a07e9d4af3
uhub.c: revision 1.37
usb.4: revision 1.30
usb.c: revision 1.38
usb.h: revision 1.40
usb_port.h: revision 1.21
usb_subr.c: revision 1.65
usbdi.h: revision 1.40
Split the attach/detach events up into device, driver and controller
attach and detach events.
The commit message from NetBSD was:
date: 2000/02/02 07:34:00; author: augustss; state: Exp;
Change the USB event mechanism to include more information
about devices and drivers. Partly from FreeBSD.
Also rework usbd to take these new event types into account.
263 lines
9.6 KiB
C
263 lines
9.6 KiB
C
/* $NetBSD: usbdi.h,v 1.40 2000/02/02 07:34:00 augustss Exp $ */
|
|
/* $FreeBSD$ */
|
|
|
|
/*
|
|
* Copyright (c) 1998 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.
|
|
* 3. All advertising materials mentioning features or use of this software
|
|
* must display the following acknowledgement:
|
|
* This product includes software developed by the NetBSD
|
|
* Foundation, Inc. and its contributors.
|
|
* 4. Neither the name of The NetBSD Foundation nor the names of its
|
|
* contributors may be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* 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.
|
|
*/
|
|
|
|
typedef struct usbd_bus *usbd_bus_handle;
|
|
typedef struct usbd_device *usbd_device_handle;
|
|
typedef struct usbd_interface *usbd_interface_handle;
|
|
typedef struct usbd_pipe *usbd_pipe_handle;
|
|
typedef struct usbd_xfer *usbd_xfer_handle;
|
|
typedef void *usbd_private_handle;
|
|
|
|
typedef enum { /* keep in sync with usbd_status_msgs */
|
|
USBD_NORMAL_COMPLETION = 0, /* must be 0 */
|
|
USBD_IN_PROGRESS,
|
|
/* errors */
|
|
USBD_PENDING_REQUESTS,
|
|
USBD_NOT_STARTED,
|
|
USBD_INVAL,
|
|
USBD_NOMEM,
|
|
USBD_CANCELLED,
|
|
USBD_BAD_ADDRESS,
|
|
USBD_IN_USE,
|
|
USBD_NO_ADDR,
|
|
USBD_SET_ADDR_FAILED,
|
|
USBD_NO_POWER,
|
|
USBD_TOO_DEEP,
|
|
USBD_IOERROR,
|
|
USBD_NOT_CONFIGURED,
|
|
USBD_TIMEOUT,
|
|
USBD_SHORT_XFER,
|
|
USBD_STALLED,
|
|
USBD_INTERRUPTED,
|
|
|
|
USBD_ERROR_MAX, /* must be last */
|
|
} usbd_status;
|
|
|
|
typedef void (*usbd_callback)(usbd_xfer_handle, usbd_private_handle,
|
|
usbd_status);
|
|
|
|
/* Open flags */
|
|
#define USBD_EXCLUSIVE_USE 0x01
|
|
|
|
/* Use default (specified by ep. desc.) interval on interrupt pipe */
|
|
#define USBD_DEFAULT_INTERVAL (-1)
|
|
|
|
/* Request flags */
|
|
#define USBD_NO_COPY 0x01 /* do not copy data to DMA buffer */
|
|
#define USBD_SYNCHRONOUS 0x02 /* wait for completion */
|
|
/* in usb.h #define USBD_SHORT_XFER_OK 0x04*/ /* allow short reads */
|
|
#define USBD_FORCE_SHORT_XFER 0x08 /* force last short packet on write */
|
|
|
|
/* XXX Temporary hack XXX */
|
|
#define USBD_NO_TSLEEP 0x80 /* XXX use busy wait */
|
|
|
|
#define USBD_NO_TIMEOUT 0
|
|
#define USBD_DEFAULT_TIMEOUT 5000 /* ms = 5 s */
|
|
|
|
#if defined(__FreeBSD__)
|
|
#define USB_CDEV_MAJOR 108
|
|
#endif
|
|
|
|
usbd_status usbd_open_pipe
|
|
(usbd_interface_handle iface, u_int8_t address,
|
|
u_int8_t flags, usbd_pipe_handle *pipe);
|
|
usbd_status usbd_close_pipe (usbd_pipe_handle pipe);
|
|
usbd_status usbd_transfer (usbd_xfer_handle req);
|
|
usbd_xfer_handle usbd_alloc_xfer (usbd_device_handle);
|
|
usbd_status usbd_free_xfer (usbd_xfer_handle xfer);
|
|
void usbd_setup_xfer
|
|
(usbd_xfer_handle xfer, usbd_pipe_handle pipe,
|
|
usbd_private_handle priv, void *buffer,
|
|
u_int32_t length, u_int16_t flags, u_int32_t timeout,
|
|
usbd_callback);
|
|
void usbd_setup_default_xfer
|
|
(usbd_xfer_handle xfer, usbd_device_handle dev,
|
|
usbd_private_handle priv, u_int32_t timeout,
|
|
usb_device_request_t *req, void *buffer,
|
|
u_int32_t length, u_int16_t flags, usbd_callback);
|
|
void usbd_setup_isoc_xfer
|
|
(usbd_xfer_handle xfer, usbd_pipe_handle pipe,
|
|
usbd_private_handle priv, u_int16_t *frlengths,
|
|
u_int32_t nframes, u_int16_t flags, usbd_callback);
|
|
void usbd_get_xfer_status
|
|
(usbd_xfer_handle xfer, usbd_private_handle *priv,
|
|
void **buffer, u_int32_t *count, usbd_status *status);
|
|
usb_endpoint_descriptor_t *usbd_interface2endpoint_descriptor
|
|
(usbd_interface_handle iface, u_int8_t address);
|
|
usbd_status usbd_abort_pipe(usbd_pipe_handle pipe);
|
|
usbd_status usbd_clear_endpoint_stall(usbd_pipe_handle pipe);
|
|
usbd_status usbd_clear_endpoint_stall_async(usbd_pipe_handle pipe);
|
|
void usbd_clear_endpoint_toggle(usbd_pipe_handle pipe);
|
|
usbd_status usbd_endpoint_count
|
|
(usbd_interface_handle dev, u_int8_t *count);
|
|
usbd_status usbd_interface_count
|
|
(usbd_device_handle dev, u_int8_t *count);
|
|
usbd_status usbd_interface2device_handle
|
|
(usbd_interface_handle iface, usbd_device_handle *dev);
|
|
usbd_status usbd_device2interface_handle
|
|
(usbd_device_handle dev, u_int8_t ifaceno, usbd_interface_handle *iface);
|
|
|
|
usbd_device_handle usbd_pipe2device_handle(usbd_pipe_handle);
|
|
void *usbd_alloc_buffer(usbd_xfer_handle req, u_int32_t size);
|
|
void usbd_free_buffer(usbd_xfer_handle req);
|
|
void *usbd_get_buffer(usbd_xfer_handle xfer);
|
|
usbd_status usbd_sync_transfer(usbd_xfer_handle req);
|
|
usbd_status usbd_open_pipe_intr
|
|
(usbd_interface_handle iface, u_int8_t address,
|
|
u_int8_t flags, usbd_pipe_handle *pipe,
|
|
usbd_private_handle priv, void *buffer,
|
|
u_int32_t length, usbd_callback, int);
|
|
usbd_status usbd_do_request
|
|
(usbd_device_handle pipe, usb_device_request_t *req, void *data);
|
|
usbd_status usbd_do_request_async
|
|
(usbd_device_handle pipe, usb_device_request_t *req, void *data);
|
|
usbd_status usbd_do_request_flags
|
|
(usbd_device_handle pipe, usb_device_request_t *req,
|
|
void *data, u_int16_t flags, int *);
|
|
usb_interface_descriptor_t *usbd_get_interface_descriptor
|
|
(usbd_interface_handle iface);
|
|
usb_config_descriptor_t *usbd_get_config_descriptor
|
|
(usbd_device_handle dev);
|
|
usb_device_descriptor_t *usbd_get_device_descriptor
|
|
(usbd_device_handle dev);
|
|
usbd_status usbd_set_interface(usbd_interface_handle, int);
|
|
int usbd_get_no_alts(usb_config_descriptor_t *, int);
|
|
usbd_status usbd_get_interface
|
|
(usbd_interface_handle iface, u_int8_t *aiface);
|
|
void usbd_fill_deviceinfo
|
|
(usbd_device_handle dev, struct usb_device_info *di, int usedev);
|
|
int usbd_get_interface_altindex(usbd_interface_handle iface);
|
|
|
|
usb_interface_descriptor_t *usbd_find_idesc
|
|
(usb_config_descriptor_t *cd, int iindex, int ano);
|
|
usb_endpoint_descriptor_t *usbd_find_edesc
|
|
(usb_config_descriptor_t *cd, int ifaceidx, int altidx,
|
|
int endptidx);
|
|
|
|
void usbd_dopoll(usbd_interface_handle);
|
|
void usbd_set_polling(usbd_interface_handle iface, int on);
|
|
|
|
const char *usbd_errstr(usbd_status err);
|
|
|
|
void usbd_add_dev_event (int, usbd_device_handle);
|
|
void usbd_add_drv_event (int, usbd_device_handle, device_ptr_t);
|
|
|
|
void usbd_devinfo(usbd_device_handle, int, char *);
|
|
const struct usbd_quirks *usbd_get_quirks(usbd_device_handle);
|
|
usb_endpoint_descriptor_t *usbd_get_endpoint_descriptor
|
|
(usbd_interface_handle iface, u_int8_t address);
|
|
|
|
usbd_status usbd_reload_device_desc(usbd_device_handle);
|
|
|
|
/* NetBSD attachment information */
|
|
|
|
/* Attach data */
|
|
struct usb_attach_arg {
|
|
int port;
|
|
int configno;
|
|
int ifaceno;
|
|
int vendor;
|
|
int product;
|
|
int release;
|
|
usbd_device_handle device; /* current device */
|
|
usbd_interface_handle iface; /* current interface */
|
|
int usegeneric;
|
|
usbd_interface_handle *ifaces; /* all interfaces */
|
|
int nifaces; /* number of interfaces */
|
|
};
|
|
|
|
#if defined(__NetBSD__) || defined(__OpenBSD__)
|
|
/* Match codes. */
|
|
/* First five codes is for a whole device. */
|
|
#define UMATCH_VENDOR_PRODUCT_REV 14
|
|
#define UMATCH_VENDOR_PRODUCT 13
|
|
#define UMATCH_VENDOR_DEVCLASS_DEVPROTO 12
|
|
#define UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO 11
|
|
#define UMATCH_DEVCLASS_DEVSUBCLASS 10
|
|
/* Next six codes are for interfaces. */
|
|
#define UMATCH_VENDOR_PRODUCT_REV_CONF_IFACE 9
|
|
#define UMATCH_VENDOR_PRODUCT_CONF_IFACE 8
|
|
#define UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO 7
|
|
#define UMATCH_VENDOR_IFACESUBCLASS 6
|
|
#define UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO 5
|
|
#define UMATCH_IFACECLASS_IFACESUBCLASS 4
|
|
#define UMATCH_IFACECLASS 3
|
|
#define UMATCH_IFACECLASS_GENERIC 2
|
|
/* Generic driver */
|
|
#define UMATCH_GENERIC 1
|
|
/* No match */
|
|
#define UMATCH_NONE 0
|
|
|
|
#elif defined(__FreeBSD__)
|
|
/* FreeBSD needs values less than zero */
|
|
#define UMATCH_VENDOR_PRODUCT_REV (-10)
|
|
#define UMATCH_VENDOR_PRODUCT (-20)
|
|
#define UMATCH_VENDOR_DEVCLASS_DEVPROTO (-30)
|
|
#define UMATCH_DEVCLASS_DEVSUBCLASS_DEVPROTO (-40)
|
|
#define UMATCH_DEVCLASS_DEVSUBCLASS (-50)
|
|
#define UMATCH_VENDOR_PRODUCT_REV_CONF_IFACE (-60)
|
|
#define UMATCH_VENDOR_PRODUCT_CONF_IFACE (-70)
|
|
#define UMATCH_VENDOR_IFACESUBCLASS_IFACEPROTO (-80)
|
|
#define UMATCH_VENDOR_IFACESUBCLASS (-90)
|
|
#define UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO (-100)
|
|
#define UMATCH_IFACECLASS_IFACESUBCLASS (-110)
|
|
#define UMATCH_IFACECLASS (-120)
|
|
#define UMATCH_IFACECLASS_GENERIC (-130)
|
|
#define UMATCH_GENERIC (-140)
|
|
#define UMATCH_NONE (ENXIO)
|
|
|
|
#endif
|
|
|
|
#if defined(__FreeBSD__)
|
|
int usbd_driver_load(module_t mod, int what, void *arg);
|
|
#endif
|
|
|
|
/*
|
|
* XXX
|
|
* splusb MUST be the lowest level interrupt so that within USB callbacks
|
|
* the level can be raised the appropriate level.
|
|
* XXX Should probably use a softsplusb.
|
|
*/
|
|
/* XXX */
|
|
#define splusb splbio
|
|
#define splhardusb splbio
|
|
#define IPL_USB IPL_BIO
|
|
/* XXX */
|