[mirror_ubuntu-bionic-kernel.git] / drivers / media / i2c / wm8739.c

/*
 * wm8739
 *
 * Copyright (C) 2005 T. Adachi <tadachi@tadachi-net.com>
 *
 * Copyright (C) 2005 Hans Verkuil <hverkuil@xs4all.nl>
 * - Cleanup
 *
 * 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/slab.h>
#include <linux/ioctl.h>
#include <asm/uaccess.h>
#include <linux/i2c.h>
#include <linux/videodev2.h>
#include <media/v4l2-device.h>
#include <media/v4l2-ctrls.h>

MODULE_DESCRIPTION("wm8739 driver");
MODULE_AUTHOR("T. Adachi, Hans Verkuil");
MODULE_LICENSE("GPL");

static int debug;

module_param(debug, int, 0644);

MODULE_PARM_DESC(debug, "Debug level (0-1)");


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

enum {
	R0 = 0, R1,
	R5 = 5, R6, R7, R8, R9, R15 = 15,
	TOT_REGS
};

struct wm8739_state {
	struct v4l2_subdev sd;
	struct v4l2_ctrl_handler hdl;
	struct {
		/* audio cluster */
		struct v4l2_ctrl *volume;
		struct v4l2_ctrl *mute;
		struct v4l2_ctrl *balance;
	};
	u32 clock_freq;
};

static inline struct wm8739_state *to_state(struct v4l2_subdev *sd)
{
	return container_of(sd, struct wm8739_state, sd);
}

static inline struct v4l2_subdev *to_sd(struct v4l2_ctrl *ctrl)
{
	return &container_of(ctrl->handler, struct wm8739_state, hdl)->sd;
}

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

static int wm8739_write(struct v4l2_subdev *sd, int reg, u16 val)
{
	struct i2c_client *client = v4l2_get_subdevdata(sd);
	int i;

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

	v4l2_dbg(1, debug, sd, "write: %02x %02x\n", reg, val);

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

static int wm8739_s_ctrl(struct v4l2_ctrl *ctrl)
{
	struct v4l2_subdev *sd = to_sd(ctrl);
	struct wm8739_state *state = to_state(sd);
	unsigned int work_l, work_r;
	u8 vol_l;	/* +12dB to -34.5dB 1.5dB step (5bit) def:0dB */
	u8 vol_r;	/* +12dB to -34.5dB 1.5dB step (5bit) def:0dB */
	u16 mute;

	switch (ctrl->id) {
	case V4L2_CID_AUDIO_VOLUME:
		break;

	default:
		return -EINVAL;
	}

	/* normalize ( 65535 to 0 -> 31 to 0 (12dB to -34.5dB) ) */
	work_l = (min(65536 - state->balance->val, 32768) * state->volume->val) / 32768;
	work_r = (min(state->balance->val, 32768) * state->volume->val) / 32768;

	vol_l = (long)work_l * 31 / 65535;
	vol_r = (long)work_r * 31 / 65535;

	/* set audio volume etc. */
	mute = state->mute->val ? 0x80 : 0;

	/* Volume setting: bits 0-4, 0x1f = 12 dB, 0x00 = -34.5 dB
	 * Default setting: 0x17 = 0 dB
	 */
	wm8739_write(sd, R0, (vol_l & 0x1f) | mute);
	wm8739_write(sd, R1, (vol_r & 0x1f) | mute);
	return 0;
}

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

static int wm8739_s_clock_freq(struct v4l2_subdev *sd, u32 audiofreq)
{
	struct wm8739_state *state = to_state(sd);

	state->clock_freq = audiofreq;
	/* de-activate */
	wm8739_write(sd, R9, 0x000);
	switch (audiofreq) {
	case 44100:
		/* 256fps, fs=44.1k */
		wm8739_write(sd, R8, 0x020);
		break;
	case 48000:
		/* 256fps, fs=48k */
		wm8739_write(sd, R8, 0x000);
		break;
	case 32000:
		/* 256fps, fs=32k */
		wm8739_write(sd, R8, 0x018);
		break;
	default:
		break;
	}
	/* activate */
	wm8739_write(sd, R9, 0x001);
	return 0;
}

static int wm8739_log_status(struct v4l2_subdev *sd)
{
	struct wm8739_state *state = to_state(sd);

	v4l2_info(sd, "Frequency: %u Hz\n", state->clock_freq);
	v4l2_ctrl_handler_log_status(&state->hdl, sd->name);
	return 0;
}

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

static const struct v4l2_ctrl_ops wm8739_ctrl_ops = {
	.s_ctrl = wm8739_s_ctrl,
};

static const struct v4l2_subdev_core_ops wm8739_core_ops = {
	.log_status = wm8739_log_status,
	.g_ext_ctrls = v4l2_subdev_g_ext_ctrls,
	.try_ext_ctrls = v4l2_subdev_try_ext_ctrls,
	.s_ext_ctrls = v4l2_subdev_s_ext_ctrls,
	.g_ctrl = v4l2_subdev_g_ctrl,
	.s_ctrl = v4l2_subdev_s_ctrl,
	.queryctrl = v4l2_subdev_queryctrl,
	.querymenu = v4l2_subdev_querymenu,
};

static const struct v4l2_subdev_audio_ops wm8739_audio_ops = {
	.s_clock_freq = wm8739_s_clock_freq,
};

static const struct v4l2_subdev_ops wm8739_ops = {
	.core = &wm8739_core_ops,
	.audio = &wm8739_audio_ops,
};

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

/* i2c implementation */

static int wm8739_probe(struct i2c_client *client,
			const struct i2c_device_id *id)
{
	struct wm8739_state *state;
	struct v4l2_subdev *sd;

	/* 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 = devm_kzalloc(&client->dev, sizeof(*state), GFP_KERNEL);
	if (state == NULL)
		return -ENOMEM;
	sd = &state->sd;
	v4l2_i2c_subdev_init(sd, client, &wm8739_ops);
	v4l2_ctrl_handler_init(&state->hdl, 2);
	state->volume = v4l2_ctrl_new_std(&state->hdl, &wm8739_ctrl_ops,
			V4L2_CID_AUDIO_VOLUME, 0, 65535, 65535 / 100, 50736);
	state->mute = v4l2_ctrl_new_std(&state->hdl, &wm8739_ctrl_ops,
			V4L2_CID_AUDIO_MUTE, 0, 1, 1, 0);
	state->balance = v4l2_ctrl_new_std(&state->hdl, &wm8739_ctrl_ops,
			V4L2_CID_AUDIO_BALANCE, 0, 65535, 65535 / 100, 32768);
	sd->ctrl_handler = &state->hdl;
	if (state->hdl.error) {
		int err = state->hdl.error;

		v4l2_ctrl_handler_free(&state->hdl);
		return err;
	}
	v4l2_ctrl_cluster(3, &state->volume);

	state->clock_freq = 48000;

	/* Initialize wm8739 */

	/* reset */
	wm8739_write(sd, R15, 0x00);
	/* filter setting, high path, offet clear */
	wm8739_write(sd, R5, 0x000);
	/* ADC, OSC, Power Off mode Disable */
	wm8739_write(sd, R6, 0x000);
	/* Digital Audio interface format:
	   Enable Master mode, 24 bit, MSB first/left justified */
	wm8739_write(sd, R7, 0x049);
	/* sampling control: normal, 256fs, 48KHz sampling rate */
	wm8739_write(sd, R8, 0x000);
	/* activate */
	wm8739_write(sd, R9, 0x001);
	/* set volume/mute */
	v4l2_ctrl_handler_setup(&state->hdl);
	return 0;
}

static int wm8739_remove(struct i2c_client *client)
{
	struct v4l2_subdev *sd = i2c_get_clientdata(client);
	struct wm8739_state *state = to_state(sd);

	v4l2_device_unregister_subdev(sd);
	v4l2_ctrl_handler_free(&state->hdl);
	return 0;
}

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

static struct i2c_driver wm8739_driver = {
	.driver = {
		.owner	= THIS_MODULE,
		.name	= "wm8739",
	},
	.probe		= wm8739_probe,
	.remove		= wm8739_remove,
	.id_table	= wm8739_id,
};

module_i2c_driver(wm8739_driver);
Commit	Line	Data
75c4570c HV	1	/*
	2	* wm8739
	3	*
	4	* Copyright (C) 2005 T. Adachi <tadachi@tadachi-net.com>
	5	*
	6	* Copyright (C) 2005 Hans Verkuil <hverkuil@xs4all.nl>
	7	* - Cleanup
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or
	12	* (at your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	22	*/
	23
	24	#include <linux/module.h>
	25	#include <linux/types.h>
5a0e3ad6	26	#include <linux/slab.h>
75c4570c HV	27	#include <linux/ioctl.h>
	28	#include <asm/uaccess.h>
	29	#include <linux/i2c.h>
33b687cf	30	#include <linux/videodev2.h>
f1460e97	31	#include <media/v4l2-device.h>
f687d19d	32	#include <media/v4l2-ctrls.h>
75c4570c HV	33
	34	MODULE_DESCRIPTION("wm8739 driver");
	35	MODULE_AUTHOR("T. Adachi, Hans Verkuil");
	36	MODULE_LICENSE("GPL");
	37
099b8e73	38	static int debug;
75c4570c HV	39
	40	module_param(debug, int, 0644);
	41
	42	MODULE_PARM_DESC(debug, "Debug level (0-1)");
	43
	44
75c4570c HV	45	/* ------------------------------------------------------------------------ */
	46
	47	enum {
	48	R0 = 0, R1,
	49	R5 = 5, R6, R7, R8, R9, R15 = 15,
	50	TOT_REGS
	51	};
	52
	53	struct wm8739_state {
f1460e97	54	struct v4l2_subdev sd;
f687d19d HV	55	struct v4l2_ctrl_handler hdl;
	56	struct {
	57	/* audio cluster */
	58	struct v4l2_ctrl *volume;
	59	struct v4l2_ctrl *mute;
	60	struct v4l2_ctrl *balance;
	61	};
75c4570c	62	u32 clock_freq;
75c4570c HV	63	};
75c4570c HV	64
f1460e97 HV	65	static inline struct wm8739_state to_state(struct v4l2_subdev sd)
	66	{
	67	return container_of(sd, struct wm8739_state, sd);
	68	}
	69
f687d19d HV	70	static inline struct v4l2_subdev to_sd(struct v4l2_ctrl ctrl)
	71	{
	72	return &container_of(ctrl->handler, struct wm8739_state, hdl)->sd;
	73	}
	74
75c4570c HV	75	/* ------------------------------------------------------------------------ */
75c4570c HV	76
f1460e97	77	static int wm8739_write(struct v4l2_subdev *sd, int reg, u16 val)
75c4570c	78	{
f1460e97	79	struct i2c_client *client = v4l2_get_subdevdata(sd);
75c4570c HV	80	int i;
	81
	82	if (reg < 0 \|\| reg >= TOT_REGS) {
f1460e97	83	v4l2_err(sd, "Invalid register R%d\n", reg);
75c4570c HV	84	return -1;
	85	}
	86
f1460e97	87	v4l2_dbg(1, debug, sd, "write: %02x %02x\n", reg, val);
75c4570c	88
099b8e73 HV	89	for (i = 0; i < 3; i++)
	90	if (i2c_smbus_write_byte_data(client,
	91	(reg << 1) \| (val >> 8), val & 0xff) == 0)
75c4570c	92	return 0;
f1460e97	93	v4l2_err(sd, "I2C: cannot write %03x to register R%d\n", val, reg);
75c4570c HV	94	return -1;
	95	}
	96
f687d19d	97	static int wm8739_s_ctrl(struct v4l2_ctrl *ctrl)
75c4570c	98	{
f687d19d	99	struct v4l2_subdev *sd = to_sd(ctrl);
f1460e97	100	struct wm8739_state *state = to_state(sd);
75c4570c	101	unsigned int work_l, work_r;
f687d19d HV	102	u8 vol_l; /* +12dB to -34.5dB 1.5dB step (5bit) def:0dB */
	103	u8 vol_r; /* +12dB to -34.5dB 1.5dB step (5bit) def:0dB */
	104	u16 mute;
75c4570c HV	105
75c4570c HV	106	switch (ctrl->id) {
75c4570c	107	case V4L2_CID_AUDIO_VOLUME:
75c4570c HV	108	break;
	109
	110	default:
	111	return -EINVAL;
	112	}
	113
	114	/* normalize ( 65535 to 0 -> 31 to 0 (12dB to -34.5dB) ) */
f687d19d HV	115	work_l = (min(65536 - state->balance->val, 32768) * state->volume->val) / 32768;
f687d19d HV	116	work_r = (min(state->balance->val, 32768) * state->volume->val) / 32768;
75c4570c	117
f687d19d HV	118	vol_l = (long)work_l * 31 / 65535;
f687d19d HV	119	vol_r = (long)work_r * 31 / 65535;
75c4570c HV	120
75c4570c HV	121	/* set audio volume etc. */
f687d19d HV	122	mute = state->mute->val ? 0x80 : 0;
	123
	124	/* Volume setting: bits 0-4, 0x1f = 12 dB, 0x00 = -34.5 dB
	125	* Default setting: 0x17 = 0 dB
	126	*/
	127	wm8739_write(sd, R0, (vol_l & 0x1f) \| mute);
	128	wm8739_write(sd, R1, (vol_r & 0x1f) \| mute);
75c4570c HV	129	return 0;
	130	}
	131
	132	/* ------------------------------------------------------------------------ */
	133
f1460e97	134	static int wm8739_s_clock_freq(struct v4l2_subdev *sd, u32 audiofreq)
75c4570c	135	{
f1460e97 HV	136	struct wm8739_state *state = to_state(sd);
	137
	138	state->clock_freq = audiofreq;
	139	/* de-activate */
	140	wm8739_write(sd, R9, 0x000);
	141	switch (audiofreq) {
	142	case 44100:
	143	/* 256fps, fs=44.1k */
	144	wm8739_write(sd, R8, 0x020);
	145	break;
	146	case 48000:
	147	/* 256fps, fs=48k */
	148	wm8739_write(sd, R8, 0x000);
	149	break;
	150	case 32000:
	151	/* 256fps, fs=32k */
	152	wm8739_write(sd, R8, 0x018);
	153	break;
	154	default:
75c4570c HV	155	break;
75c4570c HV	156	}
f1460e97 HV	157	/* activate */
	158	wm8739_write(sd, R9, 0x001);
	159	return 0;
	160	}
75c4570c	161
f1460e97 HV	162	static int wm8739_log_status(struct v4l2_subdev *sd)
	163	{
	164	struct wm8739_state *state = to_state(sd);
75c4570c	165
f1460e97	166	v4l2_info(sd, "Frequency: %u Hz\n", state->clock_freq);
f687d19d	167	v4l2_ctrl_handler_log_status(&state->hdl, sd->name);
75c4570c HV	168	return 0;
	169	}
	170
f1460e97 HV	171	/* ----------------------------------------------------------------------- */
f1460e97 HV	172
f687d19d HV	173	static const struct v4l2_ctrl_ops wm8739_ctrl_ops = {
	174	.s_ctrl = wm8739_s_ctrl,
	175	};
	176
f1460e97 HV	177	static const struct v4l2_subdev_core_ops wm8739_core_ops = {
f1460e97 HV	178	.log_status = wm8739_log_status,
f687d19d HV	179	.g_ext_ctrls = v4l2_subdev_g_ext_ctrls,
	180	.try_ext_ctrls = v4l2_subdev_try_ext_ctrls,
	181	.s_ext_ctrls = v4l2_subdev_s_ext_ctrls,
	182	.g_ctrl = v4l2_subdev_g_ctrl,
	183	.s_ctrl = v4l2_subdev_s_ctrl,
	184	.queryctrl = v4l2_subdev_queryctrl,
	185	.querymenu = v4l2_subdev_querymenu,
f1460e97 HV	186	};
	187
	188	static const struct v4l2_subdev_audio_ops wm8739_audio_ops = {
	189	.s_clock_freq = wm8739_s_clock_freq,
	190	};
	191
	192	static const struct v4l2_subdev_ops wm8739_ops = {
	193	.core = &wm8739_core_ops,
	194	.audio = &wm8739_audio_ops,
	195	};
	196
75c4570c HV	197	/* ------------------------------------------------------------------------ */
	198
	199	/* i2c implementation */
	200
d2653e92 JD	201	static int wm8739_probe(struct i2c_client *client,
d2653e92 JD	202	const struct i2c_device_id *id)
75c4570c	203	{
75c4570c	204	struct wm8739_state *state;
f1460e97	205	struct v4l2_subdev *sd;
75c4570c	206
188f3457 HV	207	/* Check if the adapter supports the needed features */
	208	if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
	209	return -EIO;
	210
099b8e73 HV	211	v4l_info(client, "chip found @ 0x%x (%s)\n",
099b8e73 HV	212	client->addr << 1, client->adapter->name);
75c4570c	213
c02b211d	214	state = devm_kzalloc(&client->dev, sizeof(*state), GFP_KERNEL);
6c832e36	215	if (state == NULL)
75c4570c	216	return -ENOMEM;
f1460e97 HV	217	sd = &state->sd;
f1460e97 HV	218	v4l2_i2c_subdev_init(sd, client, &wm8739_ops);
f687d19d HV	219	v4l2_ctrl_handler_init(&state->hdl, 2);
	220	state->volume = v4l2_ctrl_new_std(&state->hdl, &wm8739_ctrl_ops,
	221	V4L2_CID_AUDIO_VOLUME, 0, 65535, 65535 / 100, 50736);
	222	state->mute = v4l2_ctrl_new_std(&state->hdl, &wm8739_ctrl_ops,
	223	V4L2_CID_AUDIO_MUTE, 0, 1, 1, 0);
	224	state->balance = v4l2_ctrl_new_std(&state->hdl, &wm8739_ctrl_ops,
	225	V4L2_CID_AUDIO_BALANCE, 0, 65535, 65535 / 100, 32768);
	226	sd->ctrl_handler = &state->hdl;
	227	if (state->hdl.error) {
	228	int err = state->hdl.error;
	229
	230	v4l2_ctrl_handler_free(&state->hdl);
f687d19d HV	231	return err;
	232	}
	233	v4l2_ctrl_cluster(3, &state->volume);
	234
75c4570c	235	state->clock_freq = 48000;
75c4570c	236
099b8e73 HV	237	/* Initialize wm8739 */
	238
	239	/* reset */
f1460e97	240	wm8739_write(sd, R15, 0x00);
099b8e73	241	/* filter setting, high path, offet clear */
f1460e97	242	wm8739_write(sd, R5, 0x000);
099b8e73	243	/* ADC, OSC, Power Off mode Disable */
f1460e97	244	wm8739_write(sd, R6, 0x000);
099b8e73 HV	245	/* Digital Audio interface format:
099b8e73 HV	246	Enable Master mode, 24 bit, MSB first/left justified */
f1460e97	247	wm8739_write(sd, R7, 0x049);
099b8e73	248	/* sampling control: normal, 256fs, 48KHz sampling rate */
f1460e97	249	wm8739_write(sd, R8, 0x000);
099b8e73	250	/* activate */
f1460e97	251	wm8739_write(sd, R9, 0x001);
099b8e73	252	/* set volume/mute */
f687d19d	253	v4l2_ctrl_handler_setup(&state->hdl);
75c4570c HV	254	return 0;
	255	}
	256
49457cc2	257	static int wm8739_remove(struct i2c_client *client)
75c4570c	258	{
f1460e97	259	struct v4l2_subdev *sd = i2c_get_clientdata(client);
f687d19d	260	struct wm8739_state *state = to_state(sd);
f1460e97 HV	261
f1460e97 HV	262	v4l2_device_unregister_subdev(sd);
f687d19d	263	v4l2_ctrl_handler_free(&state->hdl);
75c4570c HV	264	return 0;
	265	}
	266
af294867 JD	267	static const struct i2c_device_id wm8739_id[] = {
	268	{ "wm8739", 0 },
	269	{ }
	270	};
	271	MODULE_DEVICE_TABLE(i2c, wm8739_id);
	272
49facfaa HV	273	static struct i2c_driver wm8739_driver = {
	274	.driver = {
	275	.owner = THIS_MODULE,
	276	.name = "wm8739",
	277	},
	278	.probe = wm8739_probe,
	279	.remove = wm8739_remove,
	280	.id_table = wm8739_id,
75c4570c	281	};
49facfaa	282
c6e8d86f	283	module_i2c_driver(wm8739_driver);