ieee1394: add comments in struct hpsb_packet
[linux-2.6.git] / drivers / ieee1394 / ieee1394-ioctl.h
1 /*
2  * Base file for all ieee1394 ioctl's.
3  * Linux-1394 has allocated base '#' with a range of 0x00-0x3f.
4  */
5
6 #ifndef __IEEE1394_IOCTL_H
7 #define __IEEE1394_IOCTL_H
8
9 #include <linux/ioctl.h>
10 #include <linux/types.h>
11
12 /* DV1394 Gets 10 */
13
14 /* Get the driver ready to transmit video.  pass a struct dv1394_init* as
15  * the parameter (see below), or NULL to get default parameters */
16 #define DV1394_IOC_INIT                 _IOW('#', 0x06, struct dv1394_init)
17
18 /* Stop transmitting video and free the ringbuffer */
19 #define DV1394_IOC_SHUTDOWN             _IO ('#', 0x07)
20
21 /* Submit N new frames to be transmitted, where the index of the first new
22  * frame is first_clear_buffer, and the index of the last new frame is
23  * (first_clear_buffer + N) % n_frames */
24 #define DV1394_IOC_SUBMIT_FRAMES        _IO ('#', 0x08)
25
26 /* Block until N buffers are clear (pass N as the parameter) Because we
27  * re-transmit the last frame on underrun, there will at most be n_frames
28  * - 1 clear frames at any time */
29 #define DV1394_IOC_WAIT_FRAMES          _IO ('#', 0x09)
30
31 /* Capture new frames that have been received, where the index of the
32  * first new frame is first_clear_buffer, and the index of the last new
33  * frame is (first_clear_buffer + N) % n_frames */
34 #define DV1394_IOC_RECEIVE_FRAMES       _IO ('#', 0x0a)
35
36 /* Tell card to start receiving DMA */
37 #define DV1394_IOC_START_RECEIVE        _IO ('#', 0x0b)
38
39 /* Pass a struct dv1394_status* as the parameter */
40 #define DV1394_IOC_GET_STATUS           _IOR('#', 0x0c, struct dv1394_status)
41
42
43 /* Video1394 Gets 10 */
44
45 #define VIDEO1394_IOC_LISTEN_CHANNEL            \
46         _IOWR('#', 0x10, struct video1394_mmap)
47 #define VIDEO1394_IOC_UNLISTEN_CHANNEL          \
48         _IOW ('#', 0x11, int)
49 #define VIDEO1394_IOC_LISTEN_QUEUE_BUFFER       \
50         _IOW ('#', 0x12, struct video1394_wait)
51 #define VIDEO1394_IOC_LISTEN_WAIT_BUFFER        \
52         _IOWR('#', 0x13, struct video1394_wait)
53 #define VIDEO1394_IOC_TALK_CHANNEL              \
54         _IOWR('#', 0x14, struct video1394_mmap)
55 #define VIDEO1394_IOC_UNTALK_CHANNEL            \
56         _IOW ('#', 0x15, int)
57 /*
58  * This one is broken: it really wanted
59  * "sizeof (struct video1394_wait) + sizeof (struct video1394_queue_variable)"
60  * but got just a "size_t"
61  */
62 #define VIDEO1394_IOC_TALK_QUEUE_BUFFER         \
63         _IOW ('#', 0x16, size_t)
64 #define VIDEO1394_IOC_TALK_WAIT_BUFFER          \
65         _IOW ('#', 0x17, struct video1394_wait)
66 #define VIDEO1394_IOC_LISTEN_POLL_BUFFER        \
67         _IOWR('#', 0x18, struct video1394_wait)
68
69
70 /* Raw1394's ISO interface */
71 #define RAW1394_IOC_ISO_XMIT_INIT               \
72         _IOW ('#', 0x1a, struct raw1394_iso_status)
73 #define RAW1394_IOC_ISO_RECV_INIT               \
74         _IOWR('#', 0x1b, struct raw1394_iso_status)
75 #define RAW1394_IOC_ISO_RECV_START              \
76         _IOC (_IOC_WRITE, '#', 0x1c, sizeof(int) * 3)
77 #define RAW1394_IOC_ISO_XMIT_START              \
78         _IOC (_IOC_WRITE, '#', 0x1d, sizeof(int) * 2)
79 #define RAW1394_IOC_ISO_XMIT_RECV_STOP          \
80         _IO  ('#', 0x1e)
81 #define RAW1394_IOC_ISO_GET_STATUS              \
82         _IOR ('#', 0x1f, struct raw1394_iso_status)
83 #define RAW1394_IOC_ISO_SHUTDOWN                \
84         _IO  ('#', 0x20)
85 #define RAW1394_IOC_ISO_QUEUE_ACTIVITY          \
86         _IO  ('#', 0x21)
87 #define RAW1394_IOC_ISO_RECV_LISTEN_CHANNEL     \
88         _IOW ('#', 0x22, unsigned char)
89 #define RAW1394_IOC_ISO_RECV_UNLISTEN_CHANNEL   \
90         _IOW ('#', 0x23, unsigned char)
91 #define RAW1394_IOC_ISO_RECV_SET_CHANNEL_MASK   \
92         _IOW ('#', 0x24, __u64)
93 #define RAW1394_IOC_ISO_RECV_PACKETS            \
94         _IOW ('#', 0x25, struct raw1394_iso_packets)
95 #define RAW1394_IOC_ISO_RECV_RELEASE_PACKETS    \
96         _IOW ('#', 0x26, unsigned int)
97 #define RAW1394_IOC_ISO_XMIT_PACKETS            \
98         _IOW ('#', 0x27, struct raw1394_iso_packets)
99 #define RAW1394_IOC_ISO_XMIT_SYNC               \
100         _IO  ('#', 0x28)
101 #define RAW1394_IOC_ISO_RECV_FLUSH              \
102         _IO  ('#', 0x29)
103 #define RAW1394_IOC_GET_CYCLE_TIMER             \
104         _IOR ('#', 0x30, struct raw1394_cycle_timer)
105
106 #endif /* __IEEE1394_IOCTL_H */