| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | #ifndef FALSE |
| 57 | #define FALSE 0 |
| 58 | #define TRUE 1 |
| 59 | #endif |
| 60 | |
| 61 | /*****************************************************************************/ |
| 62 | /* Mode register numbers of the SAA5246A */ |
| 63 | /*****************************************************************************/ |
| 64 | #define SAA5246A_REGISTER_R0 0 |
| 65 | #define SAA5246A_REGISTER_R1 1 |
| 66 | #define SAA5246A_REGISTER_R2 2 |
| 67 | #define SAA5246A_REGISTER_R3 3 |
| 68 | #define SAA5246A_REGISTER_R4 4 |
| 69 | #define SAA5246A_REGISTER_R5 5 |
| 70 | #define SAA5246A_REGISTER_R6 6 |
| 71 | #define SAA5246A_REGISTER_R7 7 |
| 72 | #define SAA5246A_REGISTER_R8 8 |
| 73 | #define SAA5246A_REGISTER_R9 9 |
| 74 | #define SAA5246A_REGISTER_R10 10 |
| 75 | #define SAA5246A_REGISTER_R11 11 |
| 76 | #define SAA5246A_REGISTER_R11B 11 |
| 77 | |
| 78 | /* SAA5246A mode registers often autoincrement to the next register. |
| 79 | Therefore we use variable argument lists. The following macro indicates |
| 80 | the end of a command list. */ |
| 81 | #define COMMAND_END (- 1) |
| 82 | |
| 83 | /*****************************************************************************/ |
| 84 | /* Contents of the mode registers of the SAA5246A */ |
| 85 | /*****************************************************************************/ |
| 86 | /* Register R0 (Advanced Control) */ |
| 87 | #define R0_SELECT_R11 0x00 |
| 88 | #define R0_SELECT_R11B 0x01 |
| 89 | |
| 90 | #define R0_PLL_TIME_CONSTANT_LONG 0x00 |
| 91 | #define R0_PLL_TIME_CONSTANT_SHORT 0x02 |
| 92 | |
| 93 | #define R0_ENABLE_nODD_EVEN_OUTPUT 0x00 |
| 94 | #define R0_DISABLE_nODD_EVEN_OUTPUT 0x04 |
| 95 | |
| 96 | #define R0_ENABLE_HDR_POLL 0x00 |
| 97 | #define R0_DISABLE_HDR_POLL 0x10 |
| 98 | |
| 99 | #define R0_DO_NOT_FORCE_nODD_EVEN_LOW_IF_PICTURE_DISPLAYED 0x00 |
| 100 | #define R0_FORCE_nODD_EVEN_LOW_IF_PICTURE_DISPLAYED 0x20 |
| 101 | |
| 102 | #define R0_NO_FREE_RUN_PLL 0x00 |
| 103 | #define R0_FREE_RUN_PLL 0x40 |
| 104 | |
| 105 | #define R0_NO_AUTOMATIC_FASTEXT_PROMPT 0x00 |
| 106 | #define R0_AUTOMATIC_FASTEXT_PROMPT 0x80 |
| 107 | |
| 108 | /* Register R1 (Mode) */ |
| 109 | #define R1_INTERLACED_312_AND_HALF_312_AND_HALF_LINES 0x00 |
| 110 | #define R1_NON_INTERLACED_312_313_LINES 0x01 |
| 111 | #define R1_NON_INTERLACED_312_312_LINES 0x02 |
| 112 | #define R1_FFB_LEADING_EDGE_IN_FIRST_BROAD_PULSE 0x03 |
| 113 | #define R1_FFB_LEADING_EDGE_IN_SECOND_BROAD_PULSE 0x07 |
| 114 | |
| 115 | #define R1_DEW 0x00 |
| 116 | #define R1_FULL_FIELD 0x08 |
| 117 | |
| 118 | #define R1_EXTENDED_PACKET_DISABLE 0x00 |
| 119 | #define R1_EXTENDED_PACKET_ENABLE 0x10 |
| 120 | |
| 121 | #define R1_DAUS_ALL_ON 0x00 |
| 122 | #define R1_DAUS_ALL_OFF 0x20 |
| 123 | |
| 124 | #define R1_7_BITS_PLUS_PARITY 0x00 |
| 125 | #define R1_8_BITS_NO_PARITY 0x40 |
| 126 | |
| 127 | #define R1_VCS_TO_SCS 0x00 |
| 128 | #define R1_NO_VCS_TO_SCS 0x80 |
| 129 | |
| 130 | /* Register R2 (Page request address) */ |
| 131 | #define R2_IN_R3_SELECT_PAGE_HUNDREDS 0x00 |
| 132 | #define R2_IN_R3_SELECT_PAGE_TENS 0x01 |
| 133 | #define R2_IN_R3_SELECT_PAGE_UNITS 0x02 |
| 134 | #define R2_IN_R3_SELECT_HOURS_TENS 0x03 |
| 135 | #define R2_IN_R3_SELECT_HOURS_UNITS 0x04 |
| 136 | #define R2_IN_R3_SELECT_MINUTES_TENS 0x05 |
| 137 | #define R2_IN_R3_SELECT_MINUTES_UNITS 0x06 |
| 138 | |
| 139 | #define R2_DAU_0 0x00 |
| 140 | #define R2_DAU_1 0x10 |
| 141 | #define R2_DAU_2 0x20 |
| 142 | #define R2_DAU_3 0x30 |
| 143 | |
| 144 | #define R2_BANK_0 0x00 |
| 145 | #define R2_BANK 1 0x40 |
| 146 | |
| 147 | #define R2_HAMMING_CHECK_ON 0x80 |
| 148 | #define R2_HAMMING_CHECK_OFF 0x00 |
| 149 | |
| 150 | /* Register R3 (Page request data) */ |
| 151 | #define R3_PAGE_HUNDREDS_0 0x00 |
| 152 | #define R3_PAGE_HUNDREDS_1 0x01 |
| 153 | #define R3_PAGE_HUNDREDS_2 0x02 |
| 154 | #define R3_PAGE_HUNDREDS_3 0x03 |
| 155 | #define R3_PAGE_HUNDREDS_4 0x04 |
| 156 | #define R3_PAGE_HUNDREDS_5 0x05 |
| 157 | #define R3_PAGE_HUNDREDS_6 0x06 |
| 158 | #define R3_PAGE_HUNDREDS_7 0x07 |
| 159 | |
| 160 | #define R3_HOLD_PAGE 0x00 |
| 161 | #define R3_UPDATE_PAGE 0x08 |
| 162 | |
| 163 | #define R3_PAGE_HUNDREDS_DO_NOT_CARE 0x00 |
| 164 | #define R3_PAGE_HUNDREDS_DO_CARE 0x10 |
| 165 | |
| 166 | #define R3_PAGE_TENS_DO_NOT_CARE 0x00 |
| 167 | #define R3_PAGE_TENS_DO_CARE 0x10 |
| 168 | |
| 169 | #define R3_PAGE_UNITS_DO_NOT_CARE 0x00 |
| 170 | #define R3_PAGE_UNITS_DO_CARE 0x10 |
| 171 | |
| 172 | #define R3_HOURS_TENS_DO_NOT_CARE 0x00 |
| 173 | #define R3_HOURS_TENS_DO_CARE 0x10 |
| 174 | |
| 175 | #define R3_HOURS_UNITS_DO_NOT_CARE 0x00 |
| 176 | #define R3_HOURS_UNITS_DO_CARE 0x10 |
| 177 | |
| 178 | #define R3_MINUTES_TENS_DO_NOT_CARE 0x00 |
| 179 | #define R3_MINUTES_TENS_DO_CARE 0x10 |
| 180 | |
| 181 | #define R3_MINUTES_UNITS_DO_NOT_CARE 0x00 |
| 182 | #define R3_MINUTES_UNITS_DO_CARE 0x10 |
| 183 | |
| 184 | /* Register R4 (Display chapter) */ |
| 185 | #define R4_DISPLAY_PAGE_0 0x00 |
| 186 | #define R4_DISPLAY_PAGE_1 0x01 |
| 187 | #define R4_DISPLAY_PAGE_2 0x02 |
| 188 | #define R4_DISPLAY_PAGE_3 0x03 |
| 189 | #define R4_DISPLAY_PAGE_4 0x04 |
| 190 | #define R4_DISPLAY_PAGE_5 0x05 |
| 191 | #define R4_DISPLAY_PAGE_6 0x06 |
| 192 | #define R4_DISPLAY_PAGE_7 0x07 |
| 193 | |
| 194 | /* Register R5 (Normal display control) */ |
| 195 | #define R5_PICTURE_INSIDE_BOXING_OFF 0x00 |
| 196 | #define R5_PICTURE_INSIDE_BOXING_ON 0x01 |
| 197 | |
| 198 | #define R5_PICTURE_OUTSIDE_BOXING_OFF 0x00 |
| 199 | #define R5_PICTURE_OUTSIDE_BOXING_ON 0x02 |
| 200 | |
| 201 | #define R5_TEXT_INSIDE_BOXING_OFF 0x00 |
| 202 | #define R5_TEXT_INSIDE_BOXING_ON 0x04 |
| 203 | |
| 204 | #define R5_TEXT_OUTSIDE_BOXING_OFF 0x00 |
| 205 | #define R5_TEXT_OUTSIDE_BOXING_ON 0x08 |
| 206 | |
| 207 | #define R5_CONTRAST_REDUCTION_INSIDE_BOXING_OFF 0x00 |
| 208 | #define R5_CONTRAST_REDUCTION_INSIDE_BOXING_ON 0x10 |
| 209 | |
| 210 | #define R5_CONTRAST_REDUCTION_OUTSIDE_BOXING_OFF 0x00 |
| 211 | #define R5_CONTRAST_REDUCTION_OUTSIDE_BOXING_ON 0x20 |
| 212 | |
| 213 | #define R5_BACKGROUND_COLOR_INSIDE_BOXING_OFF 0x00 |
| 214 | #define R5_BACKGROUND_COLOR_INSIDE_BOXING_ON 0x40 |
| 215 | |
| 216 | #define R5_BACKGROUND_COLOR_OUTSIDE_BOXING_OFF 0x00 |
| 217 | #define R5_BACKGROUND_COLOR_OUTSIDE_BOXING_ON 0x80 |
| 218 | |
| 219 | /* Register R6 (Newsflash display) */ |
| 220 | #define R6_NEWSFLASH_PICTURE_INSIDE_BOXING_OFF 0x00 |
| 221 | #define R6_NEWSFLASH_PICTURE_INSIDE_BOXING_ON 0x01 |
| 222 | |
| 223 | #define R6_NEWSFLASH_PICTURE_OUTSIDE_BOXING_OFF 0x00 |
| 224 | #define R6_NEWSFLASH_PICTURE_OUTSIDE_BOXING_ON 0x02 |
| 225 | |
| 226 | #define R6_NEWSFLASH_TEXT_INSIDE_BOXING_OFF 0x00 |
| 227 | #define R6_NEWSFLASH_TEXT_INSIDE_BOXING_ON 0x04 |
| 228 | |
| 229 | #define R6_NEWSFLASH_TEXT_OUTSIDE_BOXING_OFF 0x00 |
| 230 | #define R6_NEWSFLASH_TEXT_OUTSIDE_BOXING_ON 0x08 |
| 231 | |
| 232 | #define R6_NEWSFLASH_CONTRAST_REDUCTION_INSIDE_BOXING_OFF 0x00 |
| 233 | #define R6_NEWSFLASH_CONTRAST_REDUCTION_INSIDE_BOXING_ON 0x10 |
| 234 | |
| 235 | #define R6_NEWSFLASH_CONTRAST_REDUCTION_OUTSIDE_BOXING_OFF 0x00 |
| 236 | #define R6_NEWSFLASH_CONTRAST_REDUCTION_OUTSIDE_BOXING_ON 0x20 |
| 237 | |
| 238 | #define R6_NEWSFLASH_BACKGROUND_COLOR_INSIDE_BOXING_OFF 0x00 |
| 239 | #define R6_NEWSFLASH_BACKGROUND_COLOR_INSIDE_BOXING_ON 0x40 |
| 240 | |
| 241 | #define R6_NEWSFLASH_BACKGROUND_COLOR_OUTSIDE_BOXING_OFF 0x00 |
| 242 | #define R6_NEWSFLASH_BACKGROUND_COLOR_OUTSIDE_BOXING_ON 0x80 |
| 243 | |
| 244 | /* Register R7 (Display mode) */ |
| 245 | #define R7_BOX_OFF_ROW_0 0x00 |
| 246 | #define R7_BOX_ON_ROW_0 0x01 |
| 247 | |
| 248 | #define R7_BOX_OFF_ROW_1_TO_23 0x00 |
| 249 | #define R7_BOX_ON_ROW_1_TO_23 0x02 |
| 250 | |
| 251 | #define R7_BOX_OFF_ROW_24 0x00 |
| 252 | #define R7_BOX_ON_ROW_24 0x04 |
| 253 | |
| 254 | #define R7_SINGLE_HEIGHT 0x00 |
| 255 | #define R7_DOUBLE_HEIGHT 0x08 |
| 256 | |
| 257 | #define R7_TOP_HALF 0x00 |
| 258 | #define R7_BOTTOM_HALF 0x10 |
| 259 | |
| 260 | #define R7_REVEAL_OFF 0x00 |
| 261 | #define R7_REVEAL_ON 0x20 |
| 262 | |
| 263 | #define R7_CURSER_OFF 0x00 |
| 264 | #define R7_CURSER_ON 0x40 |
| 265 | |
| 266 | #define R7_STATUS_BOTTOM 0x00 |
| 267 | #define R7_STATUS_TOP 0x80 |
| 268 | |
| 269 | /* Register R8 (Active chapter) */ |
| 270 | #define R8_ACTIVE_CHAPTER_0 0x00 |
| 271 | #define R8_ACTIVE_CHAPTER_1 0x01 |
| 272 | #define R8_ACTIVE_CHAPTER_2 0x02 |
| 273 | #define R8_ACTIVE_CHAPTER_3 0x03 |
| 274 | #define R8_ACTIVE_CHAPTER_4 0x04 |
| 275 | #define R8_ACTIVE_CHAPTER_5 0x05 |
| 276 | #define R8_ACTIVE_CHAPTER_6 0x06 |
| 277 | #define R8_ACTIVE_CHAPTER_7 0x07 |
| 278 | |
| 279 | #define R8_CLEAR_MEMORY 0x08 |
| 280 | #define R8_DO_NOT_CLEAR_MEMORY 0x00 |
| 281 | |
| 282 | /* Register R9 (Curser row) */ |
| 283 | #define R9_CURSER_ROW_0 0x00 |
| 284 | #define R9_CURSER_ROW_1 0x01 |
| 285 | #define R9_CURSER_ROW_2 0x02 |
| 286 | #define R9_CURSER_ROW_25 0x19 |
| 287 | |
| 288 | /* Register R10 (Curser column) */ |
| 289 | #define R10_CURSER_COLUMN_0 0x00 |
| 290 | #define R10_CURSER_COLUMN_6 0x06 |
| 291 | #define R10_CURSER_COLUMN_8 0x08 |
| 292 | |
| 293 | /*****************************************************************************/ |
| 294 | /* Row 25 control data in column 0 to 9 */ |
| 295 | /*****************************************************************************/ |
| 296 | #define ROW25_COLUMN0_PAGE_UNITS 0x0F |
| 297 | |
| 298 | #define ROW25_COLUMN1_PAGE_TENS 0x0F |
| 299 | |
| 300 | #define ROW25_COLUMN2_MINUTES_UNITS 0x0F |
| 301 | |
| 302 | #define ROW25_COLUMN3_MINUTES_TENS 0x07 |
| 303 | #define ROW25_COLUMN3_DELETE_PAGE 0x08 |
| 304 | |
| 305 | #define ROW25_COLUMN4_HOUR_UNITS 0x0F |
| 306 | |
| 307 | #define ROW25_COLUMN5_HOUR_TENS 0x03 |
| 308 | #define ROW25_COLUMN5_INSERT_HEADLINE 0x04 |
| 309 | #define ROW25_COLUMN5_INSERT_SUBTITLE 0x08 |
| 310 | |
| 311 | #define ROW25_COLUMN6_SUPPRESS_HEADER 0x01 |
| 312 | #define ROW25_COLUMN6_UPDATE_PAGE 0x02 |
| 313 | #define ROW25_COLUMN6_INTERRUPTED_SEQUENCE 0x04 |
| 314 | #define ROW25_COLUMN6_SUPPRESS_DISPLAY 0x08 |
| 315 | |
| 316 | #define ROW25_COLUMN7_SERIAL_MODE 0x01 |
| 317 | #define ROW25_COLUMN7_CHARACTER_SET 0x0E |
| 318 | |
| 319 | #define ROW25_COLUMN8_PAGE_HUNDREDS 0x07 |
| 320 | #define ROW25_COLUMN8_PAGE_NOT_FOUND 0x10 |
| 321 | |
| 322 | #define ROW25_COLUMN9_PAGE_BEING_LOOKED_FOR 0x20 |
| 323 | |
| 324 | #define ROW25_COLUMN0_TO_7_HAMMING_ERROR 0x10 |
| 325 | |
| 326 | /*****************************************************************************/ |
| 327 | /* Helper macros for extracting page, hour and minute digits */ |
| 328 | /*****************************************************************************/ |
| 329 | /* BYTE_POS 0 is at row 0, column 0, |
| 330 | BYTE_POS 1 is at row 0, column 1, |
| 331 | BYTE_POS 40 is at row 1, column 0, (with NUM_ROWS_PER_PAGE = 40) |
| 332 | BYTE_POS 41 is at row 1, column 1, (with NUM_ROWS_PER_PAGE = 40), |
| 333 | ... */ |
| 334 | #define ROW(BYTE_POS) (BYTE_POS / NUM_ROWS_PER_PAGE) |
| 335 | #define COLUMN(BYTE_POS) (BYTE_POS % NUM_ROWS_PER_PAGE) |
| 336 | |
| 337 | /*****************************************************************************/ |
| 338 | /* Helper macros for extracting page, hour and minute digits */ |
| 339 | /*****************************************************************************/ |
| 340 | /* Macros for extracting hundreds, tens and units of a page number which |
| 341 | must be in the range 0 ... 0x799. |
| 342 | Note that page is coded in hexadecimal, i.e. 0x123 means page 123. |
| 343 | page 0x.. means page 8.. */ |
| 344 | #define HUNDREDS_OF_PAGE(page) (((page) / 0x100) & 0x7) |
| 345 | #define TENS_OF_PAGE(page) (((page) / 0x10) & 0xF) |
| 346 | #define UNITS_OF_PAGE(page) ((page) & 0xF) |
| 347 | |
| 348 | /* Macros for extracting tens and units of a hour information which |
| 349 | must be in the range 0 ... 0x24. |
| 350 | Note that hour is coded in hexadecimal, i.e. 0x12 means 12 hours */ |
| 351 | #define TENS_OF_HOUR(hour) ((hour) / 0x10) |
| 352 | #define UNITS_OF_HOUR(hour) ((hour) & 0xF) |
| 353 | |
| 354 | /* Macros for extracting tens and units of a minute information which |
| 355 | must be in the range 0 ... 0x59. |
| 356 | Note that minute is coded in hexadecimal, i.e. 0x12 means 12 minutes */ |
| 357 | #define TENS_OF_MINUTE(minute) ((minute) / 0x10) |
| 358 | #define UNITS_OF_MINUTE(minute) ((minute) & 0xF) |
| 359 | |
| 360 | #define HOUR_MAX 0x23 |
| 361 | #define MINUTE_MAX 0x59 |
| 362 | #define PAGE_MAX 0x8FF |
| 363 | |
| 364 | #endif /* __SAA5246A_H__ */ |