drivers/media/video/saa5246a.h

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