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/module.h>
22 #include <linux/kernel.h>
23 #include <linux/wait.h>
24 #include <linux/errno.h>
25 #include <linux/device.h>
26 #include <linux/vmalloc.h>
27 #include <linux/poll.h>
28 #include <linux/preempt.h>
29 #include <linux/time.h>
30 #include <linux/delay.h>
32 #include <linux/idr.h>
33 #include <linux/compat.h>
34 #include <linux/firewire-cdev.h>
35 #include <asm/system.h>
36 #include <asm/uaccess.h>
37 #include "fw-transaction.h"
38 #include "fw-topology.h"
39 #include "fw-device.h"
42 struct client_resource {
43 struct list_head link;
44 void (*release)(struct client *client, struct client_resource *r);
49 * dequeue_event() just kfree()'s the event, so the event has to be
50 * the first field in the struct.
54 struct { void *data; size_t size; } v[2];
55 struct list_head link;
60 struct fw_cdev_event_bus_reset reset;
65 struct fw_transaction transaction;
66 struct client *client;
67 struct client_resource resource;
68 struct fw_cdev_event_response response;
71 struct iso_interrupt {
73 struct fw_cdev_event_iso_interrupt interrupt;
78 struct fw_device *device;
81 struct list_head resource_list;
82 struct list_head event_list;
83 wait_queue_head_t wait;
84 u64 bus_reset_closure;
86 struct fw_iso_context *iso_context;
88 struct fw_iso_buffer buffer;
89 unsigned long vm_start;
91 struct list_head link;
94 static inline void __user *
95 u64_to_uptr(__u64 value)
97 return (void __user *)(unsigned long)value;
101 uptr_to_u64(void __user *ptr)
103 return (__u64)(unsigned long)ptr;
106 static int fw_device_op_open(struct inode *inode, struct file *file)
108 struct fw_device *device;
109 struct client *client;
112 device = fw_device_get_by_devt(inode->i_rdev);
116 if (fw_device_is_shutdown(device)) {
117 fw_device_put(device);
121 client = kzalloc(sizeof(*client), GFP_KERNEL);
122 if (client == NULL) {
123 fw_device_put(device);
127 client->device = device;
128 INIT_LIST_HEAD(&client->event_list);
129 INIT_LIST_HEAD(&client->resource_list);
130 spin_lock_init(&client->lock);
131 init_waitqueue_head(&client->wait);
133 file->private_data = client;
135 spin_lock_irqsave(&device->card->lock, flags);
136 list_add_tail(&client->link, &device->client_list);
137 spin_unlock_irqrestore(&device->card->lock, flags);
142 static void queue_event(struct client *client, struct event *event,
143 void *data0, size_t size0, void *data1, size_t size1)
147 event->v[0].data = data0;
148 event->v[0].size = size0;
149 event->v[1].data = data1;
150 event->v[1].size = size1;
152 spin_lock_irqsave(&client->lock, flags);
153 list_add_tail(&event->link, &client->event_list);
154 spin_unlock_irqrestore(&client->lock, flags);
156 wake_up_interruptible(&client->wait);
160 dequeue_event(struct client *client, char __user *buffer, size_t count)
167 retval = wait_event_interruptible(client->wait,
168 !list_empty(&client->event_list) ||
169 fw_device_is_shutdown(client->device));
173 if (list_empty(&client->event_list) &&
174 fw_device_is_shutdown(client->device))
177 spin_lock_irqsave(&client->lock, flags);
178 event = container_of(client->event_list.next, struct event, link);
179 list_del(&event->link);
180 spin_unlock_irqrestore(&client->lock, flags);
183 for (i = 0; i < ARRAY_SIZE(event->v) && total < count; i++) {
184 size = min(event->v[i].size, count - total);
185 if (copy_to_user(buffer + total, event->v[i].data, size)) {
200 fw_device_op_read(struct file *file,
201 char __user *buffer, size_t count, loff_t *offset)
203 struct client *client = file->private_data;
205 return dequeue_event(client, buffer, count);
208 /* caller must hold card->lock so that node pointers can be dereferenced here */
210 fill_bus_reset_event(struct fw_cdev_event_bus_reset *event,
211 struct client *client)
213 struct fw_card *card = client->device->card;
215 event->closure = client->bus_reset_closure;
216 event->type = FW_CDEV_EVENT_BUS_RESET;
217 event->generation = client->device->generation;
218 event->node_id = client->device->node_id;
219 event->local_node_id = card->local_node->node_id;
220 event->bm_node_id = 0; /* FIXME: We don't track the BM. */
221 event->irm_node_id = card->irm_node->node_id;
222 event->root_node_id = card->root_node->node_id;
226 for_each_client(struct fw_device *device,
227 void (*callback)(struct client *client))
229 struct fw_card *card = device->card;
233 spin_lock_irqsave(&card->lock, flags);
235 list_for_each_entry(c, &device->client_list, link)
238 spin_unlock_irqrestore(&card->lock, flags);
242 queue_bus_reset_event(struct client *client)
244 struct bus_reset *bus_reset;
246 bus_reset = kzalloc(sizeof(*bus_reset), GFP_ATOMIC);
247 if (bus_reset == NULL) {
248 fw_notify("Out of memory when allocating bus reset event\n");
252 fill_bus_reset_event(&bus_reset->reset, client);
254 queue_event(client, &bus_reset->event,
255 &bus_reset->reset, sizeof(bus_reset->reset), NULL, 0);
258 void fw_device_cdev_update(struct fw_device *device)
260 for_each_client(device, queue_bus_reset_event);
263 static void wake_up_client(struct client *client)
265 wake_up_interruptible(&client->wait);
268 void fw_device_cdev_remove(struct fw_device *device)
270 for_each_client(device, wake_up_client);
273 static int ioctl_get_info(struct client *client, void *buffer)
275 struct fw_cdev_get_info *get_info = buffer;
276 struct fw_cdev_event_bus_reset bus_reset;
277 struct fw_card *card = client->device->card;
278 unsigned long ret = 0;
280 client->version = get_info->version;
281 get_info->version = FW_CDEV_VERSION;
283 down_read(&fw_device_rwsem);
285 if (get_info->rom != 0) {
286 void __user *uptr = u64_to_uptr(get_info->rom);
287 size_t want = get_info->rom_length;
288 size_t have = client->device->config_rom_length * 4;
290 ret = copy_to_user(uptr, client->device->config_rom,
293 get_info->rom_length = client->device->config_rom_length * 4;
295 up_read(&fw_device_rwsem);
300 client->bus_reset_closure = get_info->bus_reset_closure;
301 if (get_info->bus_reset != 0) {
302 void __user *uptr = u64_to_uptr(get_info->bus_reset);
305 spin_lock_irqsave(&card->lock, flags);
306 fill_bus_reset_event(&bus_reset, client);
307 spin_unlock_irqrestore(&card->lock, flags);
309 if (copy_to_user(uptr, &bus_reset, sizeof(bus_reset)))
313 get_info->card = card->index;
319 add_client_resource(struct client *client, struct client_resource *resource)
323 spin_lock_irqsave(&client->lock, flags);
324 list_add_tail(&resource->link, &client->resource_list);
325 resource->handle = client->resource_handle++;
326 spin_unlock_irqrestore(&client->lock, flags);
330 release_client_resource(struct client *client, u32 handle,
331 struct client_resource **resource)
333 struct client_resource *r;
336 spin_lock_irqsave(&client->lock, flags);
337 list_for_each_entry(r, &client->resource_list, link) {
338 if (r->handle == handle) {
343 spin_unlock_irqrestore(&client->lock, flags);
345 if (&r->link == &client->resource_list)
351 r->release(client, r);
357 release_transaction(struct client *client, struct client_resource *resource)
359 struct response *response =
360 container_of(resource, struct response, resource);
362 fw_cancel_transaction(client->device->card, &response->transaction);
366 complete_transaction(struct fw_card *card, int rcode,
367 void *payload, size_t length, void *data)
369 struct response *response = data;
370 struct client *client = response->client;
373 if (length < response->response.length)
374 response->response.length = length;
375 if (rcode == RCODE_COMPLETE)
376 memcpy(response->response.data, payload,
377 response->response.length);
379 spin_lock_irqsave(&client->lock, flags);
380 list_del(&response->resource.link);
381 spin_unlock_irqrestore(&client->lock, flags);
383 response->response.type = FW_CDEV_EVENT_RESPONSE;
384 response->response.rcode = rcode;
385 queue_event(client, &response->event,
386 &response->response, sizeof(response->response),
387 response->response.data, response->response.length);
390 static int ioctl_send_request(struct client *client, void *buffer)
392 struct fw_device *device = client->device;
393 struct fw_cdev_send_request *request = buffer;
394 struct response *response;
396 /* What is the biggest size we'll accept, really? */
397 if (request->length > 4096)
400 response = kmalloc(sizeof(*response) + request->length, GFP_KERNEL);
401 if (response == NULL)
404 response->client = client;
405 response->response.length = request->length;
406 response->response.closure = request->closure;
409 copy_from_user(response->response.data,
410 u64_to_uptr(request->data), request->length)) {
415 response->resource.release = release_transaction;
416 add_client_resource(client, &response->resource);
418 fw_send_request(device->card, &response->transaction,
419 request->tcode & 0x1f,
420 device->node->node_id,
424 response->response.data, request->length,
425 complete_transaction, response);
428 return sizeof(request) + request->length;
430 return sizeof(request);
433 struct address_handler {
434 struct fw_address_handler handler;
436 struct client *client;
437 struct client_resource resource;
441 struct fw_request *request;
444 struct client_resource resource;
447 struct request_event {
449 struct fw_cdev_event_request request;
453 release_request(struct client *client, struct client_resource *resource)
455 struct request *request =
456 container_of(resource, struct request, resource);
458 fw_send_response(client->device->card, request->request,
459 RCODE_CONFLICT_ERROR);
464 handle_request(struct fw_card *card, struct fw_request *r,
465 int tcode, int destination, int source,
466 int generation, int speed,
467 unsigned long long offset,
468 void *payload, size_t length, void *callback_data)
470 struct address_handler *handler = callback_data;
471 struct request *request;
472 struct request_event *e;
473 struct client *client = handler->client;
475 request = kmalloc(sizeof(*request), GFP_ATOMIC);
476 e = kmalloc(sizeof(*e), GFP_ATOMIC);
477 if (request == NULL || e == NULL) {
480 fw_send_response(card, r, RCODE_CONFLICT_ERROR);
484 request->request = r;
485 request->data = payload;
486 request->length = length;
488 request->resource.release = release_request;
489 add_client_resource(client, &request->resource);
491 e->request.type = FW_CDEV_EVENT_REQUEST;
492 e->request.tcode = tcode;
493 e->request.offset = offset;
494 e->request.length = length;
495 e->request.handle = request->resource.handle;
496 e->request.closure = handler->closure;
498 queue_event(client, &e->event,
499 &e->request, sizeof(e->request), payload, length);
503 release_address_handler(struct client *client,
504 struct client_resource *resource)
506 struct address_handler *handler =
507 container_of(resource, struct address_handler, resource);
509 fw_core_remove_address_handler(&handler->handler);
513 static int ioctl_allocate(struct client *client, void *buffer)
515 struct fw_cdev_allocate *request = buffer;
516 struct address_handler *handler;
517 struct fw_address_region region;
519 handler = kmalloc(sizeof(*handler), GFP_KERNEL);
523 region.start = request->offset;
524 region.end = request->offset + request->length;
525 handler->handler.length = request->length;
526 handler->handler.address_callback = handle_request;
527 handler->handler.callback_data = handler;
528 handler->closure = request->closure;
529 handler->client = client;
531 if (fw_core_add_address_handler(&handler->handler, ®ion) < 0) {
536 handler->resource.release = release_address_handler;
537 add_client_resource(client, &handler->resource);
538 request->handle = handler->resource.handle;
543 static int ioctl_deallocate(struct client *client, void *buffer)
545 struct fw_cdev_deallocate *request = buffer;
547 return release_client_resource(client, request->handle, NULL);
550 static int ioctl_send_response(struct client *client, void *buffer)
552 struct fw_cdev_send_response *request = buffer;
553 struct client_resource *resource;
556 if (release_client_resource(client, request->handle, &resource) < 0)
558 r = container_of(resource, struct request, resource);
559 if (request->length < r->length)
560 r->length = request->length;
561 if (copy_from_user(r->data, u64_to_uptr(request->data), r->length))
564 fw_send_response(client->device->card, r->request, request->rcode);
570 static int ioctl_initiate_bus_reset(struct client *client, void *buffer)
572 struct fw_cdev_initiate_bus_reset *request = buffer;
575 short_reset = (request->type == FW_CDEV_SHORT_RESET);
577 return fw_core_initiate_bus_reset(client->device->card, short_reset);
581 struct fw_descriptor d;
582 struct client_resource resource;
586 static void release_descriptor(struct client *client,
587 struct client_resource *resource)
589 struct descriptor *descriptor =
590 container_of(resource, struct descriptor, resource);
592 fw_core_remove_descriptor(&descriptor->d);
596 static int ioctl_add_descriptor(struct client *client, void *buffer)
598 struct fw_cdev_add_descriptor *request = buffer;
599 struct descriptor *descriptor;
602 if (request->length > 256)
606 kmalloc(sizeof(*descriptor) + request->length * 4, GFP_KERNEL);
607 if (descriptor == NULL)
610 if (copy_from_user(descriptor->data,
611 u64_to_uptr(request->data), request->length * 4)) {
616 descriptor->d.length = request->length;
617 descriptor->d.immediate = request->immediate;
618 descriptor->d.key = request->key;
619 descriptor->d.data = descriptor->data;
621 retval = fw_core_add_descriptor(&descriptor->d);
627 descriptor->resource.release = release_descriptor;
628 add_client_resource(client, &descriptor->resource);
629 request->handle = descriptor->resource.handle;
634 static int ioctl_remove_descriptor(struct client *client, void *buffer)
636 struct fw_cdev_remove_descriptor *request = buffer;
638 return release_client_resource(client, request->handle, NULL);
642 iso_callback(struct fw_iso_context *context, u32 cycle,
643 size_t header_length, void *header, void *data)
645 struct client *client = data;
646 struct iso_interrupt *irq;
648 irq = kzalloc(sizeof(*irq) + header_length, GFP_ATOMIC);
652 irq->interrupt.type = FW_CDEV_EVENT_ISO_INTERRUPT;
653 irq->interrupt.closure = client->iso_closure;
654 irq->interrupt.cycle = cycle;
655 irq->interrupt.header_length = header_length;
656 memcpy(irq->interrupt.header, header, header_length);
657 queue_event(client, &irq->event, &irq->interrupt,
658 sizeof(irq->interrupt) + header_length, NULL, 0);
661 static int ioctl_create_iso_context(struct client *client, void *buffer)
663 struct fw_cdev_create_iso_context *request = buffer;
664 struct fw_iso_context *context;
666 /* We only support one context at this time. */
667 if (client->iso_context != NULL)
670 if (request->channel > 63)
673 switch (request->type) {
674 case FW_ISO_CONTEXT_RECEIVE:
675 if (request->header_size < 4 || (request->header_size & 3))
680 case FW_ISO_CONTEXT_TRANSMIT:
681 if (request->speed > SCODE_3200)
690 context = fw_iso_context_create(client->device->card,
694 request->header_size,
695 iso_callback, client);
697 return PTR_ERR(context);
699 client->iso_closure = request->closure;
700 client->iso_context = context;
702 /* We only support one context at this time. */
708 /* Macros for decoding the iso packet control header. */
709 #define GET_PAYLOAD_LENGTH(v) ((v) & 0xffff)
710 #define GET_INTERRUPT(v) (((v) >> 16) & 0x01)
711 #define GET_SKIP(v) (((v) >> 17) & 0x01)
712 #define GET_TAG(v) (((v) >> 18) & 0x02)
713 #define GET_SY(v) (((v) >> 20) & 0x04)
714 #define GET_HEADER_LENGTH(v) (((v) >> 24) & 0xff)
716 static int ioctl_queue_iso(struct client *client, void *buffer)
718 struct fw_cdev_queue_iso *request = buffer;
719 struct fw_cdev_iso_packet __user *p, *end, *next;
720 struct fw_iso_context *ctx = client->iso_context;
721 unsigned long payload, buffer_end, header_length;
725 struct fw_iso_packet packet;
729 if (ctx == NULL || request->handle != 0)
733 * If the user passes a non-NULL data pointer, has mmap()'ed
734 * the iso buffer, and the pointer points inside the buffer,
735 * we setup the payload pointers accordingly. Otherwise we
736 * set them both to 0, which will still let packets with
737 * payload_length == 0 through. In other words, if no packets
738 * use the indirect payload, the iso buffer need not be mapped
739 * and the request->data pointer is ignored.
742 payload = (unsigned long)request->data - client->vm_start;
743 buffer_end = client->buffer.page_count << PAGE_SHIFT;
744 if (request->data == 0 || client->buffer.pages == NULL ||
745 payload >= buffer_end) {
750 p = (struct fw_cdev_iso_packet __user *)u64_to_uptr(request->packets);
752 if (!access_ok(VERIFY_READ, p, request->size))
755 end = (void __user *)p + request->size;
758 if (get_user(control, &p->control))
760 u.packet.payload_length = GET_PAYLOAD_LENGTH(control);
761 u.packet.interrupt = GET_INTERRUPT(control);
762 u.packet.skip = GET_SKIP(control);
763 u.packet.tag = GET_TAG(control);
764 u.packet.sy = GET_SY(control);
765 u.packet.header_length = GET_HEADER_LENGTH(control);
767 if (ctx->type == FW_ISO_CONTEXT_TRANSMIT) {
768 header_length = u.packet.header_length;
771 * We require that header_length is a multiple of
772 * the fixed header size, ctx->header_size.
774 if (ctx->header_size == 0) {
775 if (u.packet.header_length > 0)
777 } else if (u.packet.header_length % ctx->header_size != 0) {
783 next = (struct fw_cdev_iso_packet __user *)
784 &p->header[header_length / 4];
788 (u.packet.header, p->header, header_length))
790 if (u.packet.skip && ctx->type == FW_ISO_CONTEXT_TRANSMIT &&
791 u.packet.header_length + u.packet.payload_length > 0)
793 if (payload + u.packet.payload_length > buffer_end)
796 if (fw_iso_context_queue(ctx, &u.packet,
797 &client->buffer, payload))
801 payload += u.packet.payload_length;
805 request->size -= uptr_to_u64(p) - request->packets;
806 request->packets = uptr_to_u64(p);
807 request->data = client->vm_start + payload;
812 static int ioctl_start_iso(struct client *client, void *buffer)
814 struct fw_cdev_start_iso *request = buffer;
816 if (client->iso_context == NULL || request->handle != 0)
819 if (client->iso_context->type == FW_ISO_CONTEXT_RECEIVE) {
820 if (request->tags == 0 || request->tags > 15)
823 if (request->sync > 15)
827 return fw_iso_context_start(client->iso_context, request->cycle,
828 request->sync, request->tags);
831 static int ioctl_stop_iso(struct client *client, void *buffer)
833 struct fw_cdev_stop_iso *request = buffer;
835 if (client->iso_context == NULL || request->handle != 0)
838 return fw_iso_context_stop(client->iso_context);
841 static int ioctl_get_cycle_timer(struct client *client, void *buffer)
843 struct fw_cdev_get_cycle_timer *request = buffer;
844 struct fw_card *card = client->device->card;
845 unsigned long long bus_time;
850 local_irq_save(flags);
852 bus_time = card->driver->get_bus_time(card);
853 do_gettimeofday(&tv);
855 local_irq_restore(flags);
858 request->local_time = tv.tv_sec * 1000000ULL + tv.tv_usec;
859 request->cycle_timer = bus_time & 0xffffffff;
863 static int (* const ioctl_handlers[])(struct client *client, void *buffer) = {
869 ioctl_initiate_bus_reset,
870 ioctl_add_descriptor,
871 ioctl_remove_descriptor,
872 ioctl_create_iso_context,
876 ioctl_get_cycle_timer,
880 dispatch_ioctl(struct client *client, unsigned int cmd, void __user *arg)
885 if (_IOC_TYPE(cmd) != '#' ||
886 _IOC_NR(cmd) >= ARRAY_SIZE(ioctl_handlers))
889 if (_IOC_DIR(cmd) & _IOC_WRITE) {
890 if (_IOC_SIZE(cmd) > sizeof(buffer) ||
891 copy_from_user(buffer, arg, _IOC_SIZE(cmd)))
895 retval = ioctl_handlers[_IOC_NR(cmd)](client, buffer);
899 if (_IOC_DIR(cmd) & _IOC_READ) {
900 if (_IOC_SIZE(cmd) > sizeof(buffer) ||
901 copy_to_user(arg, buffer, _IOC_SIZE(cmd)))
909 fw_device_op_ioctl(struct file *file,
910 unsigned int cmd, unsigned long arg)
912 struct client *client = file->private_data;
914 if (fw_device_is_shutdown(client->device))
917 return dispatch_ioctl(client, cmd, (void __user *) arg);
922 fw_device_op_compat_ioctl(struct file *file,
923 unsigned int cmd, unsigned long arg)
925 struct client *client = file->private_data;
927 if (fw_device_is_shutdown(client->device))
930 return dispatch_ioctl(client, cmd, compat_ptr(arg));
934 static int fw_device_op_mmap(struct file *file, struct vm_area_struct *vma)
936 struct client *client = file->private_data;
937 enum dma_data_direction direction;
939 int page_count, retval;
941 if (fw_device_is_shutdown(client->device))
944 /* FIXME: We could support multiple buffers, but we don't. */
945 if (client->buffer.pages != NULL)
948 if (!(vma->vm_flags & VM_SHARED))
951 if (vma->vm_start & ~PAGE_MASK)
954 client->vm_start = vma->vm_start;
955 size = vma->vm_end - vma->vm_start;
956 page_count = size >> PAGE_SHIFT;
957 if (size & ~PAGE_MASK)
960 if (vma->vm_flags & VM_WRITE)
961 direction = DMA_TO_DEVICE;
963 direction = DMA_FROM_DEVICE;
965 retval = fw_iso_buffer_init(&client->buffer, client->device->card,
966 page_count, direction);
970 retval = fw_iso_buffer_map(&client->buffer, vma);
972 fw_iso_buffer_destroy(&client->buffer, client->device->card);
977 static int fw_device_op_release(struct inode *inode, struct file *file)
979 struct client *client = file->private_data;
980 struct event *e, *next_e;
981 struct client_resource *r, *next_r;
984 if (client->buffer.pages)
985 fw_iso_buffer_destroy(&client->buffer, client->device->card);
987 if (client->iso_context)
988 fw_iso_context_destroy(client->iso_context);
990 list_for_each_entry_safe(r, next_r, &client->resource_list, link)
991 r->release(client, r);
994 * FIXME: We should wait for the async tasklets to stop
995 * running before freeing the memory.
998 list_for_each_entry_safe(e, next_e, &client->event_list, link)
1001 spin_lock_irqsave(&client->device->card->lock, flags);
1002 list_del(&client->link);
1003 spin_unlock_irqrestore(&client->device->card->lock, flags);
1005 fw_device_put(client->device);
1011 static unsigned int fw_device_op_poll(struct file *file, poll_table * pt)
1013 struct client *client = file->private_data;
1014 unsigned int mask = 0;
1016 poll_wait(file, &client->wait, pt);
1018 if (fw_device_is_shutdown(client->device))
1019 mask |= POLLHUP | POLLERR;
1020 if (!list_empty(&client->event_list))
1021 mask |= POLLIN | POLLRDNORM;
1026 const struct file_operations fw_device_ops = {
1027 .owner = THIS_MODULE,
1028 .open = fw_device_op_open,
1029 .read = fw_device_op_read,
1030 .unlocked_ioctl = fw_device_op_ioctl,
1031 .poll = fw_device_op_poll,
1032 .release = fw_device_op_release,
1033 .mmap = fw_device_op_mmap,
1035 #ifdef CONFIG_COMPAT
1036 .compat_ioctl = fw_device_op_compat_ioctl,