ath3k.c revision 07c0ea874d43c299d185948452945a361052b6e3 
1/*
2 * Copyright (c) 2008-2009 Atheros Communications Inc.
3 *
4 *  This program is free software; you can redistribute it and/or modify
5 *  it under the terms of the GNU General Public License as published by
6 *  the Free Software Foundation; either version 2 of the License, or
7 *  (at your option) any later version.
8 *
9 *  This program is distributed in the hope that it will be useful,
10 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
11 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 *  GNU General Public License for more details.
13 *
14 *  You should have received a copy of the GNU General Public License
15 *  along with this program; if not, write to the Free Software
16 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17 *
18 */
19
20
21#include <linux/module.h>
22#include <linux/kernel.h>
23#include <linux/init.h>
24#include <linux/slab.h>
25#include <linux/types.h>
26#include <linux/errno.h>
27#include <linux/device.h>
28#include <linux/firmware.h>
29#include <linux/usb.h>
30#include <net/bluetooth/bluetooth.h>
31
32#define VERSION "1.0"
33#define ATH3K_FIRMWARE	"ath3k-1.fw"
34
35#define ATH3K_DNLOAD				0x01
36#define ATH3K_GETSTATE				0x05
37#define ATH3K_SET_NORMAL_MODE			0x07
38#define ATH3K_GETVERSION			0x09
39#define USB_REG_SWITCH_VID_PID			0x0a
40
41#define ATH3K_MODE_MASK				0x3F
42#define ATH3K_NORMAL_MODE			0x0E
43
44#define ATH3K_PATCH_UPDATE			0x80
45#define ATH3K_SYSCFG_UPDATE			0x40
46
47#define ATH3K_XTAL_FREQ_26M			0x00
48#define ATH3K_XTAL_FREQ_40M			0x01
49#define ATH3K_XTAL_FREQ_19P2			0x02
50#define ATH3K_NAME_LEN				0xFF
51
52struct ath3k_version {
53	unsigned int	rom_version;
54	unsigned int	build_version;
55	unsigned int	ram_version;
56	unsigned char	ref_clock;
57	unsigned char	reserved[0x07];
58};
59
60static struct usb_device_id ath3k_table[] = {
61	/* Atheros AR3011 */
62	{ USB_DEVICE(0x0CF3, 0x3000) },
63
64	/* Atheros AR3011 with sflash firmware*/
65	{ USB_DEVICE(0x0CF3, 0x3002) },
66	{ USB_DEVICE(0x13d3, 0x3304) },
67	{ USB_DEVICE(0x0930, 0x0215) },
68	{ USB_DEVICE(0x0489, 0xE03D) },
69
70	/* Atheros AR9285 Malbec with sflash firmware */
71	{ USB_DEVICE(0x03F0, 0x311D) },
72
73	/* Atheros AR3012 with sflash firmware*/
74	{ USB_DEVICE(0x0CF3, 0x3004) },
75	{ USB_DEVICE(0x0CF3, 0x311D) },
76	{ USB_DEVICE(0x13d3, 0x3375) },
77
78	/* Atheros AR5BBU12 with sflash firmware */
79	{ USB_DEVICE(0x0489, 0xE02C) },
80
81	{ }	/* Terminating entry */
82};
83
84MODULE_DEVICE_TABLE(usb, ath3k_table);
85
86#define BTUSB_ATH3012		0x80
87/* This table is to load patch and sysconfig files
88 * for AR3012 */
89static struct usb_device_id ath3k_blist_tbl[] = {
90
91	/* Atheros AR3012 with sflash firmware*/
92	{ USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
93	{ USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
94	{ USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
95
96	{ }	/* Terminating entry */
97};
98
99#define USB_REQ_DFU_DNLOAD	1
100#define BULK_SIZE		4096
101#define FW_HDR_SIZE		20
102
103static int ath3k_load_firmware(struct usb_device *udev,
104				const struct firmware *firmware)
105{
106	u8 *send_buf;
107	int err, pipe, len, size, sent = 0;
108	int count = firmware->size;
109
110	BT_DBG("udev %p", udev);
111
112	pipe = usb_sndctrlpipe(udev, 0);
113
114	send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
115	if (!send_buf) {
116		BT_ERR("Can't allocate memory chunk for firmware");
117		return -ENOMEM;
118	}
119
120	memcpy(send_buf, firmware->data, 20);
121	if ((err = usb_control_msg(udev, pipe,
122				USB_REQ_DFU_DNLOAD,
123				USB_TYPE_VENDOR, 0, 0,
124				send_buf, 20, USB_CTRL_SET_TIMEOUT)) < 0) {
125		BT_ERR("Can't change to loading configuration err");
126		goto error;
127	}
128	sent += 20;
129	count -= 20;
130
131	while (count) {
132		size = min_t(uint, count, BULK_SIZE);
133		pipe = usb_sndbulkpipe(udev, 0x02);
134		memcpy(send_buf, firmware->data + sent, size);
135
136		err = usb_bulk_msg(udev, pipe, send_buf, size,
137					&len, 3000);
138
139		if (err || (len != size)) {
140			BT_ERR("Error in firmware loading err = %d,"
141				"len = %d, size = %d", err, len, size);
142			goto error;
143		}
144
145		sent  += size;
146		count -= size;
147	}
148
149error:
150	kfree(send_buf);
151	return err;
152}
153
154static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
155{
156	int pipe = 0;
157
158	pipe = usb_rcvctrlpipe(udev, 0);
159	return usb_control_msg(udev, pipe, ATH3K_GETSTATE,
160			USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
161			state, 0x01, USB_CTRL_SET_TIMEOUT);
162}
163
164static int ath3k_get_version(struct usb_device *udev,
165			struct ath3k_version *version)
166{
167	int pipe = 0;
168
169	pipe = usb_rcvctrlpipe(udev, 0);
170	return usb_control_msg(udev, pipe, ATH3K_GETVERSION,
171			USB_TYPE_VENDOR | USB_DIR_IN, 0, 0, version,
172			sizeof(struct ath3k_version),
173			USB_CTRL_SET_TIMEOUT);
174}
175
176static int ath3k_load_fwfile(struct usb_device *udev,
177		const struct firmware *firmware)
178{
179	u8 *send_buf;
180	int err, pipe, len, size, count, sent = 0;
181	int ret;
182
183	count = firmware->size;
184
185	send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
186	if (!send_buf) {
187		BT_ERR("Can't allocate memory chunk for firmware");
188		return -ENOMEM;
189	}
190
191	size = min_t(uint, count, FW_HDR_SIZE);
192	memcpy(send_buf, firmware->data, size);
193
194	pipe = usb_sndctrlpipe(udev, 0);
195	ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
196			USB_TYPE_VENDOR, 0, 0, send_buf,
197			size, USB_CTRL_SET_TIMEOUT);
198	if (ret < 0) {
199		BT_ERR("Can't change to loading configuration err");
200		kfree(send_buf);
201		return ret;
202	}
203
204	sent += size;
205	count -= size;
206
207	while (count) {
208		size = min_t(uint, count, BULK_SIZE);
209		pipe = usb_sndbulkpipe(udev, 0x02);
210
211		memcpy(send_buf, firmware->data + sent, size);
212
213		err = usb_bulk_msg(udev, pipe, send_buf, size,
214					&len, 3000);
215		if (err || (len != size)) {
216			BT_ERR("Error in firmware loading err = %d,"
217				"len = %d, size = %d", err, len, size);
218			kfree(send_buf);
219			return err;
220		}
221		sent  += size;
222		count -= size;
223	}
224
225	kfree(send_buf);
226	return 0;
227}
228
229static int ath3k_switch_pid(struct usb_device *udev)
230{
231	int pipe = 0;
232
233	pipe = usb_sndctrlpipe(udev, 0);
234	return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
235			USB_TYPE_VENDOR, 0, 0,
236			NULL, 0, USB_CTRL_SET_TIMEOUT);
237}
238
239static int ath3k_set_normal_mode(struct usb_device *udev)
240{
241	unsigned char fw_state;
242	int pipe = 0, ret;
243
244	ret = ath3k_get_state(udev, &fw_state);
245	if (ret < 0) {
246		BT_ERR("Can't get state to change to normal mode err");
247		return ret;
248	}
249
250	if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
251		BT_DBG("firmware was already in normal mode");
252		return 0;
253	}
254
255	pipe = usb_sndctrlpipe(udev, 0);
256	return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
257			USB_TYPE_VENDOR, 0, 0,
258			NULL, 0, USB_CTRL_SET_TIMEOUT);
259}
260
261static int ath3k_load_patch(struct usb_device *udev)
262{
263	unsigned char fw_state;
264	char filename[ATH3K_NAME_LEN] = {0};
265	const struct firmware *firmware;
266	struct ath3k_version fw_version, pt_version;
267	int ret;
268
269	ret = ath3k_get_state(udev, &fw_state);
270	if (ret < 0) {
271		BT_ERR("Can't get state to change to load ram patch err");
272		return ret;
273	}
274
275	if (fw_state & ATH3K_PATCH_UPDATE) {
276		BT_DBG("Patch was already downloaded");
277		return 0;
278	}
279
280	ret = ath3k_get_version(udev, &fw_version);
281	if (ret < 0) {
282		BT_ERR("Can't get version to change to load ram patch err");
283		return ret;
284	}
285
286	snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
287		fw_version.rom_version);
288
289	ret = request_firmware(&firmware, filename, &udev->dev);
290	if (ret < 0) {
291		BT_ERR("Patch file not found %s", filename);
292		return ret;
293	}
294
295	pt_version.rom_version = *(int *)(firmware->data + firmware->size - 8);
296	pt_version.build_version = *(int *)
297		(firmware->data + firmware->size - 4);
298
299	if ((pt_version.rom_version != fw_version.rom_version) ||
300		(pt_version.build_version <= fw_version.build_version)) {
301		BT_ERR("Patch file version did not match with firmware");
302		release_firmware(firmware);
303		return -EINVAL;
304	}
305
306	ret = ath3k_load_fwfile(udev, firmware);
307	release_firmware(firmware);
308
309	return ret;
310}
311
312static int ath3k_load_syscfg(struct usb_device *udev)
313{
314	unsigned char fw_state;
315	char filename[ATH3K_NAME_LEN] = {0};
316	const struct firmware *firmware;
317	struct ath3k_version fw_version;
318	int clk_value, ret;
319
320	ret = ath3k_get_state(udev, &fw_state);
321	if (ret < 0) {
322		BT_ERR("Can't get state to change to load configration err");
323		return -EBUSY;
324	}
325
326	ret = ath3k_get_version(udev, &fw_version);
327	if (ret < 0) {
328		BT_ERR("Can't get version to change to load ram patch err");
329		return ret;
330	}
331
332	switch (fw_version.ref_clock) {
333
334	case ATH3K_XTAL_FREQ_26M:
335		clk_value = 26;
336		break;
337	case ATH3K_XTAL_FREQ_40M:
338		clk_value = 40;
339		break;
340	case ATH3K_XTAL_FREQ_19P2:
341		clk_value = 19;
342		break;
343	default:
344		clk_value = 0;
345		break;
346	}
347
348	snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
349		fw_version.rom_version, clk_value, ".dfu");
350
351	ret = request_firmware(&firmware, filename, &udev->dev);
352	if (ret < 0) {
353		BT_ERR("Configuration file not found %s", filename);
354		return ret;
355	}
356
357	ret = ath3k_load_fwfile(udev, firmware);
358	release_firmware(firmware);
359
360	return ret;
361}
362
363static int ath3k_probe(struct usb_interface *intf,
364			const struct usb_device_id *id)
365{
366	const struct firmware *firmware;
367	struct usb_device *udev = interface_to_usbdev(intf);
368	int ret;
369
370	BT_DBG("intf %p id %p", intf, id);
371
372	if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
373		return -ENODEV;
374
375	/* match device ID in ath3k blacklist table */
376	if (!id->driver_info) {
377		const struct usb_device_id *match;
378		match = usb_match_id(intf, ath3k_blist_tbl);
379		if (match)
380			id = match;
381	}
382
383	/* load patch and sysconfig files for AR3012 */
384	if (id->driver_info & BTUSB_ATH3012) {
385
386		/* New firmware with patch and sysconfig files already loaded */
387		if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
388			return -ENODEV;
389
390		ret = ath3k_load_patch(udev);
391		if (ret < 0) {
392			BT_ERR("Loading patch file failed");
393			return ret;
394		}
395		ret = ath3k_load_syscfg(udev);
396		if (ret < 0) {
397			BT_ERR("Loading sysconfig file failed");
398			return ret;
399		}
400		ret = ath3k_set_normal_mode(udev);
401		if (ret < 0) {
402			BT_ERR("Set normal mode failed");
403			return ret;
404		}
405		ath3k_switch_pid(udev);
406		return 0;
407	}
408
409	ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev);
410	if (ret < 0) {
411		if (ret == -ENOENT)
412			BT_ERR("Firmware file \"%s\" not found",
413							ATH3K_FIRMWARE);
414		else
415			BT_ERR("Firmware file \"%s\" request failed (err=%d)",
416							ATH3K_FIRMWARE, ret);
417		return ret;
418	}
419
420	ret = ath3k_load_firmware(udev, firmware);
421	release_firmware(firmware);
422
423	return ret;
424}
425
426static void ath3k_disconnect(struct usb_interface *intf)
427{
428	BT_DBG("ath3k_disconnect intf %p", intf);
429}
430
431static struct usb_driver ath3k_driver = {
432	.name		= "ath3k",
433	.probe		= ath3k_probe,
434	.disconnect	= ath3k_disconnect,
435	.id_table	= ath3k_table,
436};
437
438module_usb_driver(ath3k_driver);
439
440MODULE_AUTHOR("Atheros Communications");
441MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
442MODULE_VERSION(VERSION);
443MODULE_LICENSE("GPL");
444MODULE_FIRMWARE(ATH3K_FIRMWARE);
445