[freertos] /

/*\r
 * @brief Device mode driver for the library USB MIDI Class driver\r
 *\r
 * @note\r
 * Copyright(C) NXP Semiconductors, 2012\r
 * Copyright(C) Dean Camera, 2011, 2012\r
 * All rights reserved.\r
 *\r
 * @par\r
 * Software that is described herein is for illustrative purposes only\r
 * which provides customers with programming information regarding the\r
 * LPC products.  This software is supplied "AS IS" without any warranties of\r
 * any kind, and NXP Semiconductors and its licensor disclaim any and\r
 * all warranties, express or implied, including all implied warranties of\r
 * merchantability, fitness for a particular purpose and non-infringement of\r
 * intellectual property rights.  NXP Semiconductors assumes no responsibility\r
 * or liability for the use of the software, conveys no license or rights under any\r
 * patent, copyright, mask work right, or any other intellectual property rights in\r
 * or to any products. NXP Semiconductors reserves the right to make changes\r
 * in the software without notification. NXP Semiconductors also makes no\r
 * representation or warranty that such application will be suitable for the\r
 * specified use without further testing or modification.\r
 *\r
 * @par\r
 * Permission to use, copy, modify, and distribute this software and its\r
 * documentation is hereby granted, under NXP Semiconductors' and its\r
 * licensor's relevant copyrights in the software, without fee, provided that it\r
 * is used in conjunction with NXP Semiconductors microcontrollers.  This\r
 * copyright, permission, and disclaimer notice must appear in all copies of\r
 * this code.\r
 */\r
\r
/** @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
 *    - nxpUSBlib/Drivers/USB/Class/Device/MIDI.c <i>(Makefile source module name: NXPUSBLIB_SRC_USBCLASS)</i>\r
 *\r
 *  @section Sec_ModDescription Module Description\r
 *  Device Mode USB Class driver framework interface, for the MIDI USB Class driver.\r
 *\r
 * @{\r
 */\r
\r
#ifndef _MIDI_CLASS_DEVICE_H_\r
#define _MIDI_CLASS_DEVICE_H_\r
\r
/* Includes: */\r
                #include "../../USB.h"\r
                #include "../Common/MIDIClassCommon.h"\r
\r
/* Enable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
extern "C" {\r
                #endif\r
\r
/* Preprocessor Checks: */\r
                #if !defined(__INCLUDE_FROM_MIDI_DRIVER)\r
                        #error Do not include this file directly. Include LPCUSBlib/Drivers/USB.h instead.\r
                #endif\r
\r
/* Public Interface - May be used in end-application: */\r
/* Type Define: */\r
/**\r
 * @brief MIDI Class Device Mode Configuration and State Structure.\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
 *  \c MIDIInterfaceInfo parameter. This stores each MIDI interface's configuration and state information.\r
 */\r
typedef struct {\r
        const struct {\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 IN data, if available (zero if unused). */\r
                uint16_t DataINEndpointSize;                    /**< Size in bytes of the incoming MIDI IN 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 OUT data, if available (zero if unused). */\r
                uint16_t DataOUTEndpointSize;                           /**< Size in bytes of the outgoing MIDI OUT data endpoint, if available (zero if unused). */\r
                bool     DataOUTEndpointDoubleBank;                             /**< Indicates if the MIDI interface's OUT data endpoint should use double banking. */\r
                uint8_t  PortNumber;                            /**< Port number that this interface is running.*/\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
\r
#if 0\r
        struct {\r
                // No state information for this class\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
\r
#endif\r
} USB_ClassInfo_MIDI_Device_t;\r
\r
/* Function Prototypes: */\r
/**\r
 * @brief       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       MIDIInterfaceInfo       : Pointer to a structure containing a MIDI Class configuration and state.\r
 *\r
 * @return      Boolean \c true if the endpoints were successfully configured, \c false otherwise.\r
 */\r
bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_Device_t *const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/**\r
 * @brief       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
  * @return     Nothing\r
 */\r
void MIDI_Device_USBTask(USB_ClassInfo_MIDI_Device_t *const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/**\r
 * @brief       Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded. Events are queued into the\r
 *  endpoint bank until either the endpoint bank is full, or @ref MIDI_Device_Flush() is called. This allows for multiple\r
 *  MIDI events to be packed into a single endpoint packet, increasing data throughput.\r
 *\r
 *  @pre This function must only be called when the Host state machine is in the @ref HOST_STATE_Configured state or the\r
 *       call will fail.\r
 *\r
 * @param       MIDIInterfaceInfo       : Pointer to a structure containing a MIDI Class configuration and state.\r
 * @param       Event   : Pointer to a populated @ref 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
uint8_t MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_Device_t *const MIDIInterfaceInfo,\r
                                                                        const MIDI_EventPacket_t *const Event) ATTR_NON_NULL_PTR_ARG(1)\r
ATTR_NON_NULL_PTR_ARG(2);\r
\r
/**\r
 * @brief       Flushes the MIDI send buffer, sending any queued MIDI events to the host. This should be called to override the\r
 *  @ref MIDI_Device_SendEventPacket() function's packing behaviour, to flush queued events.\r
 *\r
 * @param       MIDIInterfaceInfo       : Pointer to a structure containing a MIDI Class configuration and state.\r
 *\r
 * @return      A value from the @ref Endpoint_WaitUntilReady_ErrorCodes_t enum.\r
 */\r
uint8_t MIDI_Device_Flush(USB_ClassInfo_MIDI_Device_t *const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);\r
\r
/**\r
 * @brief       Receives a MIDI event packet from the host. Events are unpacked from the endpoint, thus if the endpoint bank contains\r
 *  multiple MIDI events from the host in the one packet, multiple calls to this function will return each individual event.\r
 *\r
 *  @pre This function must only be called when the Host state machine is in the @ref HOST_STATE_Configured state or the\r
 *       call will fail.\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
 *\r
 * @return      Boolean \c true if a MIDI event packet was received, \c false otherwise.\r
 */\r
bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_Device_t *const MIDIInterfaceInfo,\r
                                                                        MIDI_EventPacket_t *const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);\r
\r
/* Inline Functions: */\r
/**\r
 * @brief       Processes incoming 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_Device_ControlRequest() event.\r
 *\r
 * @param       MIDIInterfaceInfo       : Pointer to a structure containing a MIDI Class configuration and state.\r
 */\r
static inline void MIDI_Device_ProcessControlRequest(USB_ClassInfo_MIDI_Device_t *const MIDIInterfaceInfo)\r
ATTR_NON_NULL_PTR_ARG(1);\r
\r
static inline void MIDI_Device_ProcessControlRequest(USB_ClassInfo_MIDI_Device_t *const MIDIInterfaceInfo)\r
{\r
        (void) MIDIInterfaceInfo;\r
}\r
\r
/* Disable C linkage for C++ Compilers: */\r
                #if defined(__cplusplus)\r
}\r
                #endif\r
\r
#endif\r
\r
/** @} */\r
\r