?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Nuke usbdevs and references to it.
[dragonfly.git] / sys / dev / usbmisc / uplcom / uplcom.c
blobd089a9a6debb615e75379ed0bb1fffe9bb9c390d
1 /*
2 * $NetBSD: uplcom.c,v 1.21 2001/11/13 06:24:56 lukem Exp $
3 * $FreeBSD: src/sys/dev/usb/uplcom.c,v 1.39 2006/09/07 00:06:42 imp Exp $
4 * $DragonFly: src/sys/dev/usbmisc/uplcom/uplcom.c,v 1.24 2007/11/05 19:09:44 hasso Exp $
5 */
6
7 /*-
8 * Copyright (c) 2001-2003, 2005 Shunsuke Akiyama <akiyama@jp.FreeBSD.org>.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 */
32
33 /*
34 * Copyright (c) 2001 The NetBSD Foundation, Inc.
35 * All rights reserved.
36 *
37 * This code is derived from software contributed to The NetBSD Foundation
38 * by Ichiro FUKUHARA (ichiro@ichiro.org).
39 *
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
42 * are met:
43 * 1. Redistributions of source code must retain the above copyright
44 * notice, this list of conditions and the following disclaimer.
45 * 2. Redistributions in binary form must reproduce the above copyright
46 * notice, this list of conditions and the following disclaimer in the
47 * documentation and/or other materials provided with the distribution.
48 * 3. All advertising materials mentioning features or use of this software
49 * must display the following acknowledgement:
50 * This product includes software developed by the NetBSD
51 * Foundation, Inc. and its contributors.
52 * 4. Neither the name of The NetBSD Foundation nor the names of its
53 * contributors may be used to endorse or promote products derived
54 * from this software without specific prior written permission.
55 *
56 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
57 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
58 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
59 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
60 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
61 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
62 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
63 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
64 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
65 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
66 * POSSIBILITY OF SUCH DAMAGE.
67 */
68
69 /*
70 * This driver supports several devices devices driven by Prolific PL-2303
71 * (known also as PL-2303H), PL-2303X and PL-2303HX USB-to-RS232 bridge chip.
72 * The devices are sold under many different brand names.
73 *
74 * Datasheets are available at Prolific www site at http://www.prolific.com.tw
75 * The datasheets don't contain full programming information for the chip.
76 *
77 * PL-2303HX has the same features as PL-2303X (at least from the point of
78 * view of device driver) but is pin-to-pin compatible with PL-2303.
79 *
80 * There are several differences between PL-2303 and PL-2303(H)X.
81 * PL-2303(H)X can do higher bitrate in bulk mode, has _probably_
82 * different command for controlling CRTSCTS and needs special
83 * sequence of commands for initialization which aren't also
84 * documented in the datasheet.
85 */
86
87 #include <sys/param.h>
88 #include <sys/systm.h>
89 #include <sys/kernel.h>
90 #include <sys/malloc.h>
91 #include <sys/bus.h>
92 #include <sys/ioccom.h>
93 #include <sys/fcntl.h>
94 #include <sys/conf.h>
95 #include <sys/tty.h>
96 #include <sys/file.h>
97 #include <sys/select.h>
98 #include <sys/proc.h>
99 #include <sys/poll.h>
100 #include <sys/sysctl.h>
101 #include <sys/taskqueue.h>
102
103 #include <bus/usb/usb.h>
104 #include <bus/usb/usbcdc.h>
105
106 #include <bus/usb/usbdi.h>
107 #include <bus/usb/usbdi_util.h>
108 #include <bus/usb/usb_quirks.h>
109
110 #include "../ucom/ucomvar.h"
111
112 SYSCTL_NODE(_hw_usb, OID_AUTO, uplcom, CTLFLAG_RW, 0, "USB uplcom");
113 #ifdef USB_DEBUG
114 static int uplcomdebug = 0;
115 SYSCTL_INT(_hw_usb_uplcom, OID_AUTO, debug, CTLFLAG_RW,
116 &uplcomdebug, 0, "uplcom debug level");
117
118 #define DPRINTFN(n, x) do { \
119 if (uplcomdebug > (n)) \
120 kprintf x; \
121 } while (0)
122 #else
123 #define DPRINTFN(n, x)
124 #endif
125 #define DPRINTF(x) DPRINTFN(0, x)
126
127 #define UPLCOM_MODVER 1 /* module version */
128
129 #define UPLCOM_CONFIG_INDEX 0
130 #define UPLCOM_IFACE_INDEX 0
131 #define UPLCOM_SECOND_IFACE_INDEX 1
132
133 #ifndef UPLCOM_INTR_INTERVAL
134 #define UPLCOM_INTR_INTERVAL 100 /* ms */
135 #endif
136
137 #define UPLCOM_SET_REQUEST 0x01
138 #define UPLCOM_SET_CRTSCTS 0x41
139 #define UPLCOM_SET_CRTSCTS_PL2303X 0x61
140 #define RSAQ_STATUS_CTS 0x80
141 #define RSAQ_STATUS_DSR 0x02
142 #define RSAQ_STATUS_DCD 0x01
143
144 #define TYPE_PL2303 0
145 #define TYPE_PL2303X 1
146
147 struct uplcom_softc {
148 struct ucom_softc sc_ucom;
149
150 int sc_iface_number; /* interface number */
151
152 usbd_interface_handle sc_intr_iface; /* interrupt interface */
153 int sc_intr_number; /* interrupt number */
154 usbd_pipe_handle sc_intr_pipe; /* interrupt pipe */
155 u_char *sc_intr_buf; /* interrupt buffer */
156 int sc_isize;
157
158 usb_cdc_line_state_t sc_line_state; /* current line state */
159 u_char sc_dtr; /* current DTR state */
160 u_char sc_rts; /* current RTS state */
161 u_char sc_status;
162
163 u_char sc_lsr; /* Local status register */
164 u_char sc_msr; /* uplcom status register */
165
166 int sc_chiptype; /* Type of chip */
167
168 struct task sc_task;
169 };
170
171 /*
172 * These are the maximum number of bytes transferred per frame.
173 * The output buffer size cannot be increased due to the size encoding.
174 */
175 #define UPLCOMIBUFSIZE 256
176 #define UPLCOMOBUFSIZE 256
177
178 static usbd_status uplcom_reset(struct uplcom_softc *);
179 static usbd_status uplcom_set_line_coding(struct uplcom_softc *,
180 usb_cdc_line_state_t *);
181 static usbd_status uplcom_set_crtscts(struct uplcom_softc *);
182 static void uplcom_intr(usbd_xfer_handle, usbd_private_handle, usbd_status);
183
184 static void uplcom_set(void *, int, int, int);
185 static void uplcom_dtr(struct uplcom_softc *, int);
186 static void uplcom_rts(struct uplcom_softc *, int);
187 static void uplcom_break(struct uplcom_softc *, int);
188 static void uplcom_set_line_state(struct uplcom_softc *);
189 static void uplcom_get_status(void *, int, u_char *, u_char *);
190 #if 0 /* TODO */
191 static int uplcom_ioctl(void *, int, u_long, caddr_t, int, struct thread *);
192 #endif
193 static int uplcom_param(void *, int, struct termios *);
194 static int uplcom_open(void *, int);
195 static void uplcom_close(void *, int);
196 static void uplcom_notify(void *, int);
197
198 struct ucom_callback uplcom_callback = {
199 uplcom_get_status,
200 uplcom_set,
201 uplcom_param,
202 NULL, /* uplcom_ioctl, TODO */
203 uplcom_open,
204 uplcom_close,
205 NULL,
206 NULL
207 };
208
209 static const struct usb_devno uplcom_devs[] = {
210 { USB_DEVICE(0x0413, 0x2101) }, /* Leadtek 9531 GPS */
211 { USB_DEVICE(0x0421, 0x1234) }, /* Nokia CA-42 USB data cable clones*/
212 { USB_DEVICE(0x04bb, 0x0a03) }, /* I/O DATA USB-RSAQ USB to serial */
213 { USB_DEVICE(0x04bb, 0x0a0e) }, /* I/O DATA USB-RSAQ5 USB to serial */
214 { USB_DEVICE(0x04bf, 0x0115) }, /* TDK USB-PDC adapter UPA9664 */
215 { USB_DEVICE(0x04bf, 0x0117) }, /* TDK USB-PHS adapter UHA6400 */
216 { USB_DEVICE(0x04da, 0x3900) }, /* Panasonic 50" touch panel */
217 { USB_DEVICE(0x04e8, 0x8001) }, /* Samsung I330 smartphone cradle */
218 { USB_DEVICE(0x050d, 0x0257) }, /* Belkin F5U257 USB to serial */
219 { USB_DEVICE(0x0547, 0x2008) }, /* Anchor serial */
220 { USB_DEVICE(0x0557, 0x2008) }, /* Aten UC232A USB to serial */
221 { USB_DEVICE(0x056e, 0x5003) }, /* ELECOM UC-SGT USB to serial */
222 { USB_DEVICE(0x056e, 0x5004) }, /* ELECOM UC-SGT USB to serial */
223 { USB_DEVICE(0x0584, 0xb000) }, /* RATOC REX-USB60 USB to serial */
224 { USB_DEVICE(0x058f, 0x9720) }, /* Alcor AU9720 USB to serial */
225 { USB_DEVICE(0x067b, 0x04bb) }, /* I/O DATA USB-RSAQ2 USB to serial */
226 { USB_DEVICE(0x067b, 0x1234) }, /* Unbranded DCU-11 clone */
227 { USB_DEVICE(0x067b, 0x2303) }, /* IOGEAR/ATEN UC-232A, ST Lab
228 USB-SERIAL-X etc */
229 { USB_DEVICE(0x067b, 0xaaa0) }, /* Microsoft OEM Pharos 360 GPS */
230 { USB_DEVICE(0x067b, 0xaaa2) }, /* I/O DATA USB-RSAQ3 USB to serial */
231 { USB_DEVICE(0x0731, 0x0528) }, /* Sony-Ericsson DCU-10/DCU-11 */
232 { USB_DEVICE(0x0731, 0x2003) }, /* Susteen Datapilot Universal-2 Phone
233 Cable */
234 { USB_DEVICE(0x0745, 0x0001) }, /* Syntech CPT-8001C barcode scanner
235 USB cradle */
236 { USB_DEVICE(0x079b, 0x0027) }, /* Sagem USB data cables */
237 { USB_DEVICE(0x0833, 0x012e) }, /* SOURCENEXT KeikaiDenwa 8 with
238 charger */
239 { USB_DEVICE(0x0833, 0x039f) }, /* SOURCENEXT KeikaiDenwa 8 */
240 { USB_DEVICE(0x0b41, 0x0011) }, /* HAL Corporation Crossam2+USB */
241 { USB_DEVICE(0x0b8c, 0x2303) }, /* Smart Technologies USB to serial */
242 { USB_DEVICE(0x0df7, 0x0620) }, /* Mobile Action MA-620 IrDA */
243 { USB_DEVICE(0x0e55, 0x110b) }, /* Speed Dragon MS3303H */
244 { USB_DEVICE(0x0eba, 0x1080) }, /* Itegno GSM/GPRS modem */
245 { USB_DEVICE(0x0eba, 0x2080) }, /* Itegno CDMA 1x card */
246 { USB_DEVICE(0x10b5, 0xac70) }, /* PLX CA-42 USB data cable clone */
247 { USB_DEVICE(0x11f5, 0x0001) }, /* Siemens SX1 cellphone */
248 { USB_DEVICE(0x11f5, 0x0003) }, /* Siemens x65 series cellphones */
249 { USB_DEVICE(0x11f5, 0x0004) }, /* Siemens x75 series cellphones */
250 { USB_DEVICE(0x11f6, 0x2001) }, /* Willcom W-SIM */
251 { USB_DEVICE(0x11f7, 0x02df) }, /* Alcatel One Touch 535/735 phones */
252 { USB_DEVICE(0x12d1, 0x1001) }, /* Huawei UMTS/HSDPA adapters */
253 { USB_DEVICE(0x1453, 0x4026) }, /* RADIOSHACK USB cable */
254 { USB_DEVICE(0x2478, 0x2008) }, /* Tripp-Lite U209-000-R */
255 { USB_DEVICE(0x6189, 0x2068) }, /* Sitecom USB to serial cable */
256 };
257
258 static device_probe_t uplcom_match;
259 static device_attach_t uplcom_attach;
260 static device_detach_t uplcom_detach;
261
262 static device_method_t uplcom_methods[] = {
263 /* Device interface */
264 DEVMETHOD(device_probe, uplcom_match),
265 DEVMETHOD(device_attach, uplcom_attach),
266 DEVMETHOD(device_detach, uplcom_detach),
267 { 0, 0 }
268 };
269
270 static driver_t uplcom_driver = {
271 "ucom",
272 uplcom_methods,
273 sizeof (struct uplcom_softc)
274 };
275
276 DRIVER_MODULE(uplcom, uhub, uplcom_driver, ucom_devclass, usbd_driver_load, 0);
277 MODULE_DEPEND(uplcom, usb, 1, 1, 1);
278 MODULE_DEPEND(uplcom, ucom, UCOM_MINVER, UCOM_PREFVER, UCOM_MAXVER);
279 MODULE_VERSION(uplcom, UPLCOM_MODVER);
280
281 static int uplcominterval = UPLCOM_INTR_INTERVAL;
282
283 static int
284 sysctl_hw_usb_uplcom_interval(SYSCTL_HANDLER_ARGS)
285 {
286 int err, val;
287
288 val = uplcominterval;
289 err = sysctl_handle_int(oidp, &val, sizeof(val), req);
290 if (err != 0 || req->newptr == NULL)
291 return (err);
292 if (0 < val && val <= 1000)
293 uplcominterval = val;
294 else
295 err = EINVAL;
296
297 return (err);
298 }
299
300 SYSCTL_PROC(_hw_usb_uplcom, OID_AUTO, interval, CTLTYPE_INT | CTLFLAG_RW,
301 0, sizeof(int), sysctl_hw_usb_uplcom_interval,
302 "I", "uplcom interrupt pipe interval");
303
304 static int
305 uplcom_match(device_t self)
306 {
307 struct usb_attach_arg *uaa = device_get_ivars(self);
308
309 if (uaa->iface != NULL)
310 return (UMATCH_NONE);
311
312 return (usb_lookup(uplcom_devs, uaa->vendor, uaa->product) != NULL ?
313 UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
314 }
315
316 static int
317 uplcom_attach(device_t self)
318 {
319 struct uplcom_softc *sc = device_get_softc(self);
320 struct usb_attach_arg *uaa = device_get_ivars(self);
321 usbd_device_handle dev = uaa->device;
322 usb_device_descriptor_t *dd;
323 struct ucom_softc *ucom;
324 usb_config_descriptor_t *cdesc;
325 usb_interface_descriptor_t *id;
326 usb_endpoint_descriptor_t *ed;
327 char *devinfo;
328 usbd_status err;
329 int i;
330
331 devinfo = kmalloc(1024, M_USBDEV, M_INTWAIT);
332 ucom = &sc->sc_ucom;
333
334 bzero(sc, sizeof (struct uplcom_softc));
335
336 usbd_devinfo(dev, 0, devinfo);
337 ucom->sc_dev = self;
338 device_set_desc_copy(self, devinfo);
339
340 ucom->sc_udev = dev;
341 ucom->sc_iface = uaa->iface;
342
343 device_printf(ucom->sc_dev, "%s\n", devinfo);
344
345 DPRINTF(("uplcom attach: sc = %p\n", sc));
346
347 dd = usbd_get_device_descriptor(uaa->device);
348
349 if (!dd)
350 goto error;
351
352 /*
353 * Determine chip type with algorithm sequence taken from the
354 * Linux driver as I'm not aware of any better method. Device
355 * release number in chip could be (and in fact is in many cases)
356 * replaced by the contents of external EEPROM etc.
357 */
358 else if (dd->bDeviceClass == 0x02)
359 sc->sc_chiptype = TYPE_PL2303;
360 else if (dd->bMaxPacketSize == 0x40)
361 sc->sc_chiptype = TYPE_PL2303X;
362 else
363 sc->sc_chiptype = TYPE_PL2303;
364
365 #ifdef USB_DEBUG
366 /* print the chip type */
367 if (sc->sc_chiptype == TYPE_PL2303X) {
368 DPRINTF(("uplcom_attach: chiptype 2303X\n"));
369 } else {
370 DPRINTF(("uplcom_attach: chiptype 2303\n"));
371 }
372 #endif
373
374 /* initialize endpoints */
375 ucom->sc_bulkin_no = ucom->sc_bulkout_no = -1;
376 sc->sc_intr_number = -1;
377 sc->sc_intr_pipe = NULL;
378
379 /* Move the device into the configured state. */
380 err = usbd_set_config_index(dev, UPLCOM_CONFIG_INDEX, 1);
381 if (err) {
382 device_printf(ucom->sc_dev, "failed to set configuration: %s\n",
383 usbd_errstr(err));
384 ucom->sc_dying = 1;
385 goto error;
386 }
387
388 /* get the config descriptor */
389 cdesc = usbd_get_config_descriptor(ucom->sc_udev);
390
391 if (cdesc == NULL) {
392 device_printf(ucom->sc_dev, "failed to get configuration "
393 "descriptor\n");
394 ucom->sc_dying = 1;
395 goto error;
396 }
397
398 /* get the (first/common) interface */
399 err = usbd_device2interface_handle(dev, UPLCOM_IFACE_INDEX,
400 &ucom->sc_iface);
401 if (err) {
402 device_printf(ucom->sc_dev, "failed to get interface: %s\n",
403 usbd_errstr(err));
404 ucom->sc_dying = 1;
405 goto error;
406 }
407
408 /* Find the interrupt endpoints */
409
410 id = usbd_get_interface_descriptor(ucom->sc_iface);
411 sc->sc_iface_number = id->bInterfaceNumber;
412
413 for (i = 0; i < id->bNumEndpoints; i++) {
414 ed = usbd_interface2endpoint_descriptor(ucom->sc_iface, i);
415 if (ed == NULL) {
416 device_printf(ucom->sc_dev, "no endpoint descriptor "
417 "for %d\n", i);
418 ucom->sc_dying = 1;
419 goto error;
420 }
421
422 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
423 UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
424 sc->sc_intr_number = ed->bEndpointAddress;
425 sc->sc_isize = UGETW(ed->wMaxPacketSize);
426 }
427 }
428
429 if (sc->sc_intr_number == -1) {
430 device_printf(ucom->sc_dev, "could not find interrupt in\n");
431 ucom->sc_dying = 1;
432 goto error;
433 }
434
435 /* keep interface for interrupt */
436 sc->sc_intr_iface = ucom->sc_iface;
437
438 /*
439 * USB-RSAQ1 has two interface
440 *
441 * USB-RSAQ1 | USB-RSAQ2
442 * -----------------+-----------------
443 * Interface 0 |Interface 0
444 * Interrupt(0x81) | Interrupt(0x81)
445 * -----------------+ BulkIN(0x02)
446 * Interface 1 | BulkOUT(0x83)
447 * BulkIN(0x02) |
448 * BulkOUT(0x83) |
449 */
450 if (cdesc->bNumInterface == 2) {
451 err = usbd_device2interface_handle(dev,
452 UPLCOM_SECOND_IFACE_INDEX,
453 &ucom->sc_iface);
454 if (err) {
455 device_printf(ucom->sc_dev, "failed to get second "
456 "interface: %s\n", usbd_errstr(err));
457 ucom->sc_dying = 1;
458 goto error;
459 }
460 }
461
462 /* Find the bulk{in,out} endpoints */
463
464 id = usbd_get_interface_descriptor(ucom->sc_iface);
465 sc->sc_iface_number = id->bInterfaceNumber;
466
467 for (i = 0; i < id->bNumEndpoints; i++) {
468 ed = usbd_interface2endpoint_descriptor(ucom->sc_iface, i);
469 if (ed == NULL) {
470 device_printf(ucom->sc_dev, "no endpoint descriptor "
471 "for %d\n", i);
472 ucom->sc_dying = 1;
473 goto error;
474 }
475
476 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
477 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
478 ucom->sc_bulkin_no = ed->bEndpointAddress;
479 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
480 UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
481 ucom->sc_bulkout_no = ed->bEndpointAddress;
482 }
483 }
484
485 if (ucom->sc_bulkin_no == -1) {
486 device_printf(ucom->sc_dev, "could not find data bulk in\n");
487 ucom->sc_dying = 1;
488 goto error;
489 }
490
491 if (ucom->sc_bulkout_no == -1) {
492 device_printf(ucom->sc_dev, "could not find data bulk out\n");
493 ucom->sc_dying = 1;
494 goto error;
495 }
496
497 sc->sc_dtr = sc->sc_rts = -1;
498 ucom->sc_parent = sc;
499 ucom->sc_portno = UCOM_UNK_PORTNO;
500 /* bulkin, bulkout set above */
501 ucom->sc_ibufsize = UPLCOMIBUFSIZE;
502 ucom->sc_obufsize = UPLCOMOBUFSIZE;
503 ucom->sc_ibufsizepad = UPLCOMIBUFSIZE;
504 ucom->sc_opkthdrlen = 0;
505 ucom->sc_callback = &uplcom_callback;
506
507 err = uplcom_reset(sc);
508
509 if (err) {
510 device_printf(ucom->sc_dev, "reset failed: %s\n",
511 usbd_errstr(err));
512 ucom->sc_dying = 1;
513 goto error;
514 }
515
516 DPRINTF(("uplcom: in = 0x%x, out = 0x%x, intr = 0x%x\n",
517 ucom->sc_bulkin_no, ucom->sc_bulkout_no, sc->sc_intr_number));
518
519 TASK_INIT(&sc->sc_task, 0, uplcom_notify, sc);
520 ucom_attach(&sc->sc_ucom);
521
522 kfree(devinfo, M_USBDEV);
523 return 0;
524
525 error:
526 kfree(devinfo, M_USBDEV);
527 return ENXIO;
528 }
529
530 static int
531 uplcom_detach(device_t self)
532 {
533 struct uplcom_softc *sc = device_get_softc(self);
534 int rv = 0;
535
536 DPRINTF(("uplcom_detach: sc = %p\n", sc));
537
538 if (sc->sc_intr_pipe != NULL) {
539 usbd_abort_pipe(sc->sc_intr_pipe);
540 usbd_close_pipe(sc->sc_intr_pipe);
541 kfree(sc->sc_intr_buf, M_USBDEV);
542 sc->sc_intr_pipe = NULL;
543 }
544
545 sc->sc_ucom.sc_dying = 1;
546
547 rv = ucom_detach(&sc->sc_ucom);
548
549 return (rv);
550 }
551
552 static usbd_status
553 uplcom_reset(struct uplcom_softc *sc)
554 {
555 usb_device_request_t req;
556 usbd_status err;
557
558 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
559 req.bRequest = UPLCOM_SET_REQUEST;
560 USETW(req.wValue, 0);
561 USETW(req.wIndex, sc->sc_iface_number);
562 USETW(req.wLength, 0);
563
564 err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
565 if (err) {
566 device_printf(sc->sc_ucom.sc_dev, "uplcom_reset: %s\n",
567 usbd_errstr(err));
568 return (EIO);
569 }
570
571 return (0);
572 }
573
574 struct pl2303x_init {
575 uint8_t req_type;
576 uint8_t request;
577 uint16_t value;
578 uint16_t index;
579 uint16_t length;
580 };
581
582 static const struct pl2303x_init pl2303x[] = {
583 { UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 0 },
584 { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404, 0, 0 },
585 { UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 0 },
586 { UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8383, 0, 0 },
587 { UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 0 },
588 { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x0404, 1, 0 },
589 { UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8484, 0, 0 },
590 { UT_READ_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0x8383, 0, 0 },
591 { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 0, 1, 0 },
592 { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 1, 0, 0 },
593 { UT_WRITE_VENDOR_DEVICE, UPLCOM_SET_REQUEST, 2, 0x44, 0 }
594 };
595 #define N_PL2302X_INIT (sizeof(pl2303x)/sizeof(pl2303x[0]))
596
597 static usbd_status
598 uplcom_pl2303x_init(struct uplcom_softc *sc)
599 {
600 usb_device_request_t req;
601 usbd_status err;
602 int i;
603
604 for (i = 0; i < N_PL2302X_INIT; i++) {
605 req.bmRequestType = pl2303x[i].req_type;
606 req.bRequest = pl2303x[i].request;
607 USETW(req.wValue, pl2303x[i].value);
608 USETW(req.wIndex, pl2303x[i].index);
609 USETW(req.wLength, pl2303x[i].length);
610
611 err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
612 if (err) {
613 device_printf(sc->sc_ucom.sc_dev,
614 "uplcom_pl2303x_init: %d: %s\n", i,
615 usbd_errstr(err));
616 return (EIO);
617 }
618 }
619
620 return (0);
621 }
622
623 static void
624 uplcom_set_line_state(struct uplcom_softc *sc)
625 {
626 usb_device_request_t req;
627 int ls;
628 usbd_status err;
629
630 ls = (sc->sc_dtr ? UCDC_LINE_DTR : 0) |
631 (sc->sc_rts ? UCDC_LINE_RTS : 0);
632 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
633 req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
634 USETW(req.wValue, ls);
635 USETW(req.wIndex, sc->sc_iface_number);
636 USETW(req.wLength, 0);
637
638 err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
639 if (err)
640 device_printf(sc->sc_ucom.sc_dev, "uplcom_set_line_status: "
641 "%s\n", usbd_errstr(err));
642 }
643
644 static void
645 uplcom_set(void *addr, int portno, int reg, int onoff)
646 {
647 struct uplcom_softc *sc = addr;
648
649 switch (reg) {
650 case UCOM_SET_DTR:
651 uplcom_dtr(sc, onoff);
652 break;
653 case UCOM_SET_RTS:
654 uplcom_rts(sc, onoff);
655 break;
656 case UCOM_SET_BREAK:
657 uplcom_break(sc, onoff);
658 break;
659 default:
660 break;
661 }
662 }
663
664 static void
665 uplcom_dtr(struct uplcom_softc *sc, int onoff)
666 {
667 DPRINTF(("uplcom_dtr: onoff = %d\n", onoff));
668
669 if (sc->sc_dtr == onoff)
670 return;
671 sc->sc_dtr = onoff;
672
673 uplcom_set_line_state(sc);
674 }
675
676 static void
677 uplcom_rts(struct uplcom_softc *sc, int onoff)
678 {
679 DPRINTF(("uplcom_rts: onoff = %d\n", onoff));
680
681 if (sc->sc_rts == onoff)
682 return;
683 sc->sc_rts = onoff;
684
685 uplcom_set_line_state(sc);
686 }
687
688 static void
689 uplcom_break(struct uplcom_softc *sc, int onoff)
690 {
691 usb_device_request_t req;
692 usbd_status err;
693
694 DPRINTF(("uplcom_break: onoff = %d\n", onoff));
695
696 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
697 req.bRequest = UCDC_SEND_BREAK;
698 USETW(req.wValue, onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF);
699 USETW(req.wIndex, sc->sc_iface_number);
700 USETW(req.wLength, 0);
701
702 err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
703 if (err)
704 device_printf(sc->sc_ucom.sc_dev, "uplcom_break: %s\n",
705 usbd_errstr(err));
706 }
707
708 static usbd_status
709 uplcom_set_crtscts(struct uplcom_softc *sc)
710 {
711 usb_device_request_t req;
712 usbd_status err;
713
714 DPRINTF(("uplcom_set_crtscts: on\n"));
715
716 req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
717 req.bRequest = UPLCOM_SET_REQUEST;
718 USETW(req.wValue, 0);
719 if (sc->sc_chiptype == TYPE_PL2303X)
720 USETW(req.wIndex, UPLCOM_SET_CRTSCTS_PL2303X);
721 else
722 USETW(req.wIndex, UPLCOM_SET_CRTSCTS);
723 USETW(req.wLength, 0);
724
725 err = usbd_do_request(sc->sc_ucom.sc_udev, &req, 0);
726 if (err) {
727 device_printf(sc->sc_ucom.sc_dev, "uplcom_set_crtscts: %s\n",
728 usbd_errstr(err));
729 return (err);
730 }
731
732 return (USBD_NORMAL_COMPLETION);
733 }
734
735 static usbd_status
736 uplcom_set_line_coding(struct uplcom_softc *sc, usb_cdc_line_state_t *state)
737 {
738 usb_device_request_t req;
739 usbd_status err;
740
741 DPRINTF((
742 "uplcom_set_line_coding: rate = %d, fmt = %d, parity = %d bits = %d\n",
743 UGETDW(state->dwDTERate), state->bCharFormat,
744 state->bParityType, state->bDataBits));
745
746 if (memcmp(state, &sc->sc_line_state, UCDC_LINE_STATE_LENGTH) == 0) {
747 DPRINTF(("uplcom_set_line_coding: already set\n"));
748 return (USBD_NORMAL_COMPLETION);
749 }
750
751 req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
752 req.bRequest = UCDC_SET_LINE_CODING;
753 USETW(req.wValue, 0);
754 USETW(req.wIndex, sc->sc_iface_number);
755 USETW(req.wLength, UCDC_LINE_STATE_LENGTH);
756
757 err = usbd_do_request(sc->sc_ucom.sc_udev, &req, state);
758 if (err) {
759 device_printf(sc->sc_ucom.sc_dev, "uplcom_set_line_coding: "
760 "%s\n", usbd_errstr(err));
761 return (err);
762 }
763
764 sc->sc_line_state = *state;
765
766 return (USBD_NORMAL_COMPLETION);
767 }
768
769 static const int uplcom_rates[] = {
770 75, 150, 300, 600, 1200, 1800, 2400, 3600, 4800, 7200, 9600, 14400,
771 19200, 28800, 38400, 57600, 115200,
772 /*
773 * Higher speeds are probably possible. PL2303X supports up to
774 * 6Mb and can set any rate
775 */
776 230400, 460800, 614400, 921600, 1228800
777 };
778 #define N_UPLCOM_RATES (sizeof(uplcom_rates)/sizeof(uplcom_rates[0]))
779
780 static int
781 uplcom_param(void *addr, int portno, struct termios *t)
782 {
783 struct uplcom_softc *sc = addr;
784 usbd_status err;
785 usb_cdc_line_state_t ls;
786 int i;
787
788 DPRINTF(("uplcom_param: sc = %p\n", sc));
789
790 /* Check requested baud rate */
791 for (i = 0; i < N_UPLCOM_RATES; i++)
792 if (uplcom_rates[i] == t->c_ospeed)
793 break;
794 if (i == N_UPLCOM_RATES) {
795 DPRINTF(("uplcom_param: bad baud rate (%d)\n", t->c_ospeed));
796 return (EIO);
797 }
798
799 USETDW(ls.dwDTERate, t->c_ospeed);
800 if (ISSET(t->c_cflag, CSTOPB))
801 ls.bCharFormat = UCDC_STOP_BIT_2;
802 else
803 ls.bCharFormat = UCDC_STOP_BIT_1;
804 if (ISSET(t->c_cflag, PARENB)) {
805 if (ISSET(t->c_cflag, PARODD))
806 ls.bParityType = UCDC_PARITY_ODD;
807 else
808 ls.bParityType = UCDC_PARITY_EVEN;
809 } else
810 ls.bParityType = UCDC_PARITY_NONE;
811 switch (ISSET(t->c_cflag, CSIZE)) {
812 case CS5:
813 ls.bDataBits = 5;
814 break;
815 case CS6:
816 ls.bDataBits = 6;
817 break;
818 case CS7:
819 ls.bDataBits = 7;
820 break;
821 case CS8:
822 ls.bDataBits = 8;
823 break;
824 }
825
826 err = uplcom_set_line_coding(sc, &ls);
827 if (err)
828 return (EIO);
829
830 if (ISSET(t->c_cflag, CRTSCTS)) {
831 err = uplcom_set_crtscts(sc);
832 if (err)
833 return (EIO);
834 }
835
836 return (0);
837 }
838
839 static int
840 uplcom_open(void *addr, int portno)
841 {
842 struct uplcom_softc *sc = addr;
843 int err;
844
845 if (sc->sc_ucom.sc_dying)
846 return (ENXIO);
847
848 DPRINTF(("uplcom_open: sc = %p\n", sc));
849
850 if (sc->sc_intr_number != -1 && sc->sc_intr_pipe == NULL) {
851 sc->sc_status = 0; /* clear status bit */
852 sc->sc_intr_buf = kmalloc(sc->sc_isize, M_USBDEV, M_WAITOK);
853 err = usbd_open_pipe_intr(sc->sc_intr_iface,
854 sc->sc_intr_number,
855 USBD_SHORT_XFER_OK,
856 &sc->sc_intr_pipe,
857 sc,
858 sc->sc_intr_buf,
859 sc->sc_isize,
860 uplcom_intr,
861 uplcominterval);
862 if (err) {
863 device_printf(sc->sc_ucom.sc_dev, "cannot open "
864 "interrupt pipe (addr %d)\n",
865 sc->sc_intr_number);
866 return (EIO);
867 }
868 }
869
870 if (sc->sc_chiptype == TYPE_PL2303X)
871 return (uplcom_pl2303x_init(sc));
872
873 return (0);
874 }
875
876 static void
877 uplcom_close(void *addr, int portno)
878 {
879 struct uplcom_softc *sc = addr;
880 int err;
881
882 if (sc->sc_ucom.sc_dying)
883 return;
884
885 DPRINTF(("uplcom_close: close\n"));
886
887 if (sc->sc_intr_pipe != NULL) {
888 err = usbd_abort_pipe(sc->sc_intr_pipe);
889 if (err)
890 device_printf(sc->sc_ucom.sc_dev, "abort interrupt "
891 "pipe failed: %s\n", usbd_errstr(err));
892 err = usbd_close_pipe(sc->sc_intr_pipe);
893 if (err)
894 device_printf(sc->sc_ucom.sc_dev, "close interrupt "
895 "pipe failed: %s\n", usbd_errstr(err));
896 kfree(sc->sc_intr_buf, M_USBDEV);
897 sc->sc_intr_pipe = NULL;
898 }
899 }
900
901 static void
902 uplcom_intr(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
903 {
904 struct uplcom_softc *sc = priv;
905 u_char *buf = sc->sc_intr_buf;
906 u_char pstatus;
907
908 if (sc->sc_ucom.sc_dying)
909 return;
910
911 if (status != USBD_NORMAL_COMPLETION) {
912 if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
913 return;
914
915 DPRINTF(("%s: uplcom_intr: abnormal status: %s\n",
916 device_get_nameunit(sc->sc_ucom.sc_dev),
917 usbd_errstr(status)));
918 usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
919 return;
920 }
921
922 DPRINTF(("%s: uplcom status = %02x\n",
923 device_get_nameunit(sc->sc_ucom.sc_dev), buf[8]));
924
925 sc->sc_lsr = sc->sc_msr = 0;
926 pstatus = buf[8];
927 if (ISSET(pstatus, RSAQ_STATUS_CTS))
928 sc->sc_msr |= UMSR_CTS;
929 else
930 sc->sc_msr &= ~UMSR_CTS;
931 if (ISSET(pstatus, RSAQ_STATUS_DSR))
932 sc->sc_msr |= UMSR_DSR;
933 else
934 sc->sc_msr &= ~UMSR_DSR;
935 if (ISSET(pstatus, RSAQ_STATUS_DCD))
936 sc->sc_msr |= UMSR_DCD;
937 else
938 sc->sc_msr &= ~UMSR_DCD;
939
940 /* Deferred notifying to the ucom layer */
941 taskqueue_enqueue(taskqueue_swi, &sc->sc_task);
942 }
943
944 static void
945 uplcom_notify(void *arg, int count)
946 {
947 struct uplcom_softc *sc;
948
949 sc = (struct uplcom_softc *)arg;
950 if (sc->sc_ucom.sc_dying)
951 return;
952 ucom_status_change(&sc->sc_ucom);
953 }
954
955 static void
956 uplcom_get_status(void *addr, int portno, u_char *lsr, u_char *msr)
957 {
958 struct uplcom_softc *sc = addr;
959
960 DPRINTF(("uplcom_get_status:\n"));
961
962 if (lsr != NULL)
963 *lsr = sc->sc_lsr;
964 if (msr != NULL)
965 *msr = sc->sc_msr;
966 }
967
968 #if 0 /* TODO */
969 static int
970 uplcom_ioctl(void *addr, int portno, u_long cmd, caddr_t data, int flag,
971 struct thread *p)
972 {
973 struct uplcom_softc *sc = addr;
974 int error = 0;
975
976 if (sc->sc_ucom.sc_dying)
977 return (EIO);
978
979 DPRINTF(("uplcom_ioctl: cmd = 0x%08lx\n", cmd));
980
981 switch (cmd) {
982 case TIOCNOTTY:
983 case TIOCMGET:
984 case TIOCMSET:
985 case USB_GET_CM_OVER_DATA:
986 case USB_SET_CM_OVER_DATA:
987 break;
988
989 default:
990 DPRINTF(("uplcom_ioctl: unknown\n"));
991 error = ENOTTY;
992 break;
993 }
994
995 return (error);
996 }
997 #endif
DragonFly BSD