uipaq.c revision 1.9 1 1.9 dyoung /* $NetBSD: uipaq.c,v 1.9 2008/02/18 05:24:24 dyoung Exp $ */
2 1.1 augustss /* $OpenBSD: uipaq.c,v 1.1 2005/06/17 23:50:33 deraadt Exp $ */
3 1.1 augustss
4 1.1 augustss /*
5 1.1 augustss * Copyright (c) 2000-2005 The NetBSD Foundation, Inc.
6 1.1 augustss * All rights reserved.
7 1.1 augustss *
8 1.1 augustss * This code is derived from software contributed to The NetBSD Foundation
9 1.1 augustss * by Lennart Augustsson (lennart (at) augustsson.net) at
10 1.1 augustss * Carlstedt Research & Technology.
11 1.1 augustss *
12 1.1 augustss * Redistribution and use in source and binary forms, with or without
13 1.1 augustss * modification, are permitted provided that the following conditions
14 1.1 augustss * are met:
15 1.1 augustss * 1. Redistributions of source code must retain the above copyright
16 1.1 augustss * notice, this list of conditions and the following disclaimer.
17 1.1 augustss * 2. Redistributions in binary form must reproduce the above copyright
18 1.1 augustss * notice, this list of conditions and the following disclaimer in the
19 1.1 augustss * documentation and/or other materials provided with the distribution.
20 1.1 augustss * 3. All advertising materials mentioning features or use of this software
21 1.1 augustss * must display the following acknowledgement:
22 1.1 augustss * This product includes software developed by the NetBSD
23 1.1 augustss * Foundation, Inc. and its contributors.
24 1.1 augustss * 4. Neither the name of The NetBSD Foundation nor the names of its
25 1.1 augustss * contributors may be used to endorse or promote products derived
26 1.1 augustss * from this software without specific prior written permission.
27 1.1 augustss *
28 1.1 augustss * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29 1.1 augustss * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30 1.1 augustss * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31 1.1 augustss * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32 1.1 augustss * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 1.1 augustss * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 1.1 augustss * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 1.1 augustss * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 1.1 augustss * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 1.1 augustss * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 1.1 augustss * POSSIBILITY OF SUCH DAMAGE.
39 1.1 augustss */
40 1.1 augustss
41 1.1 augustss /*
42 1.1 augustss * iPAQ driver
43 1.1 augustss *
44 1.1 augustss * 19 July 2003: Incorporated changes suggested by Sam Lawrance from
45 1.1 augustss * the uppc module
46 1.1 augustss *
47 1.1 augustss *
48 1.1 augustss * Contact isis (at) cs.umd.edu if you have any questions/comments about this driver
49 1.1 augustss */
50 1.1 augustss
51 1.8 lukem #include <sys/cdefs.h>
52 1.9 dyoung __KERNEL_RCSID(0, "$NetBSD: uipaq.c,v 1.9 2008/02/18 05:24:24 dyoung Exp $");
53 1.8 lukem
54 1.1 augustss #include <sys/param.h>
55 1.1 augustss #include <sys/systm.h>
56 1.1 augustss #include <sys/kernel.h>
57 1.1 augustss #include <sys/device.h>
58 1.1 augustss #include <sys/conf.h>
59 1.1 augustss #include <sys/tty.h>
60 1.1 augustss
61 1.1 augustss #include <dev/usb/usb.h>
62 1.1 augustss
63 1.1 augustss #include <dev/usb/usbcdc.h> /*UCDC_* stuff */
64 1.1 augustss
65 1.1 augustss #include <dev/usb/usbdi.h>
66 1.1 augustss #include <dev/usb/usbdi_util.h>
67 1.1 augustss #include <dev/usb/usbdevs.h>
68 1.1 augustss
69 1.1 augustss #include <dev/usb/ucomvar.h>
70 1.1 augustss
71 1.1 augustss #ifdef UIPAQ_DEBUG
72 1.1 augustss #define DPRINTF(x) if (uipaqdebug) printf x
73 1.1 augustss #define DPRINTFN(n,x) if (uipaqdebug>(n)) printf x
74 1.1 augustss int uipaqdebug = 0;
75 1.1 augustss #else
76 1.1 augustss #define DPRINTF(x)
77 1.1 augustss #define DPRINTFN(n,x)
78 1.1 augustss #endif
79 1.1 augustss
80 1.1 augustss #define UIPAQ_CONFIG_NO 1
81 1.1 augustss #define UIPAQ_IFACE_INDEX 0
82 1.1 augustss
83 1.1 augustss #define UIPAQIBUFSIZE 1024
84 1.1 augustss #define UIPAQOBUFSIZE 1024
85 1.1 augustss
86 1.1 augustss struct uipaq_softc {
87 1.1 augustss USBBASEDEVICE sc_dev; /* base device */
88 1.1 augustss usbd_device_handle sc_udev; /* device */
89 1.1 augustss usbd_interface_handle sc_iface; /* interface */
90 1.1 augustss
91 1.9 dyoung device_t sc_subdev; /* ucom uses that */
92 1.1 augustss u_int16_t sc_lcr; /* state for DTR/RTS */
93 1.1 augustss
94 1.1 augustss u_int16_t sc_flags;
95 1.1 augustss
96 1.1 augustss u_char sc_dying;
97 1.1 augustss };
98 1.1 augustss
99 1.1 augustss /* Callback routines */
100 1.1 augustss Static void uipaq_set(void *, int, int, int);
101 1.1 augustss
102 1.1 augustss
103 1.1 augustss /* Support routines. */
104 1.1 augustss /* based on uppc module by Sam Lawrance */
105 1.1 augustss Static void uipaq_dtr(struct uipaq_softc *sc, int onoff);
106 1.1 augustss Static void uipaq_rts(struct uipaq_softc *sc, int onoff);
107 1.1 augustss Static void uipaq_break(struct uipaq_softc* sc, int onoff);
108 1.1 augustss
109 1.1 augustss
110 1.1 augustss struct ucom_methods uipaq_methods = {
111 1.1 augustss NULL,
112 1.1 augustss uipaq_set,
113 1.1 augustss NULL,
114 1.1 augustss NULL,
115 1.1 augustss NULL, /*open*/
116 1.1 augustss NULL, /*close*/
117 1.1 augustss NULL,
118 1.1 augustss NULL
119 1.1 augustss };
120 1.1 augustss
121 1.1 augustss struct uipaq_type {
122 1.1 augustss struct usb_devno uv_dev;
123 1.1 augustss u_int16_t uv_flags;
124 1.1 augustss };
125 1.1 augustss
126 1.1 augustss static const struct uipaq_type uipaq_devs[] = {
127 1.1 augustss {{ USB_VENDOR_HP, USB_PRODUCT_HP_2215 }, 0 },
128 1.1 augustss {{ USB_VENDOR_HP, USB_PRODUCT_HP_568J }, 0},
129 1.1 augustss {{ USB_VENDOR_COMPAQ, USB_PRODUCT_COMPAQ_IPAQPOCKETPC} , 0},
130 1.5 mjf {{ USB_VENDOR_CASIO, USB_PRODUCT_CASIO_BE300} , 0},
131 1.5 mjf {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_WS007SH} , 0}
132 1.1 augustss };
133 1.1 augustss
134 1.1 augustss #define uipaq_lookup(v, p) ((const struct uipaq_type *)usb_lookup(uipaq_devs, v, p))
135 1.1 augustss
136 1.9 dyoung int uipaq_match(device_t, struct cfdata *, void *);
137 1.9 dyoung void uipaq_attach(device_t, device_t, void *);
138 1.9 dyoung void uipaq_childdet(device_t, device_t);
139 1.9 dyoung int uipaq_detach(device_t, int);
140 1.9 dyoung int uipaq_activate(device_t, enum devact);
141 1.9 dyoung extern struct cfdriver uipaq_cd;
142 1.9 dyoung CFATTACH_DECL2(uipaq, sizeof(struct uipaq_softc), uipaq_match,
143 1.9 dyoung uipaq_attach, uipaq_detach, uipaq_activate, NULL, uipaq_childdet);
144 1.1 augustss
145 1.1 augustss USB_MATCH(uipaq)
146 1.1 augustss {
147 1.1 augustss USB_MATCH_START(uipaq, uaa);
148 1.1 augustss
149 1.1 augustss DPRINTFN(20,("uipaq: vendor=0x%x, product=0x%x\n",
150 1.1 augustss uaa->vendor, uaa->product));
151 1.1 augustss
152 1.1 augustss return (uipaq_lookup(uaa->vendor, uaa->product) != NULL ?
153 1.1 augustss UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
154 1.1 augustss }
155 1.1 augustss
156 1.1 augustss USB_ATTACH(uipaq)
157 1.1 augustss {
158 1.1 augustss USB_ATTACH_START(uipaq, sc, uaa);
159 1.1 augustss usbd_device_handle dev = uaa->device;
160 1.1 augustss usbd_interface_handle iface;
161 1.1 augustss usb_interface_descriptor_t *id;
162 1.1 augustss usb_endpoint_descriptor_t *ed;
163 1.1 augustss char *devinfop;
164 1.1 augustss char *devname = USBDEVNAME(sc->sc_dev);
165 1.1 augustss int i;
166 1.1 augustss usbd_status err;
167 1.1 augustss struct ucom_attach_args uca;
168 1.1 augustss
169 1.1 augustss DPRINTFN(10,("\nuipaq_attach: sc=%p\n", sc));
170 1.1 augustss
171 1.1 augustss /* Move the device into the configured state. */
172 1.1 augustss err = usbd_set_config_no(dev, UIPAQ_CONFIG_NO, 1);
173 1.1 augustss if (err) {
174 1.1 augustss printf("\n%s: failed to set configuration, err=%s\n",
175 1.1 augustss devname, usbd_errstr(err));
176 1.1 augustss goto bad;
177 1.1 augustss }
178 1.1 augustss
179 1.1 augustss err = usbd_device2interface_handle(dev, UIPAQ_IFACE_INDEX, &iface);
180 1.1 augustss if (err) {
181 1.1 augustss printf("\n%s: failed to get interface, err=%s\n",
182 1.1 augustss devname, usbd_errstr(err));
183 1.1 augustss goto bad;
184 1.1 augustss }
185 1.1 augustss
186 1.1 augustss devinfop = usbd_devinfo_alloc(dev, 0);
187 1.1 augustss USB_ATTACH_SETUP;
188 1.1 augustss printf("%s: %s\n", devname, devinfop);
189 1.1 augustss usbd_devinfo_free(devinfop);
190 1.1 augustss
191 1.1 augustss sc->sc_flags = uipaq_lookup(uaa->vendor, uaa->product)->uv_flags;
192 1.1 augustss
193 1.1 augustss id = usbd_get_interface_descriptor(iface);
194 1.1 augustss
195 1.1 augustss sc->sc_udev = dev;
196 1.1 augustss sc->sc_iface = iface;
197 1.1 augustss
198 1.1 augustss uca.ibufsize = UIPAQIBUFSIZE;
199 1.1 augustss uca.obufsize = UIPAQOBUFSIZE;
200 1.1 augustss uca.ibufsizepad = UIPAQIBUFSIZE;
201 1.1 augustss uca.opkthdrlen = 0;
202 1.1 augustss uca.device = dev;
203 1.1 augustss uca.iface = iface;
204 1.1 augustss uca.methods = &uipaq_methods;
205 1.1 augustss uca.arg = sc;
206 1.1 augustss uca.portno = UCOM_UNK_PORTNO;
207 1.1 augustss uca.info = "Generic";
208 1.1 augustss
209 1.1 augustss /* err = uipaq_init(sc);
210 1.1 augustss if (err) {
211 1.1 augustss printf("%s: init failed, %s\n", USBDEVNAME(sc->sc_dev),
212 1.1 augustss usbd_errstr(err));
213 1.1 augustss goto bad;
214 1.1 augustss }*/
215 1.1 augustss
216 1.1 augustss usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
217 1.1 augustss USBDEV(sc->sc_dev));
218 1.1 augustss
219 1.1 augustss uca.bulkin = uca.bulkout = -1;
220 1.1 augustss for (i=0; i<id->bNumEndpoints; i++) {
221 1.1 augustss ed = usbd_interface2endpoint_descriptor(iface, i);
222 1.1 augustss if (ed == NULL) {
223 1.1 augustss printf("%s: no endpoint descriptor for %d\n",
224 1.1 augustss devname,i);
225 1.1 augustss goto bad;
226 1.1 augustss }
227 1.1 augustss if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
228 1.1 augustss (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
229 1.1 augustss uca.bulkin = ed->bEndpointAddress;
230 1.1 augustss } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
231 1.1 augustss (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
232 1.1 augustss uca.bulkout = ed->bEndpointAddress;
233 1.1 augustss }
234 1.1 augustss }
235 1.1 augustss if (uca.bulkin == -1 || uca.bulkout == -1) {
236 1.1 augustss printf("%s: no proper endpoints found (%d,%d) \n",
237 1.1 augustss devname, uca.bulkin, uca.bulkout);
238 1.1 augustss USB_ATTACH_ERROR_RETURN;
239 1.1 augustss }
240 1.1 augustss
241 1.1 augustss sc->sc_subdev = config_found_sm_loc(self, "ucombus", NULL, &uca,
242 1.1 augustss ucomprint, ucomsubmatch);
243 1.1 augustss
244 1.1 augustss USB_ATTACH_SUCCESS_RETURN;
245 1.1 augustss
246 1.1 augustss bad:
247 1.1 augustss DPRINTF(("uipaq_attach: ATTACH ERROR\n"));
248 1.1 augustss sc->sc_dying = 1;
249 1.1 augustss USB_ATTACH_ERROR_RETURN;
250 1.1 augustss }
251 1.1 augustss
252 1.1 augustss
253 1.1 augustss void
254 1.1 augustss uipaq_dtr(struct uipaq_softc* sc, int onoff)
255 1.1 augustss {
256 1.1 augustss usb_device_request_t req;
257 1.1 augustss usbd_status err;
258 1.1 augustss int retries = 3;
259 1.1 augustss
260 1.1 augustss DPRINTF(("%s: uipaq_dtr: onoff=%x\n", USBDEVNAME(sc->sc_dev), onoff));
261 1.1 augustss
262 1.1 augustss /* Avoid sending unnecessary requests */
263 1.1 augustss if (onoff && (sc->sc_lcr & UCDC_LINE_DTR))
264 1.1 augustss return;
265 1.1 augustss if (!onoff && !(sc->sc_lcr & UCDC_LINE_DTR))
266 1.1 augustss return;
267 1.1 augustss
268 1.1 augustss /* Other parameters depend on reg */
269 1.1 augustss req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
270 1.1 augustss req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
271 1.1 augustss sc->sc_lcr = onoff ? sc->sc_lcr | UCDC_LINE_DTR : sc->sc_lcr & ~UCDC_LINE_DTR;
272 1.1 augustss USETW(req.wValue, sc->sc_lcr);
273 1.1 augustss USETW(req.wIndex, 0x0);
274 1.1 augustss USETW(req.wLength, 0);
275 1.1 augustss
276 1.1 augustss /* Fire off the request a few times if necessary */
277 1.1 augustss while (retries) {
278 1.1 augustss err = usbd_do_request(sc->sc_udev, &req, NULL);
279 1.1 augustss if (!err)
280 1.1 augustss break;
281 1.1 augustss retries--;
282 1.1 augustss }
283 1.1 augustss }
284 1.1 augustss
285 1.1 augustss
286 1.1 augustss void
287 1.1 augustss uipaq_rts(struct uipaq_softc* sc, int onoff)
288 1.1 augustss {
289 1.1 augustss usb_device_request_t req;
290 1.1 augustss usbd_status err;
291 1.1 augustss int retries = 3;
292 1.1 augustss
293 1.1 augustss DPRINTF(("%s: uipaq_rts: onoff=%x\n", USBDEVNAME(sc->sc_dev), onoff));
294 1.1 augustss
295 1.1 augustss /* Avoid sending unnecessary requests */
296 1.1 augustss if (onoff && (sc->sc_lcr & UCDC_LINE_RTS)) return;
297 1.1 augustss if (!onoff && !(sc->sc_lcr & UCDC_LINE_RTS)) return;
298 1.1 augustss
299 1.1 augustss req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
300 1.1 augustss req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
301 1.1 augustss sc->sc_lcr = onoff ? sc->sc_lcr | UCDC_LINE_RTS : sc->sc_lcr & ~UCDC_LINE_RTS;
302 1.1 augustss USETW(req.wValue, sc->sc_lcr);
303 1.1 augustss USETW(req.wIndex, 0x0);
304 1.1 augustss USETW(req.wLength, 0);
305 1.1 augustss
306 1.1 augustss while (retries) {
307 1.1 augustss err = usbd_do_request(sc->sc_udev, &req, NULL);
308 1.1 augustss if (!err)
309 1.1 augustss break;
310 1.1 augustss retries--;
311 1.1 augustss }
312 1.1 augustss }
313 1.1 augustss
314 1.1 augustss
315 1.1 augustss void
316 1.1 augustss uipaq_break(struct uipaq_softc* sc, int onoff)
317 1.1 augustss {
318 1.1 augustss usb_device_request_t req;
319 1.1 augustss usbd_status err;
320 1.1 augustss int retries = 3;
321 1.1 augustss
322 1.1 augustss DPRINTF(("%s: uipaq_break: onoff=%x\n", USBDEVNAME(sc->sc_dev), onoff));
323 1.1 augustss
324 1.1 augustss req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
325 1.1 augustss req.bRequest = UCDC_SEND_BREAK;
326 1.1 augustss
327 1.1 augustss USETW(req.wValue, onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF);
328 1.1 augustss USETW(req.wIndex, 0x0);
329 1.1 augustss USETW(req.wLength, 0);
330 1.1 augustss
331 1.1 augustss while (retries) {
332 1.1 augustss err = usbd_do_request(sc->sc_udev, &req, NULL);
333 1.1 augustss if (!err)
334 1.1 augustss break;
335 1.1 augustss retries--;
336 1.1 augustss }
337 1.1 augustss }
338 1.1 augustss
339 1.1 augustss
340 1.1 augustss void
341 1.4 christos uipaq_set(void *addr, int portno, int reg, int onoff)
342 1.1 augustss {
343 1.1 augustss struct uipaq_softc* sc = addr;
344 1.1 augustss
345 1.1 augustss switch (reg) {
346 1.1 augustss case UCOM_SET_DTR:
347 1.1 augustss uipaq_dtr(addr, onoff);
348 1.1 augustss break;
349 1.1 augustss case UCOM_SET_RTS:
350 1.1 augustss uipaq_rts(addr, onoff);
351 1.1 augustss break;
352 1.1 augustss case UCOM_SET_BREAK:
353 1.1 augustss uipaq_break(addr, onoff);
354 1.1 augustss break;
355 1.1 augustss default:
356 1.1 augustss printf("%s: unhandled set request: reg=%x onoff=%x\n",
357 1.1 augustss USBDEVNAME(sc->sc_dev), reg, onoff);
358 1.1 augustss return;
359 1.1 augustss }
360 1.1 augustss }
361 1.1 augustss
362 1.1 augustss
363 1.1 augustss int
364 1.9 dyoung uipaq_activate(device_t self, enum devact act)
365 1.1 augustss {
366 1.9 dyoung struct uipaq_softc *sc = device_private(self);
367 1.1 augustss int rv = 0;
368 1.1 augustss
369 1.1 augustss switch (act) {
370 1.1 augustss case DVACT_ACTIVATE:
371 1.1 augustss return (EOPNOTSUPP);
372 1.1 augustss break;
373 1.1 augustss
374 1.1 augustss case DVACT_DEACTIVATE:
375 1.1 augustss if (sc->sc_subdev != NULL)
376 1.1 augustss rv = config_deactivate(sc->sc_subdev);
377 1.1 augustss sc->sc_dying = 1;
378 1.1 augustss break;
379 1.1 augustss }
380 1.1 augustss return (rv);
381 1.1 augustss }
382 1.1 augustss
383 1.9 dyoung void
384 1.9 dyoung uipaq_childdet(device_t self, device_t child)
385 1.9 dyoung {
386 1.9 dyoung struct uipaq_softc *sc = device_private(self);
387 1.9 dyoung
388 1.9 dyoung KASSERT(sc->sc_subdev == child);
389 1.9 dyoung sc->sc_subdev = NULL;
390 1.9 dyoung }
391 1.9 dyoung
392 1.1 augustss int
393 1.9 dyoung uipaq_detach(device_t self, int flags)
394 1.1 augustss {
395 1.9 dyoung struct uipaq_softc *sc = device_private(self);
396 1.1 augustss int rv = 0;
397 1.1 augustss
398 1.1 augustss DPRINTF(("uipaq_detach: sc=%p flags=%d\n", sc, flags));
399 1.1 augustss sc->sc_dying = 1;
400 1.9 dyoung if (sc->sc_subdev != NULL)
401 1.1 augustss rv |= config_detach(sc->sc_subdev, flags);
402 1.1 augustss
403 1.1 augustss usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
404 1.1 augustss USBDEV(sc->sc_dev));
405 1.1 augustss
406 1.1 augustss return (rv);
407 1.1 augustss }
408 1.1 augustss
409