saa5246a.h 12 KB

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