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/sched.h>
37 #include <linux/spinlock.h>
38 #include <linux/time.h>
39 #include <linux/uaccess.h>
40 #include <linux/vmalloc.h>
41 #include <linux/wait.h>
42 #include <linux/workqueue.h>
44 #include <asm/system.h>
50 struct fw_device
*device
;
54 struct idr resource_idr
;
55 struct list_head event_list
;
56 wait_queue_head_t wait
;
57 u64 bus_reset_closure
;
59 struct fw_iso_context
*iso_context
;
61 struct fw_iso_buffer buffer
;
62 unsigned long vm_start
;
64 struct list_head link
;
68 static inline void client_get(struct client
*client
)
70 kref_get(&client
->kref
);
73 static void client_release(struct kref
*kref
)
75 struct client
*client
= container_of(kref
, struct client
, kref
);
77 fw_device_put(client
->device
);
81 static void client_put(struct client
*client
)
83 kref_put(&client
->kref
, client_release
);
86 struct client_resource
;
87 typedef void (*client_resource_release_fn_t
)(struct client
*,
88 struct client_resource
*);
89 struct client_resource
{
90 client_resource_release_fn_t release
;
94 struct address_handler_resource
{
95 struct client_resource resource
;
96 struct fw_address_handler handler
;
98 struct client
*client
;
101 struct outbound_transaction_resource
{
102 struct client_resource resource
;
103 struct fw_transaction transaction
;
106 struct inbound_transaction_resource
{
107 struct client_resource resource
;
108 struct fw_request
*request
;
113 struct descriptor_resource
{
114 struct client_resource resource
;
115 struct fw_descriptor descriptor
;
119 struct iso_resource
{
120 struct client_resource resource
;
121 struct client
*client
;
122 /* Schedule work and access todo only with client->lock held. */
123 struct delayed_work work
;
124 enum {ISO_RES_ALLOC
, ISO_RES_REALLOC
, ISO_RES_DEALLOC
,
125 ISO_RES_ALLOC_ONCE
, ISO_RES_DEALLOC_ONCE
,} todo
;
129 __be32 transaction_data
[2];
130 struct iso_resource_event
*e_alloc
, *e_dealloc
;
133 static void release_iso_resource(struct client
*, struct client_resource
*);
135 static void schedule_iso_resource(struct iso_resource
*r
, unsigned long delay
)
137 client_get(r
->client
);
138 if (!schedule_delayed_work(&r
->work
, delay
))
139 client_put(r
->client
);
142 static void schedule_if_iso_resource(struct client_resource
*resource
)
144 if (resource
->release
== release_iso_resource
)
145 schedule_iso_resource(container_of(resource
,
146 struct iso_resource
, resource
), 0);
150 * dequeue_event() just kfree()'s the event, so the event has to be
151 * the first field in a struct XYZ_event.
154 struct { void *data
; size_t size
; } v
[2];
155 struct list_head link
;
158 struct bus_reset_event
{
160 struct fw_cdev_event_bus_reset reset
;
163 struct outbound_transaction_event
{
165 struct client
*client
;
166 struct outbound_transaction_resource r
;
167 struct fw_cdev_event_response response
;
170 struct inbound_transaction_event
{
172 struct fw_cdev_event_request request
;
175 struct iso_interrupt_event
{
177 struct fw_cdev_event_iso_interrupt interrupt
;
180 struct iso_resource_event
{
182 struct fw_cdev_event_iso_resource iso_resource
;
185 static inline void __user
*u64_to_uptr(__u64 value
)
187 return (void __user
*)(unsigned long)value
;
190 static inline __u64
uptr_to_u64(void __user
*ptr
)
192 return (__u64
)(unsigned long)ptr
;
195 static int fw_device_op_open(struct inode
*inode
, struct file
*file
)
197 struct fw_device
*device
;
198 struct client
*client
;
200 device
= fw_device_get_by_devt(inode
->i_rdev
);
204 if (fw_device_is_shutdown(device
)) {
205 fw_device_put(device
);
209 client
= kzalloc(sizeof(*client
), GFP_KERNEL
);
210 if (client
== NULL
) {
211 fw_device_put(device
);
215 client
->device
= device
;
216 spin_lock_init(&client
->lock
);
217 idr_init(&client
->resource_idr
);
218 INIT_LIST_HEAD(&client
->event_list
);
219 init_waitqueue_head(&client
->wait
);
220 kref_init(&client
->kref
);
222 file
->private_data
= client
;
224 mutex_lock(&device
->client_list_mutex
);
225 list_add_tail(&client
->link
, &device
->client_list
);
226 mutex_unlock(&device
->client_list_mutex
);
231 static void queue_event(struct client
*client
, struct event
*event
,
232 void *data0
, size_t size0
, void *data1
, size_t size1
)
236 event
->v
[0].data
= data0
;
237 event
->v
[0].size
= size0
;
238 event
->v
[1].data
= data1
;
239 event
->v
[1].size
= size1
;
241 spin_lock_irqsave(&client
->lock
, flags
);
242 if (client
->in_shutdown
)
245 list_add_tail(&event
->link
, &client
->event_list
);
246 spin_unlock_irqrestore(&client
->lock
, flags
);
248 wake_up_interruptible(&client
->wait
);
251 static int dequeue_event(struct client
*client
,
252 char __user
*buffer
, size_t count
)
258 ret
= wait_event_interruptible(client
->wait
,
259 !list_empty(&client
->event_list
) ||
260 fw_device_is_shutdown(client
->device
));
264 if (list_empty(&client
->event_list
) &&
265 fw_device_is_shutdown(client
->device
))
268 spin_lock_irq(&client
->lock
);
269 event
= list_first_entry(&client
->event_list
, struct event
, link
);
270 list_del(&event
->link
);
271 spin_unlock_irq(&client
->lock
);
274 for (i
= 0; i
< ARRAY_SIZE(event
->v
) && total
< count
; i
++) {
275 size
= min(event
->v
[i
].size
, count
- total
);
276 if (copy_to_user(buffer
+ total
, event
->v
[i
].data
, size
)) {
290 static ssize_t
fw_device_op_read(struct file
*file
, char __user
*buffer
,
291 size_t count
, loff_t
*offset
)
293 struct client
*client
= file
->private_data
;
295 return dequeue_event(client
, buffer
, count
);
298 static void fill_bus_reset_event(struct fw_cdev_event_bus_reset
*event
,
299 struct client
*client
)
301 struct fw_card
*card
= client
->device
->card
;
303 spin_lock_irq(&card
->lock
);
305 event
->closure
= client
->bus_reset_closure
;
306 event
->type
= FW_CDEV_EVENT_BUS_RESET
;
307 event
->generation
= client
->device
->generation
;
308 event
->node_id
= client
->device
->node_id
;
309 event
->local_node_id
= card
->local_node
->node_id
;
310 event
->bm_node_id
= 0; /* FIXME: We don't track the BM. */
311 event
->irm_node_id
= card
->irm_node
->node_id
;
312 event
->root_node_id
= card
->root_node
->node_id
;
314 spin_unlock_irq(&card
->lock
);
317 static void for_each_client(struct fw_device
*device
,
318 void (*callback
)(struct client
*client
))
322 mutex_lock(&device
->client_list_mutex
);
323 list_for_each_entry(c
, &device
->client_list
, link
)
325 mutex_unlock(&device
->client_list_mutex
);
328 static int schedule_reallocations(int id
, void *p
, void *data
)
330 schedule_if_iso_resource(p
);
335 static void queue_bus_reset_event(struct client
*client
)
337 struct bus_reset_event
*e
;
339 e
= kzalloc(sizeof(*e
), GFP_KERNEL
);
341 fw_notify("Out of memory when allocating bus reset event\n");
345 fill_bus_reset_event(&e
->reset
, client
);
347 queue_event(client
, &e
->event
,
348 &e
->reset
, sizeof(e
->reset
), NULL
, 0);
350 spin_lock_irq(&client
->lock
);
351 idr_for_each(&client
->resource_idr
, schedule_reallocations
, client
);
352 spin_unlock_irq(&client
->lock
);
355 void fw_device_cdev_update(struct fw_device
*device
)
357 for_each_client(device
, queue_bus_reset_event
);
360 static void wake_up_client(struct client
*client
)
362 wake_up_interruptible(&client
->wait
);
365 void fw_device_cdev_remove(struct fw_device
*device
)
367 for_each_client(device
, wake_up_client
);
370 static int ioctl_get_info(struct client
*client
, void *buffer
)
372 struct fw_cdev_get_info
*get_info
= buffer
;
373 struct fw_cdev_event_bus_reset bus_reset
;
374 unsigned long ret
= 0;
376 client
->version
= get_info
->version
;
377 get_info
->version
= FW_CDEV_VERSION
;
378 get_info
->card
= client
->device
->card
->index
;
380 down_read(&fw_device_rwsem
);
382 if (get_info
->rom
!= 0) {
383 void __user
*uptr
= u64_to_uptr(get_info
->rom
);
384 size_t want
= get_info
->rom_length
;
385 size_t have
= client
->device
->config_rom_length
* 4;
387 ret
= copy_to_user(uptr
, client
->device
->config_rom
,
390 get_info
->rom_length
= client
->device
->config_rom_length
* 4;
392 up_read(&fw_device_rwsem
);
397 client
->bus_reset_closure
= get_info
->bus_reset_closure
;
398 if (get_info
->bus_reset
!= 0) {
399 void __user
*uptr
= u64_to_uptr(get_info
->bus_reset
);
401 fill_bus_reset_event(&bus_reset
, client
);
402 if (copy_to_user(uptr
, &bus_reset
, sizeof(bus_reset
)))
409 static int add_client_resource(struct client
*client
,
410 struct client_resource
*resource
, gfp_t gfp_mask
)
416 if (idr_pre_get(&client
->resource_idr
, gfp_mask
) == 0)
419 spin_lock_irqsave(&client
->lock
, flags
);
420 if (client
->in_shutdown
)
423 ret
= idr_get_new(&client
->resource_idr
, resource
,
427 schedule_if_iso_resource(resource
);
429 spin_unlock_irqrestore(&client
->lock
, flags
);
434 return ret
< 0 ? ret
: 0;
437 static int release_client_resource(struct client
*client
, u32 handle
,
438 client_resource_release_fn_t release
,
439 struct client_resource
**return_resource
)
441 struct client_resource
*resource
;
443 spin_lock_irq(&client
->lock
);
444 if (client
->in_shutdown
)
447 resource
= idr_find(&client
->resource_idr
, handle
);
448 if (resource
&& resource
->release
== release
)
449 idr_remove(&client
->resource_idr
, handle
);
450 spin_unlock_irq(&client
->lock
);
452 if (!(resource
&& resource
->release
== release
))
456 *return_resource
= resource
;
458 resource
->release(client
, resource
);
465 static void release_transaction(struct client
*client
,
466 struct client_resource
*resource
)
468 struct outbound_transaction_resource
*r
= container_of(resource
,
469 struct outbound_transaction_resource
, resource
);
471 fw_cancel_transaction(client
->device
->card
, &r
->transaction
);
474 static void complete_transaction(struct fw_card
*card
, int rcode
,
475 void *payload
, size_t length
, void *data
)
477 struct outbound_transaction_event
*e
= data
;
478 struct fw_cdev_event_response
*rsp
= &e
->response
;
479 struct client
*client
= e
->client
;
482 if (length
< rsp
->length
)
483 rsp
->length
= length
;
484 if (rcode
== RCODE_COMPLETE
)
485 memcpy(rsp
->data
, payload
, rsp
->length
);
487 spin_lock_irqsave(&client
->lock
, flags
);
489 * 1. If called while in shutdown, the idr tree must be left untouched.
490 * The idr handle will be removed and the client reference will be
492 * 2. If the call chain was release_client_resource ->
493 * release_transaction -> complete_transaction (instead of a normal
494 * conclusion of the transaction), i.e. if this resource was already
495 * unregistered from the idr, the client reference will be dropped
496 * by release_client_resource and we must not drop it here.
498 if (!client
->in_shutdown
&&
499 idr_find(&client
->resource_idr
, e
->r
.resource
.handle
)) {
500 idr_remove(&client
->resource_idr
, e
->r
.resource
.handle
);
501 /* Drop the idr's reference */
504 spin_unlock_irqrestore(&client
->lock
, flags
);
506 rsp
->type
= FW_CDEV_EVENT_RESPONSE
;
510 * In the case that sizeof(*rsp) doesn't align with the position of the
511 * data, and the read is short, preserve an extra copy of the data
512 * to stay compatible with a pre-2.6.27 bug. Since the bug is harmless
513 * for short reads and some apps depended on it, this is both safe
514 * and prudent for compatibility.
516 if (rsp
->length
<= sizeof(*rsp
) - offsetof(typeof(*rsp
), data
))
517 queue_event(client
, &e
->event
, rsp
, sizeof(*rsp
),
518 rsp
->data
, rsp
->length
);
520 queue_event(client
, &e
->event
, rsp
, sizeof(*rsp
) + rsp
->length
,
523 /* Drop the transaction callback's reference */
527 static int init_request(struct client
*client
,
528 struct fw_cdev_send_request
*request
,
529 int destination_id
, int speed
)
531 struct outbound_transaction_event
*e
;
534 if (request
->tcode
!= TCODE_STREAM_DATA
&&
535 (request
->length
> 4096 || request
->length
> 512 << speed
))
538 e
= kmalloc(sizeof(*e
) + request
->length
, GFP_KERNEL
);
543 e
->response
.length
= request
->length
;
544 e
->response
.closure
= request
->closure
;
547 copy_from_user(e
->response
.data
,
548 u64_to_uptr(request
->data
), request
->length
)) {
553 e
->r
.resource
.release
= release_transaction
;
554 ret
= add_client_resource(client
, &e
->r
.resource
, GFP_KERNEL
);
558 /* Get a reference for the transaction callback */
561 fw_send_request(client
->device
->card
, &e
->r
.transaction
,
562 request
->tcode
, destination_id
, request
->generation
,
563 speed
, request
->offset
, e
->response
.data
,
564 request
->length
, complete_transaction
, e
);
573 static int ioctl_send_request(struct client
*client
, void *buffer
)
575 struct fw_cdev_send_request
*request
= buffer
;
577 switch (request
->tcode
) {
578 case TCODE_WRITE_QUADLET_REQUEST
:
579 case TCODE_WRITE_BLOCK_REQUEST
:
580 case TCODE_READ_QUADLET_REQUEST
:
581 case TCODE_READ_BLOCK_REQUEST
:
582 case TCODE_LOCK_MASK_SWAP
:
583 case TCODE_LOCK_COMPARE_SWAP
:
584 case TCODE_LOCK_FETCH_ADD
:
585 case TCODE_LOCK_LITTLE_ADD
:
586 case TCODE_LOCK_BOUNDED_ADD
:
587 case TCODE_LOCK_WRAP_ADD
:
588 case TCODE_LOCK_VENDOR_DEPENDENT
:
594 return init_request(client
, request
, client
->device
->node_id
,
595 client
->device
->max_speed
);
598 static void release_request(struct client
*client
,
599 struct client_resource
*resource
)
601 struct inbound_transaction_resource
*r
= container_of(resource
,
602 struct inbound_transaction_resource
, resource
);
604 fw_send_response(client
->device
->card
, r
->request
,
605 RCODE_CONFLICT_ERROR
);
609 static void handle_request(struct fw_card
*card
, struct fw_request
*request
,
610 int tcode
, int destination
, int source
,
611 int generation
, int speed
,
612 unsigned long long offset
,
613 void *payload
, size_t length
, void *callback_data
)
615 struct address_handler_resource
*handler
= callback_data
;
616 struct inbound_transaction_resource
*r
;
617 struct inbound_transaction_event
*e
;
620 r
= kmalloc(sizeof(*r
), GFP_ATOMIC
);
621 e
= kmalloc(sizeof(*e
), GFP_ATOMIC
);
622 if (r
== NULL
|| e
== NULL
)
625 r
->request
= request
;
629 r
->resource
.release
= release_request
;
630 ret
= add_client_resource(handler
->client
, &r
->resource
, GFP_ATOMIC
);
634 e
->request
.type
= FW_CDEV_EVENT_REQUEST
;
635 e
->request
.tcode
= tcode
;
636 e
->request
.offset
= offset
;
637 e
->request
.length
= length
;
638 e
->request
.handle
= r
->resource
.handle
;
639 e
->request
.closure
= handler
->closure
;
641 queue_event(handler
->client
, &e
->event
,
642 &e
->request
, sizeof(e
->request
), payload
, length
);
648 fw_send_response(card
, request
, RCODE_CONFLICT_ERROR
);
651 static void release_address_handler(struct client
*client
,
652 struct client_resource
*resource
)
654 struct address_handler_resource
*r
=
655 container_of(resource
, struct address_handler_resource
, resource
);
657 fw_core_remove_address_handler(&r
->handler
);
661 static int ioctl_allocate(struct client
*client
, void *buffer
)
663 struct fw_cdev_allocate
*request
= buffer
;
664 struct address_handler_resource
*r
;
665 struct fw_address_region region
;
668 r
= kmalloc(sizeof(*r
), GFP_KERNEL
);
672 region
.start
= request
->offset
;
673 region
.end
= request
->offset
+ request
->length
;
674 r
->handler
.length
= request
->length
;
675 r
->handler
.address_callback
= handle_request
;
676 r
->handler
.callback_data
= r
;
677 r
->closure
= request
->closure
;
680 ret
= fw_core_add_address_handler(&r
->handler
, ®ion
);
686 r
->resource
.release
= release_address_handler
;
687 ret
= add_client_resource(client
, &r
->resource
, GFP_KERNEL
);
689 release_address_handler(client
, &r
->resource
);
692 request
->handle
= r
->resource
.handle
;
697 static int ioctl_deallocate(struct client
*client
, void *buffer
)
699 struct fw_cdev_deallocate
*request
= buffer
;
701 return release_client_resource(client
, request
->handle
,
702 release_address_handler
, NULL
);
705 static int ioctl_send_response(struct client
*client
, void *buffer
)
707 struct fw_cdev_send_response
*request
= buffer
;
708 struct client_resource
*resource
;
709 struct inbound_transaction_resource
*r
;
712 if (release_client_resource(client
, request
->handle
,
713 release_request
, &resource
) < 0)
716 r
= container_of(resource
, struct inbound_transaction_resource
,
718 if (request
->length
< r
->length
)
719 r
->length
= request
->length
;
721 if (copy_from_user(r
->data
, u64_to_uptr(request
->data
), r
->length
)) {
726 fw_send_response(client
->device
->card
, r
->request
, request
->rcode
);
733 static int ioctl_initiate_bus_reset(struct client
*client
, void *buffer
)
735 struct fw_cdev_initiate_bus_reset
*request
= buffer
;
738 short_reset
= (request
->type
== FW_CDEV_SHORT_RESET
);
740 return fw_core_initiate_bus_reset(client
->device
->card
, short_reset
);
743 static void release_descriptor(struct client
*client
,
744 struct client_resource
*resource
)
746 struct descriptor_resource
*r
=
747 container_of(resource
, struct descriptor_resource
, resource
);
749 fw_core_remove_descriptor(&r
->descriptor
);
753 static int ioctl_add_descriptor(struct client
*client
, void *buffer
)
755 struct fw_cdev_add_descriptor
*request
= buffer
;
756 struct descriptor_resource
*r
;
759 /* Access policy: Allow this ioctl only on local nodes' device files. */
760 if (!client
->device
->is_local
)
763 if (request
->length
> 256)
766 r
= kmalloc(sizeof(*r
) + request
->length
* 4, GFP_KERNEL
);
770 if (copy_from_user(r
->data
,
771 u64_to_uptr(request
->data
), request
->length
* 4)) {
776 r
->descriptor
.length
= request
->length
;
777 r
->descriptor
.immediate
= request
->immediate
;
778 r
->descriptor
.key
= request
->key
;
779 r
->descriptor
.data
= r
->data
;
781 ret
= fw_core_add_descriptor(&r
->descriptor
);
785 r
->resource
.release
= release_descriptor
;
786 ret
= add_client_resource(client
, &r
->resource
, GFP_KERNEL
);
788 fw_core_remove_descriptor(&r
->descriptor
);
791 request
->handle
= r
->resource
.handle
;
800 static int ioctl_remove_descriptor(struct client
*client
, void *buffer
)
802 struct fw_cdev_remove_descriptor
*request
= buffer
;
804 return release_client_resource(client
, request
->handle
,
805 release_descriptor
, NULL
);
808 static void iso_callback(struct fw_iso_context
*context
, u32 cycle
,
809 size_t header_length
, void *header
, void *data
)
811 struct client
*client
= data
;
812 struct iso_interrupt_event
*e
;
814 e
= kzalloc(sizeof(*e
) + header_length
, GFP_ATOMIC
);
818 e
->interrupt
.type
= FW_CDEV_EVENT_ISO_INTERRUPT
;
819 e
->interrupt
.closure
= client
->iso_closure
;
820 e
->interrupt
.cycle
= cycle
;
821 e
->interrupt
.header_length
= header_length
;
822 memcpy(e
->interrupt
.header
, header
, header_length
);
823 queue_event(client
, &e
->event
, &e
->interrupt
,
824 sizeof(e
->interrupt
) + header_length
, NULL
, 0);
827 static int ioctl_create_iso_context(struct client
*client
, void *buffer
)
829 struct fw_cdev_create_iso_context
*request
= buffer
;
830 struct fw_iso_context
*context
;
832 /* We only support one context at this time. */
833 if (client
->iso_context
!= NULL
)
836 if (request
->channel
> 63)
839 switch (request
->type
) {
840 case FW_ISO_CONTEXT_RECEIVE
:
841 if (request
->header_size
< 4 || (request
->header_size
& 3))
846 case FW_ISO_CONTEXT_TRANSMIT
:
847 if (request
->speed
> SCODE_3200
)
856 context
= fw_iso_context_create(client
->device
->card
,
860 request
->header_size
,
861 iso_callback
, client
);
863 return PTR_ERR(context
);
865 client
->iso_closure
= request
->closure
;
866 client
->iso_context
= context
;
868 /* We only support one context at this time. */
874 /* Macros for decoding the iso packet control header. */
875 #define GET_PAYLOAD_LENGTH(v) ((v) & 0xffff)
876 #define GET_INTERRUPT(v) (((v) >> 16) & 0x01)
877 #define GET_SKIP(v) (((v) >> 17) & 0x01)
878 #define GET_TAG(v) (((v) >> 18) & 0x03)
879 #define GET_SY(v) (((v) >> 20) & 0x0f)
880 #define GET_HEADER_LENGTH(v) (((v) >> 24) & 0xff)
882 static int ioctl_queue_iso(struct client
*client
, void *buffer
)
884 struct fw_cdev_queue_iso
*request
= buffer
;
885 struct fw_cdev_iso_packet __user
*p
, *end
, *next
;
886 struct fw_iso_context
*ctx
= client
->iso_context
;
887 unsigned long payload
, buffer_end
, header_length
;
891 struct fw_iso_packet packet
;
895 if (ctx
== NULL
|| request
->handle
!= 0)
899 * If the user passes a non-NULL data pointer, has mmap()'ed
900 * the iso buffer, and the pointer points inside the buffer,
901 * we setup the payload pointers accordingly. Otherwise we
902 * set them both to 0, which will still let packets with
903 * payload_length == 0 through. In other words, if no packets
904 * use the indirect payload, the iso buffer need not be mapped
905 * and the request->data pointer is ignored.
908 payload
= (unsigned long)request
->data
- client
->vm_start
;
909 buffer_end
= client
->buffer
.page_count
<< PAGE_SHIFT
;
910 if (request
->data
== 0 || client
->buffer
.pages
== NULL
||
911 payload
>= buffer_end
) {
916 p
= (struct fw_cdev_iso_packet __user
*)u64_to_uptr(request
->packets
);
918 if (!access_ok(VERIFY_READ
, p
, request
->size
))
921 end
= (void __user
*)p
+ request
->size
;
924 if (get_user(control
, &p
->control
))
926 u
.packet
.payload_length
= GET_PAYLOAD_LENGTH(control
);
927 u
.packet
.interrupt
= GET_INTERRUPT(control
);
928 u
.packet
.skip
= GET_SKIP(control
);
929 u
.packet
.tag
= GET_TAG(control
);
930 u
.packet
.sy
= GET_SY(control
);
931 u
.packet
.header_length
= GET_HEADER_LENGTH(control
);
933 if (ctx
->type
== FW_ISO_CONTEXT_TRANSMIT
) {
934 header_length
= u
.packet
.header_length
;
937 * We require that header_length is a multiple of
938 * the fixed header size, ctx->header_size.
940 if (ctx
->header_size
== 0) {
941 if (u
.packet
.header_length
> 0)
943 } else if (u
.packet
.header_length
% ctx
->header_size
!= 0) {
949 next
= (struct fw_cdev_iso_packet __user
*)
950 &p
->header
[header_length
/ 4];
954 (u
.packet
.header
, p
->header
, header_length
))
956 if (u
.packet
.skip
&& ctx
->type
== FW_ISO_CONTEXT_TRANSMIT
&&
957 u
.packet
.header_length
+ u
.packet
.payload_length
> 0)
959 if (payload
+ u
.packet
.payload_length
> buffer_end
)
962 if (fw_iso_context_queue(ctx
, &u
.packet
,
963 &client
->buffer
, payload
))
967 payload
+= u
.packet
.payload_length
;
971 request
->size
-= uptr_to_u64(p
) - request
->packets
;
972 request
->packets
= uptr_to_u64(p
);
973 request
->data
= client
->vm_start
+ payload
;
978 static int ioctl_start_iso(struct client
*client
, void *buffer
)
980 struct fw_cdev_start_iso
*request
= buffer
;
982 if (client
->iso_context
== NULL
|| request
->handle
!= 0)
985 if (client
->iso_context
->type
== FW_ISO_CONTEXT_RECEIVE
) {
986 if (request
->tags
== 0 || request
->tags
> 15)
989 if (request
->sync
> 15)
993 return fw_iso_context_start(client
->iso_context
, request
->cycle
,
994 request
->sync
, request
->tags
);
997 static int ioctl_stop_iso(struct client
*client
, void *buffer
)
999 struct fw_cdev_stop_iso
*request
= buffer
;
1001 if (client
->iso_context
== NULL
|| request
->handle
!= 0)
1004 return fw_iso_context_stop(client
->iso_context
);
1007 static int ioctl_get_cycle_timer(struct client
*client
, void *buffer
)
1009 struct fw_cdev_get_cycle_timer
*request
= buffer
;
1010 struct fw_card
*card
= client
->device
->card
;
1011 unsigned long long bus_time
;
1013 unsigned long flags
;
1016 local_irq_save(flags
);
1018 bus_time
= card
->driver
->get_bus_time(card
);
1019 do_gettimeofday(&tv
);
1021 local_irq_restore(flags
);
1024 request
->local_time
= tv
.tv_sec
* 1000000ULL + tv
.tv_usec
;
1025 request
->cycle_timer
= bus_time
& 0xffffffff;
1029 static void iso_resource_work(struct work_struct
*work
)
1031 struct iso_resource_event
*e
;
1032 struct iso_resource
*r
=
1033 container_of(work
, struct iso_resource
, work
.work
);
1034 struct client
*client
= r
->client
;
1035 int generation
, channel
, bandwidth
, todo
;
1036 bool skip
, free
, success
;
1038 spin_lock_irq(&client
->lock
);
1039 generation
= client
->device
->generation
;
1041 /* Allow 1000ms grace period for other reallocations. */
1042 if (todo
== ISO_RES_ALLOC
&&
1043 time_is_after_jiffies(client
->device
->card
->reset_jiffies
+ HZ
)) {
1044 schedule_iso_resource(r
, DIV_ROUND_UP(HZ
, 3));
1047 /* We could be called twice within the same generation. */
1048 skip
= todo
== ISO_RES_REALLOC
&&
1049 r
->generation
== generation
;
1051 free
= todo
== ISO_RES_DEALLOC
||
1052 todo
== ISO_RES_ALLOC_ONCE
||
1053 todo
== ISO_RES_DEALLOC_ONCE
;
1054 r
->generation
= generation
;
1055 spin_unlock_irq(&client
->lock
);
1060 bandwidth
= r
->bandwidth
;
1062 fw_iso_resource_manage(client
->device
->card
, generation
,
1063 r
->channels
, &channel
, &bandwidth
,
1064 todo
== ISO_RES_ALLOC
||
1065 todo
== ISO_RES_REALLOC
||
1066 todo
== ISO_RES_ALLOC_ONCE
,
1067 r
->transaction_data
);
1069 * Is this generation outdated already? As long as this resource sticks
1070 * in the idr, it will be scheduled again for a newer generation or at
1073 if (channel
== -EAGAIN
&&
1074 (todo
== ISO_RES_ALLOC
|| todo
== ISO_RES_REALLOC
))
1077 success
= channel
>= 0 || bandwidth
> 0;
1079 spin_lock_irq(&client
->lock
);
1081 * Transit from allocation to reallocation, except if the client
1082 * requested deallocation in the meantime.
1084 if (r
->todo
== ISO_RES_ALLOC
)
1085 r
->todo
= ISO_RES_REALLOC
;
1087 * Allocation or reallocation failure? Pull this resource out of the
1088 * idr and prepare for deletion, unless the client is shutting down.
1090 if (r
->todo
== ISO_RES_REALLOC
&& !success
&&
1091 !client
->in_shutdown
&&
1092 idr_find(&client
->resource_idr
, r
->resource
.handle
)) {
1093 idr_remove(&client
->resource_idr
, r
->resource
.handle
);
1097 spin_unlock_irq(&client
->lock
);
1099 if (todo
== ISO_RES_ALLOC
&& channel
>= 0)
1100 r
->channels
= 1ULL << channel
;
1102 if (todo
== ISO_RES_REALLOC
&& success
)
1105 if (todo
== ISO_RES_ALLOC
|| todo
== ISO_RES_ALLOC_ONCE
) {
1110 r
->e_dealloc
= NULL
;
1112 e
->iso_resource
.handle
= r
->resource
.handle
;
1113 e
->iso_resource
.channel
= channel
;
1114 e
->iso_resource
.bandwidth
= bandwidth
;
1116 queue_event(client
, &e
->event
,
1117 &e
->iso_resource
, sizeof(e
->iso_resource
), NULL
, 0);
1120 cancel_delayed_work(&r
->work
);
1122 kfree(r
->e_dealloc
);
1129 static void release_iso_resource(struct client
*client
,
1130 struct client_resource
*resource
)
1132 struct iso_resource
*r
=
1133 container_of(resource
, struct iso_resource
, resource
);
1135 spin_lock_irq(&client
->lock
);
1136 r
->todo
= ISO_RES_DEALLOC
;
1137 schedule_iso_resource(r
, 0);
1138 spin_unlock_irq(&client
->lock
);
1141 static int init_iso_resource(struct client
*client
,
1142 struct fw_cdev_allocate_iso_resource
*request
, int todo
)
1144 struct iso_resource_event
*e1
, *e2
;
1145 struct iso_resource
*r
;
1148 if ((request
->channels
== 0 && request
->bandwidth
== 0) ||
1149 request
->bandwidth
> BANDWIDTH_AVAILABLE_INITIAL
||
1150 request
->bandwidth
< 0)
1153 r
= kmalloc(sizeof(*r
), GFP_KERNEL
);
1154 e1
= kmalloc(sizeof(*e1
), GFP_KERNEL
);
1155 e2
= kmalloc(sizeof(*e2
), GFP_KERNEL
);
1156 if (r
== NULL
|| e1
== NULL
|| e2
== NULL
) {
1161 INIT_DELAYED_WORK(&r
->work
, iso_resource_work
);
1165 r
->channels
= request
->channels
;
1166 r
->bandwidth
= request
->bandwidth
;
1170 e1
->iso_resource
.closure
= request
->closure
;
1171 e1
->iso_resource
.type
= FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED
;
1172 e2
->iso_resource
.closure
= request
->closure
;
1173 e2
->iso_resource
.type
= FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED
;
1175 if (todo
== ISO_RES_ALLOC
) {
1176 r
->resource
.release
= release_iso_resource
;
1177 ret
= add_client_resource(client
, &r
->resource
, GFP_KERNEL
);
1181 r
->resource
.release
= NULL
;
1182 r
->resource
.handle
= -1;
1183 schedule_iso_resource(r
, 0);
1185 request
->handle
= r
->resource
.handle
;
1196 static int ioctl_allocate_iso_resource(struct client
*client
, void *buffer
)
1198 struct fw_cdev_allocate_iso_resource
*request
= buffer
;
1200 return init_iso_resource(client
, request
, ISO_RES_ALLOC
);
1203 static int ioctl_deallocate_iso_resource(struct client
*client
, void *buffer
)
1205 struct fw_cdev_deallocate
*request
= buffer
;
1207 return release_client_resource(client
, request
->handle
,
1208 release_iso_resource
, NULL
);
1211 static int ioctl_allocate_iso_resource_once(struct client
*client
, void *buffer
)
1213 struct fw_cdev_allocate_iso_resource
*request
= buffer
;
1215 return init_iso_resource(client
, request
, ISO_RES_ALLOC_ONCE
);
1218 static int ioctl_deallocate_iso_resource_once(struct client
*client
, void *buffer
)
1220 struct fw_cdev_allocate_iso_resource
*request
= buffer
;
1222 return init_iso_resource(client
, request
, ISO_RES_DEALLOC_ONCE
);
1226 * Returns a speed code: Maximum speed to or from this device,
1227 * limited by the device's link speed, the local node's link speed,
1228 * and all PHY port speeds between the two links.
1230 static int ioctl_get_speed(struct client
*client
, void *buffer
)
1232 return client
->device
->max_speed
;
1235 static int ioctl_send_broadcast_request(struct client
*client
, void *buffer
)
1237 struct fw_cdev_send_request
*request
= buffer
;
1239 switch (request
->tcode
) {
1240 case TCODE_WRITE_QUADLET_REQUEST
:
1241 case TCODE_WRITE_BLOCK_REQUEST
:
1247 /* Security policy: Only allow accesses to Units Space. */
1248 if (request
->offset
< CSR_REGISTER_BASE
+ CSR_CONFIG_ROM_END
)
1251 return init_request(client
, request
, LOCAL_BUS
| 0x3f, SCODE_100
);
1254 static int ioctl_send_stream_packet(struct client
*client
, void *buffer
)
1256 struct fw_cdev_send_stream_packet
*p
= buffer
;
1257 struct fw_cdev_send_request request
;
1260 if (p
->speed
> client
->device
->card
->link_speed
||
1261 p
->length
> 1024 << p
->speed
)
1264 if (p
->tag
> 3 || p
->channel
> 63 || p
->sy
> 15)
1267 dest
= fw_stream_packet_destination_id(p
->tag
, p
->channel
, p
->sy
);
1268 request
.tcode
= TCODE_STREAM_DATA
;
1269 request
.length
= p
->length
;
1270 request
.closure
= p
->closure
;
1271 request
.data
= p
->data
;
1272 request
.generation
= p
->generation
;
1274 return init_request(client
, &request
, dest
, p
->speed
);
1277 static int (* const ioctl_handlers
[])(struct client
*client
, void *buffer
) = {
1282 ioctl_send_response
,
1283 ioctl_initiate_bus_reset
,
1284 ioctl_add_descriptor
,
1285 ioctl_remove_descriptor
,
1286 ioctl_create_iso_context
,
1290 ioctl_get_cycle_timer
,
1291 ioctl_allocate_iso_resource
,
1292 ioctl_deallocate_iso_resource
,
1293 ioctl_allocate_iso_resource_once
,
1294 ioctl_deallocate_iso_resource_once
,
1296 ioctl_send_broadcast_request
,
1297 ioctl_send_stream_packet
,
1300 static int dispatch_ioctl(struct client
*client
,
1301 unsigned int cmd
, void __user
*arg
)
1303 char buffer
[sizeof(union {
1304 struct fw_cdev_get_info _00
;
1305 struct fw_cdev_send_request _01
;
1306 struct fw_cdev_allocate _02
;
1307 struct fw_cdev_deallocate _03
;
1308 struct fw_cdev_send_response _04
;
1309 struct fw_cdev_initiate_bus_reset _05
;
1310 struct fw_cdev_add_descriptor _06
;
1311 struct fw_cdev_remove_descriptor _07
;
1312 struct fw_cdev_create_iso_context _08
;
1313 struct fw_cdev_queue_iso _09
;
1314 struct fw_cdev_start_iso _0a
;
1315 struct fw_cdev_stop_iso _0b
;
1316 struct fw_cdev_get_cycle_timer _0c
;
1317 struct fw_cdev_allocate_iso_resource _0d
;
1318 struct fw_cdev_send_stream_packet _13
;
1322 if (_IOC_TYPE(cmd
) != '#' ||
1323 _IOC_NR(cmd
) >= ARRAY_SIZE(ioctl_handlers
))
1326 if (_IOC_DIR(cmd
) & _IOC_WRITE
) {
1327 if (_IOC_SIZE(cmd
) > sizeof(buffer
) ||
1328 copy_from_user(buffer
, arg
, _IOC_SIZE(cmd
)))
1332 ret
= ioctl_handlers
[_IOC_NR(cmd
)](client
, buffer
);
1336 if (_IOC_DIR(cmd
) & _IOC_READ
) {
1337 if (_IOC_SIZE(cmd
) > sizeof(buffer
) ||
1338 copy_to_user(arg
, buffer
, _IOC_SIZE(cmd
)))
1345 static long fw_device_op_ioctl(struct file
*file
,
1346 unsigned int cmd
, unsigned long arg
)
1348 struct client
*client
= file
->private_data
;
1350 if (fw_device_is_shutdown(client
->device
))
1353 return dispatch_ioctl(client
, cmd
, (void __user
*) arg
);
1356 #ifdef CONFIG_COMPAT
1357 static long fw_device_op_compat_ioctl(struct file
*file
,
1358 unsigned int cmd
, unsigned long arg
)
1360 struct client
*client
= file
->private_data
;
1362 if (fw_device_is_shutdown(client
->device
))
1365 return dispatch_ioctl(client
, cmd
, compat_ptr(arg
));
1369 static int fw_device_op_mmap(struct file
*file
, struct vm_area_struct
*vma
)
1371 struct client
*client
= file
->private_data
;
1372 enum dma_data_direction direction
;
1374 int page_count
, ret
;
1376 if (fw_device_is_shutdown(client
->device
))
1379 /* FIXME: We could support multiple buffers, but we don't. */
1380 if (client
->buffer
.pages
!= NULL
)
1383 if (!(vma
->vm_flags
& VM_SHARED
))
1386 if (vma
->vm_start
& ~PAGE_MASK
)
1389 client
->vm_start
= vma
->vm_start
;
1390 size
= vma
->vm_end
- vma
->vm_start
;
1391 page_count
= size
>> PAGE_SHIFT
;
1392 if (size
& ~PAGE_MASK
)
1395 if (vma
->vm_flags
& VM_WRITE
)
1396 direction
= DMA_TO_DEVICE
;
1398 direction
= DMA_FROM_DEVICE
;
1400 ret
= fw_iso_buffer_init(&client
->buffer
, client
->device
->card
,
1401 page_count
, direction
);
1405 ret
= fw_iso_buffer_map(&client
->buffer
, vma
);
1407 fw_iso_buffer_destroy(&client
->buffer
, client
->device
->card
);
1412 static int shutdown_resource(int id
, void *p
, void *data
)
1414 struct client_resource
*resource
= p
;
1415 struct client
*client
= data
;
1417 resource
->release(client
, resource
);
1423 static int fw_device_op_release(struct inode
*inode
, struct file
*file
)
1425 struct client
*client
= file
->private_data
;
1426 struct event
*event
, *next_event
;
1428 mutex_lock(&client
->device
->client_list_mutex
);
1429 list_del(&client
->link
);
1430 mutex_unlock(&client
->device
->client_list_mutex
);
1432 if (client
->iso_context
)
1433 fw_iso_context_destroy(client
->iso_context
);
1435 if (client
->buffer
.pages
)
1436 fw_iso_buffer_destroy(&client
->buffer
, client
->device
->card
);
1438 /* Freeze client->resource_idr and client->event_list */
1439 spin_lock_irq(&client
->lock
);
1440 client
->in_shutdown
= true;
1441 spin_unlock_irq(&client
->lock
);
1443 idr_for_each(&client
->resource_idr
, shutdown_resource
, client
);
1444 idr_remove_all(&client
->resource_idr
);
1445 idr_destroy(&client
->resource_idr
);
1447 list_for_each_entry_safe(event
, next_event
, &client
->event_list
, link
)
1455 static unsigned int fw_device_op_poll(struct file
*file
, poll_table
* pt
)
1457 struct client
*client
= file
->private_data
;
1458 unsigned int mask
= 0;
1460 poll_wait(file
, &client
->wait
, pt
);
1462 if (fw_device_is_shutdown(client
->device
))
1463 mask
|= POLLHUP
| POLLERR
;
1464 if (!list_empty(&client
->event_list
))
1465 mask
|= POLLIN
| POLLRDNORM
;
1470 const struct file_operations fw_device_ops
= {
1471 .owner
= THIS_MODULE
,
1472 .open
= fw_device_op_open
,
1473 .read
= fw_device_op_read
,
1474 .unlocked_ioctl
= fw_device_op_ioctl
,
1475 .poll
= fw_device_op_poll
,
1476 .release
= fw_device_op_release
,
1477 .mmap
= fw_device_op_mmap
,
1479 #ifdef CONFIG_COMPAT
1480 .compat_ioctl
= fw_device_op_compat_ioctl
,