1228060Sbapt/* $NetBSD: uchcom.c,v 1.1 2007/09/03 17:57:37 tshiozak Exp $ */ 2228060Sbapt 3228060Sbapt/*- 4228060Sbapt * SPDX-License-Identifier: BSD-2-Clause 5228060Sbapt * 6228060Sbapt * Copyright (c) 2007, Takanori Watanabe 7228060Sbapt * All rights reserved. 8228060Sbapt * 9228060Sbapt * Redistribution and use in source and binary forms, with or without 10228060Sbapt * modification, are permitted provided that the following conditions 11228060Sbapt * are met: 12228060Sbapt * 1. Redistributions of source code must retain the above copyright 13228060Sbapt * notice, this list of conditions and the following disclaimer. 14228060Sbapt * 2. Redistributions in binary form must reproduce the above copyright 15228060Sbapt * notice, this list of conditions and the following disclaimer in the 16228060Sbapt * documentation and/or other materials provided with the distribution. 17228060Sbapt * 18228060Sbapt * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19228060Sbapt * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20228060Sbapt * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21228060Sbapt * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22228060Sbapt * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23228060Sbapt * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24228060Sbapt * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25228060Sbapt * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26228060Sbapt * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27228060Sbapt * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28228060Sbapt * SUCH DAMAGE. 29228060Sbapt */ 30228060Sbapt 31228060Sbapt/* 32228060Sbapt * Copyright (c) 2007 The NetBSD Foundation, Inc. 33228060Sbapt * All rights reserved. 34228060Sbapt * 35228060Sbapt * This code is derived from software contributed to The NetBSD Foundation 36228060Sbapt * by Takuya SHIOZAKI (tshiozak@netbsd.org). 37228060Sbapt * 38228060Sbapt * Redistribution and use in source and binary forms, with or without 39228060Sbapt * modification, are permitted provided that the following conditions 40228060Sbapt * are met: 41228060Sbapt * 1. Redistributions of source code must retain the above copyright 42228060Sbapt * notice, this list of conditions and the following disclaimer. 43228060Sbapt * 2. Redistributions in binary form must reproduce the above copyright 44228060Sbapt * notice, this list of conditions and the following disclaimer in the 45228060Sbapt * documentation and/or other materials provided with the distribution. 46228060Sbapt * 47228060Sbapt * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 48228060Sbapt * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 49228060Sbapt * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 50228060Sbapt * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 51228060Sbapt * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 52228060Sbapt * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 53228060Sbapt * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 54228060Sbapt * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 55228060Sbapt * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 56228060Sbapt * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 57228060Sbapt * POSSIBILITY OF SUCH DAMAGE. 58228060Sbapt */ 59228060Sbapt 60228060Sbapt#include <sys/cdefs.h> 61228060Sbapt/* 62228060Sbapt * Driver for WinChipHead CH341/340, the worst USB-serial chip in the 63228060Sbapt * world. 64228060Sbapt */ 65228060Sbapt 66228060Sbapt#include <sys/stdint.h> 67228060Sbapt#include <sys/stddef.h> 68228060Sbapt#include <sys/param.h> 69228060Sbapt#include <sys/queue.h> 70228060Sbapt#include <sys/types.h> 71228060Sbapt#include <sys/systm.h> 72228060Sbapt#include <sys/kernel.h> 73228060Sbapt#include <sys/bus.h> 74228060Sbapt#include <sys/module.h> 75228060Sbapt#include <sys/lock.h> 76228060Sbapt#include <sys/mutex.h> 77228060Sbapt#include <sys/condvar.h> 78228060Sbapt#include <sys/sysctl.h> 79228060Sbapt#include <sys/sx.h> 80228060Sbapt#include <sys/unistd.h> 81228060Sbapt#include <sys/callout.h> 82228060Sbapt#include <sys/malloc.h> 83228060Sbapt#include <sys/priv.h> 84228060Sbapt 85228060Sbapt#include <dev/usb/usb.h> 86228060Sbapt#include <dev/usb/usbdi.h> 87228060Sbapt#include <dev/usb/usbdi_util.h> 88228060Sbapt#include "usbdevs.h" 89228060Sbapt 90228060Sbapt#define USB_DEBUG_VAR uchcom_debug 91228060Sbapt#include <dev/usb/usb_debug.h> 92228060Sbapt#include <dev/usb/usb_process.h> 93228060Sbapt 94228060Sbapt#include <dev/usb/serial/usb_serial.h> 95228060Sbapt 96228060Sbapt#ifdef USB_DEBUG 97228060Sbaptstatic int uchcom_debug = 0; 98228060Sbapt 99228060Sbaptstatic SYSCTL_NODE(_hw_usb, OID_AUTO, uchcom, CTLFLAG_RW | CTLFLAG_MPSAFE, 0, 100228060Sbapt "USB uchcom"); 101228060SbaptSYSCTL_INT(_hw_usb_uchcom, OID_AUTO, debug, CTLFLAG_RWTUN, 102228060Sbapt &uchcom_debug, 0, "uchcom debug level"); 103228060Sbapt#endif 104228060Sbapt 105228060Sbapt#define UCHCOM_IFACE_INDEX 0 106228060Sbapt#define UCHCOM_CONFIG_INDEX 0 107228060Sbapt 108228060Sbapt#define UCHCOM_REV_CH340 0x0250 109228060Sbapt#define UCHCOM_INPUT_BUF_SIZE 8 110228060Sbapt 111228060Sbapt#define UCHCOM_REQ_GET_VERSION 0x5F 112228060Sbapt#define UCHCOM_REQ_READ_REG 0x95 113228060Sbapt#define UCHCOM_REQ_WRITE_REG 0x9A 114228060Sbapt#define UCHCOM_REQ_RESET 0xA1 115228060Sbapt#define UCHCOM_REQ_SET_DTRRTS 0xA4 116228060Sbapt 117228060Sbapt#define UCHCOM_REG_STAT1 0x06 118228060Sbapt#define UCHCOM_REG_STAT2 0x07 119228060Sbapt#define UCHCOM_REG_BPS_PRE 0x12 120228060Sbapt#define UCHCOM_REG_BPS_DIV 0x13 121228060Sbapt#define UCHCOM_REG_BPS_MOD 0x14 122228060Sbapt#define UCHCOM_REG_BPS_PAD 0x0F 123228060Sbapt#define UCHCOM_REG_BREAK1 0x05 124228060Sbapt#define UCHCOM_REG_LCR1 0x18 125228060Sbapt#define UCHCOM_REG_LCR2 0x25 126228060Sbapt 127228060Sbapt#define UCHCOM_VER_20 0x20 128228060Sbapt#define UCHCOM_VER_30 0x30 129228060Sbapt 130228060Sbapt#define UCHCOM_BASE_UNKNOWN 0 131228060Sbapt#define UCHCOM_BPS_MOD_BASE 20000000 132228060Sbapt#define UCHCOM_BPS_MOD_BASE_OFS 1100 133228060Sbapt 134228060Sbapt#define UCHCOM_DTR_MASK 0x20 135228060Sbapt#define UCHCOM_RTS_MASK 0x40 136228060Sbapt 137228060Sbapt#define UCHCOM_BRK_MASK 0x01 138228060Sbapt 139228060Sbapt#define UCHCOM_LCR1_MASK 0xAF 140228060Sbapt#define UCHCOM_LCR2_MASK 0x07 141228060Sbapt#define UCHCOM_LCR1_RX 0x80 142228060Sbapt#define UCHCOM_LCR1_TX 0x40 143228060Sbapt#define UCHCOM_LCR1_PARENB 0x08 144228060Sbapt#define UCHCOM_LCR1_CS8 0x03 145228060Sbapt#define UCHCOM_LCR2_PAREVEN 0x07 146228060Sbapt#define UCHCOM_LCR2_PARODD 0x06 147228060Sbapt#define UCHCOM_LCR2_PARMARK 0x05 148228060Sbapt#define UCHCOM_LCR2_PARSPACE 0x04 149228060Sbapt 150228060Sbapt#define UCHCOM_INTR_STAT1 0x02 151228060Sbapt#define UCHCOM_INTR_STAT2 0x03 152228060Sbapt#define UCHCOM_INTR_LEAST 4 153228060Sbapt 154228060Sbapt#define UCHCOM_BULK_BUF_SIZE 1024 /* bytes */ 155228060Sbapt 156228060Sbaptenum { 157228060Sbapt UCHCOM_BULK_DT_WR, 158228060Sbapt UCHCOM_BULK_DT_RD, 159228060Sbapt UCHCOM_INTR_DT_RD, 160228060Sbapt UCHCOM_N_TRANSFER, 161228060Sbapt}; 162228060Sbapt 163228060Sbaptstruct uchcom_softc { 164228060Sbapt struct ucom_super_softc sc_super_ucom; 165228060Sbapt struct ucom_softc sc_ucom; 166228060Sbapt 167228060Sbapt struct usb_xfer *sc_xfer[UCHCOM_N_TRANSFER]; 168228060Sbapt struct usb_device *sc_udev; 169228060Sbapt struct mtx sc_mtx; 170228060Sbapt 171228060Sbapt uint8_t sc_dtr; /* local copy */ 172228060Sbapt uint8_t sc_rts; /* local copy */ 173228060Sbapt uint8_t sc_version; 174228060Sbapt uint8_t sc_msr; 175228060Sbapt uint8_t sc_lsr; /* local status register */ 176228060Sbapt}; 177228060Sbapt 178228060Sbaptstruct uchcom_divider { 179228060Sbapt uint8_t dv_prescaler; 180228060Sbapt uint8_t dv_div; 181228060Sbapt uint8_t dv_mod; 182228060Sbapt}; 183228060Sbapt 184228060Sbaptstruct uchcom_divider_record { 185228060Sbapt uint32_t dvr_high; 186228060Sbapt uint32_t dvr_low; 187228060Sbapt uint32_t dvr_base_clock; 188228060Sbapt struct uchcom_divider dvr_divider; 189228060Sbapt}; 190228060Sbapt 191228060Sbaptstatic const struct uchcom_divider_record dividers[] = 192228060Sbapt{ 193228060Sbapt {307200, 307200, UCHCOM_BASE_UNKNOWN, {7, 0xD9, 0}}, 194228060Sbapt {921600, 921600, UCHCOM_BASE_UNKNOWN, {7, 0xF3, 0}}, 195228060Sbapt {2999999, 23530, 6000000, {3, 0, 0}}, 196228060Sbapt {23529, 2942, 750000, {2, 0, 0}}, 197228060Sbapt {2941, 368, 93750, {1, 0, 0}}, 198228060Sbapt {367, 1, 11719, {0, 0, 0}}, 199228060Sbapt}; 200228060Sbapt 201228060Sbapt#define NUM_DIVIDERS nitems(dividers) 202228060Sbapt 203228060Sbaptstatic const STRUCT_USB_HOST_ID uchcom_devs[] = { 204228060Sbapt {USB_VPI(USB_VENDOR_WCH, USB_PRODUCT_WCH_CH341SER, 0)}, 205228060Sbapt {USB_VPI(USB_VENDOR_WCH2, USB_PRODUCT_WCH2_CH341SER, 0)}, 206228060Sbapt {USB_VPI(USB_VENDOR_WCH2, USB_PRODUCT_WCH2_CH341SER_2, 0)}, 207228060Sbapt {USB_VPI(USB_VENDOR_WCH2, USB_PRODUCT_WCH2_CH341SER_3, 0)}, 208228060Sbapt}; 209228060Sbapt 210228060Sbapt/* protypes */ 211228060Sbapt 212228060Sbaptstatic void uchcom_free(struct ucom_softc *); 213228060Sbaptstatic int uchcom_pre_param(struct ucom_softc *, struct termios *); 214228060Sbaptstatic void uchcom_cfg_get_status(struct ucom_softc *, uint8_t *, 215228060Sbapt uint8_t *); 216228060Sbaptstatic void uchcom_cfg_open(struct ucom_softc *ucom); 217228060Sbaptstatic void uchcom_cfg_param(struct ucom_softc *, struct termios *); 218228060Sbaptstatic void uchcom_cfg_set_break(struct ucom_softc *, uint8_t); 219228060Sbaptstatic void uchcom_cfg_set_dtr(struct ucom_softc *, uint8_t); 220228060Sbaptstatic void uchcom_cfg_set_rts(struct ucom_softc *, uint8_t); 221228060Sbaptstatic void uchcom_start_read(struct ucom_softc *); 222228060Sbaptstatic void uchcom_start_write(struct ucom_softc *); 223228060Sbaptstatic void uchcom_stop_read(struct ucom_softc *); 224228060Sbaptstatic void uchcom_stop_write(struct ucom_softc *); 225228060Sbaptstatic void uchcom_update_version(struct uchcom_softc *); 226228060Sbaptstatic void uchcom_convert_status(struct uchcom_softc *, uint8_t); 227228060Sbaptstatic void uchcom_update_status(struct uchcom_softc *); 228228060Sbaptstatic void uchcom_set_dtr_rts(struct uchcom_softc *); 229228060Sbaptstatic int uchcom_calc_divider_settings(struct uchcom_divider *, uint32_t); 230228060Sbaptstatic void uchcom_set_baudrate(struct uchcom_softc *, uint32_t); 231228060Sbaptstatic void uchcom_poll(struct ucom_softc *ucom); 232228060Sbapt 233228060Sbaptstatic device_probe_t uchcom_probe; 234228060Sbaptstatic device_attach_t uchcom_attach; 235228060Sbaptstatic device_detach_t uchcom_detach; 236228060Sbaptstatic void uchcom_free_softc(struct uchcom_softc *); 237228060Sbapt 238228060Sbaptstatic usb_callback_t uchcom_intr_callback; 239228060Sbaptstatic usb_callback_t uchcom_write_callback; 240228060Sbaptstatic usb_callback_t uchcom_read_callback; 241228060Sbapt 242228060Sbaptstatic const struct usb_config uchcom_config_data[UCHCOM_N_TRANSFER] = { 243228060Sbapt [UCHCOM_BULK_DT_WR] = { 244228060Sbapt .type = UE_BULK, 245228060Sbapt .endpoint = UE_ADDR_ANY, 246228060Sbapt .direction = UE_DIR_OUT, 247228060Sbapt .bufsize = UCHCOM_BULK_BUF_SIZE, 248228060Sbapt .flags = {.pipe_bof = 1,.force_short_xfer = 1,}, 249228060Sbapt .callback = &uchcom_write_callback, 250228060Sbapt }, 251228060Sbapt 252228060Sbapt [UCHCOM_BULK_DT_RD] = { 253228060Sbapt .type = UE_BULK, 254228060Sbapt .endpoint = UE_ADDR_ANY, 255228060Sbapt .direction = UE_DIR_IN, 256228060Sbapt .bufsize = UCHCOM_BULK_BUF_SIZE, 257228060Sbapt .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 258228060Sbapt .callback = &uchcom_read_callback, 259228060Sbapt }, 260228060Sbapt 261228060Sbapt [UCHCOM_INTR_DT_RD] = { 262228060Sbapt .type = UE_INTERRUPT, 263228060Sbapt .endpoint = UE_ADDR_ANY, 264228060Sbapt .direction = UE_DIR_IN, 265228060Sbapt .flags = {.pipe_bof = 1,.short_xfer_ok = 1,}, 266228060Sbapt .bufsize = 0, /* use wMaxPacketSize */ 267228060Sbapt .callback = &uchcom_intr_callback, 268228060Sbapt }, 269228060Sbapt}; 270228060Sbapt 271228060Sbaptstatic struct ucom_callback uchcom_callback = { 272228060Sbapt .ucom_cfg_get_status = &uchcom_cfg_get_status, 273228060Sbapt .ucom_cfg_set_dtr = &uchcom_cfg_set_dtr, 274228060Sbapt .ucom_cfg_set_rts = &uchcom_cfg_set_rts, 275228060Sbapt .ucom_cfg_set_break = &uchcom_cfg_set_break, 276228060Sbapt .ucom_cfg_open = &uchcom_cfg_open, 277228060Sbapt .ucom_cfg_param = &uchcom_cfg_param, 278228060Sbapt .ucom_pre_param = &uchcom_pre_param, 279228060Sbapt .ucom_start_read = &uchcom_start_read, 280228060Sbapt .ucom_stop_read = &uchcom_stop_read, 281228060Sbapt .ucom_start_write = &uchcom_start_write, 282228060Sbapt .ucom_stop_write = &uchcom_stop_write, 283228060Sbapt .ucom_poll = &uchcom_poll, 284228060Sbapt .ucom_free = &uchcom_free, 285228060Sbapt}; 286 287/* ---------------------------------------------------------------------- 288 * driver entry points 289 */ 290 291static int 292uchcom_probe(device_t dev) 293{ 294 struct usb_attach_arg *uaa = device_get_ivars(dev); 295 296 DPRINTFN(11, "\n"); 297 298 if (uaa->usb_mode != USB_MODE_HOST) { 299 return (ENXIO); 300 } 301 if (uaa->info.bConfigIndex != UCHCOM_CONFIG_INDEX) { 302 return (ENXIO); 303 } 304 if (uaa->info.bIfaceIndex != UCHCOM_IFACE_INDEX) { 305 return (ENXIO); 306 } 307 return (usbd_lookup_id_by_uaa(uchcom_devs, sizeof(uchcom_devs), uaa)); 308} 309 310static int 311uchcom_attach(device_t dev) 312{ 313 struct uchcom_softc *sc = device_get_softc(dev); 314 struct usb_attach_arg *uaa = device_get_ivars(dev); 315 int error; 316 uint8_t iface_index; 317 318 DPRINTFN(11, "\n"); 319 320 device_set_usb_desc(dev); 321 mtx_init(&sc->sc_mtx, "uchcom", NULL, MTX_DEF); 322 ucom_ref(&sc->sc_super_ucom); 323 324 sc->sc_udev = uaa->device; 325 326 switch (uaa->info.idProduct) { 327 case USB_PRODUCT_WCH2_CH341SER: 328 device_printf(dev, "CH340 detected\n"); 329 break; 330 case USB_PRODUCT_WCH2_CH341SER_2: 331 case USB_PRODUCT_WCH2_CH341SER_3: 332 device_printf(dev, "CH341 detected\n"); 333 break; 334 default: 335 device_printf(dev, "New CH340/CH341 product 0x%04x detected\n", 336 uaa->info.idProduct); 337 break; 338 } 339 340 iface_index = UCHCOM_IFACE_INDEX; 341 error = usbd_transfer_setup(uaa->device, 342 &iface_index, sc->sc_xfer, uchcom_config_data, 343 UCHCOM_N_TRANSFER, sc, &sc->sc_mtx); 344 345 if (error) { 346 DPRINTF("one or more missing USB endpoints, " 347 "error=%s\n", usbd_errstr(error)); 348 goto detach; 349 } 350 351 /* clear stall at first run */ 352 mtx_lock(&sc->sc_mtx); 353 usbd_xfer_set_stall(sc->sc_xfer[UCHCOM_BULK_DT_WR]); 354 usbd_xfer_set_stall(sc->sc_xfer[UCHCOM_BULK_DT_RD]); 355 mtx_unlock(&sc->sc_mtx); 356 357 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc, 358 &uchcom_callback, &sc->sc_mtx); 359 if (error) { 360 goto detach; 361 } 362 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev); 363 364 return (0); 365 366detach: 367 uchcom_detach(dev); 368 return (ENXIO); 369} 370 371static int 372uchcom_detach(device_t dev) 373{ 374 struct uchcom_softc *sc = device_get_softc(dev); 375 376 DPRINTFN(11, "\n"); 377 378 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom); 379 usbd_transfer_unsetup(sc->sc_xfer, UCHCOM_N_TRANSFER); 380 381 device_claim_softc(dev); 382 383 uchcom_free_softc(sc); 384 385 return (0); 386} 387 388UCOM_UNLOAD_DRAIN(uchcom); 389 390static void 391uchcom_free_softc(struct uchcom_softc *sc) 392{ 393 if (ucom_unref(&sc->sc_super_ucom)) { 394 mtx_destroy(&sc->sc_mtx); 395 device_free_softc(sc); 396 } 397} 398 399static void 400uchcom_free(struct ucom_softc *ucom) 401{ 402 uchcom_free_softc(ucom->sc_parent); 403} 404 405/* ---------------------------------------------------------------------- 406 * low level i/o 407 */ 408 409static void 410uchcom_ctrl_write(struct uchcom_softc *sc, uint8_t reqno, 411 uint16_t value, uint16_t index) 412{ 413 struct usb_device_request req; 414 415 req.bmRequestType = UT_WRITE_VENDOR_DEVICE; 416 req.bRequest = reqno; 417 USETW(req.wValue, value); 418 USETW(req.wIndex, index); 419 USETW(req.wLength, 0); 420 421 DPRINTF("WR REQ 0x%02X VAL 0x%04X IDX 0x%04X\n", 422 reqno, value, index); 423 ucom_cfg_do_request(sc->sc_udev, 424 &sc->sc_ucom, &req, NULL, 0, 1000); 425} 426 427static void 428uchcom_ctrl_read(struct uchcom_softc *sc, uint8_t reqno, 429 uint16_t value, uint16_t index, void *buf, uint16_t buflen) 430{ 431 struct usb_device_request req; 432 433 req.bmRequestType = UT_READ_VENDOR_DEVICE; 434 req.bRequest = reqno; 435 USETW(req.wValue, value); 436 USETW(req.wIndex, index); 437 USETW(req.wLength, buflen); 438 439 DPRINTF("RD REQ 0x%02X VAL 0x%04X IDX 0x%04X LEN %d\n", 440 reqno, value, index, buflen); 441 ucom_cfg_do_request(sc->sc_udev, 442 &sc->sc_ucom, &req, buf, USB_SHORT_XFER_OK, 1000); 443} 444 445static void 446uchcom_write_reg(struct uchcom_softc *sc, 447 uint8_t reg1, uint8_t val1, uint8_t reg2, uint8_t val2) 448{ 449 DPRINTF("0x%02X<-0x%02X, 0x%02X<-0x%02X\n", 450 (unsigned)reg1, (unsigned)val1, 451 (unsigned)reg2, (unsigned)val2); 452 uchcom_ctrl_write( 453 sc, UCHCOM_REQ_WRITE_REG, 454 reg1 | ((uint16_t)reg2 << 8), val1 | ((uint16_t)val2 << 8)); 455} 456 457static void 458uchcom_read_reg(struct uchcom_softc *sc, 459 uint8_t reg1, uint8_t *rval1, uint8_t reg2, uint8_t *rval2) 460{ 461 uint8_t buf[UCHCOM_INPUT_BUF_SIZE]; 462 463 uchcom_ctrl_read( 464 sc, UCHCOM_REQ_READ_REG, 465 reg1 | ((uint16_t)reg2 << 8), 0, buf, sizeof(buf)); 466 467 DPRINTF("0x%02X->0x%02X, 0x%02X->0x%02X\n", 468 (unsigned)reg1, (unsigned)buf[0], 469 (unsigned)reg2, (unsigned)buf[1]); 470 471 if (rval1) 472 *rval1 = buf[0]; 473 if (rval2) 474 *rval2 = buf[1]; 475} 476 477static void 478uchcom_get_version(struct uchcom_softc *sc, uint8_t *rver) 479{ 480 uint8_t buf[UCHCOM_INPUT_BUF_SIZE]; 481 482 uchcom_ctrl_read(sc, UCHCOM_REQ_GET_VERSION, 0, 0, buf, sizeof(buf)); 483 484 if (rver) 485 *rver = buf[0]; 486} 487 488static void 489uchcom_get_status(struct uchcom_softc *sc, uint8_t *rval) 490{ 491 uchcom_read_reg(sc, UCHCOM_REG_STAT1, rval, UCHCOM_REG_STAT2, NULL); 492} 493 494static void 495uchcom_set_dtr_rts_10(struct uchcom_softc *sc, uint8_t val) 496{ 497 uchcom_write_reg(sc, UCHCOM_REG_STAT1, val, UCHCOM_REG_STAT1, val); 498} 499 500static void 501uchcom_set_dtr_rts_20(struct uchcom_softc *sc, uint8_t val) 502{ 503 uchcom_ctrl_write(sc, UCHCOM_REQ_SET_DTRRTS, val, 0); 504} 505 506/* ---------------------------------------------------------------------- 507 * middle layer 508 */ 509 510static void 511uchcom_update_version(struct uchcom_softc *sc) 512{ 513 uchcom_get_version(sc, &sc->sc_version); 514 DPRINTF("Chip version: 0x%02x\n", sc->sc_version); 515} 516 517static void 518uchcom_convert_status(struct uchcom_softc *sc, uint8_t cur) 519{ 520 sc->sc_dtr = !(cur & UCHCOM_DTR_MASK); 521 sc->sc_rts = !(cur & UCHCOM_RTS_MASK); 522 523 cur = ~cur & 0x0F; 524 sc->sc_msr = (cur << 4) | ((sc->sc_msr >> 4) ^ cur); 525} 526 527static void 528uchcom_update_status(struct uchcom_softc *sc) 529{ 530 uint8_t cur; 531 532 uchcom_get_status(sc, &cur); 533 uchcom_convert_status(sc, cur); 534} 535 536static void 537uchcom_set_dtr_rts(struct uchcom_softc *sc) 538{ 539 uint8_t val = 0; 540 541 if (sc->sc_dtr) 542 val |= UCHCOM_DTR_MASK; 543 if (sc->sc_rts) 544 val |= UCHCOM_RTS_MASK; 545 546 if (sc->sc_version < UCHCOM_VER_20) 547 uchcom_set_dtr_rts_10(sc, ~val); 548 else 549 uchcom_set_dtr_rts_20(sc, ~val); 550} 551 552static void 553uchcom_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff) 554{ 555 struct uchcom_softc *sc = ucom->sc_parent; 556 uint8_t brk1; 557 uint8_t brk2; 558 559 uchcom_read_reg(sc, UCHCOM_REG_BREAK1, &brk1, UCHCOM_REG_LCR1, &brk2); 560 if (onoff) { 561 /* on - clear bits */ 562 brk1 &= ~UCHCOM_BRK_MASK; 563 brk2 &= ~UCHCOM_LCR1_TX; 564 } else { 565 /* off - set bits */ 566 brk1 |= UCHCOM_BRK_MASK; 567 brk2 |= UCHCOM_LCR1_TX; 568 } 569 uchcom_write_reg(sc, UCHCOM_REG_BREAK1, brk1, UCHCOM_REG_LCR1, brk2); 570} 571 572static int 573uchcom_calc_divider_settings(struct uchcom_divider *dp, uint32_t rate) 574{ 575 const struct uchcom_divider_record *rp; 576 uint32_t div; 577 uint32_t rem; 578 uint32_t mod; 579 uint8_t i; 580 581 /* find record */ 582 for (i = 0; i != NUM_DIVIDERS; i++) { 583 if (dividers[i].dvr_high >= rate && 584 dividers[i].dvr_low <= rate) { 585 rp = ÷rs[i]; 586 goto found; 587 } 588 } 589 return (-1); 590 591found: 592 dp->dv_prescaler = rp->dvr_divider.dv_prescaler; 593 if (rp->dvr_base_clock == UCHCOM_BASE_UNKNOWN) 594 dp->dv_div = rp->dvr_divider.dv_div; 595 else { 596 div = rp->dvr_base_clock / rate; 597 rem = rp->dvr_base_clock % rate; 598 if (div == 0 || div >= 0xFF) 599 return (-1); 600 if ((rem << 1) >= rate) 601 div += 1; 602 dp->dv_div = (uint8_t)-div; 603 } 604 605 mod = (UCHCOM_BPS_MOD_BASE / rate) + UCHCOM_BPS_MOD_BASE_OFS; 606 mod = mod + (mod / 2); 607 608 dp->dv_mod = (mod + 0xFF) / 0x100; 609 610 return (0); 611} 612 613static void 614uchcom_set_baudrate(struct uchcom_softc *sc, uint32_t rate) 615{ 616 struct uchcom_divider dv; 617 618 if (uchcom_calc_divider_settings(&dv, rate)) 619 return; 620 621 /* 622 * According to linux code we need to set bit 7 of UCHCOM_REG_BPS_PRE, 623 * otherwise the chip will buffer data. 624 */ 625 uchcom_write_reg(sc, 626 UCHCOM_REG_BPS_PRE, dv.dv_prescaler | 0x80, 627 UCHCOM_REG_BPS_DIV, dv.dv_div); 628 uchcom_write_reg(sc, 629 UCHCOM_REG_BPS_MOD, dv.dv_mod, 630 UCHCOM_REG_BPS_PAD, 0); 631} 632 633/* ---------------------------------------------------------------------- 634 * methods for ucom 635 */ 636static void 637uchcom_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr) 638{ 639 struct uchcom_softc *sc = ucom->sc_parent; 640 641 DPRINTF("\n"); 642 643 /* XXX Note: sc_lsr is always zero */ 644 *lsr = sc->sc_lsr; 645 *msr = sc->sc_msr; 646} 647 648static void 649uchcom_cfg_set_dtr(struct ucom_softc *ucom, uint8_t onoff) 650{ 651 struct uchcom_softc *sc = ucom->sc_parent; 652 653 DPRINTF("onoff = %d\n", onoff); 654 655 sc->sc_dtr = onoff; 656 uchcom_set_dtr_rts(sc); 657} 658 659static void 660uchcom_cfg_set_rts(struct ucom_softc *ucom, uint8_t onoff) 661{ 662 struct uchcom_softc *sc = ucom->sc_parent; 663 664 DPRINTF("onoff = %d\n", onoff); 665 666 sc->sc_rts = onoff; 667 uchcom_set_dtr_rts(sc); 668} 669 670static void 671uchcom_cfg_open(struct ucom_softc *ucom) 672{ 673 struct uchcom_softc *sc = ucom->sc_parent; 674 675 DPRINTF("\n"); 676 677 uchcom_update_version(sc); 678 uchcom_update_status(sc); 679} 680 681static int 682uchcom_pre_param(struct ucom_softc *ucom, struct termios *t) 683{ 684 struct uchcom_divider dv; 685 686 switch (t->c_cflag & CSIZE) { 687 case CS8: 688 break; 689 default: 690 return (EIO); 691 } 692 if ((t->c_cflag & CSTOPB) != 0) 693 return (EIO); 694 if ((t->c_cflag & PARENB) != 0) 695 return (EIO); 696 697 if (uchcom_calc_divider_settings(&dv, t->c_ospeed)) { 698 return (EIO); 699 } 700 return (0); /* success */ 701} 702 703static void 704uchcom_cfg_param(struct ucom_softc *ucom, struct termios *t) 705{ 706 struct uchcom_softc *sc = ucom->sc_parent; 707 708 uchcom_get_version(sc, NULL); 709 uchcom_ctrl_write(sc, UCHCOM_REQ_RESET, 0, 0); 710 uchcom_set_baudrate(sc, t->c_ospeed); 711 if (sc->sc_version < UCHCOM_VER_30) { 712 uchcom_read_reg(sc, UCHCOM_REG_LCR1, NULL, 713 UCHCOM_REG_LCR2, NULL); 714 uchcom_write_reg(sc, UCHCOM_REG_LCR1, 0x50, 715 UCHCOM_REG_LCR2, 0x00); 716 } else { 717 /* 718 * Set up line control: 719 * - enable transmit and receive 720 * - set 8n1 mode 721 * To do: support other sizes, parity, stop bits. 722 */ 723 uchcom_write_reg(sc, 724 UCHCOM_REG_LCR1, 725 UCHCOM_LCR1_RX | UCHCOM_LCR1_TX | UCHCOM_LCR1_CS8, 726 UCHCOM_REG_LCR2, 0x00); 727 } 728 uchcom_update_status(sc); 729 uchcom_ctrl_write(sc, UCHCOM_REQ_RESET, 0x501f, 0xd90a); 730 uchcom_set_baudrate(sc, t->c_ospeed); 731 uchcom_set_dtr_rts(sc); 732 uchcom_update_status(sc); 733} 734 735static void 736uchcom_start_read(struct ucom_softc *ucom) 737{ 738 struct uchcom_softc *sc = ucom->sc_parent; 739 740 /* start interrupt endpoint */ 741 usbd_transfer_start(sc->sc_xfer[UCHCOM_INTR_DT_RD]); 742 743 /* start read endpoint */ 744 usbd_transfer_start(sc->sc_xfer[UCHCOM_BULK_DT_RD]); 745} 746 747static void 748uchcom_stop_read(struct ucom_softc *ucom) 749{ 750 struct uchcom_softc *sc = ucom->sc_parent; 751 752 /* stop interrupt endpoint */ 753 usbd_transfer_stop(sc->sc_xfer[UCHCOM_INTR_DT_RD]); 754 755 /* stop read endpoint */ 756 usbd_transfer_stop(sc->sc_xfer[UCHCOM_BULK_DT_RD]); 757} 758 759static void 760uchcom_start_write(struct ucom_softc *ucom) 761{ 762 struct uchcom_softc *sc = ucom->sc_parent; 763 764 usbd_transfer_start(sc->sc_xfer[UCHCOM_BULK_DT_WR]); 765} 766 767static void 768uchcom_stop_write(struct ucom_softc *ucom) 769{ 770 struct uchcom_softc *sc = ucom->sc_parent; 771 772 usbd_transfer_stop(sc->sc_xfer[UCHCOM_BULK_DT_WR]); 773} 774 775/* ---------------------------------------------------------------------- 776 * callback when the modem status is changed. 777 */ 778static void 779uchcom_intr_callback(struct usb_xfer *xfer, usb_error_t error) 780{ 781 struct uchcom_softc *sc = usbd_xfer_softc(xfer); 782 struct usb_page_cache *pc; 783 uint8_t buf[UCHCOM_INTR_LEAST]; 784 int actlen; 785 786 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 787 788 switch (USB_GET_STATE(xfer)) { 789 case USB_ST_TRANSFERRED: 790 791 DPRINTF("actlen = %u\n", actlen); 792 793 if (actlen >= UCHCOM_INTR_LEAST) { 794 pc = usbd_xfer_get_frame(xfer, 0); 795 usbd_copy_out(pc, 0, buf, UCHCOM_INTR_LEAST); 796 797 DPRINTF("data = 0x%02X 0x%02X 0x%02X 0x%02X\n", 798 (unsigned)buf[0], (unsigned)buf[1], 799 (unsigned)buf[2], (unsigned)buf[3]); 800 801 uchcom_convert_status(sc, buf[UCHCOM_INTR_STAT1]); 802 ucom_status_change(&sc->sc_ucom); 803 } 804 case USB_ST_SETUP: 805tr_setup: 806 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 807 usbd_transfer_submit(xfer); 808 break; 809 810 default: /* Error */ 811 if (error != USB_ERR_CANCELLED) { 812 /* try to clear stall first */ 813 usbd_xfer_set_stall(xfer); 814 goto tr_setup; 815 } 816 break; 817 } 818} 819 820static void 821uchcom_write_callback(struct usb_xfer *xfer, usb_error_t error) 822{ 823 struct uchcom_softc *sc = usbd_xfer_softc(xfer); 824 struct usb_page_cache *pc; 825 uint32_t actlen; 826 827 switch (USB_GET_STATE(xfer)) { 828 case USB_ST_SETUP: 829 case USB_ST_TRANSFERRED: 830tr_setup: 831 pc = usbd_xfer_get_frame(xfer, 0); 832 if (ucom_get_data(&sc->sc_ucom, pc, 0, 833 usbd_xfer_max_len(xfer), &actlen)) { 834 DPRINTF("actlen = %d\n", actlen); 835 836 usbd_xfer_set_frame_len(xfer, 0, actlen); 837 usbd_transfer_submit(xfer); 838 } 839 break; 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 break; 848 } 849} 850 851static void 852uchcom_read_callback(struct usb_xfer *xfer, usb_error_t error) 853{ 854 struct uchcom_softc *sc = usbd_xfer_softc(xfer); 855 struct usb_page_cache *pc; 856 int actlen; 857 858 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL); 859 860 switch (USB_GET_STATE(xfer)) { 861 case USB_ST_TRANSFERRED: 862 863 if (actlen > 0) { 864 pc = usbd_xfer_get_frame(xfer, 0); 865 ucom_put_data(&sc->sc_ucom, pc, 0, actlen); 866 } 867 868 case USB_ST_SETUP: 869tr_setup: 870 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer)); 871 usbd_transfer_submit(xfer); 872 break; 873 874 default: /* Error */ 875 if (error != USB_ERR_CANCELLED) { 876 /* try to clear stall first */ 877 usbd_xfer_set_stall(xfer); 878 goto tr_setup; 879 } 880 break; 881 } 882} 883 884static void 885uchcom_poll(struct ucom_softc *ucom) 886{ 887 struct uchcom_softc *sc = ucom->sc_parent; 888 usbd_transfer_poll(sc->sc_xfer, UCHCOM_N_TRANSFER); 889} 890 891static device_method_t uchcom_methods[] = { 892 /* Device interface */ 893 DEVMETHOD(device_probe, uchcom_probe), 894 DEVMETHOD(device_attach, uchcom_attach), 895 DEVMETHOD(device_detach, uchcom_detach), 896 DEVMETHOD_END 897}; 898 899static driver_t uchcom_driver = { 900 .name = "uchcom", 901 .methods = uchcom_methods, 902 .size = sizeof(struct uchcom_softc) 903}; 904 905DRIVER_MODULE(uchcom, uhub, uchcom_driver, NULL, NULL); 906MODULE_DEPEND(uchcom, ucom, 1, 1, 1); 907MODULE_DEPEND(uchcom, usb, 1, 1, 1); 908MODULE_VERSION(uchcom, 1); 909USB_PNP_HOST_INFO(uchcom_devs); 910