1 /* $FreeBSD$ */ 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 72 enum { 73 UGENSA_BULK_DT_WR, 74 UGENSA_BULK_DT_RD, 75 UGENSA_N_TRANSFER, 76 }; 77 78 struct ugensa_sub_softc { 79 struct ucom_softc *sc_ucom_ptr; 80 struct usb_xfer *sc_xfer[UGENSA_N_TRANSFER]; 81 }; 82 83 struct 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 94 static device_probe_t ugensa_probe; 95 static device_attach_t ugensa_attach; 96 static device_detach_t ugensa_detach; 97 98 static usb_callback_t ugensa_bulk_write_callback; 99 static usb_callback_t ugensa_bulk_read_callback; 100 101 static void ugensa_start_read(struct ucom_softc *); 102 static void ugensa_stop_read(struct ucom_softc *); 103 static void ugensa_start_write(struct ucom_softc *); 104 static void ugensa_stop_write(struct ucom_softc *); 105 static void ugensa_poll(struct ucom_softc *ucom); 106 107 static const struct usb_config ugensa_xfer_config[UGENSA_N_TRANSFER] = { 108 109 [UGENSA_BULK_DT_WR] = { 110 .type = UE_BULK, 111 .endpoint = UE_ADDR_ANY, 112 .direction = UE_DIR_OUT, 113 .bufsize = UGENSA_BUF_SIZE, 114 .flags = {.pipe_bof = 1,.force_short_xfer = 1,}, 115 .callback = &ugensa_bulk_write_callback, 116 }, 117 118 [UGENSA_BULK_DT_RD] = { 119 .type = UE_BULK, 120 .endpoint = UE_ADDR_ANY, 121 .direction = UE_DIR_IN, 122 .bufsize = UGENSA_BUF_SIZE, 123 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 124 .callback = &ugensa_bulk_read_callback, 125 }, 126 }; 127 128 static const struct ucom_callback ugensa_callback = { 129 .ucom_start_read = &ugensa_start_read, 130 .ucom_stop_read = &ugensa_stop_read, 131 .ucom_start_write = &ugensa_start_write, 132 .ucom_stop_write = &ugensa_stop_write, 133 .ucom_poll = &ugensa_poll, 134 }; 135 136 static device_method_t ugensa_methods[] = { 137 /* Device methods */ 138 DEVMETHOD(device_probe, ugensa_probe), 139 DEVMETHOD(device_attach, ugensa_attach), 140 DEVMETHOD(device_detach, ugensa_detach), 141 {0, 0} 142 }; 143 144 static devclass_t ugensa_devclass; 145 146 static driver_t ugensa_driver = { 147 .name = "ugensa", 148 .methods = ugensa_methods, 149 .size = sizeof(struct ugensa_softc), 150 }; 151 152 DRIVER_MODULE(ugensa, uhub, ugensa_driver, ugensa_devclass, NULL, 0); 153 MODULE_DEPEND(ugensa, ucom, 1, 1, 1); 154 MODULE_DEPEND(ugensa, usb, 1, 1, 1); 155 MODULE_VERSION(ugensa, 1); 156 157 static const struct usb_device_id ugensa_devs[] = { 158 {USB_VPI(USB_VENDOR_AIRPRIME, USB_PRODUCT_AIRPRIME_PC5220, 0)}, 159 {USB_VPI(USB_VENDOR_CMOTECH, USB_PRODUCT_CMOTECH_CDMA_MODEM1, 0)}, 160 {USB_VPI(USB_VENDOR_KYOCERA2, USB_PRODUCT_KYOCERA2_CDMA_MSM_K, 0)}, 161 {USB_VPI(USB_VENDOR_HP, USB_PRODUCT_HP_49GPLUS, 0)}, 162 {USB_VPI(USB_VENDOR_NOVATEL2, USB_PRODUCT_NOVATEL2_FLEXPACKGPS, 0)}, 163 }; 164 165 static int 166 ugensa_probe(device_t dev) 167 { 168 struct usb_attach_arg *uaa = device_get_ivars(dev); 169 170 if (uaa->usb_mode != USB_MODE_HOST) { 171 return (ENXIO); 172 } 173 if (uaa->info.bConfigIndex != UGENSA_CONFIG_INDEX) { 174 return (ENXIO); 175 } 176 if (uaa->info.bIfaceIndex != 0) { 177 return (ENXIO); 178 } 179 return (usbd_lookup_id_by_uaa(ugensa_devs, sizeof(ugensa_devs), uaa)); 180 } 181 182 static int 183 ugensa_attach(device_t dev) 184 { 185 struct usb_attach_arg *uaa = device_get_ivars(dev); 186 struct ugensa_softc *sc = device_get_softc(dev); 187 struct ugensa_sub_softc *ssc; 188 struct usb_interface *iface; 189 int32_t error; 190 uint8_t iface_index; 191 int x, cnt; 192 193 device_set_usb_desc(dev); 194 mtx_init(&sc->sc_mtx, "ugensa", NULL, MTX_DEF); 195 196 /* Figure out how many interfaces this device has got */ 197 for (cnt = 0; cnt < UGENSA_IFACE_MAX; cnt++) { 198 if ((usbd_get_endpoint(uaa->device, cnt, ugensa_xfer_config + 0) == NULL) || 199 (usbd_get_endpoint(uaa->device, cnt, ugensa_xfer_config + 1) == NULL)) { 200 /* we have reached the end */ 201 break; 202 } 203 } 204 205 if (cnt == 0) { 206 device_printf(dev, "No interfaces\n"); 207 goto detach; 208 } 209 for (x = 0; x < cnt; x++) { 210 iface = usbd_get_iface(uaa->device, x); 211 if (iface->idesc->bInterfaceClass != UICLASS_VENDOR) 212 /* Not a serial port, most likely a SD reader */ 213 continue; 214 215 ssc = sc->sc_sub + sc->sc_niface; 216 ssc->sc_ucom_ptr = sc->sc_ucom + sc->sc_niface; 217 218 iface_index = (UGENSA_IFACE_INDEX + x); 219 error = usbd_transfer_setup(uaa->device, 220 &iface_index, ssc->sc_xfer, ugensa_xfer_config, 221 UGENSA_N_TRANSFER, ssc, &sc->sc_mtx); 222 223 if (error) { 224 device_printf(dev, "allocating USB " 225 "transfers failed\n"); 226 goto detach; 227 } 228 /* clear stall at first run */ 229 mtx_lock(&sc->sc_mtx); 230 usbd_xfer_set_stall(ssc->sc_xfer[UGENSA_BULK_DT_WR]); 231 usbd_xfer_set_stall(ssc->sc_xfer[UGENSA_BULK_DT_RD]); 232 mtx_unlock(&sc->sc_mtx); 233 234 /* initialize port number */ 235 ssc->sc_ucom_ptr->sc_portno = sc->sc_niface; 236 sc->sc_niface++; 237 if (x != uaa->info.bIfaceIndex) 238 usbd_set_parent_iface(uaa->device, x, 239 uaa->info.bIfaceIndex); 240 } 241 device_printf(dev, "Found %d interfaces.\n", sc->sc_niface); 242 243 error = ucom_attach(&sc->sc_super_ucom, sc->sc_ucom, sc->sc_niface, sc, 244 &ugensa_callback, &sc->sc_mtx); 245 if (error) { 246 DPRINTF("attach failed\n"); 247 goto detach; 248 } 249 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev); 250 251 return (0); /* success */ 252 253 detach: 254 ugensa_detach(dev); 255 return (ENXIO); /* failure */ 256 } 257 258 static int 259 ugensa_detach(device_t dev) 260 { 261 struct ugensa_softc *sc = device_get_softc(dev); 262 uint8_t x; 263 264 ucom_detach(&sc->sc_super_ucom, sc->sc_ucom); 265 266 for (x = 0; x < sc->sc_niface; x++) { 267 usbd_transfer_unsetup(sc->sc_sub[x].sc_xfer, UGENSA_N_TRANSFER); 268 } 269 mtx_destroy(&sc->sc_mtx); 270 271 return (0); 272 } 273 274 static void 275 ugensa_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error) 276 { 277 struct ugensa_sub_softc *ssc = usbd_xfer_softc(xfer); 278 struct usb_page_cache *pc; 279 uint32_t actlen; 280 281 switch (USB_GET_STATE(xfer)) { 282 case USB_ST_SETUP: 283 case USB_ST_TRANSFERRED: 284 tr_setup: 285 pc = usbd_xfer_get_frame(xfer, 0); 286 if (ucom_get_data(ssc->sc_ucom_ptr, pc, 0, 287 UGENSA_BUF_SIZE, &actlen)) { 288 usbd_xfer_set_frame_len(xfer, 0, actlen); 289 usbd_transfer_submit(xfer); 290 } 291 return; 292 293 default: /* Error */ 294 if (error != USB_ERR_CANCELLED) { 295 /* try to clear stall first */ 296 usbd_xfer_set_stall(xfer); 297 goto tr_setup; 298 } 299 return; 300 } 301 } 302 303 static void 304 ugensa_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error) 305 { 306 struct ugensa_sub_softc *ssc = usbd_xfer_softc(xfer); 307 struct usb_page_cache *pc; 308 int actlen; 309 310 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 311 312 switch (USB_GET_STATE(xfer)) { 313 case USB_ST_TRANSFERRED: 314 pc = usbd_xfer_get_frame(xfer, 0); 315 ucom_put_data(ssc->sc_ucom_ptr, pc, 0, actlen); 316 317 case USB_ST_SETUP: 318 tr_setup: 319 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 320 usbd_transfer_submit(xfer); 321 return; 322 323 default: /* Error */ 324 if (error != USB_ERR_CANCELLED) { 325 /* try to clear stall first */ 326 usbd_xfer_set_stall(xfer); 327 goto tr_setup; 328 } 329 return; 330 } 331 } 332 333 static void 334 ugensa_start_read(struct ucom_softc *ucom) 335 { 336 struct ugensa_softc *sc = ucom->sc_parent; 337 struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno; 338 339 usbd_transfer_start(ssc->sc_xfer[UGENSA_BULK_DT_RD]); 340 } 341 342 static void 343 ugensa_stop_read(struct ucom_softc *ucom) 344 { 345 struct ugensa_softc *sc = ucom->sc_parent; 346 struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno; 347 348 usbd_transfer_stop(ssc->sc_xfer[UGENSA_BULK_DT_RD]); 349 } 350 351 static void 352 ugensa_start_write(struct ucom_softc *ucom) 353 { 354 struct ugensa_softc *sc = ucom->sc_parent; 355 struct ugensa_sub_softc *ssc = sc->sc_sub + ucom->sc_portno; 356 357 usbd_transfer_start(ssc->sc_xfer[UGENSA_BULK_DT_WR]); 358 } 359 360 static void 361 ugensa_stop_write(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_stop(ssc->sc_xfer[UGENSA_BULK_DT_WR]); 367 } 368 369 static void 370 ugensa_poll(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_poll(ssc->sc_xfer, UGENSA_N_TRANSFER); 376 } 377