1 /******************************************************************************
4 * Copyright(c) 2007 - 2010 Realtek Corporation. All rights reserved.
5 * Linux device driver for RTL8192SU
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of version 2 of the GNU General Public License as
9 * published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 * You should have received a copy of the GNU General Public License along with
17 * this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
20 * Modifications for inclusion into the Linux staging tree are
21 * Copyright(c) 2010 Larry Finger. All rights reserved.
23 * Contact information:
24 * WLAN FAE <wlanfae@realtek.com>
25 * Larry Finger <Larry.Finger@lwfinger.net>
27 ******************************************************************************/
31 #include <linux/usb.h>
32 #include <linux/module.h>
33 #include <linux/firmware.h>
35 #include "osdep_service.h"
36 #include "drv_types.h"
37 #include "recv_osdep.h"
38 #include "xmit_osdep.h"
39 #include "rtl8712_efuse.h"
41 #include "usb_osintf.h"
43 static struct usb_interface *pintf;
45 static int r871xu_drv_init(struct usb_interface *pusb_intf,
46 const struct usb_device_id *pdid);
48 static void r871xu_dev_remove(struct usb_interface *pusb_intf);
50 static struct usb_device_id rtl871x_usb_id_tbl[] = {
54 {USB_DEVICE(0x0BDA, 0x8171)},
55 {USB_DEVICE(0x0bda, 0x8173)},
56 {USB_DEVICE(0x0bda, 0x8712)},
57 {USB_DEVICE(0x0bda, 0x8713)},
58 {USB_DEVICE(0x0bda, 0xC512)},
60 {USB_DEVICE(0x07B8, 0x8188)},
62 {USB_DEVICE(0x0B05, 0x1786)},
63 {USB_DEVICE(0x0B05, 0x1791)}, /* 11n mode disable */
65 {USB_DEVICE(0x050D, 0x945A)},
66 /* ISY IWL - Belkin clone */
67 {USB_DEVICE(0x050D, 0x11F1)},
69 {USB_DEVICE(0x07AA, 0x0047)},
71 {USB_DEVICE(0x2001, 0x3306)},
72 {USB_DEVICE(0x07D1, 0x3306)}, /* 11n mode disable */
74 {USB_DEVICE(0x7392, 0x7611)},
76 {USB_DEVICE(0x1740, 0x9603)},
78 {USB_DEVICE(0x0E66, 0x0016)},
80 {USB_DEVICE(0x06F8, 0xE034)},
81 {USB_DEVICE(0x06F8, 0xE032)},
83 {USB_DEVICE(0x0789, 0x0167)},
85 {USB_DEVICE(0x2019, 0xAB28)},
86 {USB_DEVICE(0x2019, 0xED16)},
88 {USB_DEVICE(0x0DF6, 0x0057)},
89 {USB_DEVICE(0x0DF6, 0x0045)},
90 {USB_DEVICE(0x0DF6, 0x0059)}, /* 11n mode disable */
91 {USB_DEVICE(0x0DF6, 0x004B)},
92 {USB_DEVICE(0x0DF6, 0x005B)},
93 {USB_DEVICE(0x0DF6, 0x005D)},
94 {USB_DEVICE(0x0DF6, 0x0063)},
96 {USB_DEVICE(0x177F, 0x0154)},
98 {USB_DEVICE(0x0BDA, 0x5077)},
100 {USB_DEVICE(0x1690, 0x0752)},
102 {USB_DEVICE(0x20F4, 0x646B)},
103 {USB_DEVICE(0x083A, 0xC512)},
104 {USB_DEVICE(0x25D4, 0x4CA1)},
105 {USB_DEVICE(0x25D4, 0x4CAB)},
109 {USB_DEVICE(0x0BDA, 0x8172)},
110 {USB_DEVICE(0x0BDA, 0x8192)},
112 {USB_DEVICE(0x0EB0, 0x9061)},
114 {USB_DEVICE(0x13D3, 0x3323)},
115 {USB_DEVICE(0x13D3, 0x3311)}, /* 11n mode disable */
116 {USB_DEVICE(0x13D3, 0x3342)},
118 {USB_DEVICE(0x13D3, 0x3333)},
119 {USB_DEVICE(0x13D3, 0x3334)},
120 {USB_DEVICE(0x13D3, 0x3335)}, /* 11n mode disable */
121 {USB_DEVICE(0x13D3, 0x3336)}, /* 11n mode disable */
123 {USB_DEVICE(0x13D3, 0x3309)},
125 {USB_DEVICE(0x050D, 0x815F)},
127 {USB_DEVICE(0x07D1, 0x3302)},
128 {USB_DEVICE(0x07D1, 0x3300)},
129 {USB_DEVICE(0x07D1, 0x3303)},
131 {USB_DEVICE(0x7392, 0x7612)},
133 {USB_DEVICE(0x1740, 0x9605)},
135 {USB_DEVICE(0x06F8, 0xE031)},
137 {USB_DEVICE(0x0E66, 0x0015)},
139 {USB_DEVICE(0x13D3, 0x3306)},
141 {USB_DEVICE(0x2019, 0xED18)},
142 {USB_DEVICE(0x2019, 0x4901)},
144 {USB_DEVICE(0x0DF6, 0x0058)},
145 {USB_DEVICE(0x0DF6, 0x0049)},
146 {USB_DEVICE(0x0DF6, 0x004C)},
147 {USB_DEVICE(0x0DF6, 0x0064)},
149 {USB_DEVICE(0x14b2, 0x3300)},
150 {USB_DEVICE(0x14b2, 0x3301)},
151 {USB_DEVICE(0x14B2, 0x3302)},
153 {USB_DEVICE(0x04F2, 0xAFF2)},
154 {USB_DEVICE(0x04F2, 0xAFF5)},
155 {USB_DEVICE(0x04F2, 0xAFF6)},
156 {USB_DEVICE(0x13D3, 0x3339)},
157 {USB_DEVICE(0x13D3, 0x3340)}, /* 11n mode disable */
158 {USB_DEVICE(0x13D3, 0x3341)}, /* 11n mode disable */
159 {USB_DEVICE(0x13D3, 0x3310)},
160 {USB_DEVICE(0x13D3, 0x3325)},
164 {USB_DEVICE(0x0BDA, 0x8174)},
166 {USB_DEVICE(0x050D, 0x845A)},
168 {USB_DEVICE(0x07AA, 0x0051)},
170 {USB_DEVICE(0x7392, 0x7622)},
172 {USB_DEVICE(0x0409, 0x02B6)},
176 MODULE_DEVICE_TABLE(usb, rtl871x_usb_id_tbl);
178 static struct specific_device_id specific_device_id_tbl[] = {
179 {.idVendor = 0x0b05, .idProduct = 0x1791,
180 .flags = SPEC_DEV_ID_DISABLE_HT},
181 {.idVendor = 0x0df6, .idProduct = 0x0059,
182 .flags = SPEC_DEV_ID_DISABLE_HT},
183 {.idVendor = 0x13d3, .idProduct = 0x3306,
184 .flags = SPEC_DEV_ID_DISABLE_HT},
185 {.idVendor = 0x13D3, .idProduct = 0x3311,
186 .flags = SPEC_DEV_ID_DISABLE_HT},
187 {.idVendor = 0x13d3, .idProduct = 0x3335,
188 .flags = SPEC_DEV_ID_DISABLE_HT},
189 {.idVendor = 0x13d3, .idProduct = 0x3336,
190 .flags = SPEC_DEV_ID_DISABLE_HT},
191 {.idVendor = 0x13d3, .idProduct = 0x3340,
192 .flags = SPEC_DEV_ID_DISABLE_HT},
193 {.idVendor = 0x13d3, .idProduct = 0x3341,
194 .flags = SPEC_DEV_ID_DISABLE_HT},
199 struct usb_driver r871xu_drv;
204 static int r871x_suspend(struct usb_interface *pusb_intf, pm_message_t state)
206 struct net_device *pnetdev = usb_get_intfdata(pusb_intf);
208 printk(KERN_INFO "r8712: suspending...\n");
209 if (!pnetdev || !netif_running(pnetdev)) {
210 printk(KERN_INFO "r8712: unable to suspend\n");
213 if (pnetdev->netdev_ops->ndo_stop)
214 pnetdev->netdev_ops->ndo_stop(pnetdev);
216 netif_device_detach(pnetdev);
220 static int r871x_resume(struct usb_interface *pusb_intf)
222 struct net_device *pnetdev = usb_get_intfdata(pusb_intf);
224 printk(KERN_INFO "r8712: resuming...\n");
225 if (!pnetdev || !netif_running(pnetdev)) {
226 printk(KERN_INFO "r8712: unable to resume\n");
229 netif_device_attach(pnetdev);
230 if (pnetdev->netdev_ops->ndo_open)
231 pnetdev->netdev_ops->ndo_open(pnetdev);
235 static int r871x_reset_resume(struct usb_interface *pusb_intf)
243 static struct drv_priv drvpriv = {
244 .r871xu_drv.name = "r8712u",
245 .r871xu_drv.id_table = rtl871x_usb_id_tbl,
246 .r871xu_drv.probe = r871xu_drv_init,
247 .r871xu_drv.disconnect = r871xu_dev_remove,
249 .r871xu_drv.suspend = r871x_suspend,
250 .r871xu_drv.resume = r871x_resume,
251 .r871xu_drv.reset_resume = r871x_reset_resume,
255 static uint r8712_usb_dvobj_init(struct _adapter *padapter)
257 uint status = _SUCCESS;
258 struct usb_device_descriptor *pdev_desc;
259 struct usb_host_config *phost_conf;
260 struct usb_config_descriptor *pconf_desc;
261 struct usb_host_interface *phost_iface;
262 struct usb_interface_descriptor *piface_desc;
263 struct dvobj_priv *pdvobjpriv = &padapter->dvobjpriv;
264 struct usb_device *pusbd = pdvobjpriv->pusbdev;
266 pdvobjpriv->padapter = padapter;
267 padapter->EepromAddressSize = 6;
268 pdev_desc = &pusbd->descriptor;
269 phost_conf = pusbd->actconfig;
270 pconf_desc = &phost_conf->desc;
271 phost_iface = &pintf->altsetting[0];
272 piface_desc = &phost_iface->desc;
273 pdvobjpriv->nr_endpoint = piface_desc->bNumEndpoints;
274 if (pusbd->speed == USB_SPEED_HIGH) {
275 pdvobjpriv->ishighspeed = true;
276 printk(KERN_INFO "r8712u: USB_SPEED_HIGH with %d endpoints\n",
277 pdvobjpriv->nr_endpoint);
279 pdvobjpriv->ishighspeed = false;
280 printk(KERN_INFO "r8712u: USB_SPEED_LOW with %d endpoints\n",
281 pdvobjpriv->nr_endpoint);
283 if ((r8712_alloc_io_queue(padapter)) == _FAIL)
288 static void r8712_usb_dvobj_deinit(struct _adapter *padapter)
292 void rtl871x_intf_stop(struct _adapter *padapter)
294 /*disable_hw_interrupt*/
295 if (padapter->bSurpriseRemoved == false) {
296 /*device still exists, so driver can do i/o operation
301 if (padapter->dvobjpriv.inirp_deinit != NULL)
302 padapter->dvobjpriv.inirp_deinit(padapter);
304 r8712_usb_write_port_cancel(padapter);
305 /* TODO:cancel other irps */
308 void r871x_dev_unload(struct _adapter *padapter)
310 if (padapter->bup == true) {
312 padapter->bDriverStopped = true;
315 rtl871x_intf_stop(padapter);
318 r8712_stop_drv_threads(padapter);
321 if (padapter->bSurpriseRemoved == false) {
322 padapter->hw_init_completed = false;
323 rtl8712_hal_deinit(padapter);
327 if (padapter->dvobj_deinit)
328 padapter->dvobj_deinit(padapter);
329 padapter->bup = false;
333 static void disable_ht_for_spec_devid(const struct usb_device_id *pdid,
334 struct _adapter *padapter)
339 int num = sizeof(specific_device_id_tbl) /
340 sizeof(struct specific_device_id);
342 for (i = 0; i < num; i++) {
343 vid = specific_device_id_tbl[i].idVendor;
344 pid = specific_device_id_tbl[i].idProduct;
345 flags = specific_device_id_tbl[i].flags;
347 if ((pdid->idVendor == vid) && (pdid->idProduct == pid) &&
348 (flags&SPEC_DEV_ID_DISABLE_HT)) {
349 padapter->registrypriv.ht_enable = 0;
350 padapter->registrypriv.cbw40_enable = 0;
351 padapter->registrypriv.ampdu_enable = 0;
356 static u8 key_2char2num(u8 hch, u8 lch)
358 return (hex_to_bin(hch) << 4) | hex_to_bin(lch);
362 * drv_init() - a device potentially for us
364 * notes: drv_init() is called when the bus driver has located a card for us
365 * to support. We accept the new device by returning 0.
367 static int r871xu_drv_init(struct usb_interface *pusb_intf,
368 const struct usb_device_id *pdid)
371 struct _adapter *padapter = NULL;
372 struct dvobj_priv *pdvobjpriv;
373 struct net_device *pnetdev;
374 struct usb_device *udev;
376 printk(KERN_INFO "r8712u: Staging version\n");
377 /* In this probe function, O.S. will provide the usb interface pointer
378 * to driver. We have to increase the reference count of the usb device
379 * structure by using the usb_get_dev function.
381 udev = interface_to_usbdev(pusb_intf);
385 pnetdev = r8712_init_netdev();
388 padapter = netdev_priv(pnetdev);
389 disable_ht_for_spec_devid(pdid, padapter);
390 pdvobjpriv = &padapter->dvobjpriv;
391 pdvobjpriv->padapter = padapter;
392 padapter->dvobjpriv.pusbdev = udev;
393 padapter->pusb_intf = pusb_intf;
394 usb_set_intfdata(pusb_intf, pnetdev);
395 SET_NETDEV_DEV(pnetdev, &pusb_intf->dev);
397 padapter->dvobj_init = &r8712_usb_dvobj_init;
398 padapter->dvobj_deinit = &r8712_usb_dvobj_deinit;
399 padapter->halpriv.hal_bus_init = &r8712_usb_hal_bus_init;
400 padapter->dvobjpriv.inirp_init = &r8712_usb_inirp_init;
401 padapter->dvobjpriv.inirp_deinit = &r8712_usb_inirp_deinit;
403 * initialize the dvobj_priv
405 if (padapter->dvobj_init == NULL)
408 status = padapter->dvobj_init(padapter);
409 if (status != _SUCCESS)
413 status = r8712_init_drv_sw(padapter);
416 /* step 5. read efuse/eeprom data and get mac_addr */
420 u8 tmpU1b, AutoloadFail, eeprom_CustomerID;
421 u8 *pdata = padapter->eeprompriv.efuse_eeprom_data;
423 tmpU1b = r8712_read8(padapter, EE_9346CR);/*CR9346*/
425 /* To check system boot selection.*/
426 printk(KERN_INFO "r8712u: Boot from %s: Autoload %s\n",
427 (tmpU1b & _9356SEL) ? "EEPROM" : "EFUSE",
428 (tmpU1b & _EEPROM_EN) ? "OK" : "Failed");
430 /* To check autoload success or not.*/
431 if (tmpU1b & _EEPROM_EN) {
433 /* The following operations prevent Efuse leakage by
436 tmpU1b = r8712_read8(padapter, EFUSE_TEST+3);
437 r8712_write8(padapter, EFUSE_TEST + 3, tmpU1b | 0x80);
439 r8712_write8(padapter, EFUSE_TEST + 3,
440 (tmpU1b & (~BIT(7))));
442 /* Retrieve Chip version.
443 * Recognize IC version by Reg0x4 BIT15.
445 tmpU1b = (u8)((r8712_read32(padapter, PMC_FSM) >> 15) &
448 padapter->registrypriv.chip_version =
451 padapter->registrypriv.chip_version =
453 switch (padapter->registrypriv.chip_version) {
459 padapter->registrypriv.chip_version =
464 for (i = 0, offset = 0; i < 128; i += 8, offset++)
465 r8712_efuse_pg_packet_read(padapter, offset,
469 /* Users specify the mac address */
472 for (jj = 0, kk = 0; jj < ETH_ALEN;
475 key_2char2num(r8712_initmac[kk],
476 r8712_initmac[kk + 1]);
478 /* Use the mac address stored in the Efuse
479 * offset = 0x12 for usb in efuse
481 memcpy(mac, &pdata[0x12], ETH_ALEN);
483 eeprom_CustomerID = pdata[0x52];
484 switch (eeprom_CustomerID) {
485 case EEPROM_CID_ALPHA:
486 padapter->eeprompriv.CustomerID =
489 case EEPROM_CID_CAMEO:
490 padapter->eeprompriv.CustomerID =
493 case EEPROM_CID_SITECOM:
494 padapter->eeprompriv.CustomerID =
497 case EEPROM_CID_COREGA:
498 padapter->eeprompriv.CustomerID =
501 case EEPROM_CID_Senao:
502 padapter->eeprompriv.CustomerID =
505 case EEPROM_CID_EDIMAX_BELKIN:
506 padapter->eeprompriv.CustomerID =
507 RT_CID_819x_Edimax_Belkin;
509 case EEPROM_CID_SERCOMM_BELKIN:
510 padapter->eeprompriv.CustomerID =
511 RT_CID_819x_Sercomm_Belkin;
513 case EEPROM_CID_WNC_COREGA:
514 padapter->eeprompriv.CustomerID =
515 RT_CID_819x_WNC_COREGA;
517 case EEPROM_CID_WHQL:
519 case EEPROM_CID_NetCore:
520 padapter->eeprompriv.CustomerID =
523 case EEPROM_CID_CAMEO1:
524 padapter->eeprompriv.CustomerID =
527 case EEPROM_CID_CLEVO:
528 padapter->eeprompriv.CustomerID =
532 padapter->eeprompriv.CustomerID =
536 printk(KERN_INFO "r8712u: CustomerID = 0x%.4x\n",
537 padapter->eeprompriv.CustomerID);
539 switch (padapter->eeprompriv.CustomerID) {
541 case RT_CID_819x_ALPHA:
542 case RT_CID_819x_CAMEO:
543 padapter->ledpriv.LedStrategy = SW_LED_MODE1;
544 padapter->ledpriv.bRegUseLed = true;
546 case RT_CID_819x_Sitecom:
547 padapter->ledpriv.LedStrategy = SW_LED_MODE2;
548 padapter->ledpriv.bRegUseLed = true;
551 case RT_CID_819x_Senao:
552 padapter->ledpriv.LedStrategy = SW_LED_MODE3;
553 padapter->ledpriv.bRegUseLed = true;
555 case RT_CID_819x_Edimax_Belkin:
556 padapter->ledpriv.LedStrategy = SW_LED_MODE4;
557 padapter->ledpriv.bRegUseLed = true;
559 case RT_CID_819x_Sercomm_Belkin:
560 padapter->ledpriv.LedStrategy = SW_LED_MODE5;
561 padapter->ledpriv.bRegUseLed = true;
563 case RT_CID_819x_WNC_COREGA:
564 padapter->ledpriv.LedStrategy = SW_LED_MODE6;
565 padapter->ledpriv.bRegUseLed = true;
568 padapter->ledpriv.LedStrategy = SW_LED_MODE0;
569 padapter->ledpriv.bRegUseLed = false;
573 AutoloadFail = false;
574 if (((mac[0] == 0xff) && (mac[1] == 0xff) &&
575 (mac[2] == 0xff) && (mac[3] == 0xff) &&
576 (mac[4] == 0xff) && (mac[5] == 0xff)) ||
577 ((mac[0] == 0x00) && (mac[1] == 0x00) &&
578 (mac[2] == 0x00) && (mac[3] == 0x00) &&
579 (mac[4] == 0x00) && (mac[5] == 0x00)) ||
580 (AutoloadFail == false)) {
589 /* Make sure the user did not select a multicast
590 * address by setting bit 1 of first octet.
593 printk(KERN_INFO "r8712u: MAC Address from user = "
596 printk(KERN_INFO "r8712u: MAC Address from efuse = "
598 memcpy(pnetdev->dev_addr, mac, ETH_ALEN);
600 /* step 6. Load the firmware asynchronously */
601 if (rtl871x_load_fw(padapter))
603 spin_lock_init(&padapter->lockRxFF0Filter);
604 mutex_init(&padapter->mutex_start);
608 usb_set_intfdata(pusb_intf, NULL);
609 if (padapter->dvobj_deinit != NULL)
610 padapter->dvobj_deinit(padapter);
612 free_netdev(pnetdev);
616 /* rmmod module & unplug(SurpriseRemoved) will call r871xu_dev_remove()
617 * => how to recognize both */
618 static void r871xu_dev_remove(struct usb_interface *pusb_intf)
620 struct net_device *pnetdev = usb_get_intfdata(pusb_intf);
621 struct _adapter *padapter = netdev_priv(pnetdev);
622 struct usb_device *udev = interface_to_usbdev(pusb_intf);
624 usb_set_intfdata(pusb_intf, NULL);
625 if (padapter->fw_found)
626 release_firmware(padapter->fw);
627 /* never exit with a firmware callback pending */
628 wait_for_completion(&padapter->rtl8712_fw_ready);
629 if (drvpriv.drv_registered == true)
630 padapter->bSurpriseRemoved = true;
631 if (pnetdev != NULL) {
632 /* will call netdev_close() */
633 unregister_netdev(pnetdev);
635 flush_scheduled_work();
637 /*Stop driver mlme relation timer */
638 if (padapter->fw_found)
639 r8712_stop_drv_timers(padapter);
640 r871x_dev_unload(padapter);
641 r8712_free_drv_sw(padapter);
642 usb_set_intfdata(pusb_intf, NULL);
643 /* decrease the reference count of the usb device structure
646 /* If we didn't unplug usb dongle and remove/insert module, driver
647 * fails on sitesurvey for the first time when device is up.
648 * Reset usb port for sitesurvey fail issue. */
649 if (udev->state != USB_STATE_NOTATTACHED)
650 usb_reset_device(udev);
654 static int __init r8712u_drv_entry(void)
656 drvpriv.drv_registered = true;
657 return usb_register(&drvpriv.r871xu_drv);
660 static void __exit r8712u_drv_halt(void)
662 drvpriv.drv_registered = false;
663 usb_deregister(&drvpriv.r871xu_drv);
664 printk(KERN_INFO "r8712u: Driver unloaded\n");
667 module_init(r8712u_drv_entry);
668 module_exit(r8712u_drv_halt);