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