Signed-off-by: Peter Mamonov <pmamonov@gmail.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
443 lines
15 KiB
C
443 lines
15 KiB
C
/*
|
|
* (C) Copyright 2001
|
|
* Denis Peter, MPL AG Switzerland
|
|
*
|
|
* See file CREDITS for list of people who contributed to this
|
|
* project.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License as
|
|
* published by the Free Software Foundation; either version 2 of
|
|
* the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
*
|
|
* Note: Part of this code has been derived from linux
|
|
*
|
|
*/
|
|
#ifndef _USB_H_
|
|
#define _USB_H_
|
|
|
|
#include <driver.h>
|
|
#include <usb/ch9.h>
|
|
#include <usb/ch11.h>
|
|
#include <usb/usb_defs.h>
|
|
#include <asm/byteorder.h>
|
|
|
|
/* Everything is aribtrary */
|
|
#define USB_ALTSETTINGALLOC 4
|
|
#define USB_MAXALTSETTING 128 /* Hard limit */
|
|
|
|
#define USB_MAX_DEVICE 32
|
|
#define USB_MAXCONFIG 8
|
|
#define USB_MAXINTERFACES 16
|
|
#define USB_MAXENDPOINTS 16
|
|
#define USB_MAXCHILDREN 8 /* This is arbitrary */
|
|
#define USB_MAX_HUB 16
|
|
|
|
#define USB_CNTL_TIMEOUT 5000 /* 5000ms timeout */
|
|
|
|
/* device request (setup) */
|
|
struct devrequest {
|
|
unsigned char requesttype;
|
|
unsigned char request;
|
|
unsigned short value;
|
|
unsigned short index;
|
|
unsigned short length;
|
|
} __attribute__ ((packed));
|
|
|
|
enum {
|
|
/* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */
|
|
PACKET_SIZE_8 = 0,
|
|
PACKET_SIZE_16 = 1,
|
|
PACKET_SIZE_32 = 2,
|
|
PACKET_SIZE_64 = 3,
|
|
};
|
|
|
|
struct usb_interface {
|
|
struct usb_interface_descriptor desc;
|
|
|
|
unsigned char no_of_ep;
|
|
unsigned char num_altsetting;
|
|
unsigned char act_altsetting;
|
|
|
|
struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
|
|
};
|
|
|
|
struct usb_configuration {
|
|
struct usb_config_descriptor desc;
|
|
|
|
unsigned char no_of_if; /* number of interfaces */
|
|
struct usb_interface interface[USB_MAXINTERFACES];
|
|
};
|
|
|
|
struct usb_device {
|
|
int devnum; /* Device number on USB bus */
|
|
int speed; /* full/low/high */
|
|
char mf[32]; /* manufacturer */
|
|
char prod[32]; /* product */
|
|
char serial[32]; /* serial number */
|
|
|
|
/* Maximum packet size; one of: PACKET_SIZE_* */
|
|
int maxpacketsize;
|
|
/* one bit for each endpoint ([0] = IN, [1] = OUT) */
|
|
unsigned int toggle[2];
|
|
/* endpoint halts; one bit per endpoint # & direction;
|
|
* [0] = IN, [1] = OUT
|
|
*/
|
|
unsigned int halted[2];
|
|
int epmaxpacketin[16]; /* INput endpoint specific maximums */
|
|
int epmaxpacketout[16]; /* OUTput endpoint specific maximums */
|
|
|
|
int configno; /* selected config number */
|
|
struct usb_device_descriptor *descriptor; /* Device Descriptor */
|
|
struct usb_configuration config; /* config descriptor */
|
|
struct devrequest *setup_packet;
|
|
|
|
int have_langid; /* whether string_langid is valid yet */
|
|
int string_langid; /* language ID for strings */
|
|
/*
|
|
* Child devices - if this is a hub device
|
|
* Each instance needs its own set of data structures.
|
|
*/
|
|
unsigned long status;
|
|
int act_len; /* transfered bytes */
|
|
int maxchild; /* Number of ports if hub */
|
|
int portnr;
|
|
struct usb_device *parent;
|
|
struct usb_device *children[USB_MAXCHILDREN];
|
|
|
|
struct device_d dev;
|
|
|
|
struct usb_host *host;
|
|
|
|
struct list_head list;
|
|
void *drv_data;
|
|
struct usb_hub_device *hub;
|
|
};
|
|
|
|
struct usb_device_id;
|
|
|
|
struct usb_driver {
|
|
const char *name;
|
|
int (*probe) (struct usb_device *, const struct usb_device_id *);
|
|
void (*disconnect)(struct usb_device *);
|
|
|
|
const struct usb_device_id *id_table;
|
|
|
|
struct driver_d driver;
|
|
};
|
|
|
|
extern struct bus_type usb_bus_type;
|
|
|
|
int usb_driver_register(struct usb_driver *);
|
|
|
|
struct usb_host {
|
|
int (*init)(struct usb_host *);
|
|
int (*exit)(struct usb_host *);
|
|
int (*submit_bulk_msg)(struct usb_device *dev, unsigned long pipe,
|
|
void *buffer, int transfer_len, int timeout);
|
|
int (*submit_control_msg)(struct usb_device *dev, unsigned long pipe, void *buffer,
|
|
int transfer_len, struct devrequest *setup, int timeout);
|
|
int (*submit_int_msg)(struct usb_device *dev, unsigned long pipe, void *buffer,
|
|
int transfer_len, int interval);
|
|
void (*usb_event_poll)(void);
|
|
|
|
struct list_head list;
|
|
|
|
struct device_d *hw_dev;
|
|
int busnum;
|
|
struct usb_device *root_dev;
|
|
int sem;
|
|
};
|
|
|
|
int usb_register_host(struct usb_host *);
|
|
|
|
int usb_host_detect(struct usb_host *host);
|
|
|
|
int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
|
|
int usb_set_idle(struct usb_device *dev, int ifnum, int duration,
|
|
int report_id);
|
|
int usb_control_msg(struct usb_device *dev, unsigned int pipe,
|
|
unsigned char request, unsigned char requesttype,
|
|
unsigned short value, unsigned short index,
|
|
void *data, unsigned short size, int timeout);
|
|
int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
|
|
void *data, int len, int *actual_length, int timeout);
|
|
int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
|
|
void *buffer, int transfer_len, int interval);
|
|
void usb_disable_asynch(int disable);
|
|
int usb_maxpacket(struct usb_device *dev, unsigned long pipe);
|
|
int usb_get_configuration_no(struct usb_device *dev, unsigned char *buffer,
|
|
int cfgno);
|
|
int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
|
|
unsigned char id, void *buf, int size);
|
|
int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
|
|
unsigned char type, unsigned char id, void *buf,
|
|
int size);
|
|
int usb_clear_halt(struct usb_device *dev, int pipe);
|
|
int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
|
|
int usb_set_interface(struct usb_device *dev, int interface, int alternate);
|
|
|
|
void usb_rescan(void);
|
|
|
|
/* big endian -> little endian conversion */
|
|
/* some CPUs are already little endian e.g. the ARM920T */
|
|
#define __swap_16(x) \
|
|
({ unsigned short x_ = (unsigned short)x; \
|
|
(unsigned short)( \
|
|
((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \
|
|
})
|
|
#define __swap_32(x) \
|
|
({ unsigned long x_ = (unsigned long)x; \
|
|
(unsigned long)( \
|
|
((x_ & 0x000000FFUL) << 24) | \
|
|
((x_ & 0x0000FF00UL) << 8) | \
|
|
((x_ & 0x00FF0000UL) >> 8) | \
|
|
((x_ & 0xFF000000UL) >> 24)); \
|
|
})
|
|
|
|
#ifdef __LITTLE_ENDIAN
|
|
# define swap_16(x) (x)
|
|
# define swap_32(x) (x)
|
|
#elif defined __BIG_ENDIAN
|
|
# define swap_16(x) __swap_16(x)
|
|
# define swap_32(x) __swap_32(x)
|
|
#else
|
|
#error "could not determine byte order"
|
|
#endif
|
|
|
|
/*
|
|
* Calling this entity a "pipe" is glorifying it. A USB pipe
|
|
* is something embarrassingly simple: it basically consists
|
|
* of the following information:
|
|
* - device number (7 bits)
|
|
* - endpoint number (4 bits)
|
|
* - current Data0/1 state (1 bit)
|
|
* - direction (1 bit)
|
|
* - speed (2 bits)
|
|
* - max packet size (2 bits: 8, 16, 32 or 64)
|
|
* - pipe type (2 bits: control, interrupt, bulk, isochronous)
|
|
*
|
|
* That's 18 bits. Really. Nothing more. And the USB people have
|
|
* documented these eighteen bits as some kind of glorious
|
|
* virtual data structure.
|
|
*
|
|
* Let's not fall in that trap. We'll just encode it as a simple
|
|
* unsigned int. The encoding is:
|
|
*
|
|
* - max size: bits 0-1 (00 = 8, 01 = 16, 10 = 32, 11 = 64)
|
|
* - direction: bit 7 (0 = Host-to-Device [Out],
|
|
* (1 = Device-to-Host [In])
|
|
* - device: bits 8-14
|
|
* - endpoint: bits 15-18
|
|
* - Data0/1: bit 19
|
|
* - speed: bit 26 (0 = Full, 1 = Low Speed, 2 = High)
|
|
* - pipe type: bits 30-31 (00 = isochronous, 01 = interrupt,
|
|
* 10 = control, 11 = bulk)
|
|
*
|
|
* Why? Because it's arbitrary, and whatever encoding we select is really
|
|
* up to us. This one happens to share a lot of bit positions with the UHCI
|
|
* specification, so that much of the uhci driver can just mask the bits
|
|
* appropriately.
|
|
*/
|
|
/* Create various pipes... */
|
|
#define create_pipe(dev,endpoint) \
|
|
(((dev)->devnum << 8) | ((endpoint) << 15) | \
|
|
((dev)->speed << 26) | (dev)->maxpacketsize)
|
|
#define default_pipe(dev) ((dev)->speed << 26)
|
|
|
|
#define usb_sndctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
|
|
create_pipe(dev, (endpoint)))
|
|
#define usb_rcvctrlpipe(dev, endpoint) ((PIPE_CONTROL << 30) | \
|
|
create_pipe(dev, (endpoint)) | \
|
|
USB_DIR_IN)
|
|
#define usb_sndisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
|
|
create_pipe(dev, (endpoint)))
|
|
#define usb_rcvisocpipe(dev, endpoint) ((PIPE_ISOCHRONOUS << 30) | \
|
|
create_pipe(dev, (endpoint)) | \
|
|
USB_DIR_IN)
|
|
#define usb_sndbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
|
|
create_pipe(dev, (endpoint)))
|
|
#define usb_rcvbulkpipe(dev, endpoint) ((PIPE_BULK << 30) | \
|
|
create_pipe(dev, (endpoint)) | \
|
|
USB_DIR_IN)
|
|
#define usb_sndintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
|
|
create_pipe(dev, (endpoint)))
|
|
#define usb_rcvintpipe(dev, endpoint) ((PIPE_INTERRUPT << 30) | \
|
|
create_pipe(dev, (endpoint)) | \
|
|
USB_DIR_IN)
|
|
#define usb_snddefctrl(dev) ((PIPE_CONTROL << 30) | \
|
|
default_pipe(dev))
|
|
#define usb_rcvdefctrl(dev) ((PIPE_CONTROL << 30) | \
|
|
default_pipe(dev) | \
|
|
USB_DIR_IN)
|
|
|
|
/* The D0/D1 toggle bits */
|
|
#define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
|
|
#define usb_dotoggle(dev, ep, out) ((dev)->toggle[out] ^= (1 << ep))
|
|
#define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
|
|
((dev)->toggle[out] & \
|
|
~(1 << ep)) | ((bit) << ep))
|
|
|
|
/* Endpoint halt control/status */
|
|
#define usb_endpoint_out(ep_dir) (((ep_dir >> 7) & 1) ^ 1)
|
|
#define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
|
|
#define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
|
|
#define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
|
|
|
|
#define usb_packetid(pipe) (((pipe) & USB_DIR_IN) ? USB_PID_IN : \
|
|
USB_PID_OUT)
|
|
|
|
#define usb_pipeout(pipe) ((((pipe) >> 7) & 1) ^ 1)
|
|
#define usb_pipein(pipe) (((pipe) >> 7) & 1)
|
|
#define usb_pipedevice(pipe) (((pipe) >> 8) & 0x7f)
|
|
#define usb_pipe_endpdev(pipe) (((pipe) >> 8) & 0x7ff)
|
|
#define usb_pipeendpoint(pipe) (((pipe) >> 15) & 0xf)
|
|
#define usb_pipedata(pipe) (((pipe) >> 19) & 1)
|
|
#define usb_pipetype(pipe) (((pipe) >> 30) & 3)
|
|
#define usb_pipeisoc(pipe) (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
|
|
#define usb_pipeint(pipe) (usb_pipetype((pipe)) == PIPE_INTERRUPT)
|
|
#define usb_pipecontrol(pipe) (usb_pipetype((pipe)) == PIPE_CONTROL)
|
|
#define usb_pipebulk(pipe) (usb_pipetype((pipe)) == PIPE_BULK)
|
|
|
|
|
|
/*************************************************************************
|
|
* Hub Stuff
|
|
*/
|
|
struct usb_hub_device {
|
|
struct usb_device *pusb_dev;
|
|
struct usb_hub_descriptor desc;
|
|
};
|
|
|
|
/**
|
|
* struct usb_device_id - identifies USB devices for probing and hotplugging
|
|
* @match_flags: Bit mask controlling of the other fields are used to match
|
|
* against new devices. Any field except for driver_info may be used,
|
|
* although some only make sense in conjunction with other fields.
|
|
* This is usually set by a USB_DEVICE_*() macro, which sets all
|
|
* other fields in this structure except for driver_info.
|
|
* @idVendor: USB vendor ID for a device; numbers are assigned
|
|
* by the USB forum to its members.
|
|
* @idProduct: Vendor-assigned product ID.
|
|
* @bcdDevice_lo: Low end of range of vendor-assigned product version numbers.
|
|
* This is also used to identify individual product versions, for
|
|
* a range consisting of a single device.
|
|
* @bcdDevice_hi: High end of version number range. The range of product
|
|
* versions is inclusive.
|
|
* @bDeviceClass: Class of device; numbers are assigned
|
|
* by the USB forum. Products may choose to implement classes,
|
|
* or be vendor-specific. Device classes specify behavior of all
|
|
* the interfaces on a devices.
|
|
* @bDeviceSubClass: Subclass of device; associated with bDeviceClass.
|
|
* @bDeviceProtocol: Protocol of device; associated with bDeviceClass.
|
|
* @bInterfaceClass: Class of interface; numbers are assigned
|
|
* by the USB forum. Products may choose to implement classes,
|
|
* or be vendor-specific. Interface classes specify behavior only
|
|
* of a given interface; other interfaces may support other classes.
|
|
* @bInterfaceSubClass: Subclass of interface; associated with bInterfaceClass.
|
|
* @bInterfaceProtocol: Protocol of interface; associated with bInterfaceClass.
|
|
* @driver_info: Holds information used by the driver. Usually it holds
|
|
* a pointer to a descriptor understood by the driver, or perhaps
|
|
* device flags.
|
|
*
|
|
* In most cases, drivers will create a table of device IDs by using
|
|
* USB_DEVICE(), or similar macros designed for that purpose.
|
|
* They will then export it to userspace using MODULE_DEVICE_TABLE(),
|
|
* and provide it to the USB core through their usb_driver structure.
|
|
*
|
|
* See the usb_match_id() function for information about how matches are
|
|
* performed. Briefly, you will normally use one of several macros to help
|
|
* construct these entries. Each entry you provide will either identify
|
|
* one or more specific products, or will identify a class of products
|
|
* which have agreed to behave the same. You should put the more specific
|
|
* matches towards the beginning of your table, so that driver_info can
|
|
* record quirks of specific products.
|
|
*/
|
|
struct usb_device_id {
|
|
/* which fields to match against? */
|
|
__u16 match_flags;
|
|
|
|
/* Used for product specific matches; range is inclusive */
|
|
__u16 idVendor;
|
|
__u16 idProduct;
|
|
__u16 bcdDevice_lo;
|
|
__u16 bcdDevice_hi;
|
|
|
|
/* Used for device class matches */
|
|
__u8 bDeviceClass;
|
|
__u8 bDeviceSubClass;
|
|
__u8 bDeviceProtocol;
|
|
|
|
/* Used for interface class matches */
|
|
__u8 bInterfaceClass;
|
|
__u8 bInterfaceSubClass;
|
|
__u8 bInterfaceProtocol;
|
|
|
|
void *driver_info;
|
|
};
|
|
|
|
#define USB_DEVICE_ID_MATCH_PRODUCT 0x0002
|
|
#define USB_DEVICE_ID_MATCH_VENDOR 0x0001
|
|
#define USB_DEVICE_ID_MATCH_DEVICE \
|
|
(USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT)
|
|
#define USB_DEVICE_ID_MATCH_INT_CLASS 0x0080
|
|
#define USB_DEVICE_ID_MATCH_INT_SUBCLASS 0x0100
|
|
#define USB_DEVICE_ID_MATCH_INT_PROTOCOL 0x0200
|
|
#define USB_DEVICE_ID_MATCH_INT_INFO \
|
|
(USB_DEVICE_ID_MATCH_INT_CLASS | \
|
|
USB_DEVICE_ID_MATCH_INT_SUBCLASS | \
|
|
USB_DEVICE_ID_MATCH_INT_PROTOCOL)
|
|
|
|
/**
|
|
* USB_DEVICE - macro used to describe a specific usb device
|
|
* @vend: the 16 bit USB Vendor ID
|
|
* @prod: the 16 bit USB Product ID
|
|
*
|
|
* This macro is used to create a struct usb_device_id that matches a
|
|
* specific device.
|
|
*/
|
|
#define USB_DEVICE(vend,prod) \
|
|
.match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
|
|
.idVendor = (vend), \
|
|
.idProduct = (prod)
|
|
|
|
/**
|
|
* USB_INTERFACE_INFO - macro used to describe a class of usb interfaces
|
|
* @cl: bInterfaceClass value
|
|
* @sc: bInterfaceSubClass value
|
|
* @pr: bInterfaceProtocol value
|
|
*
|
|
* This macro is used to create a struct usb_device_id that matches a
|
|
* specific class of interfaces.
|
|
*/
|
|
#define USB_INTERFACE_INFO(cl, sc, pr) \
|
|
.match_flags = USB_DEVICE_ID_MATCH_INT_INFO, \
|
|
.bInterfaceClass = (cl), \
|
|
.bInterfaceSubClass = (sc), \
|
|
.bInterfaceProtocol = (pr)
|
|
|
|
#define USB_CTRL_SET_TIMEOUT 5000
|
|
#define USB_CTRL_GET_TIMEOUT 5000
|
|
|
|
enum usb_dr_mode of_usb_get_dr_mode(struct device_node *np,
|
|
const char *propname);
|
|
|
|
enum usb_dr_mode {
|
|
USB_DR_MODE_UNKNOWN,
|
|
USB_DR_MODE_HOST,
|
|
USB_DR_MODE_PERIPHERAL,
|
|
USB_DR_MODE_OTG,
|
|
};
|
|
|
|
enum usb_phy_interface of_usb_get_phy_mode(struct device_node *np,
|
|
const char *propname);
|
|
|
|
extern struct list_head usb_device_list;
|
|
|
|
#endif /*_USB_H_ */
|