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/irqflags.h>
29 #include <linux/jiffies.h>
30 #include <linux/kernel.h>
31 #include <linux/kref.h>
33 #include <linux/module.h>
34 #include <linux/mutex.h>
35 #include <linux/poll.h>
36 #include <linux/sched.h>
37 #include <linux/slab.h>
38 #include <linux/spinlock.h>
39 #include <linux/string.h>
40 #include <linux/time.h>
41 #include <linux/uaccess.h>
42 #include <linux/vmalloc.h>
43 #include <linux/wait.h>
44 #include <linux/workqueue.h>
46 #include <asm/system.h>
52 struct fw_device
*device
;
56 struct idr resource_idr
;
57 struct list_head event_list
;
58 wait_queue_head_t wait
;
59 u64 bus_reset_closure
;
61 struct fw_iso_context
*iso_context
;
63 struct fw_iso_buffer buffer
;
64 unsigned long vm_start
;
66 struct list_head link
;
70 static inline void client_get(struct client
*client
)
72 kref_get(&client
->kref
);
75 static void client_release(struct kref
*kref
)
77 struct client
*client
= container_of(kref
, struct client
, kref
);
79 fw_device_put(client
->device
);
83 static void client_put(struct client
*client
)
85 kref_put(&client
->kref
, client_release
);
88 struct client_resource
;
89 typedef void (*client_resource_release_fn_t
)(struct client
*,
90 struct client_resource
*);
91 struct client_resource
{
92 client_resource_release_fn_t release
;
96 struct address_handler_resource
{
97 struct client_resource resource
;
98 struct fw_address_handler handler
;
100 struct client
*client
;
103 struct outbound_transaction_resource
{
104 struct client_resource resource
;
105 struct fw_transaction transaction
;
108 struct inbound_transaction_resource
{
109 struct client_resource resource
;
110 struct fw_request
*request
;
115 struct descriptor_resource
{
116 struct client_resource resource
;
117 struct fw_descriptor descriptor
;
121 struct iso_resource
{
122 struct client_resource resource
;
123 struct client
*client
;
124 /* Schedule work and access todo only with client->lock held. */
125 struct delayed_work work
;
126 enum {ISO_RES_ALLOC
, ISO_RES_REALLOC
, ISO_RES_DEALLOC
,
127 ISO_RES_ALLOC_ONCE
, ISO_RES_DEALLOC_ONCE
,} todo
;
131 __be32 transaction_data
[2];
132 struct iso_resource_event
*e_alloc
, *e_dealloc
;
135 static void release_iso_resource(struct client
*, struct client_resource
*);
137 static void schedule_iso_resource(struct iso_resource
*r
, unsigned long delay
)
139 client_get(r
->client
);
140 if (!schedule_delayed_work(&r
->work
, delay
))
141 client_put(r
->client
);
144 static void schedule_if_iso_resource(struct client_resource
*resource
)
146 if (resource
->release
== release_iso_resource
)
147 schedule_iso_resource(container_of(resource
,
148 struct iso_resource
, resource
), 0);
152 * dequeue_event() just kfree()'s the event, so the event has to be
153 * the first field in a struct XYZ_event.
156 struct { void *data
; size_t size
; } v
[2];
157 struct list_head link
;
160 struct bus_reset_event
{
162 struct fw_cdev_event_bus_reset reset
;
165 struct outbound_transaction_event
{
167 struct client
*client
;
168 struct outbound_transaction_resource r
;
169 struct fw_cdev_event_response response
;
172 struct inbound_transaction_event
{
174 struct fw_cdev_event_request request
;
177 struct iso_interrupt_event
{
179 struct fw_cdev_event_iso_interrupt interrupt
;
182 struct iso_resource_event
{
184 struct fw_cdev_event_iso_resource iso_resource
;
187 static inline void __user
*u64_to_uptr(__u64 value
)
189 return (void __user
*)(unsigned long)value
;
192 static inline __u64
uptr_to_u64(void __user
*ptr
)
194 return (__u64
)(unsigned long)ptr
;
197 static int fw_device_op_open(struct inode
*inode
, struct file
*file
)
199 struct fw_device
*device
;
200 struct client
*client
;
202 device
= fw_device_get_by_devt(inode
->i_rdev
);
206 if (fw_device_is_shutdown(device
)) {
207 fw_device_put(device
);
211 client
= kzalloc(sizeof(*client
), GFP_KERNEL
);
212 if (client
== NULL
) {
213 fw_device_put(device
);
217 client
->device
= device
;
218 spin_lock_init(&client
->lock
);
219 idr_init(&client
->resource_idr
);
220 INIT_LIST_HEAD(&client
->event_list
);
221 init_waitqueue_head(&client
->wait
);
222 kref_init(&client
->kref
);
224 file
->private_data
= client
;
226 mutex_lock(&device
->client_list_mutex
);
227 list_add_tail(&client
->link
, &device
->client_list
);
228 mutex_unlock(&device
->client_list_mutex
);
233 static void queue_event(struct client
*client
, struct event
*event
,
234 void *data0
, size_t size0
, void *data1
, size_t size1
)
238 event
->v
[0].data
= data0
;
239 event
->v
[0].size
= size0
;
240 event
->v
[1].data
= data1
;
241 event
->v
[1].size
= size1
;
243 spin_lock_irqsave(&client
->lock
, flags
);
244 if (client
->in_shutdown
)
247 list_add_tail(&event
->link
, &client
->event_list
);
248 spin_unlock_irqrestore(&client
->lock
, flags
);
250 wake_up_interruptible(&client
->wait
);
253 static int dequeue_event(struct client
*client
,
254 char __user
*buffer
, size_t count
)
260 ret
= wait_event_interruptible(client
->wait
,
261 !list_empty(&client
->event_list
) ||
262 fw_device_is_shutdown(client
->device
));
266 if (list_empty(&client
->event_list
) &&
267 fw_device_is_shutdown(client
->device
))
270 spin_lock_irq(&client
->lock
);
271 event
= list_first_entry(&client
->event_list
, struct event
, link
);
272 list_del(&event
->link
);
273 spin_unlock_irq(&client
->lock
);
276 for (i
= 0; i
< ARRAY_SIZE(event
->v
) && total
< count
; i
++) {
277 size
= min(event
->v
[i
].size
, count
- total
);
278 if (copy_to_user(buffer
+ total
, event
->v
[i
].data
, size
)) {
292 static ssize_t
fw_device_op_read(struct file
*file
, char __user
*buffer
,
293 size_t count
, loff_t
*offset
)
295 struct client
*client
= file
->private_data
;
297 return dequeue_event(client
, buffer
, count
);
300 static void fill_bus_reset_event(struct fw_cdev_event_bus_reset
*event
,
301 struct client
*client
)
303 struct fw_card
*card
= client
->device
->card
;
305 spin_lock_irq(&card
->lock
);
307 event
->closure
= client
->bus_reset_closure
;
308 event
->type
= FW_CDEV_EVENT_BUS_RESET
;
309 event
->generation
= client
->device
->generation
;
310 event
->node_id
= client
->device
->node_id
;
311 event
->local_node_id
= card
->local_node
->node_id
;
312 event
->bm_node_id
= 0; /* FIXME: We don't track the BM. */
313 event
->irm_node_id
= card
->irm_node
->node_id
;
314 event
->root_node_id
= card
->root_node
->node_id
;
316 spin_unlock_irq(&card
->lock
);
319 static void for_each_client(struct fw_device
*device
,
320 void (*callback
)(struct client
*client
))
324 mutex_lock(&device
->client_list_mutex
);
325 list_for_each_entry(c
, &device
->client_list
, link
)
327 mutex_unlock(&device
->client_list_mutex
);
330 static int schedule_reallocations(int id
, void *p
, void *data
)
332 schedule_if_iso_resource(p
);
337 static void queue_bus_reset_event(struct client
*client
)
339 struct bus_reset_event
*e
;
341 e
= kzalloc(sizeof(*e
), GFP_KERNEL
);
343 fw_notify("Out of memory when allocating bus reset event\n");
347 fill_bus_reset_event(&e
->reset
, client
);
349 queue_event(client
, &e
->event
,
350 &e
->reset
, sizeof(e
->reset
), NULL
, 0);
352 spin_lock_irq(&client
->lock
);
353 idr_for_each(&client
->resource_idr
, schedule_reallocations
, client
);
354 spin_unlock_irq(&client
->lock
);
357 void fw_device_cdev_update(struct fw_device
*device
)
359 for_each_client(device
, queue_bus_reset_event
);
362 static void wake_up_client(struct client
*client
)
364 wake_up_interruptible(&client
->wait
);
367 void fw_device_cdev_remove(struct fw_device
*device
)
369 for_each_client(device
, wake_up_client
);
373 struct fw_cdev_get_info get_info
;
374 struct fw_cdev_send_request send_request
;
375 struct fw_cdev_allocate allocate
;
376 struct fw_cdev_deallocate deallocate
;
377 struct fw_cdev_send_response send_response
;
378 struct fw_cdev_initiate_bus_reset initiate_bus_reset
;
379 struct fw_cdev_add_descriptor add_descriptor
;
380 struct fw_cdev_remove_descriptor remove_descriptor
;
381 struct fw_cdev_create_iso_context create_iso_context
;
382 struct fw_cdev_queue_iso queue_iso
;
383 struct fw_cdev_start_iso start_iso
;
384 struct fw_cdev_stop_iso stop_iso
;
385 struct fw_cdev_get_cycle_timer get_cycle_timer
;
386 struct fw_cdev_allocate_iso_resource allocate_iso_resource
;
387 struct fw_cdev_send_stream_packet send_stream_packet
;
388 struct fw_cdev_get_cycle_timer2 get_cycle_timer2
;
391 static int ioctl_get_info(struct client
*client
, union ioctl_arg
*arg
)
393 struct fw_cdev_get_info
*a
= &arg
->get_info
;
394 struct fw_cdev_event_bus_reset bus_reset
;
395 unsigned long ret
= 0;
397 client
->version
= a
->version
;
398 a
->version
= FW_CDEV_VERSION
;
399 a
->card
= client
->device
->card
->index
;
401 down_read(&fw_device_rwsem
);
404 size_t want
= a
->rom_length
;
405 size_t have
= client
->device
->config_rom_length
* 4;
407 ret
= copy_to_user(u64_to_uptr(a
->rom
),
408 client
->device
->config_rom
, min(want
, have
));
410 a
->rom_length
= client
->device
->config_rom_length
* 4;
412 up_read(&fw_device_rwsem
);
417 client
->bus_reset_closure
= a
->bus_reset_closure
;
418 if (a
->bus_reset
!= 0) {
419 fill_bus_reset_event(&bus_reset
, client
);
420 if (copy_to_user(u64_to_uptr(a
->bus_reset
),
421 &bus_reset
, sizeof(bus_reset
)))
428 static int add_client_resource(struct client
*client
,
429 struct client_resource
*resource
, gfp_t gfp_mask
)
435 if (idr_pre_get(&client
->resource_idr
, gfp_mask
) == 0)
438 spin_lock_irqsave(&client
->lock
, flags
);
439 if (client
->in_shutdown
)
442 ret
= idr_get_new(&client
->resource_idr
, resource
,
446 schedule_if_iso_resource(resource
);
448 spin_unlock_irqrestore(&client
->lock
, flags
);
453 return ret
< 0 ? ret
: 0;
456 static int release_client_resource(struct client
*client
, u32 handle
,
457 client_resource_release_fn_t release
,
458 struct client_resource
**return_resource
)
460 struct client_resource
*resource
;
462 spin_lock_irq(&client
->lock
);
463 if (client
->in_shutdown
)
466 resource
= idr_find(&client
->resource_idr
, handle
);
467 if (resource
&& resource
->release
== release
)
468 idr_remove(&client
->resource_idr
, handle
);
469 spin_unlock_irq(&client
->lock
);
471 if (!(resource
&& resource
->release
== release
))
475 *return_resource
= resource
;
477 resource
->release(client
, resource
);
484 static void release_transaction(struct client
*client
,
485 struct client_resource
*resource
)
487 struct outbound_transaction_resource
*r
= container_of(resource
,
488 struct outbound_transaction_resource
, resource
);
490 fw_cancel_transaction(client
->device
->card
, &r
->transaction
);
493 static void complete_transaction(struct fw_card
*card
, int rcode
,
494 void *payload
, size_t length
, void *data
)
496 struct outbound_transaction_event
*e
= data
;
497 struct fw_cdev_event_response
*rsp
= &e
->response
;
498 struct client
*client
= e
->client
;
501 if (length
< rsp
->length
)
502 rsp
->length
= length
;
503 if (rcode
== RCODE_COMPLETE
)
504 memcpy(rsp
->data
, payload
, rsp
->length
);
506 spin_lock_irqsave(&client
->lock
, flags
);
508 * 1. If called while in shutdown, the idr tree must be left untouched.
509 * The idr handle will be removed and the client reference will be
511 * 2. If the call chain was release_client_resource ->
512 * release_transaction -> complete_transaction (instead of a normal
513 * conclusion of the transaction), i.e. if this resource was already
514 * unregistered from the idr, the client reference will be dropped
515 * by release_client_resource and we must not drop it here.
517 if (!client
->in_shutdown
&&
518 idr_find(&client
->resource_idr
, e
->r
.resource
.handle
)) {
519 idr_remove(&client
->resource_idr
, e
->r
.resource
.handle
);
520 /* Drop the idr's reference */
523 spin_unlock_irqrestore(&client
->lock
, flags
);
525 rsp
->type
= FW_CDEV_EVENT_RESPONSE
;
529 * In the case that sizeof(*rsp) doesn't align with the position of the
530 * data, and the read is short, preserve an extra copy of the data
531 * to stay compatible with a pre-2.6.27 bug. Since the bug is harmless
532 * for short reads and some apps depended on it, this is both safe
533 * and prudent for compatibility.
535 if (rsp
->length
<= sizeof(*rsp
) - offsetof(typeof(*rsp
), data
))
536 queue_event(client
, &e
->event
, rsp
, sizeof(*rsp
),
537 rsp
->data
, rsp
->length
);
539 queue_event(client
, &e
->event
, rsp
, sizeof(*rsp
) + rsp
->length
,
542 /* Drop the transaction callback's reference */
546 static int init_request(struct client
*client
,
547 struct fw_cdev_send_request
*request
,
548 int destination_id
, int speed
)
550 struct outbound_transaction_event
*e
;
553 if (request
->tcode
!= TCODE_STREAM_DATA
&&
554 (request
->length
> 4096 || request
->length
> 512 << speed
))
557 e
= kmalloc(sizeof(*e
) + request
->length
, GFP_KERNEL
);
562 e
->response
.length
= request
->length
;
563 e
->response
.closure
= request
->closure
;
566 copy_from_user(e
->response
.data
,
567 u64_to_uptr(request
->data
), request
->length
)) {
572 e
->r
.resource
.release
= release_transaction
;
573 ret
= add_client_resource(client
, &e
->r
.resource
, GFP_KERNEL
);
577 /* Get a reference for the transaction callback */
580 fw_send_request(client
->device
->card
, &e
->r
.transaction
,
581 request
->tcode
, destination_id
, request
->generation
,
582 speed
, request
->offset
, e
->response
.data
,
583 request
->length
, complete_transaction
, e
);
592 static int ioctl_send_request(struct client
*client
, union ioctl_arg
*arg
)
594 switch (arg
->send_request
.tcode
) {
595 case TCODE_WRITE_QUADLET_REQUEST
:
596 case TCODE_WRITE_BLOCK_REQUEST
:
597 case TCODE_READ_QUADLET_REQUEST
:
598 case TCODE_READ_BLOCK_REQUEST
:
599 case TCODE_LOCK_MASK_SWAP
:
600 case TCODE_LOCK_COMPARE_SWAP
:
601 case TCODE_LOCK_FETCH_ADD
:
602 case TCODE_LOCK_LITTLE_ADD
:
603 case TCODE_LOCK_BOUNDED_ADD
:
604 case TCODE_LOCK_WRAP_ADD
:
605 case TCODE_LOCK_VENDOR_DEPENDENT
:
611 return init_request(client
, &arg
->send_request
, client
->device
->node_id
,
612 client
->device
->max_speed
);
615 static inline bool is_fcp_request(struct fw_request
*request
)
617 return request
== NULL
;
620 static void release_request(struct client
*client
,
621 struct client_resource
*resource
)
623 struct inbound_transaction_resource
*r
= container_of(resource
,
624 struct inbound_transaction_resource
, resource
);
626 if (is_fcp_request(r
->request
))
629 fw_send_response(client
->device
->card
, r
->request
,
630 RCODE_CONFLICT_ERROR
);
634 static void handle_request(struct fw_card
*card
, struct fw_request
*request
,
635 int tcode
, int destination
, int source
,
636 int generation
, int speed
,
637 unsigned long long offset
,
638 void *payload
, size_t length
, void *callback_data
)
640 struct address_handler_resource
*handler
= callback_data
;
641 struct inbound_transaction_resource
*r
;
642 struct inbound_transaction_event
*e
;
643 void *fcp_frame
= NULL
;
646 r
= kmalloc(sizeof(*r
), GFP_ATOMIC
);
647 e
= kmalloc(sizeof(*e
), GFP_ATOMIC
);
648 if (r
== NULL
|| e
== NULL
)
651 r
->request
= request
;
655 if (is_fcp_request(request
)) {
657 * FIXME: Let core-transaction.c manage a
658 * single reference-counted copy?
660 fcp_frame
= kmemdup(payload
, length
, GFP_ATOMIC
);
661 if (fcp_frame
== NULL
)
667 r
->resource
.release
= release_request
;
668 ret
= add_client_resource(handler
->client
, &r
->resource
, GFP_ATOMIC
);
672 e
->request
.type
= FW_CDEV_EVENT_REQUEST
;
673 e
->request
.tcode
= tcode
;
674 e
->request
.offset
= offset
;
675 e
->request
.length
= length
;
676 e
->request
.handle
= r
->resource
.handle
;
677 e
->request
.closure
= handler
->closure
;
679 queue_event(handler
->client
, &e
->event
,
680 &e
->request
, sizeof(e
->request
), r
->data
, length
);
688 if (!is_fcp_request(request
))
689 fw_send_response(card
, request
, RCODE_CONFLICT_ERROR
);
692 static void release_address_handler(struct client
*client
,
693 struct client_resource
*resource
)
695 struct address_handler_resource
*r
=
696 container_of(resource
, struct address_handler_resource
, resource
);
698 fw_core_remove_address_handler(&r
->handler
);
702 static int ioctl_allocate(struct client
*client
, union ioctl_arg
*arg
)
704 struct fw_cdev_allocate
*a
= &arg
->allocate
;
705 struct address_handler_resource
*r
;
706 struct fw_address_region region
;
709 r
= kmalloc(sizeof(*r
), GFP_KERNEL
);
713 region
.start
= a
->offset
;
714 region
.end
= a
->offset
+ a
->length
;
715 r
->handler
.length
= a
->length
;
716 r
->handler
.address_callback
= handle_request
;
717 r
->handler
.callback_data
= r
;
718 r
->closure
= a
->closure
;
721 ret
= fw_core_add_address_handler(&r
->handler
, ®ion
);
727 r
->resource
.release
= release_address_handler
;
728 ret
= add_client_resource(client
, &r
->resource
, GFP_KERNEL
);
730 release_address_handler(client
, &r
->resource
);
733 a
->handle
= r
->resource
.handle
;
738 static int ioctl_deallocate(struct client
*client
, union ioctl_arg
*arg
)
740 return release_client_resource(client
, arg
->deallocate
.handle
,
741 release_address_handler
, NULL
);
744 static int ioctl_send_response(struct client
*client
, union ioctl_arg
*arg
)
746 struct fw_cdev_send_response
*a
= &arg
->send_response
;
747 struct client_resource
*resource
;
748 struct inbound_transaction_resource
*r
;
751 if (release_client_resource(client
, a
->handle
,
752 release_request
, &resource
) < 0)
755 r
= container_of(resource
, struct inbound_transaction_resource
,
757 if (is_fcp_request(r
->request
))
760 if (a
->length
< r
->length
)
761 r
->length
= a
->length
;
762 if (copy_from_user(r
->data
, u64_to_uptr(a
->data
), r
->length
)) {
767 fw_send_response(client
->device
->card
, r
->request
, a
->rcode
);
774 static int ioctl_initiate_bus_reset(struct client
*client
, union ioctl_arg
*arg
)
776 return fw_core_initiate_bus_reset(client
->device
->card
,
777 arg
->initiate_bus_reset
.type
== FW_CDEV_SHORT_RESET
);
780 static void release_descriptor(struct client
*client
,
781 struct client_resource
*resource
)
783 struct descriptor_resource
*r
=
784 container_of(resource
, struct descriptor_resource
, resource
);
786 fw_core_remove_descriptor(&r
->descriptor
);
790 static int ioctl_add_descriptor(struct client
*client
, union ioctl_arg
*arg
)
792 struct fw_cdev_add_descriptor
*a
= &arg
->add_descriptor
;
793 struct descriptor_resource
*r
;
796 /* Access policy: Allow this ioctl only on local nodes' device files. */
797 if (!client
->device
->is_local
)
803 r
= kmalloc(sizeof(*r
) + a
->length
* 4, GFP_KERNEL
);
807 if (copy_from_user(r
->data
, u64_to_uptr(a
->data
), a
->length
* 4)) {
812 r
->descriptor
.length
= a
->length
;
813 r
->descriptor
.immediate
= a
->immediate
;
814 r
->descriptor
.key
= a
->key
;
815 r
->descriptor
.data
= r
->data
;
817 ret
= fw_core_add_descriptor(&r
->descriptor
);
821 r
->resource
.release
= release_descriptor
;
822 ret
= add_client_resource(client
, &r
->resource
, GFP_KERNEL
);
824 fw_core_remove_descriptor(&r
->descriptor
);
827 a
->handle
= r
->resource
.handle
;
836 static int ioctl_remove_descriptor(struct client
*client
, union ioctl_arg
*arg
)
838 return release_client_resource(client
, arg
->remove_descriptor
.handle
,
839 release_descriptor
, NULL
);
842 static void iso_callback(struct fw_iso_context
*context
, u32 cycle
,
843 size_t header_length
, void *header
, void *data
)
845 struct client
*client
= data
;
846 struct iso_interrupt_event
*e
;
848 e
= kzalloc(sizeof(*e
) + header_length
, GFP_ATOMIC
);
852 e
->interrupt
.type
= FW_CDEV_EVENT_ISO_INTERRUPT
;
853 e
->interrupt
.closure
= client
->iso_closure
;
854 e
->interrupt
.cycle
= cycle
;
855 e
->interrupt
.header_length
= header_length
;
856 memcpy(e
->interrupt
.header
, header
, header_length
);
857 queue_event(client
, &e
->event
, &e
->interrupt
,
858 sizeof(e
->interrupt
) + header_length
, NULL
, 0);
861 static int ioctl_create_iso_context(struct client
*client
, union ioctl_arg
*arg
)
863 struct fw_cdev_create_iso_context
*a
= &arg
->create_iso_context
;
864 struct fw_iso_context
*context
;
866 /* We only support one context at this time. */
867 if (client
->iso_context
!= NULL
)
874 case FW_ISO_CONTEXT_RECEIVE
:
875 if (a
->header_size
< 4 || (a
->header_size
& 3))
879 case FW_ISO_CONTEXT_TRANSMIT
:
880 if (a
->speed
> SCODE_3200
)
888 context
= fw_iso_context_create(client
->device
->card
, a
->type
,
889 a
->channel
, a
->speed
, a
->header_size
,
890 iso_callback
, client
);
892 return PTR_ERR(context
);
894 client
->iso_closure
= a
->closure
;
895 client
->iso_context
= context
;
897 /* We only support one context at this time. */
903 /* Macros for decoding the iso packet control header. */
904 #define GET_PAYLOAD_LENGTH(v) ((v) & 0xffff)
905 #define GET_INTERRUPT(v) (((v) >> 16) & 0x01)
906 #define GET_SKIP(v) (((v) >> 17) & 0x01)
907 #define GET_TAG(v) (((v) >> 18) & 0x03)
908 #define GET_SY(v) (((v) >> 20) & 0x0f)
909 #define GET_HEADER_LENGTH(v) (((v) >> 24) & 0xff)
911 static int ioctl_queue_iso(struct client
*client
, union ioctl_arg
*arg
)
913 struct fw_cdev_queue_iso
*a
= &arg
->queue_iso
;
914 struct fw_cdev_iso_packet __user
*p
, *end
, *next
;
915 struct fw_iso_context
*ctx
= client
->iso_context
;
916 unsigned long payload
, buffer_end
, header_length
;
920 struct fw_iso_packet packet
;
924 if (ctx
== NULL
|| a
->handle
!= 0)
928 * If the user passes a non-NULL data pointer, has mmap()'ed
929 * the iso buffer, and the pointer points inside the buffer,
930 * we setup the payload pointers accordingly. Otherwise we
931 * set them both to 0, which will still let packets with
932 * payload_length == 0 through. In other words, if no packets
933 * use the indirect payload, the iso buffer need not be mapped
934 * and the a->data pointer is ignored.
937 payload
= (unsigned long)a
->data
- client
->vm_start
;
938 buffer_end
= client
->buffer
.page_count
<< PAGE_SHIFT
;
939 if (a
->data
== 0 || client
->buffer
.pages
== NULL
||
940 payload
>= buffer_end
) {
945 p
= (struct fw_cdev_iso_packet __user
*)u64_to_uptr(a
->packets
);
947 if (!access_ok(VERIFY_READ
, p
, a
->size
))
950 end
= (void __user
*)p
+ a
->size
;
953 if (get_user(control
, &p
->control
))
955 u
.packet
.payload_length
= GET_PAYLOAD_LENGTH(control
);
956 u
.packet
.interrupt
= GET_INTERRUPT(control
);
957 u
.packet
.skip
= GET_SKIP(control
);
958 u
.packet
.tag
= GET_TAG(control
);
959 u
.packet
.sy
= GET_SY(control
);
960 u
.packet
.header_length
= GET_HEADER_LENGTH(control
);
962 if (ctx
->type
== FW_ISO_CONTEXT_TRANSMIT
) {
963 header_length
= u
.packet
.header_length
;
966 * We require that header_length is a multiple of
967 * the fixed header size, ctx->header_size.
969 if (ctx
->header_size
== 0) {
970 if (u
.packet
.header_length
> 0)
972 } else if (u
.packet
.header_length
% ctx
->header_size
!= 0) {
978 next
= (struct fw_cdev_iso_packet __user
*)
979 &p
->header
[header_length
/ 4];
983 (u
.packet
.header
, p
->header
, header_length
))
985 if (u
.packet
.skip
&& ctx
->type
== FW_ISO_CONTEXT_TRANSMIT
&&
986 u
.packet
.header_length
+ u
.packet
.payload_length
> 0)
988 if (payload
+ u
.packet
.payload_length
> buffer_end
)
991 if (fw_iso_context_queue(ctx
, &u
.packet
,
992 &client
->buffer
, payload
))
996 payload
+= u
.packet
.payload_length
;
1000 a
->size
-= uptr_to_u64(p
) - a
->packets
;
1001 a
->packets
= uptr_to_u64(p
);
1002 a
->data
= client
->vm_start
+ payload
;
1007 static int ioctl_start_iso(struct client
*client
, union ioctl_arg
*arg
)
1009 struct fw_cdev_start_iso
*a
= &arg
->start_iso
;
1011 if (client
->iso_context
== NULL
|| a
->handle
!= 0)
1014 if (client
->iso_context
->type
== FW_ISO_CONTEXT_RECEIVE
&&
1015 (a
->tags
== 0 || a
->tags
> 15 || a
->sync
> 15))
1018 return fw_iso_context_start(client
->iso_context
,
1019 a
->cycle
, a
->sync
, a
->tags
);
1022 static int ioctl_stop_iso(struct client
*client
, union ioctl_arg
*arg
)
1024 struct fw_cdev_stop_iso
*a
= &arg
->stop_iso
;
1026 if (client
->iso_context
== NULL
|| a
->handle
!= 0)
1029 return fw_iso_context_stop(client
->iso_context
);
1032 static int ioctl_get_cycle_timer2(struct client
*client
, union ioctl_arg
*arg
)
1034 struct fw_cdev_get_cycle_timer2
*a
= &arg
->get_cycle_timer2
;
1035 struct fw_card
*card
= client
->device
->card
;
1036 struct timespec ts
= {0, 0};
1040 local_irq_disable();
1042 cycle_time
= card
->driver
->get_cycle_time(card
);
1044 switch (a
->clk_id
) {
1045 case CLOCK_REALTIME
: getnstimeofday(&ts
); break;
1046 case CLOCK_MONOTONIC
: do_posix_clock_monotonic_gettime(&ts
); break;
1047 case CLOCK_MONOTONIC_RAW
: getrawmonotonic(&ts
); break;
1054 a
->tv_sec
= ts
.tv_sec
;
1055 a
->tv_nsec
= ts
.tv_nsec
;
1056 a
->cycle_timer
= cycle_time
;
1061 static int ioctl_get_cycle_timer(struct client
*client
, union ioctl_arg
*arg
)
1063 struct fw_cdev_get_cycle_timer
*a
= &arg
->get_cycle_timer
;
1064 struct fw_cdev_get_cycle_timer2 ct2
;
1066 ct2
.clk_id
= CLOCK_REALTIME
;
1067 ioctl_get_cycle_timer2(client
, (union ioctl_arg
*)&ct2
);
1069 a
->local_time
= ct2
.tv_sec
* USEC_PER_SEC
+ ct2
.tv_nsec
/ NSEC_PER_USEC
;
1070 a
->cycle_timer
= ct2
.cycle_timer
;
1075 static void iso_resource_work(struct work_struct
*work
)
1077 struct iso_resource_event
*e
;
1078 struct iso_resource
*r
=
1079 container_of(work
, struct iso_resource
, work
.work
);
1080 struct client
*client
= r
->client
;
1081 int generation
, channel
, bandwidth
, todo
;
1082 bool skip
, free
, success
;
1084 spin_lock_irq(&client
->lock
);
1085 generation
= client
->device
->generation
;
1087 /* Allow 1000ms grace period for other reallocations. */
1088 if (todo
== ISO_RES_ALLOC
&&
1089 time_is_after_jiffies(client
->device
->card
->reset_jiffies
+ HZ
)) {
1090 schedule_iso_resource(r
, DIV_ROUND_UP(HZ
, 3));
1093 /* We could be called twice within the same generation. */
1094 skip
= todo
== ISO_RES_REALLOC
&&
1095 r
->generation
== generation
;
1097 free
= todo
== ISO_RES_DEALLOC
||
1098 todo
== ISO_RES_ALLOC_ONCE
||
1099 todo
== ISO_RES_DEALLOC_ONCE
;
1100 r
->generation
= generation
;
1101 spin_unlock_irq(&client
->lock
);
1106 bandwidth
= r
->bandwidth
;
1108 fw_iso_resource_manage(client
->device
->card
, generation
,
1109 r
->channels
, &channel
, &bandwidth
,
1110 todo
== ISO_RES_ALLOC
||
1111 todo
== ISO_RES_REALLOC
||
1112 todo
== ISO_RES_ALLOC_ONCE
,
1113 r
->transaction_data
);
1115 * Is this generation outdated already? As long as this resource sticks
1116 * in the idr, it will be scheduled again for a newer generation or at
1119 if (channel
== -EAGAIN
&&
1120 (todo
== ISO_RES_ALLOC
|| todo
== ISO_RES_REALLOC
))
1123 success
= channel
>= 0 || bandwidth
> 0;
1125 spin_lock_irq(&client
->lock
);
1127 * Transit from allocation to reallocation, except if the client
1128 * requested deallocation in the meantime.
1130 if (r
->todo
== ISO_RES_ALLOC
)
1131 r
->todo
= ISO_RES_REALLOC
;
1133 * Allocation or reallocation failure? Pull this resource out of the
1134 * idr and prepare for deletion, unless the client is shutting down.
1136 if (r
->todo
== ISO_RES_REALLOC
&& !success
&&
1137 !client
->in_shutdown
&&
1138 idr_find(&client
->resource_idr
, r
->resource
.handle
)) {
1139 idr_remove(&client
->resource_idr
, r
->resource
.handle
);
1143 spin_unlock_irq(&client
->lock
);
1145 if (todo
== ISO_RES_ALLOC
&& channel
>= 0)
1146 r
->channels
= 1ULL << channel
;
1148 if (todo
== ISO_RES_REALLOC
&& success
)
1151 if (todo
== ISO_RES_ALLOC
|| todo
== ISO_RES_ALLOC_ONCE
) {
1156 r
->e_dealloc
= NULL
;
1158 e
->iso_resource
.handle
= r
->resource
.handle
;
1159 e
->iso_resource
.channel
= channel
;
1160 e
->iso_resource
.bandwidth
= bandwidth
;
1162 queue_event(client
, &e
->event
,
1163 &e
->iso_resource
, sizeof(e
->iso_resource
), NULL
, 0);
1166 cancel_delayed_work(&r
->work
);
1168 kfree(r
->e_dealloc
);
1175 static void release_iso_resource(struct client
*client
,
1176 struct client_resource
*resource
)
1178 struct iso_resource
*r
=
1179 container_of(resource
, struct iso_resource
, resource
);
1181 spin_lock_irq(&client
->lock
);
1182 r
->todo
= ISO_RES_DEALLOC
;
1183 schedule_iso_resource(r
, 0);
1184 spin_unlock_irq(&client
->lock
);
1187 static int init_iso_resource(struct client
*client
,
1188 struct fw_cdev_allocate_iso_resource
*request
, int todo
)
1190 struct iso_resource_event
*e1
, *e2
;
1191 struct iso_resource
*r
;
1194 if ((request
->channels
== 0 && request
->bandwidth
== 0) ||
1195 request
->bandwidth
> BANDWIDTH_AVAILABLE_INITIAL
||
1196 request
->bandwidth
< 0)
1199 r
= kmalloc(sizeof(*r
), GFP_KERNEL
);
1200 e1
= kmalloc(sizeof(*e1
), GFP_KERNEL
);
1201 e2
= kmalloc(sizeof(*e2
), GFP_KERNEL
);
1202 if (r
== NULL
|| e1
== NULL
|| e2
== NULL
) {
1207 INIT_DELAYED_WORK(&r
->work
, iso_resource_work
);
1211 r
->channels
= request
->channels
;
1212 r
->bandwidth
= request
->bandwidth
;
1216 e1
->iso_resource
.closure
= request
->closure
;
1217 e1
->iso_resource
.type
= FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED
;
1218 e2
->iso_resource
.closure
= request
->closure
;
1219 e2
->iso_resource
.type
= FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED
;
1221 if (todo
== ISO_RES_ALLOC
) {
1222 r
->resource
.release
= release_iso_resource
;
1223 ret
= add_client_resource(client
, &r
->resource
, GFP_KERNEL
);
1227 r
->resource
.release
= NULL
;
1228 r
->resource
.handle
= -1;
1229 schedule_iso_resource(r
, 0);
1231 request
->handle
= r
->resource
.handle
;
1242 static int ioctl_allocate_iso_resource(struct client
*client
,
1243 union ioctl_arg
*arg
)
1245 return init_iso_resource(client
,
1246 &arg
->allocate_iso_resource
, ISO_RES_ALLOC
);
1249 static int ioctl_deallocate_iso_resource(struct client
*client
,
1250 union ioctl_arg
*arg
)
1252 return release_client_resource(client
,
1253 arg
->deallocate
.handle
, release_iso_resource
, NULL
);
1256 static int ioctl_allocate_iso_resource_once(struct client
*client
,
1257 union ioctl_arg
*arg
)
1259 return init_iso_resource(client
,
1260 &arg
->allocate_iso_resource
, ISO_RES_ALLOC_ONCE
);
1263 static int ioctl_deallocate_iso_resource_once(struct client
*client
,
1264 union ioctl_arg
*arg
)
1266 return init_iso_resource(client
,
1267 &arg
->allocate_iso_resource
, ISO_RES_DEALLOC_ONCE
);
1271 * Returns a speed code: Maximum speed to or from this device,
1272 * limited by the device's link speed, the local node's link speed,
1273 * and all PHY port speeds between the two links.
1275 static int ioctl_get_speed(struct client
*client
, union ioctl_arg
*arg
)
1277 return client
->device
->max_speed
;
1280 static int ioctl_send_broadcast_request(struct client
*client
,
1281 union ioctl_arg
*arg
)
1283 struct fw_cdev_send_request
*a
= &arg
->send_request
;
1286 case TCODE_WRITE_QUADLET_REQUEST
:
1287 case TCODE_WRITE_BLOCK_REQUEST
:
1293 /* Security policy: Only allow accesses to Units Space. */
1294 if (a
->offset
< CSR_REGISTER_BASE
+ CSR_CONFIG_ROM_END
)
1297 return init_request(client
, a
, LOCAL_BUS
| 0x3f, SCODE_100
);
1300 static int ioctl_send_stream_packet(struct client
*client
, union ioctl_arg
*arg
)
1302 struct fw_cdev_send_stream_packet
*a
= &arg
->send_stream_packet
;
1303 struct fw_cdev_send_request request
;
1306 if (a
->speed
> client
->device
->card
->link_speed
||
1307 a
->length
> 1024 << a
->speed
)
1310 if (a
->tag
> 3 || a
->channel
> 63 || a
->sy
> 15)
1313 dest
= fw_stream_packet_destination_id(a
->tag
, a
->channel
, a
->sy
);
1314 request
.tcode
= TCODE_STREAM_DATA
;
1315 request
.length
= a
->length
;
1316 request
.closure
= a
->closure
;
1317 request
.data
= a
->data
;
1318 request
.generation
= a
->generation
;
1320 return init_request(client
, &request
, dest
, a
->speed
);
1323 static int (* const ioctl_handlers
[])(struct client
*, union ioctl_arg
*) = {
1328 ioctl_send_response
,
1329 ioctl_initiate_bus_reset
,
1330 ioctl_add_descriptor
,
1331 ioctl_remove_descriptor
,
1332 ioctl_create_iso_context
,
1336 ioctl_get_cycle_timer
,
1337 ioctl_allocate_iso_resource
,
1338 ioctl_deallocate_iso_resource
,
1339 ioctl_allocate_iso_resource_once
,
1340 ioctl_deallocate_iso_resource_once
,
1342 ioctl_send_broadcast_request
,
1343 ioctl_send_stream_packet
,
1344 ioctl_get_cycle_timer2
,
1347 static int dispatch_ioctl(struct client
*client
,
1348 unsigned int cmd
, void __user
*arg
)
1350 union ioctl_arg buffer
;
1353 if (fw_device_is_shutdown(client
->device
))
1356 if (_IOC_TYPE(cmd
) != '#' ||
1357 _IOC_NR(cmd
) >= ARRAY_SIZE(ioctl_handlers
))
1360 if (_IOC_DIR(cmd
) & _IOC_WRITE
) {
1361 if (_IOC_SIZE(cmd
) > sizeof(buffer
) ||
1362 copy_from_user(&buffer
, arg
, _IOC_SIZE(cmd
)))
1366 ret
= ioctl_handlers
[_IOC_NR(cmd
)](client
, &buffer
);
1370 if (_IOC_DIR(cmd
) & _IOC_READ
) {
1371 if (_IOC_SIZE(cmd
) > sizeof(buffer
) ||
1372 copy_to_user(arg
, &buffer
, _IOC_SIZE(cmd
)))
1379 static long fw_device_op_ioctl(struct file
*file
,
1380 unsigned int cmd
, unsigned long arg
)
1382 return dispatch_ioctl(file
->private_data
, cmd
, (void __user
*)arg
);
1385 #ifdef CONFIG_COMPAT
1386 static long fw_device_op_compat_ioctl(struct file
*file
,
1387 unsigned int cmd
, unsigned long arg
)
1389 return dispatch_ioctl(file
->private_data
, cmd
, compat_ptr(arg
));
1393 static int fw_device_op_mmap(struct file
*file
, struct vm_area_struct
*vma
)
1395 struct client
*client
= file
->private_data
;
1396 enum dma_data_direction direction
;
1398 int page_count
, ret
;
1400 if (fw_device_is_shutdown(client
->device
))
1403 /* FIXME: We could support multiple buffers, but we don't. */
1404 if (client
->buffer
.pages
!= NULL
)
1407 if (!(vma
->vm_flags
& VM_SHARED
))
1410 if (vma
->vm_start
& ~PAGE_MASK
)
1413 client
->vm_start
= vma
->vm_start
;
1414 size
= vma
->vm_end
- vma
->vm_start
;
1415 page_count
= size
>> PAGE_SHIFT
;
1416 if (size
& ~PAGE_MASK
)
1419 if (vma
->vm_flags
& VM_WRITE
)
1420 direction
= DMA_TO_DEVICE
;
1422 direction
= DMA_FROM_DEVICE
;
1424 ret
= fw_iso_buffer_init(&client
->buffer
, client
->device
->card
,
1425 page_count
, direction
);
1429 ret
= fw_iso_buffer_map(&client
->buffer
, vma
);
1431 fw_iso_buffer_destroy(&client
->buffer
, client
->device
->card
);
1436 static int shutdown_resource(int id
, void *p
, void *data
)
1438 struct client_resource
*resource
= p
;
1439 struct client
*client
= data
;
1441 resource
->release(client
, resource
);
1447 static int fw_device_op_release(struct inode
*inode
, struct file
*file
)
1449 struct client
*client
= file
->private_data
;
1450 struct event
*event
, *next_event
;
1452 mutex_lock(&client
->device
->client_list_mutex
);
1453 list_del(&client
->link
);
1454 mutex_unlock(&client
->device
->client_list_mutex
);
1456 if (client
->iso_context
)
1457 fw_iso_context_destroy(client
->iso_context
);
1459 if (client
->buffer
.pages
)
1460 fw_iso_buffer_destroy(&client
->buffer
, client
->device
->card
);
1462 /* Freeze client->resource_idr and client->event_list */
1463 spin_lock_irq(&client
->lock
);
1464 client
->in_shutdown
= true;
1465 spin_unlock_irq(&client
->lock
);
1467 idr_for_each(&client
->resource_idr
, shutdown_resource
, client
);
1468 idr_remove_all(&client
->resource_idr
);
1469 idr_destroy(&client
->resource_idr
);
1471 list_for_each_entry_safe(event
, next_event
, &client
->event_list
, link
)
1479 static unsigned int fw_device_op_poll(struct file
*file
, poll_table
* pt
)
1481 struct client
*client
= file
->private_data
;
1482 unsigned int mask
= 0;
1484 poll_wait(file
, &client
->wait
, pt
);
1486 if (fw_device_is_shutdown(client
->device
))
1487 mask
|= POLLHUP
| POLLERR
;
1488 if (!list_empty(&client
->event_list
))
1489 mask
|= POLLIN
| POLLRDNORM
;
1494 const struct file_operations fw_device_ops
= {
1495 .owner
= THIS_MODULE
,
1496 .open
= fw_device_op_open
,
1497 .read
= fw_device_op_read
,
1498 .unlocked_ioctl
= fw_device_op_ioctl
,
1499 .poll
= fw_device_op_poll
,
1500 .release
= fw_device_op_release
,
1501 .mmap
= fw_device_op_mmap
,
1503 #ifdef CONFIG_COMPAT
1504 .compat_ioctl
= fw_device_op_compat_ioctl
,