[mirror_ubuntu-artful-kernel.git] / drivers / media / pci / cx18 / cx18-av-firmware.c

/*
 *  cx18 ADEC firmware functions
 *
 *  Copyright (C) 2007  Hans Verkuil <hverkuil@xs4all.nl>
 *  Copyright (C) 2008  Andy Walls <awalls@md.metrocast.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.
 */

#include "cx18-driver.h"
#include "cx18-io.h"
#include <linux/firmware.h>

#define CX18_AUDIO_ENABLE    0xc72014
#define CX18_AI1_MUX_MASK    0x30
#define CX18_AI1_MUX_I2S1    0x00
#define CX18_AI1_MUX_I2S2    0x10
#define CX18_AI1_MUX_843_I2S 0x20
#define CX18_AI1_MUX_INVALID 0x30

#define FWFILE "v4l-cx23418-dig.fw"

static int cx18_av_verifyfw(struct cx18 *cx, const struct firmware *fw)
{
	struct v4l2_subdev *sd = &cx->av_state.sd;
	int ret = 0;
	const u8 *data;
	u32 size;
	int addr;
	u32 expected, dl_control;

	/* Ensure we put the 8051 in reset and enable firmware upload mode */
	dl_control = cx18_av_read4(cx, CXADEC_DL_CTL);
	do {
		dl_control &= 0x00ffffff;
		dl_control |= 0x0f000000;
		cx18_av_write4_noretry(cx, CXADEC_DL_CTL, dl_control);
		dl_control = cx18_av_read4(cx, CXADEC_DL_CTL);
	} while ((dl_control & 0xff000000) != 0x0f000000);

	/* Read and auto increment until at address 0x0000 */
	while (dl_control & 0x3fff)
		dl_control = cx18_av_read4(cx, CXADEC_DL_CTL);

	data = fw->data;
	size = fw->size;
	for (addr = 0; addr < size; addr++) {
		dl_control &= 0xffff3fff; /* ignore top 2 bits of address */
		expected = 0x0f000000 | ((u32)data[addr] << 16) | addr;
		if (expected != dl_control) {
			CX18_ERR_DEV(sd, "verification of %s firmware load failed: expected %#010x got %#010x\n",
				     FWFILE, expected, dl_control);
			ret = -EIO;
			break;
		}
		dl_control = cx18_av_read4(cx, CXADEC_DL_CTL);
	}
	if (ret == 0)
		CX18_INFO_DEV(sd, "verified load of %s firmware (%d bytes)\n",
			      FWFILE, size);
	return ret;
}

int cx18_av_loadfw(struct cx18 *cx)
{
	struct v4l2_subdev *sd = &cx->av_state.sd;
	const struct firmware *fw = NULL;
	u32 size;
	u32 u, v;
	const u8 *ptr;
	int i;
	int retries1 = 0;

	if (request_firmware(&fw, FWFILE, &cx->pci_dev->dev) != 0) {
		CX18_ERR_DEV(sd, "unable to open firmware %s\n", FWFILE);
		return -EINVAL;
	}

	/* The firmware load often has byte errors, so allow for several
	   retries, both at byte level and at the firmware load level. */
	while (retries1 < 5) {
		cx18_av_write4_expect(cx, CXADEC_CHIP_CTRL, 0x00010000,
					  0x00008430, 0xffffffff); /* cx25843 */
		cx18_av_write_expect(cx, CXADEC_STD_DET_CTL, 0xf6, 0xf6, 0xff);

		/* Reset the Mako core, Register is alias of CXADEC_CHIP_CTRL */
		cx18_av_write4_expect(cx, 0x8100, 0x00010000,
					  0x00008430, 0xffffffff); /* cx25843 */

		/* Put the 8051 in reset and enable firmware upload */
		cx18_av_write4_noretry(cx, CXADEC_DL_CTL, 0x0F000000);

		ptr = fw->data;
		size = fw->size;

		for (i = 0; i < size; i++) {
			u32 dl_control = 0x0F000000 | i | ((u32)ptr[i] << 16);
			u32 value = 0;
			int retries2;
			int unrec_err = 0;

			for (retries2 = 0; retries2 < CX18_MAX_MMIO_WR_RETRIES;
			     retries2++) {
				cx18_av_write4_noretry(cx, CXADEC_DL_CTL,
						       dl_control);
				udelay(10);
				value = cx18_av_read4(cx, CXADEC_DL_CTL);
				if (value == dl_control)
					break;
				/* Check if we can correct the byte by changing
				   the address.  We can only write the lower
				   address byte of the address. */
				if ((value & 0x3F00) != (dl_control & 0x3F00)) {
					unrec_err = 1;
					break;
				}
			}
			if (unrec_err || retries2 >= CX18_MAX_MMIO_WR_RETRIES)
				break;
		}
		if (i == size)
			break;
		retries1++;
	}
	if (retries1 >= 5) {
		CX18_ERR_DEV(sd, "unable to load firmware %s\n", FWFILE);
		release_firmware(fw);
		return -EIO;
	}

	cx18_av_write4_expect(cx, CXADEC_DL_CTL,
				0x03000000 | fw->size, 0x03000000, 0x13000000);

	CX18_INFO_DEV(sd, "loaded %s firmware (%d bytes)\n", FWFILE, size);

	if (cx18_av_verifyfw(cx, fw) == 0)
		cx18_av_write4_expect(cx, CXADEC_DL_CTL,
				0x13000000 | fw->size, 0x13000000, 0x13000000);

	/* Output to the 416 */
	cx18_av_and_or4(cx, CXADEC_PIN_CTRL1, ~0, 0x78000);

	/* Audio input control 1 set to Sony mode */
	/* Audio output input 2 is 0 for slave operation input */
	/* 0xC4000914[5]: 0 = left sample on WS=0, 1 = left sample on WS=1 */
	/* 0xC4000914[7]: 0 = Philips mode, 1 = Sony mode (1st SCK rising edge
	   after WS transition for first bit of audio word. */
	cx18_av_write4(cx, CXADEC_I2S_IN_CTL, 0x000000A0);

	/* Audio output control 1 is set to Sony mode */
	/* Audio output control 2 is set to 1 for master mode */
	/* 0xC4000918[5]: 0 = left sample on WS=0, 1 = left sample on WS=1 */
	/* 0xC4000918[7]: 0 = Philips mode, 1 = Sony mode (1st SCK rising edge
	   after WS transition for first bit of audio word. */
	/* 0xC4000918[8]: 0 = slave operation, 1 = master (SCK_OUT and WS_OUT
	   are generated) */
	cx18_av_write4(cx, CXADEC_I2S_OUT_CTL, 0x000001A0);

	/* set alt I2s master clock to /0x16 and enable alt divider i2s
	   passthrough */
	cx18_av_write4(cx, CXADEC_PIN_CFG3, 0x5600B687);

	cx18_av_write4_expect(cx, CXADEC_STD_DET_CTL, 0x000000F6, 0x000000F6,
								  0x3F00FFFF);
	/* CxDevWrReg(CXADEC_STD_DET_CTL, 0x000000FF); */

	/* Set bit 0 in register 0x9CC to signify that this is MiniMe. */
	/* Register 0x09CC is defined by the Merlin firmware, and doesn't
	   have a name in the spec. */
	cx18_av_write4(cx, 0x09CC, 1);

	v = cx18_read_reg(cx, CX18_AUDIO_ENABLE);
	/* If bit 11 is 1, clear bit 10 */
	if (v & 0x800)
		cx18_write_reg_expect(cx, v & 0xFFFFFBFF, CX18_AUDIO_ENABLE,
				      0, 0x400);

	/* Toggle the AI1 MUX */
	v = cx18_read_reg(cx, CX18_AUDIO_ENABLE);
	u = v & CX18_AI1_MUX_MASK;
	v &= ~CX18_AI1_MUX_MASK;
	if (u == CX18_AI1_MUX_843_I2S || u == CX18_AI1_MUX_INVALID) {
		/* Switch to I2S1 */
		v |= CX18_AI1_MUX_I2S1;
		cx18_write_reg_expect(cx, v | 0xb00, CX18_AUDIO_ENABLE,
				      v, CX18_AI1_MUX_MASK);
		/* Switch back to the A/V decoder core I2S output */
		v = (v & ~CX18_AI1_MUX_MASK) | CX18_AI1_MUX_843_I2S;
	} else {
		/* Switch to the A/V decoder core I2S output */
		v |= CX18_AI1_MUX_843_I2S;
		cx18_write_reg_expect(cx, v | 0xb00, CX18_AUDIO_ENABLE,
				      v, CX18_AI1_MUX_MASK);
		/* Switch back to I2S1 or I2S2 */
		v = (v & ~CX18_AI1_MUX_MASK) | u;
	}
	cx18_write_reg_expect(cx, v | 0xb00, CX18_AUDIO_ENABLE,
			      v, CX18_AI1_MUX_MASK);

	/* Enable WW auto audio standard detection */
	v = cx18_av_read4(cx, CXADEC_STD_DET_CTL);
	v |= 0xFF;   /* Auto by default */
	v |= 0x400;  /* Stereo by default */
	v |= 0x14000000;
	cx18_av_write4_expect(cx, CXADEC_STD_DET_CTL, v, v, 0x3F00FFFF);

	release_firmware(fw);
	return 0;
}

MODULE_FIRMWARE(FWFILE);
Commit	Line	Data
1c1e45d1 HV	1	/*
	2	* cx18 ADEC firmware functions
	3	*
	4	* Copyright (C) 2007 Hans Verkuil <hverkuil@xs4all.nl>
6afdeaf8	5	* Copyright (C) 2008 Andy Walls <awalls@md.metrocast.net>
1c1e45d1 HV	6	*
	7	* This program is free software; you can redistribute it and/or
	8	* modify it under the terms of the GNU General Public License
	9	* as published by the Free Software Foundation; either version 2
	10	* of the License, or (at your option) any later version.
	11	*
	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.
1c1e45d1 HV	16	*/
	17
	18	#include "cx18-driver.h"
b1526421	19	#include "cx18-io.h"
1c1e45d1 HV	20	#include <linux/firmware.h>
1c1e45d1 HV	21
33b55a0a AW	22	#define CX18_AUDIO_ENABLE 0xc72014
	23	#define CX18_AI1_MUX_MASK 0x30
	24	#define CX18_AI1_MUX_I2S1 0x00
	25	#define CX18_AI1_MUX_I2S2 0x10
	26	#define CX18_AI1_MUX_843_I2S 0x20
	27	#define CX18_AI1_MUX_INVALID 0x30
	28
1c1e45d1 HV	29	#define FWFILE "v4l-cx23418-dig.fw"
1c1e45d1 HV	30
1bd8e15a AW	31	static int cx18_av_verifyfw(struct cx18 cx, const struct firmware fw)
	32	{
	33	struct v4l2_subdev *sd = &cx->av_state.sd;
	34	int ret = 0;
	35	const u8 *data;
	36	u32 size;
	37	int addr;
	38	u32 expected, dl_control;
	39
	40	/* Ensure we put the 8051 in reset and enable firmware upload mode */
	41	dl_control = cx18_av_read4(cx, CXADEC_DL_CTL);
	42	do {
	43	dl_control &= 0x00ffffff;
	44	dl_control \|= 0x0f000000;
	45	cx18_av_write4_noretry(cx, CXADEC_DL_CTL, dl_control);
	46	dl_control = cx18_av_read4(cx, CXADEC_DL_CTL);
	47	} while ((dl_control & 0xff000000) != 0x0f000000);
	48
	49	/* Read and auto increment until at address 0x0000 */
	50	while (dl_control & 0x3fff)
	51	dl_control = cx18_av_read4(cx, CXADEC_DL_CTL);
	52
	53	data = fw->data;
	54	size = fw->size;
	55	for (addr = 0; addr < size; addr++) {
	56	dl_control &= 0xffff3fff; /* ignore top 2 bits of address */
	57	expected = 0x0f000000 \| ((u32)data[addr] << 16) \| addr;
	58	if (expected != dl_control) {
6beb1388	59	CX18_ERR_DEV(sd, "verification of %s firmware load failed: expected %#010x got %#010x\n",
1bd8e15a AW	60	FWFILE, expected, dl_control);
	61	ret = -EIO;
	62	break;
	63	}
	64	dl_control = cx18_av_read4(cx, CXADEC_DL_CTL);
	65	}
	66	if (ret == 0)
	67	CX18_INFO_DEV(sd, "verified load of %s firmware (%d bytes)\n",
	68	FWFILE, size);
	69	return ret;
	70	}
	71
1c1e45d1 HV	72	int cx18_av_loadfw(struct cx18 *cx)
1c1e45d1 HV	73	{
6246d4e1	74	struct v4l2_subdev *sd = &cx->av_state.sd;
1c1e45d1 HV	75	const struct firmware *fw = NULL;
1c1e45d1 HV	76	u32 size;
33b55a0a	77	u32 u, v;
9b8a3e4c	78	const u8 *ptr;
1c1e45d1	79	int i;
c6eb8eaf	80	int retries1 = 0;
1c1e45d1	81
3d05913d	82	if (request_firmware(&fw, FWFILE, &cx->pci_dev->dev) != 0) {
6246d4e1	83	CX18_ERR_DEV(sd, "unable to open firmware %s\n", FWFILE);
1c1e45d1 HV	84	return -EINVAL;
	85	}
	86
f313da11 HV	87	/* The firmware load often has byte errors, so allow for several
f313da11 HV	88	retries, both at byte level and at the firmware load level. */
c6eb8eaf	89	while (retries1 < 5) {
ced07371 AW	90	cx18_av_write4_expect(cx, CXADEC_CHIP_CTRL, 0x00010000,
	91	0x00008430, 0xffffffff); /* cx25843 */
	92	cx18_av_write_expect(cx, CXADEC_STD_DET_CTL, 0xf6, 0xf6, 0xff);
1c1e45d1	93
ced07371 AW	94	/* Reset the Mako core, Register is alias of CXADEC_CHIP_CTRL */
	95	cx18_av_write4_expect(cx, 0x8100, 0x00010000,
	96	0x00008430, 0xffffffff); /* cx25843 */
1c1e45d1	97
f313da11	98	/* Put the 8051 in reset and enable firmware upload */
d267d851	99	cx18_av_write4_noretry(cx, CXADEC_DL_CTL, 0x0F000000);
1c1e45d1	100
f313da11 HV	101	ptr = fw->data;
f313da11 HV	102	size = fw->size;
1c1e45d1	103
f313da11 HV	104	for (i = 0; i < size; i++) {
	105	u32 dl_control = 0x0F000000 \| i \| ((u32)ptr[i] << 16);
	106	u32 value = 0;
c6eb8eaf	107	int retries2;
d267d851	108	int unrec_err = 0;
1c1e45d1	109
f7823f8f	110	for (retries2 = 0; retries2 < CX18_MAX_MMIO_WR_RETRIES;
d267d851 AW	111	retries2++) {
	112	cx18_av_write4_noretry(cx, CXADEC_DL_CTL,
	113	dl_control);
f313da11	114	udelay(10);
3f75c616	115	value = cx18_av_read4(cx, CXADEC_DL_CTL);
f313da11 HV	116	if (value == dl_control)
	117	break;
	118	/* Check if we can correct the byte by changing
	119	the address. We can only write the lower
	120	address byte of the address. */
	121	if ((value & 0x3F00) != (dl_control & 0x3F00)) {
d267d851	122	unrec_err = 1;
f313da11 HV	123	break;
	124	}
	125	}
f7823f8f	126	if (unrec_err \|\| retries2 >= CX18_MAX_MMIO_WR_RETRIES)
1c1e45d1 HV	127	break;
1c1e45d1 HV	128	}
f313da11 HV	129	if (i == size)
f313da11 HV	130	break;
c6eb8eaf	131	retries1++;
f313da11	132	}
c6eb8eaf	133	if (retries1 >= 5) {
6246d4e1	134	CX18_ERR_DEV(sd, "unable to load firmware %s\n", FWFILE);
f313da11 HV	135	release_firmware(fw);
f313da11 HV	136	return -EIO;
1c1e45d1 HV	137	}
1c1e45d1 HV	138
ced07371	139	cx18_av_write4_expect(cx, CXADEC_DL_CTL,
1bd8e15a AW	140	0x03000000 \| fw->size, 0x03000000, 0x13000000);
	141
	142	CX18_INFO_DEV(sd, "loaded %s firmware (%d bytes)\n", FWFILE, size);
	143
	144	if (cx18_av_verifyfw(cx, fw) == 0)
	145	cx18_av_write4_expect(cx, CXADEC_DL_CTL,
ced07371	146	0x13000000 \| fw->size, 0x13000000, 0x13000000);
1c1e45d1 HV	147
	148	/* Output to the 416 */
	149	cx18_av_and_or4(cx, CXADEC_PIN_CTRL1, ~0, 0x78000);
	150
	151	/* Audio input control 1 set to Sony mode */
	152	/* Audio output input 2 is 0 for slave operation input */
	153	/* 0xC4000914[5]: 0 = left sample on WS=0, 1 = left sample on WS=1 */
	154	/* 0xC4000914[7]: 0 = Philips mode, 1 = Sony mode (1st SCK rising edge
	155	after WS transition for first bit of audio word. */
	156	cx18_av_write4(cx, CXADEC_I2S_IN_CTL, 0x000000A0);
	157
	158	/* Audio output control 1 is set to Sony mode */
	159	/* Audio output control 2 is set to 1 for master mode */
	160	/* 0xC4000918[5]: 0 = left sample on WS=0, 1 = left sample on WS=1 */
	161	/* 0xC4000918[7]: 0 = Philips mode, 1 = Sony mode (1st SCK rising edge
	162	after WS transition for first bit of audio word. */
	163	/* 0xC4000918[8]: 0 = slave operation, 1 = master (SCK_OUT and WS_OUT
	164	are generated) */
	165	cx18_av_write4(cx, CXADEC_I2S_OUT_CTL, 0x000001A0);
	166
903bfeac	167	/* set alt I2s master clock to /0x16 and enable alt divider i2s
1c1e45d1	168	passthrough */
903bfeac	169	cx18_av_write4(cx, CXADEC_PIN_CFG3, 0x5600B687);
1c1e45d1	170
ced07371 AW	171	cx18_av_write4_expect(cx, CXADEC_STD_DET_CTL, 0x000000F6, 0x000000F6,
ced07371 AW	172	0x3F00FFFF);
1c1e45d1 HV	173	/* CxDevWrReg(CXADEC_STD_DET_CTL, 0x000000FF); */
	174
	175	/* Set bit 0 in register 0x9CC to signify that this is MiniMe. */
	176	/* Register 0x09CC is defined by the Merlin firmware, and doesn't
	177	have a name in the spec. */
	178	cx18_av_write4(cx, 0x09CC, 1);
	179
b1526421 AW	180	v = cx18_read_reg(cx, CX18_AUDIO_ENABLE);
b1526421 AW	181	/* If bit 11 is 1, clear bit 10 */
1c1e45d1	182	if (v & 0x800)
072e6183 AW	183	cx18_write_reg_expect(cx, v & 0xFFFFFBFF, CX18_AUDIO_ENABLE,
072e6183 AW	184	0, 0x400);
1c1e45d1	185
33b55a0a AW	186	/* Toggle the AI1 MUX */
	187	v = cx18_read_reg(cx, CX18_AUDIO_ENABLE);
	188	u = v & CX18_AI1_MUX_MASK;
	189	v &= ~CX18_AI1_MUX_MASK;
	190	if (u == CX18_AI1_MUX_843_I2S \|\| u == CX18_AI1_MUX_INVALID) {
	191	/* Switch to I2S1 */
	192	v \|= CX18_AI1_MUX_I2S1;
	193	cx18_write_reg_expect(cx, v \| 0xb00, CX18_AUDIO_ENABLE,
	194	v, CX18_AI1_MUX_MASK);
	195	/* Switch back to the A/V decoder core I2S output */
	196	v = (v & ~CX18_AI1_MUX_MASK) \| CX18_AI1_MUX_843_I2S;
	197	} else {
	198	/* Switch to the A/V decoder core I2S output */
	199	v \|= CX18_AI1_MUX_843_I2S;
	200	cx18_write_reg_expect(cx, v \| 0xb00, CX18_AUDIO_ENABLE,
	201	v, CX18_AI1_MUX_MASK);
	202	/* Switch back to I2S1 or I2S2 */
	203	v = (v & ~CX18_AI1_MUX_MASK) \| u;
	204	}
	205	cx18_write_reg_expect(cx, v \| 0xb00, CX18_AUDIO_ENABLE,
	206	v, CX18_AI1_MUX_MASK);
	207
1c1e45d1 HV	208	/* Enable WW auto audio standard detection */
	209	v = cx18_av_read4(cx, CXADEC_STD_DET_CTL);
	210	v \|= 0xFF; /* Auto by default */
	211	v \|= 0x400; /* Stereo by default */
	212	v \|= 0x14000000;
ced07371	213	cx18_av_write4_expect(cx, CXADEC_STD_DET_CTL, v, v, 0x3F00FFFF);
1c1e45d1 HV	214
1c1e45d1 HV	215	release_firmware(fw);
1c1e45d1 HV	216	return 0;
1c1e45d1 HV	217	}
8a7bf1d4 TG	218
8a7bf1d4 TG	219	MODULE_FIRMWARE(FWFILE);