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 __be32 transaction_data
[2];
129 struct iso_resource_event
*e_alloc
, *e_dealloc
;
132 static void release_iso_resource(struct client
*, struct client_resource
*);
134 static void schedule_iso_resource(struct iso_resource
*r
, unsigned long delay
)
136 client_get(r
->client
);
137 if (!schedule_delayed_work(&r
->work
, delay
))
138 client_put(r
->client
);
141 static void schedule_if_iso_resource(struct client_resource
*resource
)
143 if (resource
->release
== release_iso_resource
)
144 schedule_iso_resource(container_of(resource
,
145 struct iso_resource
, resource
), 0);
149 * dequeue_event() just kfree()'s the event, so the event has to be
150 * the first field in a struct XYZ_event.
153 struct { void *data
; size_t size
; } v
[2];
154 struct list_head link
;
157 struct bus_reset_event
{
159 struct fw_cdev_event_bus_reset reset
;
162 struct outbound_transaction_event
{
164 struct client
*client
;
165 struct outbound_transaction_resource r
;
166 struct fw_cdev_event_response response
;
169 struct inbound_transaction_event
{
171 struct fw_cdev_event_request request
;
174 struct iso_interrupt_event
{
176 struct fw_cdev_event_iso_interrupt interrupt
;
179 struct iso_resource_event
{
181 struct fw_cdev_event_iso_resource resource
;
184 static inline void __user
*u64_to_uptr(__u64 value
)
186 return (void __user
*)(unsigned long)value
;
189 static inline __u64
uptr_to_u64(void __user
*ptr
)
191 return (__u64
)(unsigned long)ptr
;
194 static int fw_device_op_open(struct inode
*inode
, struct file
*file
)
196 struct fw_device
*device
;
197 struct client
*client
;
199 device
= fw_device_get_by_devt(inode
->i_rdev
);
203 if (fw_device_is_shutdown(device
)) {
204 fw_device_put(device
);
208 client
= kzalloc(sizeof(*client
), GFP_KERNEL
);
209 if (client
== NULL
) {
210 fw_device_put(device
);
214 client
->device
= device
;
215 spin_lock_init(&client
->lock
);
216 idr_init(&client
->resource_idr
);
217 INIT_LIST_HEAD(&client
->event_list
);
218 init_waitqueue_head(&client
->wait
);
219 kref_init(&client
->kref
);
221 file
->private_data
= client
;
223 mutex_lock(&device
->client_list_mutex
);
224 list_add_tail(&client
->link
, &device
->client_list
);
225 mutex_unlock(&device
->client_list_mutex
);
230 static void queue_event(struct client
*client
, struct event
*event
,
231 void *data0
, size_t size0
, void *data1
, size_t size1
)
235 event
->v
[0].data
= data0
;
236 event
->v
[0].size
= size0
;
237 event
->v
[1].data
= data1
;
238 event
->v
[1].size
= size1
;
240 spin_lock_irqsave(&client
->lock
, flags
);
241 if (client
->in_shutdown
)
244 list_add_tail(&event
->link
, &client
->event_list
);
245 spin_unlock_irqrestore(&client
->lock
, flags
);
247 wake_up_interruptible(&client
->wait
);
250 static int dequeue_event(struct client
*client
,
251 char __user
*buffer
, size_t count
)
257 ret
= wait_event_interruptible(client
->wait
,
258 !list_empty(&client
->event_list
) ||
259 fw_device_is_shutdown(client
->device
));
263 if (list_empty(&client
->event_list
) &&
264 fw_device_is_shutdown(client
->device
))
267 spin_lock_irq(&client
->lock
);
268 event
= list_first_entry(&client
->event_list
, struct event
, link
);
269 list_del(&event
->link
);
270 spin_unlock_irq(&client
->lock
);
273 for (i
= 0; i
< ARRAY_SIZE(event
->v
) && total
< count
; i
++) {
274 size
= min(event
->v
[i
].size
, count
- total
);
275 if (copy_to_user(buffer
+ total
, event
->v
[i
].data
, size
)) {
289 static ssize_t
fw_device_op_read(struct file
*file
, char __user
*buffer
,
290 size_t count
, loff_t
*offset
)
292 struct client
*client
= file
->private_data
;
294 return dequeue_event(client
, buffer
, count
);
297 static void fill_bus_reset_event(struct fw_cdev_event_bus_reset
*event
,
298 struct client
*client
)
300 struct fw_card
*card
= client
->device
->card
;
302 spin_lock_irq(&card
->lock
);
304 event
->closure
= client
->bus_reset_closure
;
305 event
->type
= FW_CDEV_EVENT_BUS_RESET
;
306 event
->generation
= client
->device
->generation
;
307 event
->node_id
= client
->device
->node_id
;
308 event
->local_node_id
= card
->local_node
->node_id
;
309 event
->bm_node_id
= 0; /* FIXME: We don't track the BM. */
310 event
->irm_node_id
= card
->irm_node
->node_id
;
311 event
->root_node_id
= card
->root_node
->node_id
;
313 spin_unlock_irq(&card
->lock
);
316 static void for_each_client(struct fw_device
*device
,
317 void (*callback
)(struct client
*client
))
321 mutex_lock(&device
->client_list_mutex
);
322 list_for_each_entry(c
, &device
->client_list
, link
)
324 mutex_unlock(&device
->client_list_mutex
);
327 static int schedule_reallocations(int id
, void *p
, void *data
)
329 schedule_if_iso_resource(p
);
334 static void queue_bus_reset_event(struct client
*client
)
336 struct bus_reset_event
*e
;
338 e
= kzalloc(sizeof(*e
), GFP_KERNEL
);
340 fw_notify("Out of memory when allocating bus reset event\n");
344 fill_bus_reset_event(&e
->reset
, client
);
346 queue_event(client
, &e
->event
,
347 &e
->reset
, sizeof(e
->reset
), NULL
, 0);
349 spin_lock_irq(&client
->lock
);
350 idr_for_each(&client
->resource_idr
, schedule_reallocations
, client
);
351 spin_unlock_irq(&client
->lock
);
354 void fw_device_cdev_update(struct fw_device
*device
)
356 for_each_client(device
, queue_bus_reset_event
);
359 static void wake_up_client(struct client
*client
)
361 wake_up_interruptible(&client
->wait
);
364 void fw_device_cdev_remove(struct fw_device
*device
)
366 for_each_client(device
, wake_up_client
);
369 static int ioctl_get_info(struct client
*client
, void *buffer
)
371 struct fw_cdev_get_info
*get_info
= buffer
;
372 struct fw_cdev_event_bus_reset bus_reset
;
373 unsigned long ret
= 0;
375 client
->version
= get_info
->version
;
376 get_info
->version
= FW_CDEV_VERSION
;
377 get_info
->card
= client
->device
->card
->index
;
379 down_read(&fw_device_rwsem
);
381 if (get_info
->rom
!= 0) {
382 void __user
*uptr
= u64_to_uptr(get_info
->rom
);
383 size_t want
= get_info
->rom_length
;
384 size_t have
= client
->device
->config_rom_length
* 4;
386 ret
= copy_to_user(uptr
, client
->device
->config_rom
,
389 get_info
->rom_length
= client
->device
->config_rom_length
* 4;
391 up_read(&fw_device_rwsem
);
396 client
->bus_reset_closure
= get_info
->bus_reset_closure
;
397 if (get_info
->bus_reset
!= 0) {
398 void __user
*uptr
= u64_to_uptr(get_info
->bus_reset
);
400 fill_bus_reset_event(&bus_reset
, client
);
401 if (copy_to_user(uptr
, &bus_reset
, sizeof(bus_reset
)))
408 static int add_client_resource(struct client
*client
,
409 struct client_resource
*resource
, gfp_t gfp_mask
)
415 if (idr_pre_get(&client
->resource_idr
, gfp_mask
) == 0)
418 spin_lock_irqsave(&client
->lock
, flags
);
419 if (client
->in_shutdown
)
422 ret
= idr_get_new(&client
->resource_idr
, resource
,
426 schedule_if_iso_resource(resource
);
428 spin_unlock_irqrestore(&client
->lock
, flags
);
433 return ret
< 0 ? ret
: 0;
436 static int release_client_resource(struct client
*client
, u32 handle
,
437 client_resource_release_fn_t release
,
438 struct client_resource
**resource
)
440 struct client_resource
*r
;
442 spin_lock_irq(&client
->lock
);
443 if (client
->in_shutdown
)
446 r
= idr_find(&client
->resource_idr
, handle
);
447 if (r
&& r
->release
== release
)
448 idr_remove(&client
->resource_idr
, handle
);
449 spin_unlock_irq(&client
->lock
);
451 if (!(r
&& r
->release
== release
))
457 r
->release(client
, r
);
464 static void release_transaction(struct client
*client
,
465 struct client_resource
*resource
)
467 struct outbound_transaction_resource
*r
= container_of(resource
,
468 struct outbound_transaction_resource
, resource
);
470 fw_cancel_transaction(client
->device
->card
, &r
->transaction
);
473 static void complete_transaction(struct fw_card
*card
, int rcode
,
474 void *payload
, size_t length
, void *data
)
476 struct outbound_transaction_event
*e
= data
;
477 struct fw_cdev_event_response
*rsp
= &e
->response
;
478 struct client
*client
= e
->client
;
481 if (length
< rsp
->length
)
482 rsp
->length
= length
;
483 if (rcode
== RCODE_COMPLETE
)
484 memcpy(rsp
->data
, payload
, rsp
->length
);
486 spin_lock_irqsave(&client
->lock
, flags
);
488 * 1. If called while in shutdown, the idr tree must be left untouched.
489 * The idr handle will be removed and the client reference will be
491 * 2. If the call chain was release_client_resource ->
492 * release_transaction -> complete_transaction (instead of a normal
493 * conclusion of the transaction), i.e. if this resource was already
494 * unregistered from the idr, the client reference will be dropped
495 * by release_client_resource and we must not drop it here.
497 if (!client
->in_shutdown
&&
498 idr_find(&client
->resource_idr
, e
->r
.resource
.handle
)) {
499 idr_remove(&client
->resource_idr
, e
->r
.resource
.handle
);
500 /* Drop the idr's reference */
503 spin_unlock_irqrestore(&client
->lock
, flags
);
505 rsp
->type
= FW_CDEV_EVENT_RESPONSE
;
509 * In the case that sizeof(*rsp) doesn't align with the position of the
510 * data, and the read is short, preserve an extra copy of the data
511 * to stay compatible with a pre-2.6.27 bug. Since the bug is harmless
512 * for short reads and some apps depended on it, this is both safe
513 * and prudent for compatibility.
515 if (rsp
->length
<= sizeof(*rsp
) - offsetof(typeof(*rsp
), data
))
516 queue_event(client
, &e
->event
, rsp
, sizeof(*rsp
),
517 rsp
->data
, rsp
->length
);
519 queue_event(client
, &e
->event
, rsp
, sizeof(*rsp
) + rsp
->length
,
522 /* Drop the transaction callback's reference */
526 static int init_request(struct client
*client
,
527 struct fw_cdev_send_request
*request
,
528 int destination_id
, int speed
)
530 struct outbound_transaction_event
*e
;
533 if (request
->tcode
!= TCODE_STREAM_DATA
&&
534 (request
->length
> 4096 || request
->length
> 512 << speed
))
537 e
= kmalloc(sizeof(*e
) + request
->length
, GFP_KERNEL
);
542 e
->response
.length
= request
->length
;
543 e
->response
.closure
= request
->closure
;
546 copy_from_user(e
->response
.data
,
547 u64_to_uptr(request
->data
), request
->length
)) {
552 e
->r
.resource
.release
= release_transaction
;
553 ret
= add_client_resource(client
, &e
->r
.resource
, GFP_KERNEL
);
557 /* Get a reference for the transaction callback */
560 fw_send_request(client
->device
->card
, &e
->r
.transaction
,
561 request
->tcode
, destination_id
, request
->generation
,
562 speed
, request
->offset
, e
->response
.data
,
563 request
->length
, complete_transaction
, e
);
572 static int ioctl_send_request(struct client
*client
, void *buffer
)
574 struct fw_cdev_send_request
*request
= buffer
;
576 switch (request
->tcode
) {
577 case TCODE_WRITE_QUADLET_REQUEST
:
578 case TCODE_WRITE_BLOCK_REQUEST
:
579 case TCODE_READ_QUADLET_REQUEST
:
580 case TCODE_READ_BLOCK_REQUEST
:
581 case TCODE_LOCK_MASK_SWAP
:
582 case TCODE_LOCK_COMPARE_SWAP
:
583 case TCODE_LOCK_FETCH_ADD
:
584 case TCODE_LOCK_LITTLE_ADD
:
585 case TCODE_LOCK_BOUNDED_ADD
:
586 case TCODE_LOCK_WRAP_ADD
:
587 case TCODE_LOCK_VENDOR_DEPENDENT
:
593 return init_request(client
, request
, client
->device
->node_id
,
594 client
->device
->max_speed
);
597 static void release_request(struct client
*client
,
598 struct client_resource
*resource
)
600 struct inbound_transaction_resource
*r
= container_of(resource
,
601 struct inbound_transaction_resource
, resource
);
603 fw_send_response(client
->device
->card
, r
->request
,
604 RCODE_CONFLICT_ERROR
);
608 static void handle_request(struct fw_card
*card
, struct fw_request
*request
,
609 int tcode
, int destination
, int source
,
610 int generation
, int speed
,
611 unsigned long long offset
,
612 void *payload
, size_t length
, void *callback_data
)
614 struct address_handler_resource
*handler
= callback_data
;
615 struct inbound_transaction_resource
*r
;
616 struct inbound_transaction_event
*e
;
619 r
= kmalloc(sizeof(*r
), GFP_ATOMIC
);
620 e
= kmalloc(sizeof(*e
), GFP_ATOMIC
);
621 if (r
== NULL
|| e
== NULL
)
624 r
->request
= request
;
628 r
->resource
.release
= release_request
;
629 ret
= add_client_resource(handler
->client
, &r
->resource
, GFP_ATOMIC
);
633 e
->request
.type
= FW_CDEV_EVENT_REQUEST
;
634 e
->request
.tcode
= tcode
;
635 e
->request
.offset
= offset
;
636 e
->request
.length
= length
;
637 e
->request
.handle
= r
->resource
.handle
;
638 e
->request
.closure
= handler
->closure
;
640 queue_event(handler
->client
, &e
->event
,
641 &e
->request
, sizeof(e
->request
), payload
, length
);
647 fw_send_response(card
, request
, RCODE_CONFLICT_ERROR
);
650 static void release_address_handler(struct client
*client
,
651 struct client_resource
*resource
)
653 struct address_handler_resource
*r
=
654 container_of(resource
, struct address_handler_resource
, resource
);
656 fw_core_remove_address_handler(&r
->handler
);
660 static int ioctl_allocate(struct client
*client
, void *buffer
)
662 struct fw_cdev_allocate
*request
= buffer
;
663 struct address_handler_resource
*r
;
664 struct fw_address_region region
;
667 r
= kmalloc(sizeof(*r
), GFP_KERNEL
);
671 region
.start
= request
->offset
;
672 region
.end
= request
->offset
+ request
->length
;
673 r
->handler
.length
= request
->length
;
674 r
->handler
.address_callback
= handle_request
;
675 r
->handler
.callback_data
= r
;
676 r
->closure
= request
->closure
;
679 ret
= fw_core_add_address_handler(&r
->handler
, ®ion
);
685 r
->resource
.release
= release_address_handler
;
686 ret
= add_client_resource(client
, &r
->resource
, GFP_KERNEL
);
688 release_address_handler(client
, &r
->resource
);
691 request
->handle
= r
->resource
.handle
;
696 static int ioctl_deallocate(struct client
*client
, void *buffer
)
698 struct fw_cdev_deallocate
*request
= buffer
;
700 return release_client_resource(client
, request
->handle
,
701 release_address_handler
, NULL
);
704 static int ioctl_send_response(struct client
*client
, void *buffer
)
706 struct fw_cdev_send_response
*request
= buffer
;
707 struct client_resource
*resource
;
708 struct inbound_transaction_resource
*r
;
711 if (release_client_resource(client
, request
->handle
,
712 release_request
, &resource
) < 0)
715 r
= container_of(resource
, struct inbound_transaction_resource
,
717 if (request
->length
< r
->length
)
718 r
->length
= request
->length
;
720 if (copy_from_user(r
->data
, u64_to_uptr(request
->data
), r
->length
)) {
725 fw_send_response(client
->device
->card
, r
->request
, request
->rcode
);
732 static int ioctl_initiate_bus_reset(struct client
*client
, void *buffer
)
734 struct fw_cdev_initiate_bus_reset
*request
= buffer
;
737 short_reset
= (request
->type
== FW_CDEV_SHORT_RESET
);
739 return fw_core_initiate_bus_reset(client
->device
->card
, short_reset
);
742 static void release_descriptor(struct client
*client
,
743 struct client_resource
*resource
)
745 struct descriptor_resource
*r
=
746 container_of(resource
, struct descriptor_resource
, resource
);
748 fw_core_remove_descriptor(&r
->descriptor
);
752 static int ioctl_add_descriptor(struct client
*client
, void *buffer
)
754 struct fw_cdev_add_descriptor
*request
= buffer
;
755 struct descriptor_resource
*r
;
758 /* Access policy: Allow this ioctl only on local nodes' device files. */
759 if (!client
->device
->is_local
)
762 if (request
->length
> 256)
765 r
= kmalloc(sizeof(*r
) + request
->length
* 4, GFP_KERNEL
);
769 if (copy_from_user(r
->data
,
770 u64_to_uptr(request
->data
), request
->length
* 4)) {
775 r
->descriptor
.length
= request
->length
;
776 r
->descriptor
.immediate
= request
->immediate
;
777 r
->descriptor
.key
= request
->key
;
778 r
->descriptor
.data
= r
->data
;
780 ret
= fw_core_add_descriptor(&r
->descriptor
);
784 r
->resource
.release
= release_descriptor
;
785 ret
= add_client_resource(client
, &r
->resource
, GFP_KERNEL
);
787 fw_core_remove_descriptor(&r
->descriptor
);
790 request
->handle
= r
->resource
.handle
;
799 static int ioctl_remove_descriptor(struct client
*client
, void *buffer
)
801 struct fw_cdev_remove_descriptor
*request
= buffer
;
803 return release_client_resource(client
, request
->handle
,
804 release_descriptor
, NULL
);
807 static void iso_callback(struct fw_iso_context
*context
, u32 cycle
,
808 size_t header_length
, void *header
, void *data
)
810 struct client
*client
= data
;
811 struct iso_interrupt_event
*e
;
813 e
= kzalloc(sizeof(*e
) + header_length
, GFP_ATOMIC
);
817 e
->interrupt
.type
= FW_CDEV_EVENT_ISO_INTERRUPT
;
818 e
->interrupt
.closure
= client
->iso_closure
;
819 e
->interrupt
.cycle
= cycle
;
820 e
->interrupt
.header_length
= header_length
;
821 memcpy(e
->interrupt
.header
, header
, header_length
);
822 queue_event(client
, &e
->event
, &e
->interrupt
,
823 sizeof(e
->interrupt
) + header_length
, NULL
, 0);
826 static int ioctl_create_iso_context(struct client
*client
, void *buffer
)
828 struct fw_cdev_create_iso_context
*request
= buffer
;
829 struct fw_iso_context
*context
;
831 /* We only support one context at this time. */
832 if (client
->iso_context
!= NULL
)
835 if (request
->channel
> 63)
838 switch (request
->type
) {
839 case FW_ISO_CONTEXT_RECEIVE
:
840 if (request
->header_size
< 4 || (request
->header_size
& 3))
845 case FW_ISO_CONTEXT_TRANSMIT
:
846 if (request
->speed
> SCODE_3200
)
855 context
= fw_iso_context_create(client
->device
->card
,
859 request
->header_size
,
860 iso_callback
, client
);
862 return PTR_ERR(context
);
864 client
->iso_closure
= request
->closure
;
865 client
->iso_context
= context
;
867 /* We only support one context at this time. */
873 /* Macros for decoding the iso packet control header. */
874 #define GET_PAYLOAD_LENGTH(v) ((v) & 0xffff)
875 #define GET_INTERRUPT(v) (((v) >> 16) & 0x01)
876 #define GET_SKIP(v) (((v) >> 17) & 0x01)
877 #define GET_TAG(v) (((v) >> 18) & 0x03)
878 #define GET_SY(v) (((v) >> 20) & 0x0f)
879 #define GET_HEADER_LENGTH(v) (((v) >> 24) & 0xff)
881 static int ioctl_queue_iso(struct client
*client
, void *buffer
)
883 struct fw_cdev_queue_iso
*request
= buffer
;
884 struct fw_cdev_iso_packet __user
*p
, *end
, *next
;
885 struct fw_iso_context
*ctx
= client
->iso_context
;
886 unsigned long payload
, buffer_end
, header_length
;
890 struct fw_iso_packet packet
;
894 if (ctx
== NULL
|| request
->handle
!= 0)
898 * If the user passes a non-NULL data pointer, has mmap()'ed
899 * the iso buffer, and the pointer points inside the buffer,
900 * we setup the payload pointers accordingly. Otherwise we
901 * set them both to 0, which will still let packets with
902 * payload_length == 0 through. In other words, if no packets
903 * use the indirect payload, the iso buffer need not be mapped
904 * and the request->data pointer is ignored.
907 payload
= (unsigned long)request
->data
- client
->vm_start
;
908 buffer_end
= client
->buffer
.page_count
<< PAGE_SHIFT
;
909 if (request
->data
== 0 || client
->buffer
.pages
== NULL
||
910 payload
>= buffer_end
) {
915 p
= (struct fw_cdev_iso_packet __user
*)u64_to_uptr(request
->packets
);
917 if (!access_ok(VERIFY_READ
, p
, request
->size
))
920 end
= (void __user
*)p
+ request
->size
;
923 if (get_user(control
, &p
->control
))
925 u
.packet
.payload_length
= GET_PAYLOAD_LENGTH(control
);
926 u
.packet
.interrupt
= GET_INTERRUPT(control
);
927 u
.packet
.skip
= GET_SKIP(control
);
928 u
.packet
.tag
= GET_TAG(control
);
929 u
.packet
.sy
= GET_SY(control
);
930 u
.packet
.header_length
= GET_HEADER_LENGTH(control
);
932 if (ctx
->type
== FW_ISO_CONTEXT_TRANSMIT
) {
933 header_length
= u
.packet
.header_length
;
936 * We require that header_length is a multiple of
937 * the fixed header size, ctx->header_size.
939 if (ctx
->header_size
== 0) {
940 if (u
.packet
.header_length
> 0)
942 } else if (u
.packet
.header_length
% ctx
->header_size
!= 0) {
948 next
= (struct fw_cdev_iso_packet __user
*)
949 &p
->header
[header_length
/ 4];
953 (u
.packet
.header
, p
->header
, header_length
))
955 if (u
.packet
.skip
&& ctx
->type
== FW_ISO_CONTEXT_TRANSMIT
&&
956 u
.packet
.header_length
+ u
.packet
.payload_length
> 0)
958 if (payload
+ u
.packet
.payload_length
> buffer_end
)
961 if (fw_iso_context_queue(ctx
, &u
.packet
,
962 &client
->buffer
, payload
))
966 payload
+= u
.packet
.payload_length
;
970 request
->size
-= uptr_to_u64(p
) - request
->packets
;
971 request
->packets
= uptr_to_u64(p
);
972 request
->data
= client
->vm_start
+ payload
;
977 static int ioctl_start_iso(struct client
*client
, void *buffer
)
979 struct fw_cdev_start_iso
*request
= buffer
;
981 if (client
->iso_context
== NULL
|| request
->handle
!= 0)
984 if (client
->iso_context
->type
== FW_ISO_CONTEXT_RECEIVE
) {
985 if (request
->tags
== 0 || request
->tags
> 15)
988 if (request
->sync
> 15)
992 return fw_iso_context_start(client
->iso_context
, request
->cycle
,
993 request
->sync
, request
->tags
);
996 static int ioctl_stop_iso(struct client
*client
, void *buffer
)
998 struct fw_cdev_stop_iso
*request
= buffer
;
1000 if (client
->iso_context
== NULL
|| request
->handle
!= 0)
1003 return fw_iso_context_stop(client
->iso_context
);
1006 static int ioctl_get_cycle_timer(struct client
*client
, void *buffer
)
1008 struct fw_cdev_get_cycle_timer
*request
= buffer
;
1009 struct fw_card
*card
= client
->device
->card
;
1010 unsigned long long bus_time
;
1012 unsigned long flags
;
1015 local_irq_save(flags
);
1017 bus_time
= card
->driver
->get_bus_time(card
);
1018 do_gettimeofday(&tv
);
1020 local_irq_restore(flags
);
1023 request
->local_time
= tv
.tv_sec
* 1000000ULL + tv
.tv_usec
;
1024 request
->cycle_timer
= bus_time
& 0xffffffff;
1028 static void iso_resource_work(struct work_struct
*work
)
1030 struct iso_resource_event
*e
;
1031 struct iso_resource
*r
=
1032 container_of(work
, struct iso_resource
, work
.work
);
1033 struct client
*client
= r
->client
;
1034 int generation
, channel
, bandwidth
, todo
;
1035 bool skip
, free
, success
;
1037 spin_lock_irq(&client
->lock
);
1038 generation
= client
->device
->generation
;
1040 /* Allow 1000ms grace period for other reallocations. */
1041 if (todo
== ISO_RES_ALLOC
&&
1042 time_is_after_jiffies(client
->device
->card
->reset_jiffies
+ HZ
)) {
1043 schedule_iso_resource(r
, DIV_ROUND_UP(HZ
, 3));
1046 /* We could be called twice within the same generation. */
1047 skip
= todo
== ISO_RES_REALLOC
&&
1048 r
->generation
== generation
;
1050 free
= todo
== ISO_RES_DEALLOC
||
1051 todo
== ISO_RES_ALLOC_ONCE
||
1052 todo
== ISO_RES_DEALLOC_ONCE
;
1053 r
->generation
= generation
;
1054 spin_unlock_irq(&client
->lock
);
1059 bandwidth
= r
->bandwidth
;
1061 fw_iso_resource_manage(client
->device
->card
, generation
,
1062 r
->channels
, &channel
, &bandwidth
,
1063 todo
== ISO_RES_ALLOC
||
1064 todo
== ISO_RES_REALLOC
||
1065 todo
== ISO_RES_ALLOC_ONCE
,
1066 r
->transaction_data
);
1068 * Is this generation outdated already? As long as this resource sticks
1069 * in the idr, it will be scheduled again for a newer generation or at
1072 if (channel
== -EAGAIN
&&
1073 (todo
== ISO_RES_ALLOC
|| todo
== ISO_RES_REALLOC
))
1076 success
= channel
>= 0 || bandwidth
> 0;
1078 spin_lock_irq(&client
->lock
);
1080 * Transit from allocation to reallocation, except if the client
1081 * requested deallocation in the meantime.
1083 if (r
->todo
== ISO_RES_ALLOC
)
1084 r
->todo
= ISO_RES_REALLOC
;
1086 * Allocation or reallocation failure? Pull this resource out of the
1087 * idr and prepare for deletion, unless the client is shutting down.
1089 if (r
->todo
== ISO_RES_REALLOC
&& !success
&&
1090 !client
->in_shutdown
&&
1091 idr_find(&client
->resource_idr
, r
->resource
.handle
)) {
1092 idr_remove(&client
->resource_idr
, r
->resource
.handle
);
1096 spin_unlock_irq(&client
->lock
);
1098 if (todo
== ISO_RES_ALLOC
&& channel
>= 0)
1099 r
->channels
= 1ULL << channel
;
1101 if (todo
== ISO_RES_REALLOC
&& success
)
1104 if (todo
== ISO_RES_ALLOC
|| todo
== ISO_RES_ALLOC_ONCE
) {
1109 r
->e_dealloc
= NULL
;
1111 e
->resource
.handle
= r
->resource
.handle
;
1112 e
->resource
.channel
= channel
;
1113 e
->resource
.bandwidth
= bandwidth
;
1115 queue_event(client
, &e
->event
,
1116 &e
->resource
, sizeof(e
->resource
), NULL
, 0);
1119 cancel_delayed_work(&r
->work
);
1121 kfree(r
->e_dealloc
);
1128 static void release_iso_resource(struct client
*client
,
1129 struct client_resource
*resource
)
1131 struct iso_resource
*r
=
1132 container_of(resource
, struct iso_resource
, resource
);
1134 spin_lock_irq(&client
->lock
);
1135 r
->todo
= ISO_RES_DEALLOC
;
1136 schedule_iso_resource(r
, 0);
1137 spin_unlock_irq(&client
->lock
);
1140 static int init_iso_resource(struct client
*client
,
1141 struct fw_cdev_allocate_iso_resource
*request
, int todo
)
1143 struct iso_resource_event
*e1
, *e2
;
1144 struct iso_resource
*r
;
1147 if ((request
->channels
== 0 && request
->bandwidth
== 0) ||
1148 request
->bandwidth
> BANDWIDTH_AVAILABLE_INITIAL
||
1149 request
->bandwidth
< 0)
1152 r
= kmalloc(sizeof(*r
), GFP_KERNEL
);
1153 e1
= kmalloc(sizeof(*e1
), GFP_KERNEL
);
1154 e2
= kmalloc(sizeof(*e2
), GFP_KERNEL
);
1155 if (r
== NULL
|| e1
== NULL
|| e2
== NULL
) {
1160 INIT_DELAYED_WORK(&r
->work
, iso_resource_work
);
1164 r
->channels
= request
->channels
;
1165 r
->bandwidth
= request
->bandwidth
;
1169 e1
->resource
.closure
= request
->closure
;
1170 e1
->resource
.type
= FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED
;
1171 e2
->resource
.closure
= request
->closure
;
1172 e2
->resource
.type
= FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED
;
1174 if (todo
== ISO_RES_ALLOC
) {
1175 r
->resource
.release
= release_iso_resource
;
1176 ret
= add_client_resource(client
, &r
->resource
, GFP_KERNEL
);
1180 r
->resource
.release
= NULL
;
1181 r
->resource
.handle
= -1;
1182 schedule_iso_resource(r
, 0);
1184 request
->handle
= r
->resource
.handle
;
1195 static int ioctl_allocate_iso_resource(struct client
*client
, void *buffer
)
1197 struct fw_cdev_allocate_iso_resource
*request
= buffer
;
1199 return init_iso_resource(client
, request
, ISO_RES_ALLOC
);
1202 static int ioctl_deallocate_iso_resource(struct client
*client
, void *buffer
)
1204 struct fw_cdev_deallocate
*request
= buffer
;
1206 return release_client_resource(client
, request
->handle
,
1207 release_iso_resource
, NULL
);
1210 static int ioctl_allocate_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_ALLOC_ONCE
);
1217 static int ioctl_deallocate_iso_resource_once(struct client
*client
, void *buffer
)
1219 struct fw_cdev_allocate_iso_resource
*request
= buffer
;
1221 return init_iso_resource(client
, request
, ISO_RES_DEALLOC_ONCE
);
1225 * Returns a speed code: Maximum speed to or from this device,
1226 * limited by the device's link speed, the local node's link speed,
1227 * and all PHY port speeds between the two links.
1229 static int ioctl_get_speed(struct client
*client
, void *buffer
)
1231 return client
->device
->max_speed
;
1234 static int ioctl_send_broadcast_request(struct client
*client
, void *buffer
)
1236 struct fw_cdev_send_request
*request
= buffer
;
1238 switch (request
->tcode
) {
1239 case TCODE_WRITE_QUADLET_REQUEST
:
1240 case TCODE_WRITE_BLOCK_REQUEST
:
1246 /* Security policy: Only allow accesses to Units Space. */
1247 if (request
->offset
< CSR_REGISTER_BASE
+ CSR_CONFIG_ROM_END
)
1250 return init_request(client
, request
, LOCAL_BUS
| 0x3f, SCODE_100
);
1253 static int ioctl_send_stream_packet(struct client
*client
, void *buffer
)
1255 struct fw_cdev_send_stream_packet
*p
= buffer
;
1256 struct fw_cdev_send_request request
;
1259 if (p
->speed
> client
->device
->card
->link_speed
||
1260 p
->length
> 1024 << p
->speed
)
1263 if (p
->tag
> 3 || p
->channel
> 63 || p
->sy
> 15)
1266 dest
= fw_stream_packet_destination_id(p
->tag
, p
->channel
, p
->sy
);
1267 request
.tcode
= TCODE_STREAM_DATA
;
1268 request
.length
= p
->length
;
1269 request
.closure
= p
->closure
;
1270 request
.data
= p
->data
;
1271 request
.generation
= p
->generation
;
1273 return init_request(client
, &request
, dest
, p
->speed
);
1276 static int (* const ioctl_handlers
[])(struct client
*client
, void *buffer
) = {
1281 ioctl_send_response
,
1282 ioctl_initiate_bus_reset
,
1283 ioctl_add_descriptor
,
1284 ioctl_remove_descriptor
,
1285 ioctl_create_iso_context
,
1289 ioctl_get_cycle_timer
,
1290 ioctl_allocate_iso_resource
,
1291 ioctl_deallocate_iso_resource
,
1292 ioctl_allocate_iso_resource_once
,
1293 ioctl_deallocate_iso_resource_once
,
1295 ioctl_send_broadcast_request
,
1296 ioctl_send_stream_packet
,
1299 static int dispatch_ioctl(struct client
*client
,
1300 unsigned int cmd
, void __user
*arg
)
1305 if (_IOC_TYPE(cmd
) != '#' ||
1306 _IOC_NR(cmd
) >= ARRAY_SIZE(ioctl_handlers
))
1309 if (_IOC_DIR(cmd
) & _IOC_WRITE
) {
1310 if (_IOC_SIZE(cmd
) > sizeof(buffer
) ||
1311 copy_from_user(buffer
, arg
, _IOC_SIZE(cmd
)))
1315 ret
= ioctl_handlers
[_IOC_NR(cmd
)](client
, buffer
);
1319 if (_IOC_DIR(cmd
) & _IOC_READ
) {
1320 if (_IOC_SIZE(cmd
) > sizeof(buffer
) ||
1321 copy_to_user(arg
, buffer
, _IOC_SIZE(cmd
)))
1328 static long fw_device_op_ioctl(struct file
*file
,
1329 unsigned int cmd
, unsigned long arg
)
1331 struct client
*client
= file
->private_data
;
1333 if (fw_device_is_shutdown(client
->device
))
1336 return dispatch_ioctl(client
, cmd
, (void __user
*) arg
);
1339 #ifdef CONFIG_COMPAT
1340 static long fw_device_op_compat_ioctl(struct file
*file
,
1341 unsigned int cmd
, unsigned long arg
)
1343 struct client
*client
= file
->private_data
;
1345 if (fw_device_is_shutdown(client
->device
))
1348 return dispatch_ioctl(client
, cmd
, compat_ptr(arg
));
1352 static int fw_device_op_mmap(struct file
*file
, struct vm_area_struct
*vma
)
1354 struct client
*client
= file
->private_data
;
1355 enum dma_data_direction direction
;
1357 int page_count
, ret
;
1359 if (fw_device_is_shutdown(client
->device
))
1362 /* FIXME: We could support multiple buffers, but we don't. */
1363 if (client
->buffer
.pages
!= NULL
)
1366 if (!(vma
->vm_flags
& VM_SHARED
))
1369 if (vma
->vm_start
& ~PAGE_MASK
)
1372 client
->vm_start
= vma
->vm_start
;
1373 size
= vma
->vm_end
- vma
->vm_start
;
1374 page_count
= size
>> PAGE_SHIFT
;
1375 if (size
& ~PAGE_MASK
)
1378 if (vma
->vm_flags
& VM_WRITE
)
1379 direction
= DMA_TO_DEVICE
;
1381 direction
= DMA_FROM_DEVICE
;
1383 ret
= fw_iso_buffer_init(&client
->buffer
, client
->device
->card
,
1384 page_count
, direction
);
1388 ret
= fw_iso_buffer_map(&client
->buffer
, vma
);
1390 fw_iso_buffer_destroy(&client
->buffer
, client
->device
->card
);
1395 static int shutdown_resource(int id
, void *p
, void *data
)
1397 struct client_resource
*r
= p
;
1398 struct client
*client
= data
;
1400 r
->release(client
, r
);
1406 static int fw_device_op_release(struct inode
*inode
, struct file
*file
)
1408 struct client
*client
= file
->private_data
;
1409 struct event
*e
, *next_e
;
1411 mutex_lock(&client
->device
->client_list_mutex
);
1412 list_del(&client
->link
);
1413 mutex_unlock(&client
->device
->client_list_mutex
);
1415 if (client
->iso_context
)
1416 fw_iso_context_destroy(client
->iso_context
);
1418 if (client
->buffer
.pages
)
1419 fw_iso_buffer_destroy(&client
->buffer
, client
->device
->card
);
1421 /* Freeze client->resource_idr and client->event_list */
1422 spin_lock_irq(&client
->lock
);
1423 client
->in_shutdown
= true;
1424 spin_unlock_irq(&client
->lock
);
1426 idr_for_each(&client
->resource_idr
, shutdown_resource
, client
);
1427 idr_remove_all(&client
->resource_idr
);
1428 idr_destroy(&client
->resource_idr
);
1430 list_for_each_entry_safe(e
, next_e
, &client
->event_list
, link
)
1438 static unsigned int fw_device_op_poll(struct file
*file
, poll_table
* pt
)
1440 struct client
*client
= file
->private_data
;
1441 unsigned int mask
= 0;
1443 poll_wait(file
, &client
->wait
, pt
);
1445 if (fw_device_is_shutdown(client
->device
))
1446 mask
|= POLLHUP
| POLLERR
;
1447 if (!list_empty(&client
->event_list
))
1448 mask
|= POLLIN
| POLLRDNORM
;
1453 const struct file_operations fw_device_ops
= {
1454 .owner
= THIS_MODULE
,
1455 .open
= fw_device_op_open
,
1456 .read
= fw_device_op_read
,
1457 .unlocked_ioctl
= fw_device_op_ioctl
,
1458 .poll
= fw_device_op_poll
,
1459 .release
= fw_device_op_release
,
1460 .mmap
= fw_device_op_mmap
,
1462 #ifdef CONFIG_COMPAT
1463 .compat_ioctl
= fw_device_op_compat_ioctl
,