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