ugensa.c revision 185948
1184610Salfred/* $FreeBSD: head/sys/dev/usb2/serial/ugensa2.c 185948 2008-12-11 23:13:02Z thompsa $ */ 2184610Salfred/* $NetBSD: ugensa.c,v 1.9.2.1 2007/03/24 14:55:50 yamt Exp $ */ 3184610Salfred 4184610Salfred/* 5184610Salfred * Copyright (c) 2004, 2005 The NetBSD Foundation, Inc. 6184610Salfred * All rights reserved. 7184610Salfred * 8184610Salfred * This code is derived from software contributed to The NetBSD Foundation 9184610Salfred * by Roland C. Dowdeswell <elric@netbsd.org>. 10184610Salfred * 11184610Salfred * Redistribution and use in source and binary forms, with or without 12184610Salfred * modification, are permitted provided that the following conditions 13184610Salfred * are met: 14184610Salfred * 1. Redistributions of source code must retain the above copyright 15184610Salfred * notice, this list of conditions and the following disclaimer. 16184610Salfred * 2. Redistributions in binary form must reproduce the above copyright 17184610Salfred * notice, this list of conditions and the following disclaimer in the 18184610Salfred * documentation and/or other materials provided with the distribution. 19184610Salfred * 3. All advertising materials mentioning features or use of this software 20184610Salfred * must display the following acknowledgement: 21184610Salfred * This product includes software developed by the NetBSD 22184610Salfred * Foundation, Inc. and its contributors. 23184610Salfred * 4. Neither the name of The NetBSD Foundation nor the names of its 24184610Salfred * contributors may be used to endorse or promote products derived 25184610Salfred * from this software without specific prior written permission. 26184610Salfred * 27184610Salfred * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 28184610Salfred * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 29184610Salfred * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 30184610Salfred * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 31184610Salfred * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 32184610Salfred * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 33184610Salfred * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 34184610Salfred * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 35184610Salfred * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 36184610Salfred * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 37184610Salfred * POSSIBILITY OF SUCH DAMAGE. 38184610Salfred */ 39184610Salfred 40184610Salfred/* 41184610Salfred * NOTE: all function names beginning like "ugensa_cfg_" can only 42184610Salfred * be called from within the config thread function ! 43184610Salfred */ 44184610Salfred 45184610Salfred#include <dev/usb2/include/usb2_devid.h> 46184610Salfred#include <dev/usb2/include/usb2_standard.h> 47184610Salfred#include <dev/usb2/include/usb2_mfunc.h> 48184610Salfred#include <dev/usb2/include/usb2_error.h> 49184610Salfred#include <dev/usb2/include/usb2_cdc.h> 50184610Salfred#include <dev/usb2/include/usb2_defs.h> 51184610Salfred 52184610Salfred#define USB_DEBUG_VAR usb2_debug 53184610Salfred 54184610Salfred#include <dev/usb2/core/usb2_core.h> 55184610Salfred#include <dev/usb2/core/usb2_debug.h> 56184610Salfred#include <dev/usb2/core/usb2_process.h> 57184610Salfred#include <dev/usb2/core/usb2_config_td.h> 58184610Salfred#include <dev/usb2/core/usb2_request.h> 59184610Salfred#include <dev/usb2/core/usb2_lookup.h> 60184610Salfred#include <dev/usb2/core/usb2_util.h> 61184610Salfred#include <dev/usb2/core/usb2_device.h> 62184610Salfred 63184610Salfred#include <dev/usb2/serial/usb2_serial.h> 64184610Salfred 65184610Salfred#define UGENSA_BUF_SIZE 2048 /* bytes */ 66184610Salfred#define UGENSA_N_TRANSFER 4 /* units */ 67184610Salfred#define UGENSA_CONFIG_INDEX 0 68184610Salfred#define UGENSA_IFACE_INDEX 0 69184610Salfred#define UGENSA_IFACE_MAX 8 /* exclusivly */ 70184610Salfred 71184610Salfredstruct ugensa_sub_softc { 72184610Salfred struct usb2_com_softc *sc_usb2_com_ptr; 73184610Salfred struct usb2_xfer *sc_xfer[UGENSA_N_TRANSFER]; 74184610Salfred 75184610Salfred uint8_t sc_flags; 76184610Salfred#define UGENSA_FLAG_BULK_READ_STALL 0x01 77184610Salfred#define UGENSA_FLAG_BULK_WRITE_STALL 0x02 78184610Salfred}; 79184610Salfred 80184610Salfredstruct ugensa_softc { 81184610Salfred struct usb2_com_super_softc sc_super_ucom; 82184610Salfred struct usb2_com_softc sc_ucom[UGENSA_IFACE_MAX]; 83184610Salfred struct ugensa_sub_softc sc_sub[UGENSA_IFACE_MAX]; 84184610Salfred 85184610Salfred struct mtx sc_mtx; 86184610Salfred uint8_t sc_niface; 87184610Salfred}; 88184610Salfred 89184610Salfred/* prototypes */ 90184610Salfred 91184610Salfredstatic device_probe_t ugensa_probe; 92184610Salfredstatic device_attach_t ugensa_attach; 93184610Salfredstatic device_detach_t ugensa_detach; 94184610Salfred 95184610Salfredstatic usb2_callback_t ugensa_bulk_write_callback; 96184610Salfredstatic usb2_callback_t ugensa_bulk_write_clear_stall_callback; 97184610Salfredstatic usb2_callback_t ugensa_bulk_read_callback; 98184610Salfredstatic usb2_callback_t ugensa_bulk_read_clear_stall_callback; 99184610Salfred 100185948Sthompsastatic void ugensa_start_read(struct usb2_com_softc *); 101185948Sthompsastatic void ugensa_stop_read(struct usb2_com_softc *); 102185948Sthompsastatic void ugensa_start_write(struct usb2_com_softc *); 103185948Sthompsastatic void ugensa_stop_write(struct usb2_com_softc *); 104184610Salfred 105184610Salfredstatic const struct usb2_config 106184610Salfred ugensa_xfer_config[UGENSA_N_TRANSFER] = { 107184610Salfred 108184610Salfred [0] = { 109184610Salfred .type = UE_BULK, 110184610Salfred .endpoint = UE_ADDR_ANY, 111184610Salfred .direction = UE_DIR_OUT, 112184610Salfred .mh.bufsize = UGENSA_BUF_SIZE, 113184610Salfred .mh.flags = {.pipe_bof = 1,.force_short_xfer = 1,}, 114184610Salfred .mh.callback = &ugensa_bulk_write_callback, 115184610Salfred }, 116184610Salfred 117184610Salfred [1] = { 118184610Salfred .type = UE_BULK, 119184610Salfred .endpoint = UE_ADDR_ANY, 120184610Salfred .direction = UE_DIR_IN, 121184610Salfred .mh.bufsize = UGENSA_BUF_SIZE, 122184610Salfred .mh.flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 123184610Salfred .mh.callback = &ugensa_bulk_read_callback, 124184610Salfred }, 125184610Salfred 126184610Salfred [2] = { 127184610Salfred .type = UE_CONTROL, 128184610Salfred .endpoint = 0x00, /* Control pipe */ 129184610Salfred .direction = UE_DIR_ANY, 130184610Salfred .mh.bufsize = sizeof(struct usb2_device_request), 131184610Salfred .mh.flags = {}, 132184610Salfred .mh.callback = &ugensa_bulk_write_clear_stall_callback, 133184610Salfred .mh.timeout = 1000, /* 1 second */ 134184610Salfred .mh.interval = 50, /* 50ms */ 135184610Salfred }, 136184610Salfred 137184610Salfred [3] = { 138184610Salfred .type = UE_CONTROL, 139184610Salfred .endpoint = 0x00, /* Control pipe */ 140184610Salfred .direction = UE_DIR_ANY, 141184610Salfred .mh.bufsize = sizeof(struct usb2_device_request), 142184610Salfred .mh.flags = {}, 143184610Salfred .mh.callback = &ugensa_bulk_read_clear_stall_callback, 144184610Salfred .mh.timeout = 1000, /* 1 second */ 145184610Salfred .mh.interval = 50, /* 50ms */ 146184610Salfred }, 147184610Salfred}; 148184610Salfred 149184610Salfredstatic const struct usb2_com_callback ugensa_callback = { 150184610Salfred .usb2_com_start_read = &ugensa_start_read, 151184610Salfred .usb2_com_stop_read = &ugensa_stop_read, 152184610Salfred .usb2_com_start_write = &ugensa_start_write, 153184610Salfred .usb2_com_stop_write = &ugensa_stop_write, 154184610Salfred}; 155184610Salfred 156184610Salfredstatic device_method_t ugensa_methods[] = { 157184610Salfred /* Device methods */ 158184610Salfred DEVMETHOD(device_probe, ugensa_probe), 159184610Salfred DEVMETHOD(device_attach, ugensa_attach), 160184610Salfred DEVMETHOD(device_detach, ugensa_detach), 161184610Salfred {0, 0} 162184610Salfred}; 163184610Salfred 164184610Salfredstatic devclass_t ugensa_devclass; 165184610Salfred 166184610Salfredstatic driver_t ugensa_driver = { 167184610Salfred .name = "ugensa", 168184610Salfred .methods = ugensa_methods, 169184610Salfred .size = sizeof(struct ugensa_softc), 170184610Salfred}; 171184610Salfred 172184610SalfredDRIVER_MODULE(ugensa, ushub, ugensa_driver, ugensa_devclass, NULL, 0); 173184610SalfredMODULE_DEPEND(ugensa, usb2_serial, 1, 1, 1); 174184610SalfredMODULE_DEPEND(ugensa, usb2_core, 1, 1, 1); 175184610Salfred 176184610Salfredstatic const struct usb2_device_id ugensa_devs[] = { 177184610Salfred {USB_VPI(USB_VENDOR_AIRPRIME, USB_PRODUCT_AIRPRIME_PC5220, 0)}, 178184610Salfred {USB_VPI(USB_VENDOR_CMOTECH, USB_PRODUCT_CMOTECH_CDMA_MODEM1, 0)}, 179184610Salfred {USB_VPI(USB_VENDOR_KYOCERA2, USB_PRODUCT_KYOCERA2_CDMA_MSM_K, 0)}, 180184610Salfred {USB_VPI(USB_VENDOR_HP, USB_PRODUCT_HP_49GPLUS, 0)}, 181185087Salfred/* {USB_VPI(USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_E270, 0)}, */ 182184610Salfred {USB_VPI(USB_VENDOR_HUAWEI, USB_PRODUCT_HUAWEI_MOBILE, 0)}, 183184610Salfred {USB_VPI(USB_VENDOR_MERLIN, USB_PRODUCT_MERLIN_V620, 0)}, 184184610Salfred {USB_VPI(USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_FLEXPACKGPS, 0)}, 185184610Salfred}; 186184610Salfred 187184610Salfredstatic int 188184610Salfredugensa_probe(device_t dev) 189184610Salfred{ 190184610Salfred struct usb2_attach_arg *uaa = device_get_ivars(dev); 191184610Salfred 192184610Salfred if (uaa->usb2_mode != USB_MODE_HOST) { 193184610Salfred return (ENXIO); 194184610Salfred } 195184610Salfred if (uaa->info.bConfigIndex != UGENSA_CONFIG_INDEX) { 196184610Salfred return (ENXIO); 197184610Salfred } 198184610Salfred if (uaa->info.bIfaceIndex != 0) { 199184610Salfred return (ENXIO); 200184610Salfred } 201184610Salfred return (usb2_lookup_id_by_uaa(ugensa_devs, sizeof(ugensa_devs), uaa)); 202184610Salfred} 203184610Salfred 204184610Salfredstatic int 205184610Salfredugensa_attach(device_t dev) 206184610Salfred{ 207184610Salfred struct usb2_attach_arg *uaa = device_get_ivars(dev); 208184610Salfred struct ugensa_softc *sc = device_get_softc(dev); 209184610Salfred struct ugensa_sub_softc *ssc; 210184610Salfred struct usb2_interface *iface; 211184610Salfred int32_t error; 212184610Salfred uint8_t iface_index; 213184610Salfred int x, cnt; 214184610Salfred 215184610Salfred if (sc == NULL) 216184610Salfred return (ENOMEM); 217184610Salfred 218184610Salfred device_set_usb2_desc(dev); 219184610Salfred mtx_init(&sc->sc_mtx, "ugensa", NULL, MTX_DEF); 220184610Salfred 221184610Salfred /* Figure out how many interfaces this device has got */ 222184610Salfred for (cnt = 0; cnt < UGENSA_IFACE_MAX; cnt++) { 223184610Salfred if ((usb2_get_pipe(uaa->device, cnt, ugensa_xfer_config + 0) == NULL) || 224184610Salfred (usb2_get_pipe(uaa->device, cnt, ugensa_xfer_config + 1) == NULL)) { 225184610Salfred /* we have reached the end */ 226184610Salfred break; 227184610Salfred } 228184610Salfred } 229184610Salfred 230184610Salfred if (cnt == 0) { 231184610Salfred device_printf(dev, "No interfaces!\n"); 232184610Salfred goto detach; 233184610Salfred } 234184610Salfred for (x = 0; x < cnt; x++) { 235184610Salfred iface = usb2_get_iface(uaa->device, x); 236184610Salfred if (iface->idesc->bInterfaceClass != UICLASS_VENDOR) 237184610Salfred /* Not a serial port, most likely a SD reader */ 238184610Salfred continue; 239184610Salfred 240184610Salfred ssc = sc->sc_sub + sc->sc_niface; 241184610Salfred ssc->sc_usb2_com_ptr = sc->sc_ucom + sc->sc_niface; 242184610Salfred 243184610Salfred iface_index = (UGENSA_IFACE_INDEX + x); 244184610Salfred error = usb2_transfer_setup(uaa->device, 245184610Salfred &iface_index, ssc->sc_xfer, ugensa_xfer_config, 246184610Salfred UGENSA_N_TRANSFER, ssc, &sc->sc_mtx); 247184610Salfred 248184610Salfred if (error) { 249184610Salfred device_printf(dev, "allocating USB " 250184610Salfred "transfers failed!\n"); 251184610Salfred goto detach; 252184610Salfred } 253184610Salfred /* clear stall at first run */ 254184610Salfred ssc->sc_flags |= (UGENSA_FLAG_BULK_WRITE_STALL | 255184610Salfred UGENSA_FLAG_BULK_READ_STALL); 256184610Salfred 257184610Salfred /* initialize port number */ 258184610Salfred ssc->sc_usb2_com_ptr->sc_portno = sc->sc_niface; 259184610Salfred sc->sc_niface++; 260184610Salfred if (x != uaa->info.bIfaceIndex) 261184610Salfred usb2_set_parent_iface(uaa->device, x, 262184610Salfred uaa->info.bIfaceIndex); 263184610Salfred } 264184610Salfred device_printf(dev, "Found %d interfaces.\n", sc->sc_niface); 265184610Salfred 266184610Salfred error = usb2_com_attach(&sc->sc_super_ucom, sc->sc_ucom, sc->sc_niface, sc, 267184610Salfred &ugensa_callback, &sc->sc_mtx); 268184610Salfred if (error) { 269184610Salfred DPRINTF("attach failed\n"); 270184610Salfred goto detach; 271184610Salfred } 272184610Salfred return (0); /* success */ 273184610Salfred 274184610Salfreddetach: 275184610Salfred ugensa_detach(dev); 276184610Salfred return (ENXIO); /* failure */ 277184610Salfred} 278184610Salfred 279184610Salfredstatic int 280184610Salfredugensa_detach(device_t dev) 281184610Salfred{ 282184610Salfred struct ugensa_softc *sc = device_get_softc(dev); 283184610Salfred uint8_t x; 284184610Salfred 285184610Salfred usb2_com_detach(&sc->sc_super_ucom, sc->sc_ucom, sc->sc_niface); 286184610Salfred 287184610Salfred for (x = 0; x < sc->sc_niface; x++) { 288184610Salfred usb2_transfer_unsetup(sc->sc_sub[x].sc_xfer, UGENSA_N_TRANSFER); 289184610Salfred } 290184610Salfred mtx_destroy(&sc->sc_mtx); 291184610Salfred 292184610Salfred return (0); 293184610Salfred} 294184610Salfred 295184610Salfredstatic void 296184610Salfredugensa_bulk_write_callback(struct usb2_xfer *xfer) 297184610Salfred{ 298184610Salfred struct ugensa_sub_softc *ssc = xfer->priv_sc; 299184610Salfred uint32_t actlen; 300184610Salfred 301184610Salfred switch (USB_GET_STATE(xfer)) { 302184610Salfred case USB_ST_SETUP: 303184610Salfred case USB_ST_TRANSFERRED: 304184610Salfred if (ssc->sc_flags & UGENSA_FLAG_BULK_WRITE_STALL) { 305184610Salfred usb2_transfer_start(ssc->sc_xfer[2]); 306184610Salfred return; 307184610Salfred } 308184610Salfred if (usb2_com_get_data(ssc->sc_usb2_com_ptr, xfer->frbuffers, 0, 309184610Salfred UGENSA_BUF_SIZE, &actlen)) { 310184610Salfred xfer->frlengths[0] = actlen; 311184610Salfred usb2_start_hardware(xfer); 312184610Salfred } 313184610Salfred return; 314184610Salfred 315184610Salfred default: /* Error */ 316184610Salfred if (xfer->error != USB_ERR_CANCELLED) { 317184610Salfred ssc->sc_flags |= UGENSA_FLAG_BULK_WRITE_STALL; 318184610Salfred usb2_transfer_start(ssc->sc_xfer[2]); 319184610Salfred } 320184610Salfred return; 321184610Salfred 322184610Salfred } 323184610Salfred} 324184610Salfred 325184610Salfredstatic void 326184610Salfredugensa_bulk_write_clear_stall_callback(struct usb2_xfer *xfer) 327184610Salfred{ 328184610Salfred struct ugensa_sub_softc *ssc = xfer->priv_sc; 329184610Salfred struct usb2_xfer *xfer_other = ssc->sc_xfer[0]; 330184610Salfred 331184610Salfred if (usb2_clear_stall_callback(xfer, xfer_other)) { 332184610Salfred DPRINTF("stall cleared\n"); 333184610Salfred ssc->sc_flags &= ~UGENSA_FLAG_BULK_WRITE_STALL; 334184610Salfred usb2_transfer_start(xfer_other); 335184610Salfred } 336184610Salfred return; 337184610Salfred} 338184610Salfred 339184610Salfredstatic void 340184610Salfredugensa_bulk_read_callback(struct usb2_xfer *xfer) 341184610Salfred{ 342184610Salfred struct ugensa_sub_softc *ssc = xfer->priv_sc; 343184610Salfred 344184610Salfred switch (USB_GET_STATE(xfer)) { 345184610Salfred case USB_ST_TRANSFERRED: 346184610Salfred usb2_com_put_data(ssc->sc_usb2_com_ptr, xfer->frbuffers, 0, 347184610Salfred xfer->actlen); 348184610Salfred 349184610Salfred case USB_ST_SETUP: 350184610Salfred if (ssc->sc_flags & UGENSA_FLAG_BULK_READ_STALL) { 351184610Salfred usb2_transfer_start(ssc->sc_xfer[3]); 352184610Salfred } else { 353184610Salfred xfer->frlengths[0] = xfer->max_data_length; 354184610Salfred usb2_start_hardware(xfer); 355184610Salfred } 356184610Salfred return; 357184610Salfred 358184610Salfred default: /* Error */ 359184610Salfred if (xfer->error != USB_ERR_CANCELLED) { 360184610Salfred ssc->sc_flags |= UGENSA_FLAG_BULK_READ_STALL; 361184610Salfred usb2_transfer_start(ssc->sc_xfer[3]); 362184610Salfred } 363184610Salfred return; 364184610Salfred 365184610Salfred } 366184610Salfred} 367184610Salfred 368184610Salfredstatic void 369184610Salfredugensa_bulk_read_clear_stall_callback(struct usb2_xfer *xfer) 370184610Salfred{ 371184610Salfred struct ugensa_sub_softc *ssc = xfer->priv_sc; 372184610Salfred struct usb2_xfer *xfer_other = ssc->sc_xfer[1]; 373184610Salfred 374184610Salfred if (usb2_clear_stall_callback(xfer, xfer_other)) { 375184610Salfred DPRINTF("stall cleared\n"); 376184610Salfred ssc->sc_flags &= ~UGENSA_FLAG_BULK_READ_STALL; 377184610Salfred usb2_transfer_start(xfer_other); 378184610Salfred } 379184610Salfred return; 380184610Salfred} 381184610Salfred 382184610Salfredstatic void 383184610Salfredugensa_start_read(struct usb2_com_softc *ucom) 384184610Salfred{ 385184610Salfred struct ugensa_softc *sc = ucom->sc_parent; 386184610Salfred struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno; 387184610Salfred 388184610Salfred usb2_transfer_start(ssc->sc_xfer[1]); 389184610Salfred return; 390184610Salfred} 391184610Salfred 392184610Salfredstatic void 393184610Salfredugensa_stop_read(struct usb2_com_softc *ucom) 394184610Salfred{ 395184610Salfred struct ugensa_softc *sc = ucom->sc_parent; 396184610Salfred struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno; 397184610Salfred 398184610Salfred usb2_transfer_stop(ssc->sc_xfer[3]); 399184610Salfred usb2_transfer_stop(ssc->sc_xfer[1]); 400184610Salfred return; 401184610Salfred} 402184610Salfred 403184610Salfredstatic void 404184610Salfredugensa_start_write(struct usb2_com_softc *ucom) 405184610Salfred{ 406184610Salfred struct ugensa_softc *sc = ucom->sc_parent; 407184610Salfred struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno; 408184610Salfred 409184610Salfred usb2_transfer_start(ssc->sc_xfer[0]); 410184610Salfred return; 411184610Salfred} 412184610Salfred 413184610Salfredstatic void 414184610Salfredugensa_stop_write(struct usb2_com_softc *ucom) 415184610Salfred{ 416184610Salfred struct ugensa_softc *sc = ucom->sc_parent; 417184610Salfred struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno; 418184610Salfred 419184610Salfred usb2_transfer_stop(ssc->sc_xfer[2]); 420184610Salfred usb2_transfer_stop(ssc->sc_xfer[0]); 421184610Salfred return; 422184610Salfred} 423