/** \ingroup Group_USBClassMIDI\r
* @defgroup Group_USBClassMIDIDevice MIDI Class Device Mode Driver\r
*\r
+ * \section Sec_Dependencies Module Source Dependencies\r
+ * The following files must be built with any user project that uses this module:\r
+ * - LUFA/Drivers/USB/Class/Device/MIDI.c\r
+ *\r
* \section Module Description\r
* Device Mode USB Class driver framework interface, for the MIDI USB Class driver.\r
*\r
\r
/* Public Interface - May be used in end-application: */\r
/* Type Define: */\r
- /** Configuration information structure for \ref USB_ClassInfo_MIDI_Device_t MIDI device interface structures. */\r
- typedef USB_ClassInfo_MIDI_Device_Config_t;\r
- \r
- /** Current State information structure for \ref USB_ClassInfo_MIDI_Device_t MIDI device interface structures. */\r
- typedef USB_ClassInfo_MIDI_Device_State_t;\r
- \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
// 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
- * <b>may</b> be set to initial values, but may also be ignored to default to sane values when\r
- * the interface is enumerated.\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_ConfigurationChanged() event so that the endpoints are configured when the configuration\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 MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\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 sucessfully configured, false otherwise\r
*/\r
- bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_Device_t* MIDIInterfaceInfo);\r
+ bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Processes incomming control requests from the host, that are directed to the given MIDI class interface. This should be\r
- * linked to the library \ref EVENT_USB_UnhandledControlPacket() event.\r
+ * linked to the library \ref EVENT_USB_Device_UnhandledControlRequest() event.\r
*\r
- * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
+ * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
*/ \r
- void MIDI_Device_ProcessControlPacket(USB_ClassInfo_MIDI_Device_t* MIDIInterfaceInfo);\r
+ void MIDI_Device_ProcessControlRequest(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** General management task for a given MIDI class interface, required for the correct operation of the interface. This should\r
* be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().\r
*\r
- * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
+ * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
*/\r
- void MIDI_Device_USBTask(USB_ClassInfo_MIDI_Device_t* MIDIInterfaceInfo);\r
+ void MIDI_Device_USBTask(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded.\r
*\r
- * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
- * \param Event Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send\r
+ * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
+ * \param[in] Event Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send\r
+ *\r
+ * \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum \r
*/\r
- void MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_Device_t* MIDIInterfaceInfo, MIDI_EventPacket_t* Event);\r
+ uint8_t MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo,\r
+ MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1, 2);\r
\r
/** Receives a MIDI event packet from the host.\r
*\r
- * \param MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
- * \param Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed\r
+ * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.\r
+ * \param[out] Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed\r
*\r
* \return Boolean true if a MIDI event packet was received, false otherwise\r
*/\r
- bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_Device_t* MIDIInterfaceInfo, MIDI_EventPacket_t* Event);\r
+ bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo,\r
+ MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1, 2);\r
\r
/* Disable C linkage for C++ Compilers: */\r
#if defined(__cplusplus)\r
projects / pub / USBasp.git / blobdiff