2 * FM Driver for Connectivity chip of Texas Instruments.
4 * Common header for all FM driver sub-modules.
6 * Copyright (C) 2011 Texas Instruments
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 #include <linux/skbuff.h>
27 #include <linux/interrupt.h>
28 #include <sound/core.h>
29 #include <sound/initval.h>
30 #include <linux/timer.h>
31 #include <linux/version.h>
32 #include <media/v4l2-ioctl.h>
33 #include <media/v4l2-common.h>
34 #include <media/v4l2-ctrls.h>
36 #define FM_DRV_VERSION "0.10"
37 /* Should match with FM_DRV_VERSION */
38 #define FM_DRV_RADIO_VERSION KERNEL_VERSION(0, 0, 1)
39 #define FM_DRV_NAME "ti_fmdrv"
40 #define FM_DRV_CARD_SHORT_NAME "TI FM Radio"
41 #define FM_DRV_CARD_LONG_NAME "Texas Instruments FM Radio"
44 #define FM_INTTASK_RUNNING 0
45 #define FM_INTTASK_SCHEDULE_PENDING 1
46 #define FM_FW_DW_INPROGRESS 2
47 #define FM_CORE_READY 3
48 #define FM_CORE_TRANSPORT_READY 4
49 #define FM_AF_SWITCH_INPROGRESS 5
50 #define FM_CORE_TX_XMITING 6
52 #define FM_TUNE_COMPLETE 0x1
53 #define FM_BAND_LIMIT 0x2
55 #define FM_DRV_TX_TIMEOUT (5*HZ) /* 5 seconds */
56 #define FM_DRV_RX_SEEK_TIMEOUT (20*HZ) /* 20 seconds */
58 #define fmerr(format, ...) \
59 printk(KERN_ERR "fmdrv: " format, ## __VA_ARGS__)
60 #define fmwarn(format, ...) \
61 printk(KERN_WARNING "fmdrv: " format, ##__VA_ARGS__)
63 #define fmdbg(format, ...) \
64 printk(KERN_DEBUG "fmdrv: " format, ## __VA_ARGS__)
66 #define fmdbg(format, ...)
75 #define FM_RX_RDS_INFO_FIELD_MAX 8 /* 4 Group * 2 Bytes */
77 /* RX RDS data format */
78 struct fm_rdsdata_format
{
81 u8 buff
[FM_RX_RDS_INFO_FIELD_MAX
];
103 /* FM region (Europe/US, Japan) info */
111 typedef void (*int_handler_prototype
) (struct fmdev
*);
113 /* FM Interrupt processing related info */
116 u16 flag
; /* FM interrupt flag */
117 u16 mask
; /* FM interrupt mask */
118 /* Interrupt process timeout handler */
119 struct timer_list timer
;
121 int_handler_prototype
*handlers
;
126 u8 flag
; /* RX RDS on/off status */
127 u8 last_blk_idx
; /* Last received RDS block */
130 wait_queue_head_t read_queue
;
131 u32 buf_size
; /* Size is always multiple of 3 */
137 #define FM_RDS_MAX_AF_LIST 25
140 * Current RX channel Alternate Frequency cache.
141 * This info is used to switch to other freq (AF)
142 * when current channel signal strengh is below RSSI threshold.
144 struct tuned_station_info
{
146 u32 af_cache
[FM_RDS_MAX_AF_LIST
];
151 /* FM RX mode info */
153 struct region_info region
; /* Current selected band */
154 u32 freq
; /* Current RX frquency */
155 u8 mute_mode
; /* Current mute mode */
156 u8 deemphasis_mode
; /* Current deemphasis mode */
157 /* RF dependent soft mute mode */
159 u16 volume
; /* Current volume level */
160 u16 rssi_threshold
; /* Current RSSI threshold level */
161 /* Holds the index of the current AF jump */
163 /* Will hold the frequency before the jump */
164 u32 freq_before_jump
;
165 u8 rds_mode
; /* RDS operation mode (RDS/RDBS) */
166 u8 af_mode
; /* Alternate frequency on/off */
167 struct tuned_station_info stat_info
;
171 #define FMTX_RDS_TXT_STR_SIZE 25
175 * @ text_type: is the text following PS or RT
176 * @ text: radio text string which could either be PS or RT
177 * @ af_freq: alternate frequency for Tx
178 * TODO: to be declared in application
182 u8 text
[FMTX_RDS_TXT_STR_SIZE
];
189 * @ pwr_lvl: Power Level of the Transmission from mixer control
190 * @ xmit_state: Transmission state = Updated locally upon Start/Stop
191 * @ audio_io: i2S/Analog
192 * @ tx_frq: Transmission frequency
205 /* FM driver operation structure */
207 struct video_device
*radio_dev
; /* V4L2 video device pointer */
208 struct snd_card
*card
; /* Card which holds FM mixer controls */
210 spinlock_t rds_buff_lock
; /* To protect access to RDS buffer */
211 spinlock_t resp_skb_lock
; /* To protect access to received SKB */
213 long flag
; /* FM driver state machine info */
214 u8 streg_cbdata
; /* status of ST registration */
216 struct sk_buff_head rx_q
; /* RX queue */
217 struct tasklet_struct rx_task
; /* RX Tasklet */
219 struct sk_buff_head tx_q
; /* TX queue */
220 struct tasklet_struct tx_task
; /* TX Tasklet */
221 unsigned long last_tx_jiffies
; /* Timestamp of last pkt sent */
222 atomic_t tx_cnt
; /* Number of packets can send at a time */
224 struct sk_buff
*resp_skb
; /* Response from the chip */
225 /* Main task completion handler */
226 struct completion maintask_comp
;
227 /* Opcode of last command sent to the chip */
229 /* Handler used for wakeup when response packet is received */
230 struct completion
*resp_comp
;
231 struct fm_irq irq_info
;
232 u8 curr_fmmode
; /* Current FM chip mode (TX, RX, OFF) */
233 struct fm_rx rx
; /* FM receiver info */
234 struct fmtx_data tx_data
;
236 /* V4L2 ctrl framwork handler*/
237 struct v4l2_ctrl_handler ctrl_handler
;
239 /* For core assisted locking */