drivers/staging/rtl8188eu/os_dep/usb_intf.c

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