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