include/usb.h

   1 /*
   2  * (C) Copyright 2001
   3  * Denis Peter, MPL AG Switzerland
   4  *
   5  * See file CREDITS for list of people who contributed to this
   6  * project.
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  21  * MA 02111-1307 USA
  22  *
  23  * Note: Part of this code has been derived from linux
  24  *
  25  */
  26 #ifndef _USB_H_
  27 #define _USB_H_
  28
  29 #include <usb_defs.h>
  30 #include <usbdescriptors.h>
  31
  32 /*
  33  * The EHCI spec says that we must align to at least 32 bytes.  However,
  34  * some platforms require larger alignment.
  35  */
  36 #if ARCH_DMA_MINALIGN > 32
  37 #define USB_DMA_MINALIGN        ARCH_DMA_MINALIGN
  38 #else
  39 #define USB_DMA_MINALIGN        32
  40 #endif
  41
  42 /* Everything is aribtrary */
  43 #define USB_ALTSETTINGALLOC             4
  44 #define USB_MAXALTSETTING               128     /* Hard limit */
  45
  46 #define USB_MAX_DEVICE                  32
  47 #define USB_MAXCONFIG                   8
  48 #define USB_MAXINTERFACES               8
  49 #define USB_MAXENDPOINTS                16
  50 #define USB_MAXCHILDREN                 8       /* This is arbitrary */
  51 #define USB_MAX_HUB                     16
  52
  53 #define USB_CNTL_TIMEOUT 100 /* 100ms timeout */
  54
  55 /*
  56  * This is the timeout to allow for submitting an urb in ms. We allow more
  57  * time for a BULK device to react - some are slow.
  58  */
  59 #define USB_TIMEOUT_MS(pipe) (usb_pipebulk(pipe) ? 5000 : 1000)
  60
  61 /* device request (setup) */
  62 struct devrequest {
  63         unsigned char   requesttype;
  64         unsigned char   request;
  65         unsigned short  value;
  66         unsigned short  index;
  67         unsigned short  length;
  68 } __attribute__ ((packed));
  69
  70 /* All standard descriptors have these 2 fields in common */
  71 struct usb_descriptor_header {
  72         unsigned char   bLength;
  73         unsigned char   bDescriptorType;
  74 } __attribute__ ((packed));
  75
  76 /* Interface */
  77 struct usb_interface {
  78         struct usb_interface_descriptor desc;
  79
  80         unsigned char   no_of_ep;
  81         unsigned char   num_altsetting;
  82         unsigned char   act_altsetting;
  83
  84         struct usb_endpoint_descriptor ep_desc[USB_MAXENDPOINTS];
  85 } __attribute__ ((packed));
  86
  87 /* Configuration information.. */
  88 struct usb_config {
  89         struct usb_configuration_descriptor desc;
  90
  91         unsigned char   no_of_if;       /* number of interfaces */
  92         struct usb_interface if_desc[USB_MAXINTERFACES];
  93 } __attribute__ ((packed));
  94
  95 enum {
  96         /* Maximum packet size; encoded as 0,1,2,3 = 8,16,32,64 */
  97         PACKET_SIZE_8   = 0,
  98         PACKET_SIZE_16  = 1,
  99         PACKET_SIZE_32  = 2,
 100         PACKET_SIZE_64  = 3,
 101 };
 102
 103 struct usb_device {
 104         int     devnum;                 /* Device number on USB bus */
 105         int     speed;                  /* full/low/high */
 106         char    mf[32];                 /* manufacturer */
 107         char    prod[32];               /* product */
 108         char    serial[32];             /* serial number */
 109
 110         /* Maximum packet size; one of: PACKET_SIZE_* */
 111         int maxpacketsize;
 112         /* one bit for each endpoint ([0] = IN, [1] = OUT) */
 113         unsigned int toggle[2];
 114         /* endpoint halts; one bit per endpoint # & direction;
 115          * [0] = IN, [1] = OUT
 116          */
 117         unsigned int halted[2];
 118         int epmaxpacketin[16];          /* INput endpoint specific maximums */
 119         int epmaxpacketout[16];         /* OUTput endpoint specific maximums */
 120
 121         int configno;                   /* selected config number */
 122         /* Device Descriptor */
 123         struct usb_device_descriptor descriptor
 124                 __attribute__((aligned(ARCH_DMA_MINALIGN)));
 125         struct usb_config config; /* config descriptor */
 126
 127         int have_langid;                /* whether string_langid is valid yet */
 128         int string_langid;              /* language ID for strings */
 129         int (*irq_handle)(struct usb_device *dev);
 130         unsigned long irq_status;
 131         int irq_act_len;                /* transfered bytes */
 132         void *privptr;
 133         /*
 134          * Child devices -  if this is a hub device
 135          * Each instance needs its own set of data structures.
 136          */
 137         unsigned long status;
 138         int act_len;                    /* transfered bytes */
 139         int maxchild;                   /* Number of ports if hub */
 140         int portnr;
 141         struct usb_device *parent;
 142         struct usb_device *children[USB_MAXCHILDREN];
 143 };
 144
 145 /**********************************************************************
 146  * this is how the lowlevel part communicate with the outer world
 147  */
 148
 149 #if defined(CONFIG_USB_UHCI) || defined(CONFIG_USB_OHCI) || \
 150         defined(CONFIG_USB_EHCI) || defined(CONFIG_USB_OHCI_NEW) || \
 151         defined(CONFIG_USB_SL811HS) || defined(CONFIG_USB_ISP116X_HCD) || \
 152         defined(CONFIG_USB_R8A66597_HCD) || defined(CONFIG_USB_DAVINCI) || \
 153         defined(CONFIG_USB_OMAP3) || defined(CONFIG_USB_DA8XX) || \
 154         defined(CONFIG_USB_BLACKFIN) || defined(CONFIG_USB_AM35X)
 155
 156 int usb_lowlevel_init(void);
 157 int usb_lowlevel_stop(void);
 158 int submit_bulk_msg(struct usb_device *dev, unsigned long pipe,
 159                         void *buffer, int transfer_len);
 160 int submit_control_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
 161                         int transfer_len, struct devrequest *setup);
 162 int submit_int_msg(struct usb_device *dev, unsigned long pipe, void *buffer,
 163                         int transfer_len, int interval);
 164
 165 /* Defines */
 166 #define USB_UHCI_VEND_ID        0x8086
 167 #define USB_UHCI_DEV_ID         0x7112
 168
 169 #else
 170 #error USB Lowlevel not defined
 171 #endif
 172
 173 #ifdef CONFIG_USB_STORAGE
 174
 175 #define USB_MAX_STOR_DEV 5
 176 block_dev_desc_t *usb_stor_get_dev(int index);
 177 int usb_stor_scan(int mode);
 178 int usb_stor_info(void);
 179
 180 #endif
 181
 182 #ifdef CONFIG_USB_HOST_ETHER
 183
 184 #define USB_MAX_ETH_DEV 5
 185 int usb_host_eth_scan(int mode);
 186
 187 #endif
 188
 189 #ifdef CONFIG_USB_KEYBOARD
 190
 191 int drv_usb_kbd_init(void);
 192 int usb_kbd_deregister(void);
 193
 194 #endif
 195 /* routines */
 196 int usb_init(void); /* initialize the USB Controller */
 197 int usb_stop(void); /* stop the USB Controller */
 198
 199
 200 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol);
 201 int usb_set_idle(struct usb_device *dev, int ifnum, int duration,
 202                         int report_id);
 203 struct usb_device *usb_get_dev_index(int index);
 204 int usb_control_msg(struct usb_device *dev, unsigned int pipe,
 205                         unsigned char request, unsigned char requesttype,
 206                         unsigned short value, unsigned short index,
 207                         void *data, unsigned short size, int timeout);
 208 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
 209                         void *data, int len, int *actual_length, int timeout);
 210 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
 211                         void *buffer, int transfer_len, int interval);
 212 int usb_disable_asynch(int disable);
 213 int usb_maxpacket(struct usb_device *dev, unsigned long pipe);
 214 int usb_get_configuration_no(struct usb_device *dev, unsigned char *buffer,
 215                                 int cfgno);
 216 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type,
 217                         unsigned char id, void *buf, int size);
 218 int usb_get_class_descriptor(struct usb_device *dev, int ifnum,
 219                         unsigned char type, unsigned char id, void *buf,
 220                         int size);
 221 int usb_clear_halt(struct usb_device *dev, int pipe);
 222 int usb_string(struct usb_device *dev, int index, char *buf, size_t size);
 223 int usb_set_interface(struct usb_device *dev, int interface, int alternate);
 224
 225 /* big endian -> little endian conversion */
 226 /* some CPUs are already little endian e.g. the ARM920T */
 227 #define __swap_16(x) \
 228         ({ unsigned short x_ = (unsigned short)x; \
 229          (unsigned short)( \
 230                 ((x_ & 0x00FFU) << 8) | ((x_ & 0xFF00U) >> 8)); \
 231         })
 232 #define __swap_32(x) \
 233         ({ unsigned long x_ = (unsigned long)x; \
 234          (unsigned long)( \
 235                 ((x_ & 0x000000FFUL) << 24) | \
 236                 ((x_ & 0x0000FF00UL) <<  8) | \
 237                 ((x_ & 0x00FF0000UL) >>  8) | \
 238                 ((x_ & 0xFF000000UL) >> 24)); \
 239         })
 240
 241 #ifdef __LITTLE_ENDIAN
 242 # define swap_16(x) (x)
 243 # define swap_32(x) (x)
 244 #else
 245 # define swap_16(x) __swap_16(x)
 246 # define swap_32(x) __swap_32(x)
 247 #endif
 248
 249 /*
 250  * Calling this entity a "pipe" is glorifying it. A USB pipe
 251  * is something embarrassingly simple: it basically consists
 252  * of the following information:
 253  *  - device number (7 bits)
 254  *  - endpoint number (4 bits)
 255  *  - current Data0/1 state (1 bit)
 256  *  - direction (1 bit)
 257  *  - speed (2 bits)
 258  *  - max packet size (2 bits: 8, 16, 32 or 64)
 259  *  - pipe type (2 bits: control, interrupt, bulk, isochronous)
 260  *
 261  * That's 18 bits. Really. Nothing more. And the USB people have
 262  * documented these eighteen bits as some kind of glorious
 263  * virtual data structure.
 264  *
 265  * Let's not fall in that trap. We'll just encode it as a simple
 266  * unsigned int. The encoding is:
 267  *
 268  *  - max size:         bits 0-1        (00 = 8, 01 = 16, 10 = 32, 11 = 64)
 269  *  - direction:        bit 7           (0 = Host-to-Device [Out],
 270  *                                      (1 = Device-to-Host [In])
 271  *  - device:           bits 8-14
 272  *  - endpoint:         bits 15-18
 273  *  - Data0/1:          bit 19
 274  *  - speed:            bit 26          (0 = Full, 1 = Low Speed, 2 = High)
 275  *  - pipe type:        bits 30-31      (00 = isochronous, 01 = interrupt,
 276  *                                       10 = control, 11 = bulk)
 277  *
 278  * Why? Because it's arbitrary, and whatever encoding we select is really
 279  * up to us. This one happens to share a lot of bit positions with the UHCI
 280  * specification, so that much of the uhci driver can just mask the bits
 281  * appropriately.
 282  */
 283 /* Create various pipes... */
 284 #define create_pipe(dev,endpoint) \
 285                 (((dev)->devnum << 8) | ((endpoint) << 15) | \
 286                 ((dev)->speed << 26) | (dev)->maxpacketsize)
 287 #define default_pipe(dev) ((dev)->speed << 26)
 288
 289 #define usb_sndctrlpipe(dev, endpoint)  ((PIPE_CONTROL << 30) | \
 290                                          create_pipe(dev, endpoint))
 291 #define usb_rcvctrlpipe(dev, endpoint)  ((PIPE_CONTROL << 30) | \
 292                                          create_pipe(dev, endpoint) | \
 293                                          USB_DIR_IN)
 294 #define usb_sndisocpipe(dev, endpoint)  ((PIPE_ISOCHRONOUS << 30) | \
 295                                          create_pipe(dev, endpoint))
 296 #define usb_rcvisocpipe(dev, endpoint)  ((PIPE_ISOCHRONOUS << 30) | \
 297                                          create_pipe(dev, endpoint) | \
 298                                          USB_DIR_IN)
 299 #define usb_sndbulkpipe(dev, endpoint)  ((PIPE_BULK << 30) | \
 300                                          create_pipe(dev, endpoint))
 301 #define usb_rcvbulkpipe(dev, endpoint)  ((PIPE_BULK << 30) | \
 302                                          create_pipe(dev, endpoint) | \
 303                                          USB_DIR_IN)
 304 #define usb_sndintpipe(dev, endpoint)   ((PIPE_INTERRUPT << 30) | \
 305                                          create_pipe(dev, endpoint))
 306 #define usb_rcvintpipe(dev, endpoint)   ((PIPE_INTERRUPT << 30) | \
 307                                          create_pipe(dev, endpoint) | \
 308                                          USB_DIR_IN)
 309 #define usb_snddefctrl(dev)             ((PIPE_CONTROL << 30) | \
 310                                          default_pipe(dev))
 311 #define usb_rcvdefctrl(dev)             ((PIPE_CONTROL << 30) | \
 312                                          default_pipe(dev) | \
 313                                          USB_DIR_IN)
 314
 315 /* The D0/D1 toggle bits */
 316 #define usb_gettoggle(dev, ep, out) (((dev)->toggle[out] >> ep) & 1)
 317 #define usb_dotoggle(dev, ep, out)  ((dev)->toggle[out] ^= (1 << ep))
 318 #define usb_settoggle(dev, ep, out, bit) ((dev)->toggle[out] = \
 319                                                 ((dev)->toggle[out] & \
 320                                                  ~(1 << ep)) | ((bit) << ep))
 321
 322 /* Endpoint halt control/status */
 323 #define usb_endpoint_out(ep_dir)        (((ep_dir >> 7) & 1) ^ 1)
 324 #define usb_endpoint_halt(dev, ep, out) ((dev)->halted[out] |= (1 << (ep)))
 325 #define usb_endpoint_running(dev, ep, out) ((dev)->halted[out] &= ~(1 << (ep)))
 326 #define usb_endpoint_halted(dev, ep, out) ((dev)->halted[out] & (1 << (ep)))
 327
 328 #define usb_packetid(pipe)      (((pipe) & USB_DIR_IN) ? USB_PID_IN : \
 329                                  USB_PID_OUT)
 330
 331 #define usb_pipeout(pipe)       ((((pipe) >> 7) & 1) ^ 1)
 332 #define usb_pipein(pipe)        (((pipe) >> 7) & 1)
 333 #define usb_pipedevice(pipe)    (((pipe) >> 8) & 0x7f)
 334 #define usb_pipe_endpdev(pipe)  (((pipe) >> 8) & 0x7ff)
 335 #define usb_pipeendpoint(pipe)  (((pipe) >> 15) & 0xf)
 336 #define usb_pipedata(pipe)      (((pipe) >> 19) & 1)
 337 #define usb_pipespeed(pipe)     (((pipe) >> 26) & 3)
 338 #define usb_pipeslow(pipe)      (usb_pipespeed(pipe) == USB_SPEED_LOW)
 339 #define usb_pipetype(pipe)      (((pipe) >> 30) & 3)
 340 #define usb_pipeisoc(pipe)      (usb_pipetype((pipe)) == PIPE_ISOCHRONOUS)
 341 #define usb_pipeint(pipe)       (usb_pipetype((pipe)) == PIPE_INTERRUPT)
 342 #define usb_pipecontrol(pipe)   (usb_pipetype((pipe)) == PIPE_CONTROL)
 343 #define usb_pipebulk(pipe)      (usb_pipetype((pipe)) == PIPE_BULK)
 344
 345
 346 /*************************************************************************
 347  * Hub Stuff
 348  */
 349 struct usb_port_status {
 350         unsigned short wPortStatus;
 351         unsigned short wPortChange;
 352 } __attribute__ ((packed));
 353
 354 struct usb_hub_status {
 355         unsigned short wHubStatus;
 356         unsigned short wHubChange;
 357 } __attribute__ ((packed));
 358
 359
 360 /* Hub descriptor */
 361 struct usb_hub_descriptor {
 362         unsigned char  bLength;
 363         unsigned char  bDescriptorType;
 364         unsigned char  bNbrPorts;
 365         unsigned short wHubCharacteristics;
 366         unsigned char  bPwrOn2PwrGood;
 367         unsigned char  bHubContrCurrent;
 368         unsigned char  DeviceRemovable[(USB_MAXCHILDREN+1+7)/8];
 369         unsigned char  PortPowerCtrlMask[(USB_MAXCHILDREN+1+7)/8];
 370         /* DeviceRemovable and PortPwrCtrlMask want to be variable-length
 371            bitmaps that hold max 255 entries. (bit0 is ignored) */
 372 } __attribute__ ((packed));
 373
 374
 375 struct usb_hub_device {
 376         struct usb_device *pusb_dev;
 377         struct usb_hub_descriptor desc;
 378 };
 379
 380 int usb_hub_probe(struct usb_device *dev, int ifnum);
 381 void usb_hub_reset(void);
 382 int hub_port_reset(struct usb_device *dev, int port,
 383                           unsigned short *portstat);
 384
 385 struct usb_device *usb_alloc_new_device(void);
 386 int usb_new_device(struct usb_device *dev);
 387
 388 #endif /*_USB_H_ */