uslcom.c revision 302408
164562Sgshapiro/* $OpenBSD: uslcom.c,v 1.17 2007/11/24 10:52:12 jsg Exp $ */ 2157001Sgshapiro 364562Sgshapiro#include <sys/cdefs.h> 464562Sgshapiro__FBSDID("$FreeBSD: stable/11/sys/dev/usb/serial/uslcom.c 292080 2015-12-11 05:28:00Z imp $"); 564562Sgshapiro 664562Sgshapiro/* 764562Sgshapiro * Copyright (c) 2006 Jonathan Gray <jsg@openbsd.org> 864562Sgshapiro * 964562Sgshapiro * Permission to use, copy, modify, and distribute this software for any 1064562Sgshapiro * purpose with or without fee is hereby granted, provided that the above 1164562Sgshapiro * copyright notice and this permission notice appear in all copies. 1264562Sgshapiro * 1364562Sgshapiro * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 1464562Sgshapiro * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 1564562Sgshapiro * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 1690792Sgshapiro * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 1790792Sgshapiro * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 1890792Sgshapiro * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 1964562Sgshapiro * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 2064562Sgshapiro */ 2164562Sgshapiro 22203004Sgshapiro/* 2364562Sgshapiro * Driver for Silicon Laboratories CP2101/CP2102/CP2103/CP2104/CP2105 2464562Sgshapiro * USB-Serial adapters. Based on datasheet AN571, publicly available from 2564562Sgshapiro * http://www.silabs.com/Support%20Documents/TechnicalDocs/AN571.pdf 2664562Sgshapiro */ 2764562Sgshapiro 2864562Sgshapiro#include <sys/stdint.h> 29168515Sgshapiro#include <sys/stddef.h> 30168515Sgshapiro#include <sys/param.h> 3164562Sgshapiro#include <sys/queue.h> 3264562Sgshapiro#include <sys/types.h> 3364562Sgshapiro#include <sys/systm.h> 3464562Sgshapiro#include <sys/kernel.h> 35168515Sgshapiro#include <sys/bus.h> 36168515Sgshapiro#include <sys/module.h> 37168515Sgshapiro#include <sys/lock.h> 38168515Sgshapiro#include <sys/mutex.h> 39168515Sgshapiro#include <sys/condvar.h> 40168515Sgshapiro#include <sys/sysctl.h> 41168515Sgshapiro#include <sys/sx.h> 42168515Sgshapiro#include <sys/unistd.h> 4364562Sgshapiro#include <sys/callout.h> 4464562Sgshapiro#include <sys/malloc.h> 45168515Sgshapiro#include <sys/priv.h> 46168515Sgshapiro 47168515Sgshapiro#include <dev/usb/usb.h> 48168515Sgshapiro#include <dev/usb/usbdi.h> 49168515Sgshapiro#include <dev/usb/usbdi_util.h> 50168515Sgshapiro#include <dev/usb/usb_ioctl.h> 51168515Sgshapiro#include "usbdevs.h" 52168515Sgshapiro 53168515Sgshapiro#define USB_DEBUG_VAR uslcom_debug 54168515Sgshapiro#include <dev/usb/usb_debug.h> 55168515Sgshapiro#include <dev/usb/usb_process.h> 56168515Sgshapiro 57168515Sgshapiro#include <dev/usb/serial/usb_serial.h> 58168515Sgshapiro 59168515Sgshapiro#ifdef USB_DEBUG 60168515Sgshapirostatic int uslcom_debug = 0; 61168515Sgshapiro 62168515Sgshapirostatic SYSCTL_NODE(_hw_usb, OID_AUTO, uslcom, CTLFLAG_RW, 0, "USB uslcom"); 63168515SgshapiroSYSCTL_INT(_hw_usb_uslcom, OID_AUTO, debug, CTLFLAG_RWTUN, 64168515Sgshapiro &uslcom_debug, 0, "Debug level"); 65168515Sgshapiro#endif 66168515Sgshapiro 67168515Sgshapiro#define USLCOM_BULK_BUF_SIZE 1024 68168515Sgshapiro#define USLCOM_CONFIG_INDEX 0 69168515Sgshapiro 70168515Sgshapiro/* Request types */ 71168515Sgshapiro#define USLCOM_WRITE 0x41 72168515Sgshapiro#define USLCOM_READ 0xc1 73168515Sgshapiro 74168515Sgshapiro/* Request codes */ 75168515Sgshapiro#define USLCOM_IFC_ENABLE 0x00 76168515Sgshapiro#define USLCOM_SET_BAUDDIV 0x01 77168515Sgshapiro#define USLCOM_SET_LINE_CTL 0x03 78168515Sgshapiro#define USLCOM_SET_BREAK 0x05 79168515Sgshapiro#define USLCOM_SET_MHS 0x07 80168515Sgshapiro#define USLCOM_GET_MDMSTS 0x08 81168515Sgshapiro#define USLCOM_SET_FLOW 0x13 82168515Sgshapiro#define USLCOM_SET_BAUDRATE 0x1e 83168515Sgshapiro#define USLCOM_VENDOR_SPECIFIC 0xff 84168515Sgshapiro 85168515Sgshapiro/* USLCOM_IFC_ENABLE values */ 86168515Sgshapiro#define USLCOM_IFC_ENABLE_DIS 0x00 87168515Sgshapiro#define USLCOM_IFC_ENABLE_EN 0x01 88168515Sgshapiro 89168515Sgshapiro/* USLCOM_SET_MHS/USLCOM_GET_MDMSTS values */ 90168515Sgshapiro#define USLCOM_MHS_DTR_ON 0x0001 91168515Sgshapiro#define USLCOM_MHS_DTR_SET 0x0100 92168515Sgshapiro#define USLCOM_MHS_RTS_ON 0x0002 93168515Sgshapiro#define USLCOM_MHS_RTS_SET 0x0200 94168515Sgshapiro#define USLCOM_MHS_CTS 0x0010 95168515Sgshapiro#define USLCOM_MHS_DSR 0x0020 96168515Sgshapiro#define USLCOM_MHS_RI 0x0040 97168515Sgshapiro#define USLCOM_MHS_DCD 0x0080 98168515Sgshapiro 99168515Sgshapiro/* USLCOM_SET_BAUDDIV values */ 100168515Sgshapiro#define USLCOM_BAUDDIV_REF 3686400 /* 3.6864 MHz */ 101168515Sgshapiro 102168515Sgshapiro/* USLCOM_SET_LINE_CTL values */ 103168515Sgshapiro#define USLCOM_STOP_BITS_1 0x00 104168515Sgshapiro#define USLCOM_STOP_BITS_2 0x02 105168515Sgshapiro#define USLCOM_PARITY_NONE 0x00 106168515Sgshapiro#define USLCOM_PARITY_ODD 0x10 107168515Sgshapiro#define USLCOM_PARITY_EVEN 0x20 108168515Sgshapiro#define USLCOM_SET_DATA_BITS(x) ((x) << 8) 109168515Sgshapiro 110168515Sgshapiro/* USLCOM_SET_BREAK values */ 111168515Sgshapiro#define USLCOM_SET_BREAK_OFF 0x00 112168515Sgshapiro#define USLCOM_SET_BREAK_ON 0x01 113168515Sgshapiro 114168515Sgshapiro/* USLCOM_SET_FLOW values - 1st word */ 115168515Sgshapiro#define USLCOM_FLOW_DTR_ON 0x00000001 /* DTR static active */ 116168515Sgshapiro#define USLCOM_FLOW_CTS_HS 0x00000008 /* CTS handshake */ 117168515Sgshapiro/* USLCOM_SET_FLOW values - 2nd word */ 118168515Sgshapiro#define USLCOM_FLOW_RTS_ON 0x00000040 /* RTS static active */ 119168515Sgshapiro#define USLCOM_FLOW_RTS_HS 0x00000080 /* RTS handshake */ 120168515Sgshapiro 121168515Sgshapiro/* USLCOM_VENDOR_SPECIFIC values */ 122168515Sgshapiro#define USLCOM_GET_PARTNUM 0x370B 123168515Sgshapiro#define USLCOM_WRITE_LATCH 0x37E1 12464562Sgshapiro#define USLCOM_READ_LATCH 0x00C2 12590792Sgshapiro 12690792Sgshapiro/* USLCOM_GET_PARTNUM values from hardware */ 12790792Sgshapiro#define USLCOM_PARTNUM_CP2101 1 12890792Sgshapiro#define USLCOM_PARTNUM_CP2102 2 12990792Sgshapiro#define USLCOM_PARTNUM_CP2103 3 13064562Sgshapiro#define USLCOM_PARTNUM_CP2104 4 13164562Sgshapiro#define USLCOM_PARTNUM_CP2105 5 13264562Sgshapiro 13364562Sgshapiroenum { 13471345Sgshapiro USLCOM_BULK_DT_WR, 13571345Sgshapiro USLCOM_BULK_DT_RD, 13671345Sgshapiro USLCOM_CTRL_DT_RD, 13771345Sgshapiro USLCOM_N_TRANSFER, 13871345Sgshapiro}; 13971345Sgshapiro 14071345Sgshapirostruct uslcom_softc { 141168515Sgshapiro struct ucom_super_softc sc_super_ucom; 142168515Sgshapiro struct ucom_softc sc_ucom; 143168515Sgshapiro struct usb_callout sc_watchdog; 144168515Sgshapiro 145168515Sgshapiro struct usb_xfer *sc_xfer[USLCOM_N_TRANSFER]; 146168515Sgshapiro struct usb_device *sc_udev; 147168515Sgshapiro struct mtx sc_mtx; 148168515Sgshapiro 149168515Sgshapiro uint8_t sc_msr; 150168515Sgshapiro uint8_t sc_lsr; 151168515Sgshapiro uint8_t sc_iface_no; 152168515Sgshapiro uint8_t sc_partnum; 153168515Sgshapiro}; 154168515Sgshapiro 155168515Sgshapirostatic device_probe_t uslcom_probe; 156168515Sgshapirostatic device_attach_t uslcom_attach; 157168515Sgshapirostatic device_detach_t uslcom_detach; 158168515Sgshapirostatic void uslcom_free_softc(struct uslcom_softc *); 159168515Sgshapiro 160168515Sgshapirostatic usb_callback_t uslcom_write_callback; 161168515Sgshapirostatic usb_callback_t uslcom_read_callback; 162168515Sgshapirostatic usb_callback_t uslcom_control_callback; 163168515Sgshapiro 164168515Sgshapirostatic void uslcom_free(struct ucom_softc *); 165168515Sgshapirostatic void uslcom_open(struct ucom_softc *); 166168515Sgshapirostatic void uslcom_close(struct ucom_softc *); 167168515Sgshapirostatic uint8_t uslcom_get_partnum(struct uslcom_softc *); 168168515Sgshapirostatic void uslcom_set_dtr(struct ucom_softc *, uint8_t); 169132943Sgshapirostatic void uslcom_set_rts(struct ucom_softc *, uint8_t); 170111823Sgshapirostatic void uslcom_set_break(struct ucom_softc *, uint8_t); 171111823Sgshapirostatic int uslcom_ioctl(struct ucom_softc *, uint32_t, caddr_t, int, 172111823Sgshapiro struct thread *); 173111823Sgshapirostatic int uslcom_pre_param(struct ucom_softc *, struct termios *); 174111823Sgshapirostatic void uslcom_param(struct ucom_softc *, struct termios *); 175111823Sgshapirostatic void uslcom_get_status(struct ucom_softc *, uint8_t *, uint8_t *); 176111823Sgshapirostatic void uslcom_start_read(struct ucom_softc *); 177111823Sgshapirostatic void uslcom_stop_read(struct ucom_softc *); 178111823Sgshapirostatic void uslcom_start_write(struct ucom_softc *); 179111823Sgshapirostatic void uslcom_stop_write(struct ucom_softc *); 180111823Sgshapirostatic void uslcom_poll(struct ucom_softc *ucom); 181111823Sgshapiro 182111823Sgshapirostatic const struct usb_config uslcom_config[USLCOM_N_TRANSFER] = { 183111823Sgshapiro 184111823Sgshapiro [USLCOM_BULK_DT_WR] = { 185111823Sgshapiro .type = UE_BULK, 186111823Sgshapiro .endpoint = UE_ADDR_ANY, 187111823Sgshapiro .direction = UE_DIR_OUT, 188111823Sgshapiro .bufsize = USLCOM_BULK_BUF_SIZE, 189111823Sgshapiro .flags = {.pipe_bof = 1,}, 190111823Sgshapiro .callback = &uslcom_write_callback, 191111823Sgshapiro }, 192111823Sgshapiro 193111823Sgshapiro [USLCOM_BULK_DT_RD] = { 194111823Sgshapiro .type = UE_BULK, 195111823Sgshapiro .endpoint = UE_ADDR_ANY, 196111823Sgshapiro .direction = UE_DIR_IN, 197111823Sgshapiro .bufsize = USLCOM_BULK_BUF_SIZE, 198111823Sgshapiro .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 199111823Sgshapiro .callback = &uslcom_read_callback, 200111823Sgshapiro }, 201111823Sgshapiro [USLCOM_CTRL_DT_RD] = { 202111823Sgshapiro .type = UE_CONTROL, 203111823Sgshapiro .endpoint = 0x00, 204111823Sgshapiro .direction = UE_DIR_ANY, 205111823Sgshapiro .bufsize = sizeof(struct usb_device_request) + 8, 206132943Sgshapiro .flags = {.pipe_bof = 1,}, 207111823Sgshapiro .callback = &uslcom_control_callback, 208111823Sgshapiro .timeout = 1000, /* 1 second timeout */ 209111823Sgshapiro }, 210111823Sgshapiro}; 211111823Sgshapiro 212111823Sgshapirostatic struct ucom_callback uslcom_callback = { 213111823Sgshapiro .ucom_cfg_open = &uslcom_open, 214111823Sgshapiro .ucom_cfg_close = &uslcom_close, 215111823Sgshapiro .ucom_cfg_get_status = &uslcom_get_status, 216111823Sgshapiro .ucom_cfg_set_dtr = &uslcom_set_dtr, 217111823Sgshapiro .ucom_cfg_set_rts = &uslcom_set_rts, 218111823Sgshapiro .ucom_cfg_set_break = &uslcom_set_break, 219111823Sgshapiro .ucom_ioctl = &uslcom_ioctl, 220111823Sgshapiro .ucom_cfg_param = &uslcom_param, 221111823Sgshapiro .ucom_pre_param = &uslcom_pre_param, 222157001Sgshapiro .ucom_start_read = &uslcom_start_read, 223111823Sgshapiro .ucom_stop_read = &uslcom_stop_read, 224111823Sgshapiro .ucom_start_write = &uslcom_start_write, 225111823Sgshapiro .ucom_stop_write = &uslcom_stop_write, 226111823Sgshapiro .ucom_poll = &uslcom_poll, 227111823Sgshapiro .ucom_free = &uslcom_free, 228111823Sgshapiro}; 229111823Sgshapiro 230111823Sgshapirostatic const STRUCT_USB_HOST_ID uslcom_devs[] = { 231111823Sgshapiro#define USLCOM_DEV(v,p) { USB_VP(USB_VENDOR_##v, USB_PRODUCT_##v##_##p) } 232111823Sgshapiro USLCOM_DEV(BALTECH, CARDREADER), 233132943Sgshapiro USLCOM_DEV(CLIPSAL, 5000CT2), 234111823Sgshapiro USLCOM_DEV(CLIPSAL, 5500PACA), 23564562Sgshapiro USLCOM_DEV(CLIPSAL, 5500PCU), 23664562Sgshapiro USLCOM_DEV(CLIPSAL, 560884), 23764562Sgshapiro USLCOM_DEV(CLIPSAL, 5800PC), 23877349Sgshapiro USLCOM_DEV(CLIPSAL, C5000CT2), 23964562Sgshapiro USLCOM_DEV(CLIPSAL, L51xx), 24064562Sgshapiro USLCOM_DEV(DATAAPEX, MULTICOM), 24190792Sgshapiro USLCOM_DEV(DELL, DW700), 24290792Sgshapiro USLCOM_DEV(DIGIANSWER, ZIGBEE802154), 24390792Sgshapiro USLCOM_DEV(DYNASTREAM, ANTDEVBOARD), 24490792Sgshapiro USLCOM_DEV(DYNASTREAM, ANTDEVBOARD2), 24590792Sgshapiro USLCOM_DEV(DYNASTREAM, ANT2USB), 24690792Sgshapiro USLCOM_DEV(ELV, USBI2C), 24790792Sgshapiro USLCOM_DEV(FESTO, CMSP), 24866494Sgshapiro USLCOM_DEV(FESTO, CPX_USB), 24964562Sgshapiro USLCOM_DEV(FOXCONN, PIRELLI_DP_L10), 25064562Sgshapiro USLCOM_DEV(FOXCONN, TCOM_TC_300), 25164562Sgshapiro USLCOM_DEV(GEMALTO, PROXPU), 25277349Sgshapiro USLCOM_DEV(JABLOTRON, PC60B), 25390792Sgshapiro USLCOM_DEV(KAMSTRUP, OPTICALEYE), 25464562Sgshapiro USLCOM_DEV(KAMSTRUP, MBUS_250D), 25564562Sgshapiro USLCOM_DEV(LAKESHORE, 121), 25664562Sgshapiro USLCOM_DEV(LAKESHORE, 218A), 25764562Sgshapiro USLCOM_DEV(LAKESHORE, 219), 25864562Sgshapiro USLCOM_DEV(LAKESHORE, 233), 25964562Sgshapiro USLCOM_DEV(LAKESHORE, 235), 26064562Sgshapiro USLCOM_DEV(LAKESHORE, 335), 26164562Sgshapiro USLCOM_DEV(LAKESHORE, 336), 26264562Sgshapiro USLCOM_DEV(LAKESHORE, 350), 26364562Sgshapiro USLCOM_DEV(LAKESHORE, 371), 26464562Sgshapiro USLCOM_DEV(LAKESHORE, 411), 26564562Sgshapiro USLCOM_DEV(LAKESHORE, 425), 26664562Sgshapiro USLCOM_DEV(LAKESHORE, 455A), 267120256Sgshapiro USLCOM_DEV(LAKESHORE, 465), 26864562Sgshapiro USLCOM_DEV(LAKESHORE, 475A), 26964562Sgshapiro USLCOM_DEV(LAKESHORE, 625A), 27064562Sgshapiro USLCOM_DEV(LAKESHORE, 642A), 27164562Sgshapiro USLCOM_DEV(LAKESHORE, 648), 27264562Sgshapiro USLCOM_DEV(LAKESHORE, 737), 27364562Sgshapiro USLCOM_DEV(LAKESHORE, 776), 27464562Sgshapiro USLCOM_DEV(LINKINSTRUMENTS, MSO19), 27564562Sgshapiro USLCOM_DEV(LINKINSTRUMENTS, MSO28), 27664562Sgshapiro USLCOM_DEV(LINKINSTRUMENTS, MSO28_2), 27764562Sgshapiro USLCOM_DEV(MEI, CASHFLOW_SC), 27864562Sgshapiro USLCOM_DEV(MEI, S2000), 27964562Sgshapiro USLCOM_DEV(NETGEAR, M4100), 28064562Sgshapiro USLCOM_DEV(OWEN, AC4), 28164562Sgshapiro USLCOM_DEV(OWL, CM_160), 28264562Sgshapiro USLCOM_DEV(PHILIPS, ACE1001), 28366494Sgshapiro USLCOM_DEV(PLX, CA42), 28464562Sgshapiro USLCOM_DEV(RENESAS, RX610), 285203004Sgshapiro USLCOM_DEV(SEL, C662), 28664562Sgshapiro USLCOM_DEV(SILABS, AC_SERV_CAN), 28764562Sgshapiro USLCOM_DEV(SILABS, AC_SERV_CIS), 28864562Sgshapiro USLCOM_DEV(SILABS, AC_SERV_IBUS), 28964562Sgshapiro USLCOM_DEV(SILABS, AC_SERV_OBD), 29064562Sgshapiro USLCOM_DEV(SILABS, AEROCOMM), 29190792Sgshapiro USLCOM_DEV(SILABS, AMBER_AMB2560), 29266494Sgshapiro USLCOM_DEV(SILABS, ARGUSISP), 293125820Sgshapiro USLCOM_DEV(SILABS, ARKHAM_DS101_A), 29464562Sgshapiro USLCOM_DEV(SILABS, ARKHAM_DS101_M), 29564562Sgshapiro USLCOM_DEV(SILABS, ARYGON_MIFARE), 29664562Sgshapiro USLCOM_DEV(SILABS, AVIT_USB_TTL), 29764562Sgshapiro USLCOM_DEV(SILABS, B_G_H3000), 29864562Sgshapiro USLCOM_DEV(SILABS, BALLUFF_RFID), 29964562Sgshapiro USLCOM_DEV(SILABS, BEI_VCP), 30090792Sgshapiro USLCOM_DEV(SILABS, BSM7DUSB), 301168515Sgshapiro USLCOM_DEV(SILABS, BURNSIDE), 302168515Sgshapiro USLCOM_DEV(SILABS, C2_EDGE_MODEM), 303168515Sgshapiro USLCOM_DEV(SILABS, CP2102), 304168515Sgshapiro USLCOM_DEV(SILABS, CP210X_2), 305168515Sgshapiro USLCOM_DEV(SILABS, CP210X_3), 306168515Sgshapiro USLCOM_DEV(SILABS, CP210X_4), 307168515Sgshapiro USLCOM_DEV(SILABS, CRUMB128), 308168515Sgshapiro USLCOM_DEV(SILABS, CYGNAL), 309168515Sgshapiro USLCOM_DEV(SILABS, CYGNAL_DEBUG), 310168515Sgshapiro USLCOM_DEV(SILABS, CYGNAL_GPS), 311168515Sgshapiro USLCOM_DEV(SILABS, DEGREE), 312168515Sgshapiro USLCOM_DEV(SILABS, DEKTEK_DTAPLUS), 313168515Sgshapiro USLCOM_DEV(SILABS, EMS_C1007), 314168515Sgshapiro USLCOM_DEV(SILABS, HAMLINKUSB), 315168515Sgshapiro USLCOM_DEV(SILABS, HELICOM), 316168515Sgshapiro USLCOM_DEV(SILABS, IMS_USB_RS422), 317168515Sgshapiro USLCOM_DEV(SILABS, INFINITY_MIC), 318168515Sgshapiro USLCOM_DEV(SILABS, INGENI_ZIGBEE), 319168515Sgshapiro USLCOM_DEV(SILABS, INSYS_MODEM), 320168515Sgshapiro USLCOM_DEV(SILABS, IRZ_SG10), 321168515Sgshapiro USLCOM_DEV(SILABS, KYOCERA_GPS), 322168515Sgshapiro USLCOM_DEV(SILABS, LIPOWSKY_HARP), 323168515Sgshapiro USLCOM_DEV(SILABS, LIPOWSKY_JTAG), 324168515Sgshapiro USLCOM_DEV(SILABS, LIPOWSKY_LIN), 325168515Sgshapiro USLCOM_DEV(SILABS, MC35PU), 326168515Sgshapiro USLCOM_DEV(SILABS, MMB_ZIGBEE), 327168515Sgshapiro USLCOM_DEV(SILABS, MJS_TOSLINK), 328168515Sgshapiro USLCOM_DEV(SILABS, MSD_DASHHAWK), 329168515Sgshapiro USLCOM_DEV(SILABS, MULTIPLEX_RC), 330168515Sgshapiro USLCOM_DEV(SILABS, OPTRIS_MSPRO), 331168515Sgshapiro USLCOM_DEV(SILABS, POLOLU), 332168515Sgshapiro USLCOM_DEV(SILABS, PROCYON_AVS), 333168515Sgshapiro USLCOM_DEV(SILABS, SB_PARAMOUNT_ME), 334168515Sgshapiro USLCOM_DEV(SILABS, SUUNTO), 335110560Sgshapiro USLCOM_DEV(SILABS, TAMSMASTER), 336 USLCOM_DEV(SILABS, TELEGESIS_ETRX2), 337 USLCOM_DEV(SILABS, TRACIENT), 338 USLCOM_DEV(SILABS, TRAQMATE), 339 USLCOM_DEV(SILABS, USBCOUNT50), 340 USLCOM_DEV(SILABS, USBPULSE100), 341 USLCOM_DEV(SILABS, USBSCOPE50), 342 USLCOM_DEV(SILABS, USBWAVE12), 343 USLCOM_DEV(SILABS, V_PREON32), 344 USLCOM_DEV(SILABS, VSTABI), 345 USLCOM_DEV(SILABS, WAVIT), 346 USLCOM_DEV(SILABS, WMRBATT), 347 USLCOM_DEV(SILABS, WMRRIGBLASTER), 348 USLCOM_DEV(SILABS, WMRRIGTALK), 349 USLCOM_DEV(SILABS, ZEPHYR_BIO), 350 USLCOM_DEV(SILABS2, DCU11CLONE), 351 USLCOM_DEV(SILABS3, GPRS_MODEM), 352 USLCOM_DEV(SILABS4, 100EU_MODEM), 353 USLCOM_DEV(SYNTECH, CYPHERLAB100), 354 USLCOM_DEV(USI, MC60), 355 USLCOM_DEV(VAISALA, CABLE), 356 USLCOM_DEV(WAGO, SERVICECABLE), 357 USLCOM_DEV(WAVESENSE, JAZZ), 358 USLCOM_DEV(WESTMOUNTAIN, RIGBLASTER_ADVANTAGE), 359 USLCOM_DEV(WIENERPLEINBAUS, PL512), 360 USLCOM_DEV(WIENERPLEINBAUS, RCM), 361 USLCOM_DEV(WIENERPLEINBAUS, MPOD), 362 USLCOM_DEV(WIENERPLEINBAUS, CML), 363#undef USLCOM_DEV 364}; 365 366static device_method_t uslcom_methods[] = { 367 DEVMETHOD(device_probe, uslcom_probe), 368 DEVMETHOD(device_attach, uslcom_attach), 369 DEVMETHOD(device_detach, uslcom_detach), 370 DEVMETHOD_END 371}; 372 373static devclass_t uslcom_devclass; 374 375static driver_t uslcom_driver = { 376 .name = "uslcom", 377 .methods = uslcom_methods, 378 .size = sizeof(struct uslcom_softc), 379}; 380 381DRIVER_MODULE(uslcom, uhub, uslcom_driver, uslcom_devclass, NULL, 0); 382MODULE_DEPEND(uslcom, ucom, 1, 1, 1); 383MODULE_DEPEND(uslcom, usb, 1, 1, 1); 384MODULE_VERSION(uslcom, 1); 385USB_PNP_HOST_INFO(uslcom_devs); 386 387static void 388uslcom_watchdog(void *arg) 389{ 390 struct uslcom_softc *sc = arg; 391 392 mtx_assert(&sc->sc_mtx, MA_OWNED); 393 394 usbd_transfer_start(sc->sc_xfer[USLCOM_CTRL_DT_RD]); 395 396 usb_callout_reset(&sc->sc_watchdog, 397 hz / 4, &uslcom_watchdog, sc); 398} 399 400static int 401uslcom_probe(device_t dev) 402{ 403 struct usb_attach_arg *uaa = device_get_ivars(dev); 404 405 DPRINTFN(11, "\n"); 406 407 if (uaa->usb_mode != USB_MODE_HOST) { 408 return (ENXIO); 409 } 410 if (uaa->info.bConfigIndex != USLCOM_CONFIG_INDEX) { 411 return (ENXIO); 412 } 413 return (usbd_lookup_id_by_uaa(uslcom_devs, sizeof(uslcom_devs), uaa)); 414} 415 416static int 417uslcom_attach(device_t dev) 418{ 419 struct usb_attach_arg *uaa = device_get_ivars(dev); 420 struct uslcom_softc *sc = device_get_softc(dev); 421 int error; 422 423 DPRINTFN(11, "\n"); 424 425 device_set_usb_desc(dev); 426 mtx_init(&sc->sc_mtx, "uslcom", NULL, MTX_DEF); 427 ucom_ref(&sc->sc_super_ucom); 428 usb_callout_init_mtx(&sc->sc_watchdog, &sc->sc_mtx, 0); 429 430 sc->sc_udev = uaa->device; 431 /* use the interface number from the USB interface descriptor */ 432 sc->sc_iface_no = uaa->info.bIfaceNum; 433 434 error = usbd_transfer_setup(uaa->device, 435 &uaa->info.bIfaceIndex, sc->sc_xfer, uslcom_config, 436 USLCOM_N_TRANSFER, sc, &sc->sc_mtx); 437 if (error) { 438 DPRINTF("one or more missing USB endpoints, " 439 "error=%s\n", usbd_errstr(error)); 440 goto detach; 441 } 442 /* clear stall at first run */ 443 mtx_lock(&sc->sc_mtx); 444 usbd_xfer_set_stall(sc->sc_xfer[USLCOM_BULK_DT_WR]); 445 usbd_xfer_set_stall(sc->sc_xfer[USLCOM_BULK_DT_RD]); 446 mtx_unlock(&sc->sc_mtx); 447 448 sc->sc_partnum = uslcom_get_partnum(sc); 449 450 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc, 451 &uslcom_callback, &sc->sc_mtx); 452 if (error) { 453 goto detach; 454 } 455 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev); 456 457 return (0); 458 459detach: 460 uslcom_detach(dev); 461 return (ENXIO); 462} 463 464static int 465uslcom_detach(device_t dev) 466{ 467 struct uslcom_softc *sc = device_get_softc(dev); 468 469 DPRINTF("sc=%p\n", sc); 470 471 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom); 472 usbd_transfer_unsetup(sc->sc_xfer, USLCOM_N_TRANSFER); 473 474 usb_callout_drain(&sc->sc_watchdog); 475 476 device_claim_softc(dev); 477 478 uslcom_free_softc(sc); 479 480 return (0); 481} 482 483UCOM_UNLOAD_DRAIN(uslcom); 484 485static void 486uslcom_free_softc(struct uslcom_softc *sc) 487{ 488 if (ucom_unref(&sc->sc_super_ucom)) { 489 mtx_destroy(&sc->sc_mtx); 490 device_free_softc(sc); 491 } 492} 493 494static void 495uslcom_free(struct ucom_softc *ucom) 496{ 497 uslcom_free_softc(ucom->sc_parent); 498} 499 500static void 501uslcom_open(struct ucom_softc *ucom) 502{ 503 struct uslcom_softc *sc = ucom->sc_parent; 504 struct usb_device_request req; 505 506 req.bmRequestType = USLCOM_WRITE; 507 req.bRequest = USLCOM_IFC_ENABLE; 508 USETW(req.wValue, USLCOM_IFC_ENABLE_EN); 509 USETW(req.wIndex, sc->sc_iface_no); 510 USETW(req.wLength, 0); 511 512 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 513 &req, NULL, 0, 1000)) { 514 DPRINTF("UART enable failed (ignored)\n"); 515 } 516 517 /* start polling status */ 518 uslcom_watchdog(sc); 519} 520 521static void 522uslcom_close(struct ucom_softc *ucom) 523{ 524 struct uslcom_softc *sc = ucom->sc_parent; 525 struct usb_device_request req; 526 527 /* stop polling status */ 528 usb_callout_stop(&sc->sc_watchdog); 529 530 req.bmRequestType = USLCOM_WRITE; 531 req.bRequest = USLCOM_IFC_ENABLE; 532 USETW(req.wValue, USLCOM_IFC_ENABLE_DIS); 533 USETW(req.wIndex, sc->sc_iface_no); 534 USETW(req.wLength, 0); 535 536 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 537 &req, NULL, 0, 1000)) { 538 DPRINTF("UART disable failed (ignored)\n"); 539 } 540} 541 542static uint8_t 543uslcom_get_partnum(struct uslcom_softc *sc) 544{ 545 struct usb_device_request req; 546 uint8_t partnum; 547 548 /* Find specific chip type */ 549 partnum = 0; 550 req.bmRequestType = USLCOM_READ; 551 req.bRequest = USLCOM_VENDOR_SPECIFIC; 552 USETW(req.wValue, USLCOM_GET_PARTNUM); 553 USETW(req.wIndex, sc->sc_iface_no); 554 USETW(req.wLength, sizeof(partnum)); 555 556 if (usbd_do_request_flags(sc->sc_udev, NULL, 557 &req, &partnum, 0, NULL, 1000)) { 558 DPRINTF("GET_PARTNUM failed\n"); 559 } 560 561 return(partnum); 562} 563 564static void 565uslcom_set_dtr(struct ucom_softc *ucom, uint8_t onoff) 566{ 567 struct uslcom_softc *sc = ucom->sc_parent; 568 struct usb_device_request req; 569 uint16_t ctl; 570 571 DPRINTF("onoff = %d\n", onoff); 572 573 ctl = onoff ? USLCOM_MHS_DTR_ON : 0; 574 ctl |= USLCOM_MHS_DTR_SET; 575 576 req.bmRequestType = USLCOM_WRITE; 577 req.bRequest = USLCOM_SET_MHS; 578 USETW(req.wValue, ctl); 579 USETW(req.wIndex, sc->sc_iface_no); 580 USETW(req.wLength, 0); 581 582 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 583 &req, NULL, 0, 1000)) { 584 DPRINTF("Setting DTR failed (ignored)\n"); 585 } 586} 587 588static void 589uslcom_set_rts(struct ucom_softc *ucom, uint8_t onoff) 590{ 591 struct uslcom_softc *sc = ucom->sc_parent; 592 struct usb_device_request req; 593 uint16_t ctl; 594 595 DPRINTF("onoff = %d\n", onoff); 596 597 ctl = onoff ? USLCOM_MHS_RTS_ON : 0; 598 ctl |= USLCOM_MHS_RTS_SET; 599 600 req.bmRequestType = USLCOM_WRITE; 601 req.bRequest = USLCOM_SET_MHS; 602 USETW(req.wValue, ctl); 603 USETW(req.wIndex, sc->sc_iface_no); 604 USETW(req.wLength, 0); 605 606 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 607 &req, NULL, 0, 1000)) { 608 DPRINTF("Setting DTR failed (ignored)\n"); 609 } 610} 611 612static int 613uslcom_pre_param(struct ucom_softc *ucom, struct termios *t) 614{ 615 if (t->c_ospeed <= 0 || t->c_ospeed > 921600) 616 return (EINVAL); 617 return (0); 618} 619 620static void 621uslcom_param(struct ucom_softc *ucom, struct termios *t) 622{ 623 struct uslcom_softc *sc = ucom->sc_parent; 624 struct usb_device_request req; 625 uint32_t baudrate, flowctrl[4]; 626 uint16_t data; 627 628 DPRINTF("\n"); 629 630 baudrate = t->c_ospeed; 631 req.bmRequestType = USLCOM_WRITE; 632 req.bRequest = USLCOM_SET_BAUDRATE; 633 USETW(req.wValue, 0); 634 USETW(req.wIndex, sc->sc_iface_no); 635 USETW(req.wLength, sizeof(baudrate)); 636 637 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 638 &req, &baudrate, 0, 1000)) { 639 DPRINTF("Set baudrate failed (ignored)\n"); 640 } 641 642 if (t->c_cflag & CSTOPB) 643 data = USLCOM_STOP_BITS_2; 644 else 645 data = USLCOM_STOP_BITS_1; 646 if (t->c_cflag & PARENB) { 647 if (t->c_cflag & PARODD) 648 data |= USLCOM_PARITY_ODD; 649 else 650 data |= USLCOM_PARITY_EVEN; 651 } else 652 data |= USLCOM_PARITY_NONE; 653 switch (t->c_cflag & CSIZE) { 654 case CS5: 655 data |= USLCOM_SET_DATA_BITS(5); 656 break; 657 case CS6: 658 data |= USLCOM_SET_DATA_BITS(6); 659 break; 660 case CS7: 661 data |= USLCOM_SET_DATA_BITS(7); 662 break; 663 case CS8: 664 data |= USLCOM_SET_DATA_BITS(8); 665 break; 666 } 667 668 req.bmRequestType = USLCOM_WRITE; 669 req.bRequest = USLCOM_SET_LINE_CTL; 670 USETW(req.wValue, data); 671 USETW(req.wIndex, sc->sc_iface_no); 672 USETW(req.wLength, 0); 673 674 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 675 &req, NULL, 0, 1000)) { 676 DPRINTF("Set format failed (ignored)\n"); 677 } 678 679 if (t->c_cflag & CRTSCTS) { 680 flowctrl[0] = htole32(USLCOM_FLOW_DTR_ON | USLCOM_FLOW_CTS_HS); 681 flowctrl[1] = htole32(USLCOM_FLOW_RTS_HS); 682 } else { 683 flowctrl[0] = htole32(USLCOM_FLOW_DTR_ON); 684 flowctrl[1] = htole32(USLCOM_FLOW_RTS_ON); 685 } 686 flowctrl[2] = 0; 687 flowctrl[3] = 0; 688 req.bmRequestType = USLCOM_WRITE; 689 req.bRequest = USLCOM_SET_FLOW; 690 USETW(req.wValue, 0); 691 USETW(req.wIndex, sc->sc_iface_no); 692 USETW(req.wLength, sizeof(flowctrl)); 693 694 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 695 &req, flowctrl, 0, 1000)) { 696 DPRINTF("Set flowcontrol failed (ignored)\n"); 697 } 698} 699 700static void 701uslcom_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr) 702{ 703 struct uslcom_softc *sc = ucom->sc_parent; 704 705 DPRINTF("\n"); 706 707 *lsr = sc->sc_lsr; 708 *msr = sc->sc_msr; 709} 710 711static void 712uslcom_set_break(struct ucom_softc *ucom, uint8_t onoff) 713{ 714 struct uslcom_softc *sc = ucom->sc_parent; 715 struct usb_device_request req; 716 uint16_t brk = onoff ? USLCOM_SET_BREAK_ON : USLCOM_SET_BREAK_OFF; 717 718 req.bmRequestType = USLCOM_WRITE; 719 req.bRequest = USLCOM_SET_BREAK; 720 USETW(req.wValue, brk); 721 USETW(req.wIndex, sc->sc_iface_no); 722 USETW(req.wLength, 0); 723 724 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 725 &req, NULL, 0, 1000)) { 726 DPRINTF("Set BREAK failed (ignored)\n"); 727 } 728} 729 730static int 731uslcom_ioctl(struct ucom_softc *ucom, uint32_t cmd, caddr_t data, 732 int flag, struct thread *td) 733{ 734 struct uslcom_softc *sc = ucom->sc_parent; 735 struct usb_device_request req; 736 int error = 0; 737 uint8_t latch; 738 739 DPRINTF("cmd=0x%08x\n", cmd); 740 741 switch (cmd) { 742 case USB_GET_GPIO: 743 if (sc->sc_partnum < USLCOM_PARTNUM_CP2103) { 744 error = ENODEV; 745 break; 746 } 747 req.bmRequestType = USLCOM_READ; 748 req.bRequest = USLCOM_VENDOR_SPECIFIC; 749 USETW(req.wValue, USLCOM_READ_LATCH); 750 USETW(req.wIndex, sc->sc_iface_no); 751 USETW(req.wLength, sizeof(latch)); 752 753 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 754 &req, &latch, 0, 1000)) { 755 DPRINTF("Get LATCH failed\n"); 756 error = EIO; 757 } 758 *(int *)data = latch; 759 break; 760 761 case USB_SET_GPIO: 762 if (sc->sc_partnum < USLCOM_PARTNUM_CP2103) 763 error = ENODEV; 764 else if ((sc->sc_partnum == USLCOM_PARTNUM_CP2103) || 765 (sc->sc_partnum == USLCOM_PARTNUM_CP2104)) { 766 req.bmRequestType = USLCOM_WRITE; 767 req.bRequest = USLCOM_VENDOR_SPECIFIC; 768 USETW(req.wValue, USLCOM_WRITE_LATCH); 769 USETW(req.wIndex, (*(int *)data)); 770 USETW(req.wLength, 0); 771 772 if (ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom, 773 &req, NULL, 0, 1000)) { 774 DPRINTF("Set LATCH failed\n"); 775 error = EIO; 776 } 777 } else 778 error = ENODEV; /* Not yet */ 779 break; 780 781 default: 782 DPRINTF("Unknown IOCTL\n"); 783 error = ENOIOCTL; 784 break; 785 } 786 return (error); 787} 788 789static void 790uslcom_write_callback(struct usb_xfer *xfer, usb_error_t error) 791{ 792 struct uslcom_softc *sc = usbd_xfer_softc(xfer); 793 struct usb_page_cache *pc; 794 uint32_t actlen; 795 796 switch (USB_GET_STATE(xfer)) { 797 case USB_ST_SETUP: 798 case USB_ST_TRANSFERRED: 799tr_setup: 800 pc = usbd_xfer_get_frame(xfer, 0); 801 if (ucom_get_data(&sc->sc_ucom, pc, 0, 802 USLCOM_BULK_BUF_SIZE, &actlen)) { 803 804 DPRINTF("actlen = %d\n", actlen); 805 806 usbd_xfer_set_frame_len(xfer, 0, actlen); 807 usbd_transfer_submit(xfer); 808 } 809 return; 810 811 default: /* Error */ 812 if (error != USB_ERR_CANCELLED) { 813 /* try to clear stall first */ 814 usbd_xfer_set_stall(xfer); 815 goto tr_setup; 816 } 817 return; 818 } 819} 820 821static void 822uslcom_read_callback(struct usb_xfer *xfer, usb_error_t error) 823{ 824 struct uslcom_softc *sc = usbd_xfer_softc(xfer); 825 struct usb_page_cache *pc; 826 int actlen; 827 828 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 829 830 switch (USB_GET_STATE(xfer)) { 831 case USB_ST_TRANSFERRED: 832 pc = usbd_xfer_get_frame(xfer, 0); 833 ucom_put_data(&sc->sc_ucom, pc, 0, actlen); 834 835 case USB_ST_SETUP: 836tr_setup: 837 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 838 usbd_transfer_submit(xfer); 839 return; 840 841 default: /* Error */ 842 if (error != USB_ERR_CANCELLED) { 843 /* try to clear stall first */ 844 usbd_xfer_set_stall(xfer); 845 goto tr_setup; 846 } 847 return; 848 } 849} 850 851static void 852uslcom_control_callback(struct usb_xfer *xfer, usb_error_t error) 853{ 854 struct uslcom_softc *sc = usbd_xfer_softc(xfer); 855 struct usb_page_cache *pc; 856 struct usb_device_request req; 857 uint8_t msr = 0; 858 uint8_t buf; 859 860 switch (USB_GET_STATE(xfer)) { 861 case USB_ST_TRANSFERRED: 862 pc = usbd_xfer_get_frame(xfer, 1); 863 usbd_copy_out(pc, 0, &buf, sizeof(buf)); 864 if (buf & USLCOM_MHS_CTS) 865 msr |= SER_CTS; 866 if (buf & USLCOM_MHS_DSR) 867 msr |= SER_DSR; 868 if (buf & USLCOM_MHS_RI) 869 msr |= SER_RI; 870 if (buf & USLCOM_MHS_DCD) 871 msr |= SER_DCD; 872 873 if (msr != sc->sc_msr) { 874 DPRINTF("status change msr=0x%02x " 875 "(was 0x%02x)\n", msr, sc->sc_msr); 876 sc->sc_msr = msr; 877 ucom_status_change(&sc->sc_ucom); 878 } 879 break; 880 881 case USB_ST_SETUP: 882 req.bmRequestType = USLCOM_READ; 883 req.bRequest = USLCOM_GET_MDMSTS; 884 USETW(req.wValue, 0); 885 USETW(req.wIndex, sc->sc_iface_no); 886 USETW(req.wLength, sizeof(buf)); 887 888 usbd_xfer_set_frames(xfer, 2); 889 usbd_xfer_set_frame_len(xfer, 0, sizeof(req)); 890 usbd_xfer_set_frame_len(xfer, 1, sizeof(buf)); 891 892 pc = usbd_xfer_get_frame(xfer, 0); 893 usbd_copy_in(pc, 0, &req, sizeof(req)); 894 usbd_transfer_submit(xfer); 895 break; 896 897 default: /* error */ 898 if (error != USB_ERR_CANCELLED) 899 DPRINTF("error=%s\n", usbd_errstr(error)); 900 break; 901 } 902} 903 904static void 905uslcom_start_read(struct ucom_softc *ucom) 906{ 907 struct uslcom_softc *sc = ucom->sc_parent; 908 909 /* start read endpoint */ 910 usbd_transfer_start(sc->sc_xfer[USLCOM_BULK_DT_RD]); 911} 912 913static void 914uslcom_stop_read(struct ucom_softc *ucom) 915{ 916 struct uslcom_softc *sc = ucom->sc_parent; 917 918 /* stop read endpoint */ 919 usbd_transfer_stop(sc->sc_xfer[USLCOM_BULK_DT_RD]); 920} 921 922static void 923uslcom_start_write(struct ucom_softc *ucom) 924{ 925 struct uslcom_softc *sc = ucom->sc_parent; 926 927 usbd_transfer_start(sc->sc_xfer[USLCOM_BULK_DT_WR]); 928} 929 930static void 931uslcom_stop_write(struct ucom_softc *ucom) 932{ 933 struct uslcom_softc *sc = ucom->sc_parent; 934 935 usbd_transfer_stop(sc->sc_xfer[USLCOM_BULK_DT_WR]); 936} 937 938static void 939uslcom_poll(struct ucom_softc *ucom) 940{ 941 struct uslcom_softc *sc = ucom->sc_parent; 942 usbd_transfer_poll(sc->sc_xfer, USLCOM_N_TRANSFER); 943} 944