xmos-ai-tools 1.3.2.dev80__py3-none-macosx_10_15_universal2.whl

xmos_ai_tools/runtime/include/lib_xud/lib_xud/api/xud_std_descriptors.h

@@ -0,0 +1,191 @@
+// Copyright 2015-2022 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+
+#ifndef _USB_DESCRIPTORS_H_
+#define _USB_DESCRIPTORS_H_
+
+#if !defined (__ASSEMBLER__)
+/* USB Class Codes (from usb.org) */
+typedef enum
+{
+    USB_CLASS_USE_CLASS                 = 0x00,  /* Use class information in the interface descriptors */
+    USB_CLASS_AUDIO                     = 0x01,
+    USB_CLASS_COMMUNICATIONS            = 0x02,
+    USB_CLASS_HID                       = 0x03,
+    USB_CLASS_PHYSICAL                  = 0x05,
+    USB_CLASS_IMAGE                     = 0x06,
+    USB_CLASS_PRINTER                   = 0x07,
+    USB_CLASS_MASS_STORAGE              = 0x08,
+    USB_CLASS_HUB                       = 0x09,
+    USB_CLASS_CDC_DATA                  = 0x0A,
+    USB_CLASS_SMART_CARD                = 0x0B,
+    USB_CLASS_RESERVED                  = 0x0C,
+    USB_CLASS_CONTENT_SECURITY          = 0x0D,
+    USB_CLASS_VIDEO                     = 0x0E,
+    USB_CLASS_PERSONAL_HEALTHCARE       = 0x0F,
+    USB_CLASS_AUDIO_VIDEO               = 0x10,
+//...
+    USB_CLASS_MAPPED_INDEX_END          = 17,
+    USB_CLASS_VENDOR_SPECIFIC           = 0xFF
+} USB_ClassCode_t;
+
+#endif
+
+/* USB Standard Descriptor types (Section 9.4, table 9-5) */
+enum USB_DescriptorTypes_t
+{
+    USB_DESCTYPE_DEVICE                 = 0x01, /* Device descriptor */
+    USB_DESCTYPE_CONFIGURATION          = 0x02, /* Configuration descriptor */
+    USB_DESCTYPE_STRING                 = 0x03, /* String descriptor */
+    USB_DESCTYPE_INTERFACE              = 0x04, /* Interface descriptor */
+    USB_DESCTYPE_ENDPOINT               = 0x05, /* Endpoint descriptor */
+    USB_DESCTYPE_DEVICE_QUALIFIER       = 0x06, /* Device qualifier descriptor */
+    USB_DESCTYPE_OTHER_SPEED            = 0x07,
+    USB_DESCTYPE_INTERFACE_POWER        = 0x08, /* Interface power descriptor */
+    USB_DESCTYPE_OTG                    = 0x09,
+    USB_DESCTYPE_DEBUG                  = 0x0A,
+    USB_DESCTYPE_INTERFACE_ASSOCIATION  = 0x0B, /* Interface association descriptor */
+};
+
+#ifdef __STDC__
+
+/* No current support for __attribute((packed)) in XC */
+
+/* Generic USB Descriptor Header */
+typedef struct
+{
+    unsigned char bLength;              /* Size of the descriptor (bytes) */
+    unsigned char bDescriptorType;      /* Descriptor type, either a value. See \ref USB_DescriptorTypes_t or
+                                         * a value given by the specific class */
+} __attribute__((packed)) USB_Descriptor_Header_t;
+
+/* USB Standard Device Descriptor (section 9.6.1, table 9-8) */
+typedef struct
+{
+    unsigned char bLength;              /* Size of the descriptor (bytes) */
+    unsigned char bDescriptorType;      /* Descriptor type, either a value in \ref USB_DescriptorTypes_t
+                                         * or a value given by the specific class */
+    unsigned short bcdUSB;              /* Supported USB version */
+    unsigned char  bDeviceClass;        /* USB device class code */
+    unsigned char  bDeviceSubClass;     /* USB device subclass code */
+    unsigned char  bDeviceProtocol;     /* USB device protocol code */
+    unsigned char  bMaxPacketSize0;     /* Maximum packet size for endpoint 0 (bytes) */
+    unsigned short idVendor;            /* Vendor ID */
+    unsigned short idProduct;           /* Product ID */
+    unsigned short bcdDevice;           /* Device release number in binary-coded decimal */
+    unsigned char  iManufacturer;       /* Index of string descriptor describing manufacturer */
+    unsigned char  iProduct;            /* Index of string descriptor describing product */
+    unsigned char  iSerialNumber;       /* Index of String descriptor describing the devices serial number */
+    unsigned char  bNumConfigurations;  /* Total number of configurations supported by the device */
+} __attribute__((packed)) USB_Descriptor_Device_t;
+
+/* USB Interface Association Descriptor (See IAD Engineering Change Notice) */
+typedef struct
+{
+    unsigned char bLength;              /* Size of the descriptor (bytes) */
+    unsigned char bDescriptorType;      /* Descriptor type, either a value in \ref USB_DescriptorTypes_t
+                                          or a value given by the specific class */
+    unsigned char bFirstInterface;      /* Index of the first associated interface */
+    unsigned char bInterfaceCount;      /* Total number of associated interfaces */
+    unsigned char bFunctionClass;       /* Interface class ID */
+    unsigned char bFunctionSubClass;    /* Interface subclass ID */
+    unsigned char bFunctionProtocol;    /* Interface protocol ID */
+    unsigned char iFunction;            /* Index of the string descriptor describing the
+                                         * interface association */
+} __attribute__((packed)) USB_Descriptor_Interface_Association_t;
+
+/* USB Standard Interface Descriptor (section 9.6.1 table 9-12) */
+typedef struct
+{
+    unsigned char bLength;             /* Size of the descriptor (bytes) */
+    unsigned char bDescriptorType;     /* Type of the descriptor, either a value in \ref USB_DescriptorTypes_t
+                                        * or a value given by the specific class */
+    unsigned char bInterfaceNumber;    /* Index of the interface in the current config */
+	unsigned char bAlternateSetting;   /* Alternate setting for this interface number. Multiple alternatives
+                                        * are supported per interface (with different EP configs) */
+    unsigned char bNumEndpoints;       /* Total endpoint count in this interface */
+    unsigned char bInterfaceClass;     /* Interface class code */
+
+    unsigned char bInterfaceSubClass;  /* Interface subclass code */
+    unsigned char bInterfaceProtocol;  /* Interface protocol code */
+    unsigned char iInterface;          /* Index of the string descriptor in the string table */
+} __attribute__((packed)) USB_Descriptor_Interface_t;
+
+/* USB Standard Configuration Descriptor (section 9.6.1 table 9-10) */
+typedef struct
+{
+    unsigned char  bLength;             /* Size of the descriptor (bytes) */
+    unsigned char  bDescriptorType;     /* Type of the descriptor, either a value in \ref USB_DescriptorTypes_t or a value
+                                         * given by the specific class */
+    unsigned short wTotalLength;        /* Size of the configuration descriptor header and all sub descriptors inside
+                                         * the configuration */
+    unsigned char  bNumInterfaces;      /* Total interface count in the configuration */
+    unsigned char  bConfigurationValue; /* Value to use as an argument to the SetConfiguration() request to select this
+                                         * configuration */
+    unsigned char  iConfiguration;      /* Index of string descriptor describing this configuration */
+    unsigned char  bmAttributes;        /* Configuration characteristics
+                                         * D7: Reserved (set to one)
+                                         * D6: Self-powered
+                                         * D5: Remote Wakeup
+                                         * D4...0: Reserved (reset to zero)
+                                        */
+    unsigned char  bMaxPower;           /* Maximum power consumption of the USB device from the bus in this specific
+                                         * configuration when the device is fully operational. Expressed in 2 mA units
+                                         * (i.e., 50 = 100 mA) */
+} __attribute__((packed)) USB_Descriptor_Configuration_Header_t;
+
+/* USB Standard Endpoint Descriptor (section 9.6.1 table 9-13) */
+typedef struct
+{
+    unsigned char bLength;             /* Size of the descriptor (bytes) */
+    unsigned char bDescriptorType;     /* Descriptor type, either a value. See \ref USB_DescriptorTypes_t or
+                                        * a value given by the specific class */
+    unsigned char  bEndpointAddress;   /* Address of the endpoint, includes a direction mask */
+    unsigned char  bmAttributes;       /* Endpoint attributes, comprised of a mask of the endpoint type
+                                        * See EP_TYPE_ ad EP_ADDR) */
+    unsigned short wMaxPacketSize;     /* Maximum packet size (bytes) that the endpoint can receive */
+    unsigned char  bInterval;          /* Polling interval in milliseconds for the endpoint.
+                                        * Relevant to Isochronous and Interrupt endpoints only */
+} __attribute__((packed)) USB_Descriptor_Endpoint_t;
+
+/* USB Standard Endpoint Descriptor (Section 9.6.6, table 9-13) */
+enum USB_Endpoint_TransType_t
+{
+    USB_ENDPOINT_TRANSTYPE_CTRL          = 0x0,
+    USB_ENDPOINT_TRANSTYPE_ISO           = 0x1,
+    USB_ENDPOINT_TRANSTYPE_BULK          = 0x2,
+    USB_ENDPOINT_TRANSTYPE_INT           = 0x3
+};
+#define  USB_ENDPOINT_TRANSTYPE_SHIFT     (0)
+
+enum USB_Endpoint_SyncType_t
+{
+    USB_ENDPOINT_SYNCTYPE_NONE          = 0x0,
+    USB_ENDPOINT_SYNCTYPE_ASYNC         = 0x1,
+    USB_ENDPOINT_SYNCTYPE_ADAPT         = 0x2,
+    USB_ENDPOINT_SYNCTYPE_SYNC          = 0x3
+};
+#define  USB_ENDPOINT_SYNCTYPE_SHIFT     (2)
+
+enum USB_Endpoint_UsageType_t
+{
+    USB_ENDPOINT_USAGETYPE_DATA          = 0x0,
+    USB_ENDPOINT_USAGETYPE_FEEDBACK      = 0x1,
+    USB_ENDPOINT_USAGETYPE_IMPLICIT      = 0x2,
+    USB_ENDPOINT_USAGETYPE_RESERVED      = 0x3
+};
+#define  USB_ENDPOINT_USAGETYPE_SHIFT     (4)
+
+
+
+/* USB String Descriptor (Section 9.6.7 table 9-15) */
+typedef struct
+{
+    unsigned char bLength;              /* Size of the descriptor (bytes) */
+    unsigned char bDescriptorType;      /* Descriptor type, either a value in \ref USB_DescriptorTypes_t
+                                         * or a value given by the specific class */
+    unsigned short bString[];           /* String data, (as unicode characters) - use array of chars instead of string.
+                                         * In GCC prefix string with "L" */
+} __attribute__((packed)) USB_Descriptor_String_t;
+#endif
+#endif

xmos_ai_tools/runtime/include/lib_xud/lib_xud/api/xud_std_requests.h

@@ -0,0 +1,120 @@
+// Copyright 2015-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+#ifndef _USB_STD_REQUESTS_H_
+#define _USB_STD_REQUESTS_H_
+
+#include <xccompat.h>
+#include "XUD_USB_Defines.h"
+
+/* 9.3 USB Device Requests: Table 9-2 Format of Setup Data */
+/* bmRequestType: */
+#define USB_BM_REQTYPE_DIRECTION_H2D    0           /* Host to device */
+#define USB_BM_REQTYPE_DIRECTION_D2H    1           /* Device to host */
+
+#define USB_BM_REQTYPE_TYPE_STANDARD    0x00
+#define USB_BM_REQTYPE_TYPE_CLASS       0x01
+#define USB_BM_REQTYPE_TYPE_VENDOR      0x02
+
+#define USB_BM_REQTYPE_RECIP_DEV        0x00
+#define USB_BM_REQTYPE_RECIP_INTER      0x01
+#define USB_BM_REQTYPE_RECIP_EP         0x02
+#define USB_BM_REQTYPE_RECIP_OTHER      0x03
+
+#define USB_BMREQ_H2D_STANDARD_DEV      ((USB_BM_REQTYPE_DIRECTION_H2D << 7) | \
+                                         (USB_BM_REQTYPE_TYPE_STANDARD << 5) | \
+                                         (USB_BM_REQTYPE_RECIP_DEV))
+#define USB_BMREQ_D2H_STANDARD_DEV      ((USB_BM_REQTYPE_DIRECTION_D2H << 7) | \
+                                         (USB_BM_REQTYPE_TYPE_STANDARD << 5) | \
+                                         (USB_BM_REQTYPE_RECIP_DEV))
+#define USB_BMREQ_H2D_STANDARD_INT      ((USB_BM_REQTYPE_DIRECTION_H2D << 7) | \
+                                         (USB_BM_REQTYPE_TYPE_STANDARD << 5) | \
+                                         (USB_BM_REQTYPE_RECIP_INTER))
+#define USB_BMREQ_D2H_STANDARD_INT      ((USB_BM_REQTYPE_DIRECTION_D2H << 7) | \
+                                         (USB_BM_REQTYPE_TYPE_STANDARD << 5) | \
+                                         (USB_BM_REQTYPE_RECIP_INTER))
+#define USB_BMREQ_H2D_STANDARD_EP       ((USB_BM_REQTYPE_DIRECTION_H2D << 7) | \
+                                         (USB_BM_REQTYPE_TYPE_STANDARD << 5) | \
+                                         (USB_BM_REQTYPE_RECIP_EP))
+#define USB_BMREQ_D2H_STANDARD_EP       ((USB_BM_REQTYPE_DIRECTION_D2H << 7) | \
+                                         (USB_BM_REQTYPE_TYPE_STANDARD << 5) | \
+                                         (USB_BM_REQTYPE_RECIP_EP))
+
+
+#define USB_BMREQ_H2D_CLASS_INT         ((USB_BM_REQTYPE_DIRECTION_H2D << 7) | \
+                                         (USB_BM_REQTYPE_TYPE_CLASS << 5)    | \
+                                         (USB_BM_REQTYPE_RECIP_INTER))
+#define USB_BMREQ_D2H_CLASS_INT         ((USB_BM_REQTYPE_DIRECTION_D2H << 7) | \
+                                         (USB_BM_REQTYPE_TYPE_CLASS << 5)    | \
+                                         (USB_BM_REQTYPE_RECIP_INTER))
+#define USB_BMREQ_H2D_CLASS_EP          ((USB_BM_REQTYPE_DIRECTION_H2D << 7) | \
+                                         (USB_BM_REQTYPE_TYPE_CLASS << 5)    | \
+                                         (USB_BM_REQTYPE_RECIP_EP))
+#define USB_BMREQ_D2H_CLASS_EP          ((USB_BM_REQTYPE_DIRECTION_D2H << 7) | \
+                                         (USB_BM_REQTYPE_TYPE_CLASS << 5)    | \
+                                         (USB_BM_REQTYPE_RECIP_EP))
+
+#define USB_BMREQ_H2D_VENDOR_DEV          ((USB_BM_REQTYPE_DIRECTION_H2D << 7) | \
+                                            (USB_BM_REQTYPE_TYPE_VENDOR << 5) | \
+                                            (USB_BM_REQTYPE_RECIP_DEV))
+#define USB_BMREQ_D2H_VENDOR_DEV	      ((USB_BM_REQTYPE_DIRECTION_D2H << 7) | \
+                                            (USB_BM_REQTYPE_TYPE_VENDOR << 5) | \
+                                            (USB_BM_REQTYPE_RECIP_DEV))
+
+/* Table 9-4. Standard Request Codes */
+/* bRequest */
+#define USB_GET_STATUS                  0x00
+#define USB_CLEAR_FEATURE               0x01
+#define USB_SET_FEATURE                 0x03
+#define USB_SET_ADDRESS                 0x05
+#define USB_GET_DESCRIPTOR              0x06
+#define USB_SET_DESCRIPTOR              0x07
+#define USB_GET_CONFIGURATION           0x08
+#define USB_SET_CONFIGURATION           0x09
+#define USB_GET_INTERFACE               0x0A
+#define USB_SET_INTERFACE               0x0B
+#define USB_SYNCH_FRAME                 0x0C
+
+/**
+ * \var     typedef USB_BmRequestType_t
+ * \brief   Defines the Recepient, Type and Direction of a USB request.
+ */
+typedef struct USB_BmRequestType
+{
+    unsigned char Recipient;        // [4..0]   Request directed to:
+                                    //          0b00000: Device
+                                    //          0b00001: Specific interface
+                                    //          0b00010: Specific endpoint
+                                    //          0b00011: Other element in device
+    unsigned char Type;             // [6..5]   0b00: Standard request
+                                    //          0b01: Class specific request
+                                    //          0b10: Request by vendor specific driver
+    unsigned char Direction;        // [7]      0 (Host->Dev)
+                                    //          1 (Dev->Host)
+} USB_BmRequestType_t;
+
+/**
+ * \var     typedef USB_SetupPacket_t
+ * \brief   Typedef for setup packet structure */
+typedef struct USB_SetupPacket
+{
+    USB_BmRequestType_t bmRequestType;    /* (1 byte) Specifies direction of dataflow,
+                                             type of rquest and recipient */
+    unsigned char bRequest;               /* Specifies the request */
+    unsigned short wValue;                /* Host can use this to pass info to the
+                                             device in its own way */
+    unsigned short wIndex;                /* Typically used to pass index/offset such
+                                             as interface or EP no */
+    unsigned short wLength;               /* Number of data bytes in the data stage
+                                             (for Host -> Device this this is exact
+                                             count, for Dev->Host is a max. */
+} USB_SetupPacket_t;
+
+/**
+ *  \brief Prints out passed ``USB_SetupPacket_t`` struct using debug IO
+ */
+void USB_PrintSetupPacket(USB_SetupPacket_t sp);
+
+void USB_ComposeSetupBuffer(USB_SetupPacket_t sp, unsigned char buffer[]);
+
+void USB_ParseSetupPacket(unsigned char b[], REFERENCE_PARAM(USB_SetupPacket_t, p));
+#endif

xmos_ai_tools/runtime/include/lib_xud/lib_xud/src/user/XUD_USB_Defines.h

@@ -0,0 +1,70 @@
+// Copyright 2015-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+/**
+ * @brief     Defines from the Universal Serial Bus Specification Revision 2.0
+ **/
+
+#ifndef _USB_DEFS_H_
+#define _USB_DEFS_H_
+
+/* Table 8-1. PID Types */
+#define USB_PID_OUT                     0x1         /* Tokens */
+#define USB_PID_IN                      0x9
+#define USB_PID_SOF                     0x5
+#define USB_PID_SETUP                   0xD
+#define USB_PID_DATA0                   0x3         /* Data packet PID even */
+#define USB_PID_DATA1                   0xB         /* Data packet PID odd */
+#define USB_PID_DATA2                   0x7         /* Data packet PID high-speed, high bandwidth isoc transaction in a microframe */
+#define USB_PID_MDATA                   0xF         /* Data packet PID high-speed and high bandwidth isoc transactions */
+#define USB_PID_ACK                     0x2         /* Receiver accepts error-free data packet */
+#define USB_PID_NAK                     0xA         /* Receiving device cannot accept data of transmitting device cannot send data */
+#define USB_PID_STALL                   0xE         /* Endpoint is halted or a control pipe request is not supported */
+#define USB_PID_PRE                     0xC
+#define USB_PID_ERR                     0xC
+#define USB_PID_SPLIT                   0x8
+#define USB_PID_PING                    0x4         /* Hign-speed flow control probe for bulk/control endpoint */
+
+/* PID with error check */
+#define USB_PID_NEGATE(PID) ((PID) | (((~PID) & 0xf) << 4))
+#define USB_PIDn_OUT                    0xe1
+#define USB_PIDn_IN                     0x69
+#define USB_PIDn_SOF                    0xa5
+#define USB_PIDn_SETUP                  0x2d
+#define USB_PIDn_DATA0                  0xc3
+#define USB_PIDn_DATA1                  USB_PID_NEGATE(USB_PID_DATA1)
+#define USB_PIDn_DATA2                  USB_PID_NEGATE(USB_PID_DATA2)
+#define USB_PIDn_ACK                    0xd2
+#define USB_PIDn_NAK                    0x5a
+#define USB_PIDn_STALL                  0x1e
+
+/* Table 9-6. Standard Feature Selectors (wValue) */
+#define USB_DEVICE_REMOTE_WAKEUP        0x01        /* Recipient: Device */
+#define USB_ENDPOINT_HALT               0x00        /* Recipient: Endpoint */
+#define USB_TEST_MODE                   0x02        /* Recipient: Device */
+
+#define USB_STANDARD_DEVICE_REQUEST     0x00
+#define USB_STANDARD_INTERFACE_REQUEST  0x01
+#define USB_STANDARD_ENDPOINT_REQUEST   0x02
+#define USB_VENDOR_DEVICE_REQUEST       0x40
+#define USB_VENDOR_ENDPOINT_REQUEST     0x42
+#define USB_CLASS_INTERFACE_REQUEST     0x21
+#define USB_CLASS_ENDPOINT_REQUEST      0x22
+
+#define USB_WVAL_EP_HALT                0
+
+// Low byte values:
+//#define USB_WVALUE_GETDESC_STRING_LANGIDS   0x0
+//#define USB_WVALUE_GETDESC_STRING_IPRODUCT  0x2
+
+// Test selector defines for Test mode
+#define USB_WINDEX_TEST_J               (0x1<<8)
+#define USB_WINDEX_TEST_K               (0x2<<8)
+#define USB_WINDEX_TEST_SE0_NAK         (0x3<<8)
+#define USB_WINDEX_TEST_PACKET          (0x4<<8)
+#define USB_WINDEX_TEST_FORCE_ENABLE    (0x5<<8)
+
+#define USB_MAX_NUM_EP_OUT              (16)
+#define USB_MAX_NUM_EP_IN               (16)
+#define USB_MAX_NUM_EP                  (32)
+
+#endif

xmos_ai_tools/runtime/include/lib_xud/lib_xud/src/user/class/hid.h

@@ -0,0 +1,23 @@
+// Copyright 2015-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+/*
+ * @brief Defines from USB Device Class Definition for Human Interface Devices Specification
+ */
+
+/* 7. Requests */
+
+/* 7.1 Standard Requests  - Class Descriptor Types - High byte of wValue
+ * The following defines valid types of Class descriptors */
+#define HID_HID                   0x2100
+#define HID_REPORT                0x2200
+#define HID_PHYSICAL_DESCRIPTOR   0x2300
+/*0x24 - 0x2F: Reserved */
+
+/* 7.2 Class-Specific Requests - bRequest values */
+#define HID_GET_REPORT            0x01           /* Mandatory */
+#define HID_GET_IDLE              0x02
+#define HID_GET_PROTOCOL          0x03           /* Required only for boot devices */
+/* Ox04 - 0x08 reserved */
+#define HID_SET_REPORT            0x09
+#define HID_SET_IDLE              0x0A
+#define HID_SET_PROTOCOL          0x0B           /* Required only for boot devices */

xmos_ai_tools/runtime/include/lib_xud/lib_xud/src/user/class/usbaudio10.h

@@ -0,0 +1,30 @@
+// Copyright 2017-2021 XMOS LIMITED.
+// This Software is subject to the terms of the XMOS Public Licence: Version 1.
+
+#ifndef _AUDIO10_H_
+#define _AUDIO10_H_ 1
+/**
+ * @brief      Defines from the USB Audio 1.0 Specifications
+ * @author     Ross Owen, XMOS Limited
+ */
+
+/* A.9. Audio Class-Specific Request Codes */
+#define UAC_B_REQ_SET_CUR               0x01
+#define UAC_B_REQ_GET_CUR               0x81
+#define UAC_B_REQ_SET_MIN               0x02
+#define UAC_B_REQ_GET_MIN               0x82
+#define UAC_B_REQ_SET_MAX               0x03
+#define UAC_B_REQ_GET_MAX               0x83
+#define UAC_B_REQ_SET_RES               0x04
+#define UAC_B_REQ_GET_RES               0x84
+#define UAC_B_REQ_SET_MEM               0x05
+#define UAC_B_REQ_GET_MEM               0x85
+#define UAC_B_REQ_GET_STAT              0xFF
+
+/* A.10.5 Endpoint Control Selectors: Table A-19 */
+#define EP_CONTROL_UNDEFINED            0x00
+#define SAMPLING_FREQ_CONTROL           0x01
+#define PITCH_CONTROL                   0x02
+
+#endif
+