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