]> pilppa.org Git - linux-2.6-omap-h63xx.git/blob - drivers/firewire/fw-cdev.c
95a207545eb3022c033af78a6ed2058979b89ecc
[linux-2.6-omap-h63xx.git] / drivers / firewire / fw-cdev.c
1 /*
2  * Char device for device raw access
3  *
4  * Copyright (C) 2005-2007  Kristian Hoegsberg <krh@bitplanet.net>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19  */
20
21 #include <linux/compat.h>
22 #include <linux/delay.h>
23 #include <linux/device.h>
24 #include <linux/errno.h>
25 #include <linux/firewire-cdev.h>
26 #include <linux/idr.h>
27 #include <linux/jiffies.h>
28 #include <linux/kernel.h>
29 #include <linux/kref.h>
30 #include <linux/mm.h>
31 #include <linux/module.h>
32 #include <linux/mutex.h>
33 #include <linux/poll.h>
34 #include <linux/preempt.h>
35 #include <linux/spinlock.h>
36 #include <linux/time.h>
37 #include <linux/vmalloc.h>
38 #include <linux/wait.h>
39 #include <linux/workqueue.h>
40
41 #include <asm/system.h>
42 #include <asm/uaccess.h>
43
44 #include "fw-device.h"
45 #include "fw-topology.h"
46 #include "fw-transaction.h"
47
48 struct client {
49         u32 version;
50         struct fw_device *device;
51
52         spinlock_t lock;
53         bool in_shutdown;
54         struct idr resource_idr;
55         struct list_head event_list;
56         wait_queue_head_t wait;
57         u64 bus_reset_closure;
58
59         struct fw_iso_context *iso_context;
60         u64 iso_closure;
61         struct fw_iso_buffer buffer;
62         unsigned long vm_start;
63
64         struct list_head link;
65         struct kref kref;
66 };
67
68 static inline void client_get(struct client *client)
69 {
70         kref_get(&client->kref);
71 }
72
73 static void client_release(struct kref *kref)
74 {
75         struct client *client = container_of(kref, struct client, kref);
76
77         fw_device_put(client->device);
78         kfree(client);
79 }
80
81 static void client_put(struct client *client)
82 {
83         kref_put(&client->kref, client_release);
84 }
85
86 struct client_resource;
87 typedef void (*client_resource_release_fn_t)(struct client *,
88                                              struct client_resource *);
89 struct client_resource {
90         client_resource_release_fn_t release;
91         int handle;
92 };
93
94 struct address_handler_resource {
95         struct client_resource resource;
96         struct fw_address_handler handler;
97         __u64 closure;
98         struct client *client;
99 };
100
101 struct outbound_transaction_resource {
102         struct client_resource resource;
103         struct fw_transaction transaction;
104 };
105
106 struct inbound_transaction_resource {
107         struct client_resource resource;
108         struct fw_request *request;
109         void *data;
110         size_t length;
111 };
112
113 struct descriptor_resource {
114         struct client_resource resource;
115         struct fw_descriptor descriptor;
116         u32 data[0];
117 };
118
119 struct iso_resource {
120         struct client_resource resource;
121         struct client *client;
122         /* Schedule work and access todo only with client->lock held. */
123         struct delayed_work work;
124         enum {ISO_RES_ALLOC, ISO_RES_REALLOC, ISO_RES_DEALLOC,
125               ISO_RES_ALLOC_ONCE, ISO_RES_DEALLOC_ONCE,} todo;
126         int generation;
127         u64 channels;
128         s32 bandwidth;
129         struct iso_resource_event *e_alloc, *e_dealloc;
130 };
131
132 static void schedule_iso_resource(struct iso_resource *);
133 static void release_iso_resource(struct client *, struct client_resource *);
134
135 /*
136  * dequeue_event() just kfree()'s the event, so the event has to be
137  * the first field in a struct XYZ_event.
138  */
139 struct event {
140         struct { void *data; size_t size; } v[2];
141         struct list_head link;
142 };
143
144 struct bus_reset_event {
145         struct event event;
146         struct fw_cdev_event_bus_reset reset;
147 };
148
149 struct outbound_transaction_event {
150         struct event event;
151         struct client *client;
152         struct outbound_transaction_resource r;
153         struct fw_cdev_event_response response;
154 };
155
156 struct inbound_transaction_event {
157         struct event event;
158         struct fw_cdev_event_request request;
159 };
160
161 struct iso_interrupt_event {
162         struct event event;
163         struct fw_cdev_event_iso_interrupt interrupt;
164 };
165
166 struct iso_resource_event {
167         struct event event;
168         struct fw_cdev_event_iso_resource resource;
169 };
170
171 static inline void __user *u64_to_uptr(__u64 value)
172 {
173         return (void __user *)(unsigned long)value;
174 }
175
176 static inline __u64 uptr_to_u64(void __user *ptr)
177 {
178         return (__u64)(unsigned long)ptr;
179 }
180
181 static int fw_device_op_open(struct inode *inode, struct file *file)
182 {
183         struct fw_device *device;
184         struct client *client;
185
186         device = fw_device_get_by_devt(inode->i_rdev);
187         if (device == NULL)
188                 return -ENODEV;
189
190         if (fw_device_is_shutdown(device)) {
191                 fw_device_put(device);
192                 return -ENODEV;
193         }
194
195         client = kzalloc(sizeof(*client), GFP_KERNEL);
196         if (client == NULL) {
197                 fw_device_put(device);
198                 return -ENOMEM;
199         }
200
201         client->device = device;
202         spin_lock_init(&client->lock);
203         idr_init(&client->resource_idr);
204         INIT_LIST_HEAD(&client->event_list);
205         init_waitqueue_head(&client->wait);
206         kref_init(&client->kref);
207
208         file->private_data = client;
209
210         mutex_lock(&device->client_list_mutex);
211         list_add_tail(&client->link, &device->client_list);
212         mutex_unlock(&device->client_list_mutex);
213
214         return 0;
215 }
216
217 static void queue_event(struct client *client, struct event *event,
218                         void *data0, size_t size0, void *data1, size_t size1)
219 {
220         unsigned long flags;
221
222         event->v[0].data = data0;
223         event->v[0].size = size0;
224         event->v[1].data = data1;
225         event->v[1].size = size1;
226
227         spin_lock_irqsave(&client->lock, flags);
228         if (client->in_shutdown)
229                 kfree(event);
230         else
231                 list_add_tail(&event->link, &client->event_list);
232         spin_unlock_irqrestore(&client->lock, flags);
233
234         wake_up_interruptible(&client->wait);
235 }
236
237 static int dequeue_event(struct client *client,
238                          char __user *buffer, size_t count)
239 {
240         struct event *event;
241         size_t size, total;
242         int i, ret;
243
244         ret = wait_event_interruptible(client->wait,
245                         !list_empty(&client->event_list) ||
246                         fw_device_is_shutdown(client->device));
247         if (ret < 0)
248                 return ret;
249
250         if (list_empty(&client->event_list) &&
251                        fw_device_is_shutdown(client->device))
252                 return -ENODEV;
253
254         spin_lock_irq(&client->lock);
255         event = list_first_entry(&client->event_list, struct event, link);
256         list_del(&event->link);
257         spin_unlock_irq(&client->lock);
258
259         total = 0;
260         for (i = 0; i < ARRAY_SIZE(event->v) && total < count; i++) {
261                 size = min(event->v[i].size, count - total);
262                 if (copy_to_user(buffer + total, event->v[i].data, size)) {
263                         ret = -EFAULT;
264                         goto out;
265                 }
266                 total += size;
267         }
268         ret = total;
269
270  out:
271         kfree(event);
272
273         return ret;
274 }
275
276 static ssize_t fw_device_op_read(struct file *file, char __user *buffer,
277                                  size_t count, loff_t *offset)
278 {
279         struct client *client = file->private_data;
280
281         return dequeue_event(client, buffer, count);
282 }
283
284 static void fill_bus_reset_event(struct fw_cdev_event_bus_reset *event,
285                                  struct client *client)
286 {
287         struct fw_card *card = client->device->card;
288
289         spin_lock_irq(&card->lock);
290
291         event->closure       = client->bus_reset_closure;
292         event->type          = FW_CDEV_EVENT_BUS_RESET;
293         event->generation    = client->device->generation;
294         event->node_id       = client->device->node_id;
295         event->local_node_id = card->local_node->node_id;
296         event->bm_node_id    = 0; /* FIXME: We don't track the BM. */
297         event->irm_node_id   = card->irm_node->node_id;
298         event->root_node_id  = card->root_node->node_id;
299
300         spin_unlock_irq(&card->lock);
301 }
302
303 static void for_each_client(struct fw_device *device,
304                             void (*callback)(struct client *client))
305 {
306         struct client *c;
307
308         mutex_lock(&device->client_list_mutex);
309         list_for_each_entry(c, &device->client_list, link)
310                 callback(c);
311         mutex_unlock(&device->client_list_mutex);
312 }
313
314 static int schedule_reallocations(int id, void *p, void *data)
315 {
316         struct client_resource *r = p;
317
318         if (r->release == release_iso_resource)
319                 schedule_iso_resource(container_of(r,
320                                         struct iso_resource, resource));
321         return 0;
322 }
323
324 static void queue_bus_reset_event(struct client *client)
325 {
326         struct bus_reset_event *e;
327
328         e = kzalloc(sizeof(*e), GFP_KERNEL);
329         if (e == NULL) {
330                 fw_notify("Out of memory when allocating bus reset event\n");
331                 return;
332         }
333
334         fill_bus_reset_event(&e->reset, client);
335
336         queue_event(client, &e->event,
337                     &e->reset, sizeof(e->reset), NULL, 0);
338
339         spin_lock_irq(&client->lock);
340         idr_for_each(&client->resource_idr, schedule_reallocations, client);
341         spin_unlock_irq(&client->lock);
342 }
343
344 void fw_device_cdev_update(struct fw_device *device)
345 {
346         for_each_client(device, queue_bus_reset_event);
347 }
348
349 static void wake_up_client(struct client *client)
350 {
351         wake_up_interruptible(&client->wait);
352 }
353
354 void fw_device_cdev_remove(struct fw_device *device)
355 {
356         for_each_client(device, wake_up_client);
357 }
358
359 static int ioctl_get_info(struct client *client, void *buffer)
360 {
361         struct fw_cdev_get_info *get_info = buffer;
362         struct fw_cdev_event_bus_reset bus_reset;
363         unsigned long ret = 0;
364
365         client->version = get_info->version;
366         get_info->version = FW_CDEV_VERSION;
367         get_info->card = client->device->card->index;
368
369         down_read(&fw_device_rwsem);
370
371         if (get_info->rom != 0) {
372                 void __user *uptr = u64_to_uptr(get_info->rom);
373                 size_t want = get_info->rom_length;
374                 size_t have = client->device->config_rom_length * 4;
375
376                 ret = copy_to_user(uptr, client->device->config_rom,
377                                    min(want, have));
378         }
379         get_info->rom_length = client->device->config_rom_length * 4;
380
381         up_read(&fw_device_rwsem);
382
383         if (ret != 0)
384                 return -EFAULT;
385
386         client->bus_reset_closure = get_info->bus_reset_closure;
387         if (get_info->bus_reset != 0) {
388                 void __user *uptr = u64_to_uptr(get_info->bus_reset);
389
390                 fill_bus_reset_event(&bus_reset, client);
391                 if (copy_to_user(uptr, &bus_reset, sizeof(bus_reset)))
392                         return -EFAULT;
393         }
394
395         return 0;
396 }
397
398 static int add_client_resource(struct client *client,
399                                struct client_resource *resource, gfp_t gfp_mask)
400 {
401         unsigned long flags;
402         int ret;
403
404  retry:
405         if (idr_pre_get(&client->resource_idr, gfp_mask) == 0)
406                 return -ENOMEM;
407
408         spin_lock_irqsave(&client->lock, flags);
409         if (client->in_shutdown)
410                 ret = -ECANCELED;
411         else
412                 ret = idr_get_new(&client->resource_idr, resource,
413                                   &resource->handle);
414         if (ret >= 0) {
415                 client_get(client);
416                 if (resource->release == release_iso_resource)
417                         schedule_iso_resource(container_of(resource,
418                                                 struct iso_resource, resource));
419         }
420         spin_unlock_irqrestore(&client->lock, flags);
421
422         if (ret == -EAGAIN)
423                 goto retry;
424
425         return ret < 0 ? ret : 0;
426 }
427
428 static int release_client_resource(struct client *client, u32 handle,
429                                    client_resource_release_fn_t release,
430                                    struct client_resource **resource)
431 {
432         struct client_resource *r;
433
434         spin_lock_irq(&client->lock);
435         if (client->in_shutdown)
436                 r = NULL;
437         else
438                 r = idr_find(&client->resource_idr, handle);
439         if (r && r->release == release)
440                 idr_remove(&client->resource_idr, handle);
441         spin_unlock_irq(&client->lock);
442
443         if (!(r && r->release == release))
444                 return -EINVAL;
445
446         if (resource)
447                 *resource = r;
448         else
449                 r->release(client, r);
450
451         client_put(client);
452
453         return 0;
454 }
455
456 static void release_transaction(struct client *client,
457                                 struct client_resource *resource)
458 {
459         struct outbound_transaction_resource *r = container_of(resource,
460                         struct outbound_transaction_resource, resource);
461
462         fw_cancel_transaction(client->device->card, &r->transaction);
463 }
464
465 static void complete_transaction(struct fw_card *card, int rcode,
466                                  void *payload, size_t length, void *data)
467 {
468         struct outbound_transaction_event *e = data;
469         struct fw_cdev_event_response *rsp = &e->response;
470         struct client *client = e->client;
471         unsigned long flags;
472
473         if (length < rsp->length)
474                 rsp->length = length;
475         if (rcode == RCODE_COMPLETE)
476                 memcpy(rsp->data, payload, rsp->length);
477
478         spin_lock_irqsave(&client->lock, flags);
479         /*
480          * 1. If called while in shutdown, the idr tree must be left untouched.
481          *    The idr handle will be removed and the client reference will be
482          *    dropped later.
483          * 2. If the call chain was release_client_resource ->
484          *    release_transaction -> complete_transaction (instead of a normal
485          *    conclusion of the transaction), i.e. if this resource was already
486          *    unregistered from the idr, the client reference will be dropped
487          *    by release_client_resource and we must not drop it here.
488          */
489         if (!client->in_shutdown &&
490             idr_find(&client->resource_idr, e->r.resource.handle)) {
491                 idr_remove(&client->resource_idr, e->r.resource.handle);
492                 /* Drop the idr's reference */
493                 client_put(client);
494         }
495         spin_unlock_irqrestore(&client->lock, flags);
496
497         rsp->type = FW_CDEV_EVENT_RESPONSE;
498         rsp->rcode = rcode;
499
500         /*
501          * In the case that sizeof(*rsp) doesn't align with the position of the
502          * data, and the read is short, preserve an extra copy of the data
503          * to stay compatible with a pre-2.6.27 bug.  Since the bug is harmless
504          * for short reads and some apps depended on it, this is both safe
505          * and prudent for compatibility.
506          */
507         if (rsp->length <= sizeof(*rsp) - offsetof(typeof(*rsp), data))
508                 queue_event(client, &e->event, rsp, sizeof(*rsp),
509                             rsp->data, rsp->length);
510         else
511                 queue_event(client, &e->event, rsp, sizeof(*rsp) + rsp->length,
512                             NULL, 0);
513
514         /* Drop the transaction callback's reference */
515         client_put(client);
516 }
517
518 static int init_request(struct client *client,
519                         struct fw_cdev_send_request *request,
520                         int destination_id, int speed)
521 {
522         struct outbound_transaction_event *e;
523         int ret;
524
525         if (request->length > 4096 || request->length > 512 << speed)
526                 return -EIO;
527
528         e = kmalloc(sizeof(*e) + request->length, GFP_KERNEL);
529         if (e == NULL)
530                 return -ENOMEM;
531
532         e->client = client;
533         e->response.length = request->length;
534         e->response.closure = request->closure;
535
536         if (request->data &&
537             copy_from_user(e->response.data,
538                            u64_to_uptr(request->data), request->length)) {
539                 ret = -EFAULT;
540                 goto failed;
541         }
542
543         e->r.resource.release = release_transaction;
544         ret = add_client_resource(client, &e->r.resource, GFP_KERNEL);
545         if (ret < 0)
546                 goto failed;
547
548         /* Get a reference for the transaction callback */
549         client_get(client);
550
551         fw_send_request(client->device->card, &e->r.transaction,
552                         request->tcode, destination_id, request->generation,
553                         speed, request->offset, e->response.data,
554                         request->length, complete_transaction, e);
555         return 0;
556
557  failed:
558         kfree(e);
559
560         return ret;
561 }
562
563 static int ioctl_send_request(struct client *client, void *buffer)
564 {
565         struct fw_cdev_send_request *request = buffer;
566
567         switch (request->tcode) {
568         case TCODE_WRITE_QUADLET_REQUEST:
569         case TCODE_WRITE_BLOCK_REQUEST:
570         case TCODE_READ_QUADLET_REQUEST:
571         case TCODE_READ_BLOCK_REQUEST:
572         case TCODE_LOCK_MASK_SWAP:
573         case TCODE_LOCK_COMPARE_SWAP:
574         case TCODE_LOCK_FETCH_ADD:
575         case TCODE_LOCK_LITTLE_ADD:
576         case TCODE_LOCK_BOUNDED_ADD:
577         case TCODE_LOCK_WRAP_ADD:
578         case TCODE_LOCK_VENDOR_DEPENDENT:
579                 break;
580         default:
581                 return -EINVAL;
582         }
583
584         return init_request(client, request, client->device->node_id,
585                             client->device->max_speed);
586 }
587
588 static void release_request(struct client *client,
589                             struct client_resource *resource)
590 {
591         struct inbound_transaction_resource *r = container_of(resource,
592                         struct inbound_transaction_resource, resource);
593
594         fw_send_response(client->device->card, r->request,
595                          RCODE_CONFLICT_ERROR);
596         kfree(r);
597 }
598
599 static void handle_request(struct fw_card *card, struct fw_request *request,
600                            int tcode, int destination, int source,
601                            int generation, int speed,
602                            unsigned long long offset,
603                            void *payload, size_t length, void *callback_data)
604 {
605         struct address_handler_resource *handler = callback_data;
606         struct inbound_transaction_resource *r;
607         struct inbound_transaction_event *e;
608         int ret;
609
610         r = kmalloc(sizeof(*r), GFP_ATOMIC);
611         e = kmalloc(sizeof(*e), GFP_ATOMIC);
612         if (r == NULL || e == NULL)
613                 goto failed;
614
615         r->request = request;
616         r->data    = payload;
617         r->length  = length;
618
619         r->resource.release = release_request;
620         ret = add_client_resource(handler->client, &r->resource, GFP_ATOMIC);
621         if (ret < 0)
622                 goto failed;
623
624         e->request.type    = FW_CDEV_EVENT_REQUEST;
625         e->request.tcode   = tcode;
626         e->request.offset  = offset;
627         e->request.length  = length;
628         e->request.handle  = r->resource.handle;
629         e->request.closure = handler->closure;
630
631         queue_event(handler->client, &e->event,
632                     &e->request, sizeof(e->request), payload, length);
633         return;
634
635  failed:
636         kfree(r);
637         kfree(e);
638         fw_send_response(card, request, RCODE_CONFLICT_ERROR);
639 }
640
641 static void release_address_handler(struct client *client,
642                                     struct client_resource *resource)
643 {
644         struct address_handler_resource *r =
645             container_of(resource, struct address_handler_resource, resource);
646
647         fw_core_remove_address_handler(&r->handler);
648         kfree(r);
649 }
650
651 static int ioctl_allocate(struct client *client, void *buffer)
652 {
653         struct fw_cdev_allocate *request = buffer;
654         struct address_handler_resource *r;
655         struct fw_address_region region;
656         int ret;
657
658         r = kmalloc(sizeof(*r), GFP_KERNEL);
659         if (r == NULL)
660                 return -ENOMEM;
661
662         region.start = request->offset;
663         region.end = request->offset + request->length;
664         r->handler.length = request->length;
665         r->handler.address_callback = handle_request;
666         r->handler.callback_data = r;
667         r->closure = request->closure;
668         r->client = client;
669
670         ret = fw_core_add_address_handler(&r->handler, &region);
671         if (ret < 0) {
672                 kfree(r);
673                 return ret;
674         }
675
676         r->resource.release = release_address_handler;
677         ret = add_client_resource(client, &r->resource, GFP_KERNEL);
678         if (ret < 0) {
679                 release_address_handler(client, &r->resource);
680                 return ret;
681         }
682         request->handle = r->resource.handle;
683
684         return 0;
685 }
686
687 static int ioctl_deallocate(struct client *client, void *buffer)
688 {
689         struct fw_cdev_deallocate *request = buffer;
690
691         return release_client_resource(client, request->handle,
692                                        release_address_handler, NULL);
693 }
694
695 static int ioctl_send_response(struct client *client, void *buffer)
696 {
697         struct fw_cdev_send_response *request = buffer;
698         struct client_resource *resource;
699         struct inbound_transaction_resource *r;
700
701         if (release_client_resource(client, request->handle,
702                                     release_request, &resource) < 0)
703                 return -EINVAL;
704
705         r = container_of(resource, struct inbound_transaction_resource,
706                          resource);
707         if (request->length < r->length)
708                 r->length = request->length;
709         if (copy_from_user(r->data, u64_to_uptr(request->data), r->length))
710                 return -EFAULT;
711
712         fw_send_response(client->device->card, r->request, request->rcode);
713         kfree(r);
714
715         return 0;
716 }
717
718 static int ioctl_initiate_bus_reset(struct client *client, void *buffer)
719 {
720         struct fw_cdev_initiate_bus_reset *request = buffer;
721         int short_reset;
722
723         short_reset = (request->type == FW_CDEV_SHORT_RESET);
724
725         return fw_core_initiate_bus_reset(client->device->card, short_reset);
726 }
727
728 static void release_descriptor(struct client *client,
729                                struct client_resource *resource)
730 {
731         struct descriptor_resource *r =
732                 container_of(resource, struct descriptor_resource, resource);
733
734         fw_core_remove_descriptor(&r->descriptor);
735         kfree(r);
736 }
737
738 static int ioctl_add_descriptor(struct client *client, void *buffer)
739 {
740         struct fw_cdev_add_descriptor *request = buffer;
741         struct fw_card *card = client->device->card;
742         struct descriptor_resource *r;
743         int ret;
744
745         /* Access policy: Allow this ioctl only on local nodes' device files. */
746         spin_lock_irq(&card->lock);
747         ret = client->device->node_id != card->local_node->node_id;
748         spin_unlock_irq(&card->lock);
749         if (ret)
750                 return -ENOSYS;
751
752         if (request->length > 256)
753                 return -EINVAL;
754
755         r = kmalloc(sizeof(*r) + request->length * 4, GFP_KERNEL);
756         if (r == NULL)
757                 return -ENOMEM;
758
759         if (copy_from_user(r->data,
760                            u64_to_uptr(request->data), request->length * 4)) {
761                 ret = -EFAULT;
762                 goto failed;
763         }
764
765         r->descriptor.length    = request->length;
766         r->descriptor.immediate = request->immediate;
767         r->descriptor.key       = request->key;
768         r->descriptor.data      = r->data;
769
770         ret = fw_core_add_descriptor(&r->descriptor);
771         if (ret < 0)
772                 goto failed;
773
774         r->resource.release = release_descriptor;
775         ret = add_client_resource(client, &r->resource, GFP_KERNEL);
776         if (ret < 0) {
777                 fw_core_remove_descriptor(&r->descriptor);
778                 goto failed;
779         }
780         request->handle = r->resource.handle;
781
782         return 0;
783  failed:
784         kfree(r);
785
786         return ret;
787 }
788
789 static int ioctl_remove_descriptor(struct client *client, void *buffer)
790 {
791         struct fw_cdev_remove_descriptor *request = buffer;
792
793         return release_client_resource(client, request->handle,
794                                        release_descriptor, NULL);
795 }
796
797 static void iso_callback(struct fw_iso_context *context, u32 cycle,
798                          size_t header_length, void *header, void *data)
799 {
800         struct client *client = data;
801         struct iso_interrupt_event *e;
802
803         e = kzalloc(sizeof(*e) + header_length, GFP_ATOMIC);
804         if (e == NULL)
805                 return;
806
807         e->interrupt.type      = FW_CDEV_EVENT_ISO_INTERRUPT;
808         e->interrupt.closure   = client->iso_closure;
809         e->interrupt.cycle     = cycle;
810         e->interrupt.header_length = header_length;
811         memcpy(e->interrupt.header, header, header_length);
812         queue_event(client, &e->event, &e->interrupt,
813                     sizeof(e->interrupt) + header_length, NULL, 0);
814 }
815
816 static int ioctl_create_iso_context(struct client *client, void *buffer)
817 {
818         struct fw_cdev_create_iso_context *request = buffer;
819         struct fw_iso_context *context;
820
821         /* We only support one context at this time. */
822         if (client->iso_context != NULL)
823                 return -EBUSY;
824
825         if (request->channel > 63)
826                 return -EINVAL;
827
828         switch (request->type) {
829         case FW_ISO_CONTEXT_RECEIVE:
830                 if (request->header_size < 4 || (request->header_size & 3))
831                         return -EINVAL;
832
833                 break;
834
835         case FW_ISO_CONTEXT_TRANSMIT:
836                 if (request->speed > SCODE_3200)
837                         return -EINVAL;
838
839                 break;
840
841         default:
842                 return -EINVAL;
843         }
844
845         context =  fw_iso_context_create(client->device->card,
846                                          request->type,
847                                          request->channel,
848                                          request->speed,
849                                          request->header_size,
850                                          iso_callback, client);
851         if (IS_ERR(context))
852                 return PTR_ERR(context);
853
854         client->iso_closure = request->closure;
855         client->iso_context = context;
856
857         /* We only support one context at this time. */
858         request->handle = 0;
859
860         return 0;
861 }
862
863 /* Macros for decoding the iso packet control header. */
864 #define GET_PAYLOAD_LENGTH(v)   ((v) & 0xffff)
865 #define GET_INTERRUPT(v)        (((v) >> 16) & 0x01)
866 #define GET_SKIP(v)             (((v) >> 17) & 0x01)
867 #define GET_TAG(v)              (((v) >> 18) & 0x03)
868 #define GET_SY(v)               (((v) >> 20) & 0x0f)
869 #define GET_HEADER_LENGTH(v)    (((v) >> 24) & 0xff)
870
871 static int ioctl_queue_iso(struct client *client, void *buffer)
872 {
873         struct fw_cdev_queue_iso *request = buffer;
874         struct fw_cdev_iso_packet __user *p, *end, *next;
875         struct fw_iso_context *ctx = client->iso_context;
876         unsigned long payload, buffer_end, header_length;
877         u32 control;
878         int count;
879         struct {
880                 struct fw_iso_packet packet;
881                 u8 header[256];
882         } u;
883
884         if (ctx == NULL || request->handle != 0)
885                 return -EINVAL;
886
887         /*
888          * If the user passes a non-NULL data pointer, has mmap()'ed
889          * the iso buffer, and the pointer points inside the buffer,
890          * we setup the payload pointers accordingly.  Otherwise we
891          * set them both to 0, which will still let packets with
892          * payload_length == 0 through.  In other words, if no packets
893          * use the indirect payload, the iso buffer need not be mapped
894          * and the request->data pointer is ignored.
895          */
896
897         payload = (unsigned long)request->data - client->vm_start;
898         buffer_end = client->buffer.page_count << PAGE_SHIFT;
899         if (request->data == 0 || client->buffer.pages == NULL ||
900             payload >= buffer_end) {
901                 payload = 0;
902                 buffer_end = 0;
903         }
904
905         p = (struct fw_cdev_iso_packet __user *)u64_to_uptr(request->packets);
906
907         if (!access_ok(VERIFY_READ, p, request->size))
908                 return -EFAULT;
909
910         end = (void __user *)p + request->size;
911         count = 0;
912         while (p < end) {
913                 if (get_user(control, &p->control))
914                         return -EFAULT;
915                 u.packet.payload_length = GET_PAYLOAD_LENGTH(control);
916                 u.packet.interrupt = GET_INTERRUPT(control);
917                 u.packet.skip = GET_SKIP(control);
918                 u.packet.tag = GET_TAG(control);
919                 u.packet.sy = GET_SY(control);
920                 u.packet.header_length = GET_HEADER_LENGTH(control);
921
922                 if (ctx->type == FW_ISO_CONTEXT_TRANSMIT) {
923                         header_length = u.packet.header_length;
924                 } else {
925                         /*
926                          * We require that header_length is a multiple of
927                          * the fixed header size, ctx->header_size.
928                          */
929                         if (ctx->header_size == 0) {
930                                 if (u.packet.header_length > 0)
931                                         return -EINVAL;
932                         } else if (u.packet.header_length % ctx->header_size != 0) {
933                                 return -EINVAL;
934                         }
935                         header_length = 0;
936                 }
937
938                 next = (struct fw_cdev_iso_packet __user *)
939                         &p->header[header_length / 4];
940                 if (next > end)
941                         return -EINVAL;
942                 if (__copy_from_user
943                     (u.packet.header, p->header, header_length))
944                         return -EFAULT;
945                 if (u.packet.skip && ctx->type == FW_ISO_CONTEXT_TRANSMIT &&
946                     u.packet.header_length + u.packet.payload_length > 0)
947                         return -EINVAL;
948                 if (payload + u.packet.payload_length > buffer_end)
949                         return -EINVAL;
950
951                 if (fw_iso_context_queue(ctx, &u.packet,
952                                          &client->buffer, payload))
953                         break;
954
955                 p = next;
956                 payload += u.packet.payload_length;
957                 count++;
958         }
959
960         request->size    -= uptr_to_u64(p) - request->packets;
961         request->packets  = uptr_to_u64(p);
962         request->data     = client->vm_start + payload;
963
964         return count;
965 }
966
967 static int ioctl_start_iso(struct client *client, void *buffer)
968 {
969         struct fw_cdev_start_iso *request = buffer;
970
971         if (client->iso_context == NULL || request->handle != 0)
972                 return -EINVAL;
973
974         if (client->iso_context->type == FW_ISO_CONTEXT_RECEIVE) {
975                 if (request->tags == 0 || request->tags > 15)
976                         return -EINVAL;
977
978                 if (request->sync > 15)
979                         return -EINVAL;
980         }
981
982         return fw_iso_context_start(client->iso_context, request->cycle,
983                                     request->sync, request->tags);
984 }
985
986 static int ioctl_stop_iso(struct client *client, void *buffer)
987 {
988         struct fw_cdev_stop_iso *request = buffer;
989
990         if (client->iso_context == NULL || request->handle != 0)
991                 return -EINVAL;
992
993         return fw_iso_context_stop(client->iso_context);
994 }
995
996 static int ioctl_get_cycle_timer(struct client *client, void *buffer)
997 {
998         struct fw_cdev_get_cycle_timer *request = buffer;
999         struct fw_card *card = client->device->card;
1000         unsigned long long bus_time;
1001         struct timeval tv;
1002         unsigned long flags;
1003
1004         preempt_disable();
1005         local_irq_save(flags);
1006
1007         bus_time = card->driver->get_bus_time(card);
1008         do_gettimeofday(&tv);
1009
1010         local_irq_restore(flags);
1011         preempt_enable();
1012
1013         request->local_time = tv.tv_sec * 1000000ULL + tv.tv_usec;
1014         request->cycle_timer = bus_time & 0xffffffff;
1015         return 0;
1016 }
1017
1018 static void iso_resource_work(struct work_struct *work)
1019 {
1020         struct iso_resource_event *e;
1021         struct iso_resource *r =
1022                         container_of(work, struct iso_resource, work.work);
1023         struct client *client = r->client;
1024         int generation, channel, bandwidth, todo;
1025         bool skip, free, success;
1026
1027         spin_lock_irq(&client->lock);
1028         generation = client->device->generation;
1029         todo = r->todo;
1030         /* Allow 1000ms grace period for other reallocations. */
1031         if (todo == ISO_RES_ALLOC &&
1032             time_is_after_jiffies(client->device->card->reset_jiffies + HZ)) {
1033                 if (schedule_delayed_work(&r->work, DIV_ROUND_UP(HZ, 3)))
1034                         client_get(client);
1035                 skip = true;
1036         } else {
1037                 /* We could be called twice within the same generation. */
1038                 skip = todo == ISO_RES_REALLOC &&
1039                        r->generation == generation;
1040         }
1041         free = todo == ISO_RES_DEALLOC ||
1042                todo == ISO_RES_ALLOC_ONCE ||
1043                todo == ISO_RES_DEALLOC_ONCE;
1044         r->generation = generation;
1045         spin_unlock_irq(&client->lock);
1046
1047         if (skip)
1048                 goto out;
1049
1050         bandwidth = r->bandwidth;
1051
1052         fw_iso_resource_manage(client->device->card, generation,
1053                         r->channels, &channel, &bandwidth,
1054                         todo == ISO_RES_ALLOC ||
1055                         todo == ISO_RES_REALLOC ||
1056                         todo == ISO_RES_ALLOC_ONCE);
1057         /*
1058          * Is this generation outdated already?  As long as this resource sticks
1059          * in the idr, it will be scheduled again for a newer generation or at
1060          * shutdown.
1061          */
1062         if (channel == -EAGAIN &&
1063             (todo == ISO_RES_ALLOC || todo == ISO_RES_REALLOC))
1064                 goto out;
1065
1066         success = channel >= 0 || bandwidth > 0;
1067
1068         spin_lock_irq(&client->lock);
1069         /*
1070          * Transit from allocation to reallocation, except if the client
1071          * requested deallocation in the meantime.
1072          */
1073         if (r->todo == ISO_RES_ALLOC)
1074                 r->todo = ISO_RES_REALLOC;
1075         /*
1076          * Allocation or reallocation failure?  Pull this resource out of the
1077          * idr and prepare for deletion, unless the client is shutting down.
1078          */
1079         if (r->todo == ISO_RES_REALLOC && !success &&
1080             !client->in_shutdown &&
1081             idr_find(&client->resource_idr, r->resource.handle)) {
1082                 idr_remove(&client->resource_idr, r->resource.handle);
1083                 client_put(client);
1084                 free = true;
1085         }
1086         spin_unlock_irq(&client->lock);
1087
1088         if (todo == ISO_RES_ALLOC && channel >= 0)
1089                 r->channels = 1ULL << channel;
1090
1091         if (todo == ISO_RES_REALLOC && success)
1092                 goto out;
1093
1094         if (todo == ISO_RES_ALLOC || todo == ISO_RES_ALLOC_ONCE) {
1095                 e = r->e_alloc;
1096                 r->e_alloc = NULL;
1097         } else {
1098                 e = r->e_dealloc;
1099                 r->e_dealloc = NULL;
1100         }
1101         e->resource.handle      = r->resource.handle;
1102         e->resource.channel     = channel;
1103         e->resource.bandwidth   = bandwidth;
1104
1105         queue_event(client, &e->event,
1106                     &e->resource, sizeof(e->resource), NULL, 0);
1107
1108         if (free) {
1109                 cancel_delayed_work(&r->work);
1110                 kfree(r->e_alloc);
1111                 kfree(r->e_dealloc);
1112                 kfree(r);
1113         }
1114  out:
1115         client_put(client);
1116 }
1117
1118 static void schedule_iso_resource(struct iso_resource *r)
1119 {
1120         client_get(r->client);
1121         if (!schedule_delayed_work(&r->work, 0))
1122                 client_put(r->client);
1123 }
1124
1125 static void release_iso_resource(struct client *client,
1126                                  struct client_resource *resource)
1127 {
1128         struct iso_resource *r =
1129                 container_of(resource, struct iso_resource, resource);
1130
1131         spin_lock_irq(&client->lock);
1132         r->todo = ISO_RES_DEALLOC;
1133         schedule_iso_resource(r);
1134         spin_unlock_irq(&client->lock);
1135 }
1136
1137 static int init_iso_resource(struct client *client,
1138                 struct fw_cdev_allocate_iso_resource *request, int todo)
1139 {
1140         struct iso_resource_event *e1, *e2;
1141         struct iso_resource *r;
1142         int ret;
1143
1144         if ((request->channels == 0 && request->bandwidth == 0) ||
1145             request->bandwidth > BANDWIDTH_AVAILABLE_INITIAL ||
1146             request->bandwidth < 0)
1147                 return -EINVAL;
1148
1149         r  = kmalloc(sizeof(*r), GFP_KERNEL);
1150         e1 = kmalloc(sizeof(*e1), GFP_KERNEL);
1151         e2 = kmalloc(sizeof(*e2), GFP_KERNEL);
1152         if (r == NULL || e1 == NULL || e2 == NULL) {
1153                 ret = -ENOMEM;
1154                 goto fail;
1155         }
1156
1157         INIT_DELAYED_WORK(&r->work, iso_resource_work);
1158         r->client       = client;
1159         r->todo         = todo;
1160         r->generation   = -1;
1161         r->channels     = request->channels;
1162         r->bandwidth    = request->bandwidth;
1163         r->e_alloc      = e1;
1164         r->e_dealloc    = e2;
1165
1166         e1->resource.closure    = request->closure;
1167         e1->resource.type       = FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED;
1168         e2->resource.closure    = request->closure;
1169         e2->resource.type       = FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED;
1170
1171         if (todo == ISO_RES_ALLOC) {
1172                 r->resource.release = release_iso_resource;
1173                 ret = add_client_resource(client, &r->resource, GFP_KERNEL);
1174                 if (ret < 0)
1175                         goto fail;
1176         } else {
1177                 r->resource.release = NULL;
1178                 r->resource.handle = -1;
1179                 schedule_iso_resource(r);
1180         }
1181         request->handle = r->resource.handle;
1182
1183         return 0;
1184  fail:
1185         kfree(r);
1186         kfree(e1);
1187         kfree(e2);
1188
1189         return ret;
1190 }
1191
1192 static int ioctl_allocate_iso_resource(struct client *client, void *buffer)
1193 {
1194         struct fw_cdev_allocate_iso_resource *request = buffer;
1195
1196         return init_iso_resource(client, request, ISO_RES_ALLOC);
1197 }
1198
1199 static int ioctl_deallocate_iso_resource(struct client *client, void *buffer)
1200 {
1201         struct fw_cdev_deallocate *request = buffer;
1202
1203         return release_client_resource(client, request->handle,
1204                                        release_iso_resource, NULL);
1205 }
1206
1207 static int ioctl_allocate_iso_resource_once(struct client *client, void *buffer)
1208 {
1209         struct fw_cdev_allocate_iso_resource *request = buffer;
1210
1211         return init_iso_resource(client, request, ISO_RES_ALLOC_ONCE);
1212 }
1213
1214 static int ioctl_deallocate_iso_resource_once(struct client *client, void *buffer)
1215 {
1216         struct fw_cdev_allocate_iso_resource *request = buffer;
1217
1218         return init_iso_resource(client, request, ISO_RES_DEALLOC_ONCE);
1219 }
1220
1221 /*
1222  * Returns a speed code:  Maximum speed to or from this device,
1223  * limited by the device's link speed, the local node's link speed,
1224  * and all PHY port speeds between the two links.
1225  */
1226 static int ioctl_get_speed(struct client *client, void *buffer)
1227 {
1228         return client->device->max_speed;
1229 }
1230
1231 static int ioctl_send_broadcast_request(struct client *client, void *buffer)
1232 {
1233         struct fw_cdev_send_request *request = buffer;
1234
1235         switch (request->tcode) {
1236         case TCODE_WRITE_QUADLET_REQUEST:
1237         case TCODE_WRITE_BLOCK_REQUEST:
1238                 break;
1239         default:
1240                 return -EINVAL;
1241         }
1242
1243         /* Security policy: Only allow accesses to Units Space. */
1244         if (request->offset < CSR_REGISTER_BASE + CSR_CONFIG_ROM_END)
1245                 return -EACCES;
1246
1247         return init_request(client, request, LOCAL_BUS | 0x3f, SCODE_100);
1248 }
1249
1250 struct stream_packet {
1251         struct fw_packet packet;
1252         u8 data[0];
1253 };
1254
1255 static void send_stream_packet_done(struct fw_packet *packet,
1256                                     struct fw_card *card, int status)
1257 {
1258         kfree(container_of(packet, struct stream_packet, packet));
1259 }
1260
1261 static int ioctl_send_stream_packet(struct client *client, void *buffer)
1262 {
1263         struct fw_cdev_send_stream_packet *request = buffer;
1264         struct stream_packet *p;
1265
1266         p = kmalloc(sizeof(*p) + request->size, GFP_KERNEL);
1267         if (p == NULL)
1268                 return -ENOMEM;
1269
1270         if (request->data &&
1271             copy_from_user(p->data, u64_to_uptr(request->data), request->size)) {
1272                 kfree(p);
1273                 return -EFAULT;
1274         }
1275         fw_send_stream_packet(client->device->card, &p->packet,
1276                               request->generation, request->speed,
1277                               request->channel, request->sy, request->tag,
1278                               p->data, request->size, send_stream_packet_done);
1279         return 0;
1280 }
1281
1282 static int (* const ioctl_handlers[])(struct client *client, void *buffer) = {
1283         ioctl_get_info,
1284         ioctl_send_request,
1285         ioctl_allocate,
1286         ioctl_deallocate,
1287         ioctl_send_response,
1288         ioctl_initiate_bus_reset,
1289         ioctl_add_descriptor,
1290         ioctl_remove_descriptor,
1291         ioctl_create_iso_context,
1292         ioctl_queue_iso,
1293         ioctl_start_iso,
1294         ioctl_stop_iso,
1295         ioctl_get_cycle_timer,
1296         ioctl_allocate_iso_resource,
1297         ioctl_deallocate_iso_resource,
1298         ioctl_allocate_iso_resource_once,
1299         ioctl_deallocate_iso_resource_once,
1300         ioctl_get_speed,
1301         ioctl_send_broadcast_request,
1302         ioctl_send_stream_packet,
1303 };
1304
1305 static int dispatch_ioctl(struct client *client,
1306                           unsigned int cmd, void __user *arg)
1307 {
1308         char buffer[256];
1309         int ret;
1310
1311         if (_IOC_TYPE(cmd) != '#' ||
1312             _IOC_NR(cmd) >= ARRAY_SIZE(ioctl_handlers))
1313                 return -EINVAL;
1314
1315         if (_IOC_DIR(cmd) & _IOC_WRITE) {
1316                 if (_IOC_SIZE(cmd) > sizeof(buffer) ||
1317                     copy_from_user(buffer, arg, _IOC_SIZE(cmd)))
1318                         return -EFAULT;
1319         }
1320
1321         ret = ioctl_handlers[_IOC_NR(cmd)](client, buffer);
1322         if (ret < 0)
1323                 return ret;
1324
1325         if (_IOC_DIR(cmd) & _IOC_READ) {
1326                 if (_IOC_SIZE(cmd) > sizeof(buffer) ||
1327                     copy_to_user(arg, buffer, _IOC_SIZE(cmd)))
1328                         return -EFAULT;
1329         }
1330
1331         return ret;
1332 }
1333
1334 static long fw_device_op_ioctl(struct file *file,
1335                                unsigned int cmd, unsigned long arg)
1336 {
1337         struct client *client = file->private_data;
1338
1339         if (fw_device_is_shutdown(client->device))
1340                 return -ENODEV;
1341
1342         return dispatch_ioctl(client, cmd, (void __user *) arg);
1343 }
1344
1345 #ifdef CONFIG_COMPAT
1346 static long fw_device_op_compat_ioctl(struct file *file,
1347                                       unsigned int cmd, unsigned long arg)
1348 {
1349         struct client *client = file->private_data;
1350
1351         if (fw_device_is_shutdown(client->device))
1352                 return -ENODEV;
1353
1354         return dispatch_ioctl(client, cmd, compat_ptr(arg));
1355 }
1356 #endif
1357
1358 static int fw_device_op_mmap(struct file *file, struct vm_area_struct *vma)
1359 {
1360         struct client *client = file->private_data;
1361         enum dma_data_direction direction;
1362         unsigned long size;
1363         int page_count, ret;
1364
1365         if (fw_device_is_shutdown(client->device))
1366                 return -ENODEV;
1367
1368         /* FIXME: We could support multiple buffers, but we don't. */
1369         if (client->buffer.pages != NULL)
1370                 return -EBUSY;
1371
1372         if (!(vma->vm_flags & VM_SHARED))
1373                 return -EINVAL;
1374
1375         if (vma->vm_start & ~PAGE_MASK)
1376                 return -EINVAL;
1377
1378         client->vm_start = vma->vm_start;
1379         size = vma->vm_end - vma->vm_start;
1380         page_count = size >> PAGE_SHIFT;
1381         if (size & ~PAGE_MASK)
1382                 return -EINVAL;
1383
1384         if (vma->vm_flags & VM_WRITE)
1385                 direction = DMA_TO_DEVICE;
1386         else
1387                 direction = DMA_FROM_DEVICE;
1388
1389         ret = fw_iso_buffer_init(&client->buffer, client->device->card,
1390                                  page_count, direction);
1391         if (ret < 0)
1392                 return ret;
1393
1394         ret = fw_iso_buffer_map(&client->buffer, vma);
1395         if (ret < 0)
1396                 fw_iso_buffer_destroy(&client->buffer, client->device->card);
1397
1398         return ret;
1399 }
1400
1401 static int shutdown_resource(int id, void *p, void *data)
1402 {
1403         struct client_resource *r = p;
1404         struct client *client = data;
1405
1406         r->release(client, r);
1407         client_put(client);
1408
1409         return 0;
1410 }
1411
1412 static int fw_device_op_release(struct inode *inode, struct file *file)
1413 {
1414         struct client *client = file->private_data;
1415         struct event *e, *next_e;
1416
1417         mutex_lock(&client->device->client_list_mutex);
1418         list_del(&client->link);
1419         mutex_unlock(&client->device->client_list_mutex);
1420
1421         if (client->iso_context)
1422                 fw_iso_context_destroy(client->iso_context);
1423
1424         if (client->buffer.pages)
1425                 fw_iso_buffer_destroy(&client->buffer, client->device->card);
1426
1427         /* Freeze client->resource_idr and client->event_list */
1428         spin_lock_irq(&client->lock);
1429         client->in_shutdown = true;
1430         spin_unlock_irq(&client->lock);
1431
1432         idr_for_each(&client->resource_idr, shutdown_resource, client);
1433         idr_remove_all(&client->resource_idr);
1434         idr_destroy(&client->resource_idr);
1435
1436         list_for_each_entry_safe(e, next_e, &client->event_list, link)
1437                 kfree(e);
1438
1439         client_put(client);
1440
1441         return 0;
1442 }
1443
1444 static unsigned int fw_device_op_poll(struct file *file, poll_table * pt)
1445 {
1446         struct client *client = file->private_data;
1447         unsigned int mask = 0;
1448
1449         poll_wait(file, &client->wait, pt);
1450
1451         if (fw_device_is_shutdown(client->device))
1452                 mask |= POLLHUP | POLLERR;
1453         if (!list_empty(&client->event_list))
1454                 mask |= POLLIN | POLLRDNORM;
1455
1456         return mask;
1457 }
1458
1459 const struct file_operations fw_device_ops = {
1460         .owner          = THIS_MODULE,
1461         .open           = fw_device_op_open,
1462         .read           = fw_device_op_read,
1463         .unlocked_ioctl = fw_device_op_ioctl,
1464         .poll           = fw_device_op_poll,
1465         .release        = fw_device_op_release,
1466         .mmap           = fw_device_op_mmap,
1467
1468 #ifdef CONFIG_COMPAT
1469         .compat_ioctl   = fw_device_op_compat_ioctl,
1470 #endif
1471 };