[mirror_ubuntu-artful-kernel.git] / drivers / media / radio / si470x / radio-si470x.h

/*
 *  drivers/media/radio/si470x/radio-si470x.h
 *
 *  Driver for radios with Silicon Labs Si470x FM Radio Receivers
 *
 *  Copyright (c) 2009 Tobias Lorenz <tobias.lorenz@gmx.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */


/* driver definitions */
#define DRIVER_NAME "radio-si470x"


/* kernel includes */
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/sched.h>
#include <linux/slab.h>
#include <linux/input.h>
#include <linux/videodev2.h>
#include <linux/mutex.h>
#include <media/v4l2-common.h>
#include <media/v4l2-ioctl.h>
#include <media/v4l2-ctrls.h>
#include <media/v4l2-event.h>
#include <media/v4l2-device.h>
#include <asm/unaligned.h>


/**************************************************************************
 * Register Definitions
 **************************************************************************/
#define RADIO_REGISTER_SIZE	2	/* 16 register bit width */
#define RADIO_REGISTER_NUM	16	/* DEVICEID   ... RDSD */
#define RDS_REGISTER_NUM	6	/* STATUSRSSI ... RDSD */

#define DEVICEID		0	/* Device ID */
#define DEVICEID_PN		0xf000	/* bits 15..12: Part Number */
#define DEVICEID_MFGID		0x0fff	/* bits 11..00: Manufacturer ID */

#define SI_CHIPID		1	/* Chip ID */
#define SI_CHIPID_REV		0xfc00	/* bits 15..10: Chip Version */
#define SI_CHIPID_DEV		0x0200	/* bits 09..09: Device */
#define SI_CHIPID_FIRMWARE	0x01ff	/* bits 08..00: Firmware Version */

#define POWERCFG		2	/* Power Configuration */
#define POWERCFG_DSMUTE		0x8000	/* bits 15..15: Softmute Disable */
#define POWERCFG_DMUTE		0x4000	/* bits 14..14: Mute Disable */
#define POWERCFG_MONO		0x2000	/* bits 13..13: Mono Select */
#define POWERCFG_RDSM		0x0800	/* bits 11..11: RDS Mode (Si4701 only) */
#define POWERCFG_SKMODE		0x0400	/* bits 10..10: Seek Mode */
#define POWERCFG_SEEKUP		0x0200	/* bits 09..09: Seek Direction */
#define POWERCFG_SEEK		0x0100	/* bits 08..08: Seek */
#define POWERCFG_DISABLE	0x0040	/* bits 06..06: Powerup Disable */
#define POWERCFG_ENABLE		0x0001	/* bits 00..00: Powerup Enable */

#define CHANNEL			3	/* Channel */
#define CHANNEL_TUNE		0x8000	/* bits 15..15: Tune */
#define CHANNEL_CHAN		0x03ff	/* bits 09..00: Channel Select */

#define SYSCONFIG1		4	/* System Configuration 1 */
#define SYSCONFIG1_RDSIEN	0x8000	/* bits 15..15: RDS Interrupt Enable (Si4701 only) */
#define SYSCONFIG1_STCIEN	0x4000	/* bits 14..14: Seek/Tune Complete Interrupt Enable */
#define SYSCONFIG1_RDS		0x1000	/* bits 12..12: RDS Enable (Si4701 only) */
#define SYSCONFIG1_DE		0x0800	/* bits 11..11: De-emphasis (0=75us 1=50us) */
#define SYSCONFIG1_AGCD		0x0400	/* bits 10..10: AGC Disable */
#define SYSCONFIG1_BLNDADJ	0x00c0	/* bits 07..06: Stereo/Mono Blend Level Adjustment */
#define SYSCONFIG1_GPIO3	0x0030	/* bits 05..04: General Purpose I/O 3 */
#define SYSCONFIG1_GPIO2	0x000c	/* bits 03..02: General Purpose I/O 2 */
#define SYSCONFIG1_GPIO1	0x0003	/* bits 01..00: General Purpose I/O 1 */

#define SYSCONFIG2		5	/* System Configuration 2 */
#define SYSCONFIG2_SEEKTH	0xff00	/* bits 15..08: RSSI Seek Threshold */
#define SYSCONFIG2_BAND		0x00c0	/* bits 07..06: Band Select */
#define SYSCONFIG2_SPACE	0x0030	/* bits 05..04: Channel Spacing */
#define SYSCONFIG2_VOLUME	0x000f	/* bits 03..00: Volume */

#define SYSCONFIG3		6	/* System Configuration 3 */
#define SYSCONFIG3_SMUTER	0xc000	/* bits 15..14: Softmute Attack/Recover Rate */
#define SYSCONFIG3_SMUTEA	0x3000	/* bits 13..12: Softmute Attenuation */
#define SYSCONFIG3_SKSNR	0x00f0	/* bits 07..04: Seek SNR Threshold */
#define SYSCONFIG3_SKCNT	0x000f	/* bits 03..00: Seek FM Impulse Detection Threshold */

#define TEST1			7	/* Test 1 */
#define TEST1_AHIZEN		0x4000	/* bits 14..14: Audio High-Z Enable */

#define TEST2			8	/* Test 2 */
/* TEST2 only contains reserved bits */

#define BOOTCONFIG		9	/* Boot Configuration */
/* BOOTCONFIG only contains reserved bits */

#define STATUSRSSI		10	/* Status RSSI */
#define STATUSRSSI_RDSR		0x8000	/* bits 15..15: RDS Ready (Si4701 only) */
#define STATUSRSSI_STC		0x4000	/* bits 14..14: Seek/Tune Complete */
#define STATUSRSSI_SF		0x2000	/* bits 13..13: Seek Fail/Band Limit */
#define STATUSRSSI_AFCRL	0x1000	/* bits 12..12: AFC Rail */
#define STATUSRSSI_RDSS		0x0800	/* bits 11..11: RDS Synchronized (Si4701 only) */
#define STATUSRSSI_BLERA	0x0600	/* bits 10..09: RDS Block A Errors (Si4701 only) */
#define STATUSRSSI_ST		0x0100	/* bits 08..08: Stereo Indicator */
#define STATUSRSSI_RSSI		0x00ff	/* bits 07..00: RSSI (Received Signal Strength Indicator) */

#define READCHAN		11	/* Read Channel */
#define READCHAN_BLERB		0xc000	/* bits 15..14: RDS Block D Errors (Si4701 only) */
#define READCHAN_BLERC		0x3000	/* bits 13..12: RDS Block C Errors (Si4701 only) */
#define READCHAN_BLERD		0x0c00	/* bits 11..10: RDS Block B Errors (Si4701 only) */
#define READCHAN_READCHAN	0x03ff	/* bits 09..00: Read Channel */

#define RDSA			12	/* RDSA */
#define RDSA_RDSA		0xffff	/* bits 15..00: RDS Block A Data (Si4701 only) */

#define RDSB			13	/* RDSB */
#define RDSB_RDSB		0xffff	/* bits 15..00: RDS Block B Data (Si4701 only) */

#define RDSC			14	/* RDSC */
#define RDSC_RDSC		0xffff	/* bits 15..00: RDS Block C Data (Si4701 only) */

#define RDSD			15	/* RDSD */
#define RDSD_RDSD		0xffff	/* bits 15..00: RDS Block D Data (Si4701 only) */


/**************************************************************************
 * General Driver Definitions
 **************************************************************************/

/*
 * si470x_device - private data
 */
struct si470x_device {
	struct v4l2_device v4l2_dev;
	struct video_device videodev;
	struct v4l2_ctrl_handler hdl;
	int band;

	/* Silabs internal registers (0..15) */
	unsigned short registers[RADIO_REGISTER_NUM];

	/* RDS receive buffer */
	wait_queue_head_t read_queue;
	struct mutex lock;		/* buffer locking */
	unsigned char *buffer;		/* size is always multiple of three */
	unsigned int buf_size;
	unsigned int rd_index;
	unsigned int wr_index;

	struct completion completion;
	bool status_rssi_auto_update;	/* Does RSSI get updated automatic? */

#if IS_ENABLED(CONFIG_USB_SI470X)
	/* reference to USB and video device */
	struct usb_device *usbdev;
	struct usb_interface *intf;
	char *usb_buf;

	/* Interrupt endpoint handling */
	char *int_in_buffer;
	struct usb_endpoint_descriptor *int_in_endpoint;
	struct urb *int_in_urb;
	int int_in_running;

	/* scratch page */
	unsigned char software_version;
	unsigned char hardware_version;
#endif

#if IS_ENABLED(CONFIG_I2C_SI470X)
	struct i2c_client *client;
#endif
};


/**************************************************************************
 * Firmware Versions
 **************************************************************************/

#define RADIO_FW_VERSION	12


/**************************************************************************
 * Frequency Multiplicator
 **************************************************************************/

/*
 * The frequency is set in units of 62.5 Hz when using V4L2_TUNER_CAP_LOW,
 * 62.5 kHz otherwise.
 * The tuner is able to have a channel spacing of 50, 100 or 200 kHz.
 * tuner->capability is therefore set to V4L2_TUNER_CAP_LOW
 * The FREQ_MUL is then: 1 MHz / 62.5 Hz = 16000
 */
#define FREQ_MUL (1000000 / 62.5)


/**************************************************************************
 * Common Functions
 **************************************************************************/
extern struct video_device si470x_viddev_template;
extern const struct v4l2_ctrl_ops si470x_ctrl_ops;
int si470x_get_register(struct si470x_device *radio, int regnr);
int si470x_set_register(struct si470x_device *radio, int regnr);
int si470x_disconnect_check(struct si470x_device *radio);
int si470x_set_freq(struct si470x_device *radio, unsigned int freq);
int si470x_start(struct si470x_device *radio);
int si470x_stop(struct si470x_device *radio);
int si470x_fops_open(struct file *file);
int si470x_fops_release(struct file *file);
int si470x_vidioc_querycap(struct file *file, void *priv,
		struct v4l2_capability *capability);
Commit	Line	Data
b09cd163 JS	1	/*
	2	* drivers/media/radio/si470x/radio-si470x.h
	3	*
	4	* Driver for radios with Silicon Labs Si470x FM Radio Receivers
	5	*
	6	* Copyright (c) 2009 Tobias Lorenz <tobias.lorenz@gmx.net>
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published by
	10	* the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
b09cd163 JS	17	*/
	18
	19
	20	/* driver definitions */
	21	#define DRIVER_NAME "radio-si470x"
	22
	23
	24	/* kernel includes */
	25	#include <linux/kernel.h>
	26	#include <linux/module.h>
	27	#include <linux/init.h>
788f6feb	28	#include <linux/sched.h>
b09cd163	29	#include <linux/slab.h>
b09cd163	30	#include <linux/input.h>
b09cd163 JS	31	#include <linux/videodev2.h>
	32	#include <linux/mutex.h>
	33	#include <media/v4l2-common.h>
	34	#include <media/v4l2-ioctl.h>
4967d53d HV	35	#include <media/v4l2-ctrls.h>
	36	#include <media/v4l2-event.h>
	37	#include <media/v4l2-device.h>
b09cd163 JS	38	#include <asm/unaligned.h>
	39
	40
9dcb79c2	41
b09cd163 JS	42	/**************************************************************************
	43	* Register Definitions
	44	**************************************************************************/
	45	#define RADIO_REGISTER_SIZE 2 /* 16 register bit width */
	46	#define RADIO_REGISTER_NUM 16 /* DEVICEID ... RDSD */
	47	#define RDS_REGISTER_NUM 6 /* STATUSRSSI ... RDSD */
	48
	49	#define DEVICEID 0 /* Device ID */
	50	#define DEVICEID_PN 0xf000 /* bits 15..12: Part Number */
	51	#define DEVICEID_MFGID 0x0fff /* bits 11..00: Manufacturer ID */
	52
dd7a2acf MCC	53	#define SI_CHIPID 1 /* Chip ID */
	54	#define SI_CHIPID_REV 0xfc00 /* bits 15..10: Chip Version */
	55	#define SI_CHIPID_DEV 0x0200 /* bits 09..09: Device */
	56	#define SI_CHIPID_FIRMWARE 0x01ff /* bits 08..00: Firmware Version */
b09cd163 JS	57
	58	#define POWERCFG 2 /* Power Configuration */
	59	#define POWERCFG_DSMUTE 0x8000 /* bits 15..15: Softmute Disable */
	60	#define POWERCFG_DMUTE 0x4000 /* bits 14..14: Mute Disable */
	61	#define POWERCFG_MONO 0x2000 /* bits 13..13: Mono Select */
	62	#define POWERCFG_RDSM 0x0800 /* bits 11..11: RDS Mode (Si4701 only) */
	63	#define POWERCFG_SKMODE 0x0400 /* bits 10..10: Seek Mode */
	64	#define POWERCFG_SEEKUP 0x0200 /* bits 09..09: Seek Direction */
	65	#define POWERCFG_SEEK 0x0100 /* bits 08..08: Seek */
	66	#define POWERCFG_DISABLE 0x0040 /* bits 06..06: Powerup Disable */
	67	#define POWERCFG_ENABLE 0x0001 /* bits 00..00: Powerup Enable */
	68
	69	#define CHANNEL 3 /* Channel */
	70	#define CHANNEL_TUNE 0x8000 /* bits 15..15: Tune */
	71	#define CHANNEL_CHAN 0x03ff /* bits 09..00: Channel Select */
	72
	73	#define SYSCONFIG1 4 /* System Configuration 1 */
	74	#define SYSCONFIG1_RDSIEN 0x8000 /* bits 15..15: RDS Interrupt Enable (Si4701 only) */
	75	#define SYSCONFIG1_STCIEN 0x4000 /* bits 14..14: Seek/Tune Complete Interrupt Enable */
	76	#define SYSCONFIG1_RDS 0x1000 /* bits 12..12: RDS Enable (Si4701 only) */
	77	#define SYSCONFIG1_DE 0x0800 /* bits 11..11: De-emphasis (0=75us 1=50us) */
	78	#define SYSCONFIG1_AGCD 0x0400 /* bits 10..10: AGC Disable */
	79	#define SYSCONFIG1_BLNDADJ 0x00c0 /* bits 07..06: Stereo/Mono Blend Level Adjustment */
	80	#define SYSCONFIG1_GPIO3 0x0030 /* bits 05..04: General Purpose I/O 3 */
	81	#define SYSCONFIG1_GPIO2 0x000c /* bits 03..02: General Purpose I/O 2 */
	82	#define SYSCONFIG1_GPIO1 0x0003 /* bits 01..00: General Purpose I/O 1 */
	83
	84	#define SYSCONFIG2 5 /* System Configuration 2 */
	85	#define SYSCONFIG2_SEEKTH 0xff00 /* bits 15..08: RSSI Seek Threshold */
8d8c1b37	86	#define SYSCONFIG2_BAND 0x00c0 /* bits 07..06: Band Select */
b09cd163 JS	87	#define SYSCONFIG2_SPACE 0x0030 /* bits 05..04: Channel Spacing */
	88	#define SYSCONFIG2_VOLUME 0x000f /* bits 03..00: Volume */
	89
	90	#define SYSCONFIG3 6 /* System Configuration 3 */
	91	#define SYSCONFIG3_SMUTER 0xc000 /* bits 15..14: Softmute Attack/Recover Rate */
	92	#define SYSCONFIG3_SMUTEA 0x3000 /* bits 13..12: Softmute Attenuation */
	93	#define SYSCONFIG3_SKSNR 0x00f0 /* bits 07..04: Seek SNR Threshold */
	94	#define SYSCONFIG3_SKCNT 0x000f /* bits 03..00: Seek FM Impulse Detection Threshold */
	95
	96	#define TEST1 7 /* Test 1 */
	97	#define TEST1_AHIZEN 0x4000 /* bits 14..14: Audio High-Z Enable */
	98
	99	#define TEST2 8 /* Test 2 */
	100	/* TEST2 only contains reserved bits */
	101
	102	#define BOOTCONFIG 9 /* Boot Configuration */
	103	/* BOOTCONFIG only contains reserved bits */
	104
	105	#define STATUSRSSI 10 /* Status RSSI */
	106	#define STATUSRSSI_RDSR 0x8000 /* bits 15..15: RDS Ready (Si4701 only) */
	107	#define STATUSRSSI_STC 0x4000 /* bits 14..14: Seek/Tune Complete */
	108	#define STATUSRSSI_SF 0x2000 /* bits 13..13: Seek Fail/Band Limit */
	109	#define STATUSRSSI_AFCRL 0x1000 /* bits 12..12: AFC Rail */
	110	#define STATUSRSSI_RDSS 0x0800 /* bits 11..11: RDS Synchronized (Si4701 only) */
	111	#define STATUSRSSI_BLERA 0x0600 /* bits 10..09: RDS Block A Errors (Si4701 only) */
	112	#define STATUSRSSI_ST 0x0100 /* bits 08..08: Stereo Indicator */
	113	#define STATUSRSSI_RSSI 0x00ff /* bits 07..00: RSSI (Received Signal Strength Indicator) */
	114
	115	#define READCHAN 11 /* Read Channel */
	116	#define READCHAN_BLERB 0xc000 /* bits 15..14: RDS Block D Errors (Si4701 only) */
	117	#define READCHAN_BLERC 0x3000 /* bits 13..12: RDS Block C Errors (Si4701 only) */
	118	#define READCHAN_BLERD 0x0c00 /* bits 11..10: RDS Block B Errors (Si4701 only) */
	119	#define READCHAN_READCHAN 0x03ff /* bits 09..00: Read Channel */
	120
	121	#define RDSA 12 /* RDSA */
	122	#define RDSA_RDSA 0xffff /* bits 15..00: RDS Block A Data (Si4701 only) */
	123
	124	#define RDSB 13 /* RDSB */
	125	#define RDSB_RDSB 0xffff /* bits 15..00: RDS Block B Data (Si4701 only) */
	126
	127	#define RDSC 14 /* RDSC */
	128	#define RDSC_RDSC 0xffff /* bits 15..00: RDS Block C Data (Si4701 only) */
	129
	130	#define RDSD 15 /* RDSD */
	131	#define RDSD_RDSD 0xffff /* bits 15..00: RDS Block D Data (Si4701 only) */
	132
	133
9dcb79c2	134
b09cd163 JS	135	/**************************************************************************
	136	* General Driver Definitions
	137	**************************************************************************/
	138
	139	/*
	140	* si470x_device - private data
	141	*/
	142	struct si470x_device {
4967d53d HV	143	struct v4l2_device v4l2_dev;
	144	struct video_device videodev;
	145	struct v4l2_ctrl_handler hdl;
f140612d	146	int band;
9dcb79c2 TL	147
	148	/* Silabs internal registers (0..15) */
	149	unsigned short registers[RADIO_REGISTER_NUM];
	150
	151	/* RDS receive buffer */
	152	wait_queue_head_t read_queue;
	153	struct mutex lock; /* buffer locking */
	154	unsigned char buffer; / size is always multiple of three */
	155	unsigned int buf_size;
	156	unsigned int rd_index;
	157	unsigned int wr_index;
cc35bbdd	158
0830be3f	159	struct completion completion;
86ef3f78	160	bool status_rssi_auto_update; /* Does RSSI get updated automatic? */
0830be3f	161
480d3ca1	162	#if IS_ENABLED(CONFIG_USB_SI470X)
b09cd163 JS	163	/* reference to USB and video device */
	164	struct usb_device *usbdev;
	165	struct usb_interface *intf;
567e2e96	166	char *usb_buf;
b09cd163 JS	167
	168	/* Interrupt endpoint handling */
	169	char *int_in_buffer;
	170	struct usb_endpoint_descriptor *int_in_endpoint;
	171	struct urb *int_in_urb;
	172	int int_in_running;
	173
	174	/* scratch page */
	175	unsigned char software_version;
	176	unsigned char hardware_version;
cc35bbdd	177	#endif
b09cd163	178
480d3ca1	179	#if IS_ENABLED(CONFIG_I2C_SI470X)
9dcb79c2 TL	180	struct i2c_client *client;
9dcb79c2 TL	181	#endif
b09cd163 JS	182	};
	183
	184
9dcb79c2 TL	185
	186	/**************************************************************************
	187	* Firmware Versions
	188	**************************************************************************/
	189
db3912c0	190	#define RADIO_FW_VERSION 12
9dcb79c2 TL	191
	192
	193
	194	/**************************************************************************
	195	* Frequency Multiplicator
	196	**************************************************************************/
	197
b09cd163 JS	198	/*
	199	* The frequency is set in units of 62.5 Hz when using V4L2_TUNER_CAP_LOW,
	200	* 62.5 kHz otherwise.
	201	* The tuner is able to have a channel spacing of 50, 100 or 200 kHz.
	202	* tuner->capability is therefore set to V4L2_TUNER_CAP_LOW
	203	* The FREQ_MUL is then: 1 MHz / 62.5 Hz = 16000
	204	*/
	205	#define FREQ_MUL (1000000 / 62.5)
	206
	207
	208
	209	/**************************************************************************
	210	* Common Functions
	211	**************************************************************************/
b09cd163	212	extern struct video_device si470x_viddev_template;
4967d53d	213	extern const struct v4l2_ctrl_ops si470x_ctrl_ops;
b09cd163 JS	214	int si470x_get_register(struct si470x_device *radio, int regnr);
b09cd163 JS	215	int si470x_set_register(struct si470x_device *radio, int regnr);
3c7cc8d5	216	int si470x_disconnect_check(struct si470x_device *radio);
b09cd163 JS	217	int si470x_set_freq(struct si470x_device *radio, unsigned int freq);
	218	int si470x_start(struct si470x_device *radio);
	219	int si470x_stop(struct si470x_device *radio);
1aa925c9 JS	220	int si470x_fops_open(struct file *file);
1aa925c9 JS	221	int si470x_fops_release(struct file *file);
b09cd163 JS	222	int si470x_vidioc_querycap(struct file file, void priv,
b09cd163 JS	223	struct v4l2_capability *capability);