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