102ac6454SAndrew Thompson #include <sys/cdefs.h> 202ac6454SAndrew Thompson __FBSDID("$FreeBSD$"); 302ac6454SAndrew Thompson 402ac6454SAndrew Thompson /*- 502ac6454SAndrew Thompson * Copyright (c) 2003 Scott Long 602ac6454SAndrew Thompson * All rights reserved. 702ac6454SAndrew Thompson * 802ac6454SAndrew Thompson * Redistribution and use in source and binary forms, with or without 902ac6454SAndrew Thompson * modification, are permitted provided that the following conditions 1002ac6454SAndrew Thompson * are met: 1102ac6454SAndrew Thompson * 1. Redistributions of source code must retain the above copyright 1202ac6454SAndrew Thompson * notice, this list of conditions and the following disclaimer. 1302ac6454SAndrew Thompson * 2. Redistributions in binary form must reproduce the above copyright 1402ac6454SAndrew Thompson * notice, this list of conditions and the following disclaimer in the 1502ac6454SAndrew Thompson * documentation and/or other materials provided with the distribution. 1602ac6454SAndrew Thompson * 1702ac6454SAndrew Thompson * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1802ac6454SAndrew Thompson * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1902ac6454SAndrew Thompson * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2002ac6454SAndrew Thompson * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 2102ac6454SAndrew Thompson * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2202ac6454SAndrew Thompson * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2302ac6454SAndrew Thompson * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2402ac6454SAndrew Thompson * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2502ac6454SAndrew Thompson * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2602ac6454SAndrew Thompson * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2702ac6454SAndrew Thompson * SUCH DAMAGE. 2802ac6454SAndrew Thompson * 2902ac6454SAndrew Thompson */ 3002ac6454SAndrew Thompson 3102ac6454SAndrew Thompson /* 3202ac6454SAndrew Thompson * Driver for the MCT (Magic Control Technology) USB-RS232 Converter. 3302ac6454SAndrew Thompson * Based on the superb documentation from the linux mct_u232 driver by 3402ac6454SAndrew Thompson * Wolfgang Grandeggar <wolfgang@cec.ch>. 3502ac6454SAndrew Thompson * This device smells a lot like the Belkin F5U103, except that it has 3602ac6454SAndrew Thompson * suffered some mild brain-damage. This driver is based off of the ubsa.c 375d38a4d4SEd Schouten * driver from Alexander Kabaev <kan@FreeBSD.org>. Merging the two together 3802ac6454SAndrew Thompson * might be useful, though the subtle differences might lead to lots of 3902ac6454SAndrew Thompson * #ifdef's. 4002ac6454SAndrew Thompson */ 4102ac6454SAndrew Thompson 4202ac6454SAndrew Thompson /* 4302ac6454SAndrew Thompson * NOTE: all function names beginning like "umct_cfg_" can only 4402ac6454SAndrew Thompson * be called from within the config thread function ! 4502ac6454SAndrew Thompson */ 4602ac6454SAndrew Thompson 47ed6d949aSAndrew Thompson #include <sys/stdint.h> 48ed6d949aSAndrew Thompson #include <sys/stddef.h> 49ed6d949aSAndrew Thompson #include <sys/param.h> 50ed6d949aSAndrew Thompson #include <sys/queue.h> 51ed6d949aSAndrew Thompson #include <sys/types.h> 52ed6d949aSAndrew Thompson #include <sys/systm.h> 53ed6d949aSAndrew Thompson #include <sys/kernel.h> 54ed6d949aSAndrew Thompson #include <sys/bus.h> 55ed6d949aSAndrew Thompson #include <sys/module.h> 56ed6d949aSAndrew Thompson #include <sys/lock.h> 57ed6d949aSAndrew Thompson #include <sys/mutex.h> 58ed6d949aSAndrew Thompson #include <sys/condvar.h> 59ed6d949aSAndrew Thompson #include <sys/sysctl.h> 60ed6d949aSAndrew Thompson #include <sys/sx.h> 61ed6d949aSAndrew Thompson #include <sys/unistd.h> 62ed6d949aSAndrew Thompson #include <sys/callout.h> 63ed6d949aSAndrew Thompson #include <sys/malloc.h> 64ed6d949aSAndrew Thompson #include <sys/priv.h> 65ed6d949aSAndrew Thompson 6602ac6454SAndrew Thompson #include <dev/usb/usb.h> 67ed6d949aSAndrew Thompson #include <dev/usb/usbdi.h> 68ed6d949aSAndrew Thompson #include <dev/usb/usbdi_util.h> 69ed6d949aSAndrew Thompson #include "usbdevs.h" 7002ac6454SAndrew Thompson 71a593f6b8SAndrew Thompson #define USB_DEBUG_VAR usb_debug 7202ac6454SAndrew Thompson #include <dev/usb/usb_debug.h> 7302ac6454SAndrew Thompson #include <dev/usb/usb_process.h> 7402ac6454SAndrew Thompson 7502ac6454SAndrew Thompson #include <dev/usb/serial/usb_serial.h> 7602ac6454SAndrew Thompson 7702ac6454SAndrew Thompson /* The UMCT advertises the standard 8250 UART registers */ 7802ac6454SAndrew Thompson #define UMCT_GET_MSR 2 /* Get Modem Status Register */ 7902ac6454SAndrew Thompson #define UMCT_GET_MSR_SIZE 1 8002ac6454SAndrew Thompson #define UMCT_GET_LCR 6 /* Get Line Control Register */ 8102ac6454SAndrew Thompson #define UMCT_GET_LCR_SIZE 1 8202ac6454SAndrew Thompson #define UMCT_SET_BAUD 5 /* Set the Baud Rate Divisor */ 8302ac6454SAndrew Thompson #define UMCT_SET_BAUD_SIZE 4 8402ac6454SAndrew Thompson #define UMCT_SET_LCR 7 /* Set Line Control Register */ 8502ac6454SAndrew Thompson #define UMCT_SET_LCR_SIZE 1 8602ac6454SAndrew Thompson #define UMCT_SET_MCR 10 /* Set Modem Control Register */ 8702ac6454SAndrew Thompson #define UMCT_SET_MCR_SIZE 1 8802ac6454SAndrew Thompson 89*d88e7bb0SIan Lepore #define UMCT_MSR_CTS_CHG 0x01 90*d88e7bb0SIan Lepore #define UMCT_MSR_DSR_CHG 0x02 91*d88e7bb0SIan Lepore #define UMCT_MSR_RI_CHG 0x04 92*d88e7bb0SIan Lepore #define UMCT_MSR_CD_CHG 0x08 93*d88e7bb0SIan Lepore #define UMCT_MSR_CTS 0x10 94*d88e7bb0SIan Lepore #define UMCT_MSR_RTS 0x20 95*d88e7bb0SIan Lepore #define UMCT_MSR_RI 0x40 96*d88e7bb0SIan Lepore #define UMCT_MSR_CD 0x80 97*d88e7bb0SIan Lepore 9802ac6454SAndrew Thompson #define UMCT_INTR_INTERVAL 100 9902ac6454SAndrew Thompson #define UMCT_IFACE_INDEX 0 100774651eeSAndrew Thompson #define UMCT_CONFIG_INDEX 0 10102ac6454SAndrew Thompson 10202ac6454SAndrew Thompson enum { 10302ac6454SAndrew Thompson UMCT_BULK_DT_WR, 10402ac6454SAndrew Thompson UMCT_BULK_DT_RD, 10502ac6454SAndrew Thompson UMCT_INTR_DT_RD, 10602ac6454SAndrew Thompson UMCT_N_TRANSFER, 10702ac6454SAndrew Thompson }; 10802ac6454SAndrew Thompson 10902ac6454SAndrew Thompson struct umct_softc { 110760bc48eSAndrew Thompson struct ucom_super_softc sc_super_ucom; 111760bc48eSAndrew Thompson struct ucom_softc sc_ucom; 11202ac6454SAndrew Thompson 113760bc48eSAndrew Thompson struct usb_device *sc_udev; 114760bc48eSAndrew Thompson struct usb_xfer *sc_xfer[UMCT_N_TRANSFER]; 115deefe583SAndrew Thompson struct mtx sc_mtx; 11602ac6454SAndrew Thompson 11702ac6454SAndrew Thompson uint32_t sc_unit; 11802ac6454SAndrew Thompson 11902ac6454SAndrew Thompson uint16_t sc_obufsize; 12002ac6454SAndrew Thompson 12102ac6454SAndrew Thompson uint8_t sc_lsr; 12202ac6454SAndrew Thompson uint8_t sc_msr; 12302ac6454SAndrew Thompson uint8_t sc_lcr; 12402ac6454SAndrew Thompson uint8_t sc_mcr; 12502ac6454SAndrew Thompson uint8_t sc_iface_no; 126585b13f2SAndrew Thompson uint8_t sc_swap_cb; 12702ac6454SAndrew Thompson }; 12802ac6454SAndrew Thompson 12902ac6454SAndrew Thompson /* prototypes */ 13002ac6454SAndrew Thompson 13102ac6454SAndrew Thompson static device_probe_t umct_probe; 13202ac6454SAndrew Thompson static device_attach_t umct_attach; 13302ac6454SAndrew Thompson static device_detach_t umct_detach; 134c01fc06eSHans Petter Selasky static void umct_free_softc(struct umct_softc *); 13502ac6454SAndrew Thompson 136e0a69b51SAndrew Thompson static usb_callback_t umct_intr_callback; 137585b13f2SAndrew Thompson static usb_callback_t umct_intr_callback_sub; 138e0a69b51SAndrew Thompson static usb_callback_t umct_read_callback; 139585b13f2SAndrew Thompson static usb_callback_t umct_read_callback_sub; 140585b13f2SAndrew Thompson static usb_callback_t umct_write_callback; 14102ac6454SAndrew Thompson 14202ac6454SAndrew Thompson static void umct_cfg_do_request(struct umct_softc *sc, uint8_t request, 14302ac6454SAndrew Thompson uint16_t len, uint32_t value); 1445805d178SHans Petter Selasky static void umct_free(struct ucom_softc *); 145760bc48eSAndrew Thompson static void umct_cfg_get_status(struct ucom_softc *, uint8_t *, 14602ac6454SAndrew Thompson uint8_t *); 147760bc48eSAndrew Thompson static void umct_cfg_set_break(struct ucom_softc *, uint8_t); 148760bc48eSAndrew Thompson static void umct_cfg_set_dtr(struct ucom_softc *, uint8_t); 149760bc48eSAndrew Thompson static void umct_cfg_set_rts(struct ucom_softc *, uint8_t); 15002ac6454SAndrew Thompson static uint8_t umct_calc_baud(uint32_t); 151760bc48eSAndrew Thompson static int umct_pre_param(struct ucom_softc *, struct termios *); 152760bc48eSAndrew Thompson static void umct_cfg_param(struct ucom_softc *, struct termios *); 153760bc48eSAndrew Thompson static void umct_start_read(struct ucom_softc *); 154760bc48eSAndrew Thompson static void umct_stop_read(struct ucom_softc *); 155760bc48eSAndrew Thompson static void umct_start_write(struct ucom_softc *); 156760bc48eSAndrew Thompson static void umct_stop_write(struct ucom_softc *); 157655dc9d0SAndrew Thompson static void umct_poll(struct ucom_softc *ucom); 15802ac6454SAndrew Thompson 159760bc48eSAndrew Thompson static const struct usb_config umct_config[UMCT_N_TRANSFER] = { 16002ac6454SAndrew Thompson 16102ac6454SAndrew Thompson [UMCT_BULK_DT_WR] = { 16202ac6454SAndrew Thompson .type = UE_BULK, 16302ac6454SAndrew Thompson .endpoint = UE_ADDR_ANY, 16402ac6454SAndrew Thompson .direction = UE_DIR_OUT, 1654eae601eSAndrew Thompson .bufsize = 0, /* use wMaxPacketSize */ 1664eae601eSAndrew Thompson .flags = {.pipe_bof = 1,.force_short_xfer = 1,}, 1674eae601eSAndrew Thompson .callback = &umct_write_callback, 16802ac6454SAndrew Thompson }, 16902ac6454SAndrew Thompson 17002ac6454SAndrew Thompson [UMCT_BULK_DT_RD] = { 17102ac6454SAndrew Thompson .type = UE_INTERRUPT, 17202ac6454SAndrew Thompson .endpoint = UE_ADDR_ANY, 17302ac6454SAndrew Thompson .direction = UE_DIR_IN, 1744eae601eSAndrew Thompson .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 1754eae601eSAndrew Thompson .bufsize = 0, /* use wMaxPacketSize */ 1764eae601eSAndrew Thompson .callback = &umct_read_callback, 17702ac6454SAndrew Thompson .ep_index = 0, /* first interrupt endpoint */ 17802ac6454SAndrew Thompson }, 17902ac6454SAndrew Thompson 18002ac6454SAndrew Thompson [UMCT_INTR_DT_RD] = { 18102ac6454SAndrew Thompson .type = UE_INTERRUPT, 18202ac6454SAndrew Thompson .endpoint = UE_ADDR_ANY, 18302ac6454SAndrew Thompson .direction = UE_DIR_IN, 1844eae601eSAndrew Thompson .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 1854eae601eSAndrew Thompson .bufsize = 0, /* use wMaxPacketSize */ 1864eae601eSAndrew Thompson .callback = &umct_intr_callback, 18702ac6454SAndrew Thompson .ep_index = 1, /* second interrupt endpoint */ 18802ac6454SAndrew Thompson }, 18902ac6454SAndrew Thompson }; 19002ac6454SAndrew Thompson 191760bc48eSAndrew Thompson static const struct ucom_callback umct_callback = { 192a593f6b8SAndrew Thompson .ucom_cfg_get_status = &umct_cfg_get_status, 193a593f6b8SAndrew Thompson .ucom_cfg_set_dtr = &umct_cfg_set_dtr, 194a593f6b8SAndrew Thompson .ucom_cfg_set_rts = &umct_cfg_set_rts, 195a593f6b8SAndrew Thompson .ucom_cfg_set_break = &umct_cfg_set_break, 196a593f6b8SAndrew Thompson .ucom_cfg_param = &umct_cfg_param, 197a593f6b8SAndrew Thompson .ucom_pre_param = &umct_pre_param, 198a593f6b8SAndrew Thompson .ucom_start_read = &umct_start_read, 199a593f6b8SAndrew Thompson .ucom_stop_read = &umct_stop_read, 200a593f6b8SAndrew Thompson .ucom_start_write = &umct_start_write, 201a593f6b8SAndrew Thompson .ucom_stop_write = &umct_stop_write, 202655dc9d0SAndrew Thompson .ucom_poll = &umct_poll, 2035805d178SHans Petter Selasky .ucom_free = &umct_free, 20402ac6454SAndrew Thompson }; 20502ac6454SAndrew Thompson 206f1a16106SHans Petter Selasky static const STRUCT_USB_HOST_ID umct_devs[] = { 20702ac6454SAndrew Thompson {USB_VPI(USB_VENDOR_MCT, USB_PRODUCT_MCT_USB232, 0)}, 20802ac6454SAndrew Thompson {USB_VPI(USB_VENDOR_MCT, USB_PRODUCT_MCT_SITECOM_USB232, 0)}, 20902ac6454SAndrew Thompson {USB_VPI(USB_VENDOR_MCT, USB_PRODUCT_MCT_DU_H3SP_USB232, 0)}, 21002ac6454SAndrew Thompson {USB_VPI(USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U109, 0)}, 21102ac6454SAndrew Thompson {USB_VPI(USB_VENDOR_BELKIN, USB_PRODUCT_BELKIN_F5U409, 0)}, 21202ac6454SAndrew Thompson }; 21302ac6454SAndrew Thompson 21402ac6454SAndrew Thompson static device_method_t umct_methods[] = { 21502ac6454SAndrew Thompson DEVMETHOD(device_probe, umct_probe), 21602ac6454SAndrew Thompson DEVMETHOD(device_attach, umct_attach), 21702ac6454SAndrew Thompson DEVMETHOD(device_detach, umct_detach), 2185805d178SHans Petter Selasky DEVMETHOD_END 21902ac6454SAndrew Thompson }; 22002ac6454SAndrew Thompson 22102ac6454SAndrew Thompson static devclass_t umct_devclass; 22202ac6454SAndrew Thompson 22302ac6454SAndrew Thompson static driver_t umct_driver = { 22402ac6454SAndrew Thompson .name = "umct", 22502ac6454SAndrew Thompson .methods = umct_methods, 22602ac6454SAndrew Thompson .size = sizeof(struct umct_softc), 22702ac6454SAndrew Thompson }; 22802ac6454SAndrew Thompson 2299aef556dSAndrew Thompson DRIVER_MODULE(umct, uhub, umct_driver, umct_devclass, NULL, 0); 23002ac6454SAndrew Thompson MODULE_DEPEND(umct, ucom, 1, 1, 1); 23102ac6454SAndrew Thompson MODULE_DEPEND(umct, usb, 1, 1, 1); 232910cb8feSAndrew Thompson MODULE_VERSION(umct, 1); 233f809f280SWarner Losh USB_PNP_HOST_INFO(umct_devs); 23402ac6454SAndrew Thompson 23502ac6454SAndrew Thompson static int 23602ac6454SAndrew Thompson umct_probe(device_t dev) 23702ac6454SAndrew Thompson { 238760bc48eSAndrew Thompson struct usb_attach_arg *uaa = device_get_ivars(dev); 23902ac6454SAndrew Thompson 240f29a0724SAndrew Thompson if (uaa->usb_mode != USB_MODE_HOST) { 24102ac6454SAndrew Thompson return (ENXIO); 24202ac6454SAndrew Thompson } 24302ac6454SAndrew Thompson if (uaa->info.bConfigIndex != UMCT_CONFIG_INDEX) { 24402ac6454SAndrew Thompson return (ENXIO); 24502ac6454SAndrew Thompson } 24602ac6454SAndrew Thompson if (uaa->info.bIfaceIndex != UMCT_IFACE_INDEX) { 24702ac6454SAndrew Thompson return (ENXIO); 24802ac6454SAndrew Thompson } 249a593f6b8SAndrew Thompson return (usbd_lookup_id_by_uaa(umct_devs, sizeof(umct_devs), uaa)); 25002ac6454SAndrew Thompson } 25102ac6454SAndrew Thompson 25202ac6454SAndrew Thompson static int 25302ac6454SAndrew Thompson umct_attach(device_t dev) 25402ac6454SAndrew Thompson { 255760bc48eSAndrew Thompson struct usb_attach_arg *uaa = device_get_ivars(dev); 25602ac6454SAndrew Thompson struct umct_softc *sc = device_get_softc(dev); 25702ac6454SAndrew Thompson int32_t error; 258585b13f2SAndrew Thompson uint16_t maxp; 25902ac6454SAndrew Thompson uint8_t iface_index; 26002ac6454SAndrew Thompson 26102ac6454SAndrew Thompson sc->sc_udev = uaa->device; 26202ac6454SAndrew Thompson sc->sc_unit = device_get_unit(dev); 26302ac6454SAndrew Thompson 264a593f6b8SAndrew Thompson device_set_usb_desc(dev); 265deefe583SAndrew Thompson mtx_init(&sc->sc_mtx, "umct", NULL, MTX_DEF); 2665805d178SHans Petter Selasky ucom_ref(&sc->sc_super_ucom); 26702ac6454SAndrew Thompson 26802ac6454SAndrew Thompson sc->sc_iface_no = uaa->info.bIfaceNum; 26902ac6454SAndrew Thompson 27002ac6454SAndrew Thompson iface_index = UMCT_IFACE_INDEX; 271a593f6b8SAndrew Thompson error = usbd_transfer_setup(uaa->device, &iface_index, 272deefe583SAndrew Thompson sc->sc_xfer, umct_config, UMCT_N_TRANSFER, sc, &sc->sc_mtx); 27302ac6454SAndrew Thompson 27402ac6454SAndrew Thompson if (error) { 27502ac6454SAndrew Thompson device_printf(dev, "allocating USB " 276767cb2e2SAndrew Thompson "transfers failed\n"); 27702ac6454SAndrew Thompson goto detach; 27802ac6454SAndrew Thompson } 279585b13f2SAndrew Thompson 28002ac6454SAndrew Thompson /* 28102ac6454SAndrew Thompson * The real bulk-in endpoint is also marked as an interrupt. 28202ac6454SAndrew Thompson * The only way to differentiate it from the real interrupt 28302ac6454SAndrew Thompson * endpoint is to look at the wMaxPacketSize field. 28402ac6454SAndrew Thompson */ 285585b13f2SAndrew Thompson maxp = usbd_xfer_max_framelen(sc->sc_xfer[UMCT_BULK_DT_RD]); 28602ac6454SAndrew Thompson if (maxp == 0x2) { 28702ac6454SAndrew Thompson 28802ac6454SAndrew Thompson /* guessed wrong - switch around endpoints */ 28902ac6454SAndrew Thompson 290760bc48eSAndrew Thompson struct usb_xfer *temp = sc->sc_xfer[UMCT_INTR_DT_RD]; 29102ac6454SAndrew Thompson 29202ac6454SAndrew Thompson sc->sc_xfer[UMCT_INTR_DT_RD] = sc->sc_xfer[UMCT_BULK_DT_RD]; 29302ac6454SAndrew Thompson sc->sc_xfer[UMCT_BULK_DT_RD] = temp; 294585b13f2SAndrew Thompson sc->sc_swap_cb = 1; 29502ac6454SAndrew Thompson } 296585b13f2SAndrew Thompson 297ed6d949aSAndrew Thompson sc->sc_obufsize = usbd_xfer_max_len(sc->sc_xfer[UMCT_BULK_DT_WR]); 29802ac6454SAndrew Thompson 29902ac6454SAndrew Thompson if (uaa->info.idProduct == USB_PRODUCT_MCT_SITECOM_USB232) { 30002ac6454SAndrew Thompson if (sc->sc_obufsize > 16) { 30102ac6454SAndrew Thompson sc->sc_obufsize = 16; 30202ac6454SAndrew Thompson } 30302ac6454SAndrew Thompson } 304a593f6b8SAndrew Thompson error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc, 305deefe583SAndrew Thompson &umct_callback, &sc->sc_mtx); 30602ac6454SAndrew Thompson if (error) { 30702ac6454SAndrew Thompson goto detach; 30802ac6454SAndrew Thompson } 3096416c259SNick Hibma ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev); 3106416c259SNick Hibma 31102ac6454SAndrew Thompson return (0); /* success */ 31202ac6454SAndrew Thompson 31302ac6454SAndrew Thompson detach: 31402ac6454SAndrew Thompson umct_detach(dev); 31502ac6454SAndrew Thompson return (ENXIO); /* failure */ 31602ac6454SAndrew Thompson } 31702ac6454SAndrew Thompson 31802ac6454SAndrew Thompson static int 31902ac6454SAndrew Thompson umct_detach(device_t dev) 32002ac6454SAndrew Thompson { 32102ac6454SAndrew Thompson struct umct_softc *sc = device_get_softc(dev); 32202ac6454SAndrew Thompson 323015bb88fSNick Hibma ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom); 324a593f6b8SAndrew Thompson usbd_transfer_unsetup(sc->sc_xfer, UMCT_N_TRANSFER); 32502ac6454SAndrew Thompson 326c01fc06eSHans Petter Selasky device_claim_softc(dev); 327c01fc06eSHans Petter Selasky 328c01fc06eSHans Petter Selasky umct_free_softc(sc); 329c01fc06eSHans Petter Selasky 33002ac6454SAndrew Thompson return (0); 33102ac6454SAndrew Thompson } 33202ac6454SAndrew Thompson 3335805d178SHans Petter Selasky UCOM_UNLOAD_DRAIN(umct); 3345805d178SHans Petter Selasky 3355805d178SHans Petter Selasky static void 336c01fc06eSHans Petter Selasky umct_free_softc(struct umct_softc *sc) 3375805d178SHans Petter Selasky { 3385805d178SHans Petter Selasky if (ucom_unref(&sc->sc_super_ucom)) { 3395805d178SHans Petter Selasky mtx_destroy(&sc->sc_mtx); 340c01fc06eSHans Petter Selasky device_free_softc(sc); 3415805d178SHans Petter Selasky } 3425805d178SHans Petter Selasky } 3435805d178SHans Petter Selasky 3445805d178SHans Petter Selasky static void 3455805d178SHans Petter Selasky umct_free(struct ucom_softc *ucom) 3465805d178SHans Petter Selasky { 347c01fc06eSHans Petter Selasky umct_free_softc(ucom->sc_parent); 3485805d178SHans Petter Selasky } 3495805d178SHans Petter Selasky 35002ac6454SAndrew Thompson static void 35102ac6454SAndrew Thompson umct_cfg_do_request(struct umct_softc *sc, uint8_t request, 35202ac6454SAndrew Thompson uint16_t len, uint32_t value) 35302ac6454SAndrew Thompson { 354760bc48eSAndrew Thompson struct usb_device_request req; 355e0a69b51SAndrew Thompson usb_error_t err; 35602ac6454SAndrew Thompson uint8_t temp[4]; 35702ac6454SAndrew Thompson 35802ac6454SAndrew Thompson if (len > 4) 35902ac6454SAndrew Thompson len = 4; 36002ac6454SAndrew Thompson req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 36102ac6454SAndrew Thompson req.bRequest = request; 36202ac6454SAndrew Thompson USETW(req.wValue, 0); 36302ac6454SAndrew Thompson req.wIndex[0] = sc->sc_iface_no; 36402ac6454SAndrew Thompson req.wIndex[1] = 0; 36502ac6454SAndrew Thompson USETW(req.wLength, len); 36602ac6454SAndrew Thompson USETDW(temp, value); 36702ac6454SAndrew Thompson 368a593f6b8SAndrew Thompson err = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 36902ac6454SAndrew Thompson &req, temp, 0, 1000); 37002ac6454SAndrew Thompson if (err) { 37102ac6454SAndrew Thompson DPRINTFN(0, "device request failed, err=%s " 372a593f6b8SAndrew Thompson "(ignored)\n", usbd_errstr(err)); 37302ac6454SAndrew Thompson } 37402ac6454SAndrew Thompson return; 37502ac6454SAndrew Thompson } 37602ac6454SAndrew Thompson 37702ac6454SAndrew Thompson static void 378585b13f2SAndrew Thompson umct_intr_callback_sub(struct usb_xfer *xfer, usb_error_t error) 37902ac6454SAndrew Thompson { 380ed6d949aSAndrew Thompson struct umct_softc *sc = usbd_xfer_softc(xfer); 381ed6d949aSAndrew Thompson struct usb_page_cache *pc; 38202ac6454SAndrew Thompson uint8_t buf[2]; 383ed6d949aSAndrew Thompson int actlen; 384ed6d949aSAndrew Thompson 385ed6d949aSAndrew Thompson usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 38602ac6454SAndrew Thompson 38702ac6454SAndrew Thompson switch (USB_GET_STATE(xfer)) { 38802ac6454SAndrew Thompson case USB_ST_TRANSFERRED: 389ed6d949aSAndrew Thompson if (actlen < 2) { 39002ac6454SAndrew Thompson DPRINTF("too short message\n"); 39102ac6454SAndrew Thompson goto tr_setup; 39202ac6454SAndrew Thompson } 393ed6d949aSAndrew Thompson pc = usbd_xfer_get_frame(xfer, 0); 394ed6d949aSAndrew Thompson usbd_copy_out(pc, 0, buf, sizeof(buf)); 39502ac6454SAndrew Thompson 396*d88e7bb0SIan Lepore /* 397*d88e7bb0SIan Lepore * MSR bits need translation from ns16550 to SER_* values. 398*d88e7bb0SIan Lepore * LSR bits are ns16550 in hardware and ucom. 399*d88e7bb0SIan Lepore */ 400*d88e7bb0SIan Lepore sc->sc_msr = 0; 401*d88e7bb0SIan Lepore if (buf[0] & UMCT_MSR_CTS) 402*d88e7bb0SIan Lepore sc->sc_msr |= SER_CTS; 403*d88e7bb0SIan Lepore if (buf[0] & UMCT_MSR_CD) 404*d88e7bb0SIan Lepore sc->sc_msr |= SER_DCD; 405*d88e7bb0SIan Lepore if (buf[0] & UMCT_MSR_RI) 406*d88e7bb0SIan Lepore sc->sc_msr |= SER_RI; 407*d88e7bb0SIan Lepore if (buf[0] & UMCT_MSR_RTS) 408*d88e7bb0SIan Lepore sc->sc_msr |= SER_DSR; 40902ac6454SAndrew Thompson sc->sc_lsr = buf[1]; 41002ac6454SAndrew Thompson 411a593f6b8SAndrew Thompson ucom_status_change(&sc->sc_ucom); 412*d88e7bb0SIan Lepore /* FALLTHROUGH */ 41302ac6454SAndrew Thompson case USB_ST_SETUP: 41402ac6454SAndrew Thompson tr_setup: 415ed6d949aSAndrew Thompson usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 416a593f6b8SAndrew Thompson usbd_transfer_submit(xfer); 41702ac6454SAndrew Thompson return; 41802ac6454SAndrew Thompson 41902ac6454SAndrew Thompson default: /* Error */ 420ed6d949aSAndrew Thompson if (error != USB_ERR_CANCELLED) { 42102ac6454SAndrew Thompson /* try to clear stall first */ 422ed6d949aSAndrew Thompson usbd_xfer_set_stall(xfer); 42302ac6454SAndrew Thompson goto tr_setup; 42402ac6454SAndrew Thompson } 42502ac6454SAndrew Thompson return; 42602ac6454SAndrew Thompson } 42702ac6454SAndrew Thompson } 42802ac6454SAndrew Thompson 42902ac6454SAndrew Thompson static void 430760bc48eSAndrew Thompson umct_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr) 43102ac6454SAndrew Thompson { 43202ac6454SAndrew Thompson struct umct_softc *sc = ucom->sc_parent; 43302ac6454SAndrew Thompson 43402ac6454SAndrew Thompson *lsr = sc->sc_lsr; 43502ac6454SAndrew Thompson *msr = sc->sc_msr; 43602ac6454SAndrew Thompson } 43702ac6454SAndrew Thompson 43802ac6454SAndrew Thompson static void 439760bc48eSAndrew Thompson umct_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff) 44002ac6454SAndrew Thompson { 44102ac6454SAndrew Thompson struct umct_softc *sc = ucom->sc_parent; 44202ac6454SAndrew Thompson 44302ac6454SAndrew Thompson if (onoff) 44402ac6454SAndrew Thompson sc->sc_lcr |= 0x40; 44502ac6454SAndrew Thompson else 44602ac6454SAndrew Thompson sc->sc_lcr &= ~0x40; 44702ac6454SAndrew Thompson 44802ac6454SAndrew Thompson umct_cfg_do_request(sc, UMCT_SET_LCR, UMCT_SET_LCR_SIZE, sc->sc_lcr); 44902ac6454SAndrew Thompson } 45002ac6454SAndrew Thompson 45102ac6454SAndrew Thompson static void 452760bc48eSAndrew Thompson umct_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff) 45302ac6454SAndrew Thompson { 45402ac6454SAndrew Thompson struct umct_softc *sc = ucom->sc_parent; 45502ac6454SAndrew Thompson 45602ac6454SAndrew Thompson if (onoff) 45702ac6454SAndrew Thompson sc->sc_mcr |= 0x01; 45802ac6454SAndrew Thompson else 45902ac6454SAndrew Thompson sc->sc_mcr &= ~0x01; 46002ac6454SAndrew Thompson 46102ac6454SAndrew Thompson umct_cfg_do_request(sc, UMCT_SET_MCR, UMCT_SET_MCR_SIZE, sc->sc_mcr); 46202ac6454SAndrew Thompson } 46302ac6454SAndrew Thompson 46402ac6454SAndrew Thompson static void 465760bc48eSAndrew Thompson umct_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff) 46602ac6454SAndrew Thompson { 46702ac6454SAndrew Thompson struct umct_softc *sc = ucom->sc_parent; 46802ac6454SAndrew Thompson 46902ac6454SAndrew Thompson if (onoff) 47002ac6454SAndrew Thompson sc->sc_mcr |= 0x02; 47102ac6454SAndrew Thompson else 47202ac6454SAndrew Thompson sc->sc_mcr &= ~0x02; 47302ac6454SAndrew Thompson 47402ac6454SAndrew Thompson umct_cfg_do_request(sc, UMCT_SET_MCR, UMCT_SET_MCR_SIZE, sc->sc_mcr); 47502ac6454SAndrew Thompson } 47602ac6454SAndrew Thompson 47702ac6454SAndrew Thompson static uint8_t 47802ac6454SAndrew Thompson umct_calc_baud(uint32_t baud) 47902ac6454SAndrew Thompson { 48002ac6454SAndrew Thompson switch (baud) { 48102ac6454SAndrew Thompson case B300:return (0x1); 48202ac6454SAndrew Thompson case B600: 48302ac6454SAndrew Thompson return (0x2); 48402ac6454SAndrew Thompson case B1200: 48502ac6454SAndrew Thompson return (0x3); 48602ac6454SAndrew Thompson case B2400: 48702ac6454SAndrew Thompson return (0x4); 48802ac6454SAndrew Thompson case B4800: 48902ac6454SAndrew Thompson return (0x6); 49002ac6454SAndrew Thompson case B9600: 49102ac6454SAndrew Thompson return (0x8); 49202ac6454SAndrew Thompson case B19200: 49302ac6454SAndrew Thompson return (0x9); 49402ac6454SAndrew Thompson case B38400: 49502ac6454SAndrew Thompson return (0xa); 49602ac6454SAndrew Thompson case B57600: 49702ac6454SAndrew Thompson return (0xb); 49802ac6454SAndrew Thompson case 115200: 49902ac6454SAndrew Thompson return (0xc); 50002ac6454SAndrew Thompson case B0: 50102ac6454SAndrew Thompson default: 50202ac6454SAndrew Thompson break; 50302ac6454SAndrew Thompson } 50402ac6454SAndrew Thompson return (0x0); 50502ac6454SAndrew Thompson } 50602ac6454SAndrew Thompson 50702ac6454SAndrew Thompson static int 508760bc48eSAndrew Thompson umct_pre_param(struct ucom_softc *ucom, struct termios *t) 50902ac6454SAndrew Thompson { 51002ac6454SAndrew Thompson return (0); /* we accept anything */ 51102ac6454SAndrew Thompson } 51202ac6454SAndrew Thompson 51302ac6454SAndrew Thompson static void 514760bc48eSAndrew Thompson umct_cfg_param(struct ucom_softc *ucom, struct termios *t) 51502ac6454SAndrew Thompson { 51602ac6454SAndrew Thompson struct umct_softc *sc = ucom->sc_parent; 51702ac6454SAndrew Thompson uint32_t value; 51802ac6454SAndrew Thompson 51902ac6454SAndrew Thompson value = umct_calc_baud(t->c_ospeed); 52002ac6454SAndrew Thompson umct_cfg_do_request(sc, UMCT_SET_BAUD, UMCT_SET_BAUD_SIZE, value); 52102ac6454SAndrew Thompson 52202ac6454SAndrew Thompson value = (sc->sc_lcr & 0x40); 52302ac6454SAndrew Thompson 52402ac6454SAndrew Thompson switch (t->c_cflag & CSIZE) { 52502ac6454SAndrew Thompson case CS5: 52602ac6454SAndrew Thompson value |= 0x0; 52702ac6454SAndrew Thompson break; 52802ac6454SAndrew Thompson case CS6: 52902ac6454SAndrew Thompson value |= 0x1; 53002ac6454SAndrew Thompson break; 53102ac6454SAndrew Thompson case CS7: 53202ac6454SAndrew Thompson value |= 0x2; 53302ac6454SAndrew Thompson break; 53402ac6454SAndrew Thompson default: 53502ac6454SAndrew Thompson case CS8: 53602ac6454SAndrew Thompson value |= 0x3; 53702ac6454SAndrew Thompson break; 53802ac6454SAndrew Thompson } 53902ac6454SAndrew Thompson 54002ac6454SAndrew Thompson value |= (t->c_cflag & CSTOPB) ? 0x4 : 0; 54102ac6454SAndrew Thompson if (t->c_cflag & PARENB) { 54202ac6454SAndrew Thompson value |= 0x8; 54302ac6454SAndrew Thompson value |= (t->c_cflag & PARODD) ? 0x0 : 0x10; 54402ac6454SAndrew Thompson } 54502ac6454SAndrew Thompson /* 54602ac6454SAndrew Thompson * XXX There doesn't seem to be a way to tell the device 54702ac6454SAndrew Thompson * to use flow control. 54802ac6454SAndrew Thompson */ 54902ac6454SAndrew Thompson 55002ac6454SAndrew Thompson sc->sc_lcr = value; 55102ac6454SAndrew Thompson umct_cfg_do_request(sc, UMCT_SET_LCR, UMCT_SET_LCR_SIZE, value); 55202ac6454SAndrew Thompson } 55302ac6454SAndrew Thompson 55402ac6454SAndrew Thompson static void 555760bc48eSAndrew Thompson umct_start_read(struct ucom_softc *ucom) 55602ac6454SAndrew Thompson { 55702ac6454SAndrew Thompson struct umct_softc *sc = ucom->sc_parent; 55802ac6454SAndrew Thompson 55902ac6454SAndrew Thompson /* start interrupt endpoint */ 560a593f6b8SAndrew Thompson usbd_transfer_start(sc->sc_xfer[UMCT_INTR_DT_RD]); 56102ac6454SAndrew Thompson 56202ac6454SAndrew Thompson /* start read endpoint */ 563a593f6b8SAndrew Thompson usbd_transfer_start(sc->sc_xfer[UMCT_BULK_DT_RD]); 56402ac6454SAndrew Thompson } 56502ac6454SAndrew Thompson 56602ac6454SAndrew Thompson static void 567760bc48eSAndrew Thompson umct_stop_read(struct ucom_softc *ucom) 56802ac6454SAndrew Thompson { 56902ac6454SAndrew Thompson struct umct_softc *sc = ucom->sc_parent; 57002ac6454SAndrew Thompson 57102ac6454SAndrew Thompson /* stop interrupt endpoint */ 572a593f6b8SAndrew Thompson usbd_transfer_stop(sc->sc_xfer[UMCT_INTR_DT_RD]); 57302ac6454SAndrew Thompson 57402ac6454SAndrew Thompson /* stop read endpoint */ 575a593f6b8SAndrew Thompson usbd_transfer_stop(sc->sc_xfer[UMCT_BULK_DT_RD]); 57602ac6454SAndrew Thompson } 57702ac6454SAndrew Thompson 57802ac6454SAndrew Thompson static void 579760bc48eSAndrew Thompson umct_start_write(struct ucom_softc *ucom) 58002ac6454SAndrew Thompson { 58102ac6454SAndrew Thompson struct umct_softc *sc = ucom->sc_parent; 58202ac6454SAndrew Thompson 583a593f6b8SAndrew Thompson usbd_transfer_start(sc->sc_xfer[UMCT_BULK_DT_WR]); 58402ac6454SAndrew Thompson } 58502ac6454SAndrew Thompson 58602ac6454SAndrew Thompson static void 587760bc48eSAndrew Thompson umct_stop_write(struct ucom_softc *ucom) 58802ac6454SAndrew Thompson { 58902ac6454SAndrew Thompson struct umct_softc *sc = ucom->sc_parent; 59002ac6454SAndrew Thompson 591a593f6b8SAndrew Thompson usbd_transfer_stop(sc->sc_xfer[UMCT_BULK_DT_WR]); 59202ac6454SAndrew Thompson } 59302ac6454SAndrew Thompson 59402ac6454SAndrew Thompson static void 595585b13f2SAndrew Thompson umct_read_callback(struct usb_xfer *xfer, usb_error_t error) 596585b13f2SAndrew Thompson { 597585b13f2SAndrew Thompson struct umct_softc *sc = usbd_xfer_softc(xfer); 598585b13f2SAndrew Thompson 599585b13f2SAndrew Thompson if (sc->sc_swap_cb) 600585b13f2SAndrew Thompson umct_intr_callback_sub(xfer, error); 601585b13f2SAndrew Thompson else 602585b13f2SAndrew Thompson umct_read_callback_sub(xfer, error); 603585b13f2SAndrew Thompson } 604585b13f2SAndrew Thompson 605585b13f2SAndrew Thompson static void 606585b13f2SAndrew Thompson umct_intr_callback(struct usb_xfer *xfer, usb_error_t error) 607585b13f2SAndrew Thompson { 608585b13f2SAndrew Thompson struct umct_softc *sc = usbd_xfer_softc(xfer); 609585b13f2SAndrew Thompson 610585b13f2SAndrew Thompson if (sc->sc_swap_cb) 611585b13f2SAndrew Thompson umct_read_callback_sub(xfer, error); 612585b13f2SAndrew Thompson else 613585b13f2SAndrew Thompson umct_intr_callback_sub(xfer, error); 614585b13f2SAndrew Thompson } 615585b13f2SAndrew Thompson 616585b13f2SAndrew Thompson static void 617ed6d949aSAndrew Thompson umct_write_callback(struct usb_xfer *xfer, usb_error_t error) 61802ac6454SAndrew Thompson { 619ed6d949aSAndrew Thompson struct umct_softc *sc = usbd_xfer_softc(xfer); 620ed6d949aSAndrew Thompson struct usb_page_cache *pc; 62102ac6454SAndrew Thompson uint32_t actlen; 62202ac6454SAndrew Thompson 62302ac6454SAndrew Thompson switch (USB_GET_STATE(xfer)) { 62402ac6454SAndrew Thompson case USB_ST_SETUP: 62502ac6454SAndrew Thompson case USB_ST_TRANSFERRED: 62602ac6454SAndrew Thompson tr_setup: 627ed6d949aSAndrew Thompson pc = usbd_xfer_get_frame(xfer, 0); 628ed6d949aSAndrew Thompson if (ucom_get_data(&sc->sc_ucom, pc, 0, 62902ac6454SAndrew Thompson sc->sc_obufsize, &actlen)) { 63002ac6454SAndrew Thompson 631ed6d949aSAndrew Thompson usbd_xfer_set_frame_len(xfer, 0, actlen); 632a593f6b8SAndrew Thompson usbd_transfer_submit(xfer); 63302ac6454SAndrew Thompson } 63402ac6454SAndrew Thompson return; 63502ac6454SAndrew Thompson 63602ac6454SAndrew Thompson default: /* Error */ 637ed6d949aSAndrew Thompson if (error != USB_ERR_CANCELLED) { 63802ac6454SAndrew Thompson /* try to clear stall first */ 639ed6d949aSAndrew Thompson usbd_xfer_set_stall(xfer); 64002ac6454SAndrew Thompson goto tr_setup; 64102ac6454SAndrew Thompson } 64202ac6454SAndrew Thompson return; 64302ac6454SAndrew Thompson } 64402ac6454SAndrew Thompson } 64502ac6454SAndrew Thompson 64602ac6454SAndrew Thompson static void 647585b13f2SAndrew Thompson umct_read_callback_sub(struct usb_xfer *xfer, usb_error_t error) 64802ac6454SAndrew Thompson { 649ed6d949aSAndrew Thompson struct umct_softc *sc = usbd_xfer_softc(xfer); 650ed6d949aSAndrew Thompson struct usb_page_cache *pc; 651ed6d949aSAndrew Thompson int actlen; 652ed6d949aSAndrew Thompson 653ed6d949aSAndrew Thompson usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 65402ac6454SAndrew Thompson 65502ac6454SAndrew Thompson switch (USB_GET_STATE(xfer)) { 65602ac6454SAndrew Thompson case USB_ST_TRANSFERRED: 657ed6d949aSAndrew Thompson pc = usbd_xfer_get_frame(xfer, 0); 658ed6d949aSAndrew Thompson ucom_put_data(&sc->sc_ucom, pc, 0, actlen); 65902ac6454SAndrew Thompson 66002ac6454SAndrew Thompson case USB_ST_SETUP: 66102ac6454SAndrew Thompson tr_setup: 662ed6d949aSAndrew Thompson usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 663a593f6b8SAndrew Thompson usbd_transfer_submit(xfer); 66402ac6454SAndrew Thompson return; 66502ac6454SAndrew Thompson 66602ac6454SAndrew Thompson default: /* Error */ 667ed6d949aSAndrew Thompson if (error != USB_ERR_CANCELLED) { 66802ac6454SAndrew Thompson /* try to clear stall first */ 669ed6d949aSAndrew Thompson usbd_xfer_set_stall(xfer); 67002ac6454SAndrew Thompson goto tr_setup; 67102ac6454SAndrew Thompson } 67202ac6454SAndrew Thompson return; 67302ac6454SAndrew Thompson } 67402ac6454SAndrew Thompson } 675655dc9d0SAndrew Thompson 676655dc9d0SAndrew Thompson static void 677655dc9d0SAndrew Thompson umct_poll(struct ucom_softc *ucom) 678655dc9d0SAndrew Thompson { 679655dc9d0SAndrew Thompson struct umct_softc *sc = ucom->sc_parent; 680655dc9d0SAndrew Thompson usbd_transfer_poll(sc->sc_xfer, UMCT_N_TRANSFER); 681655dc9d0SAndrew Thompson } 682