1/* $FreeBSD: stable/11/sys/dev/usb/serial/ugensa.c 366877 2020-10-20 08:15:12Z hselasky $ */ 2/* $NetBSD: ugensa.c,v 1.9.2.1 2007/03/24 14:55:50 yamt Exp $ */ 3 4/* 5 * Copyright (c) 2004, 2005 The NetBSD Foundation, Inc. 6 * All rights reserved. 7 * 8 * This code is derived from software contributed to The NetBSD Foundation 9 * by Roland C. Dowdeswell <elric@netbsd.org>. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33/* 34 * NOTE: all function names beginning like "ugensa_cfg_" can only 35 * be called from within the config thread function ! 36 */ 37 38#include <sys/stdint.h> 39#include <sys/stddef.h> 40#include <sys/param.h> 41#include <sys/queue.h> 42#include <sys/types.h> 43#include <sys/systm.h> 44#include <sys/kernel.h> 45#include <sys/bus.h> 46#include <sys/module.h> 47#include <sys/lock.h> 48#include <sys/mutex.h> 49#include <sys/condvar.h> 50#include <sys/sysctl.h> 51#include <sys/sx.h> 52#include <sys/unistd.h> 53#include <sys/callout.h> 54#include <sys/malloc.h> 55#include <sys/priv.h> 56 57#include <dev/usb/usb.h> 58#include <dev/usb/usbdi.h> 59#include "usbdevs.h" 60 61#define USB_DEBUG_VAR usb_debug 62#include <dev/usb/usb_debug.h> 63#include <dev/usb/usb_process.h> 64 65#include <dev/usb/serial/usb_serial.h> 66 67#define UGENSA_BUF_SIZE 2048 /* bytes */ 68#define UGENSA_CONFIG_INDEX 0 69#define UGENSA_IFACE_INDEX 0 70#define UGENSA_IFACE_MAX 8 /* exclusivly */ 71 72enum { 73 UGENSA_BULK_DT_WR, 74 UGENSA_BULK_DT_RD, 75 UGENSA_N_TRANSFER, 76}; 77 78struct ugensa_sub_softc { 79 struct ucom_softc *sc_ucom_ptr; 80 struct usb_xfer *sc_xfer[UGENSA_N_TRANSFER]; 81}; 82 83struct ugensa_softc { 84 struct ucom_super_softc sc_super_ucom; 85 struct ucom_softc sc_ucom[UGENSA_IFACE_MAX]; 86 struct ugensa_sub_softc sc_sub[UGENSA_IFACE_MAX]; 87 88 struct mtx sc_mtx; 89 uint8_t sc_niface; 90}; 91 92/* prototypes */ 93 94static device_probe_t ugensa_probe; 95static device_attach_t ugensa_attach; 96static device_detach_t ugensa_detach; 97static void ugensa_free_softc(struct ugensa_softc *); 98 99static usb_callback_t ugensa_bulk_write_callback; 100static usb_callback_t ugensa_bulk_read_callback; 101 102static void ugensa_free(struct ucom_softc *); 103static void ugensa_start_read(struct ucom_softc *); 104static void ugensa_stop_read(struct ucom_softc *); 105static void ugensa_start_write(struct ucom_softc *); 106static void ugensa_stop_write(struct ucom_softc *); 107static void ugensa_poll(struct ucom_softc *ucom); 108 109static const struct usb_config ugensa_xfer_config[UGENSA_N_TRANSFER] = { 110 111 [UGENSA_BULK_DT_WR] = { 112 .type = UE_BULK, 113 .endpoint = UE_ADDR_ANY, 114 .direction = UE_DIR_OUT, 115 .bufsize = UGENSA_BUF_SIZE, 116 .flags = {.pipe_bof = 1,.force_short_xfer = 1,}, 117 .callback = &ugensa_bulk_write_callback, 118 }, 119 120 [UGENSA_BULK_DT_RD] = { 121 .type = UE_BULK, 122 .endpoint = UE_ADDR_ANY, 123 .direction = UE_DIR_IN, 124 .bufsize = UGENSA_BUF_SIZE, 125 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 126 .callback = &ugensa_bulk_read_callback, 127 }, 128}; 129 130static const struct ucom_callback ugensa_callback = { 131 .ucom_start_read = &ugensa_start_read, 132 .ucom_stop_read = &ugensa_stop_read, 133 .ucom_start_write = &ugensa_start_write, 134 .ucom_stop_write = &ugensa_stop_write, 135 .ucom_poll = &ugensa_poll, 136 .ucom_free = &ugensa_free, 137}; 138 139static device_method_t ugensa_methods[] = { 140 /* Device methods */ 141 DEVMETHOD(device_probe, ugensa_probe), 142 DEVMETHOD(device_attach, ugensa_attach), 143 DEVMETHOD(device_detach, ugensa_detach), 144 DEVMETHOD_END 145}; 146 147static devclass_t ugensa_devclass; 148 149static driver_t ugensa_driver = { 150 .name = "ugensa", 151 .methods = ugensa_methods, 152 .size = sizeof(struct ugensa_softc), 153}; 154 155static const STRUCT_USB_HOST_ID ugensa_devs[] = { 156 {USB_VPI(USB_VENDOR_AIRPRIME, USB_PRODUCT_AIRPRIME_PC5220, 0)}, 157 {USB_VPI(USB_VENDOR_CMOTECH, USB_PRODUCT_CMOTECH_CDMA_MODEM1, 0)}, 158 {USB_VPI(USB_VENDOR_KYOCERA2, USB_PRODUCT_KYOCERA2_CDMA_MSM_K, 0)}, 159 {USB_VPI(USB_VENDOR_HP, USB_PRODUCT_HP_49GPLUS, 0)}, 160 {USB_VPI(USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_FLEXPACKGPS, 0)}, 161 {USB_VENDOR(USB_VENDOR_GOOGLE), USB_IFACE_CLASS(UICLASS_VENDOR), 162 USB_IFACE_SUBCLASS(0x50), USB_IFACE_PROTOCOL(0x01), USB_DRIVER_INFO(10)}, 163}; 164 165DRIVER_MODULE(ugensa, uhub, ugensa_driver, ugensa_devclass, NULL, 0); 166MODULE_DEPEND(ugensa, ucom, 1, 1, 1); 167MODULE_DEPEND(ugensa, usb, 1, 1, 1); 168MODULE_VERSION(ugensa, 1); 169USB_PNP_HOST_INFO(ugensa_devs); 170 171static int 172ugensa_probe(device_t dev) 173{ 174 struct usb_attach_arg *uaa = device_get_ivars(dev); 175 176 if (uaa->usb_mode != USB_MODE_HOST) { 177 return (ENXIO); 178 } 179 if (uaa->info.bConfigIndex != UGENSA_CONFIG_INDEX) { 180 return (ENXIO); 181 } 182 if (uaa->info.bIfaceIndex != 0) { 183 return (ENXIO); 184 } 185 return (usbd_lookup_id_by_uaa(ugensa_devs, sizeof(ugensa_devs), uaa)); 186} 187 188static int 189ugensa_attach(device_t dev) 190{ 191 struct usb_attach_arg *uaa = device_get_ivars(dev); 192 struct ugensa_softc *sc = device_get_softc(dev); 193 struct ugensa_sub_softc *ssc; 194 struct usb_interface *iface; 195 int32_t error; 196 uint8_t iface_index; 197 int x, cnt; 198 199 device_set_usb_desc(dev); 200 mtx_init(&sc->sc_mtx, "ugensa", NULL, MTX_DEF); 201 ucom_ref(&sc->sc_super_ucom); 202 203 /* Figure out how many interfaces this device has got */ 204 for (cnt = 0; cnt < UGENSA_IFACE_MAX; cnt++) { 205 if ((usbd_get_endpoint(uaa->device, cnt, ugensa_xfer_config + 0) == NULL) || 206 (usbd_get_endpoint(uaa->device, cnt, ugensa_xfer_config + 1) == NULL)) { 207 /* we have reached the end */ 208 break; 209 } 210 } 211 212 if (cnt == 0) { 213 device_printf(dev, "No interfaces\n"); 214 goto detach; 215 } 216 for (x = 0; x < cnt; x++) { 217 iface = usbd_get_iface(uaa->device, x); 218 if (iface->idesc->bInterfaceClass != UICLASS_VENDOR) 219 /* Not a serial port, most likely a SD reader */ 220 continue; 221 222 ssc = sc->sc_sub + sc->sc_niface; 223 ssc->sc_ucom_ptr = sc->sc_ucom + sc->sc_niface; 224 225 iface_index = (UGENSA_IFACE_INDEX + x); 226 error = usbd_transfer_setup(uaa->device, 227 &iface_index, ssc->sc_xfer, ugensa_xfer_config, 228 UGENSA_N_TRANSFER, ssc, &sc->sc_mtx); 229 230 if (error) { 231 device_printf(dev, "allocating USB " 232 "transfers failed\n"); 233 goto detach; 234 } 235 /* clear stall at first run */ 236 mtx_lock(&sc->sc_mtx); 237 usbd_xfer_set_stall(ssc->sc_xfer[UGENSA_BULK_DT_WR]); 238 usbd_xfer_set_stall(ssc->sc_xfer[UGENSA_BULK_DT_RD]); 239 mtx_unlock(&sc->sc_mtx); 240 241 /* initialize port number */ 242 ssc->sc_ucom_ptr->sc_portno = sc->sc_niface; 243 sc->sc_niface++; 244 if (x != uaa->info.bIfaceIndex) 245 usbd_set_parent_iface(uaa->device, x, 246 uaa->info.bIfaceIndex); 247 } 248 device_printf(dev, "Found %d interfaces.\n", sc->sc_niface); 249 250 error = ucom_attach(&sc->sc_super_ucom, sc->sc_ucom, sc->sc_niface, sc, 251 &ugensa_callback, &sc->sc_mtx); 252 if (error) { 253 DPRINTF("attach failed\n"); 254 goto detach; 255 } 256 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev); 257 258 return (0); /* success */ 259 260detach: 261 ugensa_detach(dev); 262 return (ENXIO); /* failure */ 263} 264 265static int 266ugensa_detach(device_t dev) 267{ 268 struct ugensa_softc *sc = device_get_softc(dev); 269 uint8_t x; 270 271 ucom_detach(&sc->sc_super_ucom, sc->sc_ucom); 272 273 for (x = 0; x < sc->sc_niface; x++) { 274 usbd_transfer_unsetup(sc->sc_sub[x].sc_xfer, UGENSA_N_TRANSFER); 275 } 276 277 device_claim_softc(dev); 278 279 ugensa_free_softc(sc); 280 281 return (0); 282} 283 284UCOM_UNLOAD_DRAIN(ugensa); 285 286static void 287ugensa_free_softc(struct ugensa_softc *sc) 288{ 289 if (ucom_unref(&sc->sc_super_ucom)) { 290 mtx_destroy(&sc->sc_mtx); 291 device_free_softc(sc); 292 } 293} 294 295static void 296ugensa_free(struct ucom_softc *ucom) 297{ 298 ugensa_free_softc(ucom->sc_parent); 299} 300 301static void 302ugensa_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error) 303{ 304 struct ugensa_sub_softc *ssc = usbd_xfer_softc(xfer); 305 struct usb_page_cache *pc; 306 uint32_t actlen; 307 308 switch (USB_GET_STATE(xfer)) { 309 case USB_ST_SETUP: 310 case USB_ST_TRANSFERRED: 311tr_setup: 312 pc = usbd_xfer_get_frame(xfer, 0); 313 if (ucom_get_data(ssc->sc_ucom_ptr, pc, 0, 314 UGENSA_BUF_SIZE, &actlen)) { 315 usbd_xfer_set_frame_len(xfer, 0, actlen); 316 usbd_transfer_submit(xfer); 317 } 318 return; 319 320 default: /* Error */ 321 if (error != USB_ERR_CANCELLED) { 322 /* try to clear stall first */ 323 usbd_xfer_set_stall(xfer); 324 goto tr_setup; 325 } 326 return; 327 } 328} 329 330static void 331ugensa_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error) 332{ 333 struct ugensa_sub_softc *ssc = usbd_xfer_softc(xfer); 334 struct usb_page_cache *pc; 335 int actlen; 336 337 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 338 339 switch (USB_GET_STATE(xfer)) { 340 case USB_ST_TRANSFERRED: 341 pc = usbd_xfer_get_frame(xfer, 0); 342 ucom_put_data(ssc->sc_ucom_ptr, pc, 0, actlen); 343 344 case USB_ST_SETUP: 345tr_setup: 346 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 347 usbd_transfer_submit(xfer); 348 return; 349 350 default: /* Error */ 351 if (error != USB_ERR_CANCELLED) { 352 /* try to clear stall first */ 353 usbd_xfer_set_stall(xfer); 354 goto tr_setup; 355 } 356 return; 357 } 358} 359 360static void 361ugensa_start_read(struct ucom_softc *ucom) 362{ 363 struct ugensa_softc *sc = ucom->sc_parent; 364 struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno; 365 366 usbd_transfer_start(ssc->sc_xfer[UGENSA_BULK_DT_RD]); 367} 368 369static void 370ugensa_stop_read(struct ucom_softc *ucom) 371{ 372 struct ugensa_softc *sc = ucom->sc_parent; 373 struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno; 374 375 usbd_transfer_stop(ssc->sc_xfer[UGENSA_BULK_DT_RD]); 376} 377 378static void 379ugensa_start_write(struct ucom_softc *ucom) 380{ 381 struct ugensa_softc *sc = ucom->sc_parent; 382 struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno; 383 384 usbd_transfer_start(ssc->sc_xfer[UGENSA_BULK_DT_WR]); 385} 386 387static void 388ugensa_stop_write(struct ucom_softc *ucom) 389{ 390 struct ugensa_softc *sc = ucom->sc_parent; 391 struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno; 392 393 usbd_transfer_stop(ssc->sc_xfer[UGENSA_BULK_DT_WR]); 394} 395 396static void 397ugensa_poll(struct ucom_softc *ucom) 398{ 399 struct ugensa_softc *sc = ucom->sc_parent; 400 struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno; 401 402 usbd_transfer_poll(ssc->sc_xfer, UGENSA_N_TRANSFER); 403} 404