mirror of https://github.com/qmk/qmk_firmware
176 lines
8.1 KiB
C
176 lines
8.1 KiB
C
|
/*
|
||
|
|
LUFA Library
|
||
|
|
Copyright (C) Dean Camera, 2017.
|
||
|
|
|
||
|
|
dean [at] fourwalledcubicle [dot] com
|
||
|
|
www.lufa-lib.org
|
||
|
|
*/
|
||
|
|
|
||
|
|
/*
|
||
|
|
Copyright 2017 Dean Camera (dean [at] fourwalledcubicle [dot] com)
|
||
|
|
|
||
|
|
Permission to use, copy, modify, distribute, and sell this
|
||
|
|
software and its documentation for any purpose is hereby granted
|
||
|
|
without fee, provided that the above copyright notice appear in
|
||
|
|
all copies and that both that the copyright notice and this
|
||
|
|
permission notice and warranty disclaimer appear in supporting
|
||
|
|
documentation, and that the name of the author not be used in
|
||
|
|
advertising or publicity pertaining to distribution of the
|
||
|
|
software without specific, written prior permission.
|
||
|
|
|
||
|
|
The author disclaims all warranties with regard to this
|
||
|
|
software, including all implied warranties of merchantability
|
||
|
|
and fitness. In no event shall the author be liable for any
|
||
|
|
special, indirect or consequential damages or any damages
|
||
|
|
whatsoever resulting from loss of use, data or profits, whether
|
||
|
|
in an action of contract, negligence or other tortious action,
|
||
|
|
arising out of or in connection with the use or performance of
|
||
|
|
this software.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** \file
|
||
|
|
* \brief Device mode driver for the library USB MIDI Class driver.
|
||
|
|
*
|
||
|
|
* Device mode driver for the library USB MIDI Class driver.
|
||
|
|
*
|
||
|
|
* \note This file should not be included directly. It is automatically included as needed by the USB module driver
|
||
|
|
* dispatch header located in LUFA/Drivers/USB.h.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/** \ingroup Group_USBClassMIDI
|
||
|
|
* \defgroup Group_USBClassMIDIDevice MIDI Class Device Mode Driver
|
||
|
|
*
|
||
|
|
* \section Sec_USBClassMIDIDevice_Dependencies Module Source Dependencies
|
||
|
|
* The following files must be built with any user project that uses this module:
|
||
|
|
* - LUFA/Drivers/USB/Class/Device/MIDIClassDevice.c <i>(Makefile source module name: LUFA_SRC_USBCLASS)</i>
|
||
|
|
*
|
||
|
|
* \section Sec_USBClassMIDIDevice_ModDescription Module Description
|
||
|
|
* Device Mode USB Class driver framework interface, for the MIDI USB Class driver.
|
||
|
|
*
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef _MIDI_CLASS_DEVICE_H_
|
||
|
|
#define _MIDI_CLASS_DEVICE_H_
|
||
|
|
|
||
|
|
/* Includes: */
|
||
|
|
#include "../../USB.h"
|
||
|
|
#include "../Common/MIDIClassCommon.h"
|
||
|
|
|
||
|
|
/* Enable C linkage for C++ Compilers: */
|
||
|
|
#if defined(__cplusplus)
|
||
|
|
extern "C" {
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/* Preprocessor Checks: */
|
||
|
|
#if !defined(__INCLUDE_FROM_MIDI_DRIVER)
|
||
|
|
#error Do not include this file directly. Include LUFA/Drivers/USB.h instead.
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/* Public Interface - May be used in end-application: */
|
||
|
|
/* Type Define: */
|
||
|
|
/** \brief MIDI Class Device Mode Configuration and State Structure.
|
||
|
|
*
|
||
|
|
* Class state structure. An instance of this structure should be made for each MIDI interface
|
||
|
|
* within the user application, and passed to each of the MIDI class driver functions as the
|
||
|
|
* \c MIDIInterfaceInfo parameter. This stores each MIDI interface's configuration and state information.
|
||
|
|
*/
|
||
|
|
typedef struct
|
||
|
|
{
|
||
|
|
struct
|
||
|
|
{
|
||
|
|
uint8_t StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls. */
|
||
|
|
|
||
|
|
USB_Endpoint_Table_t DataINEndpoint; /**< Data IN endpoint configuration table. */
|
||
|
|
USB_Endpoint_Table_t DataOUTEndpoint; /**< Data OUT endpoint configuration table. */
|
||
|
|
} Config; /**< Config data for the USB class interface within the device. All elements in this section
|
||
|
|
* <b>must</b> be set or the interface will fail to enumerate and operate correctly.
|
||
|
|
*/
|
||
|
|
|
||
|
|
struct
|
||
|
|
{
|
||
|
|
uint8_t RESERVED; // No state information for this class
|
||
|
|
} State; /**< State data for the USB class interface within the device. All elements in this section
|
||
|
|
* are reset to their defaults when the interface is enumerated.
|
||
|
|
*/
|
||
|
|
} USB_ClassInfo_MIDI_Device_t;
|
||
|
|
|
||
|
|
/* Function Prototypes: */
|
||
|
|
/** Configures the endpoints of a given MIDI interface, ready for use. This should be linked to the library
|
||
|
|
* \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration
|
||
|
|
* containing the given MIDI interface is selected.
|
||
|
|
*
|
||
|
|
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.
|
||
|
|
*
|
||
|
|
* \return Boolean \c true if the endpoints were successfully configured, \c false otherwise.
|
||
|
|
*/
|
||
|
|
bool MIDI_Device_ConfigureEndpoints(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
|
||
|
|
|
||
|
|
/** General management task for a given MIDI class interface, required for the correct operation of the interface. This should
|
||
|
|
* be called frequently in the main program loop, before the master USB management task \ref USB_USBTask().
|
||
|
|
*
|
||
|
|
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.
|
||
|
|
*/
|
||
|
|
void MIDI_Device_USBTask(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
|
||
|
|
|
||
|
|
/** Sends a MIDI event packet to the host. If no host is connected, the event packet is discarded. Events are queued into the
|
||
|
|
* endpoint bank until either the endpoint bank is full, or \ref MIDI_Device_Flush() is called. This allows for multiple
|
||
|
|
* MIDI events to be packed into a single endpoint packet, increasing data throughput.
|
||
|
|
*
|
||
|
|
* \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
|
||
|
|
* call will fail.
|
||
|
|
*
|
||
|
|
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.
|
||
|
|
* \param[in] Event Pointer to a populated \ref MIDI_EventPacket_t structure containing the MIDI event to send.
|
||
|
|
*
|
||
|
|
* \return A value from the \ref Endpoint_Stream_RW_ErrorCodes_t enum.
|
||
|
|
*/
|
||
|
|
uint8_t MIDI_Device_SendEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo,
|
||
|
|
const MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
|
||
|
|
|
||
|
|
|
||
|
|
/** Flushes the MIDI send buffer, sending any queued MIDI events to the host. This should be called to override the
|
||
|
|
* \ref MIDI_Device_SendEventPacket() function's packing behavior, to flush queued events.
|
||
|
|
*
|
||
|
|
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.
|
||
|
|
*
|
||
|
|
* \return A value from the \ref Endpoint_WaitUntilReady_ErrorCodes_t enum.
|
||
|
|
*/
|
||
|
|
uint8_t MIDI_Device_Flush(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
|
||
|
|
|
||
|
|
/** Receives a MIDI event packet from the host. Events are unpacked from the endpoint, thus if the endpoint bank contains
|
||
|
|
* multiple MIDI events from the host in the one packet, multiple calls to this function will return each individual event.
|
||
|
|
*
|
||
|
|
* \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
|
||
|
|
* call will fail.
|
||
|
|
*
|
||
|
|
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.
|
||
|
|
* \param[out] Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed.
|
||
|
|
*
|
||
|
|
* \return Boolean \c true if a MIDI event packet was received, \c false otherwise.
|
||
|
|
*/
|
||
|
|
bool MIDI_Device_ReceiveEventPacket(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo,
|
||
|
|
MIDI_EventPacket_t* const Event) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2);
|
||
|
|
|
||
|
|
/* Inline Functions: */
|
||
|
|
/** Processes incoming control requests from the host, that are directed to the given MIDI class interface. This should be
|
||
|
|
* linked to the library \ref EVENT_USB_Device_ControlRequest() event.
|
||
|
|
*
|
||
|
|
* \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state.
|
||
|
|
*/
|
||
|
|
static inline void MIDI_Device_ProcessControlRequest(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1);
|
||
|
|
static inline void MIDI_Device_ProcessControlRequest(USB_ClassInfo_MIDI_Device_t* const MIDIInterfaceInfo)
|
||
|
|
{
|
||
|
|
(void)MIDIInterfaceInfo;
|
||
|
|
}
|
||
|
|
|
||
|
|
/* Disable C linkage for C++ Compilers: */
|
||
|
|
#if defined(__cplusplus)
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/** @} */
|
||
|
|
|