/*- * Copyright (c) 2004 Bernd Walter * * $URL: https://devel.bwct.de/svn/projects/ubser/ubser.c $ * $Date: 2004-02-29 01:53:10 +0100 (Sun, 29 Feb 2004) $ * $Author: ticso $ * $Rev: 1127 $ */ /*- * Copyright (c) 2001-2002, Shunsuke Akiyama . * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ /*- * Copyright (c) 2000 The NetBSD Foundation, Inc. * All rights reserved. * * This code is derived from software contributed to The NetBSD Foundation * by Lennart Augustsson (lennart@augustsson.net). * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. All advertising materials mentioning features or use of this software * must display the following acknowledgement: * This product includes software developed by the NetBSD * Foundation, Inc. and its contributors. * 4. Neither the name of The NetBSD Foundation nor the names of its * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ #include __FBSDID("$FreeBSD: src/sys/dev/usb/ubser.c,v 1.30 2007/07/05 06:42:14 imp Exp $"); /* * BWCT serial adapter driver */ #include #include #include #include #include #include #include #include #include #include "usbdevs.h" #define UBSER_UNIT_MAX 32 /* Vendor Interface Requests */ #define VENDOR_GET_NUMSER 0x01 #define VENDOR_SET_BREAK 0x02 #define VENDOR_CLEAR_BREAK 0x03 #ifdef USB_DEBUG #define DPRINTF(sc,n,fmt,...) \ do { if (ubser_debug > (n)) { \ printf("%s:%s: " fmt, (sc)->sc_name, \ __FUNCTION__,## __VA_ARGS__); } } while (0) static int ubser_debug = 0; SYSCTL_NODE(_hw_usb, OID_AUTO, ubser, CTLFLAG_RW, 0, "USB ubser"); SYSCTL_INT(_hw_usb_ubser, OID_AUTO, debug, CTLFLAG_RW, &ubser_debug, 0, "ubser debug level"); #else #define DPRINTF(...) #endif #define UBSER_TR_DT_WRITE 0 #define UBSER_TR_DT_READ 1 #define UBSER_TR_CS_WRITE 2 #define UBSER_TR_CS_READ 3 #define UBSER_TR_MAX 4 struct ubser_softc { struct ucom_super_softc sc_super_ucom; struct ucom_softc sc_ucom[UBSER_UNIT_MAX]; struct usbd_xfer *sc_xfer[UBSER_TR_MAX]; struct usbd_device *sc_udev; uint16_t sc_tx_size; uint8_t sc_numser; uint8_t sc_flags; #define UBSER_FLAG_READ_STALL 0x01 #define UBSER_FLAG_WRITE_STALL 0x02 uint8_t sc_iface_no; uint8_t sc_iface_index; uint8_t sc_curr_tx_unit; uint8_t sc_name[16]; }; /* prototypes */ static device_probe_t ubser_probe; static device_attach_t ubser_attach; static device_detach_t ubser_detach; static usbd_callback_t ubser_write_clear_stall_callback; static usbd_callback_t ubser_write_callback; static usbd_callback_t ubser_read_clear_stall_callback; static usbd_callback_t ubser_read_callback; static int ubser_pre_param(struct ucom_softc *ucom, struct termios *t); static void ubser_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff); static void ubser_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr); static void ubser_start_read(struct ucom_softc *ucom); static void ubser_stop_read(struct ucom_softc *ucom); static void ubser_start_write(struct ucom_softc *ucom); static void ubser_stop_write(struct ucom_softc *ucom); static const struct usbd_config ubser_config[UBSER_TR_MAX] = { [UBSER_TR_DT_WRITE] = { .type = UE_BULK, .endpoint = UE_ADDR_ANY, .direction = UE_DIR_OUT, .mh.bufsize = 0, /* use wMaxPacketSize */ .mh.flags = {.pipe_bof = 1,.force_short_xfer = 1,}, .mh.callback = &ubser_write_callback, }, [UBSER_TR_DT_READ] = { .type = UE_BULK, .endpoint = UE_ADDR_ANY, .direction = UE_DIR_IN, .mh.bufsize = 0, /* use wMaxPacketSize */ .mh.flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, .mh.callback = &ubser_read_callback, }, [UBSER_TR_CS_WRITE] = { .type = UE_CONTROL, .endpoint = 0x00, /* Control pipe */ .direction = UE_DIR_ANY, .mh.bufsize = sizeof(usb_device_request_t), .mh.flags = {}, .mh.callback = &ubser_write_clear_stall_callback, .mh.timeout = 1000, /* 1 second */ .mh.interval = 50, /* 50ms */ }, [UBSER_TR_CS_READ] = { .type = UE_CONTROL, .endpoint = 0x00, /* Control pipe */ .direction = UE_DIR_ANY, .mh.bufsize = sizeof(usb_device_request_t), .mh.flags = {}, .mh.callback = &ubser_read_clear_stall_callback, .mh.timeout = 1000, /* 1 second */ .mh.interval = 50, /* 50ms */ }, }; static const struct ucom_callback ubser_callback = { .ucom_cfg_set_break = &ubser_cfg_set_break, .ucom_cfg_get_status = &ubser_cfg_get_status, .ucom_pre_param = &ubser_pre_param, .ucom_start_read = &ubser_start_read, .ucom_stop_read = &ubser_stop_read, .ucom_start_write = &ubser_start_write, .ucom_stop_write = &ubser_stop_write, }; static device_method_t ubser_methods[] = { DEVMETHOD(device_probe, ubser_probe), DEVMETHOD(device_attach, ubser_attach), DEVMETHOD(device_detach, ubser_detach), {0, 0} }; static devclass_t ubser_devclass; static driver_t ubser_driver = { .name = "ubser", .methods = ubser_methods, .size = sizeof(struct ubser_softc), }; DRIVER_MODULE(ubser, uhub, ubser_driver, ubser_devclass, usbd_driver_load, 0); MODULE_DEPEND(ubser, usb, 1, 1, 1); MODULE_DEPEND(ubser, ucom, UCOM_MINVER, UCOM_PREFVER, UCOM_MAXVER); static int ubser_probe(device_t dev) { struct usb_attach_arg *uaa = device_get_ivars(dev); usb_interface_descriptor_t *id; if (uaa->usb_mode != USB_MODE_HOST) { return (UMATCH_NONE); } if (uaa->iface == NULL) return (UMATCH_NONE); id = usbd_get_interface_descriptor(uaa->iface); if (id == NULL) { return (UMATCH_NONE); } /* check if this is a BWCT vendor specific ubser interface */ if ((strcmp(uaa->device->manufacturer, "BWCT") == 0) && (id->bInterfaceClass == 0xff) && (id->bInterfaceSubClass == 0x00)) return (UMATCH_VENDOR_IFACESUBCLASS); return (UMATCH_NONE); } static int ubser_attach(device_t dev) { struct usb_attach_arg *uaa = device_get_ivars(dev); struct ubser_softc *sc = device_get_softc(dev); usb_interface_descriptor_t *id; usb_device_request_t req; uint8_t n; int error; if (sc == NULL) { return (ENOMEM); } usbd_set_device_desc(dev); snprintf(sc->sc_name, sizeof(sc->sc_name), "%s", device_get_nameunit(dev)); id = usbd_get_interface_descriptor(uaa->iface); sc->sc_iface_no = id->bInterfaceNumber; sc->sc_iface_index = uaa->iface_index; sc->sc_udev = uaa->device; /* get number of serials */ req.bmRequestType = UT_READ_VENDOR_INTERFACE; req.bRequest = VENDOR_GET_NUMSER; USETW(req.wValue, 0); req.wIndex[0] = sc->sc_iface_no; req.wIndex[1] = 0; USETW(req.wLength, 1); error = usbd_do_request_flags (uaa->device, &Giant, &req, &sc->sc_numser, 0, NULL, USBD_DEFAULT_TIMEOUT); if (error || (sc->sc_numser == 0)) { device_printf(dev, "failed to get number " "of serial ports: %s\n", usbd_errstr(error)); goto detach; } if (sc->sc_numser > UBSER_UNIT_MAX) sc->sc_numser = UBSER_UNIT_MAX; device_printf(dev, "found %i serials\n", sc->sc_numser); error = usbd_transfer_setup(uaa->device, &(sc->sc_iface_index), sc->sc_xfer, ubser_config, UBSER_TR_MAX, sc, &Giant); if (error) { goto detach; } sc->sc_tx_size = sc->sc_xfer[UBSER_TR_DT_WRITE]->max_data_length; if (sc->sc_tx_size == 0) { DPRINTF(sc, -1, "invalid tx_size!\n"); goto detach; } /* initialize port numbers */ for (n = 0; n < sc->sc_numser; n++) { sc->sc_ucom[n].sc_portno = n; } error = ucom_attach(&(sc->sc_super_ucom), sc->sc_ucom, sc->sc_numser, sc, &ubser_callback, &Giant); if (error) { goto detach; } mtx_lock(&Giant); sc->sc_flags |= (UBSER_FLAG_READ_STALL | UBSER_FLAG_WRITE_STALL); usbd_transfer_start(sc->sc_xfer[UBSER_TR_DT_READ]); mtx_unlock(&Giant); return (0); /* success */ detach: ubser_detach(dev); return (ENXIO); /* failure */ } static int ubser_detach(device_t dev) { struct ubser_softc *sc = device_get_softc(dev); uint8_t n; DPRINTF(sc, 0, "\n"); ucom_detach(&(sc->sc_super_ucom), sc->sc_ucom, sc->sc_numser); /* * need to stop all transfers atomically, hence when clear stall * completes, it might start other transfers ! */ mtx_lock(&Giant); for (n = 0; n < UBSER_TR_MAX; n++) { usbd_transfer_stop(sc->sc_xfer[n]); } mtx_unlock(&Giant); usbd_transfer_unsetup(sc->sc_xfer, UBSER_TR_MAX); return (0); } static int ubser_pre_param(struct ucom_softc *ucom, struct termios *t) { struct ubser_softc *sc = ucom->sc_parent; DPRINTF(sc, 0, "\n"); /* * The firmware on our devices can only do 8n1@9600bps * without handshake. * We refuse to accept other configurations. */ /* ensure 9600bps */ switch (t->c_ospeed) { case 9600: break; default: return (EINVAL); } /* 2 stop bits not possible */ if (t->c_cflag & CSTOPB) return (EINVAL); /* XXX parity handling not possible with current firmware */ if (t->c_cflag & PARENB) return (EINVAL); /* we can only do 8 data bits */ switch (t->c_cflag & CSIZE) { case CS8: break; default: return (EINVAL); } /* we can't do any kind of hardware handshaking */ if ((t->c_cflag & (CRTS_IFLOW | CDTR_IFLOW | CDSR_OFLOW | CCAR_OFLOW)) != 0) return (EINVAL); /* * XXX xon/xoff not supported by the firmware! * This is handled within FreeBSD only and may overflow buffers * because of delayed reaction due to device buffering. */ return (0); } static __inline void ubser_inc_tx_unit(struct ubser_softc *sc) { sc->sc_curr_tx_unit++; if (sc->sc_curr_tx_unit >= sc->sc_numser) { sc->sc_curr_tx_unit = 0; } return; } static void ubser_write_clear_stall_callback(struct usbd_xfer *xfer) { struct ubser_softc *sc = xfer->priv_sc; struct usbd_xfer *xfer_other = sc->sc_xfer[UBSER_TR_DT_WRITE]; if (usbd_clear_stall_callback(xfer, xfer_other)) { DPRINTF(sc, 0, "stall cleared\n"); sc->sc_flags &= ~UBSER_FLAG_WRITE_STALL; usbd_transfer_start(xfer_other); } return; } static void ubser_write_callback(struct usbd_xfer *xfer) { struct ubser_softc *sc = xfer->priv_sc; uint8_t buf[1]; uint8_t first_unit = sc->sc_curr_tx_unit; uint32_t actlen; switch (USBD_GET_STATE(xfer)) { case USBD_ST_SETUP: case USBD_ST_TRANSFERRED: if (sc->sc_flags & UBSER_FLAG_WRITE_STALL) { usbd_transfer_start(sc->sc_xfer[UBSER_TR_CS_WRITE]); return; } do { if (ucom_get_data(sc->sc_ucom + sc->sc_curr_tx_unit, xfer->frbuffers, 1, sc->sc_tx_size - 1, &actlen)) { buf[0] = sc->sc_curr_tx_unit; usbd_copy_in(xfer->frbuffers, 0, buf, 1); xfer->frlengths[0] = actlen + 1; usbd_start_hardware(xfer); ubser_inc_tx_unit(sc); /* round robin */ break; } ubser_inc_tx_unit(sc); } while (sc->sc_curr_tx_unit != first_unit); return; default: /* Error */ if (xfer->error != USBD_ERR_CANCELLED) { sc->sc_flags |= UBSER_FLAG_WRITE_STALL; usbd_transfer_start(sc->sc_xfer[UBSER_TR_CS_WRITE]); } return; } } static void ubser_read_clear_stall_callback(struct usbd_xfer *xfer) { struct ubser_softc *sc = xfer->priv_sc; struct usbd_xfer *xfer_other = sc->sc_xfer[UBSER_TR_DT_READ]; if (usbd_clear_stall_callback(xfer, xfer_other)) { DPRINTF(sc, 0, "stall cleared\n"); sc->sc_flags &= ~UBSER_FLAG_READ_STALL; usbd_transfer_start(xfer_other); } return; } static void ubser_read_callback(struct usbd_xfer *xfer) { struct ubser_softc *sc = xfer->priv_sc; uint8_t buf[1]; switch (USBD_GET_STATE(xfer)) { case USBD_ST_TRANSFERRED: if (xfer->actlen < 1) { DPRINTF(sc, 0, "invalid actlen=0!\n"); goto tr_setup; } usbd_copy_out(xfer->frbuffers, 0, buf, 1); if (buf[0] >= sc->sc_numser) { DPRINTF(sc, 0, "invalid serial number!\n"); goto tr_setup; } ucom_put_data(sc->sc_ucom + buf[0], xfer->frbuffers, 1, xfer->actlen - 1); case USBD_ST_SETUP: tr_setup: if (sc->sc_flags & UBSER_FLAG_READ_STALL) { usbd_transfer_start(sc->sc_xfer[UBSER_TR_CS_READ]); } else { xfer->frlengths[0] = xfer->max_data_length; usbd_start_hardware(xfer); } return; default: /* Error */ if (xfer->error != USBD_ERR_CANCELLED) { sc->sc_flags |= UBSER_FLAG_READ_STALL; usbd_transfer_start(sc->sc_xfer[UBSER_TR_CS_READ]); } return; } } static void ubser_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff) { struct ubser_softc *sc = ucom->sc_parent; uint8_t x = ucom->sc_portno; usb_device_request_t req; usbd_status_t err; if (onoff) { req.bmRequestType = UT_READ_VENDOR_INTERFACE; req.bRequest = VENDOR_SET_BREAK; req.wValue[0] = x; req.wValue[1] = 0; req.wIndex[0] = sc->sc_iface_no; req.wIndex[1] = 0; USETW(req.wLength, 0); err = usbd_do_request_flags (sc->sc_udev, &Giant, &req, NULL, 0, NULL, 1000); if (err) { DPRINTF(sc, -1, "send break failed, error=%s\n", usbd_errstr(err)); } } return; } static void ubser_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr) { /* fake status bits */ *lsr = 0; *msr = SER_DCD; return; } static void ubser_start_read(struct ucom_softc *ucom) { struct ubser_softc *sc = ucom->sc_parent; usbd_transfer_start(sc->sc_xfer[UBSER_TR_DT_READ]); return; } static void ubser_stop_read(struct ucom_softc *ucom) { struct ubser_softc *sc = ucom->sc_parent; usbd_transfer_stop(sc->sc_xfer[UBSER_TR_CS_READ]); usbd_transfer_stop(sc->sc_xfer[UBSER_TR_DT_READ]); return; } static void ubser_start_write(struct ucom_softc *ucom) { struct ubser_softc *sc = ucom->sc_parent; usbd_transfer_start(sc->sc_xfer[UBSER_TR_DT_WRITE]); return; } static void ubser_stop_write(struct ucom_softc *ucom) { struct ubser_softc *sc = ucom->sc_parent; usbd_transfer_stop(sc->sc_xfer[UBSER_TR_CS_WRITE]); usbd_transfer_stop(sc->sc_xfer[UBSER_TR_DT_WRITE]); return; }