LXR linux/drivers/staging/rtl8188eu/os_dep/usb

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