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