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