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 "osdep_service.h"
32 #include "drv_types.h"
33 #include "recv_osdep.h"
34 #include "xmit_osdep.h"
35 #include "rtl8712_efuse.h"
36 #include "usb_vendor_req.h"
38 #include "usb_osintf.h"
40 #define DRVER "v7_0.20100831"
42 static struct usb_interface
*pintf
;
44 static int r871xu_drv_init(struct usb_interface
*pusb_intf
,
45 const struct usb_device_id
*pdid
);
47 static void r871xu_dev_remove(struct usb_interface
*pusb_intf
);
49 static struct usb_device_id rtl871x_usb_id_tbl
[] = {
53 {USB_DEVICE(0x0BDA, 0x8171)},
54 {USB_DEVICE(0x0bda, 0x8173)},
55 {USB_DEVICE(0x0bda, 0x8712)},
56 {USB_DEVICE(0x0bda, 0x8713)},
57 {USB_DEVICE(0x0bda, 0xC512)},
59 {USB_DEVICE(0x07B8, 0x8188)},
61 {USB_DEVICE(0x0B05, 0x1786)},
62 {USB_DEVICE(0x0B05, 0x1791)}, /* 11n mode disable */
64 {USB_DEVICE(0x050D, 0x945A)},
66 {USB_DEVICE(0x07AA, 0x0047)},
68 {USB_DEVICE(0x2001, 0x3306)},
69 {USB_DEVICE(0x07D1, 0x3306)}, /* 11n mode disable */
71 {USB_DEVICE(0x7392, 0x7611)},
73 {USB_DEVICE(0x1740, 0x9603)},
75 {USB_DEVICE(0x0E66, 0x0016)},
77 {USB_DEVICE(0x06F8, 0xE034)},
78 {USB_DEVICE(0x06F8, 0xE032)},
80 {USB_DEVICE(0x0789, 0x0167)},
82 {USB_DEVICE(0x2019, 0xAB28)},
83 {USB_DEVICE(0x2019, 0xED16)},
85 {USB_DEVICE(0x0DF6, 0x0057)},
86 {USB_DEVICE(0x0DF6, 0x0045)},
87 {USB_DEVICE(0x0DF6, 0x0059)}, /* 11n mode disable */
88 {USB_DEVICE(0x0DF6, 0x004B)},
89 {USB_DEVICE(0x0DF6, 0x005B)},
90 {USB_DEVICE(0x0DF6, 0x005D)},
91 {USB_DEVICE(0x0DF6, 0x0063)},
93 {USB_DEVICE(0x177F, 0x0154)},
95 {USB_DEVICE(0x0BDA, 0x5077)},
97 {USB_DEVICE(0x1690, 0x0752)},
99 {USB_DEVICE(0x20F4, 0x646B)},
100 {USB_DEVICE(0x083A, 0xC512)},
104 {USB_DEVICE(0x0BDA, 0x8172)},
106 {USB_DEVICE(0x0EB0, 0x9061)},
108 {USB_DEVICE(0x0BDA, 0x8172)},
109 {USB_DEVICE(0x13D3, 0x3323)},
110 {USB_DEVICE(0x13D3, 0x3311)}, /* 11n mode disable */
111 {USB_DEVICE(0x13D3, 0x3342)},
113 {USB_DEVICE(0x13D3, 0x3333)},
114 {USB_DEVICE(0x13D3, 0x3334)},
115 {USB_DEVICE(0x13D3, 0x3335)}, /* 11n mode disable */
116 {USB_DEVICE(0x13D3, 0x3336)}, /* 11n mode disable */
118 {USB_DEVICE(0x13D3, 0x3309)},
120 {USB_DEVICE(0x050D, 0x815F)},
122 {USB_DEVICE(0x07D1, 0x3302)},
123 {USB_DEVICE(0x07D1, 0x3300)},
124 {USB_DEVICE(0x07D1, 0x3303)},
126 {USB_DEVICE(0x7392, 0x7612)},
128 {USB_DEVICE(0x1740, 0x9605)},
130 {USB_DEVICE(0x06F8, 0xE031)},
132 {USB_DEVICE(0x0E66, 0x0015)},
134 {USB_DEVICE(0x13D3, 0x3306)},
136 {USB_DEVICE(0x2019, 0xED18)},
137 {USB_DEVICE(0x2019, 0x4901)},
139 {USB_DEVICE(0x0DF6, 0x0058)},
140 {USB_DEVICE(0x0DF6, 0x0049)},
141 {USB_DEVICE(0x0DF6, 0x004C)},
142 {USB_DEVICE(0x0DF6, 0x0064)},
144 {USB_DEVICE(0x14b2, 0x3300)},
145 {USB_DEVICE(0x14b2, 0x3301)},
146 {USB_DEVICE(0x14B2, 0x3302)},
148 {USB_DEVICE(0x04F2, 0xAFF2)},
149 {USB_DEVICE(0x04F2, 0xAFF5)},
150 {USB_DEVICE(0x04F2, 0xAFF6)},
151 {USB_DEVICE(0x13D3, 0x3339)},
152 {USB_DEVICE(0x13D3, 0x3340)}, /* 11n mode disable */
153 {USB_DEVICE(0x13D3, 0x3341)}, /* 11n mode disable */
154 {USB_DEVICE(0x13D3, 0x3310)},
155 {USB_DEVICE(0x13D3, 0x3325)},
159 {USB_DEVICE(0x0BDA, 0x8174)},
160 {USB_DEVICE(0x0BDA, 0x8174)},
162 {USB_DEVICE(0x050D, 0x845A)},
164 {USB_DEVICE(0x07AA, 0x0051)},
166 {USB_DEVICE(0x7392, 0x7622)},
168 {USB_DEVICE(0x0409, 0x02B6)},
172 MODULE_DEVICE_TABLE(usb
, rtl871x_usb_id_tbl
);
174 static struct specific_device_id specific_device_id_tbl
[] = {
175 {.idVendor
= 0x0b05, .idProduct
= 0x1791,
176 .flags
= SPEC_DEV_ID_DISABLE_HT
},
177 {.idVendor
= 0x0df6, .idProduct
= 0x0059,
178 .flags
= SPEC_DEV_ID_DISABLE_HT
},
179 {.idVendor
= 0x13d3, .idProduct
= 0x3306,
180 .flags
= SPEC_DEV_ID_DISABLE_HT
},
181 {.idVendor
= 0x13D3, .idProduct
= 0x3311,
182 .flags
= SPEC_DEV_ID_DISABLE_HT
},
183 {.idVendor
= 0x13d3, .idProduct
= 0x3335,
184 .flags
= SPEC_DEV_ID_DISABLE_HT
},
185 {.idVendor
= 0x13d3, .idProduct
= 0x3336,
186 .flags
= SPEC_DEV_ID_DISABLE_HT
},
187 {.idVendor
= 0x13d3, .idProduct
= 0x3340,
188 .flags
= SPEC_DEV_ID_DISABLE_HT
},
189 {.idVendor
= 0x13d3, .idProduct
= 0x3341,
190 .flags
= SPEC_DEV_ID_DISABLE_HT
},
195 struct usb_driver r871xu_drv
;
200 static int r871x_suspend(struct usb_interface
*pusb_intf
, pm_message_t state
)
202 struct net_device
*pnetdev
= usb_get_intfdata(pusb_intf
);
204 printk(KERN_INFO
"r8712: suspending...\n");
205 if (!pnetdev
|| !netif_running(pnetdev
)) {
206 printk(KERN_INFO
"r8712: unable to suspend\n");
209 if (pnetdev
->netdev_ops
->ndo_stop
)
210 pnetdev
->netdev_ops
->ndo_stop(pnetdev
);
212 netif_device_detach(pnetdev
);
216 static int r871x_resume(struct usb_interface
*pusb_intf
)
218 struct net_device
*pnetdev
= usb_get_intfdata(pusb_intf
);
220 printk(KERN_INFO
"r8712: resuming...\n");
221 if (!pnetdev
|| !netif_running(pnetdev
)) {
222 printk(KERN_INFO
"r8712: unable to resume\n");
225 netif_device_attach(pnetdev
);
226 if (pnetdev
->netdev_ops
->ndo_open
)
227 pnetdev
->netdev_ops
->ndo_open(pnetdev
);
231 static int r871x_reset_resume(struct usb_interface
*pusb_intf
)
239 static struct drv_priv drvpriv
= {
240 .r871xu_drv
.name
= "r8712u",
241 .r871xu_drv
.id_table
= rtl871x_usb_id_tbl
,
242 .r871xu_drv
.probe
= r871xu_drv_init
,
243 .r871xu_drv
.disconnect
= r871xu_dev_remove
,
245 .r871xu_drv
.suspend
= r871x_suspend
,
246 .r871xu_drv
.resume
= r871x_resume
,
247 .r871xu_drv
.reset_resume
= r871x_reset_resume
,
251 static uint
r8712_usb_dvobj_init(struct _adapter
*padapter
)
253 uint status
= _SUCCESS
;
254 struct usb_device_descriptor
*pdev_desc
;
255 struct usb_host_config
*phost_conf
;
256 struct usb_config_descriptor
*pconf_desc
;
257 struct usb_host_interface
*phost_iface
;
258 struct usb_interface_descriptor
*piface_desc
;
259 struct dvobj_priv
*pdvobjpriv
= &padapter
->dvobjpriv
;
260 struct usb_device
*pusbd
= pdvobjpriv
->pusbdev
;
262 pdvobjpriv
->padapter
= padapter
;
263 padapter
->EepromAddressSize
= 6;
264 pdev_desc
= &pusbd
->descriptor
;
265 phost_conf
= pusbd
->actconfig
;
266 pconf_desc
= &phost_conf
->desc
;
267 phost_iface
= &pintf
->altsetting
[0];
268 piface_desc
= &phost_iface
->desc
;
269 pdvobjpriv
->nr_endpoint
= piface_desc
->bNumEndpoints
;
270 if (pusbd
->speed
== USB_SPEED_HIGH
) {
271 pdvobjpriv
->ishighspeed
= true;
272 printk(KERN_INFO
"r8712u: USB_SPEED_HIGH with %d endpoints\n",
273 pdvobjpriv
->nr_endpoint
);
275 pdvobjpriv
->ishighspeed
= false;
276 printk(KERN_INFO
"r8712u: USB_SPEED_LOW with %d endpoints\n",
277 pdvobjpriv
->nr_endpoint
);
279 if ((r8712_alloc_io_queue(padapter
)) == _FAIL
)
281 sema_init(&(padapter
->dvobjpriv
.usb_suspend_sema
), 0);
285 static void r8712_usb_dvobj_deinit(struct _adapter
*padapter
)
289 void rtl871x_intf_stop(struct _adapter
*padapter
)
291 /*disable_hw_interrupt*/
292 if (padapter
->bSurpriseRemoved
== false) {
293 /*device still exists, so driver can do i/o operation
298 if (padapter
->dvobjpriv
.inirp_deinit
!= NULL
)
299 padapter
->dvobjpriv
.inirp_deinit(padapter
);
301 r8712_usb_write_port_cancel(padapter
);
302 /* TODO:cancel other irps */
305 void r871x_dev_unload(struct _adapter
*padapter
)
307 if (padapter
->bup
== true) {
309 padapter
->bDriverStopped
= true;
312 rtl871x_intf_stop(padapter
);
315 r8712_stop_drv_threads(padapter
);
318 if (padapter
->bSurpriseRemoved
== false) {
319 padapter
->hw_init_completed
= false;
320 rtl8712_hal_deinit(padapter
);
324 if (padapter
->dvobj_deinit
)
325 padapter
->dvobj_deinit(padapter
);
326 padapter
->bup
= false;
330 static void disable_ht_for_spec_devid(const struct usb_device_id
*pdid
,
331 struct _adapter
*padapter
)
336 int num
= sizeof(specific_device_id_tbl
) /
337 sizeof(struct specific_device_id
);
339 for (i
= 0; i
< num
; i
++) {
340 vid
= specific_device_id_tbl
[i
].idVendor
;
341 pid
= specific_device_id_tbl
[i
].idProduct
;
342 flags
= specific_device_id_tbl
[i
].flags
;
344 if ((pdid
->idVendor
== vid
) && (pdid
->idProduct
== pid
) &&
345 (flags
&SPEC_DEV_ID_DISABLE_HT
)) {
346 padapter
->registrypriv
.ht_enable
= 0;
347 padapter
->registrypriv
.cbw40_enable
= 0;
348 padapter
->registrypriv
.ampdu_enable
= 0;
353 static u8
key_2char2num(u8 hch
, u8 lch
)
355 return (hex_to_bin(hch
) << 4) | hex_to_bin(lch
);
359 * drv_init() - a device potentially for us
361 * notes: drv_init() is called when the bus driver has located a card for us
362 * to support. We accept the new device by returning 0.
364 static int r871xu_drv_init(struct usb_interface
*pusb_intf
,
365 const struct usb_device_id
*pdid
)
368 struct _adapter
*padapter
= NULL
;
369 struct dvobj_priv
*pdvobjpriv
;
370 struct net_device
*pnetdev
;
372 printk(KERN_INFO
"r8712u: DriverVersion: %s\n", DRVER
);
373 /* In this probe function, O.S. will provide the usb interface pointer
374 * to driver. We have to increase the reference count of the usb device
375 * structure by using the usb_get_dev function.
377 usb_get_dev(interface_to_usbdev(pusb_intf
));
380 pnetdev
= r8712_init_netdev();
383 padapter
= (struct _adapter
*)_netdev_priv(pnetdev
);
384 disable_ht_for_spec_devid(pdid
, padapter
);
385 pdvobjpriv
= &padapter
->dvobjpriv
;
386 pdvobjpriv
->padapter
= padapter
;
387 padapter
->dvobjpriv
.pusbdev
= interface_to_usbdev(pusb_intf
);
388 usb_set_intfdata(pusb_intf
, pnetdev
);
389 SET_NETDEV_DEV(pnetdev
, &pusb_intf
->dev
);
391 padapter
->dvobj_init
= &r8712_usb_dvobj_init
;
392 padapter
->dvobj_deinit
= &r8712_usb_dvobj_deinit
;
393 padapter
->halpriv
.hal_bus_init
= &r8712_usb_hal_bus_init
;
394 padapter
->dvobjpriv
.inirp_init
= &r8712_usb_inirp_init
;
395 padapter
->dvobjpriv
.inirp_deinit
= &r8712_usb_inirp_deinit
;
397 * initialize the dvobj_priv
399 if (padapter
->dvobj_init
== NULL
)
402 status
= padapter
->dvobj_init(padapter
);
403 if (status
!= _SUCCESS
)
407 status
= r8712_init_drv_sw(padapter
);
410 /* step 5. read efuse/eeprom data and get mac_addr */
414 u8 tmpU1b
, AutoloadFail
, eeprom_CustomerID
;
415 u8
*pdata
= padapter
->eeprompriv
.efuse_eeprom_data
;
417 tmpU1b
= r8712_read8(padapter
, EE_9346CR
);/*CR9346*/
419 /* To check system boot selection.*/
420 printk(KERN_INFO
"r8712u: Boot from %s: Autoload %s\n",
421 (tmpU1b
& _9356SEL
) ? "EEPROM" : "EFUSE",
422 (tmpU1b
& _EEPROM_EN
) ? "OK" : "Failed");
424 /* To check autoload success or not.*/
425 if (tmpU1b
& _EEPROM_EN
) {
427 /* The following operations prevent Efuse leakage by
430 tmpU1b
= r8712_read8(padapter
, EFUSE_TEST
+3);
431 r8712_write8(padapter
, EFUSE_TEST
+ 3, tmpU1b
| 0x80);
433 r8712_write8(padapter
, EFUSE_TEST
+ 3,
434 (tmpU1b
& (~BIT(7))));
436 /* Retrieve Chip version.
437 * Recognize IC version by Reg0x4 BIT15.
439 tmpU1b
= (u8
)((r8712_read32(padapter
, PMC_FSM
) >> 15) &
442 padapter
->registrypriv
.chip_version
=
445 padapter
->registrypriv
.chip_version
=
447 switch (padapter
->registrypriv
.chip_version
) {
453 padapter
->registrypriv
.chip_version
=
458 for (i
= 0, offset
= 0; i
< 128; i
+= 8, offset
++)
459 r8712_efuse_pg_packet_read(padapter
, offset
,
463 /* Users specify the mac address */
466 for (jj
= 0, kk
= 0; jj
< ETH_ALEN
;
469 key_2char2num(r8712_initmac
[kk
],
470 r8712_initmac
[kk
+ 1]);
472 /* Use the mac address stored in the Efuse
473 * offset = 0x12 for usb in efuse
475 memcpy(mac
, &pdata
[0x12], ETH_ALEN
);
477 eeprom_CustomerID
= pdata
[0x52];
478 switch (eeprom_CustomerID
) {
479 case EEPROM_CID_ALPHA
:
480 padapter
->eeprompriv
.CustomerID
=
483 case EEPROM_CID_CAMEO
:
484 padapter
->eeprompriv
.CustomerID
=
487 case EEPROM_CID_SITECOM
:
488 padapter
->eeprompriv
.CustomerID
=
491 case EEPROM_CID_COREGA
:
492 padapter
->eeprompriv
.CustomerID
=
495 case EEPROM_CID_Senao
:
496 padapter
->eeprompriv
.CustomerID
=
499 case EEPROM_CID_EDIMAX_BELKIN
:
500 padapter
->eeprompriv
.CustomerID
=
501 RT_CID_819x_Edimax_Belkin
;
503 case EEPROM_CID_SERCOMM_BELKIN
:
504 padapter
->eeprompriv
.CustomerID
=
505 RT_CID_819x_Sercomm_Belkin
;
507 case EEPROM_CID_WNC_COREGA
:
508 padapter
->eeprompriv
.CustomerID
=
509 RT_CID_819x_WNC_COREGA
;
511 case EEPROM_CID_WHQL
:
513 case EEPROM_CID_NetCore
:
514 padapter
->eeprompriv
.CustomerID
=
517 case EEPROM_CID_CAMEO1
:
518 padapter
->eeprompriv
.CustomerID
=
521 case EEPROM_CID_CLEVO
:
522 padapter
->eeprompriv
.CustomerID
=
526 padapter
->eeprompriv
.CustomerID
=
530 printk(KERN_INFO
"r8712u: CustomerID = 0x%.4x\n",
531 padapter
->eeprompriv
.CustomerID
);
533 switch (padapter
->eeprompriv
.CustomerID
) {
535 case RT_CID_819x_ALPHA
:
536 case RT_CID_819x_CAMEO
:
537 padapter
->ledpriv
.LedStrategy
= SW_LED_MODE1
;
538 padapter
->ledpriv
.bRegUseLed
= true;
540 case RT_CID_819x_Sitecom
:
541 padapter
->ledpriv
.LedStrategy
= SW_LED_MODE2
;
542 padapter
->ledpriv
.bRegUseLed
= true;
545 case RT_CID_819x_Senao
:
546 padapter
->ledpriv
.LedStrategy
= SW_LED_MODE3
;
547 padapter
->ledpriv
.bRegUseLed
= true;
549 case RT_CID_819x_Edimax_Belkin
:
550 padapter
->ledpriv
.LedStrategy
= SW_LED_MODE4
;
551 padapter
->ledpriv
.bRegUseLed
= true;
553 case RT_CID_819x_Sercomm_Belkin
:
554 padapter
->ledpriv
.LedStrategy
= SW_LED_MODE5
;
555 padapter
->ledpriv
.bRegUseLed
= true;
557 case RT_CID_819x_WNC_COREGA
:
558 padapter
->ledpriv
.LedStrategy
= SW_LED_MODE6
;
559 padapter
->ledpriv
.bRegUseLed
= true;
562 padapter
->ledpriv
.LedStrategy
= SW_LED_MODE0
;
563 padapter
->ledpriv
.bRegUseLed
= false;
567 AutoloadFail
= false;
568 if (((mac
[0] == 0xff) && (mac
[1] == 0xff) &&
569 (mac
[2] == 0xff) && (mac
[3] == 0xff) &&
570 (mac
[4] == 0xff) && (mac
[5] == 0xff)) ||
571 ((mac
[0] == 0x00) && (mac
[1] == 0x00) &&
572 (mac
[2] == 0x00) && (mac
[3] == 0x00) &&
573 (mac
[4] == 0x00) && (mac
[5] == 0x00)) ||
574 (AutoloadFail
== false)) {
583 /* Make sure the user did not select a multicast
584 * address by setting bit 1 of first octet.
587 printk(KERN_INFO
"r8712u: MAC Address from user = "
590 printk(KERN_INFO
"r8712u: MAC Address from efuse = "
592 memcpy(pnetdev
->dev_addr
, mac
, ETH_ALEN
);
594 /* step 6. Tell the network stack we exist */
595 if (register_netdev(pnetdev
) != 0)
599 usb_put_dev(interface_to_usbdev(pusb_intf
));
600 usb_set_intfdata(pusb_intf
, NULL
);
601 if (padapter
->dvobj_deinit
!= NULL
)
602 padapter
->dvobj_deinit(padapter
);
604 os_free_netdev(pnetdev
);
608 /* rmmod module & unplug(SurpriseRemoved) will call r871xu_dev_remove()
609 * => how to recognize both */
610 static void r871xu_dev_remove(struct usb_interface
*pusb_intf
)
612 struct net_device
*pnetdev
= usb_get_intfdata(pusb_intf
);
613 struct _adapter
*padapter
= netdev_priv(pnetdev
);
614 struct usb_device
*udev
= interface_to_usbdev(pusb_intf
);
617 if (drvpriv
.drv_registered
== true)
618 padapter
->bSurpriseRemoved
= true;
619 if (pnetdev
!= NULL
) {
620 /* will call netdev_close() */
621 unregister_netdev(pnetdev
);
623 flush_scheduled_work();
625 r871x_dev_unload(padapter
);
626 r8712_free_drv_sw(padapter
);
628 usb_set_intfdata(pusb_intf
, NULL
);
629 /* decrease the reference count of the usb device structure
632 /* If we didn't unplug usb dongle and remove/insert modlue, driver
633 * fails on sitesurvey for the first time when device is up.
634 * Reset usb port for sitesurvey fail issue. */
635 if (udev
->state
!= USB_STATE_NOTATTACHED
)
636 usb_reset_device(udev
);
640 static int __init
r8712u_drv_entry(void)
642 drvpriv
.drv_registered
= true;
643 return usb_register(&drvpriv
.r871xu_drv
);
646 static void __exit
r8712u_drv_halt(void)
648 drvpriv
.drv_registered
= false;
649 usb_deregister(&drvpriv
.r871xu_drv
);
650 printk(KERN_INFO
"r8712u: Driver unloaded\n");
653 module_init(r8712u_drv_entry
);
654 module_exit(r8712u_drv_halt
);