beta Encoder / USBDevice

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of USBDevice by mbed official

USBDevice/USBDevice_Types.h@1:80ab0d068708, 2012-07-17 (annotated)

Committer:
samux
Date:
Tue Jul 17 14:30:29 2012 +0000
Revision:
1:80ab0d068708
Child:
17:bbd6dac92961
Update USBDevice lib

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samux 1:80ab0d068708 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
samux 1:80ab0d068708 2 *
samux 1:80ab0d068708 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
samux 1:80ab0d068708 4 * and associated documentation files (the "Software"), to deal in the Software without
samux 1:80ab0d068708 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
samux 1:80ab0d068708 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
samux 1:80ab0d068708 7 * Software is furnished to do so, subject to the following conditions:
samux 1:80ab0d068708 8 *
samux 1:80ab0d068708 9 * The above copyright notice and this permission notice shall be included in all copies or
samux 1:80ab0d068708 10 * substantial portions of the Software.
samux 1:80ab0d068708 11 *
samux 1:80ab0d068708 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
samux 1:80ab0d068708 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
samux 1:80ab0d068708 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
samux 1:80ab0d068708 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
samux 1:80ab0d068708 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
samux 1:80ab0d068708 17 */
samux 1:80ab0d068708 18
samux 1:80ab0d068708 19 #ifndef USBDEVICE_TYPES_H
samux 1:80ab0d068708 20 #define USBDEVICE_TYPES_H
samux 1:80ab0d068708 21
samux 1:80ab0d068708 22 /* Standard requests */
samux 1:80ab0d068708 23 #define GET_STATUS (0)
samux 1:80ab0d068708 24 #define CLEAR_FEATURE (1)
samux 1:80ab0d068708 25 #define SET_FEATURE (3)
samux 1:80ab0d068708 26 #define SET_ADDRESS (5)
samux 1:80ab0d068708 27 #define GET_DESCRIPTOR (6)
samux 1:80ab0d068708 28 #define SET_DESCRIPTOR (7)
samux 1:80ab0d068708 29 #define GET_CONFIGURATION (8)
samux 1:80ab0d068708 30 #define SET_CONFIGURATION (9)
samux 1:80ab0d068708 31 #define GET_INTERFACE (10)
samux 1:80ab0d068708 32 #define SET_INTERFACE (11)
samux 1:80ab0d068708 33
samux 1:80ab0d068708 34 /* bmRequestType.dataTransferDirection */
samux 1:80ab0d068708 35 #define HOST_TO_DEVICE (0)
samux 1:80ab0d068708 36 #define DEVICE_TO_HOST (1)
samux 1:80ab0d068708 37
samux 1:80ab0d068708 38 /* bmRequestType.Type*/
samux 1:80ab0d068708 39 #define STANDARD_TYPE (0)
samux 1:80ab0d068708 40 #define CLASS_TYPE (1)
samux 1:80ab0d068708 41 #define VENDOR_TYPE (2)
samux 1:80ab0d068708 42 #define RESERVED_TYPE (3)
samux 1:80ab0d068708 43
samux 1:80ab0d068708 44 /* bmRequestType.Recipient */
samux 1:80ab0d068708 45 #define DEVICE_RECIPIENT (0)
samux 1:80ab0d068708 46 #define INTERFACE_RECIPIENT (1)
samux 1:80ab0d068708 47 #define ENDPOINT_RECIPIENT (2)
samux 1:80ab0d068708 48 #define OTHER_RECIPIENT (3)
samux 1:80ab0d068708 49
samux 1:80ab0d068708 50 /* Descriptors */
samux 1:80ab0d068708 51 #define DESCRIPTOR_TYPE(wValue) (wValue >> 8)
samux 1:80ab0d068708 52 #define DESCRIPTOR_INDEX(wValue) (wValue & 0xf)
samux 1:80ab0d068708 53
samux 1:80ab0d068708 54 typedef struct {
samux 1:80ab0d068708 55 struct {
samux 1:80ab0d068708 56 uint8_t dataTransferDirection;
samux 1:80ab0d068708 57 uint8_t Type;
samux 1:80ab0d068708 58 uint8_t Recipient;
samux 1:80ab0d068708 59 } bmRequestType;
samux 1:80ab0d068708 60 uint8_t bRequest;
samux 1:80ab0d068708 61 uint16_t wValue;
samux 1:80ab0d068708 62 uint16_t wIndex;
samux 1:80ab0d068708 63 uint16_t wLength;
samux 1:80ab0d068708 64 } SETUP_PACKET;
samux 1:80ab0d068708 65
samux 1:80ab0d068708 66 typedef struct {
samux 1:80ab0d068708 67 SETUP_PACKET setup;
samux 1:80ab0d068708 68 uint8_t *ptr;
samux 1:80ab0d068708 69 uint32_t remaining;
samux 1:80ab0d068708 70 uint8_t direction;
samux 1:80ab0d068708 71 bool zlp;
samux 1:80ab0d068708 72 bool notify;
samux 1:80ab0d068708 73 } CONTROL_TRANSFER;
samux 1:80ab0d068708 74
samux 1:80ab0d068708 75 typedef enum {ATTACHED, POWERED, DEFAULT, ADDRESS, CONFIGURED} DEVICE_STATE;
samux 1:80ab0d068708 76
samux 1:80ab0d068708 77 typedef struct {
samux 1:80ab0d068708 78 volatile DEVICE_STATE state;
samux 1:80ab0d068708 79 uint8_t configuration;
samux 1:80ab0d068708 80 bool suspended;
samux 1:80ab0d068708 81 } USB_DEVICE;
samux 1:80ab0d068708 82
samux 1:80ab0d068708 83 #endif