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