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_from_devt(inode->i_rdev);
116 client = kzalloc(sizeof(*client), GFP_KERNEL);
120 client->device = fw_device_get(device);
121 INIT_LIST_HEAD(&client->event_list);
122 INIT_LIST_HEAD(&client->resource_list);
123 spin_lock_init(&client->lock);
124 init_waitqueue_head(&client->wait);
126 file->private_data = client;
128 spin_lock_irqsave(&device->card->lock, flags);
129 list_add_tail(&client->link, &device->client_list);
130 spin_unlock_irqrestore(&device->card->lock, flags);
135 static void queue_event(struct client *client, struct event *event,
136 void *data0, size_t size0, void *data1, size_t size1)
140 event->v[0].data = data0;
141 event->v[0].size = size0;
142 event->v[1].data = data1;
143 event->v[1].size = size1;
145 spin_lock_irqsave(&client->lock, flags);
146 list_add_tail(&event->link, &client->event_list);
147 spin_unlock_irqrestore(&client->lock, flags);
149 wake_up_interruptible(&client->wait);
153 dequeue_event(struct client *client, char __user *buffer, size_t count)
160 retval = wait_event_interruptible(client->wait,
161 !list_empty(&client->event_list) ||
162 fw_device_is_shutdown(client->device));
166 if (list_empty(&client->event_list) &&
167 fw_device_is_shutdown(client->device))
170 spin_lock_irqsave(&client->lock, flags);
171 event = container_of(client->event_list.next, struct event, link);
172 list_del(&event->link);
173 spin_unlock_irqrestore(&client->lock, flags);
176 for (i = 0; i < ARRAY_SIZE(event->v) && total < count; i++) {
177 size = min(event->v[i].size, count - total);
178 if (copy_to_user(buffer + total, event->v[i].data, size)) {
193 fw_device_op_read(struct file *file,
194 char __user *buffer, size_t count, loff_t *offset)
196 struct client *client = file->private_data;
198 return dequeue_event(client, buffer, count);
202 fill_bus_reset_event(struct fw_cdev_event_bus_reset *event,
203 struct client *client)
205 struct fw_card *card = client->device->card;
207 event->closure = client->bus_reset_closure;
208 event->type = FW_CDEV_EVENT_BUS_RESET;
209 event->node_id = client->device->node_id;
210 event->local_node_id = card->local_node->node_id;
211 event->bm_node_id = 0; /* FIXME: We don't track the BM. */
212 event->irm_node_id = card->irm_node->node_id;
213 event->root_node_id = card->root_node->node_id;
214 event->generation = card->generation;
218 for_each_client(struct fw_device *device,
219 void (*callback)(struct client *client))
221 struct fw_card *card = device->card;
225 spin_lock_irqsave(&card->lock, flags);
227 list_for_each_entry(c, &device->client_list, link)
230 spin_unlock_irqrestore(&card->lock, flags);
234 queue_bus_reset_event(struct client *client)
236 struct bus_reset *bus_reset;
238 bus_reset = kzalloc(sizeof(*bus_reset), GFP_ATOMIC);
239 if (bus_reset == NULL) {
240 fw_notify("Out of memory when allocating bus reset event\n");
244 fill_bus_reset_event(&bus_reset->reset, client);
246 queue_event(client, &bus_reset->event,
247 &bus_reset->reset, sizeof(bus_reset->reset), NULL, 0);
250 void fw_device_cdev_update(struct fw_device *device)
252 for_each_client(device, queue_bus_reset_event);
255 static void wake_up_client(struct client *client)
257 wake_up_interruptible(&client->wait);
260 void fw_device_cdev_remove(struct fw_device *device)
262 for_each_client(device, wake_up_client);
265 static int ioctl_get_info(struct client *client, void *buffer)
267 struct fw_cdev_get_info *get_info = buffer;
268 struct fw_cdev_event_bus_reset bus_reset;
270 client->version = get_info->version;
271 get_info->version = FW_CDEV_VERSION;
273 if (get_info->rom != 0) {
274 void __user *uptr = u64_to_uptr(get_info->rom);
275 size_t want = get_info->rom_length;
276 size_t have = client->device->config_rom_length * 4;
278 if (copy_to_user(uptr, client->device->config_rom,
282 get_info->rom_length = client->device->config_rom_length * 4;
284 client->bus_reset_closure = get_info->bus_reset_closure;
285 if (get_info->bus_reset != 0) {
286 void __user *uptr = u64_to_uptr(get_info->bus_reset);
288 fill_bus_reset_event(&bus_reset, client);
289 if (copy_to_user(uptr, &bus_reset, sizeof(bus_reset)))
293 get_info->card = client->device->card->index;
299 add_client_resource(struct client *client, struct client_resource *resource)
303 spin_lock_irqsave(&client->lock, flags);
304 list_add_tail(&resource->link, &client->resource_list);
305 resource->handle = client->resource_handle++;
306 spin_unlock_irqrestore(&client->lock, flags);
310 release_client_resource(struct client *client, u32 handle,
311 struct client_resource **resource)
313 struct client_resource *r;
316 spin_lock_irqsave(&client->lock, flags);
317 list_for_each_entry(r, &client->resource_list, link) {
318 if (r->handle == handle) {
323 spin_unlock_irqrestore(&client->lock, flags);
325 if (&r->link == &client->resource_list)
331 r->release(client, r);
337 release_transaction(struct client *client, struct client_resource *resource)
339 struct response *response =
340 container_of(resource, struct response, resource);
342 fw_cancel_transaction(client->device->card, &response->transaction);
346 complete_transaction(struct fw_card *card, int rcode,
347 void *payload, size_t length, void *data)
349 struct response *response = data;
350 struct client *client = response->client;
353 if (length < response->response.length)
354 response->response.length = length;
355 if (rcode == RCODE_COMPLETE)
356 memcpy(response->response.data, payload,
357 response->response.length);
359 spin_lock_irqsave(&client->lock, flags);
360 list_del(&response->resource.link);
361 spin_unlock_irqrestore(&client->lock, flags);
363 response->response.type = FW_CDEV_EVENT_RESPONSE;
364 response->response.rcode = rcode;
365 queue_event(client, &response->event,
366 &response->response, sizeof(response->response),
367 response->response.data, response->response.length);
370 static int ioctl_send_request(struct client *client, void *buffer)
372 struct fw_device *device = client->device;
373 struct fw_cdev_send_request *request = buffer;
374 struct response *response;
376 /* What is the biggest size we'll accept, really? */
377 if (request->length > 4096)
380 response = kmalloc(sizeof(*response) + request->length, GFP_KERNEL);
381 if (response == NULL)
384 response->client = client;
385 response->response.length = request->length;
386 response->response.closure = request->closure;
389 copy_from_user(response->response.data,
390 u64_to_uptr(request->data), request->length)) {
395 response->resource.release = release_transaction;
396 add_client_resource(client, &response->resource);
398 fw_send_request(device->card, &response->transaction,
399 request->tcode & 0x1f,
400 device->node->node_id,
404 response->response.data, request->length,
405 complete_transaction, response);
408 return sizeof(request) + request->length;
410 return sizeof(request);
413 struct address_handler {
414 struct fw_address_handler handler;
416 struct client *client;
417 struct client_resource resource;
421 struct fw_request *request;
424 struct client_resource resource;
427 struct request_event {
429 struct fw_cdev_event_request request;
433 release_request(struct client *client, struct client_resource *resource)
435 struct request *request =
436 container_of(resource, struct request, resource);
438 fw_send_response(client->device->card, request->request,
439 RCODE_CONFLICT_ERROR);
444 handle_request(struct fw_card *card, struct fw_request *r,
445 int tcode, int destination, int source,
446 int generation, int speed,
447 unsigned long long offset,
448 void *payload, size_t length, void *callback_data)
450 struct address_handler *handler = callback_data;
451 struct request *request;
452 struct request_event *e;
453 struct client *client = handler->client;
455 request = kmalloc(sizeof(*request), GFP_ATOMIC);
456 e = kmalloc(sizeof(*e), GFP_ATOMIC);
457 if (request == NULL || e == NULL) {
460 fw_send_response(card, r, RCODE_CONFLICT_ERROR);
464 request->request = r;
465 request->data = payload;
466 request->length = length;
468 request->resource.release = release_request;
469 add_client_resource(client, &request->resource);
471 e->request.type = FW_CDEV_EVENT_REQUEST;
472 e->request.tcode = tcode;
473 e->request.offset = offset;
474 e->request.length = length;
475 e->request.handle = request->resource.handle;
476 e->request.closure = handler->closure;
478 queue_event(client, &e->event,
479 &e->request, sizeof(e->request), payload, length);
483 release_address_handler(struct client *client,
484 struct client_resource *resource)
486 struct address_handler *handler =
487 container_of(resource, struct address_handler, resource);
489 fw_core_remove_address_handler(&handler->handler);
493 static int ioctl_allocate(struct client *client, void *buffer)
495 struct fw_cdev_allocate *request = buffer;
496 struct address_handler *handler;
497 struct fw_address_region region;
499 handler = kmalloc(sizeof(*handler), GFP_KERNEL);
503 region.start = request->offset;
504 region.end = request->offset + request->length;
505 handler->handler.length = request->length;
506 handler->handler.address_callback = handle_request;
507 handler->handler.callback_data = handler;
508 handler->closure = request->closure;
509 handler->client = client;
511 if (fw_core_add_address_handler(&handler->handler, ®ion) < 0) {
516 handler->resource.release = release_address_handler;
517 add_client_resource(client, &handler->resource);
518 request->handle = handler->resource.handle;
523 static int ioctl_deallocate(struct client *client, void *buffer)
525 struct fw_cdev_deallocate *request = buffer;
527 return release_client_resource(client, request->handle, NULL);
530 static int ioctl_send_response(struct client *client, void *buffer)
532 struct fw_cdev_send_response *request = buffer;
533 struct client_resource *resource;
536 if (release_client_resource(client, request->handle, &resource) < 0)
538 r = container_of(resource, struct request, resource);
539 if (request->length < r->length)
540 r->length = request->length;
541 if (copy_from_user(r->data, u64_to_uptr(request->data), r->length))
544 fw_send_response(client->device->card, r->request, request->rcode);
550 static int ioctl_initiate_bus_reset(struct client *client, void *buffer)
552 struct fw_cdev_initiate_bus_reset *request = buffer;
555 short_reset = (request->type == FW_CDEV_SHORT_RESET);
557 return fw_core_initiate_bus_reset(client->device->card, short_reset);
561 struct fw_descriptor d;
562 struct client_resource resource;
566 static void release_descriptor(struct client *client,
567 struct client_resource *resource)
569 struct descriptor *descriptor =
570 container_of(resource, struct descriptor, resource);
572 fw_core_remove_descriptor(&descriptor->d);
576 static int ioctl_add_descriptor(struct client *client, void *buffer)
578 struct fw_cdev_add_descriptor *request = buffer;
579 struct descriptor *descriptor;
582 if (request->length > 256)
586 kmalloc(sizeof(*descriptor) + request->length * 4, GFP_KERNEL);
587 if (descriptor == NULL)
590 if (copy_from_user(descriptor->data,
591 u64_to_uptr(request->data), request->length * 4)) {
596 descriptor->d.length = request->length;
597 descriptor->d.immediate = request->immediate;
598 descriptor->d.key = request->key;
599 descriptor->d.data = descriptor->data;
601 retval = fw_core_add_descriptor(&descriptor->d);
607 descriptor->resource.release = release_descriptor;
608 add_client_resource(client, &descriptor->resource);
609 request->handle = descriptor->resource.handle;
614 static int ioctl_remove_descriptor(struct client *client, void *buffer)
616 struct fw_cdev_remove_descriptor *request = buffer;
618 return release_client_resource(client, request->handle, NULL);
622 iso_callback(struct fw_iso_context *context, u32 cycle,
623 size_t header_length, void *header, void *data)
625 struct client *client = data;
626 struct iso_interrupt *irq;
628 irq = kzalloc(sizeof(*irq) + header_length, GFP_ATOMIC);
632 irq->interrupt.type = FW_CDEV_EVENT_ISO_INTERRUPT;
633 irq->interrupt.closure = client->iso_closure;
634 irq->interrupt.cycle = cycle;
635 irq->interrupt.header_length = header_length;
636 memcpy(irq->interrupt.header, header, header_length);
637 queue_event(client, &irq->event, &irq->interrupt,
638 sizeof(irq->interrupt) + header_length, NULL, 0);
641 static int ioctl_create_iso_context(struct client *client, void *buffer)
643 struct fw_cdev_create_iso_context *request = buffer;
644 struct fw_iso_context *context;
646 if (request->channel > 63)
649 switch (request->type) {
650 case FW_ISO_CONTEXT_RECEIVE:
651 if (request->header_size < 4 || (request->header_size & 3))
656 case FW_ISO_CONTEXT_TRANSMIT:
657 if (request->speed > SCODE_3200)
666 context = fw_iso_context_create(client->device->card,
670 request->header_size,
671 iso_callback, client);
673 return PTR_ERR(context);
675 client->iso_closure = request->closure;
676 client->iso_context = context;
678 /* We only support one context at this time. */
684 /* Macros for decoding the iso packet control header. */
685 #define GET_PAYLOAD_LENGTH(v) ((v) & 0xffff)
686 #define GET_INTERRUPT(v) (((v) >> 16) & 0x01)
687 #define GET_SKIP(v) (((v) >> 17) & 0x01)
688 #define GET_TAG(v) (((v) >> 18) & 0x02)
689 #define GET_SY(v) (((v) >> 20) & 0x04)
690 #define GET_HEADER_LENGTH(v) (((v) >> 24) & 0xff)
692 static int ioctl_queue_iso(struct client *client, void *buffer)
694 struct fw_cdev_queue_iso *request = buffer;
695 struct fw_cdev_iso_packet __user *p, *end, *next;
696 struct fw_iso_context *ctx = client->iso_context;
697 unsigned long payload, buffer_end, header_length;
701 struct fw_iso_packet packet;
705 if (ctx == NULL || request->handle != 0)
709 * If the user passes a non-NULL data pointer, has mmap()'ed
710 * the iso buffer, and the pointer points inside the buffer,
711 * we setup the payload pointers accordingly. Otherwise we
712 * set them both to 0, which will still let packets with
713 * payload_length == 0 through. In other words, if no packets
714 * use the indirect payload, the iso buffer need not be mapped
715 * and the request->data pointer is ignored.
718 payload = (unsigned long)request->data - client->vm_start;
719 buffer_end = client->buffer.page_count << PAGE_SHIFT;
720 if (request->data == 0 || client->buffer.pages == NULL ||
721 payload >= buffer_end) {
726 p = (struct fw_cdev_iso_packet __user *)u64_to_uptr(request->packets);
728 if (!access_ok(VERIFY_READ, p, request->size))
731 end = (void __user *)p + request->size;
734 if (get_user(control, &p->control))
736 u.packet.payload_length = GET_PAYLOAD_LENGTH(control);
737 u.packet.interrupt = GET_INTERRUPT(control);
738 u.packet.skip = GET_SKIP(control);
739 u.packet.tag = GET_TAG(control);
740 u.packet.sy = GET_SY(control);
741 u.packet.header_length = GET_HEADER_LENGTH(control);
743 if (ctx->type == FW_ISO_CONTEXT_TRANSMIT) {
744 header_length = u.packet.header_length;
747 * We require that header_length is a multiple of
748 * the fixed header size, ctx->header_size.
750 if (ctx->header_size == 0) {
751 if (u.packet.header_length > 0)
753 } else if (u.packet.header_length % ctx->header_size != 0) {
759 next = (struct fw_cdev_iso_packet __user *)
760 &p->header[header_length / 4];
764 (u.packet.header, p->header, header_length))
766 if (u.packet.skip && ctx->type == FW_ISO_CONTEXT_TRANSMIT &&
767 u.packet.header_length + u.packet.payload_length > 0)
769 if (payload + u.packet.payload_length > buffer_end)
772 if (fw_iso_context_queue(ctx, &u.packet,
773 &client->buffer, payload))
777 payload += u.packet.payload_length;
781 request->size -= uptr_to_u64(p) - request->packets;
782 request->packets = uptr_to_u64(p);
783 request->data = client->vm_start + payload;
788 static int ioctl_start_iso(struct client *client, void *buffer)
790 struct fw_cdev_start_iso *request = buffer;
792 if (request->handle != 0)
794 if (client->iso_context->type == FW_ISO_CONTEXT_RECEIVE) {
795 if (request->tags == 0 || request->tags > 15)
798 if (request->sync > 15)
802 return fw_iso_context_start(client->iso_context, request->cycle,
803 request->sync, request->tags);
806 static int ioctl_stop_iso(struct client *client, void *buffer)
808 struct fw_cdev_stop_iso *request = buffer;
810 if (request->handle != 0)
813 return fw_iso_context_stop(client->iso_context);
816 static int ioctl_get_cycle_timer(struct client *client, void *buffer)
818 struct fw_cdev_get_cycle_timer *request = buffer;
819 struct fw_card *card = client->device->card;
820 unsigned long long bus_time;
825 local_irq_save(flags);
827 bus_time = card->driver->get_bus_time(card);
828 do_gettimeofday(&tv);
830 local_irq_restore(flags);
833 request->local_time = tv.tv_sec * 1000000ULL + tv.tv_usec;
834 request->cycle_timer = bus_time & 0xffffffff;
838 static int (* const ioctl_handlers[])(struct client *client, void *buffer) = {
844 ioctl_initiate_bus_reset,
845 ioctl_add_descriptor,
846 ioctl_remove_descriptor,
847 ioctl_create_iso_context,
851 ioctl_get_cycle_timer,
855 dispatch_ioctl(struct client *client, unsigned int cmd, void __user *arg)
860 if (_IOC_TYPE(cmd) != '#' ||
861 _IOC_NR(cmd) >= ARRAY_SIZE(ioctl_handlers))
864 if (_IOC_DIR(cmd) & _IOC_WRITE) {
865 if (_IOC_SIZE(cmd) > sizeof(buffer) ||
866 copy_from_user(buffer, arg, _IOC_SIZE(cmd)))
870 retval = ioctl_handlers[_IOC_NR(cmd)](client, buffer);
874 if (_IOC_DIR(cmd) & _IOC_READ) {
875 if (_IOC_SIZE(cmd) > sizeof(buffer) ||
876 copy_to_user(arg, buffer, _IOC_SIZE(cmd)))
884 fw_device_op_ioctl(struct file *file,
885 unsigned int cmd, unsigned long arg)
887 struct client *client = file->private_data;
889 return dispatch_ioctl(client, cmd, (void __user *) arg);
894 fw_device_op_compat_ioctl(struct file *file,
895 unsigned int cmd, unsigned long arg)
897 struct client *client = file->private_data;
899 return dispatch_ioctl(client, cmd, compat_ptr(arg));
903 static int fw_device_op_mmap(struct file *file, struct vm_area_struct *vma)
905 struct client *client = file->private_data;
906 enum dma_data_direction direction;
908 int page_count, retval;
910 /* FIXME: We could support multiple buffers, but we don't. */
911 if (client->buffer.pages != NULL)
914 if (!(vma->vm_flags & VM_SHARED))
917 if (vma->vm_start & ~PAGE_MASK)
920 client->vm_start = vma->vm_start;
921 size = vma->vm_end - vma->vm_start;
922 page_count = size >> PAGE_SHIFT;
923 if (size & ~PAGE_MASK)
926 if (vma->vm_flags & VM_WRITE)
927 direction = DMA_TO_DEVICE;
929 direction = DMA_FROM_DEVICE;
931 retval = fw_iso_buffer_init(&client->buffer, client->device->card,
932 page_count, direction);
936 retval = fw_iso_buffer_map(&client->buffer, vma);
938 fw_iso_buffer_destroy(&client->buffer, client->device->card);
943 static int fw_device_op_release(struct inode *inode, struct file *file)
945 struct client *client = file->private_data;
946 struct event *e, *next_e;
947 struct client_resource *r, *next_r;
950 if (client->buffer.pages)
951 fw_iso_buffer_destroy(&client->buffer, client->device->card);
953 if (client->iso_context)
954 fw_iso_context_destroy(client->iso_context);
956 list_for_each_entry_safe(r, next_r, &client->resource_list, link)
957 r->release(client, r);
960 * FIXME: We should wait for the async tasklets to stop
961 * running before freeing the memory.
964 list_for_each_entry_safe(e, next_e, &client->event_list, link)
967 spin_lock_irqsave(&client->device->card->lock, flags);
968 list_del(&client->link);
969 spin_unlock_irqrestore(&client->device->card->lock, flags);
971 fw_device_put(client->device);
977 static unsigned int fw_device_op_poll(struct file *file, poll_table * pt)
979 struct client *client = file->private_data;
980 unsigned int mask = 0;
982 poll_wait(file, &client->wait, pt);
984 if (fw_device_is_shutdown(client->device))
985 mask |= POLLHUP | POLLERR;
986 if (!list_empty(&client->event_list))
987 mask |= POLLIN | POLLRDNORM;
992 const struct file_operations fw_device_ops = {
993 .owner = THIS_MODULE,
994 .open = fw_device_op_open,
995 .read = fw_device_op_read,
996 .unlocked_ioctl = fw_device_op_ioctl,
997 .poll = fw_device_op_poll,
998 .release = fw_device_op_release,
999 .mmap = fw_device_op_mmap,
1001 #ifdef CONFIG_COMPAT
1002 .compat_ioctl = fw_device_op_compat_ioctl,