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/spinlock.h>
37 #include <linux/time.h>
38 #include <linux/uaccess.h>
39 #include <linux/vmalloc.h>
40 #include <linux/wait.h>
41 #include <linux/workqueue.h>
43 #include <asm/system.h>
49 struct fw_device
*device
;
53 struct idr resource_idr
;
54 struct list_head event_list
;
55 wait_queue_head_t wait
;
56 u64 bus_reset_closure
;
58 struct fw_iso_context
*iso_context
;
60 struct fw_iso_buffer buffer
;
61 unsigned long vm_start
;
63 struct list_head link
;
67 static inline void client_get(struct client
*client
)
69 kref_get(&client
->kref
);
72 static void client_release(struct kref
*kref
)
74 struct client
*client
= container_of(kref
, struct client
, kref
);
76 fw_device_put(client
->device
);
80 static void client_put(struct client
*client
)
82 kref_put(&client
->kref
, client_release
);
85 struct client_resource
;
86 typedef void (*client_resource_release_fn_t
)(struct client
*,
87 struct client_resource
*);
88 struct client_resource
{
89 client_resource_release_fn_t release
;
93 struct address_handler_resource
{
94 struct client_resource resource
;
95 struct fw_address_handler handler
;
97 struct client
*client
;
100 struct outbound_transaction_resource
{
101 struct client_resource resource
;
102 struct fw_transaction transaction
;
105 struct inbound_transaction_resource
{
106 struct client_resource resource
;
107 struct fw_request
*request
;
112 struct descriptor_resource
{
113 struct client_resource resource
;
114 struct fw_descriptor descriptor
;
118 struct iso_resource
{
119 struct client_resource resource
;
120 struct client
*client
;
121 /* Schedule work and access todo only with client->lock held. */
122 struct delayed_work work
;
123 enum {ISO_RES_ALLOC
, ISO_RES_REALLOC
, ISO_RES_DEALLOC
,
124 ISO_RES_ALLOC_ONCE
, ISO_RES_DEALLOC_ONCE
,} todo
;
128 struct iso_resource_event
*e_alloc
, *e_dealloc
;
131 static void schedule_iso_resource(struct iso_resource
*);
132 static void release_iso_resource(struct client
*, struct client_resource
*);
135 * dequeue_event() just kfree()'s the event, so the event has to be
136 * the first field in a struct XYZ_event.
139 struct { void *data
; size_t size
; } v
[2];
140 struct list_head link
;
143 struct bus_reset_event
{
145 struct fw_cdev_event_bus_reset reset
;
148 struct outbound_transaction_event
{
150 struct client
*client
;
151 struct outbound_transaction_resource r
;
152 struct fw_cdev_event_response response
;
155 struct inbound_transaction_event
{
157 struct fw_cdev_event_request request
;
160 struct iso_interrupt_event
{
162 struct fw_cdev_event_iso_interrupt interrupt
;
165 struct iso_resource_event
{
167 struct fw_cdev_event_iso_resource resource
;
170 static inline void __user
*u64_to_uptr(__u64 value
)
172 return (void __user
*)(unsigned long)value
;
175 static inline __u64
uptr_to_u64(void __user
*ptr
)
177 return (__u64
)(unsigned long)ptr
;
180 static int fw_device_op_open(struct inode
*inode
, struct file
*file
)
182 struct fw_device
*device
;
183 struct client
*client
;
185 device
= fw_device_get_by_devt(inode
->i_rdev
);
189 if (fw_device_is_shutdown(device
)) {
190 fw_device_put(device
);
194 client
= kzalloc(sizeof(*client
), GFP_KERNEL
);
195 if (client
== NULL
) {
196 fw_device_put(device
);
200 client
->device
= device
;
201 spin_lock_init(&client
->lock
);
202 idr_init(&client
->resource_idr
);
203 INIT_LIST_HEAD(&client
->event_list
);
204 init_waitqueue_head(&client
->wait
);
205 kref_init(&client
->kref
);
207 file
->private_data
= client
;
209 mutex_lock(&device
->client_list_mutex
);
210 list_add_tail(&client
->link
, &device
->client_list
);
211 mutex_unlock(&device
->client_list_mutex
);
216 static void queue_event(struct client
*client
, struct event
*event
,
217 void *data0
, size_t size0
, void *data1
, size_t size1
)
221 event
->v
[0].data
= data0
;
222 event
->v
[0].size
= size0
;
223 event
->v
[1].data
= data1
;
224 event
->v
[1].size
= size1
;
226 spin_lock_irqsave(&client
->lock
, flags
);
227 if (client
->in_shutdown
)
230 list_add_tail(&event
->link
, &client
->event_list
);
231 spin_unlock_irqrestore(&client
->lock
, flags
);
233 wake_up_interruptible(&client
->wait
);
236 static int dequeue_event(struct client
*client
,
237 char __user
*buffer
, size_t count
)
243 ret
= wait_event_interruptible(client
->wait
,
244 !list_empty(&client
->event_list
) ||
245 fw_device_is_shutdown(client
->device
));
249 if (list_empty(&client
->event_list
) &&
250 fw_device_is_shutdown(client
->device
))
253 spin_lock_irq(&client
->lock
);
254 event
= list_first_entry(&client
->event_list
, struct event
, link
);
255 list_del(&event
->link
);
256 spin_unlock_irq(&client
->lock
);
259 for (i
= 0; i
< ARRAY_SIZE(event
->v
) && total
< count
; i
++) {
260 size
= min(event
->v
[i
].size
, count
- total
);
261 if (copy_to_user(buffer
+ total
, event
->v
[i
].data
, size
)) {
275 static ssize_t
fw_device_op_read(struct file
*file
, char __user
*buffer
,
276 size_t count
, loff_t
*offset
)
278 struct client
*client
= file
->private_data
;
280 return dequeue_event(client
, buffer
, count
);
283 static void fill_bus_reset_event(struct fw_cdev_event_bus_reset
*event
,
284 struct client
*client
)
286 struct fw_card
*card
= client
->device
->card
;
288 spin_lock_irq(&card
->lock
);
290 event
->closure
= client
->bus_reset_closure
;
291 event
->type
= FW_CDEV_EVENT_BUS_RESET
;
292 event
->generation
= client
->device
->generation
;
293 event
->node_id
= client
->device
->node_id
;
294 event
->local_node_id
= card
->local_node
->node_id
;
295 event
->bm_node_id
= 0; /* FIXME: We don't track the BM. */
296 event
->irm_node_id
= card
->irm_node
->node_id
;
297 event
->root_node_id
= card
->root_node
->node_id
;
299 spin_unlock_irq(&card
->lock
);
302 static void for_each_client(struct fw_device
*device
,
303 void (*callback
)(struct client
*client
))
307 mutex_lock(&device
->client_list_mutex
);
308 list_for_each_entry(c
, &device
->client_list
, link
)
310 mutex_unlock(&device
->client_list_mutex
);
313 static int schedule_reallocations(int id
, void *p
, void *data
)
315 struct client_resource
*r
= p
;
317 if (r
->release
== release_iso_resource
)
318 schedule_iso_resource(container_of(r
,
319 struct iso_resource
, resource
));
323 static void queue_bus_reset_event(struct client
*client
)
325 struct bus_reset_event
*e
;
327 e
= kzalloc(sizeof(*e
), GFP_KERNEL
);
329 fw_notify("Out of memory when allocating bus reset event\n");
333 fill_bus_reset_event(&e
->reset
, client
);
335 queue_event(client
, &e
->event
,
336 &e
->reset
, sizeof(e
->reset
), NULL
, 0);
338 spin_lock_irq(&client
->lock
);
339 idr_for_each(&client
->resource_idr
, schedule_reallocations
, client
);
340 spin_unlock_irq(&client
->lock
);
343 void fw_device_cdev_update(struct fw_device
*device
)
345 for_each_client(device
, queue_bus_reset_event
);
348 static void wake_up_client(struct client
*client
)
350 wake_up_interruptible(&client
->wait
);
353 void fw_device_cdev_remove(struct fw_device
*device
)
355 for_each_client(device
, wake_up_client
);
358 static int ioctl_get_info(struct client
*client
, void *buffer
)
360 struct fw_cdev_get_info
*get_info
= buffer
;
361 struct fw_cdev_event_bus_reset bus_reset
;
362 unsigned long ret
= 0;
364 client
->version
= get_info
->version
;
365 get_info
->version
= FW_CDEV_VERSION
;
366 get_info
->card
= client
->device
->card
->index
;
368 down_read(&fw_device_rwsem
);
370 if (get_info
->rom
!= 0) {
371 void __user
*uptr
= u64_to_uptr(get_info
->rom
);
372 size_t want
= get_info
->rom_length
;
373 size_t have
= client
->device
->config_rom_length
* 4;
375 ret
= copy_to_user(uptr
, client
->device
->config_rom
,
378 get_info
->rom_length
= client
->device
->config_rom_length
* 4;
380 up_read(&fw_device_rwsem
);
385 client
->bus_reset_closure
= get_info
->bus_reset_closure
;
386 if (get_info
->bus_reset
!= 0) {
387 void __user
*uptr
= u64_to_uptr(get_info
->bus_reset
);
389 fill_bus_reset_event(&bus_reset
, client
);
390 if (copy_to_user(uptr
, &bus_reset
, sizeof(bus_reset
)))
397 static int add_client_resource(struct client
*client
,
398 struct client_resource
*resource
, gfp_t gfp_mask
)
404 if (idr_pre_get(&client
->resource_idr
, gfp_mask
) == 0)
407 spin_lock_irqsave(&client
->lock
, flags
);
408 if (client
->in_shutdown
)
411 ret
= idr_get_new(&client
->resource_idr
, resource
,
415 if (resource
->release
== release_iso_resource
)
416 schedule_iso_resource(container_of(resource
,
417 struct iso_resource
, resource
));
419 spin_unlock_irqrestore(&client
->lock
, flags
);
424 return ret
< 0 ? ret
: 0;
427 static int release_client_resource(struct client
*client
, u32 handle
,
428 client_resource_release_fn_t release
,
429 struct client_resource
**resource
)
431 struct client_resource
*r
;
433 spin_lock_irq(&client
->lock
);
434 if (client
->in_shutdown
)
437 r
= idr_find(&client
->resource_idr
, handle
);
438 if (r
&& r
->release
== release
)
439 idr_remove(&client
->resource_idr
, handle
);
440 spin_unlock_irq(&client
->lock
);
442 if (!(r
&& r
->release
== release
))
448 r
->release(client
, r
);
455 static void release_transaction(struct client
*client
,
456 struct client_resource
*resource
)
458 struct outbound_transaction_resource
*r
= container_of(resource
,
459 struct outbound_transaction_resource
, resource
);
461 fw_cancel_transaction(client
->device
->card
, &r
->transaction
);
464 static void complete_transaction(struct fw_card
*card
, int rcode
,
465 void *payload
, size_t length
, void *data
)
467 struct outbound_transaction_event
*e
= data
;
468 struct fw_cdev_event_response
*rsp
= &e
->response
;
469 struct client
*client
= e
->client
;
472 if (length
< rsp
->length
)
473 rsp
->length
= length
;
474 if (rcode
== RCODE_COMPLETE
)
475 memcpy(rsp
->data
, payload
, rsp
->length
);
477 spin_lock_irqsave(&client
->lock
, flags
);
479 * 1. If called while in shutdown, the idr tree must be left untouched.
480 * The idr handle will be removed and the client reference will be
482 * 2. If the call chain was release_client_resource ->
483 * release_transaction -> complete_transaction (instead of a normal
484 * conclusion of the transaction), i.e. if this resource was already
485 * unregistered from the idr, the client reference will be dropped
486 * by release_client_resource and we must not drop it here.
488 if (!client
->in_shutdown
&&
489 idr_find(&client
->resource_idr
, e
->r
.resource
.handle
)) {
490 idr_remove(&client
->resource_idr
, e
->r
.resource
.handle
);
491 /* Drop the idr's reference */
494 spin_unlock_irqrestore(&client
->lock
, flags
);
496 rsp
->type
= FW_CDEV_EVENT_RESPONSE
;
500 * In the case that sizeof(*rsp) doesn't align with the position of the
501 * data, and the read is short, preserve an extra copy of the data
502 * to stay compatible with a pre-2.6.27 bug. Since the bug is harmless
503 * for short reads and some apps depended on it, this is both safe
504 * and prudent for compatibility.
506 if (rsp
->length
<= sizeof(*rsp
) - offsetof(typeof(*rsp
), data
))
507 queue_event(client
, &e
->event
, rsp
, sizeof(*rsp
),
508 rsp
->data
, rsp
->length
);
510 queue_event(client
, &e
->event
, rsp
, sizeof(*rsp
) + rsp
->length
,
513 /* Drop the transaction callback's reference */
517 static int init_request(struct client
*client
,
518 struct fw_cdev_send_request
*request
,
519 int destination_id
, int speed
)
521 struct outbound_transaction_event
*e
;
524 if (request
->tcode
!= TCODE_STREAM_DATA
&&
525 (request
->length
> 4096 || request
->length
> 512 << speed
))
528 e
= kmalloc(sizeof(*e
) + request
->length
, GFP_KERNEL
);
533 e
->response
.length
= request
->length
;
534 e
->response
.closure
= request
->closure
;
537 copy_from_user(e
->response
.data
,
538 u64_to_uptr(request
->data
), request
->length
)) {
543 e
->r
.resource
.release
= release_transaction
;
544 ret
= add_client_resource(client
, &e
->r
.resource
, GFP_KERNEL
);
548 /* Get a reference for the transaction callback */
551 fw_send_request(client
->device
->card
, &e
->r
.transaction
,
552 request
->tcode
, destination_id
, request
->generation
,
553 speed
, request
->offset
, e
->response
.data
,
554 request
->length
, complete_transaction
, e
);
563 static int ioctl_send_request(struct client
*client
, void *buffer
)
565 struct fw_cdev_send_request
*request
= buffer
;
567 switch (request
->tcode
) {
568 case TCODE_WRITE_QUADLET_REQUEST
:
569 case TCODE_WRITE_BLOCK_REQUEST
:
570 case TCODE_READ_QUADLET_REQUEST
:
571 case TCODE_READ_BLOCK_REQUEST
:
572 case TCODE_LOCK_MASK_SWAP
:
573 case TCODE_LOCK_COMPARE_SWAP
:
574 case TCODE_LOCK_FETCH_ADD
:
575 case TCODE_LOCK_LITTLE_ADD
:
576 case TCODE_LOCK_BOUNDED_ADD
:
577 case TCODE_LOCK_WRAP_ADD
:
578 case TCODE_LOCK_VENDOR_DEPENDENT
:
584 return init_request(client
, request
, client
->device
->node_id
,
585 client
->device
->max_speed
);
588 static void release_request(struct client
*client
,
589 struct client_resource
*resource
)
591 struct inbound_transaction_resource
*r
= container_of(resource
,
592 struct inbound_transaction_resource
, resource
);
594 fw_send_response(client
->device
->card
, r
->request
,
595 RCODE_CONFLICT_ERROR
);
599 static void handle_request(struct fw_card
*card
, struct fw_request
*request
,
600 int tcode
, int destination
, int source
,
601 int generation
, int speed
,
602 unsigned long long offset
,
603 void *payload
, size_t length
, void *callback_data
)
605 struct address_handler_resource
*handler
= callback_data
;
606 struct inbound_transaction_resource
*r
;
607 struct inbound_transaction_event
*e
;
610 r
= kmalloc(sizeof(*r
), GFP_ATOMIC
);
611 e
= kmalloc(sizeof(*e
), GFP_ATOMIC
);
612 if (r
== NULL
|| e
== NULL
)
615 r
->request
= request
;
619 r
->resource
.release
= release_request
;
620 ret
= add_client_resource(handler
->client
, &r
->resource
, GFP_ATOMIC
);
624 e
->request
.type
= FW_CDEV_EVENT_REQUEST
;
625 e
->request
.tcode
= tcode
;
626 e
->request
.offset
= offset
;
627 e
->request
.length
= length
;
628 e
->request
.handle
= r
->resource
.handle
;
629 e
->request
.closure
= handler
->closure
;
631 queue_event(handler
->client
, &e
->event
,
632 &e
->request
, sizeof(e
->request
), payload
, length
);
638 fw_send_response(card
, request
, RCODE_CONFLICT_ERROR
);
641 static void release_address_handler(struct client
*client
,
642 struct client_resource
*resource
)
644 struct address_handler_resource
*r
=
645 container_of(resource
, struct address_handler_resource
, resource
);
647 fw_core_remove_address_handler(&r
->handler
);
651 static int ioctl_allocate(struct client
*client
, void *buffer
)
653 struct fw_cdev_allocate
*request
= buffer
;
654 struct address_handler_resource
*r
;
655 struct fw_address_region region
;
658 r
= kmalloc(sizeof(*r
), GFP_KERNEL
);
662 region
.start
= request
->offset
;
663 region
.end
= request
->offset
+ request
->length
;
664 r
->handler
.length
= request
->length
;
665 r
->handler
.address_callback
= handle_request
;
666 r
->handler
.callback_data
= r
;
667 r
->closure
= request
->closure
;
670 ret
= fw_core_add_address_handler(&r
->handler
, ®ion
);
676 r
->resource
.release
= release_address_handler
;
677 ret
= add_client_resource(client
, &r
->resource
, GFP_KERNEL
);
679 release_address_handler(client
, &r
->resource
);
682 request
->handle
= r
->resource
.handle
;
687 static int ioctl_deallocate(struct client
*client
, void *buffer
)
689 struct fw_cdev_deallocate
*request
= buffer
;
691 return release_client_resource(client
, request
->handle
,
692 release_address_handler
, NULL
);
695 static int ioctl_send_response(struct client
*client
, void *buffer
)
697 struct fw_cdev_send_response
*request
= buffer
;
698 struct client_resource
*resource
;
699 struct inbound_transaction_resource
*r
;
701 if (release_client_resource(client
, request
->handle
,
702 release_request
, &resource
) < 0)
705 r
= container_of(resource
, struct inbound_transaction_resource
,
707 if (request
->length
< r
->length
)
708 r
->length
= request
->length
;
709 if (copy_from_user(r
->data
, u64_to_uptr(request
->data
), r
->length
))
712 fw_send_response(client
->device
->card
, r
->request
, request
->rcode
);
718 static int ioctl_initiate_bus_reset(struct client
*client
, void *buffer
)
720 struct fw_cdev_initiate_bus_reset
*request
= buffer
;
723 short_reset
= (request
->type
== FW_CDEV_SHORT_RESET
);
725 return fw_core_initiate_bus_reset(client
->device
->card
, short_reset
);
728 static void release_descriptor(struct client
*client
,
729 struct client_resource
*resource
)
731 struct descriptor_resource
*r
=
732 container_of(resource
, struct descriptor_resource
, resource
);
734 fw_core_remove_descriptor(&r
->descriptor
);
738 static int ioctl_add_descriptor(struct client
*client
, void *buffer
)
740 struct fw_cdev_add_descriptor
*request
= buffer
;
741 struct descriptor_resource
*r
;
744 /* Access policy: Allow this ioctl only on local nodes' device files. */
745 if (!client
->device
->is_local
)
748 if (request
->length
> 256)
751 r
= kmalloc(sizeof(*r
) + request
->length
* 4, GFP_KERNEL
);
755 if (copy_from_user(r
->data
,
756 u64_to_uptr(request
->data
), request
->length
* 4)) {
761 r
->descriptor
.length
= request
->length
;
762 r
->descriptor
.immediate
= request
->immediate
;
763 r
->descriptor
.key
= request
->key
;
764 r
->descriptor
.data
= r
->data
;
766 ret
= fw_core_add_descriptor(&r
->descriptor
);
770 r
->resource
.release
= release_descriptor
;
771 ret
= add_client_resource(client
, &r
->resource
, GFP_KERNEL
);
773 fw_core_remove_descriptor(&r
->descriptor
);
776 request
->handle
= r
->resource
.handle
;
785 static int ioctl_remove_descriptor(struct client
*client
, void *buffer
)
787 struct fw_cdev_remove_descriptor
*request
= buffer
;
789 return release_client_resource(client
, request
->handle
,
790 release_descriptor
, NULL
);
793 static void iso_callback(struct fw_iso_context
*context
, u32 cycle
,
794 size_t header_length
, void *header
, void *data
)
796 struct client
*client
= data
;
797 struct iso_interrupt_event
*e
;
799 e
= kzalloc(sizeof(*e
) + header_length
, GFP_ATOMIC
);
803 e
->interrupt
.type
= FW_CDEV_EVENT_ISO_INTERRUPT
;
804 e
->interrupt
.closure
= client
->iso_closure
;
805 e
->interrupt
.cycle
= cycle
;
806 e
->interrupt
.header_length
= header_length
;
807 memcpy(e
->interrupt
.header
, header
, header_length
);
808 queue_event(client
, &e
->event
, &e
->interrupt
,
809 sizeof(e
->interrupt
) + header_length
, NULL
, 0);
812 static int ioctl_create_iso_context(struct client
*client
, void *buffer
)
814 struct fw_cdev_create_iso_context
*request
= buffer
;
815 struct fw_iso_context
*context
;
817 /* We only support one context at this time. */
818 if (client
->iso_context
!= NULL
)
821 if (request
->channel
> 63)
824 switch (request
->type
) {
825 case FW_ISO_CONTEXT_RECEIVE
:
826 if (request
->header_size
< 4 || (request
->header_size
& 3))
831 case FW_ISO_CONTEXT_TRANSMIT
:
832 if (request
->speed
> SCODE_3200
)
841 context
= fw_iso_context_create(client
->device
->card
,
845 request
->header_size
,
846 iso_callback
, client
);
848 return PTR_ERR(context
);
850 client
->iso_closure
= request
->closure
;
851 client
->iso_context
= context
;
853 /* We only support one context at this time. */
859 /* Macros for decoding the iso packet control header. */
860 #define GET_PAYLOAD_LENGTH(v) ((v) & 0xffff)
861 #define GET_INTERRUPT(v) (((v) >> 16) & 0x01)
862 #define GET_SKIP(v) (((v) >> 17) & 0x01)
863 #define GET_TAG(v) (((v) >> 18) & 0x03)
864 #define GET_SY(v) (((v) >> 20) & 0x0f)
865 #define GET_HEADER_LENGTH(v) (((v) >> 24) & 0xff)
867 static int ioctl_queue_iso(struct client
*client
, void *buffer
)
869 struct fw_cdev_queue_iso
*request
= buffer
;
870 struct fw_cdev_iso_packet __user
*p
, *end
, *next
;
871 struct fw_iso_context
*ctx
= client
->iso_context
;
872 unsigned long payload
, buffer_end
, header_length
;
876 struct fw_iso_packet packet
;
880 if (ctx
== NULL
|| request
->handle
!= 0)
884 * If the user passes a non-NULL data pointer, has mmap()'ed
885 * the iso buffer, and the pointer points inside the buffer,
886 * we setup the payload pointers accordingly. Otherwise we
887 * set them both to 0, which will still let packets with
888 * payload_length == 0 through. In other words, if no packets
889 * use the indirect payload, the iso buffer need not be mapped
890 * and the request->data pointer is ignored.
893 payload
= (unsigned long)request
->data
- client
->vm_start
;
894 buffer_end
= client
->buffer
.page_count
<< PAGE_SHIFT
;
895 if (request
->data
== 0 || client
->buffer
.pages
== NULL
||
896 payload
>= buffer_end
) {
901 p
= (struct fw_cdev_iso_packet __user
*)u64_to_uptr(request
->packets
);
903 if (!access_ok(VERIFY_READ
, p
, request
->size
))
906 end
= (void __user
*)p
+ request
->size
;
909 if (get_user(control
, &p
->control
))
911 u
.packet
.payload_length
= GET_PAYLOAD_LENGTH(control
);
912 u
.packet
.interrupt
= GET_INTERRUPT(control
);
913 u
.packet
.skip
= GET_SKIP(control
);
914 u
.packet
.tag
= GET_TAG(control
);
915 u
.packet
.sy
= GET_SY(control
);
916 u
.packet
.header_length
= GET_HEADER_LENGTH(control
);
918 if (ctx
->type
== FW_ISO_CONTEXT_TRANSMIT
) {
919 header_length
= u
.packet
.header_length
;
922 * We require that header_length is a multiple of
923 * the fixed header size, ctx->header_size.
925 if (ctx
->header_size
== 0) {
926 if (u
.packet
.header_length
> 0)
928 } else if (u
.packet
.header_length
% ctx
->header_size
!= 0) {
934 next
= (struct fw_cdev_iso_packet __user
*)
935 &p
->header
[header_length
/ 4];
939 (u
.packet
.header
, p
->header
, header_length
))
941 if (u
.packet
.skip
&& ctx
->type
== FW_ISO_CONTEXT_TRANSMIT
&&
942 u
.packet
.header_length
+ u
.packet
.payload_length
> 0)
944 if (payload
+ u
.packet
.payload_length
> buffer_end
)
947 if (fw_iso_context_queue(ctx
, &u
.packet
,
948 &client
->buffer
, payload
))
952 payload
+= u
.packet
.payload_length
;
956 request
->size
-= uptr_to_u64(p
) - request
->packets
;
957 request
->packets
= uptr_to_u64(p
);
958 request
->data
= client
->vm_start
+ payload
;
963 static int ioctl_start_iso(struct client
*client
, void *buffer
)
965 struct fw_cdev_start_iso
*request
= buffer
;
967 if (client
->iso_context
== NULL
|| request
->handle
!= 0)
970 if (client
->iso_context
->type
== FW_ISO_CONTEXT_RECEIVE
) {
971 if (request
->tags
== 0 || request
->tags
> 15)
974 if (request
->sync
> 15)
978 return fw_iso_context_start(client
->iso_context
, request
->cycle
,
979 request
->sync
, request
->tags
);
982 static int ioctl_stop_iso(struct client
*client
, void *buffer
)
984 struct fw_cdev_stop_iso
*request
= buffer
;
986 if (client
->iso_context
== NULL
|| request
->handle
!= 0)
989 return fw_iso_context_stop(client
->iso_context
);
992 static int ioctl_get_cycle_timer(struct client
*client
, void *buffer
)
994 struct fw_cdev_get_cycle_timer
*request
= buffer
;
995 struct fw_card
*card
= client
->device
->card
;
996 unsigned long long bus_time
;
1001 local_irq_save(flags
);
1003 bus_time
= card
->driver
->get_bus_time(card
);
1004 do_gettimeofday(&tv
);
1006 local_irq_restore(flags
);
1009 request
->local_time
= tv
.tv_sec
* 1000000ULL + tv
.tv_usec
;
1010 request
->cycle_timer
= bus_time
& 0xffffffff;
1014 static void iso_resource_work(struct work_struct
*work
)
1016 struct iso_resource_event
*e
;
1017 struct iso_resource
*r
=
1018 container_of(work
, struct iso_resource
, work
.work
);
1019 struct client
*client
= r
->client
;
1020 int generation
, channel
, bandwidth
, todo
;
1021 bool skip
, free
, success
;
1023 spin_lock_irq(&client
->lock
);
1024 generation
= client
->device
->generation
;
1026 /* Allow 1000ms grace period for other reallocations. */
1027 if (todo
== ISO_RES_ALLOC
&&
1028 time_is_after_jiffies(client
->device
->card
->reset_jiffies
+ HZ
)) {
1029 if (schedule_delayed_work(&r
->work
, DIV_ROUND_UP(HZ
, 3)))
1033 /* We could be called twice within the same generation. */
1034 skip
= todo
== ISO_RES_REALLOC
&&
1035 r
->generation
== generation
;
1037 free
= todo
== ISO_RES_DEALLOC
||
1038 todo
== ISO_RES_ALLOC_ONCE
||
1039 todo
== ISO_RES_DEALLOC_ONCE
;
1040 r
->generation
= generation
;
1041 spin_unlock_irq(&client
->lock
);
1046 bandwidth
= r
->bandwidth
;
1048 fw_iso_resource_manage(client
->device
->card
, generation
,
1049 r
->channels
, &channel
, &bandwidth
,
1050 todo
== ISO_RES_ALLOC
||
1051 todo
== ISO_RES_REALLOC
||
1052 todo
== ISO_RES_ALLOC_ONCE
);
1054 * Is this generation outdated already? As long as this resource sticks
1055 * in the idr, it will be scheduled again for a newer generation or at
1058 if (channel
== -EAGAIN
&&
1059 (todo
== ISO_RES_ALLOC
|| todo
== ISO_RES_REALLOC
))
1062 success
= channel
>= 0 || bandwidth
> 0;
1064 spin_lock_irq(&client
->lock
);
1066 * Transit from allocation to reallocation, except if the client
1067 * requested deallocation in the meantime.
1069 if (r
->todo
== ISO_RES_ALLOC
)
1070 r
->todo
= ISO_RES_REALLOC
;
1072 * Allocation or reallocation failure? Pull this resource out of the
1073 * idr and prepare for deletion, unless the client is shutting down.
1075 if (r
->todo
== ISO_RES_REALLOC
&& !success
&&
1076 !client
->in_shutdown
&&
1077 idr_find(&client
->resource_idr
, r
->resource
.handle
)) {
1078 idr_remove(&client
->resource_idr
, r
->resource
.handle
);
1082 spin_unlock_irq(&client
->lock
);
1084 if (todo
== ISO_RES_ALLOC
&& channel
>= 0)
1085 r
->channels
= 1ULL << channel
;
1087 if (todo
== ISO_RES_REALLOC
&& success
)
1090 if (todo
== ISO_RES_ALLOC
|| todo
== ISO_RES_ALLOC_ONCE
) {
1095 r
->e_dealloc
= NULL
;
1097 e
->resource
.handle
= r
->resource
.handle
;
1098 e
->resource
.channel
= channel
;
1099 e
->resource
.bandwidth
= bandwidth
;
1101 queue_event(client
, &e
->event
,
1102 &e
->resource
, sizeof(e
->resource
), NULL
, 0);
1105 cancel_delayed_work(&r
->work
);
1107 kfree(r
->e_dealloc
);
1114 static void schedule_iso_resource(struct iso_resource
*r
)
1116 client_get(r
->client
);
1117 if (!schedule_delayed_work(&r
->work
, 0))
1118 client_put(r
->client
);
1121 static void release_iso_resource(struct client
*client
,
1122 struct client_resource
*resource
)
1124 struct iso_resource
*r
=
1125 container_of(resource
, struct iso_resource
, resource
);
1127 spin_lock_irq(&client
->lock
);
1128 r
->todo
= ISO_RES_DEALLOC
;
1129 schedule_iso_resource(r
);
1130 spin_unlock_irq(&client
->lock
);
1133 static int init_iso_resource(struct client
*client
,
1134 struct fw_cdev_allocate_iso_resource
*request
, int todo
)
1136 struct iso_resource_event
*e1
, *e2
;
1137 struct iso_resource
*r
;
1140 if ((request
->channels
== 0 && request
->bandwidth
== 0) ||
1141 request
->bandwidth
> BANDWIDTH_AVAILABLE_INITIAL
||
1142 request
->bandwidth
< 0)
1145 r
= kmalloc(sizeof(*r
), GFP_KERNEL
);
1146 e1
= kmalloc(sizeof(*e1
), GFP_KERNEL
);
1147 e2
= kmalloc(sizeof(*e2
), GFP_KERNEL
);
1148 if (r
== NULL
|| e1
== NULL
|| e2
== NULL
) {
1153 INIT_DELAYED_WORK(&r
->work
, iso_resource_work
);
1157 r
->channels
= request
->channels
;
1158 r
->bandwidth
= request
->bandwidth
;
1162 e1
->resource
.closure
= request
->closure
;
1163 e1
->resource
.type
= FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED
;
1164 e2
->resource
.closure
= request
->closure
;
1165 e2
->resource
.type
= FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED
;
1167 if (todo
== ISO_RES_ALLOC
) {
1168 r
->resource
.release
= release_iso_resource
;
1169 ret
= add_client_resource(client
, &r
->resource
, GFP_KERNEL
);
1173 r
->resource
.release
= NULL
;
1174 r
->resource
.handle
= -1;
1175 schedule_iso_resource(r
);
1177 request
->handle
= r
->resource
.handle
;
1188 static int ioctl_allocate_iso_resource(struct client
*client
, void *buffer
)
1190 struct fw_cdev_allocate_iso_resource
*request
= buffer
;
1192 return init_iso_resource(client
, request
, ISO_RES_ALLOC
);
1195 static int ioctl_deallocate_iso_resource(struct client
*client
, void *buffer
)
1197 struct fw_cdev_deallocate
*request
= buffer
;
1199 return release_client_resource(client
, request
->handle
,
1200 release_iso_resource
, NULL
);
1203 static int ioctl_allocate_iso_resource_once(struct client
*client
, void *buffer
)
1205 struct fw_cdev_allocate_iso_resource
*request
= buffer
;
1207 return init_iso_resource(client
, request
, ISO_RES_ALLOC_ONCE
);
1210 static int ioctl_deallocate_iso_resource_once(struct client
*client
, void *buffer
)
1212 struct fw_cdev_allocate_iso_resource
*request
= buffer
;
1214 return init_iso_resource(client
, request
, ISO_RES_DEALLOC_ONCE
);
1218 * Returns a speed code: Maximum speed to or from this device,
1219 * limited by the device's link speed, the local node's link speed,
1220 * and all PHY port speeds between the two links.
1222 static int ioctl_get_speed(struct client
*client
, void *buffer
)
1224 return client
->device
->max_speed
;
1227 static int ioctl_send_broadcast_request(struct client
*client
, void *buffer
)
1229 struct fw_cdev_send_request
*request
= buffer
;
1231 switch (request
->tcode
) {
1232 case TCODE_WRITE_QUADLET_REQUEST
:
1233 case TCODE_WRITE_BLOCK_REQUEST
:
1239 /* Security policy: Only allow accesses to Units Space. */
1240 if (request
->offset
< CSR_REGISTER_BASE
+ CSR_CONFIG_ROM_END
)
1243 return init_request(client
, request
, LOCAL_BUS
| 0x3f, SCODE_100
);
1246 static int ioctl_send_stream_packet(struct client
*client
, void *buffer
)
1248 struct fw_cdev_send_stream_packet
*p
= buffer
;
1249 struct fw_cdev_send_request request
;
1252 if (p
->speed
> client
->device
->card
->link_speed
||
1253 p
->length
> 1024 << p
->speed
)
1256 if (p
->tag
> 3 || p
->channel
> 63 || p
->sy
> 15)
1259 dest
= fw_stream_packet_destination_id(p
->tag
, p
->channel
, p
->sy
);
1260 request
.tcode
= TCODE_STREAM_DATA
;
1261 request
.length
= p
->length
;
1262 request
.closure
= p
->closure
;
1263 request
.data
= p
->data
;
1264 request
.generation
= p
->generation
;
1266 return init_request(client
, &request
, dest
, p
->speed
);
1269 static int (* const ioctl_handlers
[])(struct client
*client
, void *buffer
) = {
1274 ioctl_send_response
,
1275 ioctl_initiate_bus_reset
,
1276 ioctl_add_descriptor
,
1277 ioctl_remove_descriptor
,
1278 ioctl_create_iso_context
,
1282 ioctl_get_cycle_timer
,
1283 ioctl_allocate_iso_resource
,
1284 ioctl_deallocate_iso_resource
,
1285 ioctl_allocate_iso_resource_once
,
1286 ioctl_deallocate_iso_resource_once
,
1288 ioctl_send_broadcast_request
,
1289 ioctl_send_stream_packet
,
1292 static int dispatch_ioctl(struct client
*client
,
1293 unsigned int cmd
, void __user
*arg
)
1298 if (_IOC_TYPE(cmd
) != '#' ||
1299 _IOC_NR(cmd
) >= ARRAY_SIZE(ioctl_handlers
))
1302 if (_IOC_DIR(cmd
) & _IOC_WRITE
) {
1303 if (_IOC_SIZE(cmd
) > sizeof(buffer
) ||
1304 copy_from_user(buffer
, arg
, _IOC_SIZE(cmd
)))
1308 ret
= ioctl_handlers
[_IOC_NR(cmd
)](client
, buffer
);
1312 if (_IOC_DIR(cmd
) & _IOC_READ
) {
1313 if (_IOC_SIZE(cmd
) > sizeof(buffer
) ||
1314 copy_to_user(arg
, buffer
, _IOC_SIZE(cmd
)))
1321 static long fw_device_op_ioctl(struct file
*file
,
1322 unsigned int cmd
, unsigned long arg
)
1324 struct client
*client
= file
->private_data
;
1326 if (fw_device_is_shutdown(client
->device
))
1329 return dispatch_ioctl(client
, cmd
, (void __user
*) arg
);
1332 #ifdef CONFIG_COMPAT
1333 static long fw_device_op_compat_ioctl(struct file
*file
,
1334 unsigned int cmd
, unsigned long arg
)
1336 struct client
*client
= file
->private_data
;
1338 if (fw_device_is_shutdown(client
->device
))
1341 return dispatch_ioctl(client
, cmd
, compat_ptr(arg
));
1345 static int fw_device_op_mmap(struct file
*file
, struct vm_area_struct
*vma
)
1347 struct client
*client
= file
->private_data
;
1348 enum dma_data_direction direction
;
1350 int page_count
, ret
;
1352 if (fw_device_is_shutdown(client
->device
))
1355 /* FIXME: We could support multiple buffers, but we don't. */
1356 if (client
->buffer
.pages
!= NULL
)
1359 if (!(vma
->vm_flags
& VM_SHARED
))
1362 if (vma
->vm_start
& ~PAGE_MASK
)
1365 client
->vm_start
= vma
->vm_start
;
1366 size
= vma
->vm_end
- vma
->vm_start
;
1367 page_count
= size
>> PAGE_SHIFT
;
1368 if (size
& ~PAGE_MASK
)
1371 if (vma
->vm_flags
& VM_WRITE
)
1372 direction
= DMA_TO_DEVICE
;
1374 direction
= DMA_FROM_DEVICE
;
1376 ret
= fw_iso_buffer_init(&client
->buffer
, client
->device
->card
,
1377 page_count
, direction
);
1381 ret
= fw_iso_buffer_map(&client
->buffer
, vma
);
1383 fw_iso_buffer_destroy(&client
->buffer
, client
->device
->card
);
1388 static int shutdown_resource(int id
, void *p
, void *data
)
1390 struct client_resource
*r
= p
;
1391 struct client
*client
= data
;
1393 r
->release(client
, r
);
1399 static int fw_device_op_release(struct inode
*inode
, struct file
*file
)
1401 struct client
*client
= file
->private_data
;
1402 struct event
*e
, *next_e
;
1404 mutex_lock(&client
->device
->client_list_mutex
);
1405 list_del(&client
->link
);
1406 mutex_unlock(&client
->device
->client_list_mutex
);
1408 if (client
->iso_context
)
1409 fw_iso_context_destroy(client
->iso_context
);
1411 if (client
->buffer
.pages
)
1412 fw_iso_buffer_destroy(&client
->buffer
, client
->device
->card
);
1414 /* Freeze client->resource_idr and client->event_list */
1415 spin_lock_irq(&client
->lock
);
1416 client
->in_shutdown
= true;
1417 spin_unlock_irq(&client
->lock
);
1419 idr_for_each(&client
->resource_idr
, shutdown_resource
, client
);
1420 idr_remove_all(&client
->resource_idr
);
1421 idr_destroy(&client
->resource_idr
);
1423 list_for_each_entry_safe(e
, next_e
, &client
->event_list
, link
)
1431 static unsigned int fw_device_op_poll(struct file
*file
, poll_table
* pt
)
1433 struct client
*client
= file
->private_data
;
1434 unsigned int mask
= 0;
1436 poll_wait(file
, &client
->wait
, pt
);
1438 if (fw_device_is_shutdown(client
->device
))
1439 mask
|= POLLHUP
| POLLERR
;
1440 if (!list_empty(&client
->event_list
))
1441 mask
|= POLLIN
| POLLRDNORM
;
1446 const struct file_operations fw_device_ops
= {
1447 .owner
= THIS_MODULE
,
1448 .open
= fw_device_op_open
,
1449 .read
= fw_device_op_read
,
1450 .unlocked_ioctl
= fw_device_op_ioctl
,
1451 .poll
= fw_device_op_poll
,
1452 .release
= fw_device_op_release
,
1453 .mmap
= fw_device_op_mmap
,
1455 #ifdef CONFIG_COMPAT
1456 .compat_ioctl
= fw_device_op_compat_ioctl
,