Annotation of qemu/hw/usb.h, revision 1.1.1.4

1.1       root        1: /*
                      2:  * QEMU USB API
                      3:  * 
                      4:  * Copyright (c) 2005 Fabrice Bellard
                      5:  * 
                      6:  * Permission is hereby granted, free of charge, to any person obtaining a copy
                      7:  * of this software and associated documentation files (the "Software"), to deal
                      8:  * in the Software without restriction, including without limitation the rights
                      9:  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
                     10:  * copies of the Software, and to permit persons to whom the Software is
                     11:  * furnished to do so, subject to the following conditions:
                     12:  *
                     13:  * The above copyright notice and this permission notice shall be included in
                     14:  * all copies or substantial portions of the Software.
                     15:  *
                     16:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
                     17:  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
                     18:  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
                     19:  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
                     20:  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
                     21:  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
                     22:  * THE SOFTWARE.
                     23:  */
                     24: #define USB_TOKEN_SETUP 0x2d
                     25: #define USB_TOKEN_IN    0x69 /* device -> host */
                     26: #define USB_TOKEN_OUT   0xe1 /* host -> device */
                     27: 
                     28: /* specific usb messages, also sent in the 'pid' parameter */
                     29: #define USB_MSG_ATTACH   0x100
                     30: #define USB_MSG_DETACH   0x101
                     31: #define USB_MSG_RESET    0x102
                     32: 
                     33: #define USB_RET_NODEV  (-1) 
                     34: #define USB_RET_NAK    (-2)
                     35: #define USB_RET_STALL  (-3)
                     36: #define USB_RET_BABBLE (-4)
1.1.1.4 ! root       37: #define USB_RET_ASYNC  (-5)
1.1       root       38: 
                     39: #define USB_SPEED_LOW   0
                     40: #define USB_SPEED_FULL  1
                     41: #define USB_SPEED_HIGH  2
                     42: 
                     43: #define USB_STATE_NOTATTACHED 0
                     44: #define USB_STATE_ATTACHED    1
                     45: //#define USB_STATE_POWERED     2
                     46: #define USB_STATE_DEFAULT     3
                     47: //#define USB_STATE_ADDRESS     4
                     48: //#define      USB_STATE_CONFIGURED  5
                     49: #define USB_STATE_SUSPENDED   6
                     50: 
                     51: #define USB_CLASS_AUDIO                        1
                     52: #define USB_CLASS_COMM                 2
                     53: #define USB_CLASS_HID                  3
                     54: #define USB_CLASS_PHYSICAL             5
                     55: #define USB_CLASS_STILL_IMAGE          6
                     56: #define USB_CLASS_PRINTER              7
                     57: #define USB_CLASS_MASS_STORAGE         8
                     58: #define USB_CLASS_HUB                  9
                     59: #define USB_CLASS_CDC_DATA             0x0a
                     60: #define USB_CLASS_CSCID                        0x0b
                     61: #define USB_CLASS_CONTENT_SEC          0x0d
                     62: #define USB_CLASS_APP_SPEC             0xfe
                     63: #define USB_CLASS_VENDOR_SPEC          0xff
                     64: 
                     65: #define USB_DIR_OUT                    0
                     66: #define USB_DIR_IN                     0x80
                     67: 
                     68: #define USB_TYPE_MASK                  (0x03 << 5)
                     69: #define USB_TYPE_STANDARD              (0x00 << 5)
                     70: #define USB_TYPE_CLASS                 (0x01 << 5)
                     71: #define USB_TYPE_VENDOR                        (0x02 << 5)
                     72: #define USB_TYPE_RESERVED              (0x03 << 5)
                     73: 
                     74: #define USB_RECIP_MASK                 0x1f
                     75: #define USB_RECIP_DEVICE               0x00
                     76: #define USB_RECIP_INTERFACE            0x01
                     77: #define USB_RECIP_ENDPOINT             0x02
                     78: #define USB_RECIP_OTHER                        0x03
                     79: 
                     80: #define DeviceRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
                     81: #define DeviceOutRequest ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_DEVICE)<<8)
                     82: #define InterfaceRequest \
                     83:         ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
                     84: #define InterfaceOutRequest \
                     85:         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_INTERFACE)<<8)
                     86: #define EndpointRequest ((USB_DIR_IN|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
                     87: #define EndpointOutRequest \
                     88:         ((USB_DIR_OUT|USB_TYPE_STANDARD|USB_RECIP_ENDPOINT)<<8)
                     89: 
                     90: #define USB_REQ_GET_STATUS             0x00
                     91: #define USB_REQ_CLEAR_FEATURE          0x01
                     92: #define USB_REQ_SET_FEATURE            0x03
                     93: #define USB_REQ_SET_ADDRESS            0x05
                     94: #define USB_REQ_GET_DESCRIPTOR         0x06
                     95: #define USB_REQ_SET_DESCRIPTOR         0x07
                     96: #define USB_REQ_GET_CONFIGURATION      0x08
                     97: #define USB_REQ_SET_CONFIGURATION      0x09
                     98: #define USB_REQ_GET_INTERFACE          0x0A
                     99: #define USB_REQ_SET_INTERFACE          0x0B
                    100: #define USB_REQ_SYNCH_FRAME            0x0C
                    101: 
                    102: #define USB_DEVICE_SELF_POWERED                0
                    103: #define USB_DEVICE_REMOTE_WAKEUP       1
                    104: 
                    105: #define USB_DT_DEVICE                  0x01
                    106: #define USB_DT_CONFIG                  0x02
                    107: #define USB_DT_STRING                  0x03
                    108: #define USB_DT_INTERFACE               0x04
                    109: #define USB_DT_ENDPOINT                        0x05
                    110: 
                    111: typedef struct USBPort USBPort;
                    112: typedef struct USBDevice USBDevice;
1.1.1.4 ! root      113: typedef struct USBPacket USBPacket;
1.1       root      114: 
                    115: /* definition of a USB device */
                    116: struct USBDevice {
                    117:     void *opaque;
1.1.1.4 ! root      118:     int (*handle_packet)(USBDevice *dev, USBPacket *p);
1.1.1.3   root      119:     void (*handle_destroy)(USBDevice *dev);
                    120: 
1.1       root      121:     int speed;
                    122:     
                    123:     /* The following fields are used by the generic USB device
                    124:        layer. They are here just to avoid creating a new structure for
                    125:        them. */
                    126:     void (*handle_reset)(USBDevice *dev);
                    127:     int (*handle_control)(USBDevice *dev, int request, int value,
                    128:                           int index, int length, uint8_t *data);
1.1.1.4 ! root      129:     int (*handle_data)(USBDevice *dev, USBPacket *p);
1.1       root      130:     uint8_t addr;
1.1.1.3   root      131:     char devname[32];
1.1       root      132:     
                    133:     int state;
                    134:     uint8_t setup_buf[8];
                    135:     uint8_t data_buf[1024];
                    136:     int remote_wakeup;
                    137:     int setup_state;
                    138:     int setup_len;
                    139:     int setup_index;
                    140: };
                    141: 
1.1.1.3   root      142: typedef void (*usb_attachfn)(USBPort *port, USBDevice *dev);
                    143: 
1.1       root      144: /* USB port on which a device can be connected */
                    145: struct USBPort {
                    146:     USBDevice *dev;
1.1.1.3   root      147:     usb_attachfn attach;
1.1       root      148:     void *opaque;
                    149:     int index; /* internal port index, may be used with the opaque */
1.1.1.3   root      150:     struct USBPort *next; /* Used internally by qemu.  */
1.1       root      151: };
                    152: 
1.1.1.4 ! root      153: typedef void USBCallback(USBPacket * packet, void *opaque);
        !           154: 
        !           155: /* Structure used to hold information about an active USB packet.  */
        !           156: struct USBPacket {
        !           157:     /* Data fields for use by the driver.  */
        !           158:     int pid;
        !           159:     uint8_t devaddr;
        !           160:     uint8_t devep;
        !           161:     uint8_t *data;
        !           162:     int len;
        !           163:     /* Internal use by the USB layer.  */
        !           164:     USBCallback *complete_cb;
        !           165:     void *complete_opaque;
        !           166:     USBCallback *cancel_cb;
        !           167:     void * *cancel_opaque;
        !           168: };
        !           169: 
        !           170: /* Defer completion of a USB packet.  The hadle_packet routine should then
        !           171:    return USB_RET_ASYNC.  Packets that complete immediately (before
        !           172:    handle_packet returns) should not call this method.  */
        !           173: static inline void usb_defer_packet(USBPacket *p, USBCallback *cancel,
        !           174:                                     void * opaque)
        !           175: {
        !           176:     p->cancel_cb = cancel;
        !           177:     p->cancel_opaque = opaque;
        !           178: }
        !           179: 
        !           180: /* Notify the controller that an async packet is complete.  This should only
        !           181:    be called for packets previously deferred with usb_defer_packet, and
        !           182:    should never be called from within handle_packet.  */
        !           183: static inline void usb_packet_complete(USBPacket *p)
        !           184: {
        !           185:     p->complete_cb(p, p->complete_opaque);
        !           186: }
        !           187: 
        !           188: /* Cancel an active packet.  The packed must have been deferred with
        !           189:    usb_defer_packet,  and not yet completed.  */
        !           190: static inline void usb_cancel_packet(USBPacket * p)
        !           191: {
        !           192:     p->cancel_cb(p, p->cancel_opaque);
        !           193: }
        !           194: 
1.1       root      195: void usb_attach(USBPort *port, USBDevice *dev);
1.1.1.4 ! root      196: int usb_generic_handle_packet(USBDevice *s, USBPacket *p);
1.1       root      197: int set_usb_string(uint8_t *buf, const char *str);
1.1.1.4 ! root      198: void usb_send_msg(USBDevice *dev, int msg);
        !           199: 
        !           200: void usb_packet_complete(USBPacket *p);
1.1       root      201: 
                    202: /* usb hub */
1.1.1.3   root      203: USBDevice *usb_hub_init(int nb_ports);
1.1       root      204: 
                    205: /* usb-uhci.c */
1.1.1.3   root      206: void usb_uhci_init(PCIBus *bus, int devfn);
                    207: 
                    208: /* usb-ohci.c */
                    209: void usb_ohci_init(struct PCIBus *bus, int num_ports, int devfn);
1.1       root      210: 
                    211: /* usb-linux.c */
                    212: USBDevice *usb_host_device_open(const char *devname);
                    213: void usb_host_info(void);
                    214: 
                    215: /* usb-hid.c */
                    216: USBDevice *usb_mouse_init(void);
1.1.1.2   root      217: USBDevice *usb_tablet_init(void);
1.1.1.3   root      218: 
                    219: /* usb-msd.c */
                    220: USBDevice *usb_msd_init(const char *filename);

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.