fmdrv_common.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
  1. /*
  2. * FM Driver for Connectivity chip of Texas Instruments.
  3. * FM Common module header file
  4. *
  5. * Copyright (C) 2011 Texas Instruments
  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 version 2 as
  9. * published by the Free Software Foundation.
  10. *
  11. * This program is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. */
  17. #ifndef _FMDRV_COMMON_H
  18. #define _FMDRV_COMMON_H
  19. #define FM_ST_REG_TIMEOUT msecs_to_jiffies(6000) /* 6 sec */
  20. #define FM_PKT_LOGICAL_CHAN_NUMBER 0x08 /* Logical channel 8 */
  21. #define REG_RD 0x1
  22. #define REG_WR 0x0
  23. struct fm_reg_table {
  24. u8 opcode;
  25. u8 type;
  26. u8 *name;
  27. };
  28. #define STEREO_GET 0
  29. #define RSSI_LVL_GET 1
  30. #define IF_COUNT_GET 2
  31. #define FLAG_GET 3
  32. #define RDS_SYNC_GET 4
  33. #define RDS_DATA_GET 5
  34. #define FREQ_SET 10
  35. #define AF_FREQ_SET 11
  36. #define MOST_MODE_SET 12
  37. #define MOST_BLEND_SET 13
  38. #define DEMPH_MODE_SET 14
  39. #define SEARCH_LVL_SET 15
  40. #define BAND_SET 16
  41. #define MUTE_STATUS_SET 17
  42. #define RDS_PAUSE_LVL_SET 18
  43. #define RDS_PAUSE_DUR_SET 19
  44. #define RDS_MEM_SET 20
  45. #define RDS_BLK_B_SET 21
  46. #define RDS_MSK_B_SET 22
  47. #define RDS_PI_MASK_SET 23
  48. #define RDS_PI_SET 24
  49. #define RDS_SYSTEM_SET 25
  50. #define INT_MASK_SET 26
  51. #define SEARCH_DIR_SET 27
  52. #define VOLUME_SET 28
  53. #define AUDIO_ENABLE_SET 29
  54. #define PCM_MODE_SET 30
  55. #define I2S_MODE_CONFIG_SET 31
  56. #define POWER_SET 32
  57. #define INTX_CONFIG_SET 33
  58. #define PULL_EN_SET 34
  59. #define HILO_SET 35
  60. #define SWITCH2FREF 36
  61. #define FREQ_DRIFT_REPORT 37
  62. #define PCE_GET 40
  63. #define FIRM_VER_GET 41
  64. #define ASIC_VER_GET 42
  65. #define ASIC_ID_GET 43
  66. #define MAN_ID_GET 44
  67. #define TUNER_MODE_SET 45
  68. #define STOP_SEARCH 46
  69. #define RDS_CNTRL_SET 47
  70. #define WRITE_HARDWARE_REG 100
  71. #define CODE_DOWNLOAD 101
  72. #define RESET 102
  73. #define FM_POWER_MODE 254
  74. #define FM_INTERRUPT 255
  75. /* Transmitter API */
  76. #define CHANL_SET 55
  77. #define CHANL_BW_SET 56
  78. #define REF_SET 57
  79. #define POWER_ENB_SET 90
  80. #define POWER_ATT_SET 58
  81. #define POWER_LEV_SET 59
  82. #define AUDIO_DEV_SET 60
  83. #define PILOT_DEV_SET 61
  84. #define RDS_DEV_SET 62
  85. #define TX_BAND_SET 65
  86. #define PUPD_SET 91
  87. #define AUDIO_IO_SET 63
  88. #define PREMPH_SET 64
  89. #define MONO_SET 66
  90. #define MUTE 92
  91. #define MPX_LMT_ENABLE 67
  92. #define PI_SET 93
  93. #define ECC_SET 69
  94. #define PTY 70
  95. #define AF 71
  96. #define DISPLAY_MODE 74
  97. #define RDS_REP_SET 77
  98. #define RDS_CONFIG_DATA_SET 98
  99. #define RDS_DATA_SET 99
  100. #define RDS_DATA_ENB 94
  101. #define TA_SET 78
  102. #define TP_SET 79
  103. #define DI_SET 80
  104. #define MS_SET 81
  105. #define PS_SCROLL_SPEED 82
  106. #define TX_AUDIO_LEVEL_TEST 96
  107. #define TX_AUDIO_LEVEL_TEST_THRESHOLD 73
  108. #define TX_AUDIO_INPUT_LEVEL_RANGE_SET 54
  109. #define RX_ANTENNA_SELECT 87
  110. #define I2C_DEV_ADDR_SET 86
  111. #define REF_ERR_CALIB_PARAM_SET 88
  112. #define REF_ERR_CALIB_PERIODICITY_SET 89
  113. #define SOC_INT_TRIGGER 52
  114. #define SOC_AUDIO_PATH_SET 83
  115. #define SOC_PCMI_OVERRIDE 84
  116. #define SOC_I2S_OVERRIDE 85
  117. #define RSSI_BLOCK_SCAN_FREQ_SET 95
  118. #define RSSI_BLOCK_SCAN_START 97
  119. #define RSSI_BLOCK_SCAN_DATA_GET 5
  120. #define READ_FMANT_TUNE_VALUE 104
  121. /* SKB helpers */
  122. struct fm_skb_cb {
  123. __u8 fm_op;
  124. struct completion *completion;
  125. };
  126. #define fm_cb(skb) ((struct fm_skb_cb *)(skb->cb))
  127. /* FM Channel-8 command message format */
  128. struct fm_cmd_msg_hdr {
  129. __u8 hdr; /* Logical Channel-8 */
  130. __u8 len; /* Number of bytes follows */
  131. __u8 op; /* FM Opcode */
  132. __u8 rd_wr; /* Read/Write command */
  133. __u8 dlen; /* Length of payload */
  134. } __attribute__ ((packed));
  135. #define FM_CMD_MSG_HDR_SIZE 5 /* sizeof(struct fm_cmd_msg_hdr) */
  136. /* FM Channel-8 event messgage format */
  137. struct fm_event_msg_hdr {
  138. __u8 header; /* Logical Channel-8 */
  139. __u8 len; /* Number of bytes follows */
  140. __u8 status; /* Event status */
  141. __u8 num_fm_hci_cmds; /* Number of pkts the host allowed to send */
  142. __u8 op; /* FM Opcode */
  143. __u8 rd_wr; /* Read/Write command */
  144. __u8 dlen; /* Length of payload */
  145. } __attribute__ ((packed));
  146. #define FM_EVT_MSG_HDR_SIZE 7 /* sizeof(struct fm_event_msg_hdr) */
  147. /* TI's magic number in firmware file */
  148. #define FM_FW_FILE_HEADER_MAGIC 0x42535442
  149. #define FM_ENABLE 1
  150. #define FM_DISABLE 0
  151. /* FLAG_GET register bits */
  152. #define FM_FR_EVENT (1 << 0)
  153. #define FM_BL_EVENT (1 << 1)
  154. #define FM_RDS_EVENT (1 << 2)
  155. #define FM_BBLK_EVENT (1 << 3)
  156. #define FM_LSYNC_EVENT (1 << 4)
  157. #define FM_LEV_EVENT (1 << 5)
  158. #define FM_IFFR_EVENT (1 << 6)
  159. #define FM_PI_EVENT (1 << 7)
  160. #define FM_PD_EVENT (1 << 8)
  161. #define FM_STIC_EVENT (1 << 9)
  162. #define FM_MAL_EVENT (1 << 10)
  163. #define FM_POW_ENB_EVENT (1 << 11)
  164. /*
  165. * Firmware files of FM. ASIC ID and ASIC version will be appened to this,
  166. * later.
  167. */
  168. #define FM_FMC_FW_FILE_START ("fmc_ch8")
  169. #define FM_RX_FW_FILE_START ("fm_rx_ch8")
  170. #define FM_TX_FW_FILE_START ("fm_tx_ch8")
  171. #define FM_UNDEFINED_FREQ 0xFFFFFFFF
  172. /* Band types */
  173. #define FM_BAND_EUROPE_US 0
  174. #define FM_BAND_JAPAN 1
  175. /* Seek directions */
  176. #define FM_SEARCH_DIRECTION_DOWN 0
  177. #define FM_SEARCH_DIRECTION_UP 1
  178. /* Tunner modes */
  179. #define FM_TUNER_STOP_SEARCH_MODE 0
  180. #define FM_TUNER_PRESET_MODE 1
  181. #define FM_TUNER_AUTONOMOUS_SEARCH_MODE 2
  182. #define FM_TUNER_AF_JUMP_MODE 3
  183. /* Min and Max volume */
  184. #define FM_RX_VOLUME_MIN 0
  185. #define FM_RX_VOLUME_MAX 70
  186. /* Volume gain step */
  187. #define FM_RX_VOLUME_GAIN_STEP 0x370
  188. /* Mute modes */
  189. #define FM_MUTE_ON 0
  190. #define FM_MUTE_OFF 1
  191. #define FM_MUTE_ATTENUATE 2
  192. #define FM_RX_UNMUTE_MODE 0x00
  193. #define FM_RX_RF_DEP_MODE 0x01
  194. #define FM_RX_AC_MUTE_MODE 0x02
  195. #define FM_RX_HARD_MUTE_LEFT_MODE 0x04
  196. #define FM_RX_HARD_MUTE_RIGHT_MODE 0x08
  197. #define FM_RX_SOFT_MUTE_FORCE_MODE 0x10
  198. /* RF dependent mute mode */
  199. #define FM_RX_RF_DEPENDENT_MUTE_ON 1
  200. #define FM_RX_RF_DEPENDENT_MUTE_OFF 0
  201. /* RSSI threshold min and max */
  202. #define FM_RX_RSSI_THRESHOLD_MIN -128
  203. #define FM_RX_RSSI_THRESHOLD_MAX 127
  204. /* Stereo/Mono mode */
  205. #define FM_STEREO_MODE 0
  206. #define FM_MONO_MODE 1
  207. #define FM_STEREO_SOFT_BLEND 1
  208. /* FM RX De-emphasis filter modes */
  209. #define FM_RX_EMPHASIS_FILTER_50_USEC 0
  210. #define FM_RX_EMPHASIS_FILTER_75_USEC 1
  211. /* FM RDS modes */
  212. #define FM_RDS_DISABLE 0
  213. #define FM_RDS_ENABLE 1
  214. #define FM_NO_PI_CODE 0
  215. /* FM and RX RDS block enable/disable */
  216. #define FM_RX_PWR_SET_FM_ON_RDS_OFF 0x1
  217. #define FM_RX_PWR_SET_FM_AND_RDS_BLK_ON 0x3
  218. #define FM_RX_PWR_SET_FM_AND_RDS_BLK_OFF 0x0
  219. /* RX RDS */
  220. #define FM_RX_RDS_FLUSH_FIFO 0x1
  221. #define FM_RX_RDS_FIFO_THRESHOLD 64 /* tuples */
  222. #define FM_RDS_BLK_SIZE 3 /* 3 bytes */
  223. /* RDS block types */
  224. #define FM_RDS_BLOCK_A 0
  225. #define FM_RDS_BLOCK_B 1
  226. #define FM_RDS_BLOCK_C 2
  227. #define FM_RDS_BLOCK_Ctag 3
  228. #define FM_RDS_BLOCK_D 4
  229. #define FM_RDS_BLOCK_E 5
  230. #define FM_RDS_BLK_IDX_A 0
  231. #define FM_RDS_BLK_IDX_B 1
  232. #define FM_RDS_BLK_IDX_C 2
  233. #define FM_RDS_BLK_IDX_D 3
  234. #define FM_RDS_BLK_IDX_UNKNOWN 0xF0
  235. #define FM_RDS_STATUS_ERR_MASK 0x18
  236. /*
  237. * Represents an RDS group type & version.
  238. * There are 15 groups, each group has 2 versions: A and B.
  239. */
  240. #define FM_RDS_GROUP_TYPE_MASK_0A ((unsigned long)1<<0)
  241. #define FM_RDS_GROUP_TYPE_MASK_0B ((unsigned long)1<<1)
  242. #define FM_RDS_GROUP_TYPE_MASK_1A ((unsigned long)1<<2)
  243. #define FM_RDS_GROUP_TYPE_MASK_1B ((unsigned long)1<<3)
  244. #define FM_RDS_GROUP_TYPE_MASK_2A ((unsigned long)1<<4)
  245. #define FM_RDS_GROUP_TYPE_MASK_2B ((unsigned long)1<<5)
  246. #define FM_RDS_GROUP_TYPE_MASK_3A ((unsigned long)1<<6)
  247. #define FM_RDS_GROUP_TYPE_MASK_3B ((unsigned long)1<<7)
  248. #define FM_RDS_GROUP_TYPE_MASK_4A ((unsigned long)1<<8)
  249. #define FM_RDS_GROUP_TYPE_MASK_4B ((unsigned long)1<<9)
  250. #define FM_RDS_GROUP_TYPE_MASK_5A ((unsigned long)1<<10)
  251. #define FM_RDS_GROUP_TYPE_MASK_5B ((unsigned long)1<<11)
  252. #define FM_RDS_GROUP_TYPE_MASK_6A ((unsigned long)1<<12)
  253. #define FM_RDS_GROUP_TYPE_MASK_6B ((unsigned long)1<<13)
  254. #define FM_RDS_GROUP_TYPE_MASK_7A ((unsigned long)1<<14)
  255. #define FM_RDS_GROUP_TYPE_MASK_7B ((unsigned long)1<<15)
  256. #define FM_RDS_GROUP_TYPE_MASK_8A ((unsigned long)1<<16)
  257. #define FM_RDS_GROUP_TYPE_MASK_8B ((unsigned long)1<<17)
  258. #define FM_RDS_GROUP_TYPE_MASK_9A ((unsigned long)1<<18)
  259. #define FM_RDS_GROUP_TYPE_MASK_9B ((unsigned long)1<<19)
  260. #define FM_RDS_GROUP_TYPE_MASK_10A ((unsigned long)1<<20)
  261. #define FM_RDS_GROUP_TYPE_MASK_10B ((unsigned long)1<<21)
  262. #define FM_RDS_GROUP_TYPE_MASK_11A ((unsigned long)1<<22)
  263. #define FM_RDS_GROUP_TYPE_MASK_11B ((unsigned long)1<<23)
  264. #define FM_RDS_GROUP_TYPE_MASK_12A ((unsigned long)1<<24)
  265. #define FM_RDS_GROUP_TYPE_MASK_12B ((unsigned long)1<<25)
  266. #define FM_RDS_GROUP_TYPE_MASK_13A ((unsigned long)1<<26)
  267. #define FM_RDS_GROUP_TYPE_MASK_13B ((unsigned long)1<<27)
  268. #define FM_RDS_GROUP_TYPE_MASK_14A ((unsigned long)1<<28)
  269. #define FM_RDS_GROUP_TYPE_MASK_14B ((unsigned long)1<<29)
  270. #define FM_RDS_GROUP_TYPE_MASK_15A ((unsigned long)1<<30)
  271. #define FM_RDS_GROUP_TYPE_MASK_15B ((unsigned long)1<<31)
  272. /* RX Alternate Frequency info */
  273. #define FM_RDS_MIN_AF 1
  274. #define FM_RDS_MAX_AF 204
  275. #define FM_RDS_MAX_AF_JAPAN 140
  276. #define FM_RDS_1_AF_FOLLOWS 225
  277. #define FM_RDS_25_AF_FOLLOWS 249
  278. /* RDS system type (RDS/RBDS) */
  279. #define FM_RDS_SYSTEM_RDS 0
  280. #define FM_RDS_SYSTEM_RBDS 1
  281. /* AF on/off */
  282. #define FM_RX_RDS_AF_SWITCH_MODE_ON 1
  283. #define FM_RX_RDS_AF_SWITCH_MODE_OFF 0
  284. /* Retry count when interrupt process goes wrong */
  285. #define FM_IRQ_TIMEOUT_RETRY_MAX 5 /* 5 times */
  286. /* Audio IO set values */
  287. #define FM_RX_AUDIO_ENABLE_I2S 0x01
  288. #define FM_RX_AUDIO_ENABLE_ANALOG 0x02
  289. #define FM_RX_AUDIO_ENABLE_I2S_AND_ANALOG 0x03
  290. #define FM_RX_AUDIO_ENABLE_DISABLE 0x00
  291. /* HI/LO set values */
  292. #define FM_RX_IFFREQ_TO_HI_SIDE 0x0
  293. #define FM_RX_IFFREQ_TO_LO_SIDE 0x1
  294. #define FM_RX_IFFREQ_HILO_AUTOMATIC 0x2
  295. /*
  296. * Default RX mode configuration. Chip will be configured
  297. * with this default values after loading RX firmware.
  298. */
  299. #define FM_DEFAULT_RX_VOLUME 10
  300. #define FM_DEFAULT_RSSI_THRESHOLD 3
  301. /* Range for TX power level in units for dB/uV */
  302. #define FM_PWR_LVL_LOW 91
  303. #define FM_PWR_LVL_HIGH 122
  304. /* Chip specific default TX power level value */
  305. #define FM_PWR_LVL_DEF 4
  306. /* FM TX Pre-emphasis filter values */
  307. #define FM_TX_PREEMPH_OFF 1
  308. #define FM_TX_PREEMPH_50US 0
  309. #define FM_TX_PREEMPH_75US 2
  310. /* FM TX antenna impedance values */
  311. #define FM_TX_ANT_IMP_50 0
  312. #define FM_TX_ANT_IMP_200 1
  313. #define FM_TX_ANT_IMP_500 2
  314. /* Functions exported by FM common sub-module */
  315. int fmc_prepare(struct fmdev *);
  316. int fmc_release(struct fmdev *);
  317. void fmc_update_region_info(struct fmdev *, u8);
  318. int fmc_send_cmd(struct fmdev *, u8, u16,
  319. void *, unsigned int, void *, int *);
  320. int fmc_is_rds_data_available(struct fmdev *, struct file *,
  321. struct poll_table_struct *);
  322. int fmc_transfer_rds_from_internal_buff(struct fmdev *, struct file *,
  323. u8 __user *, size_t);
  324. int fmc_set_freq(struct fmdev *, u32);
  325. int fmc_set_mode(struct fmdev *, u8);
  326. int fmc_set_region(struct fmdev *, u8);
  327. int fmc_set_mute_mode(struct fmdev *, u8);
  328. int fmc_set_stereo_mono(struct fmdev *, u16);
  329. int fmc_set_rds_mode(struct fmdev *, u8);
  330. int fmc_get_freq(struct fmdev *, u32 *);
  331. int fmc_get_region(struct fmdev *, u8 *);
  332. int fmc_get_mode(struct fmdev *, u8 *);
  333. /*
  334. * channel spacing
  335. */
  336. #define FM_CHANNEL_SPACING_50KHZ 1
  337. #define FM_CHANNEL_SPACING_100KHZ 2
  338. #define FM_CHANNEL_SPACING_200KHZ 4
  339. #define FM_FREQ_MUL 50
  340. #endif