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 if (copy_to_user(arg
, &get_info
, sizeof get_info
))
300 complete_transaction(struct fw_card
*card
, int rcode
,
301 void *payload
, size_t length
, void *data
)
303 struct response
*response
= data
;
304 struct client
*client
= response
->client
;
307 if (length
< response
->response
.length
)
308 response
->response
.length
= length
;
309 if (rcode
== RCODE_COMPLETE
)
310 memcpy(response
->response
.data
, payload
,
311 response
->response
.length
);
313 spin_lock_irqsave(&client
->lock
, flags
);
314 list_del(&response
->link
);
315 spin_unlock_irqrestore(&client
->lock
, flags
);
317 response
->response
.type
= FW_CDEV_EVENT_RESPONSE
;
318 response
->response
.rcode
= rcode
;
319 queue_event(client
, &response
->event
,
320 &response
->response
, sizeof response
->response
,
321 response
->response
.data
, response
->response
.length
);
324 static ssize_t
ioctl_send_request(struct client
*client
, void __user
*arg
)
326 struct fw_device
*device
= client
->device
;
327 struct fw_cdev_send_request request
;
328 struct response
*response
;
331 if (copy_from_user(&request
, arg
, sizeof request
))
334 /* What is the biggest size we'll accept, really? */
335 if (request
.length
> 4096)
338 response
= kmalloc(sizeof *response
+ request
.length
, GFP_KERNEL
);
339 if (response
== NULL
)
342 response
->client
= client
;
343 response
->response
.length
= request
.length
;
344 response
->response
.closure
= request
.closure
;
347 copy_from_user(response
->response
.data
,
348 u64_to_uptr(request
.data
), request
.length
)) {
353 spin_lock_irqsave(&client
->lock
, flags
);
354 list_add_tail(&response
->link
, &client
->transaction_list
);
355 spin_unlock_irqrestore(&client
->lock
, flags
);
357 fw_send_request(device
->card
, &response
->transaction
,
358 request
.tcode
& 0x1f,
359 device
->node
->node_id
,
360 device
->card
->generation
,
361 device
->node
->max_speed
,
363 response
->response
.data
, request
.length
,
364 complete_transaction
, response
);
367 return sizeof request
+ request
.length
;
369 return sizeof request
;
372 struct address_handler
{
373 struct fw_address_handler handler
;
375 struct client
*client
;
376 struct list_head link
;
380 struct fw_request
*request
;
384 struct list_head link
;
387 struct request_event
{
389 struct fw_cdev_event_request request
;
393 handle_request(struct fw_card
*card
, struct fw_request
*r
,
394 int tcode
, int destination
, int source
,
395 int generation
, int speed
,
396 unsigned long long offset
,
397 void *payload
, size_t length
, void *callback_data
)
399 struct address_handler
*handler
= callback_data
;
400 struct request
*request
;
401 struct request_event
*e
;
403 struct client
*client
= handler
->client
;
405 request
= kmalloc(sizeof *request
, GFP_ATOMIC
);
406 e
= kmalloc(sizeof *e
, GFP_ATOMIC
);
407 if (request
== NULL
|| e
== NULL
) {
410 fw_send_response(card
, r
, RCODE_CONFLICT_ERROR
);
414 request
->request
= r
;
415 request
->data
= payload
;
416 request
->length
= length
;
418 spin_lock_irqsave(&client
->lock
, flags
);
419 request
->serial
= client
->request_serial
++;
420 list_add_tail(&request
->link
, &client
->request_list
);
421 spin_unlock_irqrestore(&client
->lock
, flags
);
423 e
->request
.type
= FW_CDEV_EVENT_REQUEST
;
424 e
->request
.tcode
= tcode
;
425 e
->request
.offset
= offset
;
426 e
->request
.length
= length
;
427 e
->request
.serial
= request
->serial
;
428 e
->request
.closure
= handler
->closure
;
430 queue_event(client
, &e
->event
,
431 &e
->request
, sizeof e
->request
, payload
, length
);
434 static int ioctl_allocate(struct client
*client
, void __user
*arg
)
436 struct fw_cdev_allocate request
;
437 struct address_handler
*handler
;
439 struct fw_address_region region
;
441 if (copy_from_user(&request
, arg
, sizeof request
))
444 handler
= kmalloc(sizeof *handler
, GFP_KERNEL
);
448 region
.start
= request
.offset
;
449 region
.end
= request
.offset
+ request
.length
;
450 handler
->handler
.length
= request
.length
;
451 handler
->handler
.address_callback
= handle_request
;
452 handler
->handler
.callback_data
= handler
;
453 handler
->closure
= request
.closure
;
454 handler
->client
= client
;
456 if (fw_core_add_address_handler(&handler
->handler
, ®ion
) < 0) {
461 spin_lock_irqsave(&client
->lock
, flags
);
462 list_add_tail(&handler
->link
, &client
->handler_list
);
463 spin_unlock_irqrestore(&client
->lock
, flags
);
468 static int ioctl_send_response(struct client
*client
, void __user
*arg
)
470 struct fw_cdev_send_response request
;
474 if (copy_from_user(&request
, arg
, sizeof request
))
477 spin_lock_irqsave(&client
->lock
, flags
);
478 list_for_each_entry(r
, &client
->request_list
, link
) {
479 if (r
->serial
== request
.serial
) {
484 spin_unlock_irqrestore(&client
->lock
, flags
);
486 if (&r
->link
== &client
->request_list
)
489 if (request
.length
< r
->length
)
490 r
->length
= request
.length
;
491 if (copy_from_user(r
->data
, u64_to_uptr(request
.data
), r
->length
))
494 fw_send_response(client
->device
->card
, r
->request
, request
.rcode
);
501 static int ioctl_initiate_bus_reset(struct client
*client
, void __user
*arg
)
503 struct fw_cdev_initiate_bus_reset request
;
506 if (copy_from_user(&request
, arg
, sizeof request
))
509 short_reset
= (request
.type
== FW_CDEV_SHORT_RESET
);
511 return fw_core_initiate_bus_reset(client
->device
->card
, short_reset
);
515 iso_callback(struct fw_iso_context
*context
, u32 cycle
,
516 size_t header_length
, void *header
, void *data
)
518 struct client
*client
= data
;
519 struct iso_interrupt
*interrupt
;
521 interrupt
= kzalloc(sizeof *interrupt
+ header_length
, GFP_ATOMIC
);
522 if (interrupt
== NULL
)
525 interrupt
->interrupt
.type
= FW_CDEV_EVENT_ISO_INTERRUPT
;
526 interrupt
->interrupt
.closure
= 0;
527 interrupt
->interrupt
.cycle
= cycle
;
528 interrupt
->interrupt
.header_length
= header_length
;
529 memcpy(interrupt
->interrupt
.header
, header
, header_length
);
530 queue_event(client
, &interrupt
->event
,
531 &interrupt
->interrupt
,
532 sizeof interrupt
->interrupt
+ header_length
, NULL
, 0);
535 static int ioctl_create_iso_context(struct client
*client
, void __user
*arg
)
537 struct fw_cdev_create_iso_context request
;
539 if (copy_from_user(&request
, arg
, sizeof request
))
542 if (request
.type
> FW_ISO_CONTEXT_RECEIVE
)
545 if (request
.channel
> 63)
548 if (request
.sync
> 15)
551 if (request
.tags
== 0 || request
.tags
> 15)
554 if (request
.speed
> SCODE_3200
)
557 client
->iso_context
= fw_iso_context_create(client
->device
->card
,
564 iso_callback
, client
);
565 if (IS_ERR(client
->iso_context
))
566 return PTR_ERR(client
->iso_context
);
571 static int ioctl_queue_iso(struct client
*client
, void __user
*arg
)
573 struct fw_cdev_queue_iso request
;
574 struct fw_cdev_iso_packet __user
*p
, *end
, *next
;
575 struct fw_iso_context
*ctx
= client
->iso_context
;
576 unsigned long payload
, payload_end
, header_length
;
579 struct fw_iso_packet packet
;
585 if (copy_from_user(&request
, arg
, sizeof request
))
588 /* If the user passes a non-NULL data pointer, has mmap()'ed
589 * the iso buffer, and the pointer points inside the buffer,
590 * we setup the payload pointers accordingly. Otherwise we
591 * set them both to 0, which will still let packets with
592 * payload_length == 0 through. In other words, if no packets
593 * use the indirect payload, the iso buffer need not be mapped
594 * and the request.data pointer is ignored.*/
596 payload
= (unsigned long)request
.data
- client
->vm_start
;
597 payload_end
= payload
+ (client
->buffer
.page_count
<< PAGE_SHIFT
);
598 if (request
.data
== 0 || client
->buffer
.pages
== NULL
||
599 payload
>= payload_end
) {
604 if (!access_ok(VERIFY_READ
, request
.packets
, request
.size
))
607 p
= (struct fw_cdev_iso_packet __user
*)u64_to_uptr(request
.packets
);
608 end
= (void __user
*)p
+ request
.size
;
611 if (__copy_from_user(&u
.packet
, p
, sizeof *p
))
614 if (ctx
->type
== FW_ISO_CONTEXT_TRANSMIT
) {
615 header_length
= u
.packet
.header_length
;
617 /* We require that header_length is a multiple of
618 * the fixed header size, ctx->header_size */
619 if (ctx
->header_size
== 0) {
620 if (u
.packet
.header_length
> 0)
622 } else if (u
.packet
.header_length
% ctx
->header_size
!= 0) {
628 next
= (struct fw_cdev_iso_packet __user
*)
629 &p
->header
[header_length
/ 4];
633 (u
.packet
.header
, p
->header
, header_length
))
635 if (u
.packet
.skip
&& ctx
->type
== FW_ISO_CONTEXT_TRANSMIT
&&
636 u
.packet
.header_length
+ u
.packet
.payload_length
> 0)
638 if (payload
+ u
.packet
.payload_length
> payload_end
)
641 if (fw_iso_context_queue(ctx
, &u
.packet
,
642 &client
->buffer
, payload
))
646 payload
+= u
.packet
.payload_length
;
650 request
.size
-= uptr_to_u64(p
) - request
.packets
;
651 request
.packets
= uptr_to_u64(p
);
652 request
.data
= client
->vm_start
+ payload
;
654 if (copy_to_user(arg
, &request
, sizeof request
))
660 static int ioctl_start_iso(struct client
*client
, void __user
*arg
)
662 struct fw_cdev_start_iso request
;
664 if (copy_from_user(&request
, arg
, sizeof request
))
667 return fw_iso_context_start(client
->iso_context
, request
.cycle
);
670 static int ioctl_stop_iso(struct client
*client
, void __user
*arg
)
672 return fw_iso_context_stop(client
->iso_context
);
676 dispatch_ioctl(struct client
*client
, unsigned int cmd
, void __user
*arg
)
679 case FW_CDEV_IOC_GET_INFO
:
680 return ioctl_get_info(client
, arg
);
681 case FW_CDEV_IOC_SEND_REQUEST
:
682 return ioctl_send_request(client
, arg
);
683 case FW_CDEV_IOC_ALLOCATE
:
684 return ioctl_allocate(client
, arg
);
685 case FW_CDEV_IOC_SEND_RESPONSE
:
686 return ioctl_send_response(client
, arg
);
687 case FW_CDEV_IOC_INITIATE_BUS_RESET
:
688 return ioctl_initiate_bus_reset(client
, arg
);
689 case FW_CDEV_IOC_CREATE_ISO_CONTEXT
:
690 return ioctl_create_iso_context(client
, arg
);
691 case FW_CDEV_IOC_QUEUE_ISO
:
692 return ioctl_queue_iso(client
, arg
);
693 case FW_CDEV_IOC_START_ISO
:
694 return ioctl_start_iso(client
, arg
);
695 case FW_CDEV_IOC_STOP_ISO
:
696 return ioctl_stop_iso(client
, arg
);
703 fw_device_op_ioctl(struct file
*file
,
704 unsigned int cmd
, unsigned long arg
)
706 struct client
*client
= file
->private_data
;
708 return dispatch_ioctl(client
, cmd
, (void __user
*) arg
);
713 fw_device_op_compat_ioctl(struct file
*file
,
714 unsigned int cmd
, unsigned long arg
)
716 struct client
*client
= file
->private_data
;
718 return dispatch_ioctl(client
, cmd
, compat_ptr(arg
));
722 static int fw_device_op_mmap(struct file
*file
, struct vm_area_struct
*vma
)
724 struct client
*client
= file
->private_data
;
725 enum dma_data_direction direction
;
727 int page_count
, retval
;
729 /* FIXME: We could support multiple buffers, but we don't. */
730 if (client
->buffer
.pages
!= NULL
)
733 if (!(vma
->vm_flags
& VM_SHARED
))
736 if (vma
->vm_start
& ~PAGE_MASK
)
739 client
->vm_start
= vma
->vm_start
;
740 size
= vma
->vm_end
- vma
->vm_start
;
741 page_count
= size
>> PAGE_SHIFT
;
742 if (size
& ~PAGE_MASK
)
745 if (vma
->vm_flags
& VM_WRITE
)
746 direction
= DMA_TO_DEVICE
;
748 direction
= DMA_FROM_DEVICE
;
750 retval
= fw_iso_buffer_init(&client
->buffer
, client
->device
->card
,
751 page_count
, direction
);
755 retval
= fw_iso_buffer_map(&client
->buffer
, vma
);
757 fw_iso_buffer_destroy(&client
->buffer
, client
->device
->card
);
762 static int fw_device_op_release(struct inode
*inode
, struct file
*file
)
764 struct client
*client
= file
->private_data
;
765 struct address_handler
*h
, *next_h
;
766 struct request
*r
, *next_r
;
767 struct event
*e
, *next_e
;
768 struct response
*t
, *next_t
;
771 if (client
->buffer
.pages
)
772 fw_iso_buffer_destroy(&client
->buffer
, client
->device
->card
);
774 if (client
->iso_context
)
775 fw_iso_context_destroy(client
->iso_context
);
777 list_for_each_entry_safe(h
, next_h
, &client
->handler_list
, link
) {
778 fw_core_remove_address_handler(&h
->handler
);
782 list_for_each_entry_safe(r
, next_r
, &client
->request_list
, link
) {
783 fw_send_response(client
->device
->card
, r
->request
,
784 RCODE_CONFLICT_ERROR
);
788 list_for_each_entry_safe(t
, next_t
, &client
->transaction_list
, link
)
789 fw_cancel_transaction(client
->device
->card
, &t
->transaction
);
791 /* FIXME: We should wait for the async tasklets to stop
792 * running before freeing the memory. */
794 list_for_each_entry_safe(e
, next_e
, &client
->event_list
, link
)
797 spin_lock_irqsave(&client
->device
->card
->lock
, flags
);
798 list_del(&client
->link
);
799 spin_unlock_irqrestore(&client
->device
->card
->lock
, flags
);
801 fw_device_put(client
->device
);
807 static unsigned int fw_device_op_poll(struct file
*file
, poll_table
* pt
)
809 struct client
*client
= file
->private_data
;
810 unsigned int mask
= 0;
812 poll_wait(file
, &client
->wait
, pt
);
814 if (fw_device_is_shutdown(client
->device
))
815 mask
|= POLLHUP
| POLLERR
;
816 if (!list_empty(&client
->event_list
))
817 mask
|= POLLIN
| POLLRDNORM
;
822 const struct file_operations fw_device_ops
= {
823 .owner
= THIS_MODULE
,
824 .open
= fw_device_op_open
,
825 .read
= fw_device_op_read
,
826 .unlocked_ioctl
= fw_device_op_ioctl
,
827 .poll
= fw_device_op_poll
,
828 .release
= fw_device_op_release
,
829 .mmap
= fw_device_op_mmap
,
832 .compat_ioctl
= fw_device_op_compat_ioctl
,