2 * Char device for device raw access
4 * Copyright (C) 2005-2007 Kristian Hoegsberg <krh@bitplanet.net>
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.
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.
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.
21 #include <linux/bug.h>
22 #include <linux/compat.h>
23 #include <linux/delay.h>
24 #include <linux/device.h>
25 #include <linux/errno.h>
26 #include <linux/firewire.h>
27 #include <linux/firewire-cdev.h>
28 #include <linux/idr.h>
29 #include <linux/irqflags.h>
30 #include <linux/jiffies.h>
31 #include <linux/kernel.h>
32 #include <linux/kref.h>
34 #include <linux/module.h>
35 #include <linux/mutex.h>
36 #include <linux/poll.h>
37 #include <linux/sched.h>
38 #include <linux/spinlock.h>
39 #include <linux/string.h>
40 #include <linux/time.h>
41 #include <linux/uaccess.h>
42 #include <linux/vmalloc.h>
43 #include <linux/wait.h>
44 #include <linux/workqueue.h>
46 #include <asm/system.h>
51 * ABI version history is documented in linux/firewire-cdev.h.
53 #define FW_CDEV_KERNEL_VERSION 4
54 #define FW_CDEV_VERSION_EVENT_REQUEST2 4
58 struct fw_device *device;
62 struct idr resource_idr;
63 struct list_head event_list;
64 wait_queue_head_t wait;
65 u64 bus_reset_closure;
67 struct fw_iso_context *iso_context;
69 struct fw_iso_buffer buffer;
70 unsigned long vm_start;
72 struct list_head link;
76 static inline void client_get(struct client *client)
78 kref_get(&client->kref);
81 static void client_release(struct kref *kref)
83 struct client *client = container_of(kref, struct client, kref);
85 fw_device_put(client->device);
89 static void client_put(struct client *client)
91 kref_put(&client->kref, client_release);
94 struct client_resource;
95 typedef void (*client_resource_release_fn_t)(struct client *,
96 struct client_resource *);
97 struct client_resource {
98 client_resource_release_fn_t release;
102 struct address_handler_resource {
103 struct client_resource resource;
104 struct fw_address_handler handler;
106 struct client *client;
109 struct outbound_transaction_resource {
110 struct client_resource resource;
111 struct fw_transaction transaction;
114 struct inbound_transaction_resource {
115 struct client_resource resource;
116 struct fw_card *card;
117 struct fw_request *request;
122 struct descriptor_resource {
123 struct client_resource resource;
124 struct fw_descriptor descriptor;
128 struct iso_resource {
129 struct client_resource resource;
130 struct client *client;
131 /* Schedule work and access todo only with client->lock held. */
132 struct delayed_work work;
133 enum {ISO_RES_ALLOC, ISO_RES_REALLOC, ISO_RES_DEALLOC,
134 ISO_RES_ALLOC_ONCE, ISO_RES_DEALLOC_ONCE,} todo;
138 __be32 transaction_data[2];
139 struct iso_resource_event *e_alloc, *e_dealloc;
142 static void release_iso_resource(struct client *, struct client_resource *);
144 static void schedule_iso_resource(struct iso_resource *r, unsigned long delay)
146 client_get(r->client);
147 if (!schedule_delayed_work(&r->work, delay))
148 client_put(r->client);
151 static void schedule_if_iso_resource(struct client_resource *resource)
153 if (resource->release == release_iso_resource)
154 schedule_iso_resource(container_of(resource,
155 struct iso_resource, resource), 0);
159 * dequeue_event() just kfree()'s the event, so the event has to be
160 * the first field in a struct XYZ_event.
163 struct { void *data; size_t size; } v[2];
164 struct list_head link;
167 struct bus_reset_event {
169 struct fw_cdev_event_bus_reset reset;
172 struct outbound_transaction_event {
174 struct client *client;
175 struct outbound_transaction_resource r;
176 struct fw_cdev_event_response response;
179 struct inbound_transaction_event {
182 struct fw_cdev_event_request request;
183 struct fw_cdev_event_request2 request2;
187 struct iso_interrupt_event {
189 struct fw_cdev_event_iso_interrupt interrupt;
192 struct iso_resource_event {
194 struct fw_cdev_event_iso_resource iso_resource;
197 static inline void __user *u64_to_uptr(__u64 value)
199 return (void __user *)(unsigned long)value;
202 static inline __u64 uptr_to_u64(void __user *ptr)
204 return (__u64)(unsigned long)ptr;
207 static int fw_device_op_open(struct inode *inode, struct file *file)
209 struct fw_device *device;
210 struct client *client;
212 device = fw_device_get_by_devt(inode->i_rdev);
216 if (fw_device_is_shutdown(device)) {
217 fw_device_put(device);
221 client = kzalloc(sizeof(*client), GFP_KERNEL);
222 if (client == NULL) {
223 fw_device_put(device);
227 client->device = device;
228 spin_lock_init(&client->lock);
229 idr_init(&client->resource_idr);
230 INIT_LIST_HEAD(&client->event_list);
231 init_waitqueue_head(&client->wait);
232 kref_init(&client->kref);
234 file->private_data = client;
236 mutex_lock(&device->client_list_mutex);
237 list_add_tail(&client->link, &device->client_list);
238 mutex_unlock(&device->client_list_mutex);
240 return nonseekable_open(inode, file);
243 static void queue_event(struct client *client, struct event *event,
244 void *data0, size_t size0, void *data1, size_t size1)
248 event->v[0].data = data0;
249 event->v[0].size = size0;
250 event->v[1].data = data1;
251 event->v[1].size = size1;
253 spin_lock_irqsave(&client->lock, flags);
254 if (client->in_shutdown)
257 list_add_tail(&event->link, &client->event_list);
258 spin_unlock_irqrestore(&client->lock, flags);
260 wake_up_interruptible(&client->wait);
263 static int dequeue_event(struct client *client,
264 char __user *buffer, size_t count)
270 ret = wait_event_interruptible(client->wait,
271 !list_empty(&client->event_list) ||
272 fw_device_is_shutdown(client->device));
276 if (list_empty(&client->event_list) &&
277 fw_device_is_shutdown(client->device))
280 spin_lock_irq(&client->lock);
281 event = list_first_entry(&client->event_list, struct event, link);
282 list_del(&event->link);
283 spin_unlock_irq(&client->lock);
286 for (i = 0; i < ARRAY_SIZE(event->v) && total < count; i++) {
287 size = min(event->v[i].size, count - total);
288 if (copy_to_user(buffer + total, event->v[i].data, size)) {
302 static ssize_t fw_device_op_read(struct file *file, char __user *buffer,
303 size_t count, loff_t *offset)
305 struct client *client = file->private_data;
307 return dequeue_event(client, buffer, count);
310 static void fill_bus_reset_event(struct fw_cdev_event_bus_reset *event,
311 struct client *client)
313 struct fw_card *card = client->device->card;
315 spin_lock_irq(&card->lock);
317 event->closure = client->bus_reset_closure;
318 event->type = FW_CDEV_EVENT_BUS_RESET;
319 event->generation = client->device->generation;
320 event->node_id = client->device->node_id;
321 event->local_node_id = card->local_node->node_id;
322 event->bm_node_id = card->bm_node_id;
323 event->irm_node_id = card->irm_node->node_id;
324 event->root_node_id = card->root_node->node_id;
326 spin_unlock_irq(&card->lock);
329 static void for_each_client(struct fw_device *device,
330 void (*callback)(struct client *client))
334 mutex_lock(&device->client_list_mutex);
335 list_for_each_entry(c, &device->client_list, link)
337 mutex_unlock(&device->client_list_mutex);
340 static int schedule_reallocations(int id, void *p, void *data)
342 schedule_if_iso_resource(p);
347 static void queue_bus_reset_event(struct client *client)
349 struct bus_reset_event *e;
351 e = kzalloc(sizeof(*e), GFP_KERNEL);
353 fw_notify("Out of memory when allocating bus reset event\n");
357 fill_bus_reset_event(&e->reset, client);
359 queue_event(client, &e->event,
360 &e->reset, sizeof(e->reset), NULL, 0);
362 spin_lock_irq(&client->lock);
363 idr_for_each(&client->resource_idr, schedule_reallocations, client);
364 spin_unlock_irq(&client->lock);
367 void fw_device_cdev_update(struct fw_device *device)
369 for_each_client(device, queue_bus_reset_event);
372 static void wake_up_client(struct client *client)
374 wake_up_interruptible(&client->wait);
377 void fw_device_cdev_remove(struct fw_device *device)
379 for_each_client(device, wake_up_client);
383 struct fw_cdev_get_info get_info;
384 struct fw_cdev_send_request send_request;
385 struct fw_cdev_allocate allocate;
386 struct fw_cdev_deallocate deallocate;
387 struct fw_cdev_send_response send_response;
388 struct fw_cdev_initiate_bus_reset initiate_bus_reset;
389 struct fw_cdev_add_descriptor add_descriptor;
390 struct fw_cdev_remove_descriptor remove_descriptor;
391 struct fw_cdev_create_iso_context create_iso_context;
392 struct fw_cdev_queue_iso queue_iso;
393 struct fw_cdev_start_iso start_iso;
394 struct fw_cdev_stop_iso stop_iso;
395 struct fw_cdev_get_cycle_timer get_cycle_timer;
396 struct fw_cdev_allocate_iso_resource allocate_iso_resource;
397 struct fw_cdev_send_stream_packet send_stream_packet;
398 struct fw_cdev_get_cycle_timer2 get_cycle_timer2;
401 static int ioctl_get_info(struct client *client, union ioctl_arg *arg)
403 struct fw_cdev_get_info *a = &arg->get_info;
404 struct fw_cdev_event_bus_reset bus_reset;
405 unsigned long ret = 0;
407 client->version = a->version;
408 a->version = FW_CDEV_KERNEL_VERSION;
409 a->card = client->device->card->index;
411 down_read(&fw_device_rwsem);
414 size_t want = a->rom_length;
415 size_t have = client->device->config_rom_length * 4;
417 ret = copy_to_user(u64_to_uptr(a->rom),
418 client->device->config_rom, min(want, have));
420 a->rom_length = client->device->config_rom_length * 4;
422 up_read(&fw_device_rwsem);
427 client->bus_reset_closure = a->bus_reset_closure;
428 if (a->bus_reset != 0) {
429 fill_bus_reset_event(&bus_reset, client);
430 if (copy_to_user(u64_to_uptr(a->bus_reset),
431 &bus_reset, sizeof(bus_reset)))
438 static int add_client_resource(struct client *client,
439 struct client_resource *resource, gfp_t gfp_mask)
445 if (idr_pre_get(&client->resource_idr, gfp_mask) == 0)
448 spin_lock_irqsave(&client->lock, flags);
449 if (client->in_shutdown)
452 ret = idr_get_new(&client->resource_idr, resource,
456 schedule_if_iso_resource(resource);
458 spin_unlock_irqrestore(&client->lock, flags);
463 return ret < 0 ? ret : 0;
466 static int release_client_resource(struct client *client, u32 handle,
467 client_resource_release_fn_t release,
468 struct client_resource **return_resource)
470 struct client_resource *resource;
472 spin_lock_irq(&client->lock);
473 if (client->in_shutdown)
476 resource = idr_find(&client->resource_idr, handle);
477 if (resource && resource->release == release)
478 idr_remove(&client->resource_idr, handle);
479 spin_unlock_irq(&client->lock);
481 if (!(resource && resource->release == release))
485 *return_resource = resource;
487 resource->release(client, resource);
494 static void release_transaction(struct client *client,
495 struct client_resource *resource)
497 struct outbound_transaction_resource *r = container_of(resource,
498 struct outbound_transaction_resource, resource);
500 fw_cancel_transaction(client->device->card, &r->transaction);
503 static void complete_transaction(struct fw_card *card, int rcode,
504 void *payload, size_t length, void *data)
506 struct outbound_transaction_event *e = data;
507 struct fw_cdev_event_response *rsp = &e->response;
508 struct client *client = e->client;
511 if (length < rsp->length)
512 rsp->length = length;
513 if (rcode == RCODE_COMPLETE)
514 memcpy(rsp->data, payload, rsp->length);
516 spin_lock_irqsave(&client->lock, flags);
518 * 1. If called while in shutdown, the idr tree must be left untouched.
519 * The idr handle will be removed and the client reference will be
521 * 2. If the call chain was release_client_resource ->
522 * release_transaction -> complete_transaction (instead of a normal
523 * conclusion of the transaction), i.e. if this resource was already
524 * unregistered from the idr, the client reference will be dropped
525 * by release_client_resource and we must not drop it here.
527 if (!client->in_shutdown &&
528 idr_find(&client->resource_idr, e->r.resource.handle)) {
529 idr_remove(&client->resource_idr, e->r.resource.handle);
530 /* Drop the idr's reference */
533 spin_unlock_irqrestore(&client->lock, flags);
535 rsp->type = FW_CDEV_EVENT_RESPONSE;
539 * In the case that sizeof(*rsp) doesn't align with the position of the
540 * data, and the read is short, preserve an extra copy of the data
541 * to stay compatible with a pre-2.6.27 bug. Since the bug is harmless
542 * for short reads and some apps depended on it, this is both safe
543 * and prudent for compatibility.
545 if (rsp->length <= sizeof(*rsp) - offsetof(typeof(*rsp), data))
546 queue_event(client, &e->event, rsp, sizeof(*rsp),
547 rsp->data, rsp->length);
549 queue_event(client, &e->event, rsp, sizeof(*rsp) + rsp->length,
552 /* Drop the transaction callback's reference */
556 static int init_request(struct client *client,
557 struct fw_cdev_send_request *request,
558 int destination_id, int speed)
560 struct outbound_transaction_event *e;
563 if (request->tcode != TCODE_STREAM_DATA &&
564 (request->length > 4096 || request->length > 512 << speed))
567 if (request->tcode == TCODE_WRITE_QUADLET_REQUEST &&
571 e = kmalloc(sizeof(*e) + request->length, GFP_KERNEL);
576 e->response.length = request->length;
577 e->response.closure = request->closure;
580 copy_from_user(e->response.data,
581 u64_to_uptr(request->data), request->length)) {
586 e->r.resource.release = release_transaction;
587 ret = add_client_resource(client, &e->r.resource, GFP_KERNEL);
591 /* Get a reference for the transaction callback */
594 fw_send_request(client->device->card, &e->r.transaction,
595 request->tcode, destination_id, request->generation,
596 speed, request->offset, e->response.data,
597 request->length, complete_transaction, e);
606 static int ioctl_send_request(struct client *client, union ioctl_arg *arg)
608 switch (arg->send_request.tcode) {
609 case TCODE_WRITE_QUADLET_REQUEST:
610 case TCODE_WRITE_BLOCK_REQUEST:
611 case TCODE_READ_QUADLET_REQUEST:
612 case TCODE_READ_BLOCK_REQUEST:
613 case TCODE_LOCK_MASK_SWAP:
614 case TCODE_LOCK_COMPARE_SWAP:
615 case TCODE_LOCK_FETCH_ADD:
616 case TCODE_LOCK_LITTLE_ADD:
617 case TCODE_LOCK_BOUNDED_ADD:
618 case TCODE_LOCK_WRAP_ADD:
619 case TCODE_LOCK_VENDOR_DEPENDENT:
625 return init_request(client, &arg->send_request, client->device->node_id,
626 client->device->max_speed);
629 static inline bool is_fcp_request(struct fw_request *request)
631 return request == NULL;
634 static void release_request(struct client *client,
635 struct client_resource *resource)
637 struct inbound_transaction_resource *r = container_of(resource,
638 struct inbound_transaction_resource, resource);
640 if (is_fcp_request(r->request))
643 fw_send_response(r->card, r->request, RCODE_CONFLICT_ERROR);
645 fw_card_put(r->card);
649 static void handle_request(struct fw_card *card, struct fw_request *request,
650 int tcode, int destination, int source,
651 int generation, unsigned long long offset,
652 void *payload, size_t length, void *callback_data)
654 struct address_handler_resource *handler = callback_data;
655 struct inbound_transaction_resource *r;
656 struct inbound_transaction_event *e;
658 void *fcp_frame = NULL;
661 /* card may be different from handler->client->device->card */
664 r = kmalloc(sizeof(*r), GFP_ATOMIC);
665 e = kmalloc(sizeof(*e), GFP_ATOMIC);
666 if (r == NULL || e == NULL)
670 r->request = request;
674 if (is_fcp_request(request)) {
676 * FIXME: Let core-transaction.c manage a
677 * single reference-counted copy?
679 fcp_frame = kmemdup(payload, length, GFP_ATOMIC);
680 if (fcp_frame == NULL)
686 r->resource.release = release_request;
687 ret = add_client_resource(handler->client, &r->resource, GFP_ATOMIC);
691 if (handler->client->version < FW_CDEV_VERSION_EVENT_REQUEST2) {
692 struct fw_cdev_event_request *req = &e->req.request;
695 tcode = TCODE_LOCK_REQUEST;
697 req->type = FW_CDEV_EVENT_REQUEST;
699 req->offset = offset;
700 req->length = length;
701 req->handle = r->resource.handle;
702 req->closure = handler->closure;
703 event_size0 = sizeof(*req);
705 struct fw_cdev_event_request2 *req = &e->req.request2;
707 req->type = FW_CDEV_EVENT_REQUEST2;
709 req->offset = offset;
710 req->source_node_id = source;
711 req->destination_node_id = destination;
712 req->card = card->index;
713 req->generation = generation;
714 req->length = length;
715 req->handle = r->resource.handle;
716 req->closure = handler->closure;
717 event_size0 = sizeof(*req);
720 queue_event(handler->client, &e->event,
721 &e->req, event_size0, r->data, length);
729 if (!is_fcp_request(request))
730 fw_send_response(card, request, RCODE_CONFLICT_ERROR);
735 static void release_address_handler(struct client *client,
736 struct client_resource *resource)
738 struct address_handler_resource *r =
739 container_of(resource, struct address_handler_resource, resource);
741 fw_core_remove_address_handler(&r->handler);
745 static int ioctl_allocate(struct client *client, union ioctl_arg *arg)
747 struct fw_cdev_allocate *a = &arg->allocate;
748 struct address_handler_resource *r;
749 struct fw_address_region region;
752 r = kmalloc(sizeof(*r), GFP_KERNEL);
756 region.start = a->offset;
757 region.end = a->offset + a->length;
758 r->handler.length = a->length;
759 r->handler.address_callback = handle_request;
760 r->handler.callback_data = r;
761 r->closure = a->closure;
764 ret = fw_core_add_address_handler(&r->handler, ®ion);
770 r->resource.release = release_address_handler;
771 ret = add_client_resource(client, &r->resource, GFP_KERNEL);
773 release_address_handler(client, &r->resource);
776 a->handle = r->resource.handle;
781 static int ioctl_deallocate(struct client *client, union ioctl_arg *arg)
783 return release_client_resource(client, arg->deallocate.handle,
784 release_address_handler, NULL);
787 static int ioctl_send_response(struct client *client, union ioctl_arg *arg)
789 struct fw_cdev_send_response *a = &arg->send_response;
790 struct client_resource *resource;
791 struct inbound_transaction_resource *r;
794 if (release_client_resource(client, a->handle,
795 release_request, &resource) < 0)
798 r = container_of(resource, struct inbound_transaction_resource,
800 if (is_fcp_request(r->request))
803 if (a->length != fw_get_response_length(r->request)) {
808 if (copy_from_user(r->data, u64_to_uptr(a->data), a->length)) {
813 fw_send_response(r->card, r->request, a->rcode);
815 fw_card_put(r->card);
821 static int ioctl_initiate_bus_reset(struct client *client, union ioctl_arg *arg)
823 fw_schedule_bus_reset(client->device->card, true,
824 arg->initiate_bus_reset.type == FW_CDEV_SHORT_RESET);
828 static void release_descriptor(struct client *client,
829 struct client_resource *resource)
831 struct descriptor_resource *r =
832 container_of(resource, struct descriptor_resource, resource);
834 fw_core_remove_descriptor(&r->descriptor);
838 static int ioctl_add_descriptor(struct client *client, union ioctl_arg *arg)
840 struct fw_cdev_add_descriptor *a = &arg->add_descriptor;
841 struct descriptor_resource *r;
844 /* Access policy: Allow this ioctl only on local nodes' device files. */
845 if (!client->device->is_local)
851 r = kmalloc(sizeof(*r) + a->length * 4, GFP_KERNEL);
855 if (copy_from_user(r->data, u64_to_uptr(a->data), a->length * 4)) {
860 r->descriptor.length = a->length;
861 r->descriptor.immediate = a->immediate;
862 r->descriptor.key = a->key;
863 r->descriptor.data = r->data;
865 ret = fw_core_add_descriptor(&r->descriptor);
869 r->resource.release = release_descriptor;
870 ret = add_client_resource(client, &r->resource, GFP_KERNEL);
872 fw_core_remove_descriptor(&r->descriptor);
875 a->handle = r->resource.handle;
884 static int ioctl_remove_descriptor(struct client *client, union ioctl_arg *arg)
886 return release_client_resource(client, arg->remove_descriptor.handle,
887 release_descriptor, NULL);
890 static void iso_callback(struct fw_iso_context *context, u32 cycle,
891 size_t header_length, void *header, void *data)
893 struct client *client = data;
894 struct iso_interrupt_event *e;
896 e = kmalloc(sizeof(*e) + header_length, GFP_ATOMIC);
900 e->interrupt.type = FW_CDEV_EVENT_ISO_INTERRUPT;
901 e->interrupt.closure = client->iso_closure;
902 e->interrupt.cycle = cycle;
903 e->interrupt.header_length = header_length;
904 memcpy(e->interrupt.header, header, header_length);
905 queue_event(client, &e->event, &e->interrupt,
906 sizeof(e->interrupt) + header_length, NULL, 0);
909 static int ioctl_create_iso_context(struct client *client, union ioctl_arg *arg)
911 struct fw_cdev_create_iso_context *a = &arg->create_iso_context;
912 struct fw_iso_context *context;
914 BUILD_BUG_ON(FW_CDEV_ISO_CONTEXT_TRANSMIT != FW_ISO_CONTEXT_TRANSMIT ||
915 FW_CDEV_ISO_CONTEXT_RECEIVE != FW_ISO_CONTEXT_RECEIVE);
921 case FW_ISO_CONTEXT_RECEIVE:
922 if (a->header_size < 4 || (a->header_size & 3))
926 case FW_ISO_CONTEXT_TRANSMIT:
927 if (a->speed > SCODE_3200)
935 context = fw_iso_context_create(client->device->card, a->type,
936 a->channel, a->speed, a->header_size,
937 iso_callback, client);
939 return PTR_ERR(context);
941 /* We only support one context at this time. */
942 spin_lock_irq(&client->lock);
943 if (client->iso_context != NULL) {
944 spin_unlock_irq(&client->lock);
945 fw_iso_context_destroy(context);
948 client->iso_closure = a->closure;
949 client->iso_context = context;
950 spin_unlock_irq(&client->lock);
957 /* Macros for decoding the iso packet control header. */
958 #define GET_PAYLOAD_LENGTH(v) ((v) & 0xffff)
959 #define GET_INTERRUPT(v) (((v) >> 16) & 0x01)
960 #define GET_SKIP(v) (((v) >> 17) & 0x01)
961 #define GET_TAG(v) (((v) >> 18) & 0x03)
962 #define GET_SY(v) (((v) >> 20) & 0x0f)
963 #define GET_HEADER_LENGTH(v) (((v) >> 24) & 0xff)
965 static int ioctl_queue_iso(struct client *client, union ioctl_arg *arg)
967 struct fw_cdev_queue_iso *a = &arg->queue_iso;
968 struct fw_cdev_iso_packet __user *p, *end, *next;
969 struct fw_iso_context *ctx = client->iso_context;
970 unsigned long payload, buffer_end, header_length;
974 struct fw_iso_packet packet;
978 if (ctx == NULL || a->handle != 0)
982 * If the user passes a non-NULL data pointer, has mmap()'ed
983 * the iso buffer, and the pointer points inside the buffer,
984 * we setup the payload pointers accordingly. Otherwise we
985 * set them both to 0, which will still let packets with
986 * payload_length == 0 through. In other words, if no packets
987 * use the indirect payload, the iso buffer need not be mapped
988 * and the a->data pointer is ignored.
991 payload = (unsigned long)a->data - client->vm_start;
992 buffer_end = client->buffer.page_count << PAGE_SHIFT;
993 if (a->data == 0 || client->buffer.pages == NULL ||
994 payload >= buffer_end) {
999 p = (struct fw_cdev_iso_packet __user *)u64_to_uptr(a->packets);
1001 if (!access_ok(VERIFY_READ, p, a->size))
1004 end = (void __user *)p + a->size;
1007 if (get_user(control, &p->control))
1009 u.packet.payload_length = GET_PAYLOAD_LENGTH(control);
1010 u.packet.interrupt = GET_INTERRUPT(control);
1011 u.packet.skip = GET_SKIP(control);
1012 u.packet.tag = GET_TAG(control);
1013 u.packet.sy = GET_SY(control);
1014 u.packet.header_length = GET_HEADER_LENGTH(control);
1016 if (ctx->type == FW_ISO_CONTEXT_TRANSMIT) {
1017 if (u.packet.header_length % 4 != 0)
1019 header_length = u.packet.header_length;
1022 * We require that header_length is a multiple of
1023 * the fixed header size, ctx->header_size.
1025 if (ctx->header_size == 0) {
1026 if (u.packet.header_length > 0)
1028 } else if (u.packet.header_length == 0 ||
1029 u.packet.header_length % ctx->header_size != 0) {
1035 next = (struct fw_cdev_iso_packet __user *)
1036 &p->header[header_length / 4];
1039 if (__copy_from_user
1040 (u.packet.header, p->header, header_length))
1042 if (u.packet.skip && ctx->type == FW_ISO_CONTEXT_TRANSMIT &&
1043 u.packet.header_length + u.packet.payload_length > 0)
1045 if (payload + u.packet.payload_length > buffer_end)
1048 if (fw_iso_context_queue(ctx, &u.packet,
1049 &client->buffer, payload))
1053 payload += u.packet.payload_length;
1057 a->size -= uptr_to_u64(p) - a->packets;
1058 a->packets = uptr_to_u64(p);
1059 a->data = client->vm_start + payload;
1064 static int ioctl_start_iso(struct client *client, union ioctl_arg *arg)
1066 struct fw_cdev_start_iso *a = &arg->start_iso;
1069 FW_CDEV_ISO_CONTEXT_MATCH_TAG0 != FW_ISO_CONTEXT_MATCH_TAG0 ||
1070 FW_CDEV_ISO_CONTEXT_MATCH_TAG1 != FW_ISO_CONTEXT_MATCH_TAG1 ||
1071 FW_CDEV_ISO_CONTEXT_MATCH_TAG2 != FW_ISO_CONTEXT_MATCH_TAG2 ||
1072 FW_CDEV_ISO_CONTEXT_MATCH_TAG3 != FW_ISO_CONTEXT_MATCH_TAG3 ||
1073 FW_CDEV_ISO_CONTEXT_MATCH_ALL_TAGS != FW_ISO_CONTEXT_MATCH_ALL_TAGS);
1075 if (client->iso_context == NULL || a->handle != 0)
1078 if (client->iso_context->type == FW_ISO_CONTEXT_RECEIVE &&
1079 (a->tags == 0 || a->tags > 15 || a->sync > 15))
1082 return fw_iso_context_start(client->iso_context,
1083 a->cycle, a->sync, a->tags);
1086 static int ioctl_stop_iso(struct client *client, union ioctl_arg *arg)
1088 struct fw_cdev_stop_iso *a = &arg->stop_iso;
1090 if (client->iso_context == NULL || a->handle != 0)
1093 return fw_iso_context_stop(client->iso_context);
1096 static int ioctl_get_cycle_timer2(struct client *client, union ioctl_arg *arg)
1098 struct fw_cdev_get_cycle_timer2 *a = &arg->get_cycle_timer2;
1099 struct fw_card *card = client->device->card;
1100 struct timespec ts = {0, 0};
1104 local_irq_disable();
1106 cycle_time = card->driver->read_csr(card, CSR_CYCLE_TIME);
1108 switch (a->clk_id) {
1109 case CLOCK_REALTIME: getnstimeofday(&ts); break;
1110 case CLOCK_MONOTONIC: do_posix_clock_monotonic_gettime(&ts); break;
1111 case CLOCK_MONOTONIC_RAW: getrawmonotonic(&ts); break;
1118 a->tv_sec = ts.tv_sec;
1119 a->tv_nsec = ts.tv_nsec;
1120 a->cycle_timer = cycle_time;
1125 static int ioctl_get_cycle_timer(struct client *client, union ioctl_arg *arg)
1127 struct fw_cdev_get_cycle_timer *a = &arg->get_cycle_timer;
1128 struct fw_cdev_get_cycle_timer2 ct2;
1130 ct2.clk_id = CLOCK_REALTIME;
1131 ioctl_get_cycle_timer2(client, (union ioctl_arg *)&ct2);
1133 a->local_time = ct2.tv_sec * USEC_PER_SEC + ct2.tv_nsec / NSEC_PER_USEC;
1134 a->cycle_timer = ct2.cycle_timer;
1139 static void iso_resource_work(struct work_struct *work)
1141 struct iso_resource_event *e;
1142 struct iso_resource *r =
1143 container_of(work, struct iso_resource, work.work);
1144 struct client *client = r->client;
1145 int generation, channel, bandwidth, todo;
1146 bool skip, free, success;
1148 spin_lock_irq(&client->lock);
1149 generation = client->device->generation;
1151 /* Allow 1000ms grace period for other reallocations. */
1152 if (todo == ISO_RES_ALLOC &&
1153 time_is_after_jiffies(client->device->card->reset_jiffies + HZ)) {
1154 schedule_iso_resource(r, DIV_ROUND_UP(HZ, 3));
1157 /* We could be called twice within the same generation. */
1158 skip = todo == ISO_RES_REALLOC &&
1159 r->generation == generation;
1161 free = todo == ISO_RES_DEALLOC ||
1162 todo == ISO_RES_ALLOC_ONCE ||
1163 todo == ISO_RES_DEALLOC_ONCE;
1164 r->generation = generation;
1165 spin_unlock_irq(&client->lock);
1170 bandwidth = r->bandwidth;
1172 fw_iso_resource_manage(client->device->card, generation,
1173 r->channels, &channel, &bandwidth,
1174 todo == ISO_RES_ALLOC ||
1175 todo == ISO_RES_REALLOC ||
1176 todo == ISO_RES_ALLOC_ONCE,
1177 r->transaction_data);
1179 * Is this generation outdated already? As long as this resource sticks
1180 * in the idr, it will be scheduled again for a newer generation or at
1183 if (channel == -EAGAIN &&
1184 (todo == ISO_RES_ALLOC || todo == ISO_RES_REALLOC))
1187 success = channel >= 0 || bandwidth > 0;
1189 spin_lock_irq(&client->lock);
1191 * Transit from allocation to reallocation, except if the client
1192 * requested deallocation in the meantime.
1194 if (r->todo == ISO_RES_ALLOC)
1195 r->todo = ISO_RES_REALLOC;
1197 * Allocation or reallocation failure? Pull this resource out of the
1198 * idr and prepare for deletion, unless the client is shutting down.
1200 if (r->todo == ISO_RES_REALLOC && !success &&
1201 !client->in_shutdown &&
1202 idr_find(&client->resource_idr, r->resource.handle)) {
1203 idr_remove(&client->resource_idr, r->resource.handle);
1207 spin_unlock_irq(&client->lock);
1209 if (todo == ISO_RES_ALLOC && channel >= 0)
1210 r->channels = 1ULL << channel;
1212 if (todo == ISO_RES_REALLOC && success)
1215 if (todo == ISO_RES_ALLOC || todo == ISO_RES_ALLOC_ONCE) {
1220 r->e_dealloc = NULL;
1222 e->iso_resource.handle = r->resource.handle;
1223 e->iso_resource.channel = channel;
1224 e->iso_resource.bandwidth = bandwidth;
1226 queue_event(client, &e->event,
1227 &e->iso_resource, sizeof(e->iso_resource), NULL, 0);
1230 cancel_delayed_work(&r->work);
1232 kfree(r->e_dealloc);
1239 static void release_iso_resource(struct client *client,
1240 struct client_resource *resource)
1242 struct iso_resource *r =
1243 container_of(resource, struct iso_resource, resource);
1245 spin_lock_irq(&client->lock);
1246 r->todo = ISO_RES_DEALLOC;
1247 schedule_iso_resource(r, 0);
1248 spin_unlock_irq(&client->lock);
1251 static int init_iso_resource(struct client *client,
1252 struct fw_cdev_allocate_iso_resource *request, int todo)
1254 struct iso_resource_event *e1, *e2;
1255 struct iso_resource *r;
1258 if ((request->channels == 0 && request->bandwidth == 0) ||
1259 request->bandwidth > BANDWIDTH_AVAILABLE_INITIAL ||
1260 request->bandwidth < 0)
1263 r = kmalloc(sizeof(*r), GFP_KERNEL);
1264 e1 = kmalloc(sizeof(*e1), GFP_KERNEL);
1265 e2 = kmalloc(sizeof(*e2), GFP_KERNEL);
1266 if (r == NULL || e1 == NULL || e2 == NULL) {
1271 INIT_DELAYED_WORK(&r->work, iso_resource_work);
1275 r->channels = request->channels;
1276 r->bandwidth = request->bandwidth;
1280 e1->iso_resource.closure = request->closure;
1281 e1->iso_resource.type = FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED;
1282 e2->iso_resource.closure = request->closure;
1283 e2->iso_resource.type = FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED;
1285 if (todo == ISO_RES_ALLOC) {
1286 r->resource.release = release_iso_resource;
1287 ret = add_client_resource(client, &r->resource, GFP_KERNEL);
1291 r->resource.release = NULL;
1292 r->resource.handle = -1;
1293 schedule_iso_resource(r, 0);
1295 request->handle = r->resource.handle;
1306 static int ioctl_allocate_iso_resource(struct client *client,
1307 union ioctl_arg *arg)
1309 return init_iso_resource(client,
1310 &arg->allocate_iso_resource, ISO_RES_ALLOC);
1313 static int ioctl_deallocate_iso_resource(struct client *client,
1314 union ioctl_arg *arg)
1316 return release_client_resource(client,
1317 arg->deallocate.handle, release_iso_resource, NULL);
1320 static int ioctl_allocate_iso_resource_once(struct client *client,
1321 union ioctl_arg *arg)
1323 return init_iso_resource(client,
1324 &arg->allocate_iso_resource, ISO_RES_ALLOC_ONCE);
1327 static int ioctl_deallocate_iso_resource_once(struct client *client,
1328 union ioctl_arg *arg)
1330 return init_iso_resource(client,
1331 &arg->allocate_iso_resource, ISO_RES_DEALLOC_ONCE);
1335 * Returns a speed code: Maximum speed to or from this device,
1336 * limited by the device's link speed, the local node's link speed,
1337 * and all PHY port speeds between the two links.
1339 static int ioctl_get_speed(struct client *client, union ioctl_arg *arg)
1341 return client->device->max_speed;
1344 static int ioctl_send_broadcast_request(struct client *client,
1345 union ioctl_arg *arg)
1347 struct fw_cdev_send_request *a = &arg->send_request;
1350 case TCODE_WRITE_QUADLET_REQUEST:
1351 case TCODE_WRITE_BLOCK_REQUEST:
1357 /* Security policy: Only allow accesses to Units Space. */
1358 if (a->offset < CSR_REGISTER_BASE + CSR_CONFIG_ROM_END)
1361 return init_request(client, a, LOCAL_BUS | 0x3f, SCODE_100);
1364 static int ioctl_send_stream_packet(struct client *client, union ioctl_arg *arg)
1366 struct fw_cdev_send_stream_packet *a = &arg->send_stream_packet;
1367 struct fw_cdev_send_request request;
1370 if (a->speed > client->device->card->link_speed ||
1371 a->length > 1024 << a->speed)
1374 if (a->tag > 3 || a->channel > 63 || a->sy > 15)
1377 dest = fw_stream_packet_destination_id(a->tag, a->channel, a->sy);
1378 request.tcode = TCODE_STREAM_DATA;
1379 request.length = a->length;
1380 request.closure = a->closure;
1381 request.data = a->data;
1382 request.generation = a->generation;
1384 return init_request(client, &request, dest, a->speed);
1387 static int (* const ioctl_handlers[])(struct client *, union ioctl_arg *) = {
1392 ioctl_send_response,
1393 ioctl_initiate_bus_reset,
1394 ioctl_add_descriptor,
1395 ioctl_remove_descriptor,
1396 ioctl_create_iso_context,
1400 ioctl_get_cycle_timer,
1401 ioctl_allocate_iso_resource,
1402 ioctl_deallocate_iso_resource,
1403 ioctl_allocate_iso_resource_once,
1404 ioctl_deallocate_iso_resource_once,
1406 ioctl_send_broadcast_request,
1407 ioctl_send_stream_packet,
1408 ioctl_get_cycle_timer2,
1411 static int dispatch_ioctl(struct client *client,
1412 unsigned int cmd, void __user *arg)
1414 union ioctl_arg buffer;
1417 if (fw_device_is_shutdown(client->device))
1420 if (_IOC_TYPE(cmd) != '#' ||
1421 _IOC_NR(cmd) >= ARRAY_SIZE(ioctl_handlers) ||
1422 _IOC_SIZE(cmd) > sizeof(buffer))
1425 if (_IOC_DIR(cmd) == _IOC_READ)
1426 memset(&buffer, 0, _IOC_SIZE(cmd));
1428 if (_IOC_DIR(cmd) & _IOC_WRITE)
1429 if (copy_from_user(&buffer, arg, _IOC_SIZE(cmd)))
1432 ret = ioctl_handlers[_IOC_NR(cmd)](client, &buffer);
1436 if (_IOC_DIR(cmd) & _IOC_READ)
1437 if (copy_to_user(arg, &buffer, _IOC_SIZE(cmd)))
1443 static long fw_device_op_ioctl(struct file *file,
1444 unsigned int cmd, unsigned long arg)
1446 return dispatch_ioctl(file->private_data, cmd, (void __user *)arg);
1449 #ifdef CONFIG_COMPAT
1450 static long fw_device_op_compat_ioctl(struct file *file,
1451 unsigned int cmd, unsigned long arg)
1453 return dispatch_ioctl(file->private_data, cmd, compat_ptr(arg));
1457 static int fw_device_op_mmap(struct file *file, struct vm_area_struct *vma)
1459 struct client *client = file->private_data;
1460 enum dma_data_direction direction;
1462 int page_count, ret;
1464 if (fw_device_is_shutdown(client->device))
1467 /* FIXME: We could support multiple buffers, but we don't. */
1468 if (client->buffer.pages != NULL)
1471 if (!(vma->vm_flags & VM_SHARED))
1474 if (vma->vm_start & ~PAGE_MASK)
1477 client->vm_start = vma->vm_start;
1478 size = vma->vm_end - vma->vm_start;
1479 page_count = size >> PAGE_SHIFT;
1480 if (size & ~PAGE_MASK)
1483 if (vma->vm_flags & VM_WRITE)
1484 direction = DMA_TO_DEVICE;
1486 direction = DMA_FROM_DEVICE;
1488 ret = fw_iso_buffer_init(&client->buffer, client->device->card,
1489 page_count, direction);
1493 ret = fw_iso_buffer_map(&client->buffer, vma);
1495 fw_iso_buffer_destroy(&client->buffer, client->device->card);
1500 static int shutdown_resource(int id, void *p, void *data)
1502 struct client_resource *resource = p;
1503 struct client *client = data;
1505 resource->release(client, resource);
1511 static int fw_device_op_release(struct inode *inode, struct file *file)
1513 struct client *client = file->private_data;
1514 struct event *event, *next_event;
1516 mutex_lock(&client->device->client_list_mutex);
1517 list_del(&client->link);
1518 mutex_unlock(&client->device->client_list_mutex);
1520 if (client->iso_context)
1521 fw_iso_context_destroy(client->iso_context);
1523 if (client->buffer.pages)
1524 fw_iso_buffer_destroy(&client->buffer, client->device->card);
1526 /* Freeze client->resource_idr and client->event_list */
1527 spin_lock_irq(&client->lock);
1528 client->in_shutdown = true;
1529 spin_unlock_irq(&client->lock);
1531 idr_for_each(&client->resource_idr, shutdown_resource, client);
1532 idr_remove_all(&client->resource_idr);
1533 idr_destroy(&client->resource_idr);
1535 list_for_each_entry_safe(event, next_event, &client->event_list, link)
1543 static unsigned int fw_device_op_poll(struct file *file, poll_table * pt)
1545 struct client *client = file->private_data;
1546 unsigned int mask = 0;
1548 poll_wait(file, &client->wait, pt);
1550 if (fw_device_is_shutdown(client->device))
1551 mask |= POLLHUP | POLLERR;
1552 if (!list_empty(&client->event_list))
1553 mask |= POLLIN | POLLRDNORM;
1558 const struct file_operations fw_device_ops = {
1559 .owner = THIS_MODULE,
1560 .llseek = no_llseek,
1561 .open = fw_device_op_open,
1562 .read = fw_device_op_read,
1563 .unlocked_ioctl = fw_device_op_ioctl,
1564 .mmap = fw_device_op_mmap,
1565 .release = fw_device_op_release,
1566 .poll = fw_device_op_poll,
1567 #ifdef CONFIG_COMPAT
1568 .compat_ioctl = fw_device_op_compat_ioctl,