d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
a36aa44a85
freebsd-nq/sys/dev/usb/usbdivar.h
Ian Dowse 368030a87a Use the limited scatter-gather capabilities of ehci, ohci and uhci 
host controllers to avoid the need to allocate any multi-page
physically contiguous memory blocks. This makes it possible to use
USB devices reliably on low-memory systems or when memory is too
fragmented for contiguous allocations to succeed.

The USB subsystem now uses bus_dmamap_load() directly on the buffers
supplied by USB peripheral drivers, so this also avoids having to
copy data back and forth before and after transfers. The ehci and
ohci controllers support scatter/gather as long as the buffer is
contiguous in the virtual address space. For uhci the hardware
cannot handle a physical address discontinuity within a USB packet,
so it is necessary to copy small memory fragments at times.
2006-05-28 05:27:09 +00:00

333 lines
11 KiB
C
Raw Blame History

/* $NetBSD: usbdivar.h,v 1.70 2002/07/11 21:14:36 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.
*/
#if defined(__NetBSD__)
#include <sys/callout.h>
#endif
/* From usb_mem.h */
DECLARE_USB_DMA_T;
struct usbd_xfer;
struct usbd_pipe;
struct usbd_endpoint {
usb_endpoint_descriptor_t *edesc;
int refcnt;
int savedtoggle;
};
struct usbd_bus_methods {
usbd_status (*open_pipe)(struct usbd_pipe *pipe);
void (*soft_intr)(void *);
void (*do_poll)(struct usbd_bus *);
usbd_status (*allocm)(struct usbd_bus *, usb_dma_t *,
u_int32_t bufsize);
void (*freem)(struct usbd_bus *, usb_dma_t *);
struct usbd_xfer * (*allocx)(struct usbd_bus *);
void (*freex)(struct usbd_bus *, struct usbd_xfer *);
};
struct usbd_pipe_methods {
usbd_status (*transfer)(usbd_xfer_handle xfer);
usbd_status (*start)(usbd_xfer_handle xfer);
void (*abort)(usbd_xfer_handle xfer);
void (*close)(usbd_pipe_handle pipe);
void (*cleartoggle)(usbd_pipe_handle pipe);
void (*done)(usbd_xfer_handle xfer);
};
struct usbd_tt {
struct usbd_hub *hub;
};
struct usbd_port {
usb_port_status_t status;
u_int16_t power; /* mA of current on port */
u_int8_t portno;
u_int8_t restartcnt;
#define USBD_RESTART_MAX 5
struct usbd_device *device; /* Connected device */
struct usbd_device *parent; /* The ports hub */
struct usbd_tt *tt; /* Transaction translator (if any) */
};
struct usbd_hub {
usbd_status (*explore)(usbd_device_handle hub);
void *hubsoftc;
usb_hub_descriptor_t hubdesc;
struct usbd_port ports[1];
};
struct usb_softc;
/*****/
struct usbd_bus {
/* Filled by HC driver */
USBBASEDEVICE bdev; /* base device, host adapter */
struct usbd_bus_methods *methods;
u_int32_t pipe_size; /* size of a pipe struct */
/* Filled by usb driver */
struct usbd_device *root_hub;
usbd_device_handle devices[USB_MAX_DEVICES];
char needs_explore;/* a hub a signalled a change */
char use_polling;
struct usb_softc *usbctl;
struct usb_device_stats stats;
int intr_context;
u_int no_intrs;
int usbrev; /* USB revision */
#define USBREV_UNKNOWN 0
#define USBREV_PRE_1_0 1
#define USBREV_1_0 2
#define USBREV_1_1 3
#define USBREV_2_0 4
#define USBREV_STR { "unknown", "pre 1.0", "1.0", "1.1", "2.0" }
#ifdef USB_USE_SOFTINTR
#ifdef __HAVE_GENERIC_SOFT_INTERRUPTS
void *soft; /* soft interrupt cookie */
#else
struct callout softi;
#endif
#endif
bus_dma_tag_t parent_dmatag; /* Base DMA tag */
bus_dma_tag_t buffer_dmatag; /* Tag for transfer buffers */
};
struct usbd_device {
struct usbd_bus *bus; /* our controller */
struct usbd_pipe *default_pipe; /* pipe 0 */
u_int8_t address; /* device addess */
u_int8_t config; /* current configuration # */
u_int8_t depth; /* distance from root hub */
u_int8_t speed; /* low/full/high speed */
u_int8_t self_powered; /* flag for self powered */
u_int16_t power; /* mA the device uses */
int16_t langid; /* language for strings */
#define USBD_NOLANG (-1)
usb_event_cookie_t cookie; /* unique connection id */
struct usbd_port *powersrc; /* upstream hub port, or 0 */
struct usbd_device *myhub; /* upstream hub */
struct usbd_port *myhsport; /* closest high speed port */
struct usbd_endpoint def_ep; /* for pipe 0 */
usb_endpoint_descriptor_t def_ep_desc; /* for pipe 0 */
struct usbd_interface *ifaces; /* array of all interfaces */
usb_device_descriptor_t ddesc; /* device descriptor */
usb_config_descriptor_t *cdesc; /* full config descr */
const struct usbd_quirks *quirks; /* device quirks, always set */
struct usbd_hub *hub; /* only if this is a hub */
device_ptr_t *subdevs; /* sub-devices, 0 terminated */
uint8_t *ifacenums; /* sub-device interfacenumbers */
};
struct usbd_interface {
struct usbd_device *device;
usb_interface_descriptor_t *idesc;
int index;
int altindex;
struct usbd_endpoint *endpoints;
void *priv;
LIST_HEAD(, usbd_pipe) pipes;
};
struct usbd_pipe {
struct usbd_interface *iface;
struct usbd_device *device;
struct usbd_endpoint *endpoint;
int refcnt;
char running;
char aborting;
SIMPLEQ_HEAD(, usbd_xfer) queue;
LIST_ENTRY(usbd_pipe) next;
usbd_xfer_handle intrxfer; /* used for repeating requests */
char repeat;
int interval;
/* Filled by HC driver. */
struct usbd_pipe_methods *methods;
};
#define USB_DMA_NSEG (btoc(MAXPHYS) + 1)
/* DMA-capable memory buffer. */
struct usb_dma_mapping {
bus_dma_segment_t segs[USB_DMA_NSEG]; /* The physical segments. */
int nsegs; /* Number of segments. */
bus_dmamap_t map; /* DMA mapping. */
};
struct usbd_xfer {
struct usbd_pipe *pipe;
void *priv;
void *buffer;
u_int32_t length;
u_int32_t actlen;
u_int16_t flags;
u_int32_t timeout;
usbd_status status;
usbd_callback callback;
__volatile char done;
#ifdef DIAGNOSTIC
u_int32_t busy_free;
#define XFER_FREE 0x46524545
#define XFER_BUSY 0x42555359
#define XFER_ONQU 0x4f4e5155
#endif
/* For control pipe */
usb_device_request_t request;
/* For isoc */
u_int16_t *frlengths;
int nframes;
/* For memory allocation */
struct usbd_device *device;
struct usb_dma_mapping dmamap;
void *allocbuf;
int rqflags;
#define URQ_REQUEST 0x01
#define URQ_AUTO_DMABUF 0x10
#define URQ_DEV_DMABUF 0x20
SIMPLEQ_ENTRY(usbd_xfer) next;
void *hcpriv; /* private use by the HC driver */
usb_callout_t timeout_handle;
};
void usbd_init(void);
void usbd_finish(void);
#ifdef USB_DEBUG
void usbd_dump_iface(struct usbd_interface *iface);
void usbd_dump_device(struct usbd_device *dev);
void usbd_dump_endpoint(struct usbd_endpoint *endp);
void usbd_dump_queue(usbd_pipe_handle pipe);
void usbd_dump_pipe(usbd_pipe_handle pipe);
#endif
/* Routines from usb_subr.c */
int usbctlprint(void *, const char *);
void usb_delay_ms(usbd_bus_handle, u_int);
usbd_status usbd_reset_port(usbd_device_handle dev,
int port, usb_port_status_t *ps);
usbd_status usbd_setup_pipe(usbd_device_handle dev,
usbd_interface_handle iface,
struct usbd_endpoint *, int,
usbd_pipe_handle *pipe);
usbd_status usbd_new_device(device_ptr_t parent,
usbd_bus_handle bus, int depth,
int lowspeed, int port,
struct usbd_port *);
void usbd_remove_device(usbd_device_handle, struct usbd_port *);
int usbd_printBCD(char *cp, int bcd);
usbd_status usbd_fill_iface_data(usbd_device_handle dev, int i, int a);
void usb_free_device(usbd_device_handle);
usbd_status usb_insert_transfer(usbd_xfer_handle xfer);
void usb_transfer_complete(usbd_xfer_handle xfer);
void usb_disconnect_port(struct usbd_port *up, device_ptr_t);
/* Routines from usb.c */
void usb_needs_explore(usbd_device_handle);
void usb_schedsoftintr(struct usbd_bus *);
/*
* XXX This check is extremely bogus. Bad Bad Bad.
*/
#if defined(DIAGNOSTIC) && 0
#define SPLUSBCHECK \
do { int _s = splusb(), _su = splusb(); \
if (!cold && _s != _su) printf("SPLUSBCHECK failed 0x%x!=0x%x, %s:%d\n", \
_s, _su, __FILE__, __LINE__); \
splx(_s); \
} while (0)
#else
#define SPLUSBCHECK
#endif
/* Locator stuff. */
#if defined(__NetBSD__)
#include "locators.h"
#elif defined(__FreeBSD__) || defined(__OpenBSD__)
/* XXX these values are used to statically bind some elements in the USB tree
* to specific driver instances. This should be somehow emulated in FreeBSD
* but can be done later on.
* The values are copied from the files.usb file in the NetBSD sources.
*/
#define UHUBCF_PORT_DEFAULT -1
#define UHUBCF_CONFIGURATION_DEFAULT -1
#define UHUBCF_INTERFACE_DEFAULT -1
#define UHUBCF_VENDOR_DEFAULT -1
#define UHUBCF_PRODUCT_DEFAULT -1
#define UHUBCF_RELEASE_DEFAULT -1
#endif
#if defined (__OpenBSD__)
#define UHUBCF_PORT 0
#define UHUBCF_CONFIGURATION 1
#define UHUBCF_INTERFACE 2
#define UHUBCF_VENDOR 3
#define UHUBCF_PRODUCT 4
#define UHUBCF_RELEASE 5
#endif
#define uhubcf_port cf_loc[UHUBCF_PORT]
#define uhubcf_configuration cf_loc[UHUBCF_CONFIGURATION]
#define uhubcf_interface cf_loc[UHUBCF_INTERFACE]
#define uhubcf_vendor cf_loc[UHUBCF_VENDOR]
#define uhubcf_product cf_loc[UHUBCF_PRODUCT]
#define uhubcf_release cf_loc[UHUBCF_RELEASE]
#define UHUB_UNK_PORT UHUBCF_PORT_DEFAULT /* wildcarded 'port' */
#define UHUB_UNK_CONFIGURATION UHUBCF_CONFIGURATION_DEFAULT /* wildcarded 'configuration' */
#define UHUB_UNK_INTERFACE UHUBCF_INTERFACE_DEFAULT /* wildcarded 'interface' */
#define UHUB_UNK_VENDOR UHUBCF_VENDOR_DEFAULT /* wildcarded 'vendor' */
#define UHUB_UNK_PRODUCT UHUBCF_PRODUCT_DEFAULT /* wildcarded 'product' */
#define UHUB_UNK_RELEASE UHUBCF_RELEASE_DEFAULT /* wildcarded 'release' */
Reference in New Issue View Git Blame Copy Permalink