Bluetooth: hci_vhci.c: removes unnecessary semicolon
[linux-3.10.git] / drivers / bluetooth / ath3k.c
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
52 struct 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
60 static 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(0x0CF3, 0xE019) },
67         { USB_DEVICE(0x13d3, 0x3304) },
68         { USB_DEVICE(0x0930, 0x0215) },
69         { USB_DEVICE(0x0489, 0xE03D) },
70
71         /* Atheros AR9285 Malbec with sflash firmware */
72         { USB_DEVICE(0x03F0, 0x311D) },
73
74         /* Atheros AR3012 with sflash firmware*/
75         { USB_DEVICE(0x0CF3, 0x3004) },
76         { USB_DEVICE(0x0CF3, 0x311D) },
77         { USB_DEVICE(0x13d3, 0x3375) },
78         { USB_DEVICE(0x04CA, 0x3005) },
79         { USB_DEVICE(0x13d3, 0x3362) },
80         { USB_DEVICE(0x0CF3, 0xE004) },
81         { USB_DEVICE(0x0930, 0x0219) },
82
83         /* Atheros AR5BBU12 with sflash firmware */
84         { USB_DEVICE(0x0489, 0xE02C) },
85
86         /* Atheros AR5BBU22 with sflash firmware */
87         { USB_DEVICE(0x0489, 0xE03C) },
88
89         { }     /* Terminating entry */
90 };
91
92 MODULE_DEVICE_TABLE(usb, ath3k_table);
93
94 #define BTUSB_ATH3012           0x80
95 /* This table is to load patch and sysconfig files
96  * for AR3012 */
97 static struct usb_device_id ath3k_blist_tbl[] = {
98
99         /* Atheros AR3012 with sflash firmware*/
100         { USB_DEVICE(0x0cf3, 0x3004), .driver_info = BTUSB_ATH3012 },
101         { USB_DEVICE(0x0cf3, 0x311D), .driver_info = BTUSB_ATH3012 },
102         { USB_DEVICE(0x13d3, 0x3375), .driver_info = BTUSB_ATH3012 },
103         { USB_DEVICE(0x04ca, 0x3005), .driver_info = BTUSB_ATH3012 },
104         { USB_DEVICE(0x13d3, 0x3362), .driver_info = BTUSB_ATH3012 },
105         { USB_DEVICE(0x0cf3, 0xe004), .driver_info = BTUSB_ATH3012 },
106         { USB_DEVICE(0x0930, 0x0219), .driver_info = BTUSB_ATH3012 },
107
108         /* Atheros AR5BBU22 with sflash firmware */
109         { USB_DEVICE(0x0489, 0xE03C), .driver_info = BTUSB_ATH3012 },
110
111         { }     /* Terminating entry */
112 };
113
114 #define USB_REQ_DFU_DNLOAD      1
115 #define BULK_SIZE               4096
116 #define FW_HDR_SIZE             20
117
118 static int ath3k_load_firmware(struct usb_device *udev,
119                                 const struct firmware *firmware)
120 {
121         u8 *send_buf;
122         int err, pipe, len, size, sent = 0;
123         int count = firmware->size;
124
125         BT_DBG("udev %p", udev);
126
127         pipe = usb_sndctrlpipe(udev, 0);
128
129         send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
130         if (!send_buf) {
131                 BT_ERR("Can't allocate memory chunk for firmware");
132                 return -ENOMEM;
133         }
134
135         memcpy(send_buf, firmware->data, 20);
136         if ((err = usb_control_msg(udev, pipe,
137                                 USB_REQ_DFU_DNLOAD,
138                                 USB_TYPE_VENDOR, 0, 0,
139                                 send_buf, 20, USB_CTRL_SET_TIMEOUT)) < 0) {
140                 BT_ERR("Can't change to loading configuration err");
141                 goto error;
142         }
143         sent += 20;
144         count -= 20;
145
146         while (count) {
147                 size = min_t(uint, count, BULK_SIZE);
148                 pipe = usb_sndbulkpipe(udev, 0x02);
149                 memcpy(send_buf, firmware->data + sent, size);
150
151                 err = usb_bulk_msg(udev, pipe, send_buf, size,
152                                         &len, 3000);
153
154                 if (err || (len != size)) {
155                         BT_ERR("Error in firmware loading err = %d,"
156                                 "len = %d, size = %d", err, len, size);
157                         goto error;
158                 }
159
160                 sent  += size;
161                 count -= size;
162         }
163
164 error:
165         kfree(send_buf);
166         return err;
167 }
168
169 static int ath3k_get_state(struct usb_device *udev, unsigned char *state)
170 {
171         int pipe = 0;
172
173         pipe = usb_rcvctrlpipe(udev, 0);
174         return usb_control_msg(udev, pipe, ATH3K_GETSTATE,
175                         USB_TYPE_VENDOR | USB_DIR_IN, 0, 0,
176                         state, 0x01, USB_CTRL_SET_TIMEOUT);
177 }
178
179 static int ath3k_get_version(struct usb_device *udev,
180                         struct ath3k_version *version)
181 {
182         int pipe = 0;
183
184         pipe = usb_rcvctrlpipe(udev, 0);
185         return usb_control_msg(udev, pipe, ATH3K_GETVERSION,
186                         USB_TYPE_VENDOR | USB_DIR_IN, 0, 0, version,
187                         sizeof(struct ath3k_version),
188                         USB_CTRL_SET_TIMEOUT);
189 }
190
191 static int ath3k_load_fwfile(struct usb_device *udev,
192                 const struct firmware *firmware)
193 {
194         u8 *send_buf;
195         int err, pipe, len, size, count, sent = 0;
196         int ret;
197
198         count = firmware->size;
199
200         send_buf = kmalloc(BULK_SIZE, GFP_KERNEL);
201         if (!send_buf) {
202                 BT_ERR("Can't allocate memory chunk for firmware");
203                 return -ENOMEM;
204         }
205
206         size = min_t(uint, count, FW_HDR_SIZE);
207         memcpy(send_buf, firmware->data, size);
208
209         pipe = usb_sndctrlpipe(udev, 0);
210         ret = usb_control_msg(udev, pipe, ATH3K_DNLOAD,
211                         USB_TYPE_VENDOR, 0, 0, send_buf,
212                         size, USB_CTRL_SET_TIMEOUT);
213         if (ret < 0) {
214                 BT_ERR("Can't change to loading configuration err");
215                 kfree(send_buf);
216                 return ret;
217         }
218
219         sent += size;
220         count -= size;
221
222         while (count) {
223                 size = min_t(uint, count, BULK_SIZE);
224                 pipe = usb_sndbulkpipe(udev, 0x02);
225
226                 memcpy(send_buf, firmware->data + sent, size);
227
228                 err = usb_bulk_msg(udev, pipe, send_buf, size,
229                                         &len, 3000);
230                 if (err || (len != size)) {
231                         BT_ERR("Error in firmware loading err = %d,"
232                                 "len = %d, size = %d", err, len, size);
233                         kfree(send_buf);
234                         return err;
235                 }
236                 sent  += size;
237                 count -= size;
238         }
239
240         kfree(send_buf);
241         return 0;
242 }
243
244 static int ath3k_switch_pid(struct usb_device *udev)
245 {
246         int pipe = 0;
247
248         pipe = usb_sndctrlpipe(udev, 0);
249         return usb_control_msg(udev, pipe, USB_REG_SWITCH_VID_PID,
250                         USB_TYPE_VENDOR, 0, 0,
251                         NULL, 0, USB_CTRL_SET_TIMEOUT);
252 }
253
254 static int ath3k_set_normal_mode(struct usb_device *udev)
255 {
256         unsigned char fw_state;
257         int pipe = 0, ret;
258
259         ret = ath3k_get_state(udev, &fw_state);
260         if (ret < 0) {
261                 BT_ERR("Can't get state to change to normal mode err");
262                 return ret;
263         }
264
265         if ((fw_state & ATH3K_MODE_MASK) == ATH3K_NORMAL_MODE) {
266                 BT_DBG("firmware was already in normal mode");
267                 return 0;
268         }
269
270         pipe = usb_sndctrlpipe(udev, 0);
271         return usb_control_msg(udev, pipe, ATH3K_SET_NORMAL_MODE,
272                         USB_TYPE_VENDOR, 0, 0,
273                         NULL, 0, USB_CTRL_SET_TIMEOUT);
274 }
275
276 static int ath3k_load_patch(struct usb_device *udev)
277 {
278         unsigned char fw_state;
279         char filename[ATH3K_NAME_LEN] = {0};
280         const struct firmware *firmware;
281         struct ath3k_version fw_version, pt_version;
282         int ret;
283
284         ret = ath3k_get_state(udev, &fw_state);
285         if (ret < 0) {
286                 BT_ERR("Can't get state to change to load ram patch err");
287                 return ret;
288         }
289
290         if (fw_state & ATH3K_PATCH_UPDATE) {
291                 BT_DBG("Patch was already downloaded");
292                 return 0;
293         }
294
295         ret = ath3k_get_version(udev, &fw_version);
296         if (ret < 0) {
297                 BT_ERR("Can't get version to change to load ram patch err");
298                 return ret;
299         }
300
301         snprintf(filename, ATH3K_NAME_LEN, "ar3k/AthrBT_0x%08x.dfu",
302                 fw_version.rom_version);
303
304         ret = request_firmware(&firmware, filename, &udev->dev);
305         if (ret < 0) {
306                 BT_ERR("Patch file not found %s", filename);
307                 return ret;
308         }
309
310         pt_version.rom_version = *(int *)(firmware->data + firmware->size - 8);
311         pt_version.build_version = *(int *)
312                 (firmware->data + firmware->size - 4);
313
314         if ((pt_version.rom_version != fw_version.rom_version) ||
315                 (pt_version.build_version <= fw_version.build_version)) {
316                 BT_ERR("Patch file version did not match with firmware");
317                 release_firmware(firmware);
318                 return -EINVAL;
319         }
320
321         ret = ath3k_load_fwfile(udev, firmware);
322         release_firmware(firmware);
323
324         return ret;
325 }
326
327 static int ath3k_load_syscfg(struct usb_device *udev)
328 {
329         unsigned char fw_state;
330         char filename[ATH3K_NAME_LEN] = {0};
331         const struct firmware *firmware;
332         struct ath3k_version fw_version;
333         int clk_value, ret;
334
335         ret = ath3k_get_state(udev, &fw_state);
336         if (ret < 0) {
337                 BT_ERR("Can't get state to change to load configration err");
338                 return -EBUSY;
339         }
340
341         ret = ath3k_get_version(udev, &fw_version);
342         if (ret < 0) {
343                 BT_ERR("Can't get version to change to load ram patch err");
344                 return ret;
345         }
346
347         switch (fw_version.ref_clock) {
348
349         case ATH3K_XTAL_FREQ_26M:
350                 clk_value = 26;
351                 break;
352         case ATH3K_XTAL_FREQ_40M:
353                 clk_value = 40;
354                 break;
355         case ATH3K_XTAL_FREQ_19P2:
356                 clk_value = 19;
357                 break;
358         default:
359                 clk_value = 0;
360                 break;
361         }
362
363         snprintf(filename, ATH3K_NAME_LEN, "ar3k/ramps_0x%08x_%d%s",
364                 fw_version.rom_version, clk_value, ".dfu");
365
366         ret = request_firmware(&firmware, filename, &udev->dev);
367         if (ret < 0) {
368                 BT_ERR("Configuration file not found %s", filename);
369                 return ret;
370         }
371
372         ret = ath3k_load_fwfile(udev, firmware);
373         release_firmware(firmware);
374
375         return ret;
376 }
377
378 static int ath3k_probe(struct usb_interface *intf,
379                         const struct usb_device_id *id)
380 {
381         const struct firmware *firmware;
382         struct usb_device *udev = interface_to_usbdev(intf);
383         int ret;
384
385         BT_DBG("intf %p id %p", intf, id);
386
387         if (intf->cur_altsetting->desc.bInterfaceNumber != 0)
388                 return -ENODEV;
389
390         /* match device ID in ath3k blacklist table */
391         if (!id->driver_info) {
392                 const struct usb_device_id *match;
393                 match = usb_match_id(intf, ath3k_blist_tbl);
394                 if (match)
395                         id = match;
396         }
397
398         /* load patch and sysconfig files for AR3012 */
399         if (id->driver_info & BTUSB_ATH3012) {
400
401                 /* New firmware with patch and sysconfig files already loaded */
402                 if (le16_to_cpu(udev->descriptor.bcdDevice) > 0x0001)
403                         return -ENODEV;
404
405                 ret = ath3k_load_patch(udev);
406                 if (ret < 0) {
407                         BT_ERR("Loading patch file failed");
408                         return ret;
409                 }
410                 ret = ath3k_load_syscfg(udev);
411                 if (ret < 0) {
412                         BT_ERR("Loading sysconfig file failed");
413                         return ret;
414                 }
415                 ret = ath3k_set_normal_mode(udev);
416                 if (ret < 0) {
417                         BT_ERR("Set normal mode failed");
418                         return ret;
419                 }
420                 ath3k_switch_pid(udev);
421                 return 0;
422         }
423
424         ret = request_firmware(&firmware, ATH3K_FIRMWARE, &udev->dev);
425         if (ret < 0) {
426                 if (ret == -ENOENT)
427                         BT_ERR("Firmware file \"%s\" not found",
428                                                         ATH3K_FIRMWARE);
429                 else
430                         BT_ERR("Firmware file \"%s\" request failed (err=%d)",
431                                                         ATH3K_FIRMWARE, ret);
432                 return ret;
433         }
434
435         ret = ath3k_load_firmware(udev, firmware);
436         release_firmware(firmware);
437
438         return ret;
439 }
440
441 static void ath3k_disconnect(struct usb_interface *intf)
442 {
443         BT_DBG("ath3k_disconnect intf %p", intf);
444 }
445
446 static struct usb_driver ath3k_driver = {
447         .name           = "ath3k",
448         .probe          = ath3k_probe,
449         .disconnect     = ath3k_disconnect,
450         .id_table       = ath3k_table,
451         .disable_hub_initiated_lpm = 1,
452 };
453
454 module_usb_driver(ath3k_driver);
455
456 MODULE_AUTHOR("Atheros Communications");
457 MODULE_DESCRIPTION("Atheros AR30xx firmware driver");
458 MODULE_VERSION(VERSION);
459 MODULE_LICENSE("GPL");
460 MODULE_FIRMWARE(ATH3K_FIRMWARE);