1 // SPDX-License-Identifier: GPL-2.0
2 /******************************************************************************
3 *
4 * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
5 *
6 ******************************************************************************/
7
8 #define pr_fmt(fmt) "R8188EU: " fmt
9 #include <osdep_service.h>
10 #include <drv_types.h>
11 #include <recv_osdep.h>
12 #include <xmit_osdep.h>
13 #include <hal_intf.h>
14 #include <linux/usb.h>
15 #include <linux/vmalloc.h>
16 #include <mon.h>
17 #include <osdep_intf.h>
18
19 #include <usb_ops_linux.h>
20 #include <rtw_ioctl.h>
21
22 #include "rtl8188e_hal.h"
23
24 #define USB_VENDER_ID_REALTEK 0x0bda
25
26 /* DID_USB_v916_20130116 */
27 static const struct usb_device_id rtw_usb_id_tbl[] = {
28 /*=== Realtek demoboard ===*/
29 {USB_DEVICE(USB_VENDER_ID_REALTEK, 0x8179)}, /* 8188EUS */
30 {USB_DEVICE(USB_VENDER_ID_REALTEK, 0x0179)}, /* 8188ETV */
31 /*=== Customer ID ===*/
32 /****** 8188EUS ********/
33 {USB_DEVICE(0x056e, 0x4008)}, /* Elecom WDC-150SU2M */
34 {USB_DEVICE(0x07b8, 0x8179)}, /* Abocom - Abocom */
35 {USB_DEVICE(0x0B05, 0x18F0)}, /* ASUS USB-N10 Nano B1 */
36 {USB_DEVICE(0x2001, 0x330F)}, /* DLink DWA-125 REV D1 */
37 {USB_DEVICE(0x2001, 0x3310)}, /* Dlink DWA-123 REV D1 */
38 {USB_DEVICE(0x2001, 0x3311)}, /* DLink GO-USB-N150 REV B1 */
39 {USB_DEVICE(0x2001, 0x331B)}, /* D-Link DWA-121 rev B1 */
40 {USB_DEVICE(0x2357, 0x010c)}, /* TP-Link TL-WN722N v2 */
41 {USB_DEVICE(0x2357, 0x0111)}, /* TP-Link TL-WN727N v5.21 */
42 {USB_DEVICE(0x2C4E, 0x0102)}, /* MERCUSYS MW150US v2 */
43 {USB_DEVICE(0x0df6, 0x0076)}, /* Sitecom N150 v2 */
44 {USB_DEVICE(0x7392, 0xb811)}, /* Edimax EW-7811UN V2 */
45 {USB_DEVICE(USB_VENDER_ID_REALTEK, 0xffef)}, /* Rosewill RNX-N150NUB */
46 {} /* Terminating entry */
47 };
48
49 MODULE_DEVICE_TABLE(usb, rtw_usb_id_tbl);
50
usb_dvobj_init(struct usb_interface * usb_intf)51 static struct dvobj_priv *usb_dvobj_init(struct usb_interface *usb_intf)
52 {
53 int i;
54 struct dvobj_priv *pdvobjpriv;
55 struct usb_host_config *phost_conf;
56 struct usb_config_descriptor *pconf_desc;
57 struct usb_host_interface *phost_iface;
58 struct usb_interface_descriptor *piface_desc;
59 struct usb_endpoint_descriptor *pendp_desc;
60 struct usb_device *pusbd;
61
62 pdvobjpriv = kzalloc(sizeof(*pdvobjpriv), GFP_KERNEL);
63 if (!pdvobjpriv)
64 return NULL;
65
66 pdvobjpriv->pusbintf = usb_intf;
67 pusbd = interface_to_usbdev(usb_intf);
68 pdvobjpriv->pusbdev = pusbd;
69 usb_set_intfdata(usb_intf, pdvobjpriv);
70
71 pdvobjpriv->RtNumInPipes = 0;
72 pdvobjpriv->RtNumOutPipes = 0;
73
74 phost_conf = pusbd->actconfig;
75 pconf_desc = &phost_conf->desc;
76
77 phost_iface = usb_intf->cur_altsetting;
78 piface_desc = &phost_iface->desc;
79
80 pdvobjpriv->NumInterfaces = pconf_desc->bNumInterfaces;
81 pdvobjpriv->InterfaceNumber = piface_desc->bInterfaceNumber;
82
83 for (i = 0; i < piface_desc->bNumEndpoints; i++) {
84 int ep_num;
85
86 pendp_desc = &phost_iface->endpoint[i].desc;
87
88 ep_num = usb_endpoint_num(pendp_desc);
89
90 if (usb_endpoint_is_bulk_in(pendp_desc)) {
91 pdvobjpriv->RtInPipe[pdvobjpriv->RtNumInPipes] = ep_num;
92 pdvobjpriv->RtNumInPipes++;
93 } else if (usb_endpoint_is_int_in(pendp_desc)) {
94 pdvobjpriv->RtInPipe[pdvobjpriv->RtNumInPipes] = ep_num;
95 pdvobjpriv->RtNumInPipes++;
96 } else if (usb_endpoint_is_bulk_out(pendp_desc)) {
97 pdvobjpriv->RtOutPipe[pdvobjpriv->RtNumOutPipes] =
98 ep_num;
99 pdvobjpriv->RtNumOutPipes++;
100 }
101 }
102
103 if (pusbd->speed == USB_SPEED_HIGH)
104 pdvobjpriv->ishighspeed = true;
105 else
106 pdvobjpriv->ishighspeed = false;
107
108 mutex_init(&pdvobjpriv->usb_vendor_req_mutex);
109 usb_get_dev(pusbd);
110
111 return pdvobjpriv;
112 }
113
usb_dvobj_deinit(struct usb_interface * usb_intf)114 static void usb_dvobj_deinit(struct usb_interface *usb_intf)
115 {
116 struct dvobj_priv *dvobj = usb_get_intfdata(usb_intf);
117
118 usb_set_intfdata(usb_intf, NULL);
119 if (dvobj) {
120 /* Modify condition for 92DU DMDP 2010.11.18, by Thomas */
121 if ((dvobj->NumInterfaces != 2 &&
122 dvobj->NumInterfaces != 3) ||
123 (dvobj->InterfaceNumber == 1)) {
124 if (interface_to_usbdev(usb_intf)->state !=
125 USB_STATE_NOTATTACHED) {
126 /* If we didn't unplug usb dongle and
127 * remove/insert module, driver fails
128 * on sitesurvey for the first time when
129 * device is up . Reset usb port for sitesurvey
130 * fail issue.
131 */
132 pr_debug("usb attached..., try to reset usb device\n");
133 usb_reset_device(interface_to_usbdev(usb_intf));
134 }
135 }
136
137 mutex_destroy(&dvobj->usb_vendor_req_mutex);
138 kfree(dvobj);
139 }
140
141 usb_put_dev(interface_to_usbdev(usb_intf));
142 }
143
usb_intf_stop(struct adapter * padapter)144 void usb_intf_stop(struct adapter *padapter)
145 {
146 RT_TRACE(_module_hci_intfs_c_, _drv_err_, ("+%s\n", __func__));
147
148 /* disable_hw_interrupt */
149 if (!padapter->bSurpriseRemoved) {
150 /* device still exists, so driver can do i/o operation */
151 /* TODO: */
152 RT_TRACE(_module_hci_intfs_c_, _drv_err_,
153 ("SurpriseRemoved == false\n"));
154 }
155
156 /* cancel in irp */
157 rtw_hal_inirp_deinit(padapter);
158
159 /* cancel out irp */
160 usb_write_port_cancel(padapter);
161
162 /* todo:cancel other irps */
163
164 RT_TRACE(_module_hci_intfs_c_, _drv_err_, ("-%s\n", __func__));
165 }
166
rtw_dev_unload(struct adapter * padapter)167 static void rtw_dev_unload(struct adapter *padapter)
168 {
169 RT_TRACE(_module_hci_intfs_c_, _drv_err_, ("+%s\n", __func__));
170
171 if (padapter->bup) {
172 pr_debug("===> %s\n", __func__);
173 padapter->bDriverStopped = true;
174 if (padapter->xmitpriv.ack_tx)
175 rtw_ack_tx_done(&padapter->xmitpriv, RTW_SCTX_DONE_DRV_STOP);
176 /* s3. */
177 usb_intf_stop(padapter);
178 /* s4. */
179 if (!padapter->pwrctrlpriv.bInternalAutoSuspend)
180 rtw_stop_drv_threads(padapter);
181
182 /* s5. */
183 if (!padapter->bSurpriseRemoved) {
184 rtw_hal_deinit(padapter);
185 padapter->bSurpriseRemoved = true;
186 }
187
188 padapter->bup = false;
189 } else {
190 RT_TRACE(_module_hci_intfs_c_, _drv_err_,
191 ("r871x_dev_unload():padapter->bup == false\n"));
192 }
193
194 pr_debug("<=== %s\n", __func__);
195
196 RT_TRACE(_module_hci_intfs_c_, _drv_err_, ("-%s\n", __func__));
197 }
198
rtw_suspend(struct usb_interface * pusb_intf,pm_message_t message)199 static int rtw_suspend(struct usb_interface *pusb_intf, pm_message_t message)
200 {
201 struct dvobj_priv *dvobj = usb_get_intfdata(pusb_intf);
202 struct adapter *padapter = dvobj->if1;
203 struct net_device *pnetdev = padapter->pnetdev;
204 struct mlme_priv *pmlmepriv = &padapter->mlmepriv;
205 struct pwrctrl_priv *pwrpriv = &padapter->pwrctrlpriv;
206 unsigned long start_time = jiffies;
207
208 pr_debug("==> %s (%s:%d)\n", __func__, current->comm, current->pid);
209
210 if ((!padapter->bup) || (padapter->bDriverStopped) ||
211 (padapter->bSurpriseRemoved)) {
212 pr_debug("padapter->bup=%d bDriverStopped=%d bSurpriseRemoved = %d\n",
213 padapter->bup, padapter->bDriverStopped,
214 padapter->bSurpriseRemoved);
215 goto exit;
216 }
217
218 pwrpriv->bInSuspend = true;
219 rtw_cancel_all_timer(padapter);
220 LeaveAllPowerSaveMode(padapter);
221
222 mutex_lock(&pwrpriv->mutex_lock);
223 /* s1. */
224 if (pnetdev) {
225 netif_carrier_off(pnetdev);
226 netif_tx_stop_all_queues(pnetdev);
227 }
228
229 /* s2. */
230 rtw_disassoc_cmd(padapter, 0, false);
231
232 if (check_fwstate(pmlmepriv, WIFI_STATION_STATE) &&
233 check_fwstate(pmlmepriv, _FW_LINKED)) {
234 pr_debug("%s:%d %s(%pM), length:%d assoc_ssid.length:%d\n",
235 __func__, __LINE__,
236 pmlmepriv->cur_network.network.ssid.ssid,
237 pmlmepriv->cur_network.network.MacAddress,
238 pmlmepriv->cur_network.network.ssid.ssid_length,
239 pmlmepriv->assoc_ssid.ssid_length);
240
241 pmlmepriv->to_roaming = 1;
242 }
243 /* s2-2. indicate disconnect to os */
244 rtw_indicate_disconnect(padapter);
245 /* s2-3. */
246 rtw_free_assoc_resources(padapter);
247 /* s2-4. */
248 rtw_free_network_queue(padapter, true);
249
250 rtw_dev_unload(padapter);
251 mutex_unlock(&pwrpriv->mutex_lock);
252
253 if (check_fwstate(pmlmepriv, _FW_UNDER_SURVEY))
254 rtw_indicate_scan_done(padapter, 1);
255
256 if (check_fwstate(pmlmepriv, _FW_UNDER_LINKING))
257 rtw_indicate_disconnect(padapter);
258
259 exit:
260 pr_debug("<=== %s .............. in %dms\n", __func__,
261 jiffies_to_msecs(jiffies - start_time));
262
263 return 0;
264 }
265
rtw_resume_process(struct adapter * padapter)266 static int rtw_resume_process(struct adapter *padapter)
267 {
268 struct net_device *pnetdev;
269 struct pwrctrl_priv *pwrpriv = NULL;
270 int ret = -1;
271 unsigned long start_time = jiffies;
272
273 pr_debug("==> %s (%s:%d)\n", __func__, current->comm, current->pid);
274
275 if (padapter) {
276 pnetdev = padapter->pnetdev;
277 pwrpriv = &padapter->pwrctrlpriv;
278 } else {
279 goto exit;
280 }
281
282 mutex_lock(&pwrpriv->mutex_lock);
283 rtw_reset_drv_sw(padapter);
284 pwrpriv->bkeepfwalive = false;
285
286 pr_debug("bkeepfwalive(%x)\n", pwrpriv->bkeepfwalive);
287 if (netdev_open(pnetdev) != 0) {
288 mutex_unlock(&pwrpriv->mutex_lock);
289 goto exit;
290 }
291
292 netif_device_attach(pnetdev);
293 netif_carrier_on(pnetdev);
294
295 mutex_unlock(&pwrpriv->mutex_lock);
296
297 rtw_roaming(padapter, NULL);
298
299 ret = 0;
300 exit:
301 if (pwrpriv)
302 pwrpriv->bInSuspend = false;
303 pr_debug("<=== %s return %d.............. in %dms\n", __func__,
304 ret, jiffies_to_msecs(jiffies - start_time));
305
306 return ret;
307 }
308
rtw_resume(struct usb_interface * pusb_intf)309 static int rtw_resume(struct usb_interface *pusb_intf)
310 {
311 struct dvobj_priv *dvobj = usb_get_intfdata(pusb_intf);
312 struct adapter *padapter = dvobj->if1;
313
314 return rtw_resume_process(padapter);
315 }
316
317 /*
318 * drv_init() - a device potentially for us
319 *
320 * notes: drv_init() is called when the bus driver has located
321 * a card for us to support.
322 * We accept the new device by returning 0.
323 */
324
rtw_usb_if1_init(struct dvobj_priv * dvobj,struct usb_interface * pusb_intf,const struct usb_device_id * pdid)325 static struct adapter *rtw_usb_if1_init(struct dvobj_priv *dvobj,
326 struct usb_interface *pusb_intf,
327 const struct usb_device_id *pdid)
328 {
329 struct adapter *padapter = NULL;
330 struct net_device *pnetdev = NULL;
331 struct net_device *pmondev;
332 int status = _FAIL;
333
334 padapter = vzalloc(sizeof(*padapter));
335 if (!padapter)
336 goto exit;
337 padapter->dvobj = dvobj;
338 dvobj->if1 = padapter;
339
340 padapter->bDriverStopped = true;
341 mutex_init(&padapter->hw_init_mutex);
342
343 pnetdev = rtw_init_netdev(padapter);
344 if (!pnetdev)
345 goto free_adapter;
346 SET_NETDEV_DEV(pnetdev, dvobj_to_dev(dvobj));
347 padapter = rtw_netdev_priv(pnetdev);
348
349 if (padapter->registrypriv.monitor_enable) {
350 pmondev = rtl88eu_mon_init();
351 if (!pmondev)
352 netdev_warn(pnetdev, "Failed to initialize monitor interface");
353 padapter->pmondev = pmondev;
354 }
355
356 padapter->HalData = kzalloc(sizeof(struct hal_data_8188e), GFP_KERNEL);
357 if (!padapter->HalData) {
358 DBG_88E("Failed to allocate memory for HAL data\n");
359 goto free_adapter;
360 }
361
362 /* step read_chip_version */
363 rtw_hal_read_chip_version(padapter);
364
365 /* step usb endpoint mapping */
366 rtw_hal_chip_configure(padapter);
367
368 /* step read efuse/eeprom data and get mac_addr */
369 rtw_hal_read_chip_info(padapter);
370
371 /* step 5. */
372 if (rtw_init_drv_sw(padapter) == _FAIL) {
373 RT_TRACE(_module_hci_intfs_c_, _drv_err_,
374 ("Initialize driver software resource Failed!\n"));
375 goto free_hal_data;
376 }
377
378 #ifdef CONFIG_PM
379 if (padapter->pwrctrlpriv.bSupportRemoteWakeup) {
380 dvobj->pusbdev->do_remote_wakeup = 1;
381 pusb_intf->needs_remote_wakeup = 1;
382 device_init_wakeup(&pusb_intf->dev, 1);
383 pr_debug("\n padapter->pwrctrlpriv.bSupportRemoteWakeup~~~~~~\n");
384 pr_debug("\n padapter->pwrctrlpriv.bSupportRemoteWakeup~~~[%d]~~~\n",
385 device_may_wakeup(&pusb_intf->dev));
386 }
387 #endif
388
389 /* 2012-07-11 Move here to prevent the 8723AS-VAU BT auto suspend influence */
390 if (usb_autopm_get_interface(pusb_intf) < 0)
391 pr_debug("can't get autopm:\n");
392
393 /* alloc dev name after read efuse. */
394 rtw_init_netdev_name(pnetdev, padapter->registrypriv.ifname);
395 rtw_macaddr_cfg(padapter->eeprompriv.mac_addr);
396 memcpy(pnetdev->dev_addr, padapter->eeprompriv.mac_addr, ETH_ALEN);
397 pr_debug("MAC Address from pnetdev->dev_addr = %pM\n",
398 pnetdev->dev_addr);
399
400 /* step 6. Tell the network stack we exist */
401 if (register_netdev(pnetdev) != 0) {
402 RT_TRACE(_module_hci_intfs_c_, _drv_err_, ("register_netdev() failed\n"));
403 goto free_hal_data;
404 }
405
406 pr_debug("bDriverStopped:%d, bSurpriseRemoved:%d, bup:%d, hw_init_completed:%d\n"
407 , padapter->bDriverStopped
408 , padapter->bSurpriseRemoved
409 , padapter->bup
410 , padapter->hw_init_completed
411 );
412
413 status = _SUCCESS;
414
415 free_hal_data:
416 if (status != _SUCCESS)
417 kfree(padapter->HalData);
418 free_adapter:
419 if (status != _SUCCESS) {
420 if (pnetdev)
421 rtw_free_netdev(pnetdev);
422 else
423 vfree(padapter);
424 padapter = NULL;
425 }
426 exit:
427 return padapter;
428 }
429
rtw_usb_if1_deinit(struct adapter * if1)430 static void rtw_usb_if1_deinit(struct adapter *if1)
431 {
432 struct net_device *pnetdev = if1->pnetdev;
433 struct mlme_priv *pmlmepriv = &if1->mlmepriv;
434
435 if (check_fwstate(pmlmepriv, _FW_LINKED))
436 rtw_disassoc_cmd(if1, 0, false);
437
438 #ifdef CONFIG_88EU_AP_MODE
439 free_mlme_ap_info(if1);
440 #endif
441
442 if (pnetdev)
443 unregister_netdev(pnetdev); /* will call netdev_close() */
444
445 rtl88eu_mon_deinit(if1->pmondev);
446 rtw_cancel_all_timer(if1);
447
448 rtw_dev_unload(if1);
449 pr_debug("+r871xu_dev_remove, hw_init_completed=%d\n",
450 if1->hw_init_completed);
451 rtw_free_drv_sw(if1);
452 rtw_free_netdev(pnetdev);
453 }
454
rtw_drv_init(struct usb_interface * pusb_intf,const struct usb_device_id * pdid)455 static int rtw_drv_init(struct usb_interface *pusb_intf, const struct usb_device_id *pdid)
456 {
457 struct adapter *if1 = NULL;
458 struct dvobj_priv *dvobj;
459
460 /* Initialize dvobj_priv */
461 dvobj = usb_dvobj_init(pusb_intf);
462 if (!dvobj) {
463 RT_TRACE(_module_hci_intfs_c_, _drv_err_,
464 ("initialize device object priv Failed!\n"));
465 goto exit;
466 }
467
468 if1 = rtw_usb_if1_init(dvobj, pusb_intf, pdid);
469 if (!if1) {
470 pr_debug("rtw_init_primarystruct adapter Failed!\n");
471 goto free_dvobj;
472 }
473
474 return 0;
475
476 free_dvobj:
477 usb_dvobj_deinit(pusb_intf);
478 exit:
479 return -ENODEV;
480 }
481
482 /*
483 * dev_remove() - our device is being removed
484 *
485 * rmmod module & unplug(SurpriseRemoved) will call r871xu_dev_remove() => how to recognize both
486 */
rtw_dev_remove(struct usb_interface * pusb_intf)487 static void rtw_dev_remove(struct usb_interface *pusb_intf)
488 {
489 struct dvobj_priv *dvobj = usb_get_intfdata(pusb_intf);
490 struct adapter *padapter = dvobj->if1;
491
492 pr_debug("+%s\n", __func__);
493 RT_TRACE(_module_hci_intfs_c_, _drv_err_, ("+dev_remove()\n"));
494
495 if (!pusb_intf->unregistering)
496 padapter->bSurpriseRemoved = true;
497
498 rtw_pm_set_ips(padapter, IPS_NONE);
499 rtw_pm_set_lps(padapter, PS_MODE_ACTIVE);
500
501 LeaveAllPowerSaveMode(padapter);
502
503 rtw_usb_if1_deinit(padapter);
504
505 usb_dvobj_deinit(pusb_intf);
506
507 RT_TRACE(_module_hci_intfs_c_, _drv_err_, ("-dev_remove()\n"));
508 pr_debug("-r871xu_dev_remove, done\n");
509 }
510
511 static struct usb_driver rtl8188e_usb_drv = {
512 .name = "r8188eu",
513 .probe = rtw_drv_init,
514 .disconnect = rtw_dev_remove,
515 .id_table = rtw_usb_id_tbl,
516 .suspend = rtw_suspend,
517 .resume = rtw_resume,
518 .reset_resume = rtw_resume,
519 };
520
521 module_usb_driver(rtl8188e_usb_drv)
522