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"
40 #include "usb_vendor_req.h"
42 #include "usb_osintf.h"
44 static struct usb_interface
*pintf
;
46 static int r871xu_drv_init(struct usb_interface
*pusb_intf
,
47 const struct usb_device_id
*pdid
);
49 static void r871xu_dev_remove(struct usb_interface
*pusb_intf
);
51 static struct usb_device_id rtl871x_usb_id_tbl
[] = {
55 {USB_DEVICE(0x0BDA, 0x8171)},
56 {USB_DEVICE(0x0bda, 0x8173)},
57 {USB_DEVICE(0x0bda, 0x8712)},
58 {USB_DEVICE(0x0bda, 0x8713)},
59 {USB_DEVICE(0x0bda, 0xC512)},
61 {USB_DEVICE(0x07B8, 0x8188)},
63 {USB_DEVICE(0x0B05, 0x1786)},
64 {USB_DEVICE(0x0B05, 0x1791)}, /* 11n mode disable */
66 {USB_DEVICE(0x050D, 0x945A)},
68 {USB_DEVICE(0x07AA, 0x0047)},
70 {USB_DEVICE(0x2001, 0x3306)},
71 {USB_DEVICE(0x07D1, 0x3306)}, /* 11n mode disable */
73 {USB_DEVICE(0x7392, 0x7611)},
75 {USB_DEVICE(0x1740, 0x9603)},
77 {USB_DEVICE(0x0E66, 0x0016)},
79 {USB_DEVICE(0x06F8, 0xE034)},
80 {USB_DEVICE(0x06F8, 0xE032)},
82 {USB_DEVICE(0x0789, 0x0167)},
84 {USB_DEVICE(0x2019, 0xAB28)},
85 {USB_DEVICE(0x2019, 0xED16)},
87 {USB_DEVICE(0x0DF6, 0x0057)},
88 {USB_DEVICE(0x0DF6, 0x0045)},
89 {USB_DEVICE(0x0DF6, 0x0059)}, /* 11n mode disable */
90 {USB_DEVICE(0x0DF6, 0x004B)},
91 {USB_DEVICE(0x0DF6, 0x005B)},
92 {USB_DEVICE(0x0DF6, 0x005D)},
93 {USB_DEVICE(0x0DF6, 0x0063)},
95 {USB_DEVICE(0x177F, 0x0154)},
97 {USB_DEVICE(0x0BDA, 0x5077)},
99 {USB_DEVICE(0x1690, 0x0752)},
101 {USB_DEVICE(0x20F4, 0x646B)},
102 {USB_DEVICE(0x083A, 0xC512)},
103 {USB_DEVICE(0x25D4, 0x4CA1)},
104 {USB_DEVICE(0x25D4, 0x4CAB)},
108 {USB_DEVICE(0x0BDA, 0x8172)},
109 {USB_DEVICE(0x0BDA, 0x8192)},
111 {USB_DEVICE(0x0EB0, 0x9061)},
113 {USB_DEVICE(0x13D3, 0x3323)},
114 {USB_DEVICE(0x13D3, 0x3311)}, /* 11n mode disable */
115 {USB_DEVICE(0x13D3, 0x3342)},
117 {USB_DEVICE(0x13D3, 0x3333)},
118 {USB_DEVICE(0x13D3, 0x3334)},
119 {USB_DEVICE(0x13D3, 0x3335)}, /* 11n mode disable */
120 {USB_DEVICE(0x13D3, 0x3336)}, /* 11n mode disable */
122 {USB_DEVICE(0x13D3, 0x3309)},
124 {USB_DEVICE(0x050D, 0x815F)},
126 {USB_DEVICE(0x07D1, 0x3302)},
127 {USB_DEVICE(0x07D1, 0x3300)},
128 {USB_DEVICE(0x07D1, 0x3303)},
130 {USB_DEVICE(0x7392, 0x7612)},
132 {USB_DEVICE(0x1740, 0x9605)},
134 {USB_DEVICE(0x06F8, 0xE031)},
136 {USB_DEVICE(0x0E66, 0x0015)},
138 {USB_DEVICE(0x13D3, 0x3306)},
140 {USB_DEVICE(0x2019, 0xED18)},
141 {USB_DEVICE(0x2019, 0x4901)},
143 {USB_DEVICE(0x0DF6, 0x0058)},
144 {USB_DEVICE(0x0DF6, 0x0049)},
145 {USB_DEVICE(0x0DF6, 0x004C)},
146 {USB_DEVICE(0x0DF6, 0x0064)},
148 {USB_DEVICE(0x14b2, 0x3300)},
149 {USB_DEVICE(0x14b2, 0x3301)},
150 {USB_DEVICE(0x14B2, 0x3302)},
152 {USB_DEVICE(0x04F2, 0xAFF2)},
153 {USB_DEVICE(0x04F2, 0xAFF5)},
154 {USB_DEVICE(0x04F2, 0xAFF6)},
155 {USB_DEVICE(0x13D3, 0x3339)},
156 {USB_DEVICE(0x13D3, 0x3340)}, /* 11n mode disable */
157 {USB_DEVICE(0x13D3, 0x3341)}, /* 11n mode disable */
158 {USB_DEVICE(0x13D3, 0x3310)},
159 {USB_DEVICE(0x13D3, 0x3325)},
163 {USB_DEVICE(0x0BDA, 0x8174)},
165 {USB_DEVICE(0x050D, 0x845A)},
167 {USB_DEVICE(0x07AA, 0x0051)},
169 {USB_DEVICE(0x7392, 0x7622)},
171 {USB_DEVICE(0x0409, 0x02B6)},
175 MODULE_DEVICE_TABLE(usb
, rtl871x_usb_id_tbl
);
177 static struct specific_device_id specific_device_id_tbl
[] = {
178 {.idVendor
= 0x0b05, .idProduct
= 0x1791,
179 .flags
= SPEC_DEV_ID_DISABLE_HT
},
180 {.idVendor
= 0x0df6, .idProduct
= 0x0059,
181 .flags
= SPEC_DEV_ID_DISABLE_HT
},
182 {.idVendor
= 0x13d3, .idProduct
= 0x3306,
183 .flags
= SPEC_DEV_ID_DISABLE_HT
},
184 {.idVendor
= 0x13D3, .idProduct
= 0x3311,
185 .flags
= SPEC_DEV_ID_DISABLE_HT
},
186 {.idVendor
= 0x13d3, .idProduct
= 0x3335,
187 .flags
= SPEC_DEV_ID_DISABLE_HT
},
188 {.idVendor
= 0x13d3, .idProduct
= 0x3336,
189 .flags
= SPEC_DEV_ID_DISABLE_HT
},
190 {.idVendor
= 0x13d3, .idProduct
= 0x3340,
191 .flags
= SPEC_DEV_ID_DISABLE_HT
},
192 {.idVendor
= 0x13d3, .idProduct
= 0x3341,
193 .flags
= SPEC_DEV_ID_DISABLE_HT
},
198 struct usb_driver r871xu_drv
;
203 static int r871x_suspend(struct usb_interface
*pusb_intf
, pm_message_t state
)
205 struct net_device
*pnetdev
= usb_get_intfdata(pusb_intf
);
207 printk(KERN_INFO
"r8712: suspending...\n");
208 if (!pnetdev
|| !netif_running(pnetdev
)) {
209 printk(KERN_INFO
"r8712: unable to suspend\n");
212 if (pnetdev
->netdev_ops
->ndo_stop
)
213 pnetdev
->netdev_ops
->ndo_stop(pnetdev
);
215 netif_device_detach(pnetdev
);
219 static int r871x_resume(struct usb_interface
*pusb_intf
)
221 struct net_device
*pnetdev
= usb_get_intfdata(pusb_intf
);
223 printk(KERN_INFO
"r8712: resuming...\n");
224 if (!pnetdev
|| !netif_running(pnetdev
)) {
225 printk(KERN_INFO
"r8712: unable to resume\n");
228 netif_device_attach(pnetdev
);
229 if (pnetdev
->netdev_ops
->ndo_open
)
230 pnetdev
->netdev_ops
->ndo_open(pnetdev
);
234 static int r871x_reset_resume(struct usb_interface
*pusb_intf
)
242 static struct drv_priv drvpriv
= {
243 .r871xu_drv
.name
= "r8712u",
244 .r871xu_drv
.id_table
= rtl871x_usb_id_tbl
,
245 .r871xu_drv
.probe
= r871xu_drv_init
,
246 .r871xu_drv
.disconnect
= r871xu_dev_remove
,
248 .r871xu_drv
.suspend
= r871x_suspend
,
249 .r871xu_drv
.resume
= r871x_resume
,
250 .r871xu_drv
.reset_resume
= r871x_reset_resume
,
254 static uint
r8712_usb_dvobj_init(struct _adapter
*padapter
)
256 uint status
= _SUCCESS
;
257 struct usb_device_descriptor
*pdev_desc
;
258 struct usb_host_config
*phost_conf
;
259 struct usb_config_descriptor
*pconf_desc
;
260 struct usb_host_interface
*phost_iface
;
261 struct usb_interface_descriptor
*piface_desc
;
262 struct dvobj_priv
*pdvobjpriv
= &padapter
->dvobjpriv
;
263 struct usb_device
*pusbd
= pdvobjpriv
->pusbdev
;
265 pdvobjpriv
->padapter
= padapter
;
266 padapter
->EepromAddressSize
= 6;
267 pdev_desc
= &pusbd
->descriptor
;
268 phost_conf
= pusbd
->actconfig
;
269 pconf_desc
= &phost_conf
->desc
;
270 phost_iface
= &pintf
->altsetting
[0];
271 piface_desc
= &phost_iface
->desc
;
272 pdvobjpriv
->nr_endpoint
= piface_desc
->bNumEndpoints
;
273 if (pusbd
->speed
== USB_SPEED_HIGH
) {
274 pdvobjpriv
->ishighspeed
= true;
275 printk(KERN_INFO
"r8712u: USB_SPEED_HIGH with %d endpoints\n",
276 pdvobjpriv
->nr_endpoint
);
278 pdvobjpriv
->ishighspeed
= false;
279 printk(KERN_INFO
"r8712u: USB_SPEED_LOW with %d endpoints\n",
280 pdvobjpriv
->nr_endpoint
);
282 if ((r8712_alloc_io_queue(padapter
)) == _FAIL
)
287 static void r8712_usb_dvobj_deinit(struct _adapter
*padapter
)
291 void rtl871x_intf_stop(struct _adapter
*padapter
)
293 /*disable_hw_interrupt*/
294 if (padapter
->bSurpriseRemoved
== false) {
295 /*device still exists, so driver can do i/o operation
300 if (padapter
->dvobjpriv
.inirp_deinit
!= NULL
)
301 padapter
->dvobjpriv
.inirp_deinit(padapter
);
303 r8712_usb_write_port_cancel(padapter
);
304 /* TODO:cancel other irps */
307 void r871x_dev_unload(struct _adapter
*padapter
)
309 if (padapter
->bup
== true) {
311 padapter
->bDriverStopped
= true;
314 rtl871x_intf_stop(padapter
);
317 r8712_stop_drv_threads(padapter
);
320 if (padapter
->bSurpriseRemoved
== false) {
321 padapter
->hw_init_completed
= false;
322 rtl8712_hal_deinit(padapter
);
326 if (padapter
->dvobj_deinit
)
327 padapter
->dvobj_deinit(padapter
);
328 padapter
->bup
= false;
332 static void disable_ht_for_spec_devid(const struct usb_device_id
*pdid
,
333 struct _adapter
*padapter
)
338 int num
= sizeof(specific_device_id_tbl
) /
339 sizeof(struct specific_device_id
);
341 for (i
= 0; i
< num
; i
++) {
342 vid
= specific_device_id_tbl
[i
].idVendor
;
343 pid
= specific_device_id_tbl
[i
].idProduct
;
344 flags
= specific_device_id_tbl
[i
].flags
;
346 if ((pdid
->idVendor
== vid
) && (pdid
->idProduct
== pid
) &&
347 (flags
&SPEC_DEV_ID_DISABLE_HT
)) {
348 padapter
->registrypriv
.ht_enable
= 0;
349 padapter
->registrypriv
.cbw40_enable
= 0;
350 padapter
->registrypriv
.ampdu_enable
= 0;
355 static u8
key_2char2num(u8 hch
, u8 lch
)
357 return (hex_to_bin(hch
) << 4) | hex_to_bin(lch
);
361 * drv_init() - a device potentially for us
363 * notes: drv_init() is called when the bus driver has located a card for us
364 * to support. We accept the new device by returning 0.
366 static int r871xu_drv_init(struct usb_interface
*pusb_intf
,
367 const struct usb_device_id
*pdid
)
370 struct _adapter
*padapter
= NULL
;
371 struct dvobj_priv
*pdvobjpriv
;
372 struct net_device
*pnetdev
;
373 struct usb_device
*udev
;
375 printk(KERN_INFO
"r8712u: Staging version\n");
376 /* In this probe function, O.S. will provide the usb interface pointer
377 * to driver. We have to increase the reference count of the usb device
378 * structure by using the usb_get_dev function.
380 udev
= interface_to_usbdev(pusb_intf
);
384 pnetdev
= r8712_init_netdev();
387 padapter
= netdev_priv(pnetdev
);
388 disable_ht_for_spec_devid(pdid
, padapter
);
389 pdvobjpriv
= &padapter
->dvobjpriv
;
390 pdvobjpriv
->padapter
= padapter
;
391 padapter
->dvobjpriv
.pusbdev
= udev
;
392 padapter
->pusb_intf
= pusb_intf
;
393 usb_set_intfdata(pusb_intf
, pnetdev
);
394 SET_NETDEV_DEV(pnetdev
, &pusb_intf
->dev
);
396 padapter
->dvobj_init
= &r8712_usb_dvobj_init
;
397 padapter
->dvobj_deinit
= &r8712_usb_dvobj_deinit
;
398 padapter
->halpriv
.hal_bus_init
= &r8712_usb_hal_bus_init
;
399 padapter
->dvobjpriv
.inirp_init
= &r8712_usb_inirp_init
;
400 padapter
->dvobjpriv
.inirp_deinit
= &r8712_usb_inirp_deinit
;
402 * initialize the dvobj_priv
404 if (padapter
->dvobj_init
== NULL
)
407 status
= padapter
->dvobj_init(padapter
);
408 if (status
!= _SUCCESS
)
412 status
= r8712_init_drv_sw(padapter
);
415 /* step 5. read efuse/eeprom data and get mac_addr */
419 u8 tmpU1b
, AutoloadFail
, eeprom_CustomerID
;
420 u8
*pdata
= padapter
->eeprompriv
.efuse_eeprom_data
;
422 tmpU1b
= r8712_read8(padapter
, EE_9346CR
);/*CR9346*/
424 /* To check system boot selection.*/
425 printk(KERN_INFO
"r8712u: Boot from %s: Autoload %s\n",
426 (tmpU1b
& _9356SEL
) ? "EEPROM" : "EFUSE",
427 (tmpU1b
& _EEPROM_EN
) ? "OK" : "Failed");
429 /* To check autoload success or not.*/
430 if (tmpU1b
& _EEPROM_EN
) {
432 /* The following operations prevent Efuse leakage by
435 tmpU1b
= r8712_read8(padapter
, EFUSE_TEST
+3);
436 r8712_write8(padapter
, EFUSE_TEST
+ 3, tmpU1b
| 0x80);
438 r8712_write8(padapter
, EFUSE_TEST
+ 3,
439 (tmpU1b
& (~BIT(7))));
441 /* Retrieve Chip version.
442 * Recognize IC version by Reg0x4 BIT15.
444 tmpU1b
= (u8
)((r8712_read32(padapter
, PMC_FSM
) >> 15) &
447 padapter
->registrypriv
.chip_version
=
450 padapter
->registrypriv
.chip_version
=
452 switch (padapter
->registrypriv
.chip_version
) {
458 padapter
->registrypriv
.chip_version
=
463 for (i
= 0, offset
= 0; i
< 128; i
+= 8, offset
++)
464 r8712_efuse_pg_packet_read(padapter
, offset
,
468 /* Users specify the mac address */
471 for (jj
= 0, kk
= 0; jj
< ETH_ALEN
;
474 key_2char2num(r8712_initmac
[kk
],
475 r8712_initmac
[kk
+ 1]);
477 /* Use the mac address stored in the Efuse
478 * offset = 0x12 for usb in efuse
480 memcpy(mac
, &pdata
[0x12], ETH_ALEN
);
482 eeprom_CustomerID
= pdata
[0x52];
483 switch (eeprom_CustomerID
) {
484 case EEPROM_CID_ALPHA
:
485 padapter
->eeprompriv
.CustomerID
=
488 case EEPROM_CID_CAMEO
:
489 padapter
->eeprompriv
.CustomerID
=
492 case EEPROM_CID_SITECOM
:
493 padapter
->eeprompriv
.CustomerID
=
496 case EEPROM_CID_COREGA
:
497 padapter
->eeprompriv
.CustomerID
=
500 case EEPROM_CID_Senao
:
501 padapter
->eeprompriv
.CustomerID
=
504 case EEPROM_CID_EDIMAX_BELKIN
:
505 padapter
->eeprompriv
.CustomerID
=
506 RT_CID_819x_Edimax_Belkin
;
508 case EEPROM_CID_SERCOMM_BELKIN
:
509 padapter
->eeprompriv
.CustomerID
=
510 RT_CID_819x_Sercomm_Belkin
;
512 case EEPROM_CID_WNC_COREGA
:
513 padapter
->eeprompriv
.CustomerID
=
514 RT_CID_819x_WNC_COREGA
;
516 case EEPROM_CID_WHQL
:
518 case EEPROM_CID_NetCore
:
519 padapter
->eeprompriv
.CustomerID
=
522 case EEPROM_CID_CAMEO1
:
523 padapter
->eeprompriv
.CustomerID
=
526 case EEPROM_CID_CLEVO
:
527 padapter
->eeprompriv
.CustomerID
=
531 padapter
->eeprompriv
.CustomerID
=
535 printk(KERN_INFO
"r8712u: CustomerID = 0x%.4x\n",
536 padapter
->eeprompriv
.CustomerID
);
538 switch (padapter
->eeprompriv
.CustomerID
) {
540 case RT_CID_819x_ALPHA
:
541 case RT_CID_819x_CAMEO
:
542 padapter
->ledpriv
.LedStrategy
= SW_LED_MODE1
;
543 padapter
->ledpriv
.bRegUseLed
= true;
545 case RT_CID_819x_Sitecom
:
546 padapter
->ledpriv
.LedStrategy
= SW_LED_MODE2
;
547 padapter
->ledpriv
.bRegUseLed
= true;
550 case RT_CID_819x_Senao
:
551 padapter
->ledpriv
.LedStrategy
= SW_LED_MODE3
;
552 padapter
->ledpriv
.bRegUseLed
= true;
554 case RT_CID_819x_Edimax_Belkin
:
555 padapter
->ledpriv
.LedStrategy
= SW_LED_MODE4
;
556 padapter
->ledpriv
.bRegUseLed
= true;
558 case RT_CID_819x_Sercomm_Belkin
:
559 padapter
->ledpriv
.LedStrategy
= SW_LED_MODE5
;
560 padapter
->ledpriv
.bRegUseLed
= true;
562 case RT_CID_819x_WNC_COREGA
:
563 padapter
->ledpriv
.LedStrategy
= SW_LED_MODE6
;
564 padapter
->ledpriv
.bRegUseLed
= true;
567 padapter
->ledpriv
.LedStrategy
= SW_LED_MODE0
;
568 padapter
->ledpriv
.bRegUseLed
= false;
572 AutoloadFail
= false;
573 if (((mac
[0] == 0xff) && (mac
[1] == 0xff) &&
574 (mac
[2] == 0xff) && (mac
[3] == 0xff) &&
575 (mac
[4] == 0xff) && (mac
[5] == 0xff)) ||
576 ((mac
[0] == 0x00) && (mac
[1] == 0x00) &&
577 (mac
[2] == 0x00) && (mac
[3] == 0x00) &&
578 (mac
[4] == 0x00) && (mac
[5] == 0x00)) ||
579 (AutoloadFail
== false)) {
588 /* Make sure the user did not select a multicast
589 * address by setting bit 1 of first octet.
592 printk(KERN_INFO
"r8712u: MAC Address from user = "
595 printk(KERN_INFO
"r8712u: MAC Address from efuse = "
597 memcpy(pnetdev
->dev_addr
, mac
, ETH_ALEN
);
599 /* step 6. Load the firmware asynchronously */
600 if (rtl871x_load_fw(padapter
))
602 spin_lock_init(&padapter
->lockRxFF0Filter
);
603 mutex_init(&padapter
->mutex_start
);
607 usb_set_intfdata(pusb_intf
, NULL
);
608 if (padapter
->dvobj_deinit
!= NULL
)
609 padapter
->dvobj_deinit(padapter
);
611 free_netdev(pnetdev
);
615 /* rmmod module & unplug(SurpriseRemoved) will call r871xu_dev_remove()
616 * => how to recognize both */
617 static void r871xu_dev_remove(struct usb_interface
*pusb_intf
)
619 struct net_device
*pnetdev
= usb_get_intfdata(pusb_intf
);
620 struct _adapter
*padapter
= netdev_priv(pnetdev
);
621 struct usb_device
*udev
= interface_to_usbdev(pusb_intf
);
623 usb_set_intfdata(pusb_intf
, NULL
);
624 if (padapter
->fw_found
)
625 release_firmware(padapter
->fw
);
626 /* never exit with a firmware callback pending */
627 wait_for_completion(&padapter
->rtl8712_fw_ready
);
628 if (drvpriv
.drv_registered
== true)
629 padapter
->bSurpriseRemoved
= true;
630 if (pnetdev
!= NULL
) {
631 /* will call netdev_close() */
632 unregister_netdev(pnetdev
);
634 flush_scheduled_work();
636 /*Stop driver mlme relation timer */
637 if (padapter
->fw_found
)
638 r8712_stop_drv_timers(padapter
);
639 r871x_dev_unload(padapter
);
640 r8712_free_drv_sw(padapter
);
641 usb_set_intfdata(pusb_intf
, NULL
);
642 /* decrease the reference count of the usb device structure
645 /* If we didn't unplug usb dongle and remove/insert module, driver
646 * fails on sitesurvey for the first time when device is up.
647 * Reset usb port for sitesurvey fail issue. */
648 if (udev
->state
!= USB_STATE_NOTATTACHED
)
649 usb_reset_device(udev
);
653 static int __init
r8712u_drv_entry(void)
655 drvpriv
.drv_registered
= true;
656 return usb_register(&drvpriv
.r871xu_drv
);
659 static void __exit
r8712u_drv_halt(void)
661 drvpriv
.drv_registered
= false;
662 usb_deregister(&drvpriv
.r871xu_drv
);
663 printk(KERN_INFO
"r8712u: Driver unloaded\n");
666 module_init(r8712u_drv_entry
);
667 module_exit(r8712u_drv_halt
);