[mirror_ubuntu-artful-kernel.git] / drivers / media / video / wm8775.c

/*
 * wm8775 - driver version 0.0.1
 *
 * Copyright (C) 2004 Ulf Eklund <ivtv at eklund.to>
 *
 * Based on saa7115 driver
 *
 * Copyright (C) 2005 Hans Verkuil <hverkuil@xs4all.nl>
 * - Cleanup
 * - V4L2 API update
 * - sound fixes
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include <linux/module.h>
#include <linux/types.h>
#include <linux/ioctl.h>
#include <asm/uaccess.h>
#include <linux/i2c.h>
#include <linux/i2c-id.h>
#include <linux/videodev2.h>
#include <media/v4l2-common.h>
#include <media/v4l2-chip-ident.h>
#include <media/v4l2-i2c-drv-legacy.h>

MODULE_DESCRIPTION("wm8775 driver");
MODULE_AUTHOR("Ulf Eklund, Hans Verkuil");
MODULE_LICENSE("GPL");

static unsigned short normal_i2c[] = { 0x36 >> 1, I2C_CLIENT_END };

I2C_CLIENT_INSMOD;


/* ----------------------------------------------------------------------- */

enum {
	R7 = 7, R11 = 11,
	R12, R13, R14, R15, R16, R17, R18, R19, R20, R21, R23 = 23,
	TOT_REGS
};

struct wm8775_state {
	u8 input;		/* Last selected input (0-0xf) */
	u8 muted;
};

static int wm8775_write(struct i2c_client *client, int reg, u16 val)
{
	int i;

	if (reg < 0 || reg >= TOT_REGS) {
		v4l_err(client, "Invalid register R%d\n", reg);
		return -1;
	}

	for (i = 0; i < 3; i++)
		if (i2c_smbus_write_byte_data(client,
				(reg << 1) | (val >> 8), val & 0xff) == 0)
			return 0;
	v4l_err(client, "I2C: cannot write %03x to register R%d\n", val, reg);
	return -1;
}

static int wm8775_command(struct i2c_client *client, unsigned cmd, void *arg)
{
	struct wm8775_state *state = i2c_get_clientdata(client);
	struct v4l2_routing *route = arg;
	struct v4l2_control *ctrl = arg;

	switch (cmd) {
	case VIDIOC_INT_G_AUDIO_ROUTING:
		route->input = state->input;
		route->output = 0;
		break;

	case VIDIOC_INT_S_AUDIO_ROUTING:
		/* There are 4 inputs and one output. Zero or more inputs
		   are multiplexed together to the output. Hence there are
		   16 combinations.
		   If only one input is active (the normal case) then the
		   input values 1, 2, 4 or 8 should be used. */
		if (route->input > 15) {
			v4l_err(client, "Invalid input %d.\n", route->input);
			return -EINVAL;
		}
		state->input = route->input;
		if (state->muted)
			break;
		wm8775_write(client, R21, 0x0c0);
		wm8775_write(client, R14, 0x1d4);
		wm8775_write(client, R15, 0x1d4);
		wm8775_write(client, R21, 0x100 + state->input);
		break;

	case VIDIOC_G_CTRL:
		if (ctrl->id != V4L2_CID_AUDIO_MUTE)
			return -EINVAL;
		ctrl->value = state->muted;
		break;

	case VIDIOC_S_CTRL:
		if (ctrl->id != V4L2_CID_AUDIO_MUTE)
			return -EINVAL;
		state->muted = ctrl->value;
		wm8775_write(client, R21, 0x0c0);
		wm8775_write(client, R14, 0x1d4);
		wm8775_write(client, R15, 0x1d4);
		if (!state->muted)
			wm8775_write(client, R21, 0x100 + state->input);
		break;

	case VIDIOC_G_CHIP_IDENT:
		return v4l2_chip_ident_i2c_client(client,
				arg, V4L2_IDENT_WM8775, 0);

	case VIDIOC_LOG_STATUS:
		v4l_info(client, "Input: %d%s\n", state->input,
			    state->muted ? " (muted)" : "");
		break;

	case VIDIOC_S_FREQUENCY:
		/* If I remove this, then it can happen that I have no
		   sound the first time I tune from static to a valid channel.
		   It's difficult to reproduce and is almost certainly related
		   to the zero cross detect circuit. */
		wm8775_write(client, R21, 0x0c0);
		wm8775_write(client, R14, 0x1d4);
		wm8775_write(client, R15, 0x1d4);
		wm8775_write(client, R21, 0x100 + state->input);
		break;

	default:
		return -EINVAL;
	}
	return 0;
}

/* ----------------------------------------------------------------------- */

/* i2c implementation */

/*
 * Generic i2c probe
 * concerning the addresses: i2c wants 7 bit (without the r/w bit), so '>>1'
 */

static int wm8775_probe(struct i2c_client *client,
			const struct i2c_device_id *id)
{
	struct wm8775_state *state;

	/* Check if the adapter supports the needed features */
	if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
		return -EIO;

	v4l_info(client, "chip found @ 0x%x (%s)\n",
			client->addr << 1, client->adapter->name);

	state = kmalloc(sizeof(struct wm8775_state), GFP_KERNEL);
	if (state == NULL)
		return -ENOMEM;
	state->input = 2;
	state->muted = 0;
	i2c_set_clientdata(client, state);

	/* Initialize wm8775 */

	/* RESET */
	wm8775_write(client, R23, 0x000);
	/* Disable zero cross detect timeout */
	wm8775_write(client, R7, 0x000);
	/* Left justified, 24-bit mode */
	wm8775_write(client, R11, 0x021);
	/* Master mode, clock ratio 256fs */
	wm8775_write(client, R12, 0x102);
	/* Powered up */
	wm8775_write(client, R13, 0x000);
	/* ADC gain +2.5dB, enable zero cross */
	wm8775_write(client, R14, 0x1d4);
	/* ADC gain +2.5dB, enable zero cross */
	wm8775_write(client, R15, 0x1d4);
	/* ALC Stereo, ALC target level -1dB FS max gain +8dB */
	wm8775_write(client, R16, 0x1bf);
	/* Enable gain control, use zero cross detection,
	   ALC hold time 42.6 ms */
	wm8775_write(client, R17, 0x185);
	/* ALC gain ramp up delay 34 s, ALC gain ramp down delay 33 ms */
	wm8775_write(client, R18, 0x0a2);
	/* Enable noise gate, threshold -72dBfs */
	wm8775_write(client, R19, 0x005);
	/* Transient window 4ms, lower PGA gain limit -1dB */
	wm8775_write(client, R20, 0x07a);
	/* LRBOTH = 1, use input 2. */
	wm8775_write(client, R21, 0x102);
	return 0;
}

static int wm8775_remove(struct i2c_client *client)
{
	kfree(i2c_get_clientdata(client));
	return 0;
}

static const struct i2c_device_id wm8775_id[] = {
	{ "wm8775", 0 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, wm8775_id);

static struct v4l2_i2c_driver_data v4l2_i2c_data = {
	.name = "wm8775",
	.driverid = I2C_DRIVERID_WM8775,
	.command = wm8775_command,
	.probe = wm8775_probe,
	.remove = wm8775_remove,
	.id_table = wm8775_id,
};
Commit	Line	Data
0edeea4f HV	1	/*
	2	* wm8775 - driver version 0.0.1
	3	*
	4	* Copyright (C) 2004 Ulf Eklund <ivtv at eklund.to>
	5	*
	6	* Based on saa7115 driver
	7	*
1f4b3365 HV	8	* Copyright (C) 2005 Hans Verkuil <hverkuil@xs4all.nl>
	9	* - Cleanup
	10	* - V4L2 API update
	11	* - sound fixes
	12	*
0edeea4f HV	13	* This program is free software; you can redistribute it and/or modify
	14	* it under the terms of the GNU General Public License as published by
	15	* the Free Software Foundation; either version 2 of the License, or
	16	* (at your option) any later version.
	17	*
	18	* This program is distributed in the hope that it will be useful,
	19	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	20	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	21	* GNU General Public License for more details.
	22	*
	23	* You should have received a copy of the GNU General Public License
	24	* along with this program; if not, write to the Free Software
	25	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	26	*/
	27
0edeea4f HV	28	#include <linux/module.h>
	29	#include <linux/types.h>
	30	#include <linux/ioctl.h>
	31	#include <asm/uaccess.h>
	32	#include <linux/i2c.h>
e2998e10	33	#include <linux/i2c-id.h>
33b687cf	34	#include <linux/videodev2.h>
fac9e899	35	#include <media/v4l2-common.h>
74cab31c	36	#include <media/v4l2-chip-ident.h>
d9a53aa9	37	#include <media/v4l2-i2c-drv-legacy.h>
0edeea4f HV	38
0edeea4f HV	39	MODULE_DESCRIPTION("wm8775 driver");
1f4b3365	40	MODULE_AUTHOR("Ulf Eklund, Hans Verkuil");
0edeea4f HV	41	MODULE_LICENSE("GPL");
0edeea4f HV	42
0edeea4f HV	43	static unsigned short normal_i2c[] = { 0x36 >> 1, I2C_CLIENT_END };
0edeea4f HV	44
0edeea4f HV	45	I2C_CLIENT_INSMOD;
0edeea4f HV	46
d9a53aa9	47
0edeea4f HV	48	/* ----------------------------------------------------------------------- */
	49
	50	enum {
	51	R7 = 7, R11 = 11,
	52	R12, R13, R14, R15, R16, R17, R18, R19, R20, R21, R23 = 23,
	53	TOT_REGS
	54	};
	55
	56	struct wm8775_state {
	57	u8 input; /* Last selected input (0-0xf) */
	58	u8 muted;
	59	};
	60
	61	static int wm8775_write(struct i2c_client *client, int reg, u16 val)
	62	{
	63	int i;
	64
	65	if (reg < 0 \|\| reg >= TOT_REGS) {
fac9e899	66	v4l_err(client, "Invalid register R%d\n", reg);
0edeea4f HV	67	return -1;
	68	}
	69
842441d4 HV	70	for (i = 0; i < 3; i++)
	71	if (i2c_smbus_write_byte_data(client,
	72	(reg << 1) \| (val >> 8), val & 0xff) == 0)
0edeea4f	73	return 0;
fac9e899	74	v4l_err(client, "I2C: cannot write %03x to register R%d\n", val, reg);
0edeea4f HV	75	return -1;
	76	}
	77
842441d4	78	static int wm8775_command(struct i2c_client client, unsigned cmd, void arg)
0edeea4f HV	79	{
0edeea4f HV	80	struct wm8775_state *state = i2c_get_clientdata(client);
7fa033b1	81	struct v4l2_routing *route = arg;
fbc46e74	82	struct v4l2_control *ctrl = arg;
0edeea4f HV	83
0edeea4f HV	84	switch (cmd) {
7fa033b1 HV	85	case VIDIOC_INT_G_AUDIO_ROUTING:
	86	route->input = state->input;
	87	route->output = 0;
	88	break;
	89
	90	case VIDIOC_INT_S_AUDIO_ROUTING:
fbc46e74 HV	91	/* There are 4 inputs and one output. Zero or more inputs
	92	are multiplexed together to the output. Hence there are
	93	16 combinations.
	94	If only one input is active (the normal case) then the
	95	input values 1, 2, 4 or 8 should be used. */
7fa033b1 HV	96	if (route->input > 15) {
7fa033b1 HV	97	v4l_err(client, "Invalid input %d.\n", route->input);
fbc46e74 HV	98	return -EINVAL;
fbc46e74 HV	99	}
7fa033b1	100	state->input = route->input;
fbc46e74 HV	101	if (state->muted)
fbc46e74 HV	102	break;
0edeea4f HV	103	wm8775_write(client, R21, 0x0c0);
	104	wm8775_write(client, R14, 0x1d4);
	105	wm8775_write(client, R15, 0x1d4);
fbc46e74 HV	106	wm8775_write(client, R21, 0x100 + state->input);
fbc46e74 HV	107	break;
0edeea4f	108
fbc46e74 HV	109	case VIDIOC_G_CTRL:
	110	if (ctrl->id != V4L2_CID_AUDIO_MUTE)
	111	return -EINVAL;
	112	ctrl->value = state->muted;
	113	break;
	114
	115	case VIDIOC_S_CTRL:
	116	if (ctrl->id != V4L2_CID_AUDIO_MUTE)
	117	return -EINVAL;
	118	state->muted = ctrl->value;
	119	wm8775_write(client, R21, 0x0c0);
	120	wm8775_write(client, R14, 0x1d4);
	121	wm8775_write(client, R15, 0x1d4);
	122	if (!state->muted)
0edeea4f	123	wm8775_write(client, R21, 0x100 + state->input);
0edeea4f HV	124	break;
0edeea4f HV	125
74cab31c	126	case VIDIOC_G_CHIP_IDENT:
842441d4 HV	127	return v4l2_chip_ident_i2c_client(client,
842441d4 HV	128	arg, V4L2_IDENT_WM8775, 0);
74cab31c	129
bf7e26ee	130	case VIDIOC_LOG_STATUS:
fac9e899	131	v4l_info(client, "Input: %d%s\n", state->input,
bf7e26ee HV	132	state->muted ? " (muted)" : "");
bf7e26ee HV	133	break;
0edeea4f	134
bf7e26ee	135	case VIDIOC_S_FREQUENCY:
0edeea4f HV	136	/* If I remove this, then it can happen that I have no
	137	sound the first time I tune from static to a valid channel.
	138	It's difficult to reproduce and is almost certainly related
	139	to the zero cross detect circuit. */
	140	wm8775_write(client, R21, 0x0c0);
	141	wm8775_write(client, R14, 0x1d4);
	142	wm8775_write(client, R15, 0x1d4);
	143	wm8775_write(client, R21, 0x100 + state->input);
	144	break;
	145
	146	default:
	147	return -EINVAL;
	148	}
	149	return 0;
	150	}
	151
	152	/* ----------------------------------------------------------------------- */
	153
	154	/* i2c implementation */
	155
	156	/*
	157	* Generic i2c probe
	158	* concerning the addresses: i2c wants 7 bit (without the r/w bit), so '>>1'
	159	*/
	160
d2653e92 JD	161	static int wm8775_probe(struct i2c_client *client,
d2653e92 JD	162	const struct i2c_device_id *id)
0edeea4f	163	{
0edeea4f HV	164	struct wm8775_state *state;
	165
	166	/* Check if the adapter supports the needed features */
d9a53aa9 HV	167	if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
d9a53aa9 HV	168	return -EIO;
0edeea4f	169
842441d4 HV	170	v4l_info(client, "chip found @ 0x%x (%s)\n",
842441d4 HV	171	client->addr << 1, client->adapter->name);
0edeea4f HV	172
0edeea4f HV	173	state = kmalloc(sizeof(struct wm8775_state), GFP_KERNEL);
842441d4	174	if (state == NULL)
0edeea4f	175	return -ENOMEM;
0edeea4f HV	176	state->input = 2;
	177	state->muted = 0;
	178	i2c_set_clientdata(client, state);
	179
842441d4 HV	180	/* Initialize wm8775 */
	181
	182	/* RESET */
	183	wm8775_write(client, R23, 0x000);
	184	/* Disable zero cross detect timeout */
	185	wm8775_write(client, R7, 0x000);
	186	/* Left justified, 24-bit mode */
	187	wm8775_write(client, R11, 0x021);
	188	/* Master mode, clock ratio 256fs */
	189	wm8775_write(client, R12, 0x102);
	190	/* Powered up */
	191	wm8775_write(client, R13, 0x000);
	192	/* ADC gain +2.5dB, enable zero cross */
	193	wm8775_write(client, R14, 0x1d4);
	194	/* ADC gain +2.5dB, enable zero cross */
	195	wm8775_write(client, R15, 0x1d4);
	196	/* ALC Stereo, ALC target level -1dB FS max gain +8dB */
	197	wm8775_write(client, R16, 0x1bf);
	198	/* Enable gain control, use zero cross detection,
	199	ALC hold time 42.6 ms */
	200	wm8775_write(client, R17, 0x185);
	201	/* ALC gain ramp up delay 34 s, ALC gain ramp down delay 33 ms */
	202	wm8775_write(client, R18, 0x0a2);
	203	/* Enable noise gate, threshold -72dBfs */
	204	wm8775_write(client, R19, 0x005);
	205	/* Transient window 4ms, lower PGA gain limit -1dB */
	206	wm8775_write(client, R20, 0x07a);
	207	/* LRBOTH = 1, use input 2. */
	208	wm8775_write(client, R21, 0x102);
0edeea4f HV	209	return 0;
	210	}
	211
d9a53aa9	212	static int wm8775_remove(struct i2c_client *client)
0edeea4f	213	{
d9a53aa9	214	kfree(i2c_get_clientdata(client));
0edeea4f HV	215	return 0;
	216	}
	217
af294867 JD	218	static const struct i2c_device_id wm8775_id[] = {
	219	{ "wm8775", 0 },
	220	{ }
	221	};
	222	MODULE_DEVICE_TABLE(i2c, wm8775_id);
	223
d9a53aa9 HV	224	static struct v4l2_i2c_driver_data v4l2_i2c_data = {
	225	.name = "wm8775",
	226	.driverid = I2C_DRIVERID_WM8775,
	227	.command = wm8775_command,
	228	.probe = wm8775_probe,
	229	.remove = wm8775_remove,
af294867	230	.id_table = wm8775_id,
0edeea4f	231	};