ugensa.c revision 189275
1184610Salfred/* $FreeBSD: head/sys/dev/usb/serial/ugensa.c 189275 2009-03-02 05:37:05Z 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 45188746Sthompsa#include "usbdevs.h" 46188942Sthompsa#include <dev/usb/usb.h> 47188942Sthompsa#include <dev/usb/usb_mfunc.h> 48188942Sthompsa#include <dev/usb/usb_error.h> 49188942Sthompsa#include <dev/usb/usb_cdc.h> 50188942Sthompsa#include <dev/usb/usb_defs.h> 51184610Salfred 52184610Salfred#define USB_DEBUG_VAR usb2_debug 53184610Salfred 54188942Sthompsa#include <dev/usb/usb_core.h> 55188942Sthompsa#include <dev/usb/usb_debug.h> 56188942Sthompsa#include <dev/usb/usb_process.h> 57188942Sthompsa#include <dev/usb/usb_request.h> 58188942Sthompsa#include <dev/usb/usb_lookup.h> 59188942Sthompsa#include <dev/usb/usb_util.h> 60188942Sthompsa#include <dev/usb/usb_device.h> 61184610Salfred 62188942Sthompsa#include <dev/usb/serial/usb_serial.h> 63184610Salfred 64184610Salfred#define UGENSA_BUF_SIZE 2048 /* bytes */ 65184610Salfred#define UGENSA_CONFIG_INDEX 0 66184610Salfred#define UGENSA_IFACE_INDEX 0 67184610Salfred#define UGENSA_IFACE_MAX 8 /* exclusivly */ 68184610Salfred 69187259Sthompsaenum { 70187259Sthompsa UGENSA_BULK_DT_WR, 71187259Sthompsa UGENSA_BULK_DT_RD, 72188413Sthompsa UGENSA_N_TRANSFER, 73187259Sthompsa}; 74187259Sthompsa 75184610Salfredstruct ugensa_sub_softc { 76184610Salfred struct usb2_com_softc *sc_usb2_com_ptr; 77184610Salfred struct usb2_xfer *sc_xfer[UGENSA_N_TRANSFER]; 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_read_callback; 97184610Salfred 98185948Sthompsastatic void ugensa_start_read(struct usb2_com_softc *); 99185948Sthompsastatic void ugensa_stop_read(struct usb2_com_softc *); 100185948Sthompsastatic void ugensa_start_write(struct usb2_com_softc *); 101185948Sthompsastatic void ugensa_stop_write(struct usb2_com_softc *); 102184610Salfred 103184610Salfredstatic const struct usb2_config 104184610Salfred ugensa_xfer_config[UGENSA_N_TRANSFER] = { 105184610Salfred 106187259Sthompsa [UGENSA_BULK_DT_WR] = { 107184610Salfred .type = UE_BULK, 108184610Salfred .endpoint = UE_ADDR_ANY, 109184610Salfred .direction = UE_DIR_OUT, 110184610Salfred .mh.bufsize = UGENSA_BUF_SIZE, 111184610Salfred .mh.flags = {.pipe_bof = 1,.force_short_xfer = 1,}, 112184610Salfred .mh.callback = &ugensa_bulk_write_callback, 113184610Salfred }, 114184610Salfred 115187259Sthompsa [UGENSA_BULK_DT_RD] = { 116184610Salfred .type = UE_BULK, 117184610Salfred .endpoint = UE_ADDR_ANY, 118184610Salfred .direction = UE_DIR_IN, 119184610Salfred .mh.bufsize = UGENSA_BUF_SIZE, 120184610Salfred .mh.flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 121184610Salfred .mh.callback = &ugensa_bulk_read_callback, 122184610Salfred }, 123184610Salfred}; 124184610Salfred 125184610Salfredstatic const struct usb2_com_callback ugensa_callback = { 126184610Salfred .usb2_com_start_read = &ugensa_start_read, 127184610Salfred .usb2_com_stop_read = &ugensa_stop_read, 128184610Salfred .usb2_com_start_write = &ugensa_start_write, 129184610Salfred .usb2_com_stop_write = &ugensa_stop_write, 130184610Salfred}; 131184610Salfred 132184610Salfredstatic device_method_t ugensa_methods[] = { 133184610Salfred /* Device methods */ 134184610Salfred DEVMETHOD(device_probe, ugensa_probe), 135184610Salfred DEVMETHOD(device_attach, ugensa_attach), 136184610Salfred DEVMETHOD(device_detach, ugensa_detach), 137184610Salfred {0, 0} 138184610Salfred}; 139184610Salfred 140184610Salfredstatic devclass_t ugensa_devclass; 141184610Salfred 142184610Salfredstatic driver_t ugensa_driver = { 143184610Salfred .name = "ugensa", 144184610Salfred .methods = ugensa_methods, 145184610Salfred .size = sizeof(struct ugensa_softc), 146184610Salfred}; 147184610Salfred 148189275SthompsaDRIVER_MODULE(ugensa, uhub, ugensa_driver, ugensa_devclass, NULL, 0); 149188942SthompsaMODULE_DEPEND(ugensa, ucom, 1, 1, 1); 150188942SthompsaMODULE_DEPEND(ugensa, usb, 1, 1, 1); 151184610Salfred 152184610Salfredstatic const struct usb2_device_id ugensa_devs[] = { 153184610Salfred {USB_VPI(USB_VENDOR_AIRPRIME, USB_PRODUCT_AIRPRIME_PC5220, 0)}, 154184610Salfred {USB_VPI(USB_VENDOR_CMOTECH, USB_PRODUCT_CMOTECH_CDMA_MODEM1, 0)}, 155184610Salfred {USB_VPI(USB_VENDOR_KYOCERA2, USB_PRODUCT_KYOCERA2_CDMA_MSM_K, 0)}, 156184610Salfred {USB_VPI(USB_VENDOR_HP, USB_PRODUCT_HP_49GPLUS, 0)}, 157184610Salfred {USB_VPI(USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_FLEXPACKGPS, 0)}, 158184610Salfred}; 159184610Salfred 160184610Salfredstatic int 161184610Salfredugensa_probe(device_t dev) 162184610Salfred{ 163184610Salfred struct usb2_attach_arg *uaa = device_get_ivars(dev); 164184610Salfred 165184610Salfred if (uaa->usb2_mode != USB_MODE_HOST) { 166184610Salfred return (ENXIO); 167184610Salfred } 168184610Salfred if (uaa->info.bConfigIndex != UGENSA_CONFIG_INDEX) { 169184610Salfred return (ENXIO); 170184610Salfred } 171184610Salfred if (uaa->info.bIfaceIndex != 0) { 172184610Salfred return (ENXIO); 173184610Salfred } 174184610Salfred return (usb2_lookup_id_by_uaa(ugensa_devs, sizeof(ugensa_devs), uaa)); 175184610Salfred} 176184610Salfred 177184610Salfredstatic int 178184610Salfredugensa_attach(device_t dev) 179184610Salfred{ 180184610Salfred struct usb2_attach_arg *uaa = device_get_ivars(dev); 181184610Salfred struct ugensa_softc *sc = device_get_softc(dev); 182184610Salfred struct ugensa_sub_softc *ssc; 183184610Salfred struct usb2_interface *iface; 184184610Salfred int32_t error; 185184610Salfred uint8_t iface_index; 186184610Salfred int x, cnt; 187184610Salfred 188184610Salfred device_set_usb2_desc(dev); 189184610Salfred mtx_init(&sc->sc_mtx, "ugensa", NULL, MTX_DEF); 190184610Salfred 191184610Salfred /* Figure out how many interfaces this device has got */ 192184610Salfred for (cnt = 0; cnt < UGENSA_IFACE_MAX; cnt++) { 193184610Salfred if ((usb2_get_pipe(uaa->device, cnt, ugensa_xfer_config + 0) == NULL) || 194184610Salfred (usb2_get_pipe(uaa->device, cnt, ugensa_xfer_config + 1) == NULL)) { 195184610Salfred /* we have reached the end */ 196184610Salfred break; 197184610Salfred } 198184610Salfred } 199184610Salfred 200184610Salfred if (cnt == 0) { 201184610Salfred device_printf(dev, "No interfaces!\n"); 202184610Salfred goto detach; 203184610Salfred } 204184610Salfred for (x = 0; x < cnt; x++) { 205184610Salfred iface = usb2_get_iface(uaa->device, x); 206184610Salfred if (iface->idesc->bInterfaceClass != UICLASS_VENDOR) 207184610Salfred /* Not a serial port, most likely a SD reader */ 208184610Salfred continue; 209184610Salfred 210184610Salfred ssc = sc->sc_sub + sc->sc_niface; 211184610Salfred ssc->sc_usb2_com_ptr = sc->sc_ucom + sc->sc_niface; 212184610Salfred 213184610Salfred iface_index = (UGENSA_IFACE_INDEX + x); 214184610Salfred error = usb2_transfer_setup(uaa->device, 215184610Salfred &iface_index, ssc->sc_xfer, ugensa_xfer_config, 216184610Salfred UGENSA_N_TRANSFER, ssc, &sc->sc_mtx); 217184610Salfred 218184610Salfred if (error) { 219184610Salfred device_printf(dev, "allocating USB " 220184610Salfred "transfers failed!\n"); 221184610Salfred goto detach; 222184610Salfred } 223184610Salfred /* clear stall at first run */ 224189265Sthompsa mtx_lock(&sc->sc_mtx); 225188413Sthompsa usb2_transfer_set_stall(ssc->sc_xfer[UGENSA_BULK_DT_WR]); 226188413Sthompsa usb2_transfer_set_stall(ssc->sc_xfer[UGENSA_BULK_DT_RD]); 227189265Sthompsa mtx_unlock(&sc->sc_mtx); 228184610Salfred 229184610Salfred /* initialize port number */ 230184610Salfred ssc->sc_usb2_com_ptr->sc_portno = sc->sc_niface; 231184610Salfred sc->sc_niface++; 232184610Salfred if (x != uaa->info.bIfaceIndex) 233184610Salfred usb2_set_parent_iface(uaa->device, x, 234184610Salfred uaa->info.bIfaceIndex); 235184610Salfred } 236184610Salfred device_printf(dev, "Found %d interfaces.\n", sc->sc_niface); 237184610Salfred 238184610Salfred error = usb2_com_attach(&sc->sc_super_ucom, sc->sc_ucom, sc->sc_niface, sc, 239184610Salfred &ugensa_callback, &sc->sc_mtx); 240184610Salfred if (error) { 241184610Salfred DPRINTF("attach failed\n"); 242184610Salfred goto detach; 243184610Salfred } 244184610Salfred return (0); /* success */ 245184610Salfred 246184610Salfreddetach: 247184610Salfred ugensa_detach(dev); 248184610Salfred return (ENXIO); /* failure */ 249184610Salfred} 250184610Salfred 251184610Salfredstatic int 252184610Salfredugensa_detach(device_t dev) 253184610Salfred{ 254184610Salfred struct ugensa_softc *sc = device_get_softc(dev); 255184610Salfred uint8_t x; 256184610Salfred 257184610Salfred usb2_com_detach(&sc->sc_super_ucom, sc->sc_ucom, sc->sc_niface); 258184610Salfred 259184610Salfred for (x = 0; x < sc->sc_niface; x++) { 260184610Salfred usb2_transfer_unsetup(sc->sc_sub[x].sc_xfer, UGENSA_N_TRANSFER); 261184610Salfred } 262184610Salfred mtx_destroy(&sc->sc_mtx); 263184610Salfred 264184610Salfred return (0); 265184610Salfred} 266184610Salfred 267184610Salfredstatic void 268184610Salfredugensa_bulk_write_callback(struct usb2_xfer *xfer) 269184610Salfred{ 270184610Salfred struct ugensa_sub_softc *ssc = xfer->priv_sc; 271184610Salfred uint32_t actlen; 272184610Salfred 273184610Salfred switch (USB_GET_STATE(xfer)) { 274184610Salfred case USB_ST_SETUP: 275184610Salfred case USB_ST_TRANSFERRED: 276188413Sthompsatr_setup: 277184610Salfred if (usb2_com_get_data(ssc->sc_usb2_com_ptr, xfer->frbuffers, 0, 278184610Salfred UGENSA_BUF_SIZE, &actlen)) { 279184610Salfred xfer->frlengths[0] = actlen; 280184610Salfred usb2_start_hardware(xfer); 281184610Salfred } 282184610Salfred return; 283184610Salfred 284184610Salfred default: /* Error */ 285184610Salfred if (xfer->error != USB_ERR_CANCELLED) { 286188413Sthompsa /* try to clear stall first */ 287188413Sthompsa xfer->flags.stall_pipe = 1; 288188413Sthompsa goto tr_setup; 289184610Salfred } 290184610Salfred return; 291184610Salfred } 292184610Salfred} 293184610Salfred 294184610Salfredstatic void 295184610Salfredugensa_bulk_read_callback(struct usb2_xfer *xfer) 296184610Salfred{ 297184610Salfred struct ugensa_sub_softc *ssc = xfer->priv_sc; 298184610Salfred 299184610Salfred switch (USB_GET_STATE(xfer)) { 300184610Salfred case USB_ST_TRANSFERRED: 301184610Salfred usb2_com_put_data(ssc->sc_usb2_com_ptr, xfer->frbuffers, 0, 302184610Salfred xfer->actlen); 303184610Salfred 304184610Salfred case USB_ST_SETUP: 305188413Sthompsatr_setup: 306188413Sthompsa xfer->frlengths[0] = xfer->max_data_length; 307188413Sthompsa usb2_start_hardware(xfer); 308184610Salfred return; 309184610Salfred 310184610Salfred default: /* Error */ 311184610Salfred if (xfer->error != USB_ERR_CANCELLED) { 312188413Sthompsa /* try to clear stall first */ 313188413Sthompsa xfer->flags.stall_pipe = 1; 314188413Sthompsa goto tr_setup; 315184610Salfred } 316184610Salfred return; 317184610Salfred } 318184610Salfred} 319184610Salfred 320184610Salfredstatic void 321184610Salfredugensa_start_read(struct usb2_com_softc *ucom) 322184610Salfred{ 323184610Salfred struct ugensa_softc *sc = ucom->sc_parent; 324184610Salfred struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno; 325184610Salfred 326187259Sthompsa usb2_transfer_start(ssc->sc_xfer[UGENSA_BULK_DT_RD]); 327184610Salfred} 328184610Salfred 329184610Salfredstatic void 330184610Salfredugensa_stop_read(struct usb2_com_softc *ucom) 331184610Salfred{ 332184610Salfred struct ugensa_softc *sc = ucom->sc_parent; 333184610Salfred struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno; 334184610Salfred 335187259Sthompsa usb2_transfer_stop(ssc->sc_xfer[UGENSA_BULK_DT_RD]); 336184610Salfred} 337184610Salfred 338184610Salfredstatic void 339184610Salfredugensa_start_write(struct usb2_com_softc *ucom) 340184610Salfred{ 341184610Salfred struct ugensa_softc *sc = ucom->sc_parent; 342184610Salfred struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno; 343184610Salfred 344187259Sthompsa usb2_transfer_start(ssc->sc_xfer[UGENSA_BULK_DT_WR]); 345184610Salfred} 346184610Salfred 347184610Salfredstatic void 348184610Salfredugensa_stop_write(struct usb2_com_softc *ucom) 349184610Salfred{ 350184610Salfred struct ugensa_softc *sc = ucom->sc_parent; 351184610Salfred struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno; 352184610Salfred 353187259Sthompsa usb2_transfer_stop(ssc->sc_xfer[UGENSA_BULK_DT_WR]); 354184610Salfred} 355