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 int 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 -ENOMEM;
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 0;
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 usb_interface * pusb_intf)325 static int rtw_usb_if1_init(struct usb_interface *pusb_intf)
326 {
327 	struct dvobj_priv *dvobj = usb_get_intfdata(pusb_intf);
328 	struct adapter *padapter;
329 	struct net_device *pnetdev;
330 	struct net_device *pmondev;
331 	int err = 0;
332 
333 	pnetdev = rtw_init_netdev();
334 	if (!pnetdev)
335 		return -ENOMEM;
336 	SET_NETDEV_DEV(pnetdev, dvobj_to_dev(dvobj));
337 
338 	padapter = netdev_priv(pnetdev);
339 	padapter->dvobj = dvobj;
340 	dvobj->if1 = padapter;
341 
342 	padapter->bDriverStopped = true;
343 	mutex_init(&padapter->hw_init_mutex);
344 
345 	if (padapter->registrypriv.monitor_enable) {
346 		pmondev = rtl88eu_mon_init();
347 		if (!pmondev)
348 			netdev_warn(pnetdev, "Failed to initialize monitor interface");
349 		padapter->pmondev = pmondev;
350 	}
351 
352 	padapter->HalData = kzalloc(sizeof(struct hal_data_8188e), GFP_KERNEL);
353 	if (!padapter->HalData) {
354 		DBG_88E("Failed to allocate memory for HAL data\n");
355 		err = -ENOMEM;
356 		goto free_adapter;
357 	}
358 
359 	/* step read_chip_version */
360 	rtw_hal_read_chip_version(padapter);
361 
362 	/* step usb endpoint mapping */
363 	rtw_hal_chip_configure(padapter);
364 
365 	/* step read efuse/eeprom data and get mac_addr */
366 	rtw_hal_read_chip_info(padapter);
367 
368 	/* step 5. */
369 	if (rtw_init_drv_sw(padapter) == _FAIL) {
370 		RT_TRACE(_module_hci_intfs_c_, _drv_err_,
371 			 ("Initialize driver software resource Failed!\n"));
372 		err = -ENOMEM;
373 		goto free_hal_data;
374 	}
375 
376 #ifdef CONFIG_PM
377 	if (padapter->pwrctrlpriv.bSupportRemoteWakeup) {
378 		dvobj->pusbdev->do_remote_wakeup = 1;
379 		pusb_intf->needs_remote_wakeup = 1;
380 		device_init_wakeup(&pusb_intf->dev, 1);
381 		pr_debug("\n  padapter->pwrctrlpriv.bSupportRemoteWakeup~~~[%d]~~~\n",
382 			 device_may_wakeup(&pusb_intf->dev));
383 	}
384 #endif
385 
386 	/* 2012-07-11 Move here to prevent the 8723AS-VAU BT auto suspend influence */
387 	if (usb_autopm_get_interface(pusb_intf) < 0)
388 		pr_debug("can't get autopm:\n");
389 
390 	/*  alloc dev name after read efuse. */
391 	if (dev_alloc_name(pnetdev, padapter->registrypriv.ifname) < 0)
392 		RT_TRACE(_module_os_intfs_c_, _drv_err_, ("dev_alloc_name, fail!\n"));
393 
394 	netif_carrier_off(pnetdev);
395 
396 	rtw_macaddr_cfg(padapter->eeprompriv.mac_addr);
397 	memcpy(pnetdev->dev_addr, padapter->eeprompriv.mac_addr, ETH_ALEN);
398 	pr_debug("MAC Address from pnetdev->dev_addr =  %pM\n",
399 		 pnetdev->dev_addr);
400 
401 	/* step 6. Tell the network stack we exist */
402 	err = register_netdev(pnetdev);
403 	if (err) {
404 		RT_TRACE(_module_hci_intfs_c_, _drv_err_, ("register_netdev() failed\n"));
405 		goto free_hal_data;
406 	}
407 
408 	pr_debug("bDriverStopped:%d, bSurpriseRemoved:%d, bup:%d, hw_init_completed:%d\n"
409 		, padapter->bDriverStopped
410 		, padapter->bSurpriseRemoved
411 		, padapter->bup
412 		, padapter->hw_init_completed
413 	);
414 
415 	return 0;
416 
417 free_hal_data:
418 	kfree(padapter->HalData);
419 free_adapter:
420 	free_netdev(pnetdev);
421 	return err;
422 }
423 
rtw_usb_if1_deinit(struct adapter * if1)424 static void rtw_usb_if1_deinit(struct adapter *if1)
425 {
426 	struct net_device *pnetdev = if1->pnetdev;
427 	struct mlme_priv *pmlmepriv = &if1->mlmepriv;
428 
429 	if (check_fwstate(pmlmepriv, _FW_LINKED))
430 		rtw_disassoc_cmd(if1, 0, false);
431 
432 #ifdef CONFIG_88EU_AP_MODE
433 	free_mlme_ap_info(if1);
434 #endif
435 
436 	if (pnetdev)
437 		unregister_netdev(pnetdev); /* will call netdev_close() */
438 
439 	rtl88eu_mon_deinit(if1->pmondev);
440 	rtw_cancel_all_timer(if1);
441 
442 	rtw_dev_unload(if1);
443 	pr_debug("+r871xu_dev_remove, hw_init_completed=%d\n",
444 		 if1->hw_init_completed);
445 	rtw_free_drv_sw(if1);
446 	if (pnetdev)
447 		free_netdev(pnetdev);
448 }
449 
rtw_drv_init(struct usb_interface * pusb_intf,const struct usb_device_id * pdid)450 static int rtw_drv_init(struct usb_interface *pusb_intf, const struct usb_device_id *pdid)
451 {
452 	int err;
453 
454 	err = usb_dvobj_init(pusb_intf);
455 	if (err) {
456 		pr_debug("usb_dvobj_init failed\n");
457 		return err;
458 	}
459 
460 	err = rtw_usb_if1_init(pusb_intf);
461 	if (err) {
462 		pr_debug("rtw_usb_if1_init failed\n");
463 		usb_dvobj_deinit(pusb_intf);
464 		return err;
465 	}
466 
467 	return 0;
468 }
469 
470 /*
471  * dev_remove() - our device is being removed
472  *
473  * rmmod module & unplug(SurpriseRemoved) will call r871xu_dev_remove() => how to recognize both
474  */
rtw_dev_remove(struct usb_interface * pusb_intf)475 static void rtw_dev_remove(struct usb_interface *pusb_intf)
476 {
477 	struct dvobj_priv *dvobj = usb_get_intfdata(pusb_intf);
478 	struct adapter *padapter = dvobj->if1;
479 
480 	pr_debug("+%s\n", __func__);
481 	RT_TRACE(_module_hci_intfs_c_, _drv_err_, ("+dev_remove()\n"));
482 
483 	if (!pusb_intf->unregistering)
484 		padapter->bSurpriseRemoved = true;
485 
486 	rtw_pm_set_ips(padapter, IPS_NONE);
487 	rtw_pm_set_lps(padapter, PS_MODE_ACTIVE);
488 
489 	LeaveAllPowerSaveMode(padapter);
490 
491 	rtw_usb_if1_deinit(padapter);
492 
493 	usb_dvobj_deinit(pusb_intf);
494 
495 	RT_TRACE(_module_hci_intfs_c_, _drv_err_, ("-dev_remove()\n"));
496 	pr_debug("-r871xu_dev_remove, done\n");
497 }
498 
499 static struct usb_driver rtl8188e_usb_drv = {
500 	.name = "r8188eu",
501 	.probe = rtw_drv_init,
502 	.disconnect = rtw_dev_remove,
503 	.id_table = rtw_usb_id_tbl,
504 	.suspend =  rtw_suspend,
505 	.resume = rtw_resume,
506 	.reset_resume = rtw_resume,
507 };
508 
509 module_usb_driver(rtl8188e_usb_drv)
510