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/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>
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>
44 #include <asm/system.h>
50 struct fw_device *device;
54 struct idr resource_idr;
55 struct list_head event_list;
56 wait_queue_head_t wait;
57 u64 bus_reset_closure;
59 struct fw_iso_context *iso_context;
61 struct fw_iso_buffer buffer;
62 unsigned long vm_start;
64 struct list_head link;
68 static inline void client_get(struct client *client)
70 kref_get(&client->kref);
73 static void client_release(struct kref *kref)
75 struct client *client = container_of(kref, struct client, kref);
77 fw_device_put(client->device);
81 static void client_put(struct client *client)
83 kref_put(&client->kref, client_release);
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;
94 struct address_handler_resource {
95 struct client_resource resource;
96 struct fw_address_handler handler;
98 struct client *client;
101 struct outbound_transaction_resource {
102 struct client_resource resource;
103 struct fw_transaction transaction;
106 struct inbound_transaction_resource {
107 struct client_resource resource;
108 struct fw_request *request;
113 struct descriptor_resource {
114 struct client_resource resource;
115 struct fw_descriptor descriptor;
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;
129 __be32 transaction_data[2];
130 struct iso_resource_event *e_alloc, *e_dealloc;
133 static void release_iso_resource(struct client *, struct client_resource *);
135 static void schedule_iso_resource(struct iso_resource *r, unsigned long delay)
137 client_get(r->client);
138 if (!schedule_delayed_work(&r->work, delay))
139 client_put(r->client);
142 static void schedule_if_iso_resource(struct client_resource *resource)
144 if (resource->release == release_iso_resource)
145 schedule_iso_resource(container_of(resource,
146 struct iso_resource, resource), 0);
150 * dequeue_event() just kfree()'s the event, so the event has to be
151 * the first field in a struct XYZ_event.
154 struct { void *data; size_t size; } v[2];
155 struct list_head link;
158 struct bus_reset_event {
160 struct fw_cdev_event_bus_reset reset;
163 struct outbound_transaction_event {
165 struct client *client;
166 struct outbound_transaction_resource r;
167 struct fw_cdev_event_response response;
170 struct inbound_transaction_event {
172 struct fw_cdev_event_request request;
175 struct iso_interrupt_event {
177 struct fw_cdev_event_iso_interrupt interrupt;
180 struct iso_resource_event {
182 struct fw_cdev_event_iso_resource iso_resource;
185 static inline void __user *u64_to_uptr(__u64 value)
187 return (void __user *)(unsigned long)value;
190 static inline __u64 uptr_to_u64(void __user *ptr)
192 return (__u64)(unsigned long)ptr;
195 static int fw_device_op_open(struct inode *inode, struct file *file)
197 struct fw_device *device;
198 struct client *client;
200 device = fw_device_get_by_devt(inode->i_rdev);
204 if (fw_device_is_shutdown(device)) {
205 fw_device_put(device);
209 client = kzalloc(sizeof(*client), GFP_KERNEL);
210 if (client == NULL) {
211 fw_device_put(device);
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);
222 file->private_data = client;
224 mutex_lock(&device->client_list_mutex);
225 list_add_tail(&client->link, &device->client_list);
226 mutex_unlock(&device->client_list_mutex);
231 static void queue_event(struct client *client, struct event *event,
232 void *data0, size_t size0, void *data1, size_t size1)
236 event->v[0].data = data0;
237 event->v[0].size = size0;
238 event->v[1].data = data1;
239 event->v[1].size = size1;
241 spin_lock_irqsave(&client->lock, flags);
242 if (client->in_shutdown)
245 list_add_tail(&event->link, &client->event_list);
246 spin_unlock_irqrestore(&client->lock, flags);
248 wake_up_interruptible(&client->wait);
251 static int dequeue_event(struct client *client,
252 char __user *buffer, size_t count)
258 ret = wait_event_interruptible(client->wait,
259 !list_empty(&client->event_list) ||
260 fw_device_is_shutdown(client->device));
264 if (list_empty(&client->event_list) &&
265 fw_device_is_shutdown(client->device))
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);
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)) {
290 static ssize_t fw_device_op_read(struct file *file, char __user *buffer,
291 size_t count, loff_t *offset)
293 struct client *client = file->private_data;
295 return dequeue_event(client, buffer, count);
298 static void fill_bus_reset_event(struct fw_cdev_event_bus_reset *event,
299 struct client *client)
301 struct fw_card *card = client->device->card;
303 spin_lock_irq(&card->lock);
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;
314 spin_unlock_irq(&card->lock);
317 static void for_each_client(struct fw_device *device,
318 void (*callback)(struct client *client))
322 mutex_lock(&device->client_list_mutex);
323 list_for_each_entry(c, &device->client_list, link)
325 mutex_unlock(&device->client_list_mutex);
328 static int schedule_reallocations(int id, void *p, void *data)
330 schedule_if_iso_resource(p);
335 static void queue_bus_reset_event(struct client *client)
337 struct bus_reset_event *e;
339 e = kzalloc(sizeof(*e), GFP_KERNEL);
341 fw_notify("Out of memory when allocating bus reset event\n");
345 fill_bus_reset_event(&e->reset, client);
347 queue_event(client, &e->event,
348 &e->reset, sizeof(e->reset), NULL, 0);
350 spin_lock_irq(&client->lock);
351 idr_for_each(&client->resource_idr, schedule_reallocations, client);
352 spin_unlock_irq(&client->lock);
355 void fw_device_cdev_update(struct fw_device *device)
357 for_each_client(device, queue_bus_reset_event);
360 static void wake_up_client(struct client *client)
362 wake_up_interruptible(&client->wait);
365 void fw_device_cdev_remove(struct fw_device *device)
367 for_each_client(device, wake_up_client);
370 static int ioctl_get_info(struct client *client, void *buffer)
372 struct fw_cdev_get_info *get_info = buffer;
373 struct fw_cdev_event_bus_reset bus_reset;
374 unsigned long ret = 0;
376 client->version = get_info->version;
377 get_info->version = FW_CDEV_VERSION;
378 get_info->card = client->device->card->index;
380 down_read(&fw_device_rwsem);
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;
387 ret = copy_to_user(uptr, client->device->config_rom,
390 get_info->rom_length = client->device->config_rom_length * 4;
392 up_read(&fw_device_rwsem);
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);
401 fill_bus_reset_event(&bus_reset, client);
402 if (copy_to_user(uptr, &bus_reset, sizeof(bus_reset)))
409 static int add_client_resource(struct client *client,
410 struct client_resource *resource, gfp_t gfp_mask)
416 if (idr_pre_get(&client->resource_idr, gfp_mask) == 0)
419 spin_lock_irqsave(&client->lock, flags);
420 if (client->in_shutdown)
423 ret = idr_get_new(&client->resource_idr, resource,
427 schedule_if_iso_resource(resource);
429 spin_unlock_irqrestore(&client->lock, flags);
434 return ret < 0 ? ret : 0;
437 static int release_client_resource(struct client *client, u32 handle,
438 client_resource_release_fn_t release,
439 struct client_resource **return_resource)
441 struct client_resource *resource;
443 spin_lock_irq(&client->lock);
444 if (client->in_shutdown)
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);
452 if (!(resource && resource->release == release))
456 *return_resource = resource;
458 resource->release(client, resource);
465 static void release_transaction(struct client *client,
466 struct client_resource *resource)
468 struct outbound_transaction_resource *r = container_of(resource,
469 struct outbound_transaction_resource, resource);
471 fw_cancel_transaction(client->device->card, &r->transaction);
474 static void complete_transaction(struct fw_card *card, int rcode,
475 void *payload, size_t length, void *data)
477 struct outbound_transaction_event *e = data;
478 struct fw_cdev_event_response *rsp = &e->response;
479 struct client *client = e->client;
482 if (length < rsp->length)
483 rsp->length = length;
484 if (rcode == RCODE_COMPLETE)
485 memcpy(rsp->data, payload, rsp->length);
487 spin_lock_irqsave(&client->lock, flags);
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
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.
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 */
504 spin_unlock_irqrestore(&client->lock, flags);
506 rsp->type = FW_CDEV_EVENT_RESPONSE;
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.
516 if (rsp->length <= sizeof(*rsp) - offsetof(typeof(*rsp), data))
517 queue_event(client, &e->event, rsp, sizeof(*rsp),
518 rsp->data, rsp->length);
520 queue_event(client, &e->event, rsp, sizeof(*rsp) + rsp->length,
523 /* Drop the transaction callback's reference */
527 static int init_request(struct client *client,
528 struct fw_cdev_send_request *request,
529 int destination_id, int speed)
531 struct outbound_transaction_event *e;
534 if (request->tcode != TCODE_STREAM_DATA &&
535 (request->length > 4096 || request->length > 512 << speed))
538 e = kmalloc(sizeof(*e) + request->length, GFP_KERNEL);
543 e->response.length = request->length;
544 e->response.closure = request->closure;
547 copy_from_user(e->response.data,
548 u64_to_uptr(request->data), request->length)) {
553 e->r.resource.release = release_transaction;
554 ret = add_client_resource(client, &e->r.resource, GFP_KERNEL);
558 /* Get a reference for the transaction callback */
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);
573 static int ioctl_send_request(struct client *client, void *buffer)
575 struct fw_cdev_send_request *request = buffer;
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:
594 return init_request(client, request, client->device->node_id,
595 client->device->max_speed);
598 static void release_request(struct client *client,
599 struct client_resource *resource)
601 struct inbound_transaction_resource *r = container_of(resource,
602 struct inbound_transaction_resource, resource);
605 fw_send_response(client->device->card, r->request,
606 RCODE_CONFLICT_ERROR);
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)
616 struct address_handler_resource *handler = callback_data;
617 struct inbound_transaction_resource *r;
618 struct inbound_transaction_event *e;
621 r = kmalloc(sizeof(*r), GFP_ATOMIC);
622 e = kmalloc(sizeof(*e), GFP_ATOMIC);
623 if (r == NULL || e == NULL)
626 r->request = request;
630 r->resource.release = release_request;
631 ret = add_client_resource(handler->client, &r->resource, GFP_ATOMIC);
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;
642 queue_event(handler->client, &e->event,
643 &e->request, sizeof(e->request), payload, length);
650 fw_send_response(card, request, RCODE_CONFLICT_ERROR);
653 static void release_address_handler(struct client *client,
654 struct client_resource *resource)
656 struct address_handler_resource *r =
657 container_of(resource, struct address_handler_resource, resource);
659 fw_core_remove_address_handler(&r->handler);
663 static int ioctl_allocate(struct client *client, void *buffer)
665 struct fw_cdev_allocate *request = buffer;
666 struct address_handler_resource *r;
667 struct fw_address_region region;
670 r = kmalloc(sizeof(*r), GFP_KERNEL);
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;
682 ret = fw_core_add_address_handler(&r->handler, ®ion);
688 r->resource.release = release_address_handler;
689 ret = add_client_resource(client, &r->resource, GFP_KERNEL);
691 release_address_handler(client, &r->resource);
694 request->handle = r->resource.handle;
699 static int ioctl_deallocate(struct client *client, void *buffer)
701 struct fw_cdev_deallocate *request = buffer;
703 return release_client_resource(client, request->handle,
704 release_address_handler, NULL);
707 static int ioctl_send_response(struct client *client, void *buffer)
709 struct fw_cdev_send_response *request = buffer;
710 struct client_resource *resource;
711 struct inbound_transaction_resource *r;
714 if (release_client_resource(client, request->handle,
715 release_request, &resource) < 0)
718 r = container_of(resource, struct inbound_transaction_resource,
721 if (request->length < r->length)
722 r->length = request->length;
723 if (copy_from_user(r->data, u64_to_uptr(request->data),
729 fw_send_response(client->device->card, r->request,
738 static int ioctl_initiate_bus_reset(struct client *client, void *buffer)
740 struct fw_cdev_initiate_bus_reset *request = buffer;
743 short_reset = (request->type == FW_CDEV_SHORT_RESET);
745 return fw_core_initiate_bus_reset(client->device->card, short_reset);
748 static void release_descriptor(struct client *client,
749 struct client_resource *resource)
751 struct descriptor_resource *r =
752 container_of(resource, struct descriptor_resource, resource);
754 fw_core_remove_descriptor(&r->descriptor);
758 static int ioctl_add_descriptor(struct client *client, void *buffer)
760 struct fw_cdev_add_descriptor *request = buffer;
761 struct descriptor_resource *r;
764 /* Access policy: Allow this ioctl only on local nodes' device files. */
765 if (!client->device->is_local)
768 if (request->length > 256)
771 r = kmalloc(sizeof(*r) + request->length * 4, GFP_KERNEL);
775 if (copy_from_user(r->data,
776 u64_to_uptr(request->data), request->length * 4)) {
781 r->descriptor.length = request->length;
782 r->descriptor.immediate = request->immediate;
783 r->descriptor.key = request->key;
784 r->descriptor.data = r->data;
786 ret = fw_core_add_descriptor(&r->descriptor);
790 r->resource.release = release_descriptor;
791 ret = add_client_resource(client, &r->resource, GFP_KERNEL);
793 fw_core_remove_descriptor(&r->descriptor);
796 request->handle = r->resource.handle;
805 static int ioctl_remove_descriptor(struct client *client, void *buffer)
807 struct fw_cdev_remove_descriptor *request = buffer;
809 return release_client_resource(client, request->handle,
810 release_descriptor, NULL);
813 static void iso_callback(struct fw_iso_context *context, u32 cycle,
814 size_t header_length, void *header, void *data)
816 struct client *client = data;
817 struct iso_interrupt_event *e;
819 e = kzalloc(sizeof(*e) + header_length, GFP_ATOMIC);
823 e->interrupt.type = FW_CDEV_EVENT_ISO_INTERRUPT;
824 e->interrupt.closure = client->iso_closure;
825 e->interrupt.cycle = cycle;
826 e->interrupt.header_length = header_length;
827 memcpy(e->interrupt.header, header, header_length);
828 queue_event(client, &e->event, &e->interrupt,
829 sizeof(e->interrupt) + header_length, NULL, 0);
832 static int ioctl_create_iso_context(struct client *client, void *buffer)
834 struct fw_cdev_create_iso_context *request = buffer;
835 struct fw_iso_context *context;
837 /* We only support one context at this time. */
838 if (client->iso_context != NULL)
841 if (request->channel > 63)
844 switch (request->type) {
845 case FW_ISO_CONTEXT_RECEIVE:
846 if (request->header_size < 4 || (request->header_size & 3))
851 case FW_ISO_CONTEXT_TRANSMIT:
852 if (request->speed > SCODE_3200)
861 context = fw_iso_context_create(client->device->card,
865 request->header_size,
866 iso_callback, client);
868 return PTR_ERR(context);
870 client->iso_closure = request->closure;
871 client->iso_context = context;
873 /* We only support one context at this time. */
879 /* Macros for decoding the iso packet control header. */
880 #define GET_PAYLOAD_LENGTH(v) ((v) & 0xffff)
881 #define GET_INTERRUPT(v) (((v) >> 16) & 0x01)
882 #define GET_SKIP(v) (((v) >> 17) & 0x01)
883 #define GET_TAG(v) (((v) >> 18) & 0x03)
884 #define GET_SY(v) (((v) >> 20) & 0x0f)
885 #define GET_HEADER_LENGTH(v) (((v) >> 24) & 0xff)
887 static int ioctl_queue_iso(struct client *client, void *buffer)
889 struct fw_cdev_queue_iso *request = buffer;
890 struct fw_cdev_iso_packet __user *p, *end, *next;
891 struct fw_iso_context *ctx = client->iso_context;
892 unsigned long payload, buffer_end, header_length;
896 struct fw_iso_packet packet;
900 if (ctx == NULL || request->handle != 0)
904 * If the user passes a non-NULL data pointer, has mmap()'ed
905 * the iso buffer, and the pointer points inside the buffer,
906 * we setup the payload pointers accordingly. Otherwise we
907 * set them both to 0, which will still let packets with
908 * payload_length == 0 through. In other words, if no packets
909 * use the indirect payload, the iso buffer need not be mapped
910 * and the request->data pointer is ignored.
913 payload = (unsigned long)request->data - client->vm_start;
914 buffer_end = client->buffer.page_count << PAGE_SHIFT;
915 if (request->data == 0 || client->buffer.pages == NULL ||
916 payload >= buffer_end) {
921 p = (struct fw_cdev_iso_packet __user *)u64_to_uptr(request->packets);
923 if (!access_ok(VERIFY_READ, p, request->size))
926 end = (void __user *)p + request->size;
929 if (get_user(control, &p->control))
931 u.packet.payload_length = GET_PAYLOAD_LENGTH(control);
932 u.packet.interrupt = GET_INTERRUPT(control);
933 u.packet.skip = GET_SKIP(control);
934 u.packet.tag = GET_TAG(control);
935 u.packet.sy = GET_SY(control);
936 u.packet.header_length = GET_HEADER_LENGTH(control);
938 if (ctx->type == FW_ISO_CONTEXT_TRANSMIT) {
939 header_length = u.packet.header_length;
942 * We require that header_length is a multiple of
943 * the fixed header size, ctx->header_size.
945 if (ctx->header_size == 0) {
946 if (u.packet.header_length > 0)
948 } else if (u.packet.header_length % ctx->header_size != 0) {
954 next = (struct fw_cdev_iso_packet __user *)
955 &p->header[header_length / 4];
959 (u.packet.header, p->header, header_length))
961 if (u.packet.skip && ctx->type == FW_ISO_CONTEXT_TRANSMIT &&
962 u.packet.header_length + u.packet.payload_length > 0)
964 if (payload + u.packet.payload_length > buffer_end)
967 if (fw_iso_context_queue(ctx, &u.packet,
968 &client->buffer, payload))
972 payload += u.packet.payload_length;
976 request->size -= uptr_to_u64(p) - request->packets;
977 request->packets = uptr_to_u64(p);
978 request->data = client->vm_start + payload;
983 static int ioctl_start_iso(struct client *client, void *buffer)
985 struct fw_cdev_start_iso *request = buffer;
987 if (client->iso_context == NULL || request->handle != 0)
990 if (client->iso_context->type == FW_ISO_CONTEXT_RECEIVE) {
991 if (request->tags == 0 || request->tags > 15)
994 if (request->sync > 15)
998 return fw_iso_context_start(client->iso_context, request->cycle,
999 request->sync, request->tags);
1002 static int ioctl_stop_iso(struct client *client, void *buffer)
1004 struct fw_cdev_stop_iso *request = buffer;
1006 if (client->iso_context == NULL || request->handle != 0)
1009 return fw_iso_context_stop(client->iso_context);
1012 static int ioctl_get_cycle_timer(struct client *client, void *buffer)
1014 struct fw_cdev_get_cycle_timer *request = buffer;
1015 struct fw_card *card = client->device->card;
1016 unsigned long long bus_time;
1018 unsigned long flags;
1021 local_irq_save(flags);
1023 bus_time = card->driver->get_bus_time(card);
1024 do_gettimeofday(&tv);
1026 local_irq_restore(flags);
1029 request->local_time = tv.tv_sec * 1000000ULL + tv.tv_usec;
1030 request->cycle_timer = bus_time & 0xffffffff;
1034 static void iso_resource_work(struct work_struct *work)
1036 struct iso_resource_event *e;
1037 struct iso_resource *r =
1038 container_of(work, struct iso_resource, work.work);
1039 struct client *client = r->client;
1040 int generation, channel, bandwidth, todo;
1041 bool skip, free, success;
1043 spin_lock_irq(&client->lock);
1044 generation = client->device->generation;
1046 /* Allow 1000ms grace period for other reallocations. */
1047 if (todo == ISO_RES_ALLOC &&
1048 time_is_after_jiffies(client->device->card->reset_jiffies + HZ)) {
1049 schedule_iso_resource(r, DIV_ROUND_UP(HZ, 3));
1052 /* We could be called twice within the same generation. */
1053 skip = todo == ISO_RES_REALLOC &&
1054 r->generation == generation;
1056 free = todo == ISO_RES_DEALLOC ||
1057 todo == ISO_RES_ALLOC_ONCE ||
1058 todo == ISO_RES_DEALLOC_ONCE;
1059 r->generation = generation;
1060 spin_unlock_irq(&client->lock);
1065 bandwidth = r->bandwidth;
1067 fw_iso_resource_manage(client->device->card, generation,
1068 r->channels, &channel, &bandwidth,
1069 todo == ISO_RES_ALLOC ||
1070 todo == ISO_RES_REALLOC ||
1071 todo == ISO_RES_ALLOC_ONCE,
1072 r->transaction_data);
1074 * Is this generation outdated already? As long as this resource sticks
1075 * in the idr, it will be scheduled again for a newer generation or at
1078 if (channel == -EAGAIN &&
1079 (todo == ISO_RES_ALLOC || todo == ISO_RES_REALLOC))
1082 success = channel >= 0 || bandwidth > 0;
1084 spin_lock_irq(&client->lock);
1086 * Transit from allocation to reallocation, except if the client
1087 * requested deallocation in the meantime.
1089 if (r->todo == ISO_RES_ALLOC)
1090 r->todo = ISO_RES_REALLOC;
1092 * Allocation or reallocation failure? Pull this resource out of the
1093 * idr and prepare for deletion, unless the client is shutting down.
1095 if (r->todo == ISO_RES_REALLOC && !success &&
1096 !client->in_shutdown &&
1097 idr_find(&client->resource_idr, r->resource.handle)) {
1098 idr_remove(&client->resource_idr, r->resource.handle);
1102 spin_unlock_irq(&client->lock);
1104 if (todo == ISO_RES_ALLOC && channel >= 0)
1105 r->channels = 1ULL << channel;
1107 if (todo == ISO_RES_REALLOC && success)
1110 if (todo == ISO_RES_ALLOC || todo == ISO_RES_ALLOC_ONCE) {
1115 r->e_dealloc = NULL;
1117 e->iso_resource.handle = r->resource.handle;
1118 e->iso_resource.channel = channel;
1119 e->iso_resource.bandwidth = bandwidth;
1121 queue_event(client, &e->event,
1122 &e->iso_resource, sizeof(e->iso_resource), NULL, 0);
1125 cancel_delayed_work(&r->work);
1127 kfree(r->e_dealloc);
1134 static void release_iso_resource(struct client *client,
1135 struct client_resource *resource)
1137 struct iso_resource *r =
1138 container_of(resource, struct iso_resource, resource);
1140 spin_lock_irq(&client->lock);
1141 r->todo = ISO_RES_DEALLOC;
1142 schedule_iso_resource(r, 0);
1143 spin_unlock_irq(&client->lock);
1146 static int init_iso_resource(struct client *client,
1147 struct fw_cdev_allocate_iso_resource *request, int todo)
1149 struct iso_resource_event *e1, *e2;
1150 struct iso_resource *r;
1153 if ((request->channels == 0 && request->bandwidth == 0) ||
1154 request->bandwidth > BANDWIDTH_AVAILABLE_INITIAL ||
1155 request->bandwidth < 0)
1158 r = kmalloc(sizeof(*r), GFP_KERNEL);
1159 e1 = kmalloc(sizeof(*e1), GFP_KERNEL);
1160 e2 = kmalloc(sizeof(*e2), GFP_KERNEL);
1161 if (r == NULL || e1 == NULL || e2 == NULL) {
1166 INIT_DELAYED_WORK(&r->work, iso_resource_work);
1170 r->channels = request->channels;
1171 r->bandwidth = request->bandwidth;
1175 e1->iso_resource.closure = request->closure;
1176 e1->iso_resource.type = FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED;
1177 e2->iso_resource.closure = request->closure;
1178 e2->iso_resource.type = FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED;
1180 if (todo == ISO_RES_ALLOC) {
1181 r->resource.release = release_iso_resource;
1182 ret = add_client_resource(client, &r->resource, GFP_KERNEL);
1186 r->resource.release = NULL;
1187 r->resource.handle = -1;
1188 schedule_iso_resource(r, 0);
1190 request->handle = r->resource.handle;
1201 static int ioctl_allocate_iso_resource(struct client *client, void *buffer)
1203 struct fw_cdev_allocate_iso_resource *request = buffer;
1205 return init_iso_resource(client, request, ISO_RES_ALLOC);
1208 static int ioctl_deallocate_iso_resource(struct client *client, void *buffer)
1210 struct fw_cdev_deallocate *request = buffer;
1212 return release_client_resource(client, request->handle,
1213 release_iso_resource, NULL);
1216 static int ioctl_allocate_iso_resource_once(struct client *client, void *buffer)
1218 struct fw_cdev_allocate_iso_resource *request = buffer;
1220 return init_iso_resource(client, request, ISO_RES_ALLOC_ONCE);
1223 static int ioctl_deallocate_iso_resource_once(struct client *client, void *buffer)
1225 struct fw_cdev_allocate_iso_resource *request = buffer;
1227 return init_iso_resource(client, request, ISO_RES_DEALLOC_ONCE);
1231 * Returns a speed code: Maximum speed to or from this device,
1232 * limited by the device's link speed, the local node's link speed,
1233 * and all PHY port speeds between the two links.
1235 static int ioctl_get_speed(struct client *client, void *buffer)
1237 return client->device->max_speed;
1240 static int ioctl_send_broadcast_request(struct client *client, void *buffer)
1242 struct fw_cdev_send_request *request = buffer;
1244 switch (request->tcode) {
1245 case TCODE_WRITE_QUADLET_REQUEST:
1246 case TCODE_WRITE_BLOCK_REQUEST:
1252 /* Security policy: Only allow accesses to Units Space. */
1253 if (request->offset < CSR_REGISTER_BASE + CSR_CONFIG_ROM_END)
1256 return init_request(client, request, LOCAL_BUS | 0x3f, SCODE_100);
1259 static int ioctl_send_stream_packet(struct client *client, void *buffer)
1261 struct fw_cdev_send_stream_packet *p = buffer;
1262 struct fw_cdev_send_request request;
1265 if (p->speed > client->device->card->link_speed ||
1266 p->length > 1024 << p->speed)
1269 if (p->tag > 3 || p->channel > 63 || p->sy > 15)
1272 dest = fw_stream_packet_destination_id(p->tag, p->channel, p->sy);
1273 request.tcode = TCODE_STREAM_DATA;
1274 request.length = p->length;
1275 request.closure = p->closure;
1276 request.data = p->data;
1277 request.generation = p->generation;
1279 return init_request(client, &request, dest, p->speed);
1282 static int (* const ioctl_handlers[])(struct client *client, void *buffer) = {
1287 ioctl_send_response,
1288 ioctl_initiate_bus_reset,
1289 ioctl_add_descriptor,
1290 ioctl_remove_descriptor,
1291 ioctl_create_iso_context,
1295 ioctl_get_cycle_timer,
1296 ioctl_allocate_iso_resource,
1297 ioctl_deallocate_iso_resource,
1298 ioctl_allocate_iso_resource_once,
1299 ioctl_deallocate_iso_resource_once,
1301 ioctl_send_broadcast_request,
1302 ioctl_send_stream_packet,
1305 static int dispatch_ioctl(struct client *client,
1306 unsigned int cmd, void __user *arg)
1308 char buffer[sizeof(union {
1309 struct fw_cdev_get_info _00;
1310 struct fw_cdev_send_request _01;
1311 struct fw_cdev_allocate _02;
1312 struct fw_cdev_deallocate _03;
1313 struct fw_cdev_send_response _04;
1314 struct fw_cdev_initiate_bus_reset _05;
1315 struct fw_cdev_add_descriptor _06;
1316 struct fw_cdev_remove_descriptor _07;
1317 struct fw_cdev_create_iso_context _08;
1318 struct fw_cdev_queue_iso _09;
1319 struct fw_cdev_start_iso _0a;
1320 struct fw_cdev_stop_iso _0b;
1321 struct fw_cdev_get_cycle_timer _0c;
1322 struct fw_cdev_allocate_iso_resource _0d;
1323 struct fw_cdev_send_stream_packet _13;
1327 if (_IOC_TYPE(cmd) != '#' ||
1328 _IOC_NR(cmd) >= ARRAY_SIZE(ioctl_handlers))
1331 if (_IOC_DIR(cmd) & _IOC_WRITE) {
1332 if (_IOC_SIZE(cmd) > sizeof(buffer) ||
1333 copy_from_user(buffer, arg, _IOC_SIZE(cmd)))
1337 ret = ioctl_handlers[_IOC_NR(cmd)](client, buffer);
1341 if (_IOC_DIR(cmd) & _IOC_READ) {
1342 if (_IOC_SIZE(cmd) > sizeof(buffer) ||
1343 copy_to_user(arg, buffer, _IOC_SIZE(cmd)))
1350 static long fw_device_op_ioctl(struct file *file,
1351 unsigned int cmd, unsigned long arg)
1353 struct client *client = file->private_data;
1355 if (fw_device_is_shutdown(client->device))
1358 return dispatch_ioctl(client, cmd, (void __user *) arg);
1361 #ifdef CONFIG_COMPAT
1362 static long fw_device_op_compat_ioctl(struct file *file,
1363 unsigned int cmd, unsigned long arg)
1365 struct client *client = file->private_data;
1367 if (fw_device_is_shutdown(client->device))
1370 return dispatch_ioctl(client, cmd, compat_ptr(arg));
1374 static int fw_device_op_mmap(struct file *file, struct vm_area_struct *vma)
1376 struct client *client = file->private_data;
1377 enum dma_data_direction direction;
1379 int page_count, ret;
1381 if (fw_device_is_shutdown(client->device))
1384 /* FIXME: We could support multiple buffers, but we don't. */
1385 if (client->buffer.pages != NULL)
1388 if (!(vma->vm_flags & VM_SHARED))
1391 if (vma->vm_start & ~PAGE_MASK)
1394 client->vm_start = vma->vm_start;
1395 size = vma->vm_end - vma->vm_start;
1396 page_count = size >> PAGE_SHIFT;
1397 if (size & ~PAGE_MASK)
1400 if (vma->vm_flags & VM_WRITE)
1401 direction = DMA_TO_DEVICE;
1403 direction = DMA_FROM_DEVICE;
1405 ret = fw_iso_buffer_init(&client->buffer, client->device->card,
1406 page_count, direction);
1410 ret = fw_iso_buffer_map(&client->buffer, vma);
1412 fw_iso_buffer_destroy(&client->buffer, client->device->card);
1417 static int shutdown_resource(int id, void *p, void *data)
1419 struct client_resource *resource = p;
1420 struct client *client = data;
1422 resource->release(client, resource);
1428 static int fw_device_op_release(struct inode *inode, struct file *file)
1430 struct client *client = file->private_data;
1431 struct event *event, *next_event;
1433 mutex_lock(&client->device->client_list_mutex);
1434 list_del(&client->link);
1435 mutex_unlock(&client->device->client_list_mutex);
1437 if (client->iso_context)
1438 fw_iso_context_destroy(client->iso_context);
1440 if (client->buffer.pages)
1441 fw_iso_buffer_destroy(&client->buffer, client->device->card);
1443 /* Freeze client->resource_idr and client->event_list */
1444 spin_lock_irq(&client->lock);
1445 client->in_shutdown = true;
1446 spin_unlock_irq(&client->lock);
1448 idr_for_each(&client->resource_idr, shutdown_resource, client);
1449 idr_remove_all(&client->resource_idr);
1450 idr_destroy(&client->resource_idr);
1452 list_for_each_entry_safe(event, next_event, &client->event_list, link)
1460 static unsigned int fw_device_op_poll(struct file *file, poll_table * pt)
1462 struct client *client = file->private_data;
1463 unsigned int mask = 0;
1465 poll_wait(file, &client->wait, pt);
1467 if (fw_device_is_shutdown(client->device))
1468 mask |= POLLHUP | POLLERR;
1469 if (!list_empty(&client->event_list))
1470 mask |= POLLIN | POLLRDNORM;
1475 const struct file_operations fw_device_ops = {
1476 .owner = THIS_MODULE,
1477 .open = fw_device_op_open,
1478 .read = fw_device_op_read,
1479 .unlocked_ioctl = fw_device_op_ioctl,
1480 .poll = fw_device_op_poll,
1481 .release = fw_device_op_release,
1482 .mmap = fw_device_op_mmap,
1484 #ifdef CONFIG_COMPAT
1485 .compat_ioctl = fw_device_op_compat_ioctl,