1 /* -*- c-basic-offset: 8 -*-
3 * fw-device-cdev.c - Char device for device raw access
5 * Copyright (C) 2005-2006 Kristian Hoegsberg <krh@bitplanet.net>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software Foundation,
19 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 #include <linux/module.h>
23 #include <linux/kernel.h>
24 #include <linux/wait.h>
25 #include <linux/errno.h>
26 #include <linux/device.h>
27 #include <linux/vmalloc.h>
28 #include <linux/poll.h>
29 #include <linux/delay.h>
31 #include <linux/idr.h>
32 #include <linux/compat.h>
33 #include <asm/uaccess.h>
34 #include "fw-transaction.h"
35 #include "fw-topology.h"
36 #include "fw-device.h"
37 #include "fw-device-cdev.h"
42 * - bus resets sends a new packet with new generation and node id
46 /* dequeue_event() just kfree()'s the event, so the event has to be
47 * the first field in the struct. */
50 struct { void *data; size_t size; } v[2];
51 struct list_head link;
56 struct fw_cdev_event_bus_reset reset;
61 struct fw_transaction transaction;
62 struct client *client;
63 struct list_head link;
64 struct fw_cdev_event_response response;
67 struct iso_interrupt {
69 struct fw_cdev_event_iso_interrupt interrupt;
74 struct fw_device *device;
76 struct list_head handler_list;
77 struct list_head request_list;
78 struct list_head transaction_list;
80 struct list_head event_list;
81 wait_queue_head_t wait;
83 struct fw_iso_context *iso_context;
84 struct fw_iso_buffer buffer;
85 unsigned long vm_start;
87 struct list_head link;
90 static inline void __user *
91 u64_to_uptr(__u64 value)
93 return (void __user *)(unsigned long)value;
97 uptr_to_u64(void __user *ptr)
99 return (__u64)(unsigned long)ptr;
102 static int fw_device_op_open(struct inode *inode, struct file *file)
104 struct fw_device *device;
105 struct client *client;
108 device = fw_device_from_devt(inode->i_rdev);
112 client = kzalloc(sizeof *client, GFP_KERNEL);
116 client->device = fw_device_get(device);
117 INIT_LIST_HEAD(&client->event_list);
118 INIT_LIST_HEAD(&client->handler_list);
119 INIT_LIST_HEAD(&client->request_list);
120 INIT_LIST_HEAD(&client->transaction_list);
121 spin_lock_init(&client->lock);
122 init_waitqueue_head(&client->wait);
124 file->private_data = client;
126 spin_lock_irqsave(&device->card->lock, flags);
127 list_add_tail(&client->link, &device->client_list);
128 spin_unlock_irqrestore(&device->card->lock, flags);
133 static void queue_event(struct client *client, struct event *event,
134 void *data0, size_t size0, void *data1, size_t size1)
138 event->v[0].data = data0;
139 event->v[0].size = size0;
140 event->v[1].data = data1;
141 event->v[1].size = size1;
143 spin_lock_irqsave(&client->lock, flags);
145 list_add_tail(&event->link, &client->event_list);
146 wake_up_interruptible(&client->wait);
148 spin_unlock_irqrestore(&client->lock, flags);
152 dequeue_event(struct client *client, char __user *buffer, size_t count)
159 retval = wait_event_interruptible(client->wait,
160 !list_empty(&client->event_list) ||
161 fw_device_is_shutdown(client->device));
165 if (list_empty(&client->event_list) &&
166 fw_device_is_shutdown(client->device))
169 spin_lock_irqsave(&client->lock, flags);
170 event = container_of(client->event_list.next, struct event, link);
171 list_del(&event->link);
172 spin_unlock_irqrestore(&client->lock, flags);
175 for (i = 0; i < ARRAY_SIZE(event->v) && total < count; i++) {
176 size = min(event->v[i].size, count - total);
177 if (copy_to_user(buffer + total, event->v[i].data, size)) {
192 fw_device_op_read(struct file *file,
193 char __user *buffer, size_t count, loff_t *offset)
195 struct client *client = file->private_data;
197 return dequeue_event(client, buffer, count);
201 fill_bus_reset_event(struct fw_cdev_event_bus_reset *event,
202 struct fw_device *device)
204 struct fw_card *card = device->card;
206 event->type = FW_CDEV_EVENT_BUS_RESET;
207 event->node_id = device->node_id;
208 event->local_node_id = card->local_node->node_id;
209 event->bm_node_id = 0; /* FIXME: We don't track the BM. */
210 event->irm_node_id = card->irm_node->node_id;
211 event->root_node_id = card->root_node->node_id;
212 event->generation = card->generation;
216 for_each_client(struct fw_device *device,
217 void (*callback)(struct client *client))
219 struct fw_card *card = device->card;
223 spin_lock_irqsave(&card->lock, flags);
225 list_for_each_entry(c, &device->client_list, link)
228 spin_unlock_irqrestore(&card->lock, flags);
232 queue_bus_reset_event(struct client *client)
234 struct bus_reset *bus_reset;
235 struct fw_device *device = client->device;
237 bus_reset = kzalloc(sizeof *bus_reset, GFP_ATOMIC);
238 if (bus_reset == NULL) {
239 fw_notify("Out of memory when allocating bus reset event\n");
243 fill_bus_reset_event(&bus_reset->reset, device);
245 queue_event(client, &bus_reset->event,
246 &bus_reset->reset, sizeof bus_reset->reset, NULL, 0);
249 void fw_device_cdev_update(struct fw_device *device)
251 for_each_client(device, queue_bus_reset_event);
254 static void wake_up_client(struct client *client)
256 wake_up_interruptible(&client->wait);
259 void fw_device_cdev_remove(struct fw_device *device)
261 for_each_client(device, wake_up_client);
264 static int ioctl_get_info(struct client *client, void __user *arg)
266 struct fw_cdev_get_info get_info;
267 struct fw_cdev_event_bus_reset bus_reset;
269 if (copy_from_user(&get_info, arg, sizeof get_info))
272 client->version = get_info.version;
273 get_info.version = FW_CDEV_VERSION;
275 if (get_info.rom != 0) {
276 void __user *uptr = u64_to_uptr(get_info.rom);
277 size_t length = min(get_info.rom_length,
278 client->device->config_rom_length * 4);
280 if (copy_to_user(uptr, client->device->config_rom, length))
283 get_info.rom_length = client->device->config_rom_length * 4;
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->device);
289 if (copy_to_user(uptr, &bus_reset, sizeof bus_reset))
293 get_info.card = client->device->card->index;
295 if (copy_to_user(arg, &get_info, sizeof get_info))
302 complete_transaction(struct fw_card *card, int rcode,
303 void *payload, size_t length, void *data)
305 struct response *response = data;
306 struct client *client = response->client;
309 if (length < response->response.length)
310 response->response.length = length;
311 if (rcode == RCODE_COMPLETE)
312 memcpy(response->response.data, payload,
313 response->response.length);
315 spin_lock_irqsave(&client->lock, flags);
316 list_del(&response->link);
317 spin_unlock_irqrestore(&client->lock, flags);
319 response->response.type = FW_CDEV_EVENT_RESPONSE;
320 response->response.rcode = rcode;
321 queue_event(client, &response->event,
322 &response->response, sizeof response->response,
323 response->response.data, response->response.length);
326 static ssize_t ioctl_send_request(struct client *client, void __user *arg)
328 struct fw_device *device = client->device;
329 struct fw_cdev_send_request request;
330 struct response *response;
333 if (copy_from_user(&request, arg, sizeof request))
336 /* What is the biggest size we'll accept, really? */
337 if (request.length > 4096)
340 response = kmalloc(sizeof *response + request.length, GFP_KERNEL);
341 if (response == NULL)
344 response->client = client;
345 response->response.length = request.length;
346 response->response.closure = request.closure;
349 copy_from_user(response->response.data,
350 u64_to_uptr(request.data), request.length)) {
355 spin_lock_irqsave(&client->lock, flags);
356 list_add_tail(&response->link, &client->transaction_list);
357 spin_unlock_irqrestore(&client->lock, flags);
359 fw_send_request(device->card, &response->transaction,
360 request.tcode & 0x1f,
361 device->node->node_id,
363 device->node->max_speed,
365 response->response.data, request.length,
366 complete_transaction, response);
369 return sizeof request + request.length;
371 return sizeof request;
374 struct address_handler {
375 struct fw_address_handler handler;
377 struct client *client;
378 struct list_head link;
382 struct fw_request *request;
386 struct list_head link;
389 struct request_event {
391 struct fw_cdev_event_request request;
395 handle_request(struct fw_card *card, struct fw_request *r,
396 int tcode, int destination, int source,
397 int generation, int speed,
398 unsigned long long offset,
399 void *payload, size_t length, void *callback_data)
401 struct address_handler *handler = callback_data;
402 struct request *request;
403 struct request_event *e;
405 struct client *client = handler->client;
407 request = kmalloc(sizeof *request, GFP_ATOMIC);
408 e = kmalloc(sizeof *e, GFP_ATOMIC);
409 if (request == NULL || e == NULL) {
412 fw_send_response(card, r, RCODE_CONFLICT_ERROR);
416 request->request = r;
417 request->data = payload;
418 request->length = length;
420 spin_lock_irqsave(&client->lock, flags);
421 request->serial = client->request_serial++;
422 list_add_tail(&request->link, &client->request_list);
423 spin_unlock_irqrestore(&client->lock, flags);
425 e->request.type = FW_CDEV_EVENT_REQUEST;
426 e->request.tcode = tcode;
427 e->request.offset = offset;
428 e->request.length = length;
429 e->request.serial = request->serial;
430 e->request.closure = handler->closure;
432 queue_event(client, &e->event,
433 &e->request, sizeof e->request, payload, length);
436 static int ioctl_allocate(struct client *client, void __user *arg)
438 struct fw_cdev_allocate request;
439 struct address_handler *handler;
441 struct fw_address_region region;
443 if (copy_from_user(&request, arg, sizeof request))
446 handler = kmalloc(sizeof *handler, GFP_KERNEL);
450 region.start = request.offset;
451 region.end = request.offset + request.length;
452 handler->handler.length = request.length;
453 handler->handler.address_callback = handle_request;
454 handler->handler.callback_data = handler;
455 handler->closure = request.closure;
456 handler->client = client;
458 if (fw_core_add_address_handler(&handler->handler, ®ion) < 0) {
463 spin_lock_irqsave(&client->lock, flags);
464 list_add_tail(&handler->link, &client->handler_list);
465 spin_unlock_irqrestore(&client->lock, flags);
470 static int ioctl_send_response(struct client *client, void __user *arg)
472 struct fw_cdev_send_response request;
476 if (copy_from_user(&request, arg, sizeof request))
479 spin_lock_irqsave(&client->lock, flags);
480 list_for_each_entry(r, &client->request_list, link) {
481 if (r->serial == request.serial) {
486 spin_unlock_irqrestore(&client->lock, flags);
488 if (&r->link == &client->request_list)
491 if (request.length < r->length)
492 r->length = request.length;
493 if (copy_from_user(r->data, u64_to_uptr(request.data), r->length))
496 fw_send_response(client->device->card, r->request, request.rcode);
503 static int ioctl_initiate_bus_reset(struct client *client, void __user *arg)
505 struct fw_cdev_initiate_bus_reset request;
508 if (copy_from_user(&request, arg, sizeof request))
511 short_reset = (request.type == FW_CDEV_SHORT_RESET);
513 return fw_core_initiate_bus_reset(client->device->card, short_reset);
517 iso_callback(struct fw_iso_context *context, u32 cycle,
518 size_t header_length, void *header, void *data)
520 struct client *client = data;
521 struct iso_interrupt *interrupt;
523 interrupt = kzalloc(sizeof *interrupt + header_length, GFP_ATOMIC);
524 if (interrupt == NULL)
527 interrupt->interrupt.type = FW_CDEV_EVENT_ISO_INTERRUPT;
528 interrupt->interrupt.closure = 0;
529 interrupt->interrupt.cycle = cycle;
530 interrupt->interrupt.header_length = header_length;
531 memcpy(interrupt->interrupt.header, header, header_length);
532 queue_event(client, &interrupt->event,
533 &interrupt->interrupt,
534 sizeof interrupt->interrupt + header_length, NULL, 0);
537 static int ioctl_create_iso_context(struct client *client, void __user *arg)
539 struct fw_cdev_create_iso_context request;
541 if (copy_from_user(&request, arg, sizeof request))
544 if (request.channel > 63)
547 switch (request.type) {
548 case FW_ISO_CONTEXT_RECEIVE:
549 if (request.sync > 15)
552 if (request.tags == 0 || request.tags > 15)
555 if (request.header_size < 4 || (request.header_size & 3))
560 case FW_ISO_CONTEXT_TRANSMIT:
561 if (request.speed > SCODE_3200)
571 client->iso_context = fw_iso_context_create(client->device->card,
578 iso_callback, client);
579 if (IS_ERR(client->iso_context))
580 return PTR_ERR(client->iso_context);
585 static int ioctl_queue_iso(struct client *client, void __user *arg)
587 struct fw_cdev_queue_iso request;
588 struct fw_cdev_iso_packet __user *p, *end, *next;
589 struct fw_iso_context *ctx = client->iso_context;
590 unsigned long payload, payload_end, header_length;
593 struct fw_iso_packet packet;
599 if (copy_from_user(&request, arg, sizeof request))
602 /* If the user passes a non-NULL data pointer, has mmap()'ed
603 * the iso buffer, and the pointer points inside the buffer,
604 * we setup the payload pointers accordingly. Otherwise we
605 * set them both to 0, which will still let packets with
606 * payload_length == 0 through. In other words, if no packets
607 * use the indirect payload, the iso buffer need not be mapped
608 * and the request.data pointer is ignored.*/
610 payload = (unsigned long)request.data - client->vm_start;
611 payload_end = payload + (client->buffer.page_count << PAGE_SHIFT);
612 if (request.data == 0 || client->buffer.pages == NULL ||
613 payload >= payload_end) {
618 if (!access_ok(VERIFY_READ, request.packets, request.size))
621 p = (struct fw_cdev_iso_packet __user *)u64_to_uptr(request.packets);
622 end = (void __user *)p + request.size;
625 if (__copy_from_user(&u.packet, p, sizeof *p))
628 if (ctx->type == FW_ISO_CONTEXT_TRANSMIT) {
629 header_length = u.packet.header_length;
631 /* We require that header_length is a multiple of
632 * the fixed header size, ctx->header_size */
633 if (ctx->header_size == 0) {
634 if (u.packet.header_length > 0)
636 } else if (u.packet.header_length % ctx->header_size != 0) {
642 next = (struct fw_cdev_iso_packet __user *)
643 &p->header[header_length / 4];
647 (u.packet.header, p->header, header_length))
649 if (u.packet.skip && ctx->type == FW_ISO_CONTEXT_TRANSMIT &&
650 u.packet.header_length + u.packet.payload_length > 0)
652 if (payload + u.packet.payload_length > payload_end)
655 if (fw_iso_context_queue(ctx, &u.packet,
656 &client->buffer, payload))
660 payload += u.packet.payload_length;
664 request.size -= uptr_to_u64(p) - request.packets;
665 request.packets = uptr_to_u64(p);
666 request.data = client->vm_start + payload;
668 if (copy_to_user(arg, &request, sizeof request))
674 static int ioctl_start_iso(struct client *client, void __user *arg)
676 struct fw_cdev_start_iso request;
678 if (copy_from_user(&request, arg, sizeof request))
681 return fw_iso_context_start(client->iso_context, request.cycle);
684 static int ioctl_stop_iso(struct client *client, void __user *arg)
686 return fw_iso_context_stop(client->iso_context);
690 dispatch_ioctl(struct client *client, unsigned int cmd, void __user *arg)
693 case FW_CDEV_IOC_GET_INFO:
694 return ioctl_get_info(client, arg);
695 case FW_CDEV_IOC_SEND_REQUEST:
696 return ioctl_send_request(client, arg);
697 case FW_CDEV_IOC_ALLOCATE:
698 return ioctl_allocate(client, arg);
699 case FW_CDEV_IOC_SEND_RESPONSE:
700 return ioctl_send_response(client, arg);
701 case FW_CDEV_IOC_INITIATE_BUS_RESET:
702 return ioctl_initiate_bus_reset(client, arg);
703 case FW_CDEV_IOC_CREATE_ISO_CONTEXT:
704 return ioctl_create_iso_context(client, arg);
705 case FW_CDEV_IOC_QUEUE_ISO:
706 return ioctl_queue_iso(client, arg);
707 case FW_CDEV_IOC_START_ISO:
708 return ioctl_start_iso(client, arg);
709 case FW_CDEV_IOC_STOP_ISO:
710 return ioctl_stop_iso(client, arg);
717 fw_device_op_ioctl(struct file *file,
718 unsigned int cmd, unsigned long arg)
720 struct client *client = file->private_data;
722 return dispatch_ioctl(client, cmd, (void __user *) arg);
727 fw_device_op_compat_ioctl(struct file *file,
728 unsigned int cmd, unsigned long arg)
730 struct client *client = file->private_data;
732 return dispatch_ioctl(client, cmd, compat_ptr(arg));
736 static int fw_device_op_mmap(struct file *file, struct vm_area_struct *vma)
738 struct client *client = file->private_data;
739 enum dma_data_direction direction;
741 int page_count, retval;
743 /* FIXME: We could support multiple buffers, but we don't. */
744 if (client->buffer.pages != NULL)
747 if (!(vma->vm_flags & VM_SHARED))
750 if (vma->vm_start & ~PAGE_MASK)
753 client->vm_start = vma->vm_start;
754 size = vma->vm_end - vma->vm_start;
755 page_count = size >> PAGE_SHIFT;
756 if (size & ~PAGE_MASK)
759 if (vma->vm_flags & VM_WRITE)
760 direction = DMA_TO_DEVICE;
762 direction = DMA_FROM_DEVICE;
764 retval = fw_iso_buffer_init(&client->buffer, client->device->card,
765 page_count, direction);
769 retval = fw_iso_buffer_map(&client->buffer, vma);
771 fw_iso_buffer_destroy(&client->buffer, client->device->card);
776 static int fw_device_op_release(struct inode *inode, struct file *file)
778 struct client *client = file->private_data;
779 struct address_handler *h, *next_h;
780 struct request *r, *next_r;
781 struct event *e, *next_e;
782 struct response *t, *next_t;
785 if (client->buffer.pages)
786 fw_iso_buffer_destroy(&client->buffer, client->device->card);
788 if (client->iso_context)
789 fw_iso_context_destroy(client->iso_context);
791 list_for_each_entry_safe(h, next_h, &client->handler_list, link) {
792 fw_core_remove_address_handler(&h->handler);
796 list_for_each_entry_safe(r, next_r, &client->request_list, link) {
797 fw_send_response(client->device->card, r->request,
798 RCODE_CONFLICT_ERROR);
802 list_for_each_entry_safe(t, next_t, &client->transaction_list, link)
803 fw_cancel_transaction(client->device->card, &t->transaction);
805 /* FIXME: We should wait for the async tasklets to stop
806 * running before freeing the memory. */
808 list_for_each_entry_safe(e, next_e, &client->event_list, link)
811 spin_lock_irqsave(&client->device->card->lock, flags);
812 list_del(&client->link);
813 spin_unlock_irqrestore(&client->device->card->lock, flags);
815 fw_device_put(client->device);
821 static unsigned int fw_device_op_poll(struct file *file, poll_table * pt)
823 struct client *client = file->private_data;
824 unsigned int mask = 0;
826 poll_wait(file, &client->wait, pt);
828 if (fw_device_is_shutdown(client->device))
829 mask |= POLLHUP | POLLERR;
830 if (!list_empty(&client->event_list))
831 mask |= POLLIN | POLLRDNORM;
836 const struct file_operations fw_device_ops = {
837 .owner = THIS_MODULE,
838 .open = fw_device_op_open,
839 .read = fw_device_op_read,
840 .unlocked_ioctl = fw_device_op_ioctl,
841 .poll = fw_device_op_poll,
842 .release = fw_device_op_release,
843 .mmap = fw_device_op_mmap,
846 .compat_ioctl = fw_device_op_compat_ioctl,