- /* Macros: */\r
- /** Audio class descriptor subtype value for a Audio class specific MIDI input jack descriptor. */\r
- #define DSUBTYPE_InputJack 0x02\r
-\r
- /** Audio class descriptor subtype value for a Audio class specific MIDI output jack descriptor. */\r
- #define DSUBTYPE_OutputJack 0x03\r
- \r
- /** Audio class descriptor jack type value for an embedded (logical) MIDI input or output jack. */\r
- #define MIDI_JACKTYPE_EMBEDDED 0x01\r
-\r
- /** Audio class descriptor jack type value for an external (physical) MIDI input or output jack. */\r
- #define MIDI_JACKTYPE_EXTERNAL 0x02\r
-\r
- /** MIDI command for a note on (activation) event */\r
- #define MIDI_COMMAND_NOTE_ON 0x09\r
-\r
- /** MIDI command for a note off (deactivation) event */\r
- #define MIDI_COMMAND_NOTE_OFF 0x08\r
-\r
- /** Standard key press velocity value used for all note events, as no pressure sensor is mounted */\r
- #define MIDI_STANDARD_VELOCITY 64\r
- \r
- /** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel\r
- * addresses are zero-indexed. This converts a natural MIDI channel number into the logical channel address.\r
- *\r
- * \param channel MIDI channel number to address\r
- */\r
- #define MIDI_CHANNEL(channel) (channel - 1)\r
- \r
- /* Type Defines: */\r
- /** Type define for an Audio class specific MIDI streaming interface descriptor. This indicates to the host\r
- * how MIDI the specification compliance of the device and the total length of the Audio class specific descriptors.\r
- * See the USB Audio specification for more details.\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
- \r
- uint16_t AudioSpecification; /**< Binary coded decimal value, indicating the supported Audio Class specification version */\r
- uint16_t TotalLength; /**< Total length of the Audio class specific descriptors, including this descriptor */\r
- } USB_AudioInterface_MIDI_AS_t;\r
- \r
- /** Type define for an Audio class specific MIDI IN jack. This gives information to the host on a MIDI input, either\r
- * a physical input jack, or a logical jack (receiving input data internally, or from the host via an endpoint).\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
-\r
- uint8_t JackType; /**< Type of jack, one of the JACKTYPE_* mask values */\r
- uint8_t JackID; /**< ID value of this jack - must be a unique value within the device */\r
- \r
- uint8_t JackStrIndex; /**< Index of a string descriptor describing this descriptor within the device */\r
- } USB_MIDI_In_Jack_t;\r
-\r
- /** Type define for an Audio class specific MIDI OUT jack. This gives information to the host on a MIDI output, either\r
- * a physical output jack, or a logical jack (sending output data internally, or to the host via an endpoint).\r
- */\r
- typedef struct\r
- {\r
- USB_Descriptor_Header_t Header; /**< Regular descriptor header containing the descriptor's type and length */\r
- uint8_t Subtype; /**< Sub type value used to distinguish between audio class specific descriptors */\r
-\r
- uint8_t JackType; /**< Type of jack, one of the JACKTYPE_* mask values */\r
- uint8_t JackID; /**< ID value of this jack - must be a unique value within the device */\r
+ /* Public Interface - May be used in end-application: */\r
+ /* Type Define: */\r
+ /** Class state structure. An instance of this structure should be made for each MIDI interface\r
+ * within the user application, and passed to each of the MIDI class driver functions as the\r
+ * MIDIInterfaceInfo parameter. This stores each MIDI interface's configuration and state information.\r
+ */\r
+ typedef struct\r
+ {\r
+ const struct\r
+ {\r
+ uint8_t StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls */\r
+\r
+ uint8_t DataINEndpointNumber; /**< Endpoint number of the incoming MIDI data, if available (zero if unused) */\r
+ uint16_t DataINEndpointSize; /**< Size in bytes of the incoming MIDI data endpoint, if available (zero if unused) */\r
+ bool DataINEndpointDoubleBank; /** Indicates if the MIDI interface's IN data endpoint should use double banking */\r
+\r
+ uint8_t DataOUTEndpointNumber; /**< Endpoint number of the outgoing MIDI data, if available (zero if unused) */\r
+ uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing MIDI data endpoint, if available (zero if unused) */\r
+ bool DataOUTEndpointDoubleBank; /** Indicates if the MIDI interface's IN data endpoint should use double banking */\r
+ } Config; /**< Config data for the USB class interface within the device. All elements in this section\r
+ * <b>must</b> be set or the interface will fail to enumerate and operate correctly.\r
+ */ \r
+ struct\r
+ {\r
+ // No state information for this class yet\r
+ } State; /**< State data for the USB class interface within the device. All elements in this section\r
+ * are reset to their defaults when the interface is enumerated.\r
+ */\r
+ } USB_ClassInfo_MIDI_Device_t; \r
+ \r
+ /* Function Prototypes: */\r
+ /** Configures the endpoints of a given MIDI interface, ready for use. This should be linked to the library\r
+ * \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration\r
+ * containing the given MIDI interface is selected.\r
+ *\r
+ * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state\r
+ *\r
+ * \return Boolean true if the endpoints were successfully configured, false otherwise\r
+ */\r
+ bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
projects / pub / USBasp.git / blobdiff