390 lines · c
1/* SPDX-License-Identifier: GPL-2.0-only */2/*3 * FM Driver for Connectivity chip of Texas Instruments.4 * FM Common module header file5 *6 * Copyright (C) 2011 Texas Instruments7 */8 9#ifndef _FMDRV_COMMON_H10#define _FMDRV_COMMON_H11 12#define FM_ST_REG_TIMEOUT msecs_to_jiffies(6000) /* 6 sec */13#define FM_PKT_LOGICAL_CHAN_NUMBER 0x08 /* Logical channel 8 */14 15#define REG_RD 0x116#define REG_WR 0x017 18struct fm_reg_table {19 u8 opcode;20 u8 type;21 u8 *name;22};23 24#define STEREO_GET 025#define RSSI_LVL_GET 126#define IF_COUNT_GET 227#define FLAG_GET 328#define RDS_SYNC_GET 429#define RDS_DATA_GET 530#define FREQ_SET 1031#define AF_FREQ_SET 1132#define MOST_MODE_SET 1233#define MOST_BLEND_SET 1334#define DEMPH_MODE_SET 1435#define SEARCH_LVL_SET 1536#define BAND_SET 1637#define MUTE_STATUS_SET 1738#define RDS_PAUSE_LVL_SET 1839#define RDS_PAUSE_DUR_SET 1940#define RDS_MEM_SET 2041#define RDS_BLK_B_SET 2142#define RDS_MSK_B_SET 2243#define RDS_PI_MASK_SET 2344#define RDS_PI_SET 2445#define RDS_SYSTEM_SET 2546#define INT_MASK_SET 2647#define SEARCH_DIR_SET 2748#define VOLUME_SET 2849#define AUDIO_ENABLE_SET 2950#define PCM_MODE_SET 3051#define I2S_MODE_CONFIG_SET 3152#define POWER_SET 3253#define INTX_CONFIG_SET 3354#define PULL_EN_SET 3455#define HILO_SET 3556#define SWITCH2FREF 3657#define FREQ_DRIFT_REPORT 3758 59#define PCE_GET 4060#define FIRM_VER_GET 4161#define ASIC_VER_GET 4262#define ASIC_ID_GET 4363#define MAN_ID_GET 4464#define TUNER_MODE_SET 4565#define STOP_SEARCH 4666#define RDS_CNTRL_SET 4767 68#define WRITE_HARDWARE_REG 10069#define CODE_DOWNLOAD 10170#define RESET 10271 72#define FM_POWER_MODE 25473#define FM_INTERRUPT 25574 75/* Transmitter API */76 77#define CHANL_SET 5578#define CHANL_BW_SET 5679#define REF_SET 5780#define POWER_ENB_SET 9081#define POWER_ATT_SET 5882#define POWER_LEV_SET 5983#define AUDIO_DEV_SET 6084#define PILOT_DEV_SET 6185#define RDS_DEV_SET 6286#define TX_BAND_SET 6587#define PUPD_SET 9188#define AUDIO_IO_SET 6389#define PREMPH_SET 6490#define MONO_SET 6691#define MUTE 9292#define MPX_LMT_ENABLE 6793#define PI_SET 9394#define ECC_SET 6995#define PTY 7096#define AF 7197#define DISPLAY_MODE 7498#define RDS_REP_SET 7799#define RDS_CONFIG_DATA_SET 98100#define RDS_DATA_SET 99101#define RDS_DATA_ENB 94102#define TA_SET 78103#define TP_SET 79104#define DI_SET 80105#define MS_SET 81106#define PS_SCROLL_SPEED 82107#define TX_AUDIO_LEVEL_TEST 96108#define TX_AUDIO_LEVEL_TEST_THRESHOLD 73109#define TX_AUDIO_INPUT_LEVEL_RANGE_SET 54110#define RX_ANTENNA_SELECT 87111#define I2C_DEV_ADDR_SET 86112#define REF_ERR_CALIB_PARAM_SET 88113#define REF_ERR_CALIB_PERIODICITY_SET 89114#define SOC_INT_TRIGGER 52115#define SOC_AUDIO_PATH_SET 83116#define SOC_PCMI_OVERRIDE 84117#define SOC_I2S_OVERRIDE 85118#define RSSI_BLOCK_SCAN_FREQ_SET 95119#define RSSI_BLOCK_SCAN_START 97120#define RSSI_BLOCK_SCAN_DATA_GET 5121#define READ_FMANT_TUNE_VALUE 104122 123/* SKB helpers */124struct fm_skb_cb {125 __u8 fm_op;126 struct completion *completion;127};128 129#define fm_cb(skb) ((struct fm_skb_cb *)(skb->cb))130 131/* FM Channel-8 command message format */132struct fm_cmd_msg_hdr {133 __u8 hdr; /* Logical Channel-8 */134 __u8 len; /* Number of bytes follows */135 __u8 op; /* FM Opcode */136 __u8 rd_wr; /* Read/Write command */137 __u8 dlen; /* Length of payload */138} __attribute__ ((packed));139 140#define FM_CMD_MSG_HDR_SIZE 5 /* sizeof(struct fm_cmd_msg_hdr) */141 142/* FM Channel-8 event messgage format */143struct fm_event_msg_hdr {144 __u8 header; /* Logical Channel-8 */145 __u8 len; /* Number of bytes follows */146 __u8 status; /* Event status */147 __u8 num_fm_hci_cmds; /* Number of pkts the host allowed to send */148 __u8 op; /* FM Opcode */149 __u8 rd_wr; /* Read/Write command */150 __u8 dlen; /* Length of payload */151} __attribute__ ((packed));152 153#define FM_EVT_MSG_HDR_SIZE 7 /* sizeof(struct fm_event_msg_hdr) */154 155/* TI's magic number in firmware file */156#define FM_FW_FILE_HEADER_MAGIC 0x42535442157 158#define FM_ENABLE 1159#define FM_DISABLE 0160 161/* FLAG_GET register bits */162#define FM_FR_EVENT BIT(0)163#define FM_BL_EVENT BIT(1)164#define FM_RDS_EVENT BIT(2)165#define FM_BBLK_EVENT BIT(3)166#define FM_LSYNC_EVENT BIT(4)167#define FM_LEV_EVENT BIT(5)168#define FM_IFFR_EVENT BIT(6)169#define FM_PI_EVENT BIT(7)170#define FM_PD_EVENT BIT(8)171#define FM_STIC_EVENT BIT(9)172#define FM_MAL_EVENT BIT(10)173#define FM_POW_ENB_EVENT BIT(11)174 175/*176 * Firmware files of FM. ASIC ID and ASIC version will be appened to this,177 * later.178 */179#define FM_FMC_FW_FILE_START ("fmc_ch8")180#define FM_RX_FW_FILE_START ("fm_rx_ch8")181#define FM_TX_FW_FILE_START ("fm_tx_ch8")182 183#define FM_UNDEFINED_FREQ 0xFFFFFFFF184 185/* Band types */186#define FM_BAND_EUROPE_US 0187#define FM_BAND_JAPAN 1188 189/* Seek directions */190#define FM_SEARCH_DIRECTION_DOWN 0191#define FM_SEARCH_DIRECTION_UP 1192 193/* Tunner modes */194#define FM_TUNER_STOP_SEARCH_MODE 0195#define FM_TUNER_PRESET_MODE 1196#define FM_TUNER_AUTONOMOUS_SEARCH_MODE 2197#define FM_TUNER_AF_JUMP_MODE 3198 199/* Min and Max volume */200#define FM_RX_VOLUME_MIN 0201#define FM_RX_VOLUME_MAX 70202 203/* Volume gain step */204#define FM_RX_VOLUME_GAIN_STEP 0x370205 206/* Mute modes */207#define FM_MUTE_ON 0208#define FM_MUTE_OFF 1209#define FM_MUTE_ATTENUATE 2210 211#define FM_RX_UNMUTE_MODE 0x00212#define FM_RX_RF_DEP_MODE 0x01213#define FM_RX_AC_MUTE_MODE 0x02214#define FM_RX_HARD_MUTE_LEFT_MODE 0x04215#define FM_RX_HARD_MUTE_RIGHT_MODE 0x08216#define FM_RX_SOFT_MUTE_FORCE_MODE 0x10217 218/* RF dependent mute mode */219#define FM_RX_RF_DEPENDENT_MUTE_ON 1220#define FM_RX_RF_DEPENDENT_MUTE_OFF 0221 222/* RSSI threshold min and max */223#define FM_RX_RSSI_THRESHOLD_MIN -128224#define FM_RX_RSSI_THRESHOLD_MAX 127225 226/* Stereo/Mono mode */227#define FM_STEREO_MODE 0228#define FM_MONO_MODE 1229#define FM_STEREO_SOFT_BLEND 1230 231/* FM RX De-emphasis filter modes */232#define FM_RX_EMPHASIS_FILTER_50_USEC 0233#define FM_RX_EMPHASIS_FILTER_75_USEC 1234 235/* FM RDS modes */236#define FM_RDS_DISABLE 0237#define FM_RDS_ENABLE 1238 239#define FM_NO_PI_CODE 0240 241/* FM and RX RDS block enable/disable */242#define FM_RX_PWR_SET_FM_ON_RDS_OFF 0x1243#define FM_RX_PWR_SET_FM_AND_RDS_BLK_ON 0x3244#define FM_RX_PWR_SET_FM_AND_RDS_BLK_OFF 0x0245 246/* RX RDS */247#define FM_RX_RDS_FLUSH_FIFO 0x1248#define FM_RX_RDS_FIFO_THRESHOLD 64 /* tuples */249#define FM_RDS_BLK_SIZE 3 /* 3 bytes */250 251/* RDS block types */252#define FM_RDS_BLOCK_A 0253#define FM_RDS_BLOCK_B 1254#define FM_RDS_BLOCK_C 2255#define FM_RDS_BLOCK_Ctag 3256#define FM_RDS_BLOCK_D 4257#define FM_RDS_BLOCK_E 5258 259#define FM_RDS_BLK_IDX_A 0260#define FM_RDS_BLK_IDX_B 1261#define FM_RDS_BLK_IDX_C 2262#define FM_RDS_BLK_IDX_D 3263#define FM_RDS_BLK_IDX_UNKNOWN 0xF0264 265#define FM_RDS_STATUS_ERR_MASK 0x18266 267/*268 * Represents an RDS group type & version.269 * There are 15 groups, each group has 2 versions: A and B.270 */271#define FM_RDS_GROUP_TYPE_MASK_0A BIT(0)272#define FM_RDS_GROUP_TYPE_MASK_0B BIT(1)273#define FM_RDS_GROUP_TYPE_MASK_1A BIT(2)274#define FM_RDS_GROUP_TYPE_MASK_1B BIT(3)275#define FM_RDS_GROUP_TYPE_MASK_2A BIT(4)276#define FM_RDS_GROUP_TYPE_MASK_2B BIT(5)277#define FM_RDS_GROUP_TYPE_MASK_3A BIT(6)278#define FM_RDS_GROUP_TYPE_MASK_3B BIT(7)279#define FM_RDS_GROUP_TYPE_MASK_4A BIT(8)280#define FM_RDS_GROUP_TYPE_MASK_4B BIT(9)281#define FM_RDS_GROUP_TYPE_MASK_5A BIT(10)282#define FM_RDS_GROUP_TYPE_MASK_5B BIT(11)283#define FM_RDS_GROUP_TYPE_MASK_6A BIT(12)284#define FM_RDS_GROUP_TYPE_MASK_6B BIT(13)285#define FM_RDS_GROUP_TYPE_MASK_7A BIT(14)286#define FM_RDS_GROUP_TYPE_MASK_7B BIT(15)287#define FM_RDS_GROUP_TYPE_MASK_8A BIT(16)288#define FM_RDS_GROUP_TYPE_MASK_8B BIT(17)289#define FM_RDS_GROUP_TYPE_MASK_9A BIT(18)290#define FM_RDS_GROUP_TYPE_MASK_9B BIT(19)291#define FM_RDS_GROUP_TYPE_MASK_10A BIT(20)292#define FM_RDS_GROUP_TYPE_MASK_10B BIT(21)293#define FM_RDS_GROUP_TYPE_MASK_11A BIT(22)294#define FM_RDS_GROUP_TYPE_MASK_11B BIT(23)295#define FM_RDS_GROUP_TYPE_MASK_12A BIT(24)296#define FM_RDS_GROUP_TYPE_MASK_12B BIT(25)297#define FM_RDS_GROUP_TYPE_MASK_13A BIT(26)298#define FM_RDS_GROUP_TYPE_MASK_13B BIT(27)299#define FM_RDS_GROUP_TYPE_MASK_14A BIT(28)300#define FM_RDS_GROUP_TYPE_MASK_14B BIT(29)301#define FM_RDS_GROUP_TYPE_MASK_15A BIT(30)302#define FM_RDS_GROUP_TYPE_MASK_15B BIT(31)303 304/* RX Alternate Frequency info */305#define FM_RDS_MIN_AF 1306#define FM_RDS_MAX_AF 204307#define FM_RDS_MAX_AF_JAPAN 140308#define FM_RDS_1_AF_FOLLOWS 225309#define FM_RDS_25_AF_FOLLOWS 249310 311/* RDS system type (RDS/RBDS) */312#define FM_RDS_SYSTEM_RDS 0313#define FM_RDS_SYSTEM_RBDS 1314 315/* AF on/off */316#define FM_RX_RDS_AF_SWITCH_MODE_ON 1317#define FM_RX_RDS_AF_SWITCH_MODE_OFF 0318 319/* Retry count when interrupt process goes wrong */320#define FM_IRQ_TIMEOUT_RETRY_MAX 5 /* 5 times */321 322/* Audio IO set values */323#define FM_RX_AUDIO_ENABLE_I2S 0x01324#define FM_RX_AUDIO_ENABLE_ANALOG 0x02325#define FM_RX_AUDIO_ENABLE_I2S_AND_ANALOG 0x03326#define FM_RX_AUDIO_ENABLE_DISABLE 0x00327 328/* HI/LO set values */329#define FM_RX_IFFREQ_TO_HI_SIDE 0x0330#define FM_RX_IFFREQ_TO_LO_SIDE 0x1331#define FM_RX_IFFREQ_HILO_AUTOMATIC 0x2332 333/*334 * Default RX mode configuration. Chip will be configured335 * with this default values after loading RX firmware.336 */337#define FM_DEFAULT_RX_VOLUME 10338#define FM_DEFAULT_RSSI_THRESHOLD 3339 340/* Range for TX power level in units for dB/uV */341#define FM_PWR_LVL_LOW 91342#define FM_PWR_LVL_HIGH 122343 344/* Chip specific default TX power level value */345#define FM_PWR_LVL_DEF 4346 347/* FM TX Pre-emphasis filter values */348#define FM_TX_PREEMPH_OFF 1349#define FM_TX_PREEMPH_50US 0350#define FM_TX_PREEMPH_75US 2351 352/* FM TX antenna impedance values */353#define FM_TX_ANT_IMP_50 0354#define FM_TX_ANT_IMP_200 1355#define FM_TX_ANT_IMP_500 2356 357/* Functions exported by FM common sub-module */358int fmc_prepare(struct fmdev *);359int fmc_release(struct fmdev *);360 361void fmc_update_region_info(struct fmdev *, u8);362int fmc_send_cmd(struct fmdev *, u8, u16,363 void *, unsigned int, void *, int *);364int fmc_is_rds_data_available(struct fmdev *, struct file *,365 struct poll_table_struct *);366int fmc_transfer_rds_from_internal_buff(struct fmdev *, struct file *,367 u8 __user *, size_t);368 369int fmc_set_freq(struct fmdev *, u32);370int fmc_set_mode(struct fmdev *, u8);371int fmc_set_region(struct fmdev *, u8);372int fmc_set_mute_mode(struct fmdev *, u8);373int fmc_set_stereo_mono(struct fmdev *, u16);374int fmc_set_rds_mode(struct fmdev *, u8);375 376int fmc_get_freq(struct fmdev *, u32 *);377int fmc_get_region(struct fmdev *, u8 *);378int fmc_get_mode(struct fmdev *, u8 *);379 380/*381 * channel spacing382 */383#define FM_CHANNEL_SPACING_50KHZ 1384#define FM_CHANNEL_SPACING_100KHZ 2385#define FM_CHANNEL_SPACING_200KHZ 4386#define FM_FREQ_MUL 50387 388#endif389 390