root/dev/usb/uipaq.c

DEFINITIONS

1. uipaq_match
2. uipaq_attach
3. uipaq_dtr
4. uipaq_rts
5. uipaq_break
6. uipaq_set
7. uipaq_activate
8. uipaq_detach

    1 /*      $OpenBSD: uipaq.c,v 1.12 2007/06/14 10:11:16 mbalmer Exp $      */
    3 /*
    4  * Copyright (c) 2000 The NetBSD Foundation, Inc.
    5  * All rights reserved.
    6  *
    7  * This code is derived from software contributed to The NetBSD Foundation
    8  * by Lennart Augustsson (lennart@augustsson.net) at
    9  * Carlstedt Research & Technology.
   10  *
   11  * Redistribution and use in source and binary forms, with or without
   12  * modification, are permitted provided that the following conditions
   13  * are met:
   14  * 1. Redistributions of source code must retain the above copyright
   15  *    notice, this list of conditions and the following disclaimer.
   16  * 2. Redistributions in binary form must reproduce the above copyright
   17  *    notice, this list of conditions and the following disclaimer in the
   18  *    documentation and/or other materials provided with the distribution.
   19  * 3. All advertising materials mentioning features or use of this software
   20  *    must display the following acknowledgement:
   21  *        This product includes software developed by the NetBSD
   22  *        Foundation, Inc. and its contributors.
   23  * 4. Neither the name of The NetBSD Foundation nor the names of its
   24  *    contributors may be used to endorse or promote products derived
   25  *    from this software without specific prior written permission.
   26  *
   27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
   28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
   29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
   31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   37  * POSSIBILITY OF SUCH DAMAGE.
   38  */
   40 /*
   41  * iPAQ driver
   42  * 
   43  * 19 July 2003:        Incorporated changes suggested by Sam Lawrance from
   44  *                      the uppc module
   45  *
   46  *
   47  * Contact isis@cs.umd.edu if you have any questions/comments about this driver
   48  */
   50 #include <sys/param.h>
   51 #include <sys/systm.h>
   52 #include <sys/kernel.h>
   53 #include <sys/device.h>
   54 #include <sys/conf.h>
   55 #include <sys/tty.h>
   57 #include <dev/usb/usb.h>
   58 #include <dev/usb/usbhid.h>
   60 #include <dev/usb/usbcdc.h>     /*UCDC_* stuff */
   62 #include <dev/usb/usbdi.h>
   63 #include <dev/usb/usbdi_util.h>
   64 #include <dev/usb/usbdevs.h>
   66 #include <dev/usb/ucomvar.h>
   68 #ifdef UIPAQ_DEBUG
   69 #define DPRINTF(x)      if (uipaqdebug) printf x
   70 #define DPRINTFN(n,x)   if (uipaqdebug>(n)) printf x
   71 int uipaqdebug = 0;
   72 #else
   73 #define DPRINTF(x)
   74 #define DPRINTFN(n,x)
   75 #endif
   77 #define UIPAQ_CONFIG_NO         1
   78 #define UIPAQ_IFACE_INDEX       0
   80 #define UIPAQIBUFSIZE 1024
   81 #define UIPAQOBUFSIZE 1024
   83 struct uipaq_softc {
   84         struct device            sc_dev;        /* base device */
usbd_device_handle       sc_udev;       /* device */
usbd_interface_handle    sc_iface;      /* interface */
   88         struct device           *sc_subdev;     /* ucom uses that */
u_int16_t                sc_lcr;        /* state for DTR/RTS */
u_int16_t                sc_flags;
u_char                   sc_dying;
   94 };
   96 /* Callback routines */
   97 void    uipaq_set(void *, int, int, int);
  100 /* Support routines. */
  101 /* based on uppc module by Sam Lawrance */
  102 void    uipaq_dtr(struct uipaq_softc *sc, int onoff);
  103 void    uipaq_rts(struct uipaq_softc *sc, int onoff);
  104 void    uipaq_break(struct uipaq_softc* sc, int onoff);
  107 struct ucom_methods uipaq_methods = {
NULL,
uipaq_set,
NULL,
NULL,
NULL,   /*open*/
NULL,   /*close*/
NULL,
NULL
  116 };
  118 struct uipaq_type {
  119         struct usb_devno        uv_dev;
u_int16_t               uv_flags;
  121 };
  123 static const struct uipaq_type uipaq_devs[] = {
  124         {{ USB_VENDOR_HP, USB_PRODUCT_HP_2215 }, 0 },
  125         {{ USB_VENDOR_HP, USB_PRODUCT_HP_568J }, 0},
  126         {{ USB_VENDOR_COMPAQ, USB_PRODUCT_COMPAQ_IPAQPOCKETPC} , 0},
  127         {{ USB_VENDOR_CASIO, USB_PRODUCT_CASIO_BE300} , 0},
  128         {{ USB_VENDOR_ASUS, USB_PRODUCT_ASUS_MYPAL_A730} , 0}
  129 };
  131 #define uipaq_lookup(v, p) ((struct uipaq_type *)usb_lookup(uipaq_devs, v, p))
  133 int uipaq_match(struct device *, void *, void *); 
  134 void uipaq_attach(struct device *, struct device *, void *); 
  135 int uipaq_detach(struct device *, int); 
  136 int uipaq_activate(struct device *, enum devact); 
  138 struct cfdriver uipaq_cd = { 
NULL, "uipaq", DV_DULL 
  140 }; 
  142 const struct cfattach uipaq_ca = { 
  143         sizeof(struct uipaq_softc), 
uipaq_match, 
uipaq_attach, 
uipaq_detach, 
uipaq_activate, 
  148 };
  150 int
uipaq_match(struct device *parent, void *match, void *aux)
  152 {
  153         struct usb_attach_arg *uaa = aux;
  155         if (uaa->iface != NULL)
  156                 return (UMATCH_NONE);
DPRINTFN(20,("uipaq: vendor=0x%x, product=0x%x\n",
uaa->vendor, uaa->product));
  161         return (uipaq_lookup(uaa->vendor, uaa->product) != NULL ?
UMATCH_VENDOR_PRODUCT : UMATCH_NONE);
  163 }
  165 void
uipaq_attach(struct device *parent, struct device *self, void *aux)
  167 {
  168         struct uipaq_softc *sc = (struct uipaq_softc *)self;
  169         struct usb_attach_arg *uaa = aux;
usbd_device_handle dev = uaa->device;
usbd_interface_handle iface;
usb_interface_descriptor_t *id;
usb_endpoint_descriptor_t *ed;
  174         char *devinfop;
  175         char *devname = sc->sc_dev.dv_xname;
  176         int i;
usbd_status err;
  178         struct ucom_attach_args uca;
DPRINTFN(10,("\nuipaq_attach: sc=%p\n", sc));
  182         /* Move the device into the configured state. */
err = usbd_set_config_no(dev, UIPAQ_CONFIG_NO, 1);
  184         if (err) {
printf("\n%s: failed to set configuration, err=%s\n",
devname, usbd_errstr(err));
  187                 goto bad;
  188         }
err = usbd_device2interface_handle(dev, UIPAQ_IFACE_INDEX, &iface);
  191         if (err) {
printf("\n%s: failed to get interface, err=%s\n",
devname, usbd_errstr(err));
  194                 goto bad;
  195         }
devinfop = usbd_devinfo_alloc(dev, 0);
printf("\n%s: %s\n", devname, devinfop);
usbd_devinfo_free(devinfop);
sc->sc_flags = uipaq_lookup(uaa->vendor, uaa->product)->uv_flags;
id = usbd_get_interface_descriptor(iface);
sc->sc_udev = dev;
sc->sc_iface = iface;
uca.ibufsize = UIPAQIBUFSIZE;
uca.obufsize = UIPAQOBUFSIZE;
uca.ibufsizepad = UIPAQIBUFSIZE;
uca.opkthdrlen = 0;
uca.device = dev;
uca.iface = iface;
uca.methods = &uipaq_methods;
uca.arg = sc;
uca.portno = UCOM_UNK_PORTNO;
uca.info = "Generic";
  219 /*      err = uipaq_init(sc);
  220         if (err) {
  221                 printf("%s: init failed, %s\n", sc->sc_dev.dv_xname,
  222                     usbd_errstr(err));
  223                 goto bad;
  224         }*/
usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
  227             &sc->sc_dev);
uca.bulkin = uca.bulkout = -1;
  230         for (i=0; i<id->bNumEndpoints; i++) {
ed = usbd_interface2endpoint_descriptor(iface, i);
  232                 if (ed == NULL) {
printf("%s: no endpoint descriptor for %d\n",
devname,i);
  235                         goto bad;
  236                 }
  237                 if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
  238                     (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
uca.bulkin = ed->bEndpointAddress;
  240                 } else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
  241                     (ed->bmAttributes & UE_XFERTYPE) == UE_BULK) {
uca.bulkout = ed->bEndpointAddress;
  243                 }
  244         }
  245         if (uca.bulkin != -1 && uca.bulkout != -1)
sc->sc_subdev = config_found_sm(self, &uca,
ucomprint, ucomsubmatch);
  248         else
printf("%s: no proper endpoints found (%d,%d) \n",
devname, uca.bulkin, uca.bulkout);
  252         return;
bad:
DPRINTF(("uipaq_attach: ATTACH ERROR\n"));
sc->sc_dying = 1;
  257 }
  260 void
uipaq_dtr(struct uipaq_softc* sc, int onoff)
  262 {
usb_device_request_t req;
usbd_status err;
  265         int retries = 3;
DPRINTF(("%s: uipaq_dtr: onoff=%x\n", sc->sc_dev.dv_xname, onoff));
  269         /* Avoid sending unnecessary requests */
  270         if (onoff && (sc->sc_lcr & UCDC_LINE_DTR))
  271                 return;
  272         if (!onoff && !(sc->sc_lcr & UCDC_LINE_DTR))
  273                 return;
  275         /* Other parameters depend on reg */
req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
sc->sc_lcr = onoff ? sc->sc_lcr | UCDC_LINE_DTR : sc->sc_lcr & ~UCDC_LINE_DTR;
USETW(req.wValue, sc->sc_lcr);
USETW(req.wIndex, 0x0);
USETW(req.wLength, 0);
  283         /* Fire off the request a few times if necessary */
  284         while (retries) {
err = usbd_do_request(sc->sc_udev, &req, NULL);
  286                 if (!err)
  287                         break;
retries--;
  289         }
  290 }
  293 void
uipaq_rts(struct uipaq_softc* sc, int onoff)
  295 {
usb_device_request_t req;
usbd_status err;
  298         int retries = 3;
DPRINTF(("%s: uipaq_rts: onoff=%x\n", sc->sc_dev.dv_xname, onoff));
  302         /* Avoid sending unnecessary requests */
  303         if (onoff && (sc->sc_lcr & UCDC_LINE_RTS)) return;
  304         if (!onoff && !(sc->sc_lcr & UCDC_LINE_RTS)) return;
req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
req.bRequest = UCDC_SET_CONTROL_LINE_STATE;
sc->sc_lcr = onoff ? sc->sc_lcr | UCDC_LINE_RTS : sc->sc_lcr & ~UCDC_LINE_RTS;
USETW(req.wValue, sc->sc_lcr);
USETW(req.wIndex, 0x0);
USETW(req.wLength, 0);
  313         while (retries) {
err = usbd_do_request(sc->sc_udev, &req, NULL);
  315                 if (!err)
  316                         break;
retries--;
  318         }
  319 }
  322 void
uipaq_break(struct uipaq_softc* sc, int onoff)
  324 {
usb_device_request_t req;
usbd_status err;
  327         int retries = 3;
DPRINTF(("%s: uipaq_break: onoff=%x\n", sc->sc_dev.dv_xname, onoff));
req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
req.bRequest = UCDC_SEND_BREAK;
USETW(req.wValue, onoff ? UCDC_BREAK_ON : UCDC_BREAK_OFF);
USETW(req.wIndex, 0x0);
USETW(req.wLength, 0);
  338         while (retries) {
err = usbd_do_request(sc->sc_udev, &req, NULL);
  340                 if (!err)
  341                         break;
retries--;
  343         }
  344 }
  347 void
uipaq_set(void *addr, int portno, int reg, int onoff)
  349 {
  350         struct uipaq_softc* sc = addr;
  352         switch (reg) {
  353         case UCOM_SET_DTR:
uipaq_dtr(addr, onoff);
  355                 break;
  356         case UCOM_SET_RTS:
uipaq_rts(addr, onoff);
  358                 break;
  359         case UCOM_SET_BREAK:
uipaq_break(addr, onoff);
  361                 break;
  362         default:
printf("%s: unhandled set request: reg=%x onoff=%x\n",
sc->sc_dev.dv_xname, reg, onoff);
  365                 return;
  366         }
  367 }
  370 int
uipaq_activate(struct device *self, enum devact act)
  372 {
  373         struct uipaq_softc *sc = (struct uipaq_softc *)self;
  374         int rv = 0;
  376         switch (act) {
  377         case DVACT_ACTIVATE:
  378                 break;
  380         case DVACT_DEACTIVATE:
  381                 if (sc->sc_subdev != NULL)
rv = config_deactivate(sc->sc_subdev);
sc->sc_dying = 1;
  384                 break;
  385         }
  386         return (rv);
  387 }
  389 int
uipaq_detach(struct device *self, int flags)
  391 {
  392         struct uipaq_softc *sc = (struct uipaq_softc *)self;
  393         int rv = 0;
DPRINTF(("uipaq_detach: sc=%p flags=%d\n", sc, flags));
sc->sc_dying = 1;
  397         if (sc->sc_subdev != NULL) {
rv |= config_detach(sc->sc_subdev, flags);
sc->sc_subdev = NULL;
  400         }
usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
  403             &sc->sc_dev);
  405         return (rv);
  406 }