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, 0x006C)},
148 {USB_DEVICE(0x0DF6, 0x0064)},
150 {USB_DEVICE(0x14b2, 0x3300)},
151 {USB_DEVICE(0x14b2, 0x3301)},
152 {USB_DEVICE(0x14B2, 0x3302)},
154 {USB_DEVICE(0x04F2, 0xAFF2)},
155 {USB_DEVICE(0x04F2, 0xAFF5)},
156 {USB_DEVICE(0x04F2, 0xAFF6)},
157 {USB_DEVICE(0x13D3, 0x3339)},
158 {USB_DEVICE(0x13D3, 0x3340)}, /* 11n mode disable */
159 {USB_DEVICE(0x13D3, 0x3341)}, /* 11n mode disable */
160 {USB_DEVICE(0x13D3, 0x3310)},
161 {USB_DEVICE(0x13D3, 0x3325)},
165 {USB_DEVICE(0x0BDA, 0x8174)},
167 {USB_DEVICE(0x050D, 0x845A)},
169 {USB_DEVICE(0x07AA, 0x0051)},
171 {USB_DEVICE(0x7392, 0x7622)},
173 {USB_DEVICE(0x0409, 0x02B6)},
177 MODULE_DEVICE_TABLE(usb, rtl871x_usb_id_tbl);
179 static struct specific_device_id specific_device_id_tbl[] = {
180 {.idVendor = 0x0b05, .idProduct = 0x1791,
181 .flags = SPEC_DEV_ID_DISABLE_HT},
182 {.idVendor = 0x0df6, .idProduct = 0x0059,
183 .flags = SPEC_DEV_ID_DISABLE_HT},
184 {.idVendor = 0x13d3, .idProduct = 0x3306,
185 .flags = SPEC_DEV_ID_DISABLE_HT},
186 {.idVendor = 0x13D3, .idProduct = 0x3311,
187 .flags = SPEC_DEV_ID_DISABLE_HT},
188 {.idVendor = 0x13d3, .idProduct = 0x3335,
189 .flags = SPEC_DEV_ID_DISABLE_HT},
190 {.idVendor = 0x13d3, .idProduct = 0x3336,
191 .flags = SPEC_DEV_ID_DISABLE_HT},
192 {.idVendor = 0x13d3, .idProduct = 0x3340,
193 .flags = SPEC_DEV_ID_DISABLE_HT},
194 {.idVendor = 0x13d3, .idProduct = 0x3341,
195 .flags = SPEC_DEV_ID_DISABLE_HT},
200 struct usb_driver r871xu_drv;
205 static int r871x_suspend(struct usb_interface *pusb_intf, pm_message_t state)
207 struct net_device *pnetdev = usb_get_intfdata(pusb_intf);
209 netdev_info(pnetdev, "Suspending...\n");
210 if (!pnetdev || !netif_running(pnetdev)) {
211 netdev_info(pnetdev, "Unable to suspend\n");
214 if (pnetdev->netdev_ops->ndo_stop)
215 pnetdev->netdev_ops->ndo_stop(pnetdev);
217 netif_device_detach(pnetdev);
221 static int r871x_resume(struct usb_interface *pusb_intf)
223 struct net_device *pnetdev = usb_get_intfdata(pusb_intf);
225 netdev_info(pnetdev, "Resuming...\n");
226 if (!pnetdev || !netif_running(pnetdev)) {
227 netdev_info(pnetdev, "Unable to resume\n");
230 netif_device_attach(pnetdev);
231 if (pnetdev->netdev_ops->ndo_open)
232 pnetdev->netdev_ops->ndo_open(pnetdev);
236 static int r871x_reset_resume(struct usb_interface *pusb_intf)
244 static struct drv_priv drvpriv = {
245 .r871xu_drv.name = "r8712u",
246 .r871xu_drv.id_table = rtl871x_usb_id_tbl,
247 .r871xu_drv.probe = r871xu_drv_init,
248 .r871xu_drv.disconnect = r871xu_dev_remove,
250 .r871xu_drv.suspend = r871x_suspend,
251 .r871xu_drv.resume = r871x_resume,
252 .r871xu_drv.reset_resume = r871x_reset_resume,
256 static uint r8712_usb_dvobj_init(struct _adapter *padapter)
258 uint status = _SUCCESS;
259 struct usb_host_interface *phost_iface;
260 struct usb_interface_descriptor *piface_desc;
261 struct dvobj_priv *pdvobjpriv = &padapter->dvobjpriv;
262 struct usb_device *pusbd = pdvobjpriv->pusbdev;
264 pdvobjpriv->padapter = padapter;
265 padapter->EepromAddressSize = 6;
266 phost_iface = &pintf->altsetting[0];
267 piface_desc = &phost_iface->desc;
268 pdvobjpriv->nr_endpoint = piface_desc->bNumEndpoints;
269 if (pusbd->speed == USB_SPEED_HIGH) {
270 pdvobjpriv->ishighspeed = true;
271 dev_info(&pusbd->dev, "r8712u: USB_SPEED_HIGH with %d endpoints\n",
272 pdvobjpriv->nr_endpoint);
274 pdvobjpriv->ishighspeed = false;
275 dev_info(&pusbd->dev, "r8712u: USB_SPEED_LOW with %d endpoints\n",
276 pdvobjpriv->nr_endpoint);
278 if ((r8712_alloc_io_queue(padapter)) == _FAIL)
283 static void r8712_usb_dvobj_deinit(struct _adapter *padapter)
287 void rtl871x_intf_stop(struct _adapter *padapter)
289 /*disable_hw_interrupt*/
290 if (!padapter->bSurpriseRemoved) {
291 /*device still exists, so driver can do i/o operation
296 if (padapter->dvobjpriv.inirp_deinit)
297 padapter->dvobjpriv.inirp_deinit(padapter);
299 r8712_usb_write_port_cancel(padapter);
300 /* TODO:cancel other irps */
303 void r871x_dev_unload(struct _adapter *padapter)
307 padapter->bDriverStopped = true;
310 rtl871x_intf_stop(padapter);
313 r8712_stop_drv_threads(padapter);
316 if (!padapter->bSurpriseRemoved) {
317 padapter->hw_init_completed = false;
318 rtl8712_hal_deinit(padapter);
322 if (padapter->dvobj_deinit)
323 padapter->dvobj_deinit(padapter);
324 padapter->bup = false;
328 static void disable_ht_for_spec_devid(const struct usb_device_id *pdid,
329 struct _adapter *padapter)
334 int num = ARRAY_SIZE(specific_device_id_tbl);
336 for (i = 0; i < num; i++) {
337 vid = specific_device_id_tbl[i].idVendor;
338 pid = specific_device_id_tbl[i].idProduct;
339 flags = specific_device_id_tbl[i].flags;
341 if ((pdid->idVendor == vid) && (pdid->idProduct == pid) &&
342 (flags & SPEC_DEV_ID_DISABLE_HT)) {
343 padapter->registrypriv.ht_enable = 0;
344 padapter->registrypriv.cbw40_enable = 0;
345 padapter->registrypriv.ampdu_enable = 0;
350 static const struct device_type wlan_type = {
355 * drv_init() - a device potentially for us
357 * notes: drv_init() is called when the bus driver has located a card for us
358 * to support. We accept the new device by returning 0.
360 static int r871xu_drv_init(struct usb_interface *pusb_intf,
361 const struct usb_device_id *pdid)
364 struct _adapter *padapter = NULL;
365 struct dvobj_priv *pdvobjpriv;
366 struct net_device *pnetdev;
367 struct usb_device *udev;
369 /* In this probe function, O.S. will provide the usb interface pointer
370 * to driver. We have to increase the reference count of the usb device
371 * structure by using the usb_get_dev function.
373 udev = interface_to_usbdev(pusb_intf);
377 pnetdev = r8712_init_netdev();
380 padapter = netdev_priv(pnetdev);
381 disable_ht_for_spec_devid(pdid, padapter);
382 pdvobjpriv = &padapter->dvobjpriv;
383 pdvobjpriv->padapter = padapter;
384 padapter->dvobjpriv.pusbdev = udev;
385 padapter->pusb_intf = pusb_intf;
386 usb_set_intfdata(pusb_intf, pnetdev);
387 SET_NETDEV_DEV(pnetdev, &pusb_intf->dev);
388 pnetdev->dev.type = &wlan_type;
390 padapter->dvobj_init = &r8712_usb_dvobj_init;
391 padapter->dvobj_deinit = &r8712_usb_dvobj_deinit;
392 padapter->halpriv.hal_bus_init = &r8712_usb_hal_bus_init;
393 padapter->dvobjpriv.inirp_init = &r8712_usb_inirp_init;
394 padapter->dvobjpriv.inirp_deinit = &r8712_usb_inirp_deinit;
396 * initialize the dvobj_priv
398 if (!padapter->dvobj_init) {
401 status = padapter->dvobj_init(padapter);
402 if (status != _SUCCESS)
406 status = r8712_init_drv_sw(padapter);
409 /* step 5. read efuse/eeprom data and get mac_addr */
413 u8 tmpU1b, AutoloadFail, eeprom_CustomerID;
414 u8 *pdata = padapter->eeprompriv.efuse_eeprom_data;
416 tmpU1b = r8712_read8(padapter, EE_9346CR);/*CR9346*/
418 /* To check system boot selection.*/
419 dev_info(&udev->dev, "r8712u: Boot from %s: Autoload %s\n",
420 (tmpU1b & _9356SEL) ? "EEPROM" : "EFUSE",
421 (tmpU1b & _EEPROM_EN) ? "OK" : "Failed");
423 /* To check autoload success or not.*/
424 if (tmpU1b & _EEPROM_EN) {
426 /* The following operations prevent Efuse leakage by
429 tmpU1b = r8712_read8(padapter, EFUSE_TEST + 3);
430 r8712_write8(padapter, EFUSE_TEST + 3, tmpU1b | 0x80);
432 r8712_write8(padapter, EFUSE_TEST + 3,
433 (tmpU1b & (~BIT(7))));
435 /* Retrieve Chip version.
436 * Recognize IC version by Reg0x4 BIT15.
438 tmpU1b = (u8)((r8712_read32(padapter, PMC_FSM) >> 15) &
441 padapter->registrypriv.chip_version =
444 padapter->registrypriv.chip_version =
446 switch (padapter->registrypriv.chip_version) {
452 padapter->registrypriv.chip_version =
457 for (i = 0, offset = 0; i < 128; i += 8, offset++)
458 r8712_efuse_pg_packet_read(padapter, offset,
461 if (!r8712_initmac || !mac_pton(r8712_initmac, mac)) {
462 /* Use the mac address stored in the Efuse
463 * offset = 0x12 for usb in efuse
465 ether_addr_copy(mac, &pdata[0x12]);
467 eeprom_CustomerID = pdata[0x52];
468 switch (eeprom_CustomerID) {
469 case EEPROM_CID_ALPHA:
470 padapter->eeprompriv.CustomerID =
473 case EEPROM_CID_CAMEO:
474 padapter->eeprompriv.CustomerID =
477 case EEPROM_CID_SITECOM:
478 padapter->eeprompriv.CustomerID =
481 case EEPROM_CID_COREGA:
482 padapter->eeprompriv.CustomerID =
485 case EEPROM_CID_Senao:
486 padapter->eeprompriv.CustomerID =
489 case EEPROM_CID_EDIMAX_BELKIN:
490 padapter->eeprompriv.CustomerID =
491 RT_CID_819x_Edimax_Belkin;
493 case EEPROM_CID_SERCOMM_BELKIN:
494 padapter->eeprompriv.CustomerID =
495 RT_CID_819x_Sercomm_Belkin;
497 case EEPROM_CID_WNC_COREGA:
498 padapter->eeprompriv.CustomerID =
499 RT_CID_819x_WNC_COREGA;
501 case EEPROM_CID_WHQL:
503 case EEPROM_CID_NetCore:
504 padapter->eeprompriv.CustomerID =
507 case EEPROM_CID_CAMEO1:
508 padapter->eeprompriv.CustomerID =
511 case EEPROM_CID_CLEVO:
512 padapter->eeprompriv.CustomerID =
516 padapter->eeprompriv.CustomerID =
520 dev_info(&udev->dev, "r8712u: CustomerID = 0x%.4x\n",
521 padapter->eeprompriv.CustomerID);
523 switch (padapter->eeprompriv.CustomerID) {
525 case RT_CID_819x_ALPHA:
526 case RT_CID_819x_CAMEO:
527 padapter->ledpriv.LedStrategy = SW_LED_MODE1;
528 padapter->ledpriv.bRegUseLed = true;
530 case RT_CID_819x_Sitecom:
531 padapter->ledpriv.LedStrategy = SW_LED_MODE2;
532 padapter->ledpriv.bRegUseLed = true;
535 case RT_CID_819x_Senao:
536 padapter->ledpriv.LedStrategy = SW_LED_MODE3;
537 padapter->ledpriv.bRegUseLed = true;
539 case RT_CID_819x_Edimax_Belkin:
540 padapter->ledpriv.LedStrategy = SW_LED_MODE4;
541 padapter->ledpriv.bRegUseLed = true;
543 case RT_CID_819x_Sercomm_Belkin:
544 padapter->ledpriv.LedStrategy = SW_LED_MODE5;
545 padapter->ledpriv.bRegUseLed = true;
547 case RT_CID_819x_WNC_COREGA:
548 padapter->ledpriv.LedStrategy = SW_LED_MODE6;
549 padapter->ledpriv.bRegUseLed = true;
552 padapter->ledpriv.LedStrategy = SW_LED_MODE0;
553 padapter->ledpriv.bRegUseLed = false;
557 AutoloadFail = false;
559 if (((mac[0] == 0xff) && (mac[1] == 0xff) &&
560 (mac[2] == 0xff) && (mac[3] == 0xff) &&
561 (mac[4] == 0xff) && (mac[5] == 0xff)) ||
562 ((mac[0] == 0x00) && (mac[1] == 0x00) &&
563 (mac[2] == 0x00) && (mac[3] == 0x00) &&
564 (mac[4] == 0x00) && (mac[5] == 0x00)) ||
574 /* Make sure the user did not select a multicast
575 * address by setting bit 1 of first octet.
579 "r8712u: MAC Address from user = %pM\n", mac);
582 "r8712u: MAC Address from efuse = %pM\n", mac);
583 ether_addr_copy(pnetdev->dev_addr, mac);
585 /* step 6. Load the firmware asynchronously */
586 if (rtl871x_load_fw(padapter))
588 spin_lock_init(&padapter->lockRxFF0Filter);
589 mutex_init(&padapter->mutex_start);
593 usb_set_intfdata(pusb_intf, NULL);
594 if (padapter && padapter->dvobj_deinit != NULL)
595 padapter->dvobj_deinit(padapter);
597 free_netdev(pnetdev);
601 /* rmmod module & unplug(SurpriseRemoved) will call r871xu_dev_remove()
602 * => how to recognize both */
603 static void r871xu_dev_remove(struct usb_interface *pusb_intf)
605 struct net_device *pnetdev = usb_get_intfdata(pusb_intf);
606 struct usb_device *udev = interface_to_usbdev(pusb_intf);
609 struct _adapter *padapter = netdev_priv(pnetdev);
611 usb_set_intfdata(pusb_intf, NULL);
612 release_firmware(padapter->fw);
613 /* never exit with a firmware callback pending */
614 wait_for_completion(&padapter->rtl8712_fw_ready);
615 if (drvpriv.drv_registered)
616 padapter->bSurpriseRemoved = true;
617 unregister_netdev(pnetdev); /* will call netdev_close() */
618 flush_scheduled_work();
620 /* Stop driver mlme relation timer */
621 r8712_stop_drv_timers(padapter);
622 r871x_dev_unload(padapter);
623 r8712_free_drv_sw(padapter);
625 /* decrease the reference count of the usb device structure
629 /* If we didn't unplug usb dongle and remove/insert module, driver
630 * fails on sitesurvey for the first time when device is up.
631 * Reset usb port for sitesurvey fail issue. */
632 if (udev->state != USB_STATE_NOTATTACHED)
633 usb_reset_device(udev);
636 static int __init r8712u_drv_entry(void)
638 drvpriv.drv_registered = true;
639 return usb_register(&drvpriv.r871xu_drv);
642 static void __exit r8712u_drv_halt(void)
644 drvpriv.drv_registered = false;
645 usb_deregister(&drvpriv.r871xu_drv);
648 module_init(r8712u_drv_entry);
649 module_exit(r8712u_drv_halt);