[mirror_ubuntu-zesty-kernel.git] / drivers / staging / rtl8188eu / hal / fw.c

/******************************************************************************
 *
 * Copyright(c) 2009-2013  Realtek Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
 *
 * The full GNU General Public License is included in this distribution in the
 * file called LICENSE.
 *
 * Contact Information:
 * wlanfae <wlanfae@realtek.com>
 * Realtek Corporation, No. 2, Innovation Road II, Hsinchu Science Park,
 * Hsinchu 300, Taiwan.
 *
 * Larry Finger <Larry.Finger@lwfinger.net>
 *
 *****************************************************************************/

#include "fw.h"
#include "drv_types.h"
#include "usb_ops_linux.h"
#include "rtl8188e_spec.h"
#include "rtl8188e_hal.h"

#include <linux/firmware.h>
#include <linux/kmemleak.h>

static void _rtl88e_enable_fw_download(struct adapter *adapt, bool enable)
{
	u8 tmp;

	if (enable) {
		tmp = usb_read8(adapt, REG_MCUFWDL);
		usb_write8(adapt, REG_MCUFWDL, tmp | 0x01);

		tmp = usb_read8(adapt, REG_MCUFWDL + 2);
		usb_write8(adapt, REG_MCUFWDL + 2, tmp & 0xf7);
	} else {
		tmp = usb_read8(adapt, REG_MCUFWDL);
		usb_write8(adapt, REG_MCUFWDL, tmp & 0xfe);

		usb_write8(adapt, REG_MCUFWDL + 1, 0x00);
	}
}

static void _rtl88e_fw_block_write(struct adapter *adapt,
				   const u8 *buffer, u32 size)
{
	u32 blk_sz = sizeof(u32);
	u8 *buf_ptr = (u8 *)buffer;
	u32 *pu4BytePtr = (u32 *)buffer;
	u32 i, offset, blk_cnt, remain;

	blk_cnt = size / blk_sz;
	remain = size % blk_sz;

	for (i = 0; i < blk_cnt; i++) {
		offset = i * blk_sz;
		usb_write32(adapt, (FW_8192C_START_ADDRESS + offset),
				*(pu4BytePtr + i));
	}

	if (remain) {
		offset = blk_cnt * blk_sz;
		buf_ptr += offset;
		for (i = 0; i < remain; i++) {
			usb_write8(adapt, (FW_8192C_START_ADDRESS +
						 offset + i), *(buf_ptr + i));
		}
	}
}

static void _rtl88e_fill_dummy(u8 *pfwbuf, u32 *pfwlen)
{
	u32 fwlen = *pfwlen;
	u8 remain = (u8)(fwlen % 4);

	remain = (remain == 0) ? 0 : (4 - remain);

	while (remain > 0) {
		pfwbuf[fwlen] = 0;
		fwlen++;
		remain--;
	}

	*pfwlen = fwlen;
}

static void _rtl88e_fw_page_write(struct adapter *adapt,
				  u32 page, const u8 *buffer, u32 size)
{
	u8 value8;
	u8 u8page = (u8)(page & 0x07);

	value8 = (usb_read8(adapt, REG_MCUFWDL + 2) & 0xF8) | u8page;

	usb_write8(adapt, (REG_MCUFWDL + 2), value8);
	_rtl88e_fw_block_write(adapt, buffer, size);
}

static void _rtl88e_write_fw(struct adapter *adapt, u8 *buffer, u32 size)
{
	u8 *buf_ptr = buffer;
	u32 page_no, remain;
	u32 page, offset;

	_rtl88e_fill_dummy(buf_ptr, &size);

	page_no = size / FW_8192C_PAGE_SIZE;
	remain = size % FW_8192C_PAGE_SIZE;

	for (page = 0; page < page_no; page++) {
		offset = page * FW_8192C_PAGE_SIZE;
		_rtl88e_fw_page_write(adapt, page, (buf_ptr + offset),
				      FW_8192C_PAGE_SIZE);
	}

	if (remain) {
		offset = page_no * FW_8192C_PAGE_SIZE;
		page = page_no;
		_rtl88e_fw_page_write(adapt, page, (buf_ptr + offset), remain);
	}
}

static void rtl88e_firmware_selfreset(struct adapter *adapt)
{
	u8 u1b_tmp;

	u1b_tmp = usb_read8(adapt, REG_SYS_FUNC_EN+1);
	usb_write8(adapt, REG_SYS_FUNC_EN+1, (u1b_tmp & (~BIT(2))));
	usb_write8(adapt, REG_SYS_FUNC_EN+1, (u1b_tmp | BIT(2)));
}

static int _rtl88e_fw_free_to_go(struct adapter *adapt)
{
	int err = -EIO;
	u32 counter = 0;
	u32 value32;

	do {
		value32 = usb_read32(adapt, REG_MCUFWDL);
		if (value32 & FWDL_ChkSum_rpt)
			break;
	} while (counter++ < POLLING_READY_TIMEOUT_COUNT);

	if (counter >= POLLING_READY_TIMEOUT_COUNT)
		goto exit;

	value32 = usb_read32(adapt, REG_MCUFWDL);
	value32 |= MCUFWDL_RDY;
	value32 &= ~WINTINI_RDY;
	usb_write32(adapt, REG_MCUFWDL, value32);

	rtl88e_firmware_selfreset(adapt);
	counter = 0;

	do {
		value32 = usb_read32(adapt, REG_MCUFWDL);
		if (value32 & WINTINI_RDY) {
			err = 0;
			goto exit;
		}

		udelay(FW_8192C_POLLING_DELAY);

	} while (counter++ < POLLING_READY_TIMEOUT_COUNT);

exit:
	return err;
}

int rtl88eu_download_fw(struct adapter *adapt)
{
	struct hal_data_8188e *rtlhal = GET_HAL_DATA(adapt);
	struct dvobj_priv *dvobj = adapter_to_dvobj(adapt);
	struct device *device = dvobj_to_dev(dvobj);
	const struct firmware *fw;
	const char fw_name[] = "rtlwifi/rtl8188eufw.bin";
	struct rtl92c_firmware_header *pfwheader = NULL;
	u8 *pfwdata;
	u32 fwsize;
	int err;

	if (request_firmware(&fw, fw_name, device)) {
		dev_err(device, "Firmware %s not available\n", fw_name);
		return -ENOENT;
	}

	if (fw->size > FW_8188E_SIZE) {
		dev_err(device, "Firmware size exceed 0x%X. Check it.\n",
			 FW_8188E_SIZE);
		return -1;
	}

	pfwdata = kzalloc(FW_8188E_SIZE, GFP_KERNEL);
	if (!pfwdata)
		return -ENOMEM;

	rtlhal->pfirmware = pfwdata;
	memcpy(rtlhal->pfirmware, fw->data, fw->size);
	rtlhal->fwsize = fw->size;
	release_firmware(fw);

	fwsize = rtlhal->fwsize;
	pfwheader = (struct rtl92c_firmware_header *)pfwdata;

	if (IS_FW_HEADER_EXIST(pfwheader)) {
		pfwdata = pfwdata + 32;
		fwsize = fwsize - 32;
	}

	if (usb_read8(adapt, REG_MCUFWDL) & RAM_DL_SEL) {
		usb_write8(adapt, REG_MCUFWDL, 0);
		rtl88e_firmware_selfreset(adapt);
	}
	_rtl88e_enable_fw_download(adapt, true);
	usb_write8(adapt, REG_MCUFWDL, usb_read8(adapt, REG_MCUFWDL) | FWDL_ChkSum_rpt);
	_rtl88e_write_fw(adapt, pfwdata, fwsize);
	_rtl88e_enable_fw_download(adapt, false);

	err = _rtl88e_fw_free_to_go(adapt);

	return err;
}
Commit	Line	Data
d6c28c23	1	/******************************************************************************
	2	*
	3	* Copyright(c) 2009-2013 Realtek Corporation.
	4	*
	5	* This program is free software; you can redistribute it and/or modify it
	6	* under the terms of version 2 of the GNU General Public License as
	7	* published by the Free Software Foundation.
	8	*
	9	* This program is distributed in the hope that it will be useful, but WITHOUT
	10	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	11	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	12	* more details.
	13	*
	14	* You should have received a copy of the GNU General Public License along with
	15	* this program; if not, write to the Free Software Foundation, Inc.,
	16	* 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
	17	*
	18	* The full GNU General Public License is included in this distribution in the
	19	* file called LICENSE.
	20	*
	21	* Contact Information:
	22	* wlanfae <wlanfae@realtek.com>
	23	* Realtek Corporation, No. 2, Innovation Road II, Hsinchu Science Park,
	24	* Hsinchu 300, Taiwan.
	25	*
	26	* Larry Finger <Larry.Finger@lwfinger.net>
	27	*
	28	*****************************************************************************/
	29
	30	#include "fw.h"
	31	#include "drv_types.h"
	32	#include "usb_ops_linux.h"
	33	#include "rtl8188e_spec.h"
	34	#include "rtl8188e_hal.h"
	35
	36	#include <linux/firmware.h>
	37	#include <linux/kmemleak.h>
	38
	39	static void _rtl88e_enable_fw_download(struct adapter *adapt, bool enable)
	40	{
	41	u8 tmp;
	42
	43	if (enable) {
	44	tmp = usb_read8(adapt, REG_MCUFWDL);
	45	usb_write8(adapt, REG_MCUFWDL, tmp \| 0x01);
	46
	47	tmp = usb_read8(adapt, REG_MCUFWDL + 2);
	48	usb_write8(adapt, REG_MCUFWDL + 2, tmp & 0xf7);
	49	} else {
	50	tmp = usb_read8(adapt, REG_MCUFWDL);
	51	usb_write8(adapt, REG_MCUFWDL, tmp & 0xfe);
	52
	53	usb_write8(adapt, REG_MCUFWDL + 1, 0x00);
	54	}
	55	}
	56
	57	static void _rtl88e_fw_block_write(struct adapter *adapt,
	58	const u8 *buffer, u32 size)
	59	{
	60	u32 blk_sz = sizeof(u32);
	61	u8 buf_ptr = (u8 )buffer;
	62	u32 pu4BytePtr = (u32 )buffer;
	63	u32 i, offset, blk_cnt, remain;
	64
65	blk_cnt = size / blk_sz;
66	remain = size % blk_sz;
67
68	for (i = 0; i < blk_cnt; i++) {
69	offset = i * blk_sz;
70	usb_write32(adapt, (FW_8192C_START_ADDRESS + offset),
71	*(pu4BytePtr + i));
72	}
73
74	if (remain) {
75	offset = blk_cnt * blk_sz;
76	buf_ptr += offset;
77	for (i = 0; i < remain; i++) {
78	usb_write8(adapt, (FW_8192C_START_ADDRESS +
79	offset + i), *(buf_ptr + i));
80	}
81	}
82	}
83
84	static void _rtl88e_fill_dummy(u8 pfwbuf, u32 pfwlen)
85	{
86	u32 fwlen = *pfwlen;
7be921a2	87	u8 remain = (u8)(fwlen % 4);
d6c28c23	88
	89	remain = (remain == 0) ? 0 : (4 - remain);
	90
	91	while (remain > 0) {
	92	pfwbuf[fwlen] = 0;
	93	fwlen++;
	94	remain--;
	95	}
	96
	97	*pfwlen = fwlen;
	98	}
	99
	100	static void _rtl88e_fw_page_write(struct adapter *adapt,
	101	u32 page, const u8 *buffer, u32 size)
	102	{
	103	u8 value8;
7be921a2	104	u8 u8page = (u8)(page & 0x07);
d6c28c23	105
	106	value8 = (usb_read8(adapt, REG_MCUFWDL + 2) & 0xF8) \| u8page;
	107
	108	usb_write8(adapt, (REG_MCUFWDL + 2), value8);
	109	_rtl88e_fw_block_write(adapt, buffer, size);
	110	}
	111
	112	static void _rtl88e_write_fw(struct adapter adapt, u8 buffer, u32 size)
	113	{
	114	u8 *buf_ptr = buffer;
	115	u32 page_no, remain;
	116	u32 page, offset;
	117
	118	_rtl88e_fill_dummy(buf_ptr, &size);
	119
	120	page_no = size / FW_8192C_PAGE_SIZE;
	121	remain = size % FW_8192C_PAGE_SIZE;
	122
	123	for (page = 0; page < page_no; page++) {
	124	offset = page * FW_8192C_PAGE_SIZE;
	125	_rtl88e_fw_page_write(adapt, page, (buf_ptr + offset),
	126	FW_8192C_PAGE_SIZE);
	127	}
	128
	129	if (remain) {
	130	offset = page_no * FW_8192C_PAGE_SIZE;
	131	page = page_no;
	132	_rtl88e_fw_page_write(adapt, page, (buf_ptr + offset), remain);
	133	}
	134	}
	135
	136	static void rtl88e_firmware_selfreset(struct adapter *adapt)
	137	{
	138	u8 u1b_tmp;
	139
	140	u1b_tmp = usb_read8(adapt, REG_SYS_FUNC_EN+1);
	141	usb_write8(adapt, REG_SYS_FUNC_EN+1, (u1b_tmp & (~BIT(2))));
	142	usb_write8(adapt, REG_SYS_FUNC_EN+1, (u1b_tmp \| BIT(2)));
	143	}
	144
	145	static int _rtl88e_fw_free_to_go(struct adapter *adapt)
	146	{
	147	int err = -EIO;
	148	u32 counter = 0;
	149	u32 value32;
	150
	151	do {
	152	value32 = usb_read32(adapt, REG_MCUFWDL);
	153	if (value32 & FWDL_ChkSum_rpt)
	154	break;
	155	} while (counter++ < POLLING_READY_TIMEOUT_COUNT);
	156
dacd2ece	157	if (counter >= POLLING_READY_TIMEOUT_COUNT)
d6c28c23	158	goto exit;
d6c28c23	159
	160	value32 = usb_read32(adapt, REG_MCUFWDL);
	161	value32 \|= MCUFWDL_RDY;
	162	value32 &= ~WINTINI_RDY;
	163	usb_write32(adapt, REG_MCUFWDL, value32);
	164
	165	rtl88e_firmware_selfreset(adapt);
	166	counter = 0;
	167
	168	do {
	169	value32 = usb_read32(adapt, REG_MCUFWDL);
	170	if (value32 & WINTINI_RDY) {
	171	err = 0;
	172	goto exit;
	173	}
	174
	175	udelay(FW_8192C_POLLING_DELAY);
	176
	177	} while (counter++ < POLLING_READY_TIMEOUT_COUNT);
	178
	179	exit:
	180	return err;
	181	}
	182
90d88de8	183	int rtl88eu_download_fw(struct adapter *adapt)
d6c28c23	184	{
	185	struct hal_data_8188e *rtlhal = GET_HAL_DATA(adapt);
	186	struct dvobj_priv *dvobj = adapter_to_dvobj(adapt);
	187	struct device *device = dvobj_to_dev(dvobj);
	188	const struct firmware *fw;
	189	const char fw_name[] = "rtlwifi/rtl8188eufw.bin";
	190	struct rtl92c_firmware_header *pfwheader = NULL;
	191	u8 *pfwdata;
	192	u32 fwsize;
	193	int err;
	194
7be921a2	195	if (request_firmware(&fw, fw_name, device)) {
d6c28c23	196	dev_err(device, "Firmware %s not available\n", fw_name);
	197	return -ENOENT;
	198	}
	199
	200	if (fw->size > FW_8188E_SIZE) {
7be921a2	201	dev_err(device, "Firmware size exceed 0x%X. Check it.\n",
d6c28c23	202	FW_8188E_SIZE);
	203	return -1;
	204	}
	205
	206	pfwdata = kzalloc(FW_8188E_SIZE, GFP_KERNEL);
	207	if (!pfwdata)
	208	return -ENOMEM;
	209
	210	rtlhal->pfirmware = pfwdata;
	211	memcpy(rtlhal->pfirmware, fw->data, fw->size);
	212	rtlhal->fwsize = fw->size;
	213	release_firmware(fw);
	214
	215	fwsize = rtlhal->fwsize;
	216	pfwheader = (struct rtl92c_firmware_header *)pfwdata;
	217
	218	if (IS_FW_HEADER_EXIST(pfwheader)) {
	219	pfwdata = pfwdata + 32;
	220	fwsize = fwsize - 32;
	221	}
	222
	223	if (usb_read8(adapt, REG_MCUFWDL) & RAM_DL_SEL) {
	224	usb_write8(adapt, REG_MCUFWDL, 0);
	225	rtl88e_firmware_selfreset(adapt);
	226	}
	227	_rtl88e_enable_fw_download(adapt, true);
	228	usb_write8(adapt, REG_MCUFWDL, usb_read8(adapt, REG_MCUFWDL) \| FWDL_ChkSum_rpt);
	229	_rtl88e_write_fw(adapt, pfwdata, fwsize);
	230	_rtl88e_enable_fw_download(adapt, false);
	231
	232	err = _rtl88e_fw_free_to_go(adapt);
	233
	234	return err;
	235	}