Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/roland...
[linux-2.6] / drivers / media / video / saa5246a.h
1 /*
2    Driver for the SAA5246A or SAA5281 Teletext (=Videotext) decoder chips from
3    Philips.
4
5    Copyright (C) 2004 Michael Geng (linux@MichaelGeng.de)
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program; if not, write to the Free Software
19    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20
21  */
22 #ifndef __SAA5246A_H__
23 #define __SAA5246A_H__
24
25 #define MAJOR_VERSION 1         /* driver major version number */
26 #define MINOR_VERSION 8         /* driver minor version number */
27
28 #define IF_NAME "SAA5246A"
29
30 #define I2C_ADDRESS 17
31
32 /* Number of DAUs = number of pages that can be searched at the same time. */
33 #define NUM_DAUS 4
34
35 #define NUM_ROWS_PER_PAGE 40
36
37 /* first column is 0 (not 1) */
38 #define POS_TIME_START 32
39 #define POS_TIME_END 39
40
41 #define POS_HEADER_START 7
42 #define POS_HEADER_END 31
43
44 /* Returns 'true' if the part of the videotext page described with req contains
45    (at least parts of) the time field */
46 #define REQ_CONTAINS_TIME(p_req) \
47         ((p_req)->start <= POS_TIME_END && \
48          (p_req)->end   >= POS_TIME_START)
49
50 /* Returns 'true' if the part of the videotext page described with req contains
51    (at least parts of) the page header */
52 #define REQ_CONTAINS_HEADER(p_req) \
53         ((p_req)->start <= POS_HEADER_END && \
54          (p_req)->end   >= POS_HEADER_START)
55
56 /*****************************************************************************/
57 /* Mode register numbers of the SAA5246A                                     */
58 /*****************************************************************************/
59 #define SAA5246A_REGISTER_R0    0
60 #define SAA5246A_REGISTER_R1    1
61 #define SAA5246A_REGISTER_R2    2
62 #define SAA5246A_REGISTER_R3    3
63 #define SAA5246A_REGISTER_R4    4
64 #define SAA5246A_REGISTER_R5    5
65 #define SAA5246A_REGISTER_R6    6
66 #define SAA5246A_REGISTER_R7    7
67 #define SAA5246A_REGISTER_R8    8
68 #define SAA5246A_REGISTER_R9    9
69 #define SAA5246A_REGISTER_R10  10
70 #define SAA5246A_REGISTER_R11  11
71 #define SAA5246A_REGISTER_R11B 11
72
73 /* SAA5246A mode registers often autoincrement to the next register.
74    Therefore we use variable argument lists. The following macro indicates
75    the end of a command list. */
76 #define COMMAND_END (- 1)
77
78 /*****************************************************************************/
79 /* Contents of the mode registers of the SAA5246A                            */
80 /*****************************************************************************/
81 /* Register R0 (Advanced Control) */
82 #define R0_SELECT_R11                                      0x00
83 #define R0_SELECT_R11B                                     0x01
84
85 #define R0_PLL_TIME_CONSTANT_LONG                          0x00
86 #define R0_PLL_TIME_CONSTANT_SHORT                         0x02
87
88 #define R0_ENABLE_nODD_EVEN_OUTPUT                         0x00
89 #define R0_DISABLE_nODD_EVEN_OUTPUT                        0x04
90
91 #define R0_ENABLE_HDR_POLL                                 0x00
92 #define R0_DISABLE_HDR_POLL                                0x10
93
94 #define R0_DO_NOT_FORCE_nODD_EVEN_LOW_IF_PICTURE_DISPLAYED 0x00
95 #define R0_FORCE_nODD_EVEN_LOW_IF_PICTURE_DISPLAYED        0x20
96
97 #define R0_NO_FREE_RUN_PLL                                 0x00
98 #define R0_FREE_RUN_PLL                                    0x40
99
100 #define R0_NO_AUTOMATIC_FASTEXT_PROMPT                     0x00
101 #define R0_AUTOMATIC_FASTEXT_PROMPT                        0x80
102
103 /* Register R1 (Mode) */
104 #define R1_INTERLACED_312_AND_HALF_312_AND_HALF_LINES      0x00
105 #define R1_NON_INTERLACED_312_313_LINES                    0x01
106 #define R1_NON_INTERLACED_312_312_LINES                    0x02
107 #define R1_FFB_LEADING_EDGE_IN_FIRST_BROAD_PULSE           0x03
108 #define R1_FFB_LEADING_EDGE_IN_SECOND_BROAD_PULSE          0x07
109
110 #define R1_DEW                                             0x00
111 #define R1_FULL_FIELD                                      0x08
112
113 #define R1_EXTENDED_PACKET_DISABLE                         0x00
114 #define R1_EXTENDED_PACKET_ENABLE                          0x10
115
116 #define R1_DAUS_ALL_ON                                     0x00
117 #define R1_DAUS_ALL_OFF                                    0x20
118
119 #define R1_7_BITS_PLUS_PARITY                              0x00
120 #define R1_8_BITS_NO_PARITY                                0x40
121
122 #define R1_VCS_TO_SCS                                      0x00
123 #define R1_NO_VCS_TO_SCS                                   0x80
124
125 /* Register R2 (Page request address) */
126 #define R2_IN_R3_SELECT_PAGE_HUNDREDS                      0x00
127 #define R2_IN_R3_SELECT_PAGE_TENS                          0x01
128 #define R2_IN_R3_SELECT_PAGE_UNITS                         0x02
129 #define R2_IN_R3_SELECT_HOURS_TENS                         0x03
130 #define R2_IN_R3_SELECT_HOURS_UNITS                        0x04
131 #define R2_IN_R3_SELECT_MINUTES_TENS                       0x05
132 #define R2_IN_R3_SELECT_MINUTES_UNITS                      0x06
133
134 #define R2_DAU_0                                           0x00
135 #define R2_DAU_1                                           0x10
136 #define R2_DAU_2                                           0x20
137 #define R2_DAU_3                                           0x30
138
139 #define R2_BANK_0                                          0x00
140 #define R2_BANK 1                                          0x40
141
142 #define R2_HAMMING_CHECK_ON                                0x80
143 #define R2_HAMMING_CHECK_OFF                               0x00
144
145 /* Register R3 (Page request data) */
146 #define R3_PAGE_HUNDREDS_0                                 0x00
147 #define R3_PAGE_HUNDREDS_1                                 0x01
148 #define R3_PAGE_HUNDREDS_2                                 0x02
149 #define R3_PAGE_HUNDREDS_3                                 0x03
150 #define R3_PAGE_HUNDREDS_4                                 0x04
151 #define R3_PAGE_HUNDREDS_5                                 0x05
152 #define R3_PAGE_HUNDREDS_6                                 0x06
153 #define R3_PAGE_HUNDREDS_7                                 0x07
154
155 #define R3_HOLD_PAGE                                       0x00
156 #define R3_UPDATE_PAGE                                     0x08
157
158 #define R3_PAGE_HUNDREDS_DO_NOT_CARE                       0x00
159 #define R3_PAGE_HUNDREDS_DO_CARE                           0x10
160
161 #define R3_PAGE_TENS_DO_NOT_CARE                           0x00
162 #define R3_PAGE_TENS_DO_CARE                               0x10
163
164 #define R3_PAGE_UNITS_DO_NOT_CARE                          0x00
165 #define R3_PAGE_UNITS_DO_CARE                              0x10
166
167 #define R3_HOURS_TENS_DO_NOT_CARE                          0x00
168 #define R3_HOURS_TENS_DO_CARE                              0x10
169
170 #define R3_HOURS_UNITS_DO_NOT_CARE                         0x00
171 #define R3_HOURS_UNITS_DO_CARE                             0x10
172
173 #define R3_MINUTES_TENS_DO_NOT_CARE                        0x00
174 #define R3_MINUTES_TENS_DO_CARE                            0x10
175
176 #define R3_MINUTES_UNITS_DO_NOT_CARE                       0x00
177 #define R3_MINUTES_UNITS_DO_CARE                           0x10
178
179 /* Register R4 (Display chapter) */
180 #define R4_DISPLAY_PAGE_0                                  0x00
181 #define R4_DISPLAY_PAGE_1                                  0x01
182 #define R4_DISPLAY_PAGE_2                                  0x02
183 #define R4_DISPLAY_PAGE_3                                  0x03
184 #define R4_DISPLAY_PAGE_4                                  0x04
185 #define R4_DISPLAY_PAGE_5                                  0x05
186 #define R4_DISPLAY_PAGE_6                                  0x06
187 #define R4_DISPLAY_PAGE_7                                  0x07
188
189 /* Register R5 (Normal display control) */
190 #define R5_PICTURE_INSIDE_BOXING_OFF                       0x00
191 #define R5_PICTURE_INSIDE_BOXING_ON                        0x01
192
193 #define R5_PICTURE_OUTSIDE_BOXING_OFF                      0x00
194 #define R5_PICTURE_OUTSIDE_BOXING_ON                       0x02
195
196 #define R5_TEXT_INSIDE_BOXING_OFF                          0x00
197 #define R5_TEXT_INSIDE_BOXING_ON                           0x04
198
199 #define R5_TEXT_OUTSIDE_BOXING_OFF                         0x00
200 #define R5_TEXT_OUTSIDE_BOXING_ON                          0x08
201
202 #define R5_CONTRAST_REDUCTION_INSIDE_BOXING_OFF            0x00
203 #define R5_CONTRAST_REDUCTION_INSIDE_BOXING_ON             0x10
204
205 #define R5_CONTRAST_REDUCTION_OUTSIDE_BOXING_OFF           0x00
206 #define R5_CONTRAST_REDUCTION_OUTSIDE_BOXING_ON            0x20
207
208 #define R5_BACKGROUND_COLOR_INSIDE_BOXING_OFF              0x00
209 #define R5_BACKGROUND_COLOR_INSIDE_BOXING_ON               0x40
210
211 #define R5_BACKGROUND_COLOR_OUTSIDE_BOXING_OFF             0x00
212 #define R5_BACKGROUND_COLOR_OUTSIDE_BOXING_ON              0x80
213
214 /* Register R6 (Newsflash display) */
215 #define R6_NEWSFLASH_PICTURE_INSIDE_BOXING_OFF             0x00
216 #define R6_NEWSFLASH_PICTURE_INSIDE_BOXING_ON              0x01
217
218 #define R6_NEWSFLASH_PICTURE_OUTSIDE_BOXING_OFF            0x00
219 #define R6_NEWSFLASH_PICTURE_OUTSIDE_BOXING_ON             0x02
220
221 #define R6_NEWSFLASH_TEXT_INSIDE_BOXING_OFF                0x00
222 #define R6_NEWSFLASH_TEXT_INSIDE_BOXING_ON                 0x04
223
224 #define R6_NEWSFLASH_TEXT_OUTSIDE_BOXING_OFF               0x00
225 #define R6_NEWSFLASH_TEXT_OUTSIDE_BOXING_ON                0x08
226
227 #define R6_NEWSFLASH_CONTRAST_REDUCTION_INSIDE_BOXING_OFF  0x00
228 #define R6_NEWSFLASH_CONTRAST_REDUCTION_INSIDE_BOXING_ON   0x10
229
230 #define R6_NEWSFLASH_CONTRAST_REDUCTION_OUTSIDE_BOXING_OFF 0x00
231 #define R6_NEWSFLASH_CONTRAST_REDUCTION_OUTSIDE_BOXING_ON  0x20
232
233 #define R6_NEWSFLASH_BACKGROUND_COLOR_INSIDE_BOXING_OFF    0x00
234 #define R6_NEWSFLASH_BACKGROUND_COLOR_INSIDE_BOXING_ON     0x40
235
236 #define R6_NEWSFLASH_BACKGROUND_COLOR_OUTSIDE_BOXING_OFF   0x00
237 #define R6_NEWSFLASH_BACKGROUND_COLOR_OUTSIDE_BOXING_ON    0x80
238
239 /* Register R7 (Display mode) */
240 #define R7_BOX_OFF_ROW_0                                   0x00
241 #define R7_BOX_ON_ROW_0                                    0x01
242
243 #define R7_BOX_OFF_ROW_1_TO_23                             0x00
244 #define R7_BOX_ON_ROW_1_TO_23                              0x02
245
246 #define R7_BOX_OFF_ROW_24                                  0x00
247 #define R7_BOX_ON_ROW_24                                   0x04
248
249 #define R7_SINGLE_HEIGHT                                   0x00
250 #define R7_DOUBLE_HEIGHT                                   0x08
251
252 #define R7_TOP_HALF                                        0x00
253 #define R7_BOTTOM_HALF                                     0x10
254
255 #define R7_REVEAL_OFF                                      0x00
256 #define R7_REVEAL_ON                                       0x20
257
258 #define R7_CURSER_OFF                                      0x00
259 #define R7_CURSER_ON                                       0x40
260
261 #define R7_STATUS_BOTTOM                                   0x00
262 #define R7_STATUS_TOP                                      0x80
263
264 /* Register R8 (Active chapter) */
265 #define R8_ACTIVE_CHAPTER_0                                0x00
266 #define R8_ACTIVE_CHAPTER_1                                0x01
267 #define R8_ACTIVE_CHAPTER_2                                0x02
268 #define R8_ACTIVE_CHAPTER_3                                0x03
269 #define R8_ACTIVE_CHAPTER_4                                0x04
270 #define R8_ACTIVE_CHAPTER_5                                0x05
271 #define R8_ACTIVE_CHAPTER_6                                0x06
272 #define R8_ACTIVE_CHAPTER_7                                0x07
273
274 #define R8_CLEAR_MEMORY                                    0x08
275 #define R8_DO_NOT_CLEAR_MEMORY                             0x00
276
277 /* Register R9 (Curser row) */
278 #define R9_CURSER_ROW_0                                    0x00
279 #define R9_CURSER_ROW_1                                    0x01
280 #define R9_CURSER_ROW_2                                    0x02
281 #define R9_CURSER_ROW_25                                   0x19
282
283 /* Register R10 (Curser column) */
284 #define R10_CURSER_COLUMN_0                                0x00
285 #define R10_CURSER_COLUMN_6                                0x06
286 #define R10_CURSER_COLUMN_8                                0x08
287
288 /*****************************************************************************/
289 /* Row 25 control data in column 0 to 9                                      */
290 /*****************************************************************************/
291 #define ROW25_COLUMN0_PAGE_UNITS                           0x0F
292
293 #define ROW25_COLUMN1_PAGE_TENS                            0x0F
294
295 #define ROW25_COLUMN2_MINUTES_UNITS                        0x0F
296
297 #define ROW25_COLUMN3_MINUTES_TENS                         0x07
298 #define ROW25_COLUMN3_DELETE_PAGE                          0x08
299
300 #define ROW25_COLUMN4_HOUR_UNITS                           0x0F
301
302 #define ROW25_COLUMN5_HOUR_TENS                            0x03
303 #define ROW25_COLUMN5_INSERT_HEADLINE                      0x04
304 #define ROW25_COLUMN5_INSERT_SUBTITLE                      0x08
305
306 #define ROW25_COLUMN6_SUPPRESS_HEADER                      0x01
307 #define ROW25_COLUMN6_UPDATE_PAGE                          0x02
308 #define ROW25_COLUMN6_INTERRUPTED_SEQUENCE                 0x04
309 #define ROW25_COLUMN6_SUPPRESS_DISPLAY                     0x08
310
311 #define ROW25_COLUMN7_SERIAL_MODE                          0x01
312 #define ROW25_COLUMN7_CHARACTER_SET                        0x0E
313
314 #define ROW25_COLUMN8_PAGE_HUNDREDS                        0x07
315 #define ROW25_COLUMN8_PAGE_NOT_FOUND                       0x10
316
317 #define ROW25_COLUMN9_PAGE_BEING_LOOKED_FOR                0x20
318
319 #define ROW25_COLUMN0_TO_7_HAMMING_ERROR                   0x10
320
321 /*****************************************************************************/
322 /* Helper macros for extracting page, hour and minute digits                 */
323 /*****************************************************************************/
324 /* BYTE_POS  0 is at row 0, column 0,
325    BYTE_POS  1 is at row 0, column 1,
326    BYTE_POS 40 is at row 1, column 0, (with NUM_ROWS_PER_PAGE = 40)
327    BYTE_POS 41 is at row 1, column 1, (with NUM_ROWS_PER_PAGE = 40),
328    ... */
329 #define ROW(BYTE_POS)    (BYTE_POS / NUM_ROWS_PER_PAGE)
330 #define COLUMN(BYTE_POS) (BYTE_POS % NUM_ROWS_PER_PAGE)
331
332 /*****************************************************************************/
333 /* Helper macros for extracting page, hour and minute digits                 */
334 /*****************************************************************************/
335 /* Macros for extracting hundreds, tens and units of a page number which
336    must be in the range 0 ... 0x799.
337    Note that page is coded in hexadecimal, i.e. 0x123 means page 123.
338    page 0x.. means page 8.. */
339 #define HUNDREDS_OF_PAGE(page) (((page) / 0x100) & 0x7)
340 #define TENS_OF_PAGE(page)     (((page) / 0x10)  & 0xF)
341 #define UNITS_OF_PAGE(page)     ((page) & 0xF)
342
343 /* Macros for extracting tens and units of a hour information which
344    must be in the range 0 ... 0x24.
345    Note that hour is coded in hexadecimal, i.e. 0x12 means 12 hours */
346 #define TENS_OF_HOUR(hour)  ((hour) / 0x10)
347 #define UNITS_OF_HOUR(hour) ((hour) & 0xF)
348
349 /* Macros for extracting tens and units of a minute information which
350    must be in the range 0 ... 0x59.
351    Note that minute is coded in hexadecimal, i.e. 0x12 means 12 minutes */
352 #define TENS_OF_MINUTE(minute)  ((minute) / 0x10)
353 #define UNITS_OF_MINUTE(minute) ((minute) & 0xF)
354
355 #define HOUR_MAX   0x23
356 #define MINUTE_MAX 0x59
357 #define PAGE_MAX   0x8FF
358
359 #endif  /* __SAA5246A_H__ */