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