linsys SDI: change shortnames
[vlc.git] / modules / access / linsys / linsys_sdivideo.h
1 /* sdivideo.h
2  *
3  * Shared header file for the Linux user-space API for
4  * Linear Systems Ltd. SMPTE 292M and SMPTE 259M-C interface boards.
5  *
6  * Copyright (C) 2009-2010 Linear Systems Ltd.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  *   1. Redistributions of source code must retain the above copyright notice,
12  *      this list of conditions and the following disclaimer.
13  *
14  *   2. Redistributions in binary form must reproduce the above copyright
15  *      notice, this list of conditions and the following disclaimer in the
16  *      documentation and/or other materials provided with the distribution.
17  *
18  *   3. Neither the name of Linear Systems Ltd. nor the names of its
19  *      contributors may be used to endorse or promote products derived from
20  *      this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY LINEAR SYSTEMS LTD. "AS IS" AND ANY
23  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED. IN NO EVENT SHALL LINEAR SYSTEMS LTD. OR CONTRIBUTORS
26  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
27  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
29  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
30  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
31  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
32  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Linear Systems can be contacted at <http://www.linsys.ca/>.
35  *
36  */
37
38 #ifndef _SDIVIDEO_H
39 #define _SDIVIDEO_H
40
41 /* Driver info */
42 #define SDIVIDEO_DRIVER_NAME "sdivideo"
43
44 #define SDIVIDEO_MAJOR 0        /* Set to 0 for dynamic allocation.
45                          * See /usr/src/linux/Documentation/devices.txt */
46
47 #define SDIVIDEO_TX_BUFFERS_MIN 2 /* This must be at least 2 */
48 /* The minimum transmit buffer size must be positive, divisible by 4,
49  * and large enough that the buffers aren't transferred to the onboard FIFOs
50  * too quickly for the machine to handle the interrupts.
51  * This is especially a problem at startup, when the FIFOs are empty.
52  * Relevant factors include onboard FIFO size, PCI bus throughput,
53  * processor speed, and interrupt latency. */
54 #define SDIVIDEO_TX_BUFSIZE_MIN 1024
55 #define SDIVIDEO_RX_BUFFERS_MIN 2 /* This must be at least 2 */
56 #define SDIVIDEO_RX_BUFSIZE_MIN 8 /* This must be positive and divisible by 4 */
57
58 #define SDIVIDEO_TX_BUFFERS 30 /* This must be at least 2 */
59 #define SDIVIDEO_TX_BUFSIZE 1843200 /* This must be positive and divisible by 4 */
60 #define SDIVIDEO_RX_BUFFERS 30 /* This must be at least 2 */
61 #define SDIVIDEO_RX_BUFSIZE 1843200 /* This must be positive and divisible by 4 */
62
63 /* Ioctl () definitions */
64 #define SDIVIDEO_IOC_MAGIC '=' /* This ioctl magic number is currently free. See
65                            * /usr/src/linux/Documentation/ioctl-number.txt */
66
67 #define SDIVIDEO_IOC_TXGETCAP           _IOR(SDIVIDEO_IOC_MAGIC, 1, unsigned int)
68 #define SDIVIDEO_IOC_TXGETEVENTS        _IOR(SDIVIDEO_IOC_MAGIC, 2, unsigned int)
69 #define SDIVIDEO_IOC_TXGETBUFLEVEL      _IOR(SDIVIDEO_IOC_MAGIC, 3, unsigned int)
70 #define SDIVIDEO_IOC_TXGETTXD           _IOR(SDIVIDEO_IOC_MAGIC, 4, int)
71 #define SDIVIDEO_IOC_TXGETREF           _IOR(SDIVIDEO_IOC_MAGIC, 5, unsigned int)
72
73 #define SDIVIDEO_IOC_RXGETCAP           _IOR(SDIVIDEO_IOC_MAGIC, 65, unsigned int)
74 #define SDIVIDEO_IOC_RXGETEVENTS        _IOR(SDIVIDEO_IOC_MAGIC, 66, unsigned int)
75 #define SDIVIDEO_IOC_RXGETBUFLEVEL      _IOR(SDIVIDEO_IOC_MAGIC, 67, unsigned int)
76 #define SDIVIDEO_IOC_RXGETCARRIER       _IOR(SDIVIDEO_IOC_MAGIC, 68, int)
77 #define SDIVIDEO_IOC_RXGETSTATUS        _IOR(SDIVIDEO_IOC_MAGIC, 69, int)
78 #define SDIVIDEO_IOC_RXGETYCRCERROR     _IOR(SDIVIDEO_IOC_MAGIC, 70, unsigned int)
79 #define SDIVIDEO_IOC_RXGETCCRCERROR     _IOR(SDIVIDEO_IOC_MAGIC, 71, unsigned int)
80 #define SDIVIDEO_IOC_RXGETVIDSTATUS     _IOR(SDIVIDEO_IOC_MAGIC, 72, unsigned int)
81
82 #define SDIVIDEO_IOC_GETID              _IOR(SDIVIDEO_IOC_MAGIC, 129, unsigned int)
83 #define SDIVIDEO_IOC_GETVERSION         _IOR(SDIVIDEO_IOC_MAGIC, 130, unsigned int)
84 /* Provide compatibility with applications compiled for older API */
85 #define SDIVIDEO_IOC_QBUF_DEPRECATED    _IOW(SDIVIDEO_IOC_MAGIC, 131, unsigned int)
86 #define SDIVIDEO_IOC_QBUF               _IO(SDIVIDEO_IOC_MAGIC, 131)
87 /* Provide compatibility with applications compiled for older API */
88 #define SDIVIDEO_IOC_DQBUF_DEPRECATED   _IOW(SDIVIDEO_IOC_MAGIC, 132, unsigned int)
89 #define SDIVIDEO_IOC_DQBUF              _IO(SDIVIDEO_IOC_MAGIC, 132)
90
91 /* Transmitter event flag bit locations */
92 #define SDIVIDEO_EVENT_TX_BUFFER_ORDER  0
93 #define SDIVIDEO_EVENT_TX_BUFFER        (1 << SDIVIDEO_EVENT_TX_BUFFER_ORDER)
94 #define SDIVIDEO_EVENT_TX_FIFO_ORDER    1
95 #define SDIVIDEO_EVENT_TX_FIFO          (1 << SDIVIDEO_EVENT_TX_FIFO_ORDER)
96 #define SDIVIDEO_EVENT_TX_DATA_ORDER    2
97 #define SDIVIDEO_EVENT_TX_DATA          (1 << SDIVIDEO_EVENT_TX_DATA_ORDER)
98 #define SDIVIDEO_EVENT_TX_REF_ORDER     3
99 #define SDIVIDEO_EVENT_TX_REF           (1 << SDIVIDEO_EVENT_TX_REF_ORDER)
100
101 /* Receiver event flag bit locations */
102 #define SDIVIDEO_EVENT_RX_BUFFER_ORDER  0
103 #define SDIVIDEO_EVENT_RX_BUFFER        (1 << SDIVIDEO_EVENT_RX_BUFFER_ORDER)
104 #define SDIVIDEO_EVENT_RX_FIFO_ORDER    1
105 #define SDIVIDEO_EVENT_RX_FIFO          (1 << SDIVIDEO_EVENT_RX_FIFO_ORDER)
106 #define SDIVIDEO_EVENT_RX_CARRIER_ORDER 2
107 #define SDIVIDEO_EVENT_RX_CARRIER       (1 << SDIVIDEO_EVENT_RX_CARRIER_ORDER)
108 #define SDIVIDEO_EVENT_RX_DATA_ORDER    3
109 #define SDIVIDEO_EVENT_RX_DATA          (1 << SDIVIDEO_EVENT_RX_DATA_ORDER)
110 #define SDIVIDEO_EVENT_RX_STD_ORDER     4
111 #define SDIVIDEO_EVENT_RX_STD           (1 << SDIVIDEO_EVENT_RX_STD_ORDER)
112
113 /* Interface capabilities */
114 #define SDIVIDEO_CAP_RX_CD              0x00000001
115 #define SDIVIDEO_CAP_RX_DATA            0x00000002
116 #define SDIVIDEO_CAP_RX_ERR_COUNT       0x00000004
117 #define SDIVIDEO_CAP_RX_VBI             0x00000008
118 #define SDIVIDEO_CAP_RX_RAWMODE         0x00000010
119 #define SDIVIDEO_CAP_RX_DEINTERLACING   0x00000020
120
121 /* Transmitter clock source settings */
122 #define SDIVIDEO_CTL_TX_CLKSRC_ONBOARD          0
123 #define SDIVIDEO_CTL_TX_CLKSRC_NTSC             1
124 #define SDIVIDEO_CTL_TX_CLKSRC_PAL              2
125 #define SDIVIDEO_CTL_TX_CLKSRC_525P             3
126 #define SDIVIDEO_CTL_TX_CLKSRC_625P             4
127 #define SDIVIDEO_CTL_TX_CLKSRC_720P_60          5
128 #define SDIVIDEO_CTL_TX_CLKSRC_720P_59_94       6
129 #define SDIVIDEO_CTL_TX_CLKSRC_720P_50          7
130 #define SDIVIDEO_CTL_TX_CLKSRC_720P_30          8
131 #define SDIVIDEO_CTL_TX_CLKSRC_720P_29_97       9
132 #define SDIVIDEO_CTL_TX_CLKSRC_720P_25          10
133 #define SDIVIDEO_CTL_TX_CLKSRC_720P_24          11
134 #define SDIVIDEO_CTL_TX_CLKSRC_720P_23_98       12
135 #define SDIVIDEO_CTL_TX_CLKSRC_1080P_60         13
136 #define SDIVIDEO_CTL_TX_CLKSRC_1080P_59_94      14
137 #define SDIVIDEO_CTL_TX_CLKSRC_1080P_50         15
138 #define SDIVIDEO_CTL_TX_CLKSRC_1080P_30         16
139 #define SDIVIDEO_CTL_TX_CLKSRC_1080P_29_97      17
140 #define SDIVIDEO_CTL_TX_CLKSRC_1080P_25         18
141 #define SDIVIDEO_CTL_TX_CLKSRC_1080P_24         19
142 #define SDIVIDEO_CTL_TX_CLKSRC_1080P_23_98      20
143 #define SDIVIDEO_CTL_TX_CLKSRC_1080I_60         21
144 #define SDIVIDEO_CTL_TX_CLKSRC_1080I_59_94      22
145 #define SDIVIDEO_CTL_TX_CLKSRC_1080I_50         23
146
147 /* Mode settings */
148 #define SDIVIDEO_CTL_MODE_UYVY                  0
149 #define SDIVIDEO_CTL_MODE_V210                  1
150 #define SDIVIDEO_CTL_MODE_V210_DEINTERLACE      2
151 #define SDIVIDEO_CTL_MODE_RAW                   3
152
153 /* Frame mode settings */
154 #define SDIVIDEO_CTL_UNLOCKED                           0
155 #define SDIVIDEO_CTL_SMPTE_125M_486I_59_94HZ            1
156 #define SDIVIDEO_CTL_BT_601_576I_50HZ                   2
157 #define SDIVIDEO_CTL_SMPTE_260M_1035I_60HZ              5
158 #define SDIVIDEO_CTL_SMPTE_260M_1035I_59_94HZ           6
159 #define SDIVIDEO_CTL_SMPTE_295M_1080I_50HZ              7
160 #define SDIVIDEO_CTL_SMPTE_274M_1080I_60HZ              8
161 #define SDIVIDEO_CTL_SMPTE_274M_1080PSF_30HZ            9
162 #define SDIVIDEO_CTL_SMPTE_274M_1080I_59_94HZ           10
163 #define SDIVIDEO_CTL_SMPTE_274M_1080PSF_29_97HZ         11
164 #define SDIVIDEO_CTL_SMPTE_274M_1080I_50HZ              12
165 #define SDIVIDEO_CTL_SMPTE_274M_1080PSF_25HZ            13
166 #define SDIVIDEO_CTL_SMPTE_274M_1080PSF_24HZ            14
167 #define SDIVIDEO_CTL_SMPTE_274M_1080PSF_23_98HZ         15
168 #define SDIVIDEO_CTL_SMPTE_274M_1080P_30HZ              16
169 #define SDIVIDEO_CTL_SMPTE_274M_1080P_29_97HZ           17
170 #define SDIVIDEO_CTL_SMPTE_274M_1080P_25HZ              18
171 #define SDIVIDEO_CTL_SMPTE_274M_1080P_24HZ              19
172 #define SDIVIDEO_CTL_SMPTE_274M_1080P_23_98HZ           20
173 #define SDIVIDEO_CTL_SMPTE_296M_720P_60HZ               21
174 #define SDIVIDEO_CTL_SMPTE_296M_720P_59_94HZ            22
175 #define SDIVIDEO_CTL_SMPTE_296M_720P_50HZ               23
176 #define SDIVIDEO_CTL_SMPTE_296M_720P_30HZ               24
177 #define SDIVIDEO_CTL_SMPTE_296M_720P_29_97HZ            25
178 #define SDIVIDEO_CTL_SMPTE_296M_720P_25HZ               26
179 #define SDIVIDEO_CTL_SMPTE_296M_720P_24HZ               27
180 #define SDIVIDEO_CTL_SMPTE_296M_720P_23_98HZ            28
181
182 #endif
183