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