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