freebsd-dev/sys/dev/usb/serial/uvisor.c
Hans Petter Selasky 271ae033e9 Style change.
- Make it easier to port the USB code to other platforms by only using
one set of memory functions for clearing and copying memory. None of
the memory copies are overlapping. This means using bcopy() is not
required.
- Fix a compile warning when USB_HAVE_BUSDMA=0
- Add missing semicolon in avr32dci.
- Update some comments.

MFC after:	1 week
2011-11-12 08:16:45 +00:00

653 lines
17 KiB
C

/* $NetBSD: uvisor.c,v 1.9 2001/01/23 14:04:14 augustss Exp $ */
/* $FreeBSD$ */
/* Also already merged from NetBSD:
* $NetBSD: uvisor.c,v 1.12 2001/11/13 06:24:57 lukem Exp $
* $NetBSD: uvisor.c,v 1.13 2002/02/11 15:11:49 augustss Exp $
* $NetBSD: uvisor.c,v 1.14 2002/02/27 23:00:03 augustss Exp $
* $NetBSD: uvisor.c,v 1.15 2002/06/16 15:01:31 augustss Exp $
* $NetBSD: uvisor.c,v 1.16 2002/07/11 21:14:36 augustss Exp $
* $NetBSD: uvisor.c,v 1.17 2002/08/13 11:38:15 augustss Exp $
* $NetBSD: uvisor.c,v 1.18 2003/02/05 00:50:14 augustss Exp $
* $NetBSD: uvisor.c,v 1.19 2003/02/07 18:12:37 augustss Exp $
* $NetBSD: uvisor.c,v 1.20 2003/04/11 01:30:10 simonb Exp $
*/
/*-
* Copyright (c) 2000 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Lennart Augustsson (lennart@augustsson.net) at
* Carlstedt Research & Technology.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/*
* Handspring Visor (Palmpilot compatible PDA) driver
*/
#include <sys/stdint.h>
#include <sys/stddef.h>
#include <sys/param.h>
#include <sys/queue.h>
#include <sys/types.h>
#include <sys/systm.h>
#include <sys/kernel.h>
#include <sys/bus.h>
#include <sys/module.h>
#include <sys/lock.h>
#include <sys/mutex.h>
#include <sys/condvar.h>
#include <sys/sysctl.h>
#include <sys/sx.h>
#include <sys/unistd.h>
#include <sys/callout.h>
#include <sys/malloc.h>
#include <sys/priv.h>
#include <dev/usb/usb.h>
#include <dev/usb/usbdi.h>
#include <dev/usb/usbdi_util.h>
#include "usbdevs.h"
#define USB_DEBUG_VAR uvisor_debug
#include <dev/usb/usb_debug.h>
#include <dev/usb/usb_process.h>
#include <dev/usb/serial/usb_serial.h>
#ifdef USB_DEBUG
static int uvisor_debug = 0;
static SYSCTL_NODE(_hw_usb, OID_AUTO, uvisor, CTLFLAG_RW, 0, "USB uvisor");
SYSCTL_INT(_hw_usb_uvisor, OID_AUTO, debug, CTLFLAG_RW,
&uvisor_debug, 0, "Debug level");
#endif
#define UVISOR_CONFIG_INDEX 0
#define UVISOR_IFACE_INDEX 0
/*
* The following buffer sizes are hardcoded due to the way the Palm
* firmware works. It looks like the device is not short terminating
* the data transferred.
*/
#define UVISORIBUFSIZE 0 /* Use wMaxPacketSize */
#define UVISOROBUFSIZE 32 /* bytes */
#define UVISOROFRAMES 32 /* units */
/* From the Linux driver */
/*
* UVISOR_REQUEST_BYTES_AVAILABLE asks the visor for the number of bytes that
* are available to be transfered to the host for the specified endpoint.
* Currently this is not used, and always returns 0x0001
*/
#define UVISOR_REQUEST_BYTES_AVAILABLE 0x01
/*
* UVISOR_CLOSE_NOTIFICATION is set to the device to notify it that the host
* is now closing the pipe. An empty packet is sent in response.
*/
#define UVISOR_CLOSE_NOTIFICATION 0x02
/*
* UVISOR_GET_CONNECTION_INFORMATION is sent by the host during enumeration to
* get the endpoints used by the connection.
*/
#define UVISOR_GET_CONNECTION_INFORMATION 0x03
/*
* UVISOR_GET_CONNECTION_INFORMATION returns data in the following format
*/
#define UVISOR_MAX_CONN 8
struct uvisor_connection_info {
uWord num_ports;
struct {
uByte port_function_id;
uByte port;
} __packed connections[UVISOR_MAX_CONN];
} __packed;
#define UVISOR_CONNECTION_INFO_SIZE 18
/* struct uvisor_connection_info.connection[x].port defines: */
#define UVISOR_ENDPOINT_1 0x01
#define UVISOR_ENDPOINT_2 0x02
/* struct uvisor_connection_info.connection[x].port_function_id defines: */
#define UVISOR_FUNCTION_GENERIC 0x00
#define UVISOR_FUNCTION_DEBUGGER 0x01
#define UVISOR_FUNCTION_HOTSYNC 0x02
#define UVISOR_FUNCTION_CONSOLE 0x03
#define UVISOR_FUNCTION_REMOTE_FILE_SYS 0x04
/*
* Unknown PalmOS stuff.
*/
#define UVISOR_GET_PALM_INFORMATION 0x04
#define UVISOR_GET_PALM_INFORMATION_LEN 0x44
struct uvisor_palm_connection_info {
uByte num_ports;
uByte endpoint_numbers_different;
uWord reserved1;
struct {
uDWord port_function_id;
uByte port;
uByte end_point_info;
uWord reserved;
} __packed connections[UVISOR_MAX_CONN];
} __packed;
enum {
UVISOR_BULK_DT_WR,
UVISOR_BULK_DT_RD,
UVISOR_N_TRANSFER,
};
struct uvisor_softc {
struct ucom_super_softc sc_super_ucom;
struct ucom_softc sc_ucom;
struct usb_xfer *sc_xfer[UVISOR_N_TRANSFER];
struct usb_device *sc_udev;
struct mtx sc_mtx;
uint16_t sc_flag;
#define UVISOR_FLAG_PALM4 0x0001
#define UVISOR_FLAG_VISOR 0x0002
#define UVISOR_FLAG_PALM35 0x0004
#define UVISOR_FLAG_SEND_NOTIFY 0x0008
uint8_t sc_iface_no;
uint8_t sc_iface_index;
};
/* prototypes */
static device_probe_t uvisor_probe;
static device_attach_t uvisor_attach;
static device_detach_t uvisor_detach;
static usb_callback_t uvisor_write_callback;
static usb_callback_t uvisor_read_callback;
static usb_error_t uvisor_init(struct uvisor_softc *, struct usb_device *,
struct usb_config *);
static void uvisor_cfg_open(struct ucom_softc *);
static void uvisor_cfg_close(struct ucom_softc *);
static void uvisor_start_read(struct ucom_softc *);
static void uvisor_stop_read(struct ucom_softc *);
static void uvisor_start_write(struct ucom_softc *);
static void uvisor_stop_write(struct ucom_softc *);
static const struct usb_config uvisor_config[UVISOR_N_TRANSFER] = {
[UVISOR_BULK_DT_WR] = {
.type = UE_BULK,
.endpoint = UE_ADDR_ANY,
.direction = UE_DIR_OUT,
.bufsize = UVISOROBUFSIZE * UVISOROFRAMES,
.frames = UVISOROFRAMES,
.flags = {.pipe_bof = 1,.force_short_xfer = 1,},
.callback = &uvisor_write_callback,
},
[UVISOR_BULK_DT_RD] = {
.type = UE_BULK,
.endpoint = UE_ADDR_ANY,
.direction = UE_DIR_IN,
.bufsize = UVISORIBUFSIZE,
.flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
.callback = &uvisor_read_callback,
},
};
static const struct ucom_callback uvisor_callback = {
.ucom_cfg_open = &uvisor_cfg_open,
.ucom_cfg_close = &uvisor_cfg_close,
.ucom_start_read = &uvisor_start_read,
.ucom_stop_read = &uvisor_stop_read,
.ucom_start_write = &uvisor_start_write,
.ucom_stop_write = &uvisor_stop_write,
};
static device_method_t uvisor_methods[] = {
DEVMETHOD(device_probe, uvisor_probe),
DEVMETHOD(device_attach, uvisor_attach),
DEVMETHOD(device_detach, uvisor_detach),
{0, 0}
};
static devclass_t uvisor_devclass;
static driver_t uvisor_driver = {
.name = "uvisor",
.methods = uvisor_methods,
.size = sizeof(struct uvisor_softc),
};
DRIVER_MODULE(uvisor, uhub, uvisor_driver, uvisor_devclass, NULL, 0);
MODULE_DEPEND(uvisor, ucom, 1, 1, 1);
MODULE_DEPEND(uvisor, usb, 1, 1, 1);
MODULE_VERSION(uvisor, 1);
static const STRUCT_USB_HOST_ID uvisor_devs[] = {
#define UVISOR_DEV(v,p,i) { USB_VPI(USB_VENDOR_##v, USB_PRODUCT_##v##_##p, i) }
UVISOR_DEV(ACEECA, MEZ1000, UVISOR_FLAG_PALM4),
UVISOR_DEV(ALPHASMART, DANA_SYNC, UVISOR_FLAG_PALM4),
UVISOR_DEV(GARMIN, IQUE_3600, UVISOR_FLAG_PALM4),
UVISOR_DEV(FOSSIL, WRISTPDA, UVISOR_FLAG_PALM4),
UVISOR_DEV(HANDSPRING, VISOR, UVISOR_FLAG_VISOR),
UVISOR_DEV(HANDSPRING, TREO, UVISOR_FLAG_PALM4),
UVISOR_DEV(HANDSPRING, TREO600, UVISOR_FLAG_PALM4),
UVISOR_DEV(PALM, M500, UVISOR_FLAG_PALM4),
UVISOR_DEV(PALM, M505, UVISOR_FLAG_PALM4),
UVISOR_DEV(PALM, M515, UVISOR_FLAG_PALM4),
UVISOR_DEV(PALM, I705, UVISOR_FLAG_PALM4),
UVISOR_DEV(PALM, M125, UVISOR_FLAG_PALM4),
UVISOR_DEV(PALM, M130, UVISOR_FLAG_PALM4),
UVISOR_DEV(PALM, TUNGSTEN_Z, UVISOR_FLAG_PALM4),
UVISOR_DEV(PALM, TUNGSTEN_T, UVISOR_FLAG_PALM4),
UVISOR_DEV(PALM, ZIRE, UVISOR_FLAG_PALM4),
UVISOR_DEV(PALM, ZIRE31, UVISOR_FLAG_PALM4),
UVISOR_DEV(SAMSUNG, I500, UVISOR_FLAG_PALM4),
UVISOR_DEV(SONY, CLIE_40, 0),
UVISOR_DEV(SONY, CLIE_41, 0),
UVISOR_DEV(SONY, CLIE_S360, UVISOR_FLAG_PALM4),
UVISOR_DEV(SONY, CLIE_NX60, UVISOR_FLAG_PALM4),
UVISOR_DEV(SONY, CLIE_35, UVISOR_FLAG_PALM35),
/* UVISOR_DEV(SONY, CLIE_25, UVISOR_FLAG_PALM4 ), */
UVISOR_DEV(SONY, CLIE_TJ37, UVISOR_FLAG_PALM4),
/* UVISOR_DEV(SONY, CLIE_TH55, UVISOR_FLAG_PALM4 ), See PR 80935 */
UVISOR_DEV(TAPWAVE, ZODIAC, UVISOR_FLAG_PALM4),
#undef UVISOR_DEV
};
static int
uvisor_probe(device_t dev)
{
struct usb_attach_arg *uaa = device_get_ivars(dev);
if (uaa->usb_mode != USB_MODE_HOST) {
return (ENXIO);
}
if (uaa->info.bConfigIndex != UVISOR_CONFIG_INDEX) {
return (ENXIO);
}
if (uaa->info.bIfaceIndex != UVISOR_IFACE_INDEX) {
return (ENXIO);
}
return (usbd_lookup_id_by_uaa(uvisor_devs, sizeof(uvisor_devs), uaa));
}
static int
uvisor_attach(device_t dev)
{
struct usb_attach_arg *uaa = device_get_ivars(dev);
struct uvisor_softc *sc = device_get_softc(dev);
struct usb_config uvisor_config_copy[UVISOR_N_TRANSFER];
int error;
DPRINTF("sc=%p\n", sc);
memcpy(uvisor_config_copy, uvisor_config,
sizeof(uvisor_config_copy));
device_set_usb_desc(dev);
mtx_init(&sc->sc_mtx, "uvisor", NULL, MTX_DEF);
sc->sc_udev = uaa->device;
/* configure the device */
sc->sc_flag = USB_GET_DRIVER_INFO(uaa);
sc->sc_iface_no = uaa->info.bIfaceNum;
sc->sc_iface_index = UVISOR_IFACE_INDEX;
error = uvisor_init(sc, uaa->device, uvisor_config_copy);
if (error) {
DPRINTF("init failed, error=%s\n",
usbd_errstr(error));
goto detach;
}
error = usbd_transfer_setup(uaa->device, &sc->sc_iface_index,
sc->sc_xfer, uvisor_config_copy, UVISOR_N_TRANSFER,
sc, &sc->sc_mtx);
if (error) {
DPRINTF("could not allocate all pipes\n");
goto detach;
}
error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
&uvisor_callback, &sc->sc_mtx);
if (error) {
DPRINTF("ucom_attach failed\n");
goto detach;
}
ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
return (0);
detach:
uvisor_detach(dev);
return (ENXIO);
}
static int
uvisor_detach(device_t dev)
{
struct uvisor_softc *sc = device_get_softc(dev);
DPRINTF("sc=%p\n", sc);
ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
usbd_transfer_unsetup(sc->sc_xfer, UVISOR_N_TRANSFER);
mtx_destroy(&sc->sc_mtx);
return (0);
}
static usb_error_t
uvisor_init(struct uvisor_softc *sc, struct usb_device *udev, struct usb_config *config)
{
usb_error_t err = 0;
struct usb_device_request req;
struct uvisor_connection_info coninfo;
struct uvisor_palm_connection_info pconinfo;
uint16_t actlen;
uint8_t buffer[256];
if (sc->sc_flag & UVISOR_FLAG_VISOR) {
DPRINTF("getting connection info\n");
req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
req.bRequest = UVISOR_GET_CONNECTION_INFORMATION;
USETW(req.wValue, 0);
USETW(req.wIndex, 0);
USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE);
err = usbd_do_request_flags(udev, NULL,
&req, &coninfo, USB_SHORT_XFER_OK,
&actlen, USB_DEFAULT_TIMEOUT);
if (err) {
goto done;
}
}
#ifdef USB_DEBUG
if (sc->sc_flag & UVISOR_FLAG_VISOR) {
uint16_t i, np;
const char *desc;
np = UGETW(coninfo.num_ports);
if (np > UVISOR_MAX_CONN) {
np = UVISOR_MAX_CONN;
}
DPRINTF("Number of ports: %d\n", np);
for (i = 0; i < np; ++i) {
switch (coninfo.connections[i].port_function_id) {
case UVISOR_FUNCTION_GENERIC:
desc = "Generic";
break;
case UVISOR_FUNCTION_DEBUGGER:
desc = "Debugger";
break;
case UVISOR_FUNCTION_HOTSYNC:
desc = "HotSync";
break;
case UVISOR_FUNCTION_REMOTE_FILE_SYS:
desc = "Remote File System";
break;
default:
desc = "unknown";
break;
}
DPRINTF("Port %d is for %s\n",
coninfo.connections[i].port, desc);
}
}
#endif
if (sc->sc_flag & UVISOR_FLAG_PALM4) {
uint8_t port;
/* Palm OS 4.0 Hack */
req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
req.bRequest = UVISOR_GET_PALM_INFORMATION;
USETW(req.wValue, 0);
USETW(req.wIndex, 0);
USETW(req.wLength, UVISOR_GET_PALM_INFORMATION_LEN);
err = usbd_do_request_flags
(udev, NULL, &req, &pconinfo, USB_SHORT_XFER_OK,
&actlen, USB_DEFAULT_TIMEOUT);
if (err) {
goto done;
}
if (actlen < 12) {
DPRINTF("too little data\n");
err = USB_ERR_INVAL;
goto done;
}
if (pconinfo.endpoint_numbers_different) {
port = pconinfo.connections[0].end_point_info;
config[0].endpoint = (port & 0xF); /* output */
config[1].endpoint = (port >> 4); /* input */
} else {
port = pconinfo.connections[0].port;
config[0].endpoint = (port & 0xF); /* output */
config[1].endpoint = (port & 0xF); /* input */
}
#if 0
req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
req.bRequest = UVISOR_GET_PALM_INFORMATION;
USETW(req.wValue, 0);
USETW(req.wIndex, 0);
USETW(req.wLength, UVISOR_GET_PALM_INFORMATION_LEN);
err = usbd_do_request(udev, &req, buffer);
if (err) {
goto done;
}
#endif
}
if (sc->sc_flag & UVISOR_FLAG_PALM35) {
/* get the config number */
DPRINTF("getting config info\n");
req.bmRequestType = UT_READ;
req.bRequest = UR_GET_CONFIG;
USETW(req.wValue, 0);
USETW(req.wIndex, 0);
USETW(req.wLength, 1);
err = usbd_do_request(udev, NULL, &req, buffer);
if (err) {
goto done;
}
/* get the interface number */
DPRINTF("get the interface number\n");
req.bmRequestType = UT_READ_DEVICE;
req.bRequest = UR_GET_INTERFACE;
USETW(req.wValue, 0);
USETW(req.wIndex, 0);
USETW(req.wLength, 1);
err = usbd_do_request(udev, NULL, &req, buffer);
if (err) {
goto done;
}
}
#if 0
uWord wAvail;
DPRINTF("getting available bytes\n");
req.bmRequestType = UT_READ_VENDOR_ENDPOINT;
req.bRequest = UVISOR_REQUEST_BYTES_AVAILABLE;
USETW(req.wValue, 0);
USETW(req.wIndex, 5);
USETW(req.wLength, sizeof(wAvail));
err = usbd_do_request(udev, NULL, &req, &wAvail);
if (err) {
goto done;
}
DPRINTF("avail=%d\n", UGETW(wAvail));
#endif
DPRINTF("done\n");
done:
return (err);
}
static void
uvisor_cfg_open(struct ucom_softc *ucom)
{
return;
}
static void
uvisor_cfg_close(struct ucom_softc *ucom)
{
struct uvisor_softc *sc = ucom->sc_parent;
uint8_t buffer[UVISOR_CONNECTION_INFO_SIZE];
struct usb_device_request req;
usb_error_t err;
req.bmRequestType = UT_READ_VENDOR_ENDPOINT; /* XXX read? */
req.bRequest = UVISOR_CLOSE_NOTIFICATION;
USETW(req.wValue, 0);
USETW(req.wIndex, 0);
USETW(req.wLength, UVISOR_CONNECTION_INFO_SIZE);
err = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
&req, buffer, 0, 1000);
if (err) {
DPRINTFN(0, "close notification failed, error=%s\n",
usbd_errstr(err));
}
}
static void
uvisor_start_read(struct ucom_softc *ucom)
{
struct uvisor_softc *sc = ucom->sc_parent;
usbd_transfer_start(sc->sc_xfer[UVISOR_BULK_DT_RD]);
}
static void
uvisor_stop_read(struct ucom_softc *ucom)
{
struct uvisor_softc *sc = ucom->sc_parent;
usbd_transfer_stop(sc->sc_xfer[UVISOR_BULK_DT_RD]);
}
static void
uvisor_start_write(struct ucom_softc *ucom)
{
struct uvisor_softc *sc = ucom->sc_parent;
usbd_transfer_start(sc->sc_xfer[UVISOR_BULK_DT_WR]);
}
static void
uvisor_stop_write(struct ucom_softc *ucom)
{
struct uvisor_softc *sc = ucom->sc_parent;
usbd_transfer_stop(sc->sc_xfer[UVISOR_BULK_DT_WR]);
}
static void
uvisor_write_callback(struct usb_xfer *xfer, usb_error_t error)
{
struct uvisor_softc *sc = usbd_xfer_softc(xfer);
struct usb_page_cache *pc;
uint32_t actlen;
uint8_t x;
switch (USB_GET_STATE(xfer)) {
case USB_ST_SETUP:
case USB_ST_TRANSFERRED:
tr_setup:
for (x = 0; x != UVISOROFRAMES; x++) {
usbd_xfer_set_frame_offset(xfer,
x * UVISOROBUFSIZE, x);
pc = usbd_xfer_get_frame(xfer, x);
if (ucom_get_data(&sc->sc_ucom, pc, 0,
UVISOROBUFSIZE, &actlen)) {
usbd_xfer_set_frame_len(xfer, x, actlen);
} else {
break;
}
}
/* check for data */
if (x != 0) {
usbd_xfer_set_frames(xfer, x);
usbd_transfer_submit(xfer);
}
break;
default: /* Error */
if (error != USB_ERR_CANCELLED) {
/* try to clear stall first */
usbd_xfer_set_stall(xfer);
goto tr_setup;
}
break;
}
}
static void
uvisor_read_callback(struct usb_xfer *xfer, usb_error_t error)
{
struct uvisor_softc *sc = usbd_xfer_softc(xfer);
struct usb_page_cache *pc;
int actlen;
usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
switch (USB_GET_STATE(xfer)) {
case USB_ST_TRANSFERRED:
pc = usbd_xfer_get_frame(xfer, 0);
ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
case USB_ST_SETUP:
tr_setup:
usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
usbd_transfer_submit(xfer);
return;
default: /* Error */
if (error != USB_ERR_CANCELLED) {
/* try to clear stall first */
usbd_xfer_set_stall(xfer);
goto tr_setup;
}
return;
}
}