drivers/staging/rtl8188eu/os_dep/usb_intf.c

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