uplcom.c revision 1.43 1 1.43 augustss /* $NetBSD: uplcom.c,v 1.43 2005/05/11 20:25:01 augustss Exp $ */
2 1.1 ichiro /*
3 1.3 ichiro * Copyright (c) 2001 The NetBSD Foundation, Inc.
4 1.1 ichiro * All rights reserved.
5 1.1 ichiro *
6 1.1 ichiro * This code is derived from software contributed to The NetBSD Foundation
7 1.12 ichiro * by Ichiro FUKUHARA (ichiro (at) ichiro.org).
8 1.1 ichiro *
9 1.1 ichiro * Redistribution and use in source and binary forms, with or without
10 1.1 ichiro * modification, are permitted provided that the following conditions
11 1.1 ichiro * are met:
12 1.1 ichiro * 1. Redistributions of source code must retain the above copyright
13 1.1 ichiro * notice, this list of conditions and the following disclaimer.
14 1.1 ichiro * 2. Redistributions in binary form must reproduce the above copyright
15 1.1 ichiro * notice, this list of conditions and the following disclaimer in the
16 1.1 ichiro * documentation and/or other materials provided with the distribution.
17 1.1 ichiro * 3. All advertising materials mentioning features or use of this software
18 1.1 ichiro * must display the following acknowledgement:
19 1.1 ichiro * This product includes software developed by the NetBSD
20 1.1 ichiro * Foundation, Inc. and its contributors.
21 1.1 ichiro * 4. Neither the name of The NetBSD Foundation nor the names of its
22 1.1 ichiro * contributors may be used to endorse or promote products derived
23 1.1 ichiro * from this software without specific prior written permission.
24 1.1 ichiro *
25 1.1 ichiro * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26 1.1 ichiro * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27 1.1 ichiro * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 1.1 ichiro * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29 1.1 ichiro * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 1.1 ichiro * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 1.1 ichiro * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 1.1 ichiro * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 1.1 ichiro * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 1.1 ichiro * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 1.1 ichiro * POSSIBILITY OF SUCH DAMAGE.
36 1.1 ichiro */
37 1.1 ichiro
38 1.1 ichiro /*
39 1.31 wiz * General information: http://www.prolific.com.tw/fr_pl2303.htm
40 1.31 wiz * http://www.hitachi-hitec.com/jyouhou/prolific/2303.pdf
41 1.1 ichiro */
42 1.21 lukem
43 1.21 lukem #include <sys/cdefs.h>
44 1.43 augustss __KERNEL_RCSID(0, "$NetBSD: uplcom.c,v 1.43 2005/05/11 20:25:01 augustss Exp $");
45 1.1 ichiro
46 1.1 ichiro #include <sys/param.h>
47 1.1 ichiro #include <sys/systm.h>
48 1.1 ichiro #include <sys/kernel.h>
49 1.12 ichiro #include <sys/malloc.h>
50 1.1 ichiro #include <sys/ioctl.h>
51 1.1 ichiro #include <sys/conf.h>
52 1.1 ichiro #include <sys/tty.h>
53 1.1 ichiro #include <sys/file.h>
54 1.1 ichiro #include <sys/select.h>
55 1.1 ichiro #include <sys/proc.h>
56 1.1 ichiro #include <sys/device.h>
57 1.1 ichiro #include <sys/poll.h>
58 1.1 ichiro
59 1.1 ichiro #include <dev/usb/usb.h>
60 1.1 ichiro #include <dev/usb/usbcdc.h>
61 1.1 ichiro
62 1.1 ichiro #include <dev/usb/usbdi.h>
63 1.1 ichiro #include <dev/usb/usbdi_util.h>
64 1.1 ichiro #include <dev/usb/usbdevs.h>
65 1.1 ichiro #include <dev/usb/usb_quirks.h>
66 1.1 ichiro
67 1.1 ichiro #include <dev/usb/usbdevs.h>
68 1.1 ichiro #include <dev/usb/ucomvar.h>
69 1.1 ichiro
70 1.1 ichiro #ifdef UPLCOM_DEBUG
71 1.1 ichiro #define DPRINTFN(n, x) if (uplcomdebug > (n)) logprintf x
72 1.12 ichiro int uplcomdebug = 0;
73 1.1 ichiro #else
74 1.1 ichiro #define DPRINTFN(n, x)
75 1.1 ichiro #endif
76 1.1 ichiro #define DPRINTF(x) DPRINTFN(0, x)
77 1.1 ichiro
78 1.1 ichiro #define UPLCOM_CONFIG_INDEX 0
79 1.10 ichiro #define UPLCOM_IFACE_INDEX 0
80 1.10 ichiro #define UPLCOM_SECOND_IFACE_INDEX 1
81 1.1 ichiro
82 1.19 ichiro #define UPLCOM_SET_REQUEST 0x01
83 1.43 augustss #define UPLCOM_SET_CRTSCTS_0 0x41
84 1.43 augustss #define UPLCOM_SET_CRTSCTS_HX 0x61
85 1.12 ichiro #define RSAQ_STATUS_DSR 0x02
86 1.12 ichiro #define RSAQ_STATUS_DCD 0x01
87 1.12 ichiro
88 1.37 martin #define UPLCOM_FLOW_OUT_CTS 0x0001
89 1.37 martin #define UPLCOM_FLOW_OUT_DSR 0x0002
90 1.37 martin #define UPLCOM_FLOW_IN_DSR 0x0004
91 1.37 martin #define UPLCOM_FLOW_IN_DTR 0x0008
92 1.37 martin #define UPLCOM_FLOW_IN_RTS 0x0010
93 1.37 martin #define UPLCOM_FLOW_OUT_RTS 0x0020
94 1.37 martin #define UPLCOM_FLOW_OUT_XON 0x0080
95 1.37 martin #define UPLCOM_FLOW_IN_XON 0x0100
96 1.37 martin
97 1.43 augustss enum pl2303_type {
98 1.43 augustss UPLCOM_TYPE_0,
99 1.43 augustss UPLCOM_TYPE_HX,
100 1.43 augustss };
101 1.43 augustss
102 1.1 ichiro struct uplcom_softc {
103 1.1 ichiro USBBASEDEVICE sc_dev; /* base device */
104 1.1 ichiro usbd_device_handle sc_udev; /* USB device */
105 1.14 ichiro usbd_interface_handle sc_iface; /* interface */
106 1.1 ichiro int sc_iface_number; /* interface number */
107 1.1 ichiro
108 1.20 ichiro usbd_interface_handle sc_intr_iface; /* interrupt interface */
109 1.12 ichiro int sc_intr_number; /* interrupt number */
110 1.12 ichiro usbd_pipe_handle sc_intr_pipe; /* interrupt pipe */
111 1.12 ichiro u_char *sc_intr_buf; /* interrupt buffer */
112 1.12 ichiro int sc_isize;
113 1.12 ichiro
114 1.1 ichiro usb_cdc_line_state_t sc_line_state; /* current line state */
115 1.37 martin int sc_dtr; /* current DTR state */
116 1.37 martin int sc_rts; /* current RTS state */
117 1.1 ichiro
118 1.12 ichiro device_ptr_t sc_subdev; /* ucom device */
119 1.1 ichiro
120 1.13 ichiro u_char sc_dying; /* disconnecting */
121 1.12 ichiro
122 1.12 ichiro u_char sc_lsr; /* Local status register */
123 1.12 ichiro u_char sc_msr; /* uplcom status register */
124 1.43 augustss
125 1.43 augustss enum pl2303_type sc_type; /* PL2303 chip type */
126 1.1 ichiro };
127 1.1 ichiro
128 1.1 ichiro /*
129 1.1 ichiro * These are the maximum number of bytes transferred per frame.
130 1.1 ichiro * The output buffer size cannot be increased due to the size encoding.
131 1.1 ichiro */
132 1.6 augustss #define UPLCOMIBUFSIZE 256
133 1.6 augustss #define UPLCOMOBUFSIZE 256
134 1.1 ichiro
135 1.11 ichiro Static usbd_status uplcom_reset(struct uplcom_softc *);
136 1.1 ichiro Static usbd_status uplcom_set_line_coding(struct uplcom_softc *sc,
137 1.6 augustss usb_cdc_line_state_t *state);
138 1.19 ichiro Static usbd_status uplcom_set_crtscts(struct uplcom_softc *);
139 1.12 ichiro Static void uplcom_intr(usbd_xfer_handle, usbd_private_handle, usbd_status);
140 1.1 ichiro
141 1.12 ichiro Static void uplcom_set(void *, int, int, int);
142 1.12 ichiro Static void uplcom_dtr(struct uplcom_softc *, int);
143 1.12 ichiro Static void uplcom_rts(struct uplcom_softc *, int);
144 1.12 ichiro Static void uplcom_break(struct uplcom_softc *, int);
145 1.12 ichiro Static void uplcom_set_line_state(struct uplcom_softc *);
146 1.12 ichiro Static void uplcom_get_status(void *, int portno, u_char *lsr, u_char *msr);
147 1.12 ichiro #if TODO
148 1.24 augustss Static int uplcom_ioctl(void *, int, u_long, caddr_t, int, usb_proc_ptr );
149 1.12 ichiro #endif
150 1.12 ichiro Static int uplcom_param(void *, int, struct termios *);
151 1.12 ichiro Static int uplcom_open(void *, int);
152 1.12 ichiro Static void uplcom_close(void *, int);
153 1.43 augustss Static usbd_status uplcom_vendor_control_write(usbd_device_handle, u_int16_t, u_int16_t);
154 1.1 ichiro
155 1.1 ichiro struct ucom_methods uplcom_methods = {
156 1.12 ichiro uplcom_get_status,
157 1.1 ichiro uplcom_set,
158 1.1 ichiro uplcom_param,
159 1.12 ichiro NULL, /* uplcom_ioctl, TODO */
160 1.11 ichiro uplcom_open,
161 1.11 ichiro uplcom_close,
162 1.1 ichiro NULL,
163 1.1 ichiro NULL,
164 1.1 ichiro };
165 1.1 ichiro
166 1.23 augustss static const struct usb_devno uplcom_devs[] = {
167 1.1 ichiro /* I/O DATA USB-RSAQ2 */
168 1.17 jhawk { USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_RSAQ2 },
169 1.13 ichiro /* I/O DATA USB-RSAQ */
170 1.10 ichiro { USB_VENDOR_IODATA, USB_PRODUCT_IODATA_USBRSAQ },
171 1.16 ichiro /* PLANEX USB-RS232 URS-03 */
172 1.16 ichiro { USB_VENDOR_ATEN, USB_PRODUCT_ATEN_UC232A },
173 1.17 jhawk /* IOGEAR/ATEN UC-232A */
174 1.18 jhawk { USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_PL2303 },
175 1.34 augustss /* IOGEAR/ATENTRIPPLITE */
176 1.34 augustss { USB_VENDOR_TRIPPLITE, USB_PRODUCT_TRIPPLITE_U209 },
177 1.22 augustss /* ELECOM UC-SGT */
178 1.22 augustss { USB_VENDOR_ELECOM, USB_PRODUCT_ELECOM_UCSGT },
179 1.25 ichiro /* RATOC REX-USB60 */
180 1.25 ichiro { USB_VENDOR_RATOC, USB_PRODUCT_RATOC_REXUSB60 },
181 1.26 ichiro /* TDK USB-PHS Adapter UHA6400 */
182 1.26 ichiro { USB_VENDOR_TDK, USB_PRODUCT_TDK_UHA6400 },
183 1.27 ichiro /* TDK USB-PDC Adapter UPA9664 */
184 1.27 ichiro { USB_VENDOR_TDK, USB_PRODUCT_TDK_UPA9664 },
185 1.30 augustss /* Sony Ericsson USB Cable */
186 1.40 augustss { USB_VENDOR_SUSTEEN, USB_PRODUCT_SUSTEEN_DCU10 },
187 1.32 augustss /* SOURCENEXT KeikaiDenwa 8 */
188 1.32 augustss { USB_VENDOR_SOURCENEXT, USB_PRODUCT_SOURCENEXT_KEIKAI8 },
189 1.32 augustss /* SOURCENEXT KeikaiDenwa 8 with charger */
190 1.32 augustss { USB_VENDOR_SOURCENEXT, USB_PRODUCT_SOURCENEXT_KEIKAI8_CHG },
191 1.32 augustss /* HAL Corporation Crossam2+USB */
192 1.32 augustss { USB_VENDOR_HAL, USB_PRODUCT_HAL_IMR001 },
193 1.38 jdolecek /* Sitecom USB to serial cable */
194 1.40 augustss { USB_VENDOR_SITECOM, USB_PRODUCT_SITECOM_CN104 },
195 1.41 augustss /* Pharos USB GPS - Microsoft version */
196 1.41 augustss { USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_PL2303X },
197 1.1 ichiro };
198 1.23 augustss #define uplcom_lookup(v, p) usb_lookup(uplcom_devs, v, p)
199 1.32 augustss
200 1.1 ichiro
201 1.1 ichiro USB_DECLARE_DRIVER(uplcom);
202 1.1 ichiro
203 1.1 ichiro USB_MATCH(uplcom)
204 1.1 ichiro {
205 1.1 ichiro USB_MATCH_START(uplcom, uaa);
206 1.1 ichiro
207 1.6 augustss if (uaa->iface != NULL)
208 1.1 ichiro return (UMATCH_NONE);
209 1.1 ichiro
210 1.23 augustss return (uplcom_lookup(uaa->vendor, uaa->product) != NULL ?
211 1.23 augustss UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
212 1.1 ichiro }
213 1.1 ichiro
214 1.1 ichiro USB_ATTACH(uplcom)
215 1.1 ichiro {
216 1.1 ichiro USB_ATTACH_START(uplcom, sc, uaa);
217 1.1 ichiro usbd_device_handle dev = uaa->device;
218 1.43 augustss usb_device_descriptor_t *ddesc;
219 1.10 ichiro usb_config_descriptor_t *cdesc;
220 1.1 ichiro usb_interface_descriptor_t *id;
221 1.1 ichiro usb_endpoint_descriptor_t *ed;
222 1.42 augustss char *devinfop;
223 1.1 ichiro char *devname = USBDEVNAME(sc->sc_dev);
224 1.1 ichiro usbd_status err;
225 1.1 ichiro int i;
226 1.1 ichiro struct ucom_attach_args uca;
227 1.1 ichiro
228 1.42 augustss devinfop = usbd_devinfo_alloc(dev, 0);
229 1.42 augustss USB_ATTACH_SETUP;
230 1.42 augustss printf("%s: %s\n", devname, devinfop);
231 1.42 augustss usbd_devinfo_free(devinfop);
232 1.10 ichiro
233 1.10 ichiro sc->sc_udev = dev;
234 1.10 ichiro
235 1.1 ichiro DPRINTF(("\n\nuplcom attach: sc=%p\n", sc));
236 1.1 ichiro
237 1.28 augustss /* initialize endpoints */
238 1.13 ichiro uca.bulkin = uca.bulkout = -1;
239 1.13 ichiro sc->sc_intr_number = -1;
240 1.13 ichiro sc->sc_intr_pipe = NULL;
241 1.13 ichiro
242 1.6 augustss /* Move the device into the configured state. */
243 1.1 ichiro err = usbd_set_config_index(dev, UPLCOM_CONFIG_INDEX, 1);
244 1.1 ichiro if (err) {
245 1.1 ichiro printf("\n%s: failed to set configuration, err=%s\n",
246 1.1 ichiro devname, usbd_errstr(err));
247 1.13 ichiro sc->sc_dying = 1;
248 1.1 ichiro USB_ATTACH_ERROR_RETURN;
249 1.1 ichiro }
250 1.1 ichiro
251 1.43 augustss /* get the device descriptor */
252 1.43 augustss ddesc = usbd_get_device_descriptor(sc->sc_udev);
253 1.43 augustss if (ddesc == NULL) {
254 1.43 augustss printf("%s: failed to get device descriptor\n",
255 1.43 augustss USBDEVNAME(sc->sc_dev));
256 1.43 augustss sc->sc_dying = 1;
257 1.43 augustss USB_ATTACH_ERROR_RETURN;
258 1.43 augustss }
259 1.43 augustss
260 1.43 augustss /*
261 1.43 augustss * NOTE: The Linux driver distinguishes between UPLCOM_TYPE_0
262 1.43 augustss * and UPLCOM_TYPE_1 type chips by testing other fields in the
263 1.43 augustss * device descriptor. As far as the uplcom driver is
264 1.43 augustss * concerned, both types are identical.
265 1.43 augustss * The bcdDevice field should also distinguish these versions,
266 1.43 augustss * but who knows.
267 1.43 augustss */
268 1.43 augustss if (UGETW(ddesc->bcdDevice) == 0x0300)
269 1.43 augustss sc->sc_type = UPLCOM_TYPE_HX;
270 1.43 augustss else
271 1.43 augustss sc->sc_type = UPLCOM_TYPE_0;
272 1.43 augustss
273 1.10 ichiro /* get the config descriptor */
274 1.10 ichiro cdesc = usbd_get_config_descriptor(sc->sc_udev);
275 1.10 ichiro
276 1.10 ichiro if (cdesc == NULL) {
277 1.10 ichiro printf("%s: failed to get configuration descriptor\n",
278 1.10 ichiro USBDEVNAME(sc->sc_dev));
279 1.13 ichiro sc->sc_dying = 1;
280 1.10 ichiro USB_ATTACH_ERROR_RETURN;
281 1.10 ichiro }
282 1.10 ichiro
283 1.13 ichiro /* get the (first/common) interface */
284 1.28 augustss err = usbd_device2interface_handle(dev, UPLCOM_IFACE_INDEX,
285 1.10 ichiro &sc->sc_iface);
286 1.1 ichiro if (err) {
287 1.1 ichiro printf("\n%s: failed to get interface, err=%s\n",
288 1.1 ichiro devname, usbd_errstr(err));
289 1.13 ichiro sc->sc_dying = 1;
290 1.1 ichiro USB_ATTACH_ERROR_RETURN;
291 1.1 ichiro }
292 1.13 ichiro
293 1.13 ichiro /* Find the interrupt endpoints */
294 1.13 ichiro
295 1.13 ichiro id = usbd_get_interface_descriptor(sc->sc_iface);
296 1.13 ichiro sc->sc_iface_number = id->bInterfaceNumber;
297 1.13 ichiro
298 1.13 ichiro for (i = 0; i < id->bNumEndpoints; i++) {
299 1.13 ichiro ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
300 1.13 ichiro if (ed == NULL) {
301 1.13 ichiro printf("%s: no endpoint descriptor for %d\n",
302 1.13 ichiro USBDEVNAME(sc->sc_dev), i);
303 1.13 ichiro sc->sc_dying = 1;
304 1.13 ichiro USB_ATTACH_ERROR_RETURN;
305 1.13 ichiro }
306 1.13 ichiro
307 1.13 ichiro if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
308 1.13 ichiro UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
309 1.13 ichiro sc->sc_intr_number = ed->bEndpointAddress;
310 1.13 ichiro sc->sc_isize = UGETW(ed->wMaxPacketSize);
311 1.28 augustss }
312 1.13 ichiro }
313 1.13 ichiro
314 1.13 ichiro if (sc->sc_intr_number== -1) {
315 1.13 ichiro printf("%s: Could not find interrupt in\n",
316 1.13 ichiro USBDEVNAME(sc->sc_dev));
317 1.13 ichiro sc->sc_dying = 1;
318 1.13 ichiro USB_ATTACH_ERROR_RETURN;
319 1.13 ichiro }
320 1.13 ichiro
321 1.20 ichiro /* keep interface for interrupt */
322 1.20 ichiro sc->sc_intr_iface = sc->sc_iface;
323 1.20 ichiro
324 1.10 ichiro /*
325 1.13 ichiro * USB-RSAQ1 has two interface
326 1.13 ichiro *
327 1.13 ichiro * USB-RSAQ1 | USB-RSAQ2
328 1.13 ichiro * -----------------+-----------------
329 1.14 ichiro * Interface 0 |Interface 0
330 1.14 ichiro * Interrupt(0x81) | Interrupt(0x81)
331 1.13 ichiro * -----------------+ BulkIN(0x02)
332 1.14 ichiro * Interface 1 | BulkOUT(0x83)
333 1.28 augustss * BulkIN(0x02) |
334 1.13 ichiro * BulkOUT(0x83) |
335 1.10 ichiro */
336 1.10 ichiro if (cdesc->bNumInterface == 2) {
337 1.28 augustss err = usbd_device2interface_handle(dev,
338 1.13 ichiro UPLCOM_SECOND_IFACE_INDEX, &sc->sc_iface);
339 1.10 ichiro if (err) {
340 1.10 ichiro printf("\n%s: failed to get second interface, err=%s\n",
341 1.10 ichiro devname, usbd_errstr(err));
342 1.13 ichiro sc->sc_dying = 1;
343 1.10 ichiro USB_ATTACH_ERROR_RETURN;
344 1.10 ichiro }
345 1.28 augustss }
346 1.1 ichiro
347 1.13 ichiro /* Find the bulk{in,out} endpoints */
348 1.1 ichiro
349 1.12 ichiro id = usbd_get_interface_descriptor(sc->sc_iface);
350 1.1 ichiro sc->sc_iface_number = id->bInterfaceNumber;
351 1.1 ichiro
352 1.1 ichiro for (i = 0; i < id->bNumEndpoints; i++) {
353 1.12 ichiro ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
354 1.1 ichiro if (ed == NULL) {
355 1.1 ichiro printf("%s: no endpoint descriptor for %d\n",
356 1.1 ichiro USBDEVNAME(sc->sc_dev), i);
357 1.13 ichiro sc->sc_dying = 1;
358 1.1 ichiro USB_ATTACH_ERROR_RETURN;
359 1.1 ichiro }
360 1.1 ichiro
361 1.1 ichiro if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
362 1.1 ichiro UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
363 1.1 ichiro uca.bulkin = ed->bEndpointAddress;
364 1.1 ichiro } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
365 1.1 ichiro UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
366 1.1 ichiro uca.bulkout = ed->bEndpointAddress;
367 1.1 ichiro }
368 1.1 ichiro }
369 1.1 ichiro
370 1.1 ichiro if (uca.bulkin == -1) {
371 1.1 ichiro printf("%s: Could not find data bulk in\n",
372 1.1 ichiro USBDEVNAME(sc->sc_dev));
373 1.13 ichiro sc->sc_dying = 1;
374 1.1 ichiro USB_ATTACH_ERROR_RETURN;
375 1.1 ichiro }
376 1.1 ichiro
377 1.1 ichiro if (uca.bulkout == -1) {
378 1.1 ichiro printf("%s: Could not find data bulk out\n",
379 1.1 ichiro USBDEVNAME(sc->sc_dev));
380 1.13 ichiro sc->sc_dying = 1;
381 1.12 ichiro USB_ATTACH_ERROR_RETURN;
382 1.12 ichiro }
383 1.12 ichiro
384 1.37 martin sc->sc_dtr = sc->sc_rts = -1;
385 1.1 ichiro uca.portno = UCOM_UNK_PORTNO;
386 1.1 ichiro /* bulkin, bulkout set above */
387 1.1 ichiro uca.ibufsize = UPLCOMIBUFSIZE;
388 1.1 ichiro uca.obufsize = UPLCOMOBUFSIZE;
389 1.1 ichiro uca.ibufsizepad = UPLCOMIBUFSIZE;
390 1.4 ichiro uca.opkthdrlen = 0;
391 1.1 ichiro uca.device = dev;
392 1.12 ichiro uca.iface = sc->sc_iface;
393 1.1 ichiro uca.methods = &uplcom_methods;
394 1.1 ichiro uca.arg = sc;
395 1.8 augustss uca.info = NULL;
396 1.1 ichiro
397 1.11 ichiro err = uplcom_reset(sc);
398 1.11 ichiro
399 1.1 ichiro if (err) {
400 1.11 ichiro printf("%s: reset failed, %s\n", USBDEVNAME(sc->sc_dev),
401 1.1 ichiro usbd_errstr(err));
402 1.13 ichiro sc->sc_dying = 1;
403 1.1 ichiro USB_ATTACH_ERROR_RETURN;
404 1.1 ichiro }
405 1.1 ichiro
406 1.7 augustss usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
407 1.7 augustss USBDEV(sc->sc_dev));
408 1.7 augustss
409 1.12 ichiro DPRINTF(("uplcom: in=0x%x out=0x%x intr=0x%x\n",
410 1.12 ichiro uca.bulkin, uca.bulkout, sc->sc_intr_number ));
411 1.39 drochner sc->sc_subdev = config_found_sm_loc(self, "ucombus", NULL, &uca,
412 1.39 drochner ucomprint, ucomsubmatch);
413 1.1 ichiro
414 1.1 ichiro USB_ATTACH_SUCCESS_RETURN;
415 1.1 ichiro }
416 1.1 ichiro
417 1.1 ichiro USB_DETACH(uplcom)
418 1.1 ichiro {
419 1.1 ichiro USB_DETACH_START(uplcom, sc);
420 1.1 ichiro int rv = 0;
421 1.1 ichiro
422 1.1 ichiro DPRINTF(("uplcom_detach: sc=%p flags=%d\n", sc, flags));
423 1.12 ichiro
424 1.12 ichiro if (sc->sc_intr_pipe != NULL) {
425 1.12 ichiro usbd_abort_pipe(sc->sc_intr_pipe);
426 1.12 ichiro usbd_close_pipe(sc->sc_intr_pipe);
427 1.12 ichiro free(sc->sc_intr_buf, M_USBDEV);
428 1.12 ichiro sc->sc_intr_pipe = NULL;
429 1.12 ichiro }
430 1.12 ichiro
431 1.1 ichiro sc->sc_dying = 1;
432 1.6 augustss if (sc->sc_subdev != NULL) {
433 1.1 ichiro rv = config_detach(sc->sc_subdev, flags);
434 1.6 augustss sc->sc_subdev = NULL;
435 1.6 augustss }
436 1.7 augustss
437 1.7 augustss usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
438 1.7 augustss USBDEV(sc->sc_dev));
439 1.1 ichiro
440 1.1 ichiro return (rv);
441 1.1 ichiro }
442 1.1 ichiro
443 1.1 ichiro int
444 1.1 ichiro uplcom_activate(device_ptr_t self, enum devact act)
445 1.1 ichiro {
446 1.1 ichiro struct uplcom_softc *sc = (struct uplcom_softc *)self;
447 1.1 ichiro int rv = 0;
448 1.1 ichiro
449 1.1 ichiro switch (act) {
450 1.1 ichiro case DVACT_ACTIVATE:
451 1.1 ichiro return (EOPNOTSUPP);
452 1.1 ichiro
453 1.1 ichiro case DVACT_DEACTIVATE:
454 1.1 ichiro if (sc->sc_subdev != NULL)
455 1.1 ichiro rv = config_deactivate(sc->sc_subdev);
456 1.1 ichiro sc->sc_dying = 1;
457 1.1 ichiro break;
458 1.1 ichiro }
459 1.1 ichiro return (rv);
460 1.1 ichiro }
461 1.1 ichiro
462 1.1 ichiro usbd_status
463 1.11 ichiro uplcom_reset(struct uplcom_softc *sc)
464 1.1 ichiro {
465 1.1 ichiro usb_device_request_t req;
466 1.1 ichiro usbd_status err;
467 1.1 ichiro
468 1.19 ichiro req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
469 1.19 ichiro req.bRequest = UPLCOM_SET_REQUEST;
470 1.19 ichiro USETW(req.wValue, 0);
471 1.1 ichiro USETW(req.wIndex, sc->sc_iface_number);
472 1.28 augustss USETW(req.wLength, 0);
473 1.28 augustss
474 1.28 augustss err = usbd_do_request(sc->sc_udev, &req, 0);
475 1.1 ichiro if (err)
476 1.1 ichiro return (EIO);
477 1.1 ichiro
478 1.1 ichiro return (0);
479 1.1 ichiro }
480 1.1 ichiro
481 1.1 ichiro void
482 1.1 ichiro uplcom_set_line_state(struct uplcom_softc *sc)
483 1.1 ichiro {
484 1.1 ichiro usb_device_request_t req;
485 1.1 ichiro int ls;
486 1.1 ichiro
487 1.37 martin /* make sure we have initialized state for sc_dtr and sc_rts */
488 1.37 martin if (sc->sc_dtr == -1)
489 1.37 martin sc->sc_dtr = 0;
490 1.37 martin if (sc->sc_rts == -1)
491 1.37 martin sc->sc_rts = 0;
492 1.37 martin
493 1.37 martin ls = (sc->sc_dtr ? UPLCOM_FLOW_OUT_DSR : 0) |
494 1.37 martin (sc->sc_rts ? UPLCOM_FLOW_OUT_CTS : 0);
495 1.37 martin
496 1.1 ichiro req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
497 1.1 ichiro req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
498 1.1 ichiro USETW(req.wValue, ls);
499 1.1 ichiro USETW(req.wIndex, sc->sc_iface_number);
500 1.1 ichiro USETW(req.wLength, 0);
501 1.1 ichiro
502 1.1 ichiro (void)usbd_do_request(sc->sc_udev, &req, 0);
503 1.1 ichiro }
504 1.1 ichiro
505 1.1 ichiro void
506 1.1 ichiro uplcom_set(void *addr, int portno, int reg, int onoff)
507 1.1 ichiro {
508 1.1 ichiro struct uplcom_softc *sc = addr;
509 1.1 ichiro
510 1.1 ichiro switch (reg) {
511 1.1 ichiro case UCOM_SET_DTR:
512 1.1 ichiro uplcom_dtr(sc, onoff);
513 1.1 ichiro break;
514 1.1 ichiro case UCOM_SET_RTS:
515 1.1 ichiro uplcom_rts(sc, onoff);
516 1.1 ichiro break;
517 1.1 ichiro case UCOM_SET_BREAK:
518 1.1 ichiro uplcom_break(sc, onoff);
519 1.1 ichiro break;
520 1.1 ichiro default:
521 1.1 ichiro break;
522 1.1 ichiro }
523 1.1 ichiro }
524 1.1 ichiro
525 1.1 ichiro void
526 1.1 ichiro uplcom_dtr(struct uplcom_softc *sc, int onoff)
527 1.1 ichiro {
528 1.1 ichiro
529 1.11 ichiro DPRINTF(("uplcom_dtr: onoff=%d\n", onoff));
530 1.1 ichiro
531 1.37 martin if (sc->sc_dtr != -1 && !sc->sc_dtr == !onoff)
532 1.1 ichiro return;
533 1.37 martin
534 1.37 martin sc->sc_dtr = !!onoff;
535 1.1 ichiro
536 1.1 ichiro uplcom_set_line_state(sc);
537 1.1 ichiro }
538 1.1 ichiro
539 1.1 ichiro void
540 1.1 ichiro uplcom_rts(struct uplcom_softc *sc, int onoff)
541 1.1 ichiro {
542 1.1 ichiro DPRINTF(("uplcom_rts: onoff=%d\n", onoff));
543 1.1 ichiro
544 1.37 martin if (sc->sc_rts != -1 && !sc->sc_rts == !onoff)
545 1.1 ichiro return;
546 1.37 martin
547 1.37 martin sc->sc_rts = !!onoff;
548 1.1 ichiro
549 1.1 ichiro uplcom_set_line_state(sc);
550 1.4 ichiro }
551 1.4 ichiro
552 1.4 ichiro void
553 1.4 ichiro uplcom_break(struct uplcom_softc *sc, int onoff)
554 1.4 ichiro {
555 1.4 ichiro usb_device_request_t req;
556 1.4 ichiro
557 1.4 ichiro DPRINTF(("uplcom_break: onoff=%d\n", onoff));
558 1.4 ichiro
559 1.4 ichiro req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
560 1.4 ichiro req.bRequest = UCDC_SEND_BREAK;
561 1.4 ichiro USETW(req.wValue, onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF);
562 1.4 ichiro USETW(req.wIndex, sc->sc_iface_number);
563 1.4 ichiro USETW(req.wLength, 0);
564 1.4 ichiro
565 1.4 ichiro (void)usbd_do_request(sc->sc_udev, &req, 0);
566 1.1 ichiro }
567 1.1 ichiro
568 1.1 ichiro usbd_status
569 1.19 ichiro uplcom_set_crtscts(struct uplcom_softc *sc)
570 1.19 ichiro {
571 1.19 ichiro usb_device_request_t req;
572 1.19 ichiro usbd_status err;
573 1.19 ichiro
574 1.19 ichiro DPRINTF(("uplcom_set_crtscts: on\n"));
575 1.19 ichiro
576 1.19 ichiro req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
577 1.19 ichiro req.bRequest = UPLCOM_SET_REQUEST;
578 1.19 ichiro USETW(req.wValue, 0);
579 1.43 augustss if (sc->sc_type == UPLCOM_TYPE_HX)
580 1.43 augustss USETW(req.wIndex, UPLCOM_SET_CRTSCTS_HX);
581 1.43 augustss else
582 1.43 augustss USETW(req.wIndex, UPLCOM_SET_CRTSCTS_0);
583 1.19 ichiro USETW(req.wLength, 0);
584 1.19 ichiro
585 1.19 ichiro err = usbd_do_request(sc->sc_udev, &req, 0);
586 1.19 ichiro if (err) {
587 1.19 ichiro DPRINTF(("uplcom_set_crtscts: failed, err=%s\n",
588 1.19 ichiro usbd_errstr(err)));
589 1.19 ichiro return (err);
590 1.19 ichiro }
591 1.19 ichiro
592 1.19 ichiro return (USBD_NORMAL_COMPLETION);
593 1.19 ichiro }
594 1.19 ichiro
595 1.19 ichiro usbd_status
596 1.1 ichiro uplcom_set_line_coding(struct uplcom_softc *sc, usb_cdc_line_state_t *state)
597 1.1 ichiro {
598 1.1 ichiro usb_device_request_t req;
599 1.1 ichiro usbd_status err;
600 1.1 ichiro
601 1.1 ichiro DPRINTF(("uplcom_set_line_coding: rate=%d fmt=%d parity=%d bits=%d\n",
602 1.1 ichiro UGETDW(state->dwDTERate), state->bCharFormat,
603 1.1 ichiro state->bParityType, state->bDataBits));
604 1.1 ichiro
605 1.1 ichiro if (memcmp(state, &sc->sc_line_state, UCDC_LINE_STATE_LENGTH) == 0) {
606 1.1 ichiro DPRINTF(("uplcom_set_line_coding: already set\n"));
607 1.1 ichiro return (USBD_NORMAL_COMPLETION);
608 1.1 ichiro }
609 1.1 ichiro
610 1.1 ichiro req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
611 1.1 ichiro req.bRequest = UCDC_SET_LINE_CODING;
612 1.1 ichiro USETW(req.wValue, 0);
613 1.1 ichiro USETW(req.wIndex, sc->sc_iface_number);
614 1.1 ichiro USETW(req.wLength, UCDC_LINE_STATE_LENGTH);
615 1.1 ichiro
616 1.1 ichiro err = usbd_do_request(sc->sc_udev, &req, state);
617 1.1 ichiro if (err) {
618 1.1 ichiro DPRINTF(("uplcom_set_line_coding: failed, err=%s\n",
619 1.1 ichiro usbd_errstr(err)));
620 1.1 ichiro return (err);
621 1.1 ichiro }
622 1.1 ichiro
623 1.1 ichiro sc->sc_line_state = *state;
624 1.1 ichiro
625 1.1 ichiro return (USBD_NORMAL_COMPLETION);
626 1.1 ichiro }
627 1.1 ichiro
628 1.1 ichiro int
629 1.1 ichiro uplcom_param(void *addr, int portno, struct termios *t)
630 1.1 ichiro {
631 1.1 ichiro struct uplcom_softc *sc = addr;
632 1.1 ichiro usbd_status err;
633 1.1 ichiro usb_cdc_line_state_t ls;
634 1.1 ichiro
635 1.1 ichiro DPRINTF(("uplcom_param: sc=%p\n", sc));
636 1.1 ichiro
637 1.1 ichiro USETDW(ls.dwDTERate, t->c_ospeed);
638 1.1 ichiro if (ISSET(t->c_cflag, CSTOPB))
639 1.1 ichiro ls.bCharFormat = UCDC_STOP_BIT_2;
640 1.1 ichiro else
641 1.1 ichiro ls.bCharFormat = UCDC_STOP_BIT_1;
642 1.1 ichiro if (ISSET(t->c_cflag, PARENB)) {
643 1.1 ichiro if (ISSET(t->c_cflag, PARODD))
644 1.1 ichiro ls.bParityType = UCDC_PARITY_ODD;
645 1.1 ichiro else
646 1.1 ichiro ls.bParityType = UCDC_PARITY_EVEN;
647 1.1 ichiro } else
648 1.1 ichiro ls.bParityType = UCDC_PARITY_NONE;
649 1.1 ichiro switch (ISSET(t->c_cflag, CSIZE)) {
650 1.1 ichiro case CS5:
651 1.1 ichiro ls.bDataBits = 5;
652 1.1 ichiro break;
653 1.1 ichiro case CS6:
654 1.1 ichiro ls.bDataBits = 6;
655 1.1 ichiro break;
656 1.1 ichiro case CS7:
657 1.1 ichiro ls.bDataBits = 7;
658 1.1 ichiro break;
659 1.1 ichiro case CS8:
660 1.1 ichiro ls.bDataBits = 8;
661 1.1 ichiro break;
662 1.1 ichiro }
663 1.1 ichiro
664 1.1 ichiro err = uplcom_set_line_coding(sc, &ls);
665 1.1 ichiro if (err) {
666 1.1 ichiro DPRINTF(("uplcom_param: err=%s\n", usbd_errstr(err)));
667 1.1 ichiro return (EIO);
668 1.1 ichiro }
669 1.19 ichiro
670 1.19 ichiro if (ISSET(t->c_cflag, CRTSCTS))
671 1.19 ichiro uplcom_set_crtscts(sc);
672 1.19 ichiro
673 1.37 martin if (sc->sc_rts == -1 || sc->sc_dtr == -1)
674 1.37 martin uplcom_set_line_state(sc);
675 1.37 martin
676 1.19 ichiro if (err) {
677 1.19 ichiro DPRINTF(("uplcom_param: err=%s\n", usbd_errstr(err)));
678 1.19 ichiro return (EIO);
679 1.19 ichiro }
680 1.19 ichiro
681 1.1 ichiro return (0);
682 1.11 ichiro }
683 1.11 ichiro
684 1.43 augustss Static usbd_status
685 1.43 augustss uplcom_vendor_control_write(usbd_device_handle dev, u_int16_t value, u_int16_t index)
686 1.43 augustss {
687 1.43 augustss usb_device_request_t req;
688 1.43 augustss usbd_status err;
689 1.43 augustss
690 1.43 augustss req.bmRequestType = UT_WRITE_VENDOR_DEVICE;
691 1.43 augustss req.bRequest = UPLCOM_SET_REQUEST;
692 1.43 augustss USETW(req.wValue, value);
693 1.43 augustss USETW(req.wIndex, index);
694 1.43 augustss USETW(req.wLength, 0);
695 1.43 augustss
696 1.43 augustss err = usbd_do_request(dev, &req, NULL);
697 1.43 augustss
698 1.43 augustss if (err) {
699 1.43 augustss DPRINTF(("uplcom_open: vendor write failed, err=%s (%d)\n",
700 1.43 augustss usbd_errstr(err), err));
701 1.43 augustss }
702 1.43 augustss
703 1.43 augustss return err;
704 1.43 augustss }
705 1.43 augustss
706 1.11 ichiro int
707 1.11 ichiro uplcom_open(void *addr, int portno)
708 1.11 ichiro {
709 1.11 ichiro struct uplcom_softc *sc = addr;
710 1.43 augustss usbd_status err;
711 1.28 augustss
712 1.11 ichiro if (sc->sc_dying)
713 1.11 ichiro return (EIO);
714 1.11 ichiro
715 1.12 ichiro DPRINTF(("uplcom_open: sc=%p\n", sc));
716 1.11 ichiro
717 1.43 augustss /* Some unknown device frobbing. */
718 1.43 augustss if (sc->sc_type == UPLCOM_TYPE_HX)
719 1.43 augustss uplcom_vendor_control_write(sc->sc_udev, 2, 0x44);
720 1.43 augustss else
721 1.43 augustss uplcom_vendor_control_write(sc->sc_udev, 2, 0x24);
722 1.43 augustss
723 1.12 ichiro if (sc->sc_intr_number != -1 && sc->sc_intr_pipe == NULL) {
724 1.12 ichiro sc->sc_intr_buf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK);
725 1.20 ichiro err = usbd_open_pipe_intr(sc->sc_intr_iface, sc->sc_intr_number,
726 1.12 ichiro USBD_SHORT_XFER_OK, &sc->sc_intr_pipe, sc,
727 1.12 ichiro sc->sc_intr_buf, sc->sc_isize,
728 1.12 ichiro uplcom_intr, USBD_DEFAULT_INTERVAL);
729 1.12 ichiro if (err) {
730 1.12 ichiro DPRINTF(("%s: cannot open interrupt pipe (addr %d)\n",
731 1.12 ichiro USBDEVNAME(sc->sc_dev), sc->sc_intr_number));
732 1.12 ichiro return (EIO);
733 1.12 ichiro }
734 1.12 ichiro }
735 1.11 ichiro
736 1.11 ichiro return (0);
737 1.11 ichiro }
738 1.11 ichiro
739 1.11 ichiro void
740 1.28 augustss uplcom_close(void *addr, int portno)
741 1.11 ichiro {
742 1.11 ichiro struct uplcom_softc *sc = addr;
743 1.12 ichiro int err;
744 1.12 ichiro
745 1.12 ichiro if (sc->sc_dying)
746 1.12 ichiro return;
747 1.12 ichiro
748 1.12 ichiro DPRINTF(("uplcom_close: close\n"));
749 1.12 ichiro
750 1.12 ichiro if (sc->sc_intr_pipe != NULL) {
751 1.12 ichiro err = usbd_abort_pipe(sc->sc_intr_pipe);
752 1.12 ichiro if (err)
753 1.12 ichiro printf("%s: abort interrupt pipe failed: %s\n",
754 1.12 ichiro USBDEVNAME(sc->sc_dev), usbd_errstr(err));
755 1.12 ichiro err = usbd_close_pipe(sc->sc_intr_pipe);
756 1.12 ichiro if (err)
757 1.12 ichiro printf("%s: close interrupt pipe failed: %s\n",
758 1.12 ichiro USBDEVNAME(sc->sc_dev), usbd_errstr(err));
759 1.12 ichiro free(sc->sc_intr_buf, M_USBDEV);
760 1.12 ichiro sc->sc_intr_pipe = NULL;
761 1.12 ichiro }
762 1.12 ichiro }
763 1.12 ichiro
764 1.12 ichiro void
765 1.12 ichiro uplcom_intr(usbd_xfer_handle xfer, usbd_private_handle priv, usbd_status status)
766 1.12 ichiro {
767 1.12 ichiro struct uplcom_softc *sc = priv;
768 1.12 ichiro u_char *buf = sc->sc_intr_buf;
769 1.12 ichiro u_char pstatus;
770 1.11 ichiro
771 1.11 ichiro if (sc->sc_dying)
772 1.11 ichiro return;
773 1.11 ichiro
774 1.12 ichiro if (status != USBD_NORMAL_COMPLETION) {
775 1.12 ichiro if (status == USBD_NOT_STARTED || status == USBD_CANCELLED)
776 1.12 ichiro return;
777 1.12 ichiro
778 1.12 ichiro DPRINTF(("%s: abnormal status: %s\n", USBDEVNAME(sc->sc_dev),
779 1.12 ichiro usbd_errstr(status)));
780 1.12 ichiro usbd_clear_endpoint_stall_async(sc->sc_intr_pipe);
781 1.12 ichiro return;
782 1.12 ichiro }
783 1.12 ichiro
784 1.12 ichiro DPRINTF(("%s: uplcom status = %02x\n", USBDEVNAME(sc->sc_dev), buf[8]));
785 1.12 ichiro
786 1.15 augustss sc->sc_lsr = sc->sc_msr = 0;
787 1.15 augustss pstatus = buf[8];
788 1.15 augustss if (ISSET(pstatus, RSAQ_STATUS_DSR))
789 1.15 augustss sc->sc_msr |= UMSR_DSR;
790 1.15 augustss if (ISSET(pstatus, RSAQ_STATUS_DCD))
791 1.15 augustss sc->sc_msr |= UMSR_DCD;
792 1.15 augustss ucom_status_change((struct ucom_softc *) sc->sc_subdev);
793 1.12 ichiro }
794 1.12 ichiro
795 1.12 ichiro void
796 1.12 ichiro uplcom_get_status(void *addr, int portno, u_char *lsr, u_char *msr)
797 1.12 ichiro {
798 1.12 ichiro struct uplcom_softc *sc = addr;
799 1.12 ichiro
800 1.12 ichiro DPRINTF(("uplcom_get_status:\n"));
801 1.12 ichiro
802 1.12 ichiro if (lsr != NULL)
803 1.12 ichiro *lsr = sc->sc_lsr;
804 1.12 ichiro if (msr != NULL)
805 1.12 ichiro *msr = sc->sc_msr;
806 1.12 ichiro }
807 1.12 ichiro
808 1.12 ichiro #if TODO
809 1.12 ichiro int
810 1.12 ichiro uplcom_ioctl(void *addr, int portno, u_long cmd, caddr_t data, int flag,
811 1.24 augustss usb_proc_ptr p)
812 1.12 ichiro {
813 1.12 ichiro struct uplcom_softc *sc = addr;
814 1.12 ichiro int error = 0;
815 1.12 ichiro
816 1.12 ichiro if (sc->sc_dying)
817 1.12 ichiro return (EIO);
818 1.12 ichiro
819 1.12 ichiro DPRINTF(("uplcom_ioctl: cmd=0x%08lx\n", cmd));
820 1.12 ichiro
821 1.12 ichiro switch (cmd) {
822 1.12 ichiro case TIOCNOTTY:
823 1.12 ichiro case TIOCMGET:
824 1.12 ichiro case TIOCMSET:
825 1.12 ichiro case USB_GET_CM_OVER_DATA:
826 1.12 ichiro case USB_SET_CM_OVER_DATA:
827 1.12 ichiro break;
828 1.12 ichiro
829 1.12 ichiro default:
830 1.12 ichiro DPRINTF(("uplcom_ioctl: unknown\n"));
831 1.12 ichiro error = ENOTTY;
832 1.12 ichiro break;
833 1.11 ichiro }
834 1.11 ichiro
835 1.12 ichiro return (error);
836 1.1 ichiro }
837 1.12 ichiro #endif
838