firewire: core: drop unused call parameters of close_transaction
[linux-2.6] / 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->tcode != TCODE_STREAM_DATA &&
526             (request->length > 4096 || request->length > 512 << speed))
527                 return -EIO;
528
529         e = kmalloc(sizeof(*e) + request->length, GFP_KERNEL);
530         if (e == NULL)
531                 return -ENOMEM;
532
533         e->client = client;
534         e->response.length = request->length;
535         e->response.closure = request->closure;
536
537         if (request->data &&
538             copy_from_user(e->response.data,
539                            u64_to_uptr(request->data), request->length)) {
540                 ret = -EFAULT;
541                 goto failed;
542         }
543
544         e->r.resource.release = release_transaction;
545         ret = add_client_resource(client, &e->r.resource, GFP_KERNEL);
546         if (ret < 0)
547                 goto failed;
548
549         /* Get a reference for the transaction callback */
550         client_get(client);
551
552         fw_send_request(client->device->card, &e->r.transaction,
553                         request->tcode, destination_id, request->generation,
554                         speed, request->offset, e->response.data,
555                         request->length, complete_transaction, e);
556         return 0;
557
558  failed:
559         kfree(e);
560
561         return ret;
562 }
563
564 static int ioctl_send_request(struct client *client, void *buffer)
565 {
566         struct fw_cdev_send_request *request = buffer;
567
568         switch (request->tcode) {
569         case TCODE_WRITE_QUADLET_REQUEST:
570         case TCODE_WRITE_BLOCK_REQUEST:
571         case TCODE_READ_QUADLET_REQUEST:
572         case TCODE_READ_BLOCK_REQUEST:
573         case TCODE_LOCK_MASK_SWAP:
574         case TCODE_LOCK_COMPARE_SWAP:
575         case TCODE_LOCK_FETCH_ADD:
576         case TCODE_LOCK_LITTLE_ADD:
577         case TCODE_LOCK_BOUNDED_ADD:
578         case TCODE_LOCK_WRAP_ADD:
579         case TCODE_LOCK_VENDOR_DEPENDENT:
580                 break;
581         default:
582                 return -EINVAL;
583         }
584
585         return init_request(client, request, client->device->node_id,
586                             client->device->max_speed);
587 }
588
589 static void release_request(struct client *client,
590                             struct client_resource *resource)
591 {
592         struct inbound_transaction_resource *r = container_of(resource,
593                         struct inbound_transaction_resource, resource);
594
595         fw_send_response(client->device->card, r->request,
596                          RCODE_CONFLICT_ERROR);
597         kfree(r);
598 }
599
600 static void handle_request(struct fw_card *card, struct fw_request *request,
601                            int tcode, int destination, int source,
602                            int generation, int speed,
603                            unsigned long long offset,
604                            void *payload, size_t length, void *callback_data)
605 {
606         struct address_handler_resource *handler = callback_data;
607         struct inbound_transaction_resource *r;
608         struct inbound_transaction_event *e;
609         int ret;
610
611         r = kmalloc(sizeof(*r), GFP_ATOMIC);
612         e = kmalloc(sizeof(*e), GFP_ATOMIC);
613         if (r == NULL || e == NULL)
614                 goto failed;
615
616         r->request = request;
617         r->data    = payload;
618         r->length  = length;
619
620         r->resource.release = release_request;
621         ret = add_client_resource(handler->client, &r->resource, GFP_ATOMIC);
622         if (ret < 0)
623                 goto failed;
624
625         e->request.type    = FW_CDEV_EVENT_REQUEST;
626         e->request.tcode   = tcode;
627         e->request.offset  = offset;
628         e->request.length  = length;
629         e->request.handle  = r->resource.handle;
630         e->request.closure = handler->closure;
631
632         queue_event(handler->client, &e->event,
633                     &e->request, sizeof(e->request), payload, length);
634         return;
635
636  failed:
637         kfree(r);
638         kfree(e);
639         fw_send_response(card, request, RCODE_CONFLICT_ERROR);
640 }
641
642 static void release_address_handler(struct client *client,
643                                     struct client_resource *resource)
644 {
645         struct address_handler_resource *r =
646             container_of(resource, struct address_handler_resource, resource);
647
648         fw_core_remove_address_handler(&r->handler);
649         kfree(r);
650 }
651
652 static int ioctl_allocate(struct client *client, void *buffer)
653 {
654         struct fw_cdev_allocate *request = buffer;
655         struct address_handler_resource *r;
656         struct fw_address_region region;
657         int ret;
658
659         r = kmalloc(sizeof(*r), GFP_KERNEL);
660         if (r == NULL)
661                 return -ENOMEM;
662
663         region.start = request->offset;
664         region.end = request->offset + request->length;
665         r->handler.length = request->length;
666         r->handler.address_callback = handle_request;
667         r->handler.callback_data = r;
668         r->closure = request->closure;
669         r->client = client;
670
671         ret = fw_core_add_address_handler(&r->handler, &region);
672         if (ret < 0) {
673                 kfree(r);
674                 return ret;
675         }
676
677         r->resource.release = release_address_handler;
678         ret = add_client_resource(client, &r->resource, GFP_KERNEL);
679         if (ret < 0) {
680                 release_address_handler(client, &r->resource);
681                 return ret;
682         }
683         request->handle = r->resource.handle;
684
685         return 0;
686 }
687
688 static int ioctl_deallocate(struct client *client, void *buffer)
689 {
690         struct fw_cdev_deallocate *request = buffer;
691
692         return release_client_resource(client, request->handle,
693                                        release_address_handler, NULL);
694 }
695
696 static int ioctl_send_response(struct client *client, void *buffer)
697 {
698         struct fw_cdev_send_response *request = buffer;
699         struct client_resource *resource;
700         struct inbound_transaction_resource *r;
701
702         if (release_client_resource(client, request->handle,
703                                     release_request, &resource) < 0)
704                 return -EINVAL;
705
706         r = container_of(resource, struct inbound_transaction_resource,
707                          resource);
708         if (request->length < r->length)
709                 r->length = request->length;
710         if (copy_from_user(r->data, u64_to_uptr(request->data), r->length))
711                 return -EFAULT;
712
713         fw_send_response(client->device->card, r->request, request->rcode);
714         kfree(r);
715
716         return 0;
717 }
718
719 static int ioctl_initiate_bus_reset(struct client *client, void *buffer)
720 {
721         struct fw_cdev_initiate_bus_reset *request = buffer;
722         int short_reset;
723
724         short_reset = (request->type == FW_CDEV_SHORT_RESET);
725
726         return fw_core_initiate_bus_reset(client->device->card, short_reset);
727 }
728
729 static void release_descriptor(struct client *client,
730                                struct client_resource *resource)
731 {
732         struct descriptor_resource *r =
733                 container_of(resource, struct descriptor_resource, resource);
734
735         fw_core_remove_descriptor(&r->descriptor);
736         kfree(r);
737 }
738
739 static int ioctl_add_descriptor(struct client *client, void *buffer)
740 {
741         struct fw_cdev_add_descriptor *request = buffer;
742         struct fw_card *card = client->device->card;
743         struct descriptor_resource *r;
744         int ret;
745
746         /* Access policy: Allow this ioctl only on local nodes' device files. */
747         spin_lock_irq(&card->lock);
748         ret = client->device->node_id != card->local_node->node_id;
749         spin_unlock_irq(&card->lock);
750         if (ret)
751                 return -ENOSYS;
752
753         if (request->length > 256)
754                 return -EINVAL;
755
756         r = kmalloc(sizeof(*r) + request->length * 4, GFP_KERNEL);
757         if (r == NULL)
758                 return -ENOMEM;
759
760         if (copy_from_user(r->data,
761                            u64_to_uptr(request->data), request->length * 4)) {
762                 ret = -EFAULT;
763                 goto failed;
764         }
765
766         r->descriptor.length    = request->length;
767         r->descriptor.immediate = request->immediate;
768         r->descriptor.key       = request->key;
769         r->descriptor.data      = r->data;
770
771         ret = fw_core_add_descriptor(&r->descriptor);
772         if (ret < 0)
773                 goto failed;
774
775         r->resource.release = release_descriptor;
776         ret = add_client_resource(client, &r->resource, GFP_KERNEL);
777         if (ret < 0) {
778                 fw_core_remove_descriptor(&r->descriptor);
779                 goto failed;
780         }
781         request->handle = r->resource.handle;
782
783         return 0;
784  failed:
785         kfree(r);
786
787         return ret;
788 }
789
790 static int ioctl_remove_descriptor(struct client *client, void *buffer)
791 {
792         struct fw_cdev_remove_descriptor *request = buffer;
793
794         return release_client_resource(client, request->handle,
795                                        release_descriptor, NULL);
796 }
797
798 static void iso_callback(struct fw_iso_context *context, u32 cycle,
799                          size_t header_length, void *header, void *data)
800 {
801         struct client *client = data;
802         struct iso_interrupt_event *e;
803
804         e = kzalloc(sizeof(*e) + header_length, GFP_ATOMIC);
805         if (e == NULL)
806                 return;
807
808         e->interrupt.type      = FW_CDEV_EVENT_ISO_INTERRUPT;
809         e->interrupt.closure   = client->iso_closure;
810         e->interrupt.cycle     = cycle;
811         e->interrupt.header_length = header_length;
812         memcpy(e->interrupt.header, header, header_length);
813         queue_event(client, &e->event, &e->interrupt,
814                     sizeof(e->interrupt) + header_length, NULL, 0);
815 }
816
817 static int ioctl_create_iso_context(struct client *client, void *buffer)
818 {
819         struct fw_cdev_create_iso_context *request = buffer;
820         struct fw_iso_context *context;
821
822         /* We only support one context at this time. */
823         if (client->iso_context != NULL)
824                 return -EBUSY;
825
826         if (request->channel > 63)
827                 return -EINVAL;
828
829         switch (request->type) {
830         case FW_ISO_CONTEXT_RECEIVE:
831                 if (request->header_size < 4 || (request->header_size & 3))
832                         return -EINVAL;
833
834                 break;
835
836         case FW_ISO_CONTEXT_TRANSMIT:
837                 if (request->speed > SCODE_3200)
838                         return -EINVAL;
839
840                 break;
841
842         default:
843                 return -EINVAL;
844         }
845
846         context =  fw_iso_context_create(client->device->card,
847                                          request->type,
848                                          request->channel,
849                                          request->speed,
850                                          request->header_size,
851                                          iso_callback, client);
852         if (IS_ERR(context))
853                 return PTR_ERR(context);
854
855         client->iso_closure = request->closure;
856         client->iso_context = context;
857
858         /* We only support one context at this time. */
859         request->handle = 0;
860
861         return 0;
862 }
863
864 /* Macros for decoding the iso packet control header. */
865 #define GET_PAYLOAD_LENGTH(v)   ((v) & 0xffff)
866 #define GET_INTERRUPT(v)        (((v) >> 16) & 0x01)
867 #define GET_SKIP(v)             (((v) >> 17) & 0x01)
868 #define GET_TAG(v)              (((v) >> 18) & 0x03)
869 #define GET_SY(v)               (((v) >> 20) & 0x0f)
870 #define GET_HEADER_LENGTH(v)    (((v) >> 24) & 0xff)
871
872 static int ioctl_queue_iso(struct client *client, void *buffer)
873 {
874         struct fw_cdev_queue_iso *request = buffer;
875         struct fw_cdev_iso_packet __user *p, *end, *next;
876         struct fw_iso_context *ctx = client->iso_context;
877         unsigned long payload, buffer_end, header_length;
878         u32 control;
879         int count;
880         struct {
881                 struct fw_iso_packet packet;
882                 u8 header[256];
883         } u;
884
885         if (ctx == NULL || request->handle != 0)
886                 return -EINVAL;
887
888         /*
889          * If the user passes a non-NULL data pointer, has mmap()'ed
890          * the iso buffer, and the pointer points inside the buffer,
891          * we setup the payload pointers accordingly.  Otherwise we
892          * set them both to 0, which will still let packets with
893          * payload_length == 0 through.  In other words, if no packets
894          * use the indirect payload, the iso buffer need not be mapped
895          * and the request->data pointer is ignored.
896          */
897
898         payload = (unsigned long)request->data - client->vm_start;
899         buffer_end = client->buffer.page_count << PAGE_SHIFT;
900         if (request->data == 0 || client->buffer.pages == NULL ||
901             payload >= buffer_end) {
902                 payload = 0;
903                 buffer_end = 0;
904         }
905
906         p = (struct fw_cdev_iso_packet __user *)u64_to_uptr(request->packets);
907
908         if (!access_ok(VERIFY_READ, p, request->size))
909                 return -EFAULT;
910
911         end = (void __user *)p + request->size;
912         count = 0;
913         while (p < end) {
914                 if (get_user(control, &p->control))
915                         return -EFAULT;
916                 u.packet.payload_length = GET_PAYLOAD_LENGTH(control);
917                 u.packet.interrupt = GET_INTERRUPT(control);
918                 u.packet.skip = GET_SKIP(control);
919                 u.packet.tag = GET_TAG(control);
920                 u.packet.sy = GET_SY(control);
921                 u.packet.header_length = GET_HEADER_LENGTH(control);
922
923                 if (ctx->type == FW_ISO_CONTEXT_TRANSMIT) {
924                         header_length = u.packet.header_length;
925                 } else {
926                         /*
927                          * We require that header_length is a multiple of
928                          * the fixed header size, ctx->header_size.
929                          */
930                         if (ctx->header_size == 0) {
931                                 if (u.packet.header_length > 0)
932                                         return -EINVAL;
933                         } else if (u.packet.header_length % ctx->header_size != 0) {
934                                 return -EINVAL;
935                         }
936                         header_length = 0;
937                 }
938
939                 next = (struct fw_cdev_iso_packet __user *)
940                         &p->header[header_length / 4];
941                 if (next > end)
942                         return -EINVAL;
943                 if (__copy_from_user
944                     (u.packet.header, p->header, header_length))
945                         return -EFAULT;
946                 if (u.packet.skip && ctx->type == FW_ISO_CONTEXT_TRANSMIT &&
947                     u.packet.header_length + u.packet.payload_length > 0)
948                         return -EINVAL;
949                 if (payload + u.packet.payload_length > buffer_end)
950                         return -EINVAL;
951
952                 if (fw_iso_context_queue(ctx, &u.packet,
953                                          &client->buffer, payload))
954                         break;
955
956                 p = next;
957                 payload += u.packet.payload_length;
958                 count++;
959         }
960
961         request->size    -= uptr_to_u64(p) - request->packets;
962         request->packets  = uptr_to_u64(p);
963         request->data     = client->vm_start + payload;
964
965         return count;
966 }
967
968 static int ioctl_start_iso(struct client *client, void *buffer)
969 {
970         struct fw_cdev_start_iso *request = buffer;
971
972         if (client->iso_context == NULL || request->handle != 0)
973                 return -EINVAL;
974
975         if (client->iso_context->type == FW_ISO_CONTEXT_RECEIVE) {
976                 if (request->tags == 0 || request->tags > 15)
977                         return -EINVAL;
978
979                 if (request->sync > 15)
980                         return -EINVAL;
981         }
982
983         return fw_iso_context_start(client->iso_context, request->cycle,
984                                     request->sync, request->tags);
985 }
986
987 static int ioctl_stop_iso(struct client *client, void *buffer)
988 {
989         struct fw_cdev_stop_iso *request = buffer;
990
991         if (client->iso_context == NULL || request->handle != 0)
992                 return -EINVAL;
993
994         return fw_iso_context_stop(client->iso_context);
995 }
996
997 static int ioctl_get_cycle_timer(struct client *client, void *buffer)
998 {
999         struct fw_cdev_get_cycle_timer *request = buffer;
1000         struct fw_card *card = client->device->card;
1001         unsigned long long bus_time;
1002         struct timeval tv;
1003         unsigned long flags;
1004
1005         preempt_disable();
1006         local_irq_save(flags);
1007
1008         bus_time = card->driver->get_bus_time(card);
1009         do_gettimeofday(&tv);
1010
1011         local_irq_restore(flags);
1012         preempt_enable();
1013
1014         request->local_time = tv.tv_sec * 1000000ULL + tv.tv_usec;
1015         request->cycle_timer = bus_time & 0xffffffff;
1016         return 0;
1017 }
1018
1019 static void iso_resource_work(struct work_struct *work)
1020 {
1021         struct iso_resource_event *e;
1022         struct iso_resource *r =
1023                         container_of(work, struct iso_resource, work.work);
1024         struct client *client = r->client;
1025         int generation, channel, bandwidth, todo;
1026         bool skip, free, success;
1027
1028         spin_lock_irq(&client->lock);
1029         generation = client->device->generation;
1030         todo = r->todo;
1031         /* Allow 1000ms grace period for other reallocations. */
1032         if (todo == ISO_RES_ALLOC &&
1033             time_is_after_jiffies(client->device->card->reset_jiffies + HZ)) {
1034                 if (schedule_delayed_work(&r->work, DIV_ROUND_UP(HZ, 3)))
1035                         client_get(client);
1036                 skip = true;
1037         } else {
1038                 /* We could be called twice within the same generation. */
1039                 skip = todo == ISO_RES_REALLOC &&
1040                        r->generation == generation;
1041         }
1042         free = todo == ISO_RES_DEALLOC ||
1043                todo == ISO_RES_ALLOC_ONCE ||
1044                todo == ISO_RES_DEALLOC_ONCE;
1045         r->generation = generation;
1046         spin_unlock_irq(&client->lock);
1047
1048         if (skip)
1049                 goto out;
1050
1051         bandwidth = r->bandwidth;
1052
1053         fw_iso_resource_manage(client->device->card, generation,
1054                         r->channels, &channel, &bandwidth,
1055                         todo == ISO_RES_ALLOC ||
1056                         todo == ISO_RES_REALLOC ||
1057                         todo == ISO_RES_ALLOC_ONCE);
1058         /*
1059          * Is this generation outdated already?  As long as this resource sticks
1060          * in the idr, it will be scheduled again for a newer generation or at
1061          * shutdown.
1062          */
1063         if (channel == -EAGAIN &&
1064             (todo == ISO_RES_ALLOC || todo == ISO_RES_REALLOC))
1065                 goto out;
1066
1067         success = channel >= 0 || bandwidth > 0;
1068
1069         spin_lock_irq(&client->lock);
1070         /*
1071          * Transit from allocation to reallocation, except if the client
1072          * requested deallocation in the meantime.
1073          */
1074         if (r->todo == ISO_RES_ALLOC)
1075                 r->todo = ISO_RES_REALLOC;
1076         /*
1077          * Allocation or reallocation failure?  Pull this resource out of the
1078          * idr and prepare for deletion, unless the client is shutting down.
1079          */
1080         if (r->todo == ISO_RES_REALLOC && !success &&
1081             !client->in_shutdown &&
1082             idr_find(&client->resource_idr, r->resource.handle)) {
1083                 idr_remove(&client->resource_idr, r->resource.handle);
1084                 client_put(client);
1085                 free = true;
1086         }
1087         spin_unlock_irq(&client->lock);
1088
1089         if (todo == ISO_RES_ALLOC && channel >= 0)
1090                 r->channels = 1ULL << channel;
1091
1092         if (todo == ISO_RES_REALLOC && success)
1093                 goto out;
1094
1095         if (todo == ISO_RES_ALLOC || todo == ISO_RES_ALLOC_ONCE) {
1096                 e = r->e_alloc;
1097                 r->e_alloc = NULL;
1098         } else {
1099                 e = r->e_dealloc;
1100                 r->e_dealloc = NULL;
1101         }
1102         e->resource.handle      = r->resource.handle;
1103         e->resource.channel     = channel;
1104         e->resource.bandwidth   = bandwidth;
1105
1106         queue_event(client, &e->event,
1107                     &e->resource, sizeof(e->resource), NULL, 0);
1108
1109         if (free) {
1110                 cancel_delayed_work(&r->work);
1111                 kfree(r->e_alloc);
1112                 kfree(r->e_dealloc);
1113                 kfree(r);
1114         }
1115  out:
1116         client_put(client);
1117 }
1118
1119 static void schedule_iso_resource(struct iso_resource *r)
1120 {
1121         client_get(r->client);
1122         if (!schedule_delayed_work(&r->work, 0))
1123                 client_put(r->client);
1124 }
1125
1126 static void release_iso_resource(struct client *client,
1127                                  struct client_resource *resource)
1128 {
1129         struct iso_resource *r =
1130                 container_of(resource, struct iso_resource, resource);
1131
1132         spin_lock_irq(&client->lock);
1133         r->todo = ISO_RES_DEALLOC;
1134         schedule_iso_resource(r);
1135         spin_unlock_irq(&client->lock);
1136 }
1137
1138 static int init_iso_resource(struct client *client,
1139                 struct fw_cdev_allocate_iso_resource *request, int todo)
1140 {
1141         struct iso_resource_event *e1, *e2;
1142         struct iso_resource *r;
1143         int ret;
1144
1145         if ((request->channels == 0 && request->bandwidth == 0) ||
1146             request->bandwidth > BANDWIDTH_AVAILABLE_INITIAL ||
1147             request->bandwidth < 0)
1148                 return -EINVAL;
1149
1150         r  = kmalloc(sizeof(*r), GFP_KERNEL);
1151         e1 = kmalloc(sizeof(*e1), GFP_KERNEL);
1152         e2 = kmalloc(sizeof(*e2), GFP_KERNEL);
1153         if (r == NULL || e1 == NULL || e2 == NULL) {
1154                 ret = -ENOMEM;
1155                 goto fail;
1156         }
1157
1158         INIT_DELAYED_WORK(&r->work, iso_resource_work);
1159         r->client       = client;
1160         r->todo         = todo;
1161         r->generation   = -1;
1162         r->channels     = request->channels;
1163         r->bandwidth    = request->bandwidth;
1164         r->e_alloc      = e1;
1165         r->e_dealloc    = e2;
1166
1167         e1->resource.closure    = request->closure;
1168         e1->resource.type       = FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED;
1169         e2->resource.closure    = request->closure;
1170         e2->resource.type       = FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED;
1171
1172         if (todo == ISO_RES_ALLOC) {
1173                 r->resource.release = release_iso_resource;
1174                 ret = add_client_resource(client, &r->resource, GFP_KERNEL);
1175                 if (ret < 0)
1176                         goto fail;
1177         } else {
1178                 r->resource.release = NULL;
1179                 r->resource.handle = -1;
1180                 schedule_iso_resource(r);
1181         }
1182         request->handle = r->resource.handle;
1183
1184         return 0;
1185  fail:
1186         kfree(r);
1187         kfree(e1);
1188         kfree(e2);
1189
1190         return ret;
1191 }
1192
1193 static int ioctl_allocate_iso_resource(struct client *client, void *buffer)
1194 {
1195         struct fw_cdev_allocate_iso_resource *request = buffer;
1196
1197         return init_iso_resource(client, request, ISO_RES_ALLOC);
1198 }
1199
1200 static int ioctl_deallocate_iso_resource(struct client *client, void *buffer)
1201 {
1202         struct fw_cdev_deallocate *request = buffer;
1203
1204         return release_client_resource(client, request->handle,
1205                                        release_iso_resource, NULL);
1206 }
1207
1208 static int ioctl_allocate_iso_resource_once(struct client *client, void *buffer)
1209 {
1210         struct fw_cdev_allocate_iso_resource *request = buffer;
1211
1212         return init_iso_resource(client, request, ISO_RES_ALLOC_ONCE);
1213 }
1214
1215 static int ioctl_deallocate_iso_resource_once(struct client *client, void *buffer)
1216 {
1217         struct fw_cdev_allocate_iso_resource *request = buffer;
1218
1219         return init_iso_resource(client, request, ISO_RES_DEALLOC_ONCE);
1220 }
1221
1222 /*
1223  * Returns a speed code:  Maximum speed to or from this device,
1224  * limited by the device's link speed, the local node's link speed,
1225  * and all PHY port speeds between the two links.
1226  */
1227 static int ioctl_get_speed(struct client *client, void *buffer)
1228 {
1229         return client->device->max_speed;
1230 }
1231
1232 static int ioctl_send_broadcast_request(struct client *client, void *buffer)
1233 {
1234         struct fw_cdev_send_request *request = buffer;
1235
1236         switch (request->tcode) {
1237         case TCODE_WRITE_QUADLET_REQUEST:
1238         case TCODE_WRITE_BLOCK_REQUEST:
1239                 break;
1240         default:
1241                 return -EINVAL;
1242         }
1243
1244         /* Security policy: Only allow accesses to Units Space. */
1245         if (request->offset < CSR_REGISTER_BASE + CSR_CONFIG_ROM_END)
1246                 return -EACCES;
1247
1248         return init_request(client, request, LOCAL_BUS | 0x3f, SCODE_100);
1249 }
1250
1251 static int ioctl_send_stream_packet(struct client *client, void *buffer)
1252 {
1253         struct fw_cdev_send_stream_packet *p = buffer;
1254         struct fw_cdev_send_request request;
1255         int dest;
1256
1257         if (p->speed > client->device->card->link_speed ||
1258             p->length > 1024 << p->speed)
1259                 return -EIO;
1260
1261         if (p->tag > 3 || p->channel > 63 || p->sy > 15)
1262                 return -EINVAL;
1263
1264         dest = fw_stream_packet_destination_id(p->tag, p->channel, p->sy);
1265         request.tcode           = TCODE_STREAM_DATA;
1266         request.length          = p->length;
1267         request.closure         = p->closure;
1268         request.data            = p->data;
1269         request.generation      = p->generation;
1270
1271         return init_request(client, &request, dest, p->speed);
1272 }
1273
1274 static int (* const ioctl_handlers[])(struct client *client, void *buffer) = {
1275         ioctl_get_info,
1276         ioctl_send_request,
1277         ioctl_allocate,
1278         ioctl_deallocate,
1279         ioctl_send_response,
1280         ioctl_initiate_bus_reset,
1281         ioctl_add_descriptor,
1282         ioctl_remove_descriptor,
1283         ioctl_create_iso_context,
1284         ioctl_queue_iso,
1285         ioctl_start_iso,
1286         ioctl_stop_iso,
1287         ioctl_get_cycle_timer,
1288         ioctl_allocate_iso_resource,
1289         ioctl_deallocate_iso_resource,
1290         ioctl_allocate_iso_resource_once,
1291         ioctl_deallocate_iso_resource_once,
1292         ioctl_get_speed,
1293         ioctl_send_broadcast_request,
1294         ioctl_send_stream_packet,
1295 };
1296
1297 static int dispatch_ioctl(struct client *client,
1298                           unsigned int cmd, void __user *arg)
1299 {
1300         char buffer[256];
1301         int ret;
1302
1303         if (_IOC_TYPE(cmd) != '#' ||
1304             _IOC_NR(cmd) >= ARRAY_SIZE(ioctl_handlers))
1305                 return -EINVAL;
1306
1307         if (_IOC_DIR(cmd) & _IOC_WRITE) {
1308                 if (_IOC_SIZE(cmd) > sizeof(buffer) ||
1309                     copy_from_user(buffer, arg, _IOC_SIZE(cmd)))
1310                         return -EFAULT;
1311         }
1312
1313         ret = ioctl_handlers[_IOC_NR(cmd)](client, buffer);
1314         if (ret < 0)
1315                 return ret;
1316
1317         if (_IOC_DIR(cmd) & _IOC_READ) {
1318                 if (_IOC_SIZE(cmd) > sizeof(buffer) ||
1319                     copy_to_user(arg, buffer, _IOC_SIZE(cmd)))
1320                         return -EFAULT;
1321         }
1322
1323         return ret;
1324 }
1325
1326 static long fw_device_op_ioctl(struct file *file,
1327                                unsigned int cmd, unsigned long arg)
1328 {
1329         struct client *client = file->private_data;
1330
1331         if (fw_device_is_shutdown(client->device))
1332                 return -ENODEV;
1333
1334         return dispatch_ioctl(client, cmd, (void __user *) arg);
1335 }
1336
1337 #ifdef CONFIG_COMPAT
1338 static long fw_device_op_compat_ioctl(struct file *file,
1339                                       unsigned int cmd, unsigned long arg)
1340 {
1341         struct client *client = file->private_data;
1342
1343         if (fw_device_is_shutdown(client->device))
1344                 return -ENODEV;
1345
1346         return dispatch_ioctl(client, cmd, compat_ptr(arg));
1347 }
1348 #endif
1349
1350 static int fw_device_op_mmap(struct file *file, struct vm_area_struct *vma)
1351 {
1352         struct client *client = file->private_data;
1353         enum dma_data_direction direction;
1354         unsigned long size;
1355         int page_count, ret;
1356
1357         if (fw_device_is_shutdown(client->device))
1358                 return -ENODEV;
1359
1360         /* FIXME: We could support multiple buffers, but we don't. */
1361         if (client->buffer.pages != NULL)
1362                 return -EBUSY;
1363
1364         if (!(vma->vm_flags & VM_SHARED))
1365                 return -EINVAL;
1366
1367         if (vma->vm_start & ~PAGE_MASK)
1368                 return -EINVAL;
1369
1370         client->vm_start = vma->vm_start;
1371         size = vma->vm_end - vma->vm_start;
1372         page_count = size >> PAGE_SHIFT;
1373         if (size & ~PAGE_MASK)
1374                 return -EINVAL;
1375
1376         if (vma->vm_flags & VM_WRITE)
1377                 direction = DMA_TO_DEVICE;
1378         else
1379                 direction = DMA_FROM_DEVICE;
1380
1381         ret = fw_iso_buffer_init(&client->buffer, client->device->card,
1382                                  page_count, direction);
1383         if (ret < 0)
1384                 return ret;
1385
1386         ret = fw_iso_buffer_map(&client->buffer, vma);
1387         if (ret < 0)
1388                 fw_iso_buffer_destroy(&client->buffer, client->device->card);
1389
1390         return ret;
1391 }
1392
1393 static int shutdown_resource(int id, void *p, void *data)
1394 {
1395         struct client_resource *r = p;
1396         struct client *client = data;
1397
1398         r->release(client, r);
1399         client_put(client);
1400
1401         return 0;
1402 }
1403
1404 static int fw_device_op_release(struct inode *inode, struct file *file)
1405 {
1406         struct client *client = file->private_data;
1407         struct event *e, *next_e;
1408
1409         mutex_lock(&client->device->client_list_mutex);
1410         list_del(&client->link);
1411         mutex_unlock(&client->device->client_list_mutex);
1412
1413         if (client->iso_context)
1414                 fw_iso_context_destroy(client->iso_context);
1415
1416         if (client->buffer.pages)
1417                 fw_iso_buffer_destroy(&client->buffer, client->device->card);
1418
1419         /* Freeze client->resource_idr and client->event_list */
1420         spin_lock_irq(&client->lock);
1421         client->in_shutdown = true;
1422         spin_unlock_irq(&client->lock);
1423
1424         idr_for_each(&client->resource_idr, shutdown_resource, client);
1425         idr_remove_all(&client->resource_idr);
1426         idr_destroy(&client->resource_idr);
1427
1428         list_for_each_entry_safe(e, next_e, &client->event_list, link)
1429                 kfree(e);
1430
1431         client_put(client);
1432
1433         return 0;
1434 }
1435
1436 static unsigned int fw_device_op_poll(struct file *file, poll_table * pt)
1437 {
1438         struct client *client = file->private_data;
1439         unsigned int mask = 0;
1440
1441         poll_wait(file, &client->wait, pt);
1442
1443         if (fw_device_is_shutdown(client->device))
1444                 mask |= POLLHUP | POLLERR;
1445         if (!list_empty(&client->event_list))
1446                 mask |= POLLIN | POLLRDNORM;
1447
1448         return mask;
1449 }
1450
1451 const struct file_operations fw_device_ops = {
1452         .owner          = THIS_MODULE,
1453         .open           = fw_device_op_open,
1454         .read           = fw_device_op_read,
1455         .unlocked_ioctl = fw_device_op_ioctl,
1456         .poll           = fw_device_op_poll,
1457         .release        = fw_device_op_release,
1458         .mmap           = fw_device_op_mmap,
1459
1460 #ifdef CONFIG_COMPAT
1461         .compat_ioctl   = fw_device_op_compat_ioctl,
1462 #endif
1463 };