Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
firewire-cdev.h
Go to the documentation of this file.
1 /*
2  * Char device interface.
3  *
4  * Copyright (C) 2005-2007 Kristian Hoegsberg <[email protected]>
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice (including the next
14  * paragraph) shall be included in all copies or substantial portions of the
15  * Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
21  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
22  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23  * DEALINGS IN THE SOFTWARE.
24  */
25 
26 #ifndef _LINUX_FIREWIRE_CDEV_H
27 #define _LINUX_FIREWIRE_CDEV_H
28 
29 #include <linux/ioctl.h>
30 #include <linux/types.h>
31 #include <linux/firewire-constants.h>
32 
33 /* available since kernel version 2.6.22 */
34 #define FW_CDEV_EVENT_BUS_RESET 0x00
35 #define FW_CDEV_EVENT_RESPONSE 0x01
36 #define FW_CDEV_EVENT_REQUEST 0x02
37 #define FW_CDEV_EVENT_ISO_INTERRUPT 0x03
38 
39 /* available since kernel version 2.6.30 */
40 #define FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED 0x04
41 #define FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED 0x05
42 
43 /* available since kernel version 2.6.36 */
44 #define FW_CDEV_EVENT_REQUEST2 0x06
45 #define FW_CDEV_EVENT_PHY_PACKET_SENT 0x07
46 #define FW_CDEV_EVENT_PHY_PACKET_RECEIVED 0x08
47 #define FW_CDEV_EVENT_ISO_INTERRUPT_MULTICHANNEL 0x09
48 
61 struct fw_cdev_event_common {
62  __u64 closure;
63  __u32 type;
64 };
65 
85 struct fw_cdev_event_bus_reset {
86  __u64 closure;
87  __u32 type;
88  __u32 node_id;
89  __u32 local_node_id;
90  __u32 bm_node_id;
91  __u32 irm_node_id;
92  __u32 root_node_id;
93  __u32 generation;
94 };
95 
116 struct fw_cdev_event_response {
117  __u64 closure;
118  __u32 type;
119  __u32 rcode;
120  __u32 length;
121  __u32 data[0];
122 };
123 
132 struct fw_cdev_event_request {
133  __u64 closure;
134  __u32 type;
135  __u32 tcode;
136  __u64 offset;
137  __u32 handle;
138  __u32 length;
139  __u32 data[0];
140 };
141 
191 struct fw_cdev_event_request2 {
192  __u64 closure;
193  __u32 type;
194  __u32 tcode;
195  __u64 offset;
196  __u32 source_node_id;
197  __u32 destination_node_id;
198  __u32 card;
199  __u32 generation;
200  __u32 handle;
201  __u32 length;
202  __u32 data[0];
203 };
204 
257 struct fw_cdev_event_iso_interrupt {
258  __u64 closure;
259  __u32 type;
260  __u32 cycle;
261  __u32 header_length;
262  __u32 header[0];
263 };
264 
296 struct fw_cdev_event_iso_interrupt_mc {
297  __u64 closure;
298  __u32 type;
299  __u32 completed;
300 };
301 
323 struct fw_cdev_event_iso_resource {
324  __u64 closure;
325  __u32 type;
326  __u32 handle;
327  __s32 channel;
328  __s32 bandwidth;
329 };
330 
347 struct fw_cdev_event_phy_packet {
348  __u64 closure;
349  __u32 type;
350  __u32 rcode;
351  __u32 length;
352  __u32 data[0];
353 };
354 
380 union fw_cdev_event {
381  struct fw_cdev_event_common common;
382  struct fw_cdev_event_bus_reset bus_reset;
383  struct fw_cdev_event_response response;
384  struct fw_cdev_event_request request;
385  struct fw_cdev_event_request2 request2; /* added in 2.6.36 */
386  struct fw_cdev_event_iso_interrupt iso_interrupt;
387  struct fw_cdev_event_iso_interrupt_mc iso_interrupt_mc; /* added in 2.6.36 */
388  struct fw_cdev_event_iso_resource iso_resource; /* added in 2.6.30 */
389  struct fw_cdev_event_phy_packet phy_packet; /* added in 2.6.36 */
390 };
391 
392 /* available since kernel version 2.6.22 */
393 #define FW_CDEV_IOC_GET_INFO _IOWR('#', 0x00, struct fw_cdev_get_info)
394 #define FW_CDEV_IOC_SEND_REQUEST _IOW('#', 0x01, struct fw_cdev_send_request)
395 #define FW_CDEV_IOC_ALLOCATE _IOWR('#', 0x02, struct fw_cdev_allocate)
396 #define FW_CDEV_IOC_DEALLOCATE _IOW('#', 0x03, struct fw_cdev_deallocate)
397 #define FW_CDEV_IOC_SEND_RESPONSE _IOW('#', 0x04, struct fw_cdev_send_response)
398 #define FW_CDEV_IOC_INITIATE_BUS_RESET _IOW('#', 0x05, struct fw_cdev_initiate_bus_reset)
399 #define FW_CDEV_IOC_ADD_DESCRIPTOR _IOWR('#', 0x06, struct fw_cdev_add_descriptor)
400 #define FW_CDEV_IOC_REMOVE_DESCRIPTOR _IOW('#', 0x07, struct fw_cdev_remove_descriptor)
401 #define FW_CDEV_IOC_CREATE_ISO_CONTEXT _IOWR('#', 0x08, struct fw_cdev_create_iso_context)
402 #define FW_CDEV_IOC_QUEUE_ISO _IOWR('#', 0x09, struct fw_cdev_queue_iso)
403 #define FW_CDEV_IOC_START_ISO _IOW('#', 0x0a, struct fw_cdev_start_iso)
404 #define FW_CDEV_IOC_STOP_ISO _IOW('#', 0x0b, struct fw_cdev_stop_iso)
405 
406 /* available since kernel version 2.6.24 */
407 #define FW_CDEV_IOC_GET_CYCLE_TIMER _IOR('#', 0x0c, struct fw_cdev_get_cycle_timer)
408 
409 /* available since kernel version 2.6.30 */
410 #define FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE _IOWR('#', 0x0d, struct fw_cdev_allocate_iso_resource)
411 #define FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE _IOW('#', 0x0e, struct fw_cdev_deallocate)
412 #define FW_CDEV_IOC_ALLOCATE_ISO_RESOURCE_ONCE _IOW('#', 0x0f, struct fw_cdev_allocate_iso_resource)
413 #define FW_CDEV_IOC_DEALLOCATE_ISO_RESOURCE_ONCE _IOW('#', 0x10, struct fw_cdev_allocate_iso_resource)
414 #define FW_CDEV_IOC_GET_SPEED _IO('#', 0x11) /* returns speed code */
415 #define FW_CDEV_IOC_SEND_BROADCAST_REQUEST _IOW('#', 0x12, struct fw_cdev_send_request)
416 #define FW_CDEV_IOC_SEND_STREAM_PACKET _IOW('#', 0x13, struct fw_cdev_send_stream_packet)
417 
418 /* available since kernel version 2.6.34 */
419 #define FW_CDEV_IOC_GET_CYCLE_TIMER2 _IOWR('#', 0x14, struct fw_cdev_get_cycle_timer2)
420 
421 /* available since kernel version 2.6.36 */
422 #define FW_CDEV_IOC_SEND_PHY_PACKET _IOWR('#', 0x15, struct fw_cdev_send_phy_packet)
423 #define FW_CDEV_IOC_RECEIVE_PHY_PACKETS _IOW('#', 0x16, struct fw_cdev_receive_phy_packets)
424 #define FW_CDEV_IOC_SET_ISO_CHANNELS _IOW('#', 0x17, struct fw_cdev_set_iso_channels)
425 
426 /* available since kernel version 3.4 */
427 #define FW_CDEV_IOC_FLUSH_ISO _IOW('#', 0x18, struct fw_cdev_flush_iso)
428 
429 /*
430  * ABI version history
431  * 1 (2.6.22) - initial version
432  * (2.6.24) - added %FW_CDEV_IOC_GET_CYCLE_TIMER
433  * 2 (2.6.30) - changed &fw_cdev_event_iso_interrupt.header if
434  * &fw_cdev_create_iso_context.header_size is 8 or more
435  * - added %FW_CDEV_IOC_*_ISO_RESOURCE*,
436  * %FW_CDEV_IOC_GET_SPEED, %FW_CDEV_IOC_SEND_BROADCAST_REQUEST,
437  * %FW_CDEV_IOC_SEND_STREAM_PACKET
438  * (2.6.32) - added time stamp to xmit &fw_cdev_event_iso_interrupt
439  * (2.6.33) - IR has always packet-per-buffer semantics now, not one of
440  * dual-buffer or packet-per-buffer depending on hardware
441  * - shared use and auto-response for FCP registers
442  * 3 (2.6.34) - made &fw_cdev_get_cycle_timer reliable
443  * - added %FW_CDEV_IOC_GET_CYCLE_TIMER2
444  * 4 (2.6.36) - added %FW_CDEV_EVENT_REQUEST2, %FW_CDEV_EVENT_PHY_PACKET_*,
445  * and &fw_cdev_allocate.region_end
446  * - implemented &fw_cdev_event_bus_reset.bm_node_id
447  * - added %FW_CDEV_IOC_SEND_PHY_PACKET, _RECEIVE_PHY_PACKETS
448  * - added %FW_CDEV_EVENT_ISO_INTERRUPT_MULTICHANNEL,
449  * %FW_CDEV_ISO_CONTEXT_RECEIVE_MULTICHANNEL, and
450  * %FW_CDEV_IOC_SET_ISO_CHANNELS
451  * 5 (3.4) - send %FW_CDEV_EVENT_ISO_INTERRUPT events when needed to
452  * avoid dropping data
453  * - added %FW_CDEV_IOC_FLUSH_ISO
454  */
455 
481 struct fw_cdev_get_info {
482  __u32 version;
483  __u32 rom_length;
484  __u64 rom;
485  __u64 bus_reset;
486  __u64 bus_reset_closure;
487  __u32 card;
488 };
489 
505 struct fw_cdev_send_request {
506  __u32 tcode;
507  __u32 length;
508  __u64 offset;
509  __u64 closure;
510  __u64 data;
511  __u32 generation;
512 };
513 
527 struct fw_cdev_send_response {
528  __u32 rcode;
529  __u32 length;
530  __u64 data;
531  __u32 handle;
532 };
533 
571 struct fw_cdev_allocate {
572  __u64 offset;
573  __u64 closure;
574  __u32 length;
575  __u32 handle;
576  __u64 region_end; /* available since kernel version 2.6.36 */
577 };
578 
584 struct fw_cdev_deallocate {
585  __u32 handle;
586 };
587 
588 #define FW_CDEV_LONG_RESET 0
589 #define FW_CDEV_SHORT_RESET 1
590 
604 struct fw_cdev_initiate_bus_reset {
605  __u32 type;
606 };
607 
637 struct fw_cdev_add_descriptor {
638  __u32 immediate;
639  __u32 key;
640  __u64 data;
641  __u32 length;
642  __u32 handle;
643 };
644 
654 struct fw_cdev_remove_descriptor {
655  __u32 handle;
656 };
657 
658 #define FW_CDEV_ISO_CONTEXT_TRANSMIT 0
659 #define FW_CDEV_ISO_CONTEXT_RECEIVE 1
660 #define FW_CDEV_ISO_CONTEXT_RECEIVE_MULTICHANNEL 2 /* added in 2.6.36 */
661 
696 struct fw_cdev_create_iso_context {
697  __u32 type;
698  __u32 header_size;
699  __u32 channel;
700  __u32 speed;
701  __u64 closure;
702  __u32 handle;
703 };
704 
716 struct fw_cdev_set_iso_channels {
717  __u64 channels;
718  __u32 handle;
719 };
720 
721 #define FW_CDEV_ISO_PAYLOAD_LENGTH(v) (v)
722 #define FW_CDEV_ISO_INTERRUPT (1 << 16)
723 #define FW_CDEV_ISO_SKIP (1 << 17)
724 #define FW_CDEV_ISO_SYNC (1 << 17)
725 #define FW_CDEV_ISO_TAG(v) ((v) << 18)
726 #define FW_CDEV_ISO_SY(v) ((v) << 20)
727 #define FW_CDEV_ISO_HEADER_LENGTH(v) ((v) << 24)
728 
798 struct fw_cdev_iso_packet {
799  __u32 control;
800  __u32 header[0];
801 };
802 
824 struct fw_cdev_queue_iso {
825  __u64 packets;
826  __u64 data;
827  __u32 size;
828  __u32 handle;
829 };
830 
831 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG0 1
832 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG1 2
833 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG2 4
834 #define FW_CDEV_ISO_CONTEXT_MATCH_TAG3 8
835 #define FW_CDEV_ISO_CONTEXT_MATCH_ALL_TAGS 15
836 
848 struct fw_cdev_start_iso {
849  __s32 cycle;
850  __u32 sync;
851  __u32 tags;
852  __u32 handle;
853 };
854 
859 struct fw_cdev_stop_iso {
860  __u32 handle;
861 };
862 
878 struct fw_cdev_flush_iso {
879  __u32 handle;
880 };
881 
893 struct fw_cdev_get_cycle_timer {
894  __u64 local_time;
895  __u32 cycle_timer;
896 };
897 
917 struct fw_cdev_get_cycle_timer2 {
918  __s64 tv_sec;
919  __s32 tv_nsec;
920  __s32 clk_id;
921  __u32 cycle_timer;
922 };
923 
968 struct fw_cdev_allocate_iso_resource {
969  __u64 closure;
970  __u64 channels;
971  __u32 bandwidth;
972  __u32 handle;
973 };
974 
991 struct fw_cdev_send_stream_packet {
992  __u32 length;
993  __u32 tag;
994  __u32 channel;
995  __u32 sy;
996  __u64 closure;
997  __u64 data;
998  __u32 generation;
999  __u32 speed;
1000 };
1001 
1018 struct fw_cdev_send_phy_packet {
1019  __u64 closure;
1020  __u32 data[2];
1021  __u32 generation;
1022 };
1023 
1033 struct fw_cdev_receive_phy_packets {
1034  __u64 closure;
1035 };
1036 
1037 #define FW_CDEV_VERSION 3 /* Meaningless legacy macro; don't use it. */
1038 
1039 #endif /* _LINUX_FIREWIRE_CDEV_H */
Generated on Thu Jan 10 2013 14:53:48 for Linux Kernel by   doxygen 1.8.2