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/spinlock.h>
38 #include <linux/string.h>
39 #include <linux/time.h>
40 #include <linux/uaccess.h>
41 #include <linux/vmalloc.h>
42 #include <linux/wait.h>
43 #include <linux/workqueue.h>
45 #include <asm/system.h>
51 struct fw_device
*device
;
55 struct idr resource_idr
;
56 struct list_head event_list
;
57 wait_queue_head_t wait
;
58 u64 bus_reset_closure
;
60 struct fw_iso_context
*iso_context
;
62 struct fw_iso_buffer buffer
;
63 unsigned long vm_start
;
65 struct list_head link
;
69 static inline void client_get(struct client
*client
)
71 kref_get(&client
->kref
);
74 static void client_release(struct kref
*kref
)
76 struct client
*client
= container_of(kref
, struct client
, kref
);
78 fw_device_put(client
->device
);
82 static void client_put(struct client
*client
)
84 kref_put(&client
->kref
, client_release
);
87 struct client_resource
;
88 typedef void (*client_resource_release_fn_t
)(struct client
*,
89 struct client_resource
*);
90 struct client_resource
{
91 client_resource_release_fn_t release
;
95 struct address_handler_resource
{
96 struct client_resource resource
;
97 struct fw_address_handler handler
;
99 struct client
*client
;
102 struct outbound_transaction_resource
{
103 struct client_resource resource
;
104 struct fw_transaction transaction
;
107 struct inbound_transaction_resource
{
108 struct client_resource resource
;
109 struct fw_request
*request
;
114 struct descriptor_resource
{
115 struct client_resource resource
;
116 struct fw_descriptor descriptor
;
120 struct iso_resource
{
121 struct client_resource resource
;
122 struct client
*client
;
123 /* Schedule work and access todo only with client->lock held. */
124 struct delayed_work work
;
125 enum {ISO_RES_ALLOC
, ISO_RES_REALLOC
, ISO_RES_DEALLOC
,
126 ISO_RES_ALLOC_ONCE
, ISO_RES_DEALLOC_ONCE
,} todo
;
130 __be32 transaction_data
[2];
131 struct iso_resource_event
*e_alloc
, *e_dealloc
;
134 static void release_iso_resource(struct client
*, struct client_resource
*);
136 static void schedule_iso_resource(struct iso_resource
*r
, unsigned long delay
)
138 client_get(r
->client
);
139 if (!schedule_delayed_work(&r
->work
, delay
))
140 client_put(r
->client
);
143 static void schedule_if_iso_resource(struct client_resource
*resource
)
145 if (resource
->release
== release_iso_resource
)
146 schedule_iso_resource(container_of(resource
,
147 struct iso_resource
, resource
), 0);
151 * dequeue_event() just kfree()'s the event, so the event has to be
152 * the first field in a struct XYZ_event.
155 struct { void *data
; size_t size
; } v
[2];
156 struct list_head link
;
159 struct bus_reset_event
{
161 struct fw_cdev_event_bus_reset reset
;
164 struct outbound_transaction_event
{
166 struct client
*client
;
167 struct outbound_transaction_resource r
;
168 struct fw_cdev_event_response response
;
171 struct inbound_transaction_event
{
173 struct fw_cdev_event_request request
;
176 struct iso_interrupt_event
{
178 struct fw_cdev_event_iso_interrupt interrupt
;
181 struct iso_resource_event
{
183 struct fw_cdev_event_iso_resource iso_resource
;
186 static inline void __user
*u64_to_uptr(__u64 value
)
188 return (void __user
*)(unsigned long)value
;
191 static inline __u64
uptr_to_u64(void __user
*ptr
)
193 return (__u64
)(unsigned long)ptr
;
196 static int fw_device_op_open(struct inode
*inode
, struct file
*file
)
198 struct fw_device
*device
;
199 struct client
*client
;
201 device
= fw_device_get_by_devt(inode
->i_rdev
);
205 if (fw_device_is_shutdown(device
)) {
206 fw_device_put(device
);
210 client
= kzalloc(sizeof(*client
), GFP_KERNEL
);
211 if (client
== NULL
) {
212 fw_device_put(device
);
216 client
->device
= device
;
217 spin_lock_init(&client
->lock
);
218 idr_init(&client
->resource_idr
);
219 INIT_LIST_HEAD(&client
->event_list
);
220 init_waitqueue_head(&client
->wait
);
221 kref_init(&client
->kref
);
223 file
->private_data
= client
;
225 mutex_lock(&device
->client_list_mutex
);
226 list_add_tail(&client
->link
, &device
->client_list
);
227 mutex_unlock(&device
->client_list_mutex
);
229 return nonseekable_open(inode
, file
);
232 static void queue_event(struct client
*client
, struct event
*event
,
233 void *data0
, size_t size0
, void *data1
, size_t size1
)
237 event
->v
[0].data
= data0
;
238 event
->v
[0].size
= size0
;
239 event
->v
[1].data
= data1
;
240 event
->v
[1].size
= size1
;
242 spin_lock_irqsave(&client
->lock
, flags
);
243 if (client
->in_shutdown
)
246 list_add_tail(&event
->link
, &client
->event_list
);
247 spin_unlock_irqrestore(&client
->lock
, flags
);
249 wake_up_interruptible(&client
->wait
);
252 static int dequeue_event(struct client
*client
,
253 char __user
*buffer
, size_t count
)
259 ret
= wait_event_interruptible(client
->wait
,
260 !list_empty(&client
->event_list
) ||
261 fw_device_is_shutdown(client
->device
));
265 if (list_empty(&client
->event_list
) &&
266 fw_device_is_shutdown(client
->device
))
269 spin_lock_irq(&client
->lock
);
270 event
= list_first_entry(&client
->event_list
, struct event
, link
);
271 list_del(&event
->link
);
272 spin_unlock_irq(&client
->lock
);
275 for (i
= 0; i
< ARRAY_SIZE(event
->v
) && total
< count
; i
++) {
276 size
= min(event
->v
[i
].size
, count
- total
);
277 if (copy_to_user(buffer
+ total
, event
->v
[i
].data
, size
)) {
291 static ssize_t
fw_device_op_read(struct file
*file
, char __user
*buffer
,
292 size_t count
, loff_t
*offset
)
294 struct client
*client
= file
->private_data
;
296 return dequeue_event(client
, buffer
, count
);
299 static void fill_bus_reset_event(struct fw_cdev_event_bus_reset
*event
,
300 struct client
*client
)
302 struct fw_card
*card
= client
->device
->card
;
304 spin_lock_irq(&card
->lock
);
306 event
->closure
= client
->bus_reset_closure
;
307 event
->type
= FW_CDEV_EVENT_BUS_RESET
;
308 event
->generation
= client
->device
->generation
;
309 event
->node_id
= client
->device
->node_id
;
310 event
->local_node_id
= card
->local_node
->node_id
;
311 event
->bm_node_id
= 0; /* FIXME: We don't track the BM. */
312 event
->irm_node_id
= card
->irm_node
->node_id
;
313 event
->root_node_id
= card
->root_node
->node_id
;
315 spin_unlock_irq(&card
->lock
);
318 static void for_each_client(struct fw_device
*device
,
319 void (*callback
)(struct client
*client
))
323 mutex_lock(&device
->client_list_mutex
);
324 list_for_each_entry(c
, &device
->client_list
, link
)
326 mutex_unlock(&device
->client_list_mutex
);
329 static int schedule_reallocations(int id
, void *p
, void *data
)
331 schedule_if_iso_resource(p
);
336 static void queue_bus_reset_event(struct client
*client
)
338 struct bus_reset_event
*e
;
340 e
= kzalloc(sizeof(*e
), GFP_KERNEL
);
342 fw_notify("Out of memory when allocating bus reset event\n");
346 fill_bus_reset_event(&e
->reset
, client
);
348 queue_event(client
, &e
->event
,
349 &e
->reset
, sizeof(e
->reset
), NULL
, 0);
351 spin_lock_irq(&client
->lock
);
352 idr_for_each(&client
->resource_idr
, schedule_reallocations
, client
);
353 spin_unlock_irq(&client
->lock
);
356 void fw_device_cdev_update(struct fw_device
*device
)
358 for_each_client(device
, queue_bus_reset_event
);
361 static void wake_up_client(struct client
*client
)
363 wake_up_interruptible(&client
->wait
);
366 void fw_device_cdev_remove(struct fw_device
*device
)
368 for_each_client(device
, wake_up_client
);
372 struct fw_cdev_get_info get_info
;
373 struct fw_cdev_send_request send_request
;
374 struct fw_cdev_allocate allocate
;
375 struct fw_cdev_deallocate deallocate
;
376 struct fw_cdev_send_response send_response
;
377 struct fw_cdev_initiate_bus_reset initiate_bus_reset
;
378 struct fw_cdev_add_descriptor add_descriptor
;
379 struct fw_cdev_remove_descriptor remove_descriptor
;
380 struct fw_cdev_create_iso_context create_iso_context
;
381 struct fw_cdev_queue_iso queue_iso
;
382 struct fw_cdev_start_iso start_iso
;
383 struct fw_cdev_stop_iso stop_iso
;
384 struct fw_cdev_get_cycle_timer get_cycle_timer
;
385 struct fw_cdev_allocate_iso_resource allocate_iso_resource
;
386 struct fw_cdev_send_stream_packet send_stream_packet
;
387 struct fw_cdev_get_cycle_timer2 get_cycle_timer2
;
390 static int ioctl_get_info(struct client
*client
, union ioctl_arg
*arg
)
392 struct fw_cdev_get_info
*a
= &arg
->get_info
;
393 struct fw_cdev_event_bus_reset bus_reset
;
394 unsigned long ret
= 0;
396 client
->version
= a
->version
;
397 a
->version
= FW_CDEV_VERSION
;
398 a
->card
= client
->device
->card
->index
;
400 down_read(&fw_device_rwsem
);
403 size_t want
= a
->rom_length
;
404 size_t have
= client
->device
->config_rom_length
* 4;
406 ret
= copy_to_user(u64_to_uptr(a
->rom
),
407 client
->device
->config_rom
, min(want
, have
));
409 a
->rom_length
= client
->device
->config_rom_length
* 4;
411 up_read(&fw_device_rwsem
);
416 client
->bus_reset_closure
= a
->bus_reset_closure
;
417 if (a
->bus_reset
!= 0) {
418 fill_bus_reset_event(&bus_reset
, client
);
419 if (copy_to_user(u64_to_uptr(a
->bus_reset
),
420 &bus_reset
, sizeof(bus_reset
)))
427 static int add_client_resource(struct client
*client
,
428 struct client_resource
*resource
, gfp_t gfp_mask
)
434 if (idr_pre_get(&client
->resource_idr
, gfp_mask
) == 0)
437 spin_lock_irqsave(&client
->lock
, flags
);
438 if (client
->in_shutdown
)
441 ret
= idr_get_new(&client
->resource_idr
, resource
,
445 schedule_if_iso_resource(resource
);
447 spin_unlock_irqrestore(&client
->lock
, flags
);
452 return ret
< 0 ? ret
: 0;
455 static int release_client_resource(struct client
*client
, u32 handle
,
456 client_resource_release_fn_t release
,
457 struct client_resource
**return_resource
)
459 struct client_resource
*resource
;
461 spin_lock_irq(&client
->lock
);
462 if (client
->in_shutdown
)
465 resource
= idr_find(&client
->resource_idr
, handle
);
466 if (resource
&& resource
->release
== release
)
467 idr_remove(&client
->resource_idr
, handle
);
468 spin_unlock_irq(&client
->lock
);
470 if (!(resource
&& resource
->release
== release
))
474 *return_resource
= resource
;
476 resource
->release(client
, resource
);
483 static void release_transaction(struct client
*client
,
484 struct client_resource
*resource
)
486 struct outbound_transaction_resource
*r
= container_of(resource
,
487 struct outbound_transaction_resource
, resource
);
489 fw_cancel_transaction(client
->device
->card
, &r
->transaction
);
492 static void complete_transaction(struct fw_card
*card
, int rcode
,
493 void *payload
, size_t length
, void *data
)
495 struct outbound_transaction_event
*e
= data
;
496 struct fw_cdev_event_response
*rsp
= &e
->response
;
497 struct client
*client
= e
->client
;
500 if (length
< rsp
->length
)
501 rsp
->length
= length
;
502 if (rcode
== RCODE_COMPLETE
)
503 memcpy(rsp
->data
, payload
, rsp
->length
);
505 spin_lock_irqsave(&client
->lock
, flags
);
507 * 1. If called while in shutdown, the idr tree must be left untouched.
508 * The idr handle will be removed and the client reference will be
510 * 2. If the call chain was release_client_resource ->
511 * release_transaction -> complete_transaction (instead of a normal
512 * conclusion of the transaction), i.e. if this resource was already
513 * unregistered from the idr, the client reference will be dropped
514 * by release_client_resource and we must not drop it here.
516 if (!client
->in_shutdown
&&
517 idr_find(&client
->resource_idr
, e
->r
.resource
.handle
)) {
518 idr_remove(&client
->resource_idr
, e
->r
.resource
.handle
);
519 /* Drop the idr's reference */
522 spin_unlock_irqrestore(&client
->lock
, flags
);
524 rsp
->type
= FW_CDEV_EVENT_RESPONSE
;
528 * In the case that sizeof(*rsp) doesn't align with the position of the
529 * data, and the read is short, preserve an extra copy of the data
530 * to stay compatible with a pre-2.6.27 bug. Since the bug is harmless
531 * for short reads and some apps depended on it, this is both safe
532 * and prudent for compatibility.
534 if (rsp
->length
<= sizeof(*rsp
) - offsetof(typeof(*rsp
), data
))
535 queue_event(client
, &e
->event
, rsp
, sizeof(*rsp
),
536 rsp
->data
, rsp
->length
);
538 queue_event(client
, &e
->event
, rsp
, sizeof(*rsp
) + rsp
->length
,
541 /* Drop the transaction callback's reference */
545 static int init_request(struct client
*client
,
546 struct fw_cdev_send_request
*request
,
547 int destination_id
, int speed
)
549 struct outbound_transaction_event
*e
;
552 if (request
->tcode
!= TCODE_STREAM_DATA
&&
553 (request
->length
> 4096 || request
->length
> 512 << speed
))
556 e
= kmalloc(sizeof(*e
) + request
->length
, GFP_KERNEL
);
561 e
->response
.length
= request
->length
;
562 e
->response
.closure
= request
->closure
;
565 copy_from_user(e
->response
.data
,
566 u64_to_uptr(request
->data
), request
->length
)) {
571 e
->r
.resource
.release
= release_transaction
;
572 ret
= add_client_resource(client
, &e
->r
.resource
, GFP_KERNEL
);
576 /* Get a reference for the transaction callback */
579 fw_send_request(client
->device
->card
, &e
->r
.transaction
,
580 request
->tcode
, destination_id
, request
->generation
,
581 speed
, request
->offset
, e
->response
.data
,
582 request
->length
, complete_transaction
, e
);
591 static int ioctl_send_request(struct client
*client
, union ioctl_arg
*arg
)
593 switch (arg
->send_request
.tcode
) {
594 case TCODE_WRITE_QUADLET_REQUEST
:
595 case TCODE_WRITE_BLOCK_REQUEST
:
596 case TCODE_READ_QUADLET_REQUEST
:
597 case TCODE_READ_BLOCK_REQUEST
:
598 case TCODE_LOCK_MASK_SWAP
:
599 case TCODE_LOCK_COMPARE_SWAP
:
600 case TCODE_LOCK_FETCH_ADD
:
601 case TCODE_LOCK_LITTLE_ADD
:
602 case TCODE_LOCK_BOUNDED_ADD
:
603 case TCODE_LOCK_WRAP_ADD
:
604 case TCODE_LOCK_VENDOR_DEPENDENT
:
610 return init_request(client
, &arg
->send_request
, client
->device
->node_id
,
611 client
->device
->max_speed
);
614 static inline bool is_fcp_request(struct fw_request
*request
)
616 return request
== NULL
;
619 static void release_request(struct client
*client
,
620 struct client_resource
*resource
)
622 struct inbound_transaction_resource
*r
= container_of(resource
,
623 struct inbound_transaction_resource
, resource
);
625 if (is_fcp_request(r
->request
))
628 fw_send_response(client
->device
->card
, r
->request
,
629 RCODE_CONFLICT_ERROR
);
633 static void handle_request(struct fw_card
*card
, struct fw_request
*request
,
634 int tcode
, int destination
, int source
,
635 int generation
, int speed
,
636 unsigned long long offset
,
637 void *payload
, size_t length
, void *callback_data
)
639 struct address_handler_resource
*handler
= callback_data
;
640 struct inbound_transaction_resource
*r
;
641 struct inbound_transaction_event
*e
;
642 void *fcp_frame
= NULL
;
645 r
= kmalloc(sizeof(*r
), GFP_ATOMIC
);
646 e
= kmalloc(sizeof(*e
), GFP_ATOMIC
);
647 if (r
== NULL
|| e
== NULL
)
650 r
->request
= request
;
654 if (is_fcp_request(request
)) {
656 * FIXME: Let core-transaction.c manage a
657 * single reference-counted copy?
659 fcp_frame
= kmemdup(payload
, length
, GFP_ATOMIC
);
660 if (fcp_frame
== NULL
)
666 r
->resource
.release
= release_request
;
667 ret
= add_client_resource(handler
->client
, &r
->resource
, GFP_ATOMIC
);
671 e
->request
.type
= FW_CDEV_EVENT_REQUEST
;
672 e
->request
.tcode
= tcode
;
673 e
->request
.offset
= offset
;
674 e
->request
.length
= length
;
675 e
->request
.handle
= r
->resource
.handle
;
676 e
->request
.closure
= handler
->closure
;
678 queue_event(handler
->client
, &e
->event
,
679 &e
->request
, sizeof(e
->request
), r
->data
, length
);
687 if (!is_fcp_request(request
))
688 fw_send_response(card
, request
, RCODE_CONFLICT_ERROR
);
691 static void release_address_handler(struct client
*client
,
692 struct client_resource
*resource
)
694 struct address_handler_resource
*r
=
695 container_of(resource
, struct address_handler_resource
, resource
);
697 fw_core_remove_address_handler(&r
->handler
);
701 static int ioctl_allocate(struct client
*client
, union ioctl_arg
*arg
)
703 struct fw_cdev_allocate
*a
= &arg
->allocate
;
704 struct address_handler_resource
*r
;
705 struct fw_address_region region
;
708 r
= kmalloc(sizeof(*r
), GFP_KERNEL
);
712 region
.start
= a
->offset
;
713 region
.end
= a
->offset
+ a
->length
;
714 r
->handler
.length
= a
->length
;
715 r
->handler
.address_callback
= handle_request
;
716 r
->handler
.callback_data
= r
;
717 r
->closure
= a
->closure
;
720 ret
= fw_core_add_address_handler(&r
->handler
, ®ion
);
726 r
->resource
.release
= release_address_handler
;
727 ret
= add_client_resource(client
, &r
->resource
, GFP_KERNEL
);
729 release_address_handler(client
, &r
->resource
);
732 a
->handle
= r
->resource
.handle
;
737 static int ioctl_deallocate(struct client
*client
, union ioctl_arg
*arg
)
739 return release_client_resource(client
, arg
->deallocate
.handle
,
740 release_address_handler
, NULL
);
743 static int ioctl_send_response(struct client
*client
, union ioctl_arg
*arg
)
745 struct fw_cdev_send_response
*a
= &arg
->send_response
;
746 struct client_resource
*resource
;
747 struct inbound_transaction_resource
*r
;
750 if (release_client_resource(client
, a
->handle
,
751 release_request
, &resource
) < 0)
754 r
= container_of(resource
, struct inbound_transaction_resource
,
756 if (is_fcp_request(r
->request
))
759 if (a
->length
!= fw_get_response_length(r
->request
)) {
764 if (copy_from_user(r
->data
, u64_to_uptr(a
->data
), a
->length
)) {
769 fw_send_response(client
->device
->card
, r
->request
, a
->rcode
);
776 static int ioctl_initiate_bus_reset(struct client
*client
, union ioctl_arg
*arg
)
778 return fw_core_initiate_bus_reset(client
->device
->card
,
779 arg
->initiate_bus_reset
.type
== FW_CDEV_SHORT_RESET
);
782 static void release_descriptor(struct client
*client
,
783 struct client_resource
*resource
)
785 struct descriptor_resource
*r
=
786 container_of(resource
, struct descriptor_resource
, resource
);
788 fw_core_remove_descriptor(&r
->descriptor
);
792 static int ioctl_add_descriptor(struct client
*client
, union ioctl_arg
*arg
)
794 struct fw_cdev_add_descriptor
*a
= &arg
->add_descriptor
;
795 struct descriptor_resource
*r
;
798 /* Access policy: Allow this ioctl only on local nodes' device files. */
799 if (!client
->device
->is_local
)
805 r
= kmalloc(sizeof(*r
) + a
->length
* 4, GFP_KERNEL
);
809 if (copy_from_user(r
->data
, u64_to_uptr(a
->data
), a
->length
* 4)) {
814 r
->descriptor
.length
= a
->length
;
815 r
->descriptor
.immediate
= a
->immediate
;
816 r
->descriptor
.key
= a
->key
;
817 r
->descriptor
.data
= r
->data
;
819 ret
= fw_core_add_descriptor(&r
->descriptor
);
823 r
->resource
.release
= release_descriptor
;
824 ret
= add_client_resource(client
, &r
->resource
, GFP_KERNEL
);
826 fw_core_remove_descriptor(&r
->descriptor
);
829 a
->handle
= r
->resource
.handle
;
838 static int ioctl_remove_descriptor(struct client
*client
, union ioctl_arg
*arg
)
840 return release_client_resource(client
, arg
->remove_descriptor
.handle
,
841 release_descriptor
, NULL
);
844 static void iso_callback(struct fw_iso_context
*context
, u32 cycle
,
845 size_t header_length
, void *header
, void *data
)
847 struct client
*client
= data
;
848 struct iso_interrupt_event
*e
;
850 e
= kzalloc(sizeof(*e
) + header_length
, GFP_ATOMIC
);
854 e
->interrupt
.type
= FW_CDEV_EVENT_ISO_INTERRUPT
;
855 e
->interrupt
.closure
= client
->iso_closure
;
856 e
->interrupt
.cycle
= cycle
;
857 e
->interrupt
.header_length
= header_length
;
858 memcpy(e
->interrupt
.header
, header
, header_length
);
859 queue_event(client
, &e
->event
, &e
->interrupt
,
860 sizeof(e
->interrupt
) + header_length
, NULL
, 0);
863 static int ioctl_create_iso_context(struct client
*client
, union ioctl_arg
*arg
)
865 struct fw_cdev_create_iso_context
*a
= &arg
->create_iso_context
;
866 struct fw_iso_context
*context
;
868 /* We only support one context at this time. */
869 if (client
->iso_context
!= NULL
)
876 case FW_ISO_CONTEXT_RECEIVE
:
877 if (a
->header_size
< 4 || (a
->header_size
& 3))
881 case FW_ISO_CONTEXT_TRANSMIT
:
882 if (a
->speed
> SCODE_3200
)
890 context
= fw_iso_context_create(client
->device
->card
, a
->type
,
891 a
->channel
, a
->speed
, a
->header_size
,
892 iso_callback
, client
);
894 return PTR_ERR(context
);
896 client
->iso_closure
= a
->closure
;
897 client
->iso_context
= context
;
899 /* We only support one context at this time. */
905 /* Macros for decoding the iso packet control header. */
906 #define GET_PAYLOAD_LENGTH(v) ((v) & 0xffff)
907 #define GET_INTERRUPT(v) (((v) >> 16) & 0x01)
908 #define GET_SKIP(v) (((v) >> 17) & 0x01)
909 #define GET_TAG(v) (((v) >> 18) & 0x03)
910 #define GET_SY(v) (((v) >> 20) & 0x0f)
911 #define GET_HEADER_LENGTH(v) (((v) >> 24) & 0xff)
913 static int ioctl_queue_iso(struct client
*client
, union ioctl_arg
*arg
)
915 struct fw_cdev_queue_iso
*a
= &arg
->queue_iso
;
916 struct fw_cdev_iso_packet __user
*p
, *end
, *next
;
917 struct fw_iso_context
*ctx
= client
->iso_context
;
918 unsigned long payload
, buffer_end
, header_length
;
922 struct fw_iso_packet packet
;
926 if (ctx
== NULL
|| a
->handle
!= 0)
930 * If the user passes a non-NULL data pointer, has mmap()'ed
931 * the iso buffer, and the pointer points inside the buffer,
932 * we setup the payload pointers accordingly. Otherwise we
933 * set them both to 0, which will still let packets with
934 * payload_length == 0 through. In other words, if no packets
935 * use the indirect payload, the iso buffer need not be mapped
936 * and the a->data pointer is ignored.
939 payload
= (unsigned long)a
->data
- client
->vm_start
;
940 buffer_end
= client
->buffer
.page_count
<< PAGE_SHIFT
;
941 if (a
->data
== 0 || client
->buffer
.pages
== NULL
||
942 payload
>= buffer_end
) {
947 p
= (struct fw_cdev_iso_packet __user
*)u64_to_uptr(a
->packets
);
949 if (!access_ok(VERIFY_READ
, p
, a
->size
))
952 end
= (void __user
*)p
+ a
->size
;
955 if (get_user(control
, &p
->control
))
957 u
.packet
.payload_length
= GET_PAYLOAD_LENGTH(control
);
958 u
.packet
.interrupt
= GET_INTERRUPT(control
);
959 u
.packet
.skip
= GET_SKIP(control
);
960 u
.packet
.tag
= GET_TAG(control
);
961 u
.packet
.sy
= GET_SY(control
);
962 u
.packet
.header_length
= GET_HEADER_LENGTH(control
);
964 if (ctx
->type
== FW_ISO_CONTEXT_TRANSMIT
) {
965 if (u
.packet
.header_length
% 4 != 0)
967 header_length
= u
.packet
.header_length
;
970 * We require that header_length is a multiple of
971 * the fixed header size, ctx->header_size.
973 if (ctx
->header_size
== 0) {
974 if (u
.packet
.header_length
> 0)
976 } else if (u
.packet
.header_length
== 0 ||
977 u
.packet
.header_length
% ctx
->header_size
!= 0) {
983 next
= (struct fw_cdev_iso_packet __user
*)
984 &p
->header
[header_length
/ 4];
988 (u
.packet
.header
, p
->header
, header_length
))
990 if (u
.packet
.skip
&& ctx
->type
== FW_ISO_CONTEXT_TRANSMIT
&&
991 u
.packet
.header_length
+ u
.packet
.payload_length
> 0)
993 if (payload
+ u
.packet
.payload_length
> buffer_end
)
996 if (fw_iso_context_queue(ctx
, &u
.packet
,
997 &client
->buffer
, payload
))
1001 payload
+= u
.packet
.payload_length
;
1005 a
->size
-= uptr_to_u64(p
) - a
->packets
;
1006 a
->packets
= uptr_to_u64(p
);
1007 a
->data
= client
->vm_start
+ payload
;
1012 static int ioctl_start_iso(struct client
*client
, union ioctl_arg
*arg
)
1014 struct fw_cdev_start_iso
*a
= &arg
->start_iso
;
1016 if (client
->iso_context
== NULL
|| a
->handle
!= 0)
1019 if (client
->iso_context
->type
== FW_ISO_CONTEXT_RECEIVE
&&
1020 (a
->tags
== 0 || a
->tags
> 15 || a
->sync
> 15))
1023 return fw_iso_context_start(client
->iso_context
,
1024 a
->cycle
, a
->sync
, a
->tags
);
1027 static int ioctl_stop_iso(struct client
*client
, union ioctl_arg
*arg
)
1029 struct fw_cdev_stop_iso
*a
= &arg
->stop_iso
;
1031 if (client
->iso_context
== NULL
|| a
->handle
!= 0)
1034 return fw_iso_context_stop(client
->iso_context
);
1037 static int ioctl_get_cycle_timer2(struct client
*client
, union ioctl_arg
*arg
)
1039 struct fw_cdev_get_cycle_timer2
*a
= &arg
->get_cycle_timer2
;
1040 struct fw_card
*card
= client
->device
->card
;
1041 struct timespec ts
= {0, 0};
1045 local_irq_disable();
1047 cycle_time
= card
->driver
->read_csr_reg(card
, CSR_CYCLE_TIME
);
1049 switch (a
->clk_id
) {
1050 case CLOCK_REALTIME
: getnstimeofday(&ts
); break;
1051 case CLOCK_MONOTONIC
: do_posix_clock_monotonic_gettime(&ts
); break;
1052 case CLOCK_MONOTONIC_RAW
: getrawmonotonic(&ts
); break;
1059 a
->tv_sec
= ts
.tv_sec
;
1060 a
->tv_nsec
= ts
.tv_nsec
;
1061 a
->cycle_timer
= cycle_time
;
1066 static int ioctl_get_cycle_timer(struct client
*client
, union ioctl_arg
*arg
)
1068 struct fw_cdev_get_cycle_timer
*a
= &arg
->get_cycle_timer
;
1069 struct fw_cdev_get_cycle_timer2 ct2
;
1071 ct2
.clk_id
= CLOCK_REALTIME
;
1072 ioctl_get_cycle_timer2(client
, (union ioctl_arg
*)&ct2
);
1074 a
->local_time
= ct2
.tv_sec
* USEC_PER_SEC
+ ct2
.tv_nsec
/ NSEC_PER_USEC
;
1075 a
->cycle_timer
= ct2
.cycle_timer
;
1080 static void iso_resource_work(struct work_struct
*work
)
1082 struct iso_resource_event
*e
;
1083 struct iso_resource
*r
=
1084 container_of(work
, struct iso_resource
, work
.work
);
1085 struct client
*client
= r
->client
;
1086 int generation
, channel
, bandwidth
, todo
;
1087 bool skip
, free
, success
;
1089 spin_lock_irq(&client
->lock
);
1090 generation
= client
->device
->generation
;
1092 /* Allow 1000ms grace period for other reallocations. */
1093 if (todo
== ISO_RES_ALLOC
&&
1094 time_is_after_jiffies(client
->device
->card
->reset_jiffies
+ HZ
)) {
1095 schedule_iso_resource(r
, DIV_ROUND_UP(HZ
, 3));
1098 /* We could be called twice within the same generation. */
1099 skip
= todo
== ISO_RES_REALLOC
&&
1100 r
->generation
== generation
;
1102 free
= todo
== ISO_RES_DEALLOC
||
1103 todo
== ISO_RES_ALLOC_ONCE
||
1104 todo
== ISO_RES_DEALLOC_ONCE
;
1105 r
->generation
= generation
;
1106 spin_unlock_irq(&client
->lock
);
1111 bandwidth
= r
->bandwidth
;
1113 fw_iso_resource_manage(client
->device
->card
, generation
,
1114 r
->channels
, &channel
, &bandwidth
,
1115 todo
== ISO_RES_ALLOC
||
1116 todo
== ISO_RES_REALLOC
||
1117 todo
== ISO_RES_ALLOC_ONCE
,
1118 r
->transaction_data
);
1120 * Is this generation outdated already? As long as this resource sticks
1121 * in the idr, it will be scheduled again for a newer generation or at
1124 if (channel
== -EAGAIN
&&
1125 (todo
== ISO_RES_ALLOC
|| todo
== ISO_RES_REALLOC
))
1128 success
= channel
>= 0 || bandwidth
> 0;
1130 spin_lock_irq(&client
->lock
);
1132 * Transit from allocation to reallocation, except if the client
1133 * requested deallocation in the meantime.
1135 if (r
->todo
== ISO_RES_ALLOC
)
1136 r
->todo
= ISO_RES_REALLOC
;
1138 * Allocation or reallocation failure? Pull this resource out of the
1139 * idr and prepare for deletion, unless the client is shutting down.
1141 if (r
->todo
== ISO_RES_REALLOC
&& !success
&&
1142 !client
->in_shutdown
&&
1143 idr_find(&client
->resource_idr
, r
->resource
.handle
)) {
1144 idr_remove(&client
->resource_idr
, r
->resource
.handle
);
1148 spin_unlock_irq(&client
->lock
);
1150 if (todo
== ISO_RES_ALLOC
&& channel
>= 0)
1151 r
->channels
= 1ULL << channel
;
1153 if (todo
== ISO_RES_REALLOC
&& success
)
1156 if (todo
== ISO_RES_ALLOC
|| todo
== ISO_RES_ALLOC_ONCE
) {
1161 r
->e_dealloc
= NULL
;
1163 e
->iso_resource
.handle
= r
->resource
.handle
;
1164 e
->iso_resource
.channel
= channel
;
1165 e
->iso_resource
.bandwidth
= bandwidth
;
1167 queue_event(client
, &e
->event
,
1168 &e
->iso_resource
, sizeof(e
->iso_resource
), NULL
, 0);
1171 cancel_delayed_work(&r
->work
);
1173 kfree(r
->e_dealloc
);
1180 static void release_iso_resource(struct client
*client
,
1181 struct client_resource
*resource
)
1183 struct iso_resource
*r
=
1184 container_of(resource
, struct iso_resource
, resource
);
1186 spin_lock_irq(&client
->lock
);
1187 r
->todo
= ISO_RES_DEALLOC
;
1188 schedule_iso_resource(r
, 0);
1189 spin_unlock_irq(&client
->lock
);
1192 static int init_iso_resource(struct client
*client
,
1193 struct fw_cdev_allocate_iso_resource
*request
, int todo
)
1195 struct iso_resource_event
*e1
, *e2
;
1196 struct iso_resource
*r
;
1199 if ((request
->channels
== 0 && request
->bandwidth
== 0) ||
1200 request
->bandwidth
> BANDWIDTH_AVAILABLE_INITIAL
||
1201 request
->bandwidth
< 0)
1204 r
= kmalloc(sizeof(*r
), GFP_KERNEL
);
1205 e1
= kmalloc(sizeof(*e1
), GFP_KERNEL
);
1206 e2
= kmalloc(sizeof(*e2
), GFP_KERNEL
);
1207 if (r
== NULL
|| e1
== NULL
|| e2
== NULL
) {
1212 INIT_DELAYED_WORK(&r
->work
, iso_resource_work
);
1216 r
->channels
= request
->channels
;
1217 r
->bandwidth
= request
->bandwidth
;
1221 e1
->iso_resource
.closure
= request
->closure
;
1222 e1
->iso_resource
.type
= FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED
;
1223 e2
->iso_resource
.closure
= request
->closure
;
1224 e2
->iso_resource
.type
= FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED
;
1226 if (todo
== ISO_RES_ALLOC
) {
1227 r
->resource
.release
= release_iso_resource
;
1228 ret
= add_client_resource(client
, &r
->resource
, GFP_KERNEL
);
1232 r
->resource
.release
= NULL
;
1233 r
->resource
.handle
= -1;
1234 schedule_iso_resource(r
, 0);
1236 request
->handle
= r
->resource
.handle
;
1247 static int ioctl_allocate_iso_resource(struct client
*client
,
1248 union ioctl_arg
*arg
)
1250 return init_iso_resource(client
,
1251 &arg
->allocate_iso_resource
, ISO_RES_ALLOC
);
1254 static int ioctl_deallocate_iso_resource(struct client
*client
,
1255 union ioctl_arg
*arg
)
1257 return release_client_resource(client
,
1258 arg
->deallocate
.handle
, release_iso_resource
, NULL
);
1261 static int ioctl_allocate_iso_resource_once(struct client
*client
,
1262 union ioctl_arg
*arg
)
1264 return init_iso_resource(client
,
1265 &arg
->allocate_iso_resource
, ISO_RES_ALLOC_ONCE
);
1268 static int ioctl_deallocate_iso_resource_once(struct client
*client
,
1269 union ioctl_arg
*arg
)
1271 return init_iso_resource(client
,
1272 &arg
->allocate_iso_resource
, ISO_RES_DEALLOC_ONCE
);
1276 * Returns a speed code: Maximum speed to or from this device,
1277 * limited by the device's link speed, the local node's link speed,
1278 * and all PHY port speeds between the two links.
1280 static int ioctl_get_speed(struct client
*client
, union ioctl_arg
*arg
)
1282 return client
->device
->max_speed
;
1285 static int ioctl_send_broadcast_request(struct client
*client
,
1286 union ioctl_arg
*arg
)
1288 struct fw_cdev_send_request
*a
= &arg
->send_request
;
1291 case TCODE_WRITE_QUADLET_REQUEST
:
1292 case TCODE_WRITE_BLOCK_REQUEST
:
1298 /* Security policy: Only allow accesses to Units Space. */
1299 if (a
->offset
< CSR_REGISTER_BASE
+ CSR_CONFIG_ROM_END
)
1302 return init_request(client
, a
, LOCAL_BUS
| 0x3f, SCODE_100
);
1305 static int ioctl_send_stream_packet(struct client
*client
, union ioctl_arg
*arg
)
1307 struct fw_cdev_send_stream_packet
*a
= &arg
->send_stream_packet
;
1308 struct fw_cdev_send_request request
;
1311 if (a
->speed
> client
->device
->card
->link_speed
||
1312 a
->length
> 1024 << a
->speed
)
1315 if (a
->tag
> 3 || a
->channel
> 63 || a
->sy
> 15)
1318 dest
= fw_stream_packet_destination_id(a
->tag
, a
->channel
, a
->sy
);
1319 request
.tcode
= TCODE_STREAM_DATA
;
1320 request
.length
= a
->length
;
1321 request
.closure
= a
->closure
;
1322 request
.data
= a
->data
;
1323 request
.generation
= a
->generation
;
1325 return init_request(client
, &request
, dest
, a
->speed
);
1328 static int (* const ioctl_handlers
[])(struct client
*, union ioctl_arg
*) = {
1333 ioctl_send_response
,
1334 ioctl_initiate_bus_reset
,
1335 ioctl_add_descriptor
,
1336 ioctl_remove_descriptor
,
1337 ioctl_create_iso_context
,
1341 ioctl_get_cycle_timer
,
1342 ioctl_allocate_iso_resource
,
1343 ioctl_deallocate_iso_resource
,
1344 ioctl_allocate_iso_resource_once
,
1345 ioctl_deallocate_iso_resource_once
,
1347 ioctl_send_broadcast_request
,
1348 ioctl_send_stream_packet
,
1349 ioctl_get_cycle_timer2
,
1352 static int dispatch_ioctl(struct client
*client
,
1353 unsigned int cmd
, void __user
*arg
)
1355 union ioctl_arg buffer
;
1358 if (fw_device_is_shutdown(client
->device
))
1361 if (_IOC_TYPE(cmd
) != '#' ||
1362 _IOC_NR(cmd
) >= ARRAY_SIZE(ioctl_handlers
) ||
1363 _IOC_SIZE(cmd
) > sizeof(buffer
))
1366 if (_IOC_DIR(cmd
) == _IOC_READ
)
1367 memset(&buffer
, 0, _IOC_SIZE(cmd
));
1369 if (_IOC_DIR(cmd
) & _IOC_WRITE
)
1370 if (copy_from_user(&buffer
, arg
, _IOC_SIZE(cmd
)))
1373 ret
= ioctl_handlers
[_IOC_NR(cmd
)](client
, &buffer
);
1377 if (_IOC_DIR(cmd
) & _IOC_READ
)
1378 if (copy_to_user(arg
, &buffer
, _IOC_SIZE(cmd
)))
1384 static long fw_device_op_ioctl(struct file
*file
,
1385 unsigned int cmd
, unsigned long arg
)
1387 return dispatch_ioctl(file
->private_data
, cmd
, (void __user
*)arg
);
1390 #ifdef CONFIG_COMPAT
1391 static long fw_device_op_compat_ioctl(struct file
*file
,
1392 unsigned int cmd
, unsigned long arg
)
1394 return dispatch_ioctl(file
->private_data
, cmd
, compat_ptr(arg
));
1398 static int fw_device_op_mmap(struct file
*file
, struct vm_area_struct
*vma
)
1400 struct client
*client
= file
->private_data
;
1401 enum dma_data_direction direction
;
1403 int page_count
, ret
;
1405 if (fw_device_is_shutdown(client
->device
))
1408 /* FIXME: We could support multiple buffers, but we don't. */
1409 if (client
->buffer
.pages
!= NULL
)
1412 if (!(vma
->vm_flags
& VM_SHARED
))
1415 if (vma
->vm_start
& ~PAGE_MASK
)
1418 client
->vm_start
= vma
->vm_start
;
1419 size
= vma
->vm_end
- vma
->vm_start
;
1420 page_count
= size
>> PAGE_SHIFT
;
1421 if (size
& ~PAGE_MASK
)
1424 if (vma
->vm_flags
& VM_WRITE
)
1425 direction
= DMA_TO_DEVICE
;
1427 direction
= DMA_FROM_DEVICE
;
1429 ret
= fw_iso_buffer_init(&client
->buffer
, client
->device
->card
,
1430 page_count
, direction
);
1434 ret
= fw_iso_buffer_map(&client
->buffer
, vma
);
1436 fw_iso_buffer_destroy(&client
->buffer
, client
->device
->card
);
1441 static int shutdown_resource(int id
, void *p
, void *data
)
1443 struct client_resource
*resource
= p
;
1444 struct client
*client
= data
;
1446 resource
->release(client
, resource
);
1452 static int fw_device_op_release(struct inode
*inode
, struct file
*file
)
1454 struct client
*client
= file
->private_data
;
1455 struct event
*event
, *next_event
;
1457 mutex_lock(&client
->device
->client_list_mutex
);
1458 list_del(&client
->link
);
1459 mutex_unlock(&client
->device
->client_list_mutex
);
1461 if (client
->iso_context
)
1462 fw_iso_context_destroy(client
->iso_context
);
1464 if (client
->buffer
.pages
)
1465 fw_iso_buffer_destroy(&client
->buffer
, client
->device
->card
);
1467 /* Freeze client->resource_idr and client->event_list */
1468 spin_lock_irq(&client
->lock
);
1469 client
->in_shutdown
= true;
1470 spin_unlock_irq(&client
->lock
);
1472 idr_for_each(&client
->resource_idr
, shutdown_resource
, client
);
1473 idr_remove_all(&client
->resource_idr
);
1474 idr_destroy(&client
->resource_idr
);
1476 list_for_each_entry_safe(event
, next_event
, &client
->event_list
, link
)
1484 static unsigned int fw_device_op_poll(struct file
*file
, poll_table
* pt
)
1486 struct client
*client
= file
->private_data
;
1487 unsigned int mask
= 0;
1489 poll_wait(file
, &client
->wait
, pt
);
1491 if (fw_device_is_shutdown(client
->device
))
1492 mask
|= POLLHUP
| POLLERR
;
1493 if (!list_empty(&client
->event_list
))
1494 mask
|= POLLIN
| POLLRDNORM
;
1499 const struct file_operations fw_device_ops
= {
1500 .owner
= THIS_MODULE
,
1501 .llseek
= no_llseek
,
1502 .open
= fw_device_op_open
,
1503 .read
= fw_device_op_read
,
1504 .unlocked_ioctl
= fw_device_op_ioctl
,
1505 .mmap
= fw_device_op_mmap
,
1506 .release
= fw_device_op_release
,
1507 .poll
= fw_device_op_poll
,
1508 #ifdef CONFIG_COMPAT
1509 .compat_ioctl
= fw_device_op_compat_ioctl
,