Demos/Host/ClassDriver/MIDIHost/MIDIHost.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2019.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2019  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Main source file for the MIDIHost demo. This file contains the main tasks of
  34  *  the demo and is responsible for the initial application hardware configuration.
  35  */
  36
  37 #include "MIDIHost.h"
  38
  39 /** LUFA MIDI Class driver interface configuration and state information. This structure is
  40  *  passed to all MIDI Class driver functions, so that multiple instances of the same class
  41  *  within a device can be differentiated from one another.
  42  */
  43 USB_ClassInfo_MIDI_Host_t Keyboard_MIDI_Interface =
  44         {
  45                 .Config =
  46                         {
  47                                 .DataINPipe             =
  48                                         {
  49                                                 .Address        = (PIPE_DIR_IN  | 1),
  50                                                 .Banks          = 1,
  51                                         },
  52                                 .DataOUTPipe            =
  53                                         {
  54                                                 .Address        = (PIPE_DIR_OUT | 2),
  55                                                 .Banks          = 1,
  56                                         },
  57                         },
  58         };
  59
  60
  61 /** Main program entry point. This routine configures the hardware required by the application, then
  62  *  enters a loop to run the application tasks in sequence.
  63  */
  64 int main(void)
  65 {
  66         SetupHardware();
  67
  68         puts_P(PSTR(ESC_FG_CYAN "MIDI Host Demo running.\r\n" ESC_FG_WHITE));
  69
  70         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
  71         GlobalInterruptEnable();
  72
  73         for (;;)
  74         {
  75                 JoystickHost_Task();
  76
  77                 MIDI_Host_USBTask(&Keyboard_MIDI_Interface);
  78                 USB_USBTask();
  79         }
  80 }
  81
  82 /** Configures the board hardware and chip peripherals for the demo's functionality. */
  83 void SetupHardware(void)
  84 {
  85 #if (ARCH == ARCH_AVR8)
  86         /* Disable watchdog if enabled by bootloader/fuses */
  87         MCUSR &= ~(1 << WDRF);
  88         wdt_disable();
  89
  90         /* Disable clock division */
  91         clock_prescale_set(clock_div_1);
  92 #endif
  93
  94         /* Hardware Initialization */
  95         Serial_Init(9600, false);
  96         LEDs_Init();
  97         Buttons_Init();
  98         Joystick_Init();
  99         USB_Init();
 100
 101         /* Create a stdio stream for the serial port for stdin and stdout */
 102         Serial_CreateStream(NULL);
 103 }
 104
 105 /** Task to manage an enumerated USB MIDI device once connected, to display received
 106  *  note events from the host and send note changes in response to the board's joystick.
 107  */
 108 void JoystickHost_Task(void)
 109 {
 110         if (USB_HostState != HOST_STATE_Configured)
 111           return;
 112
 113         MIDI_EventPacket_t MIDIEvent;
 114         while (MIDI_Host_ReceiveEventPacket(&Keyboard_MIDI_Interface, &MIDIEvent))
 115         {
 116                 bool NoteOnEvent  = (MIDIEvent.Event == MIDI_EVENT(0, MIDI_COMMAND_NOTE_ON));
 117                 bool NoteOffEvent = (MIDIEvent.Event == MIDI_EVENT(0, MIDI_COMMAND_NOTE_OFF));
 118
 119                 /* Display note events from the host */
 120                 if (NoteOnEvent || NoteOffEvent)
 121                 {
 122                         printf_P(PSTR("MIDI Note %s - Channel %d, Pitch %d, Velocity %d\r\n"), NoteOnEvent ? "On" : "Off",
 123                                                                                                                                                                    ((MIDIEvent.Data1 & 0x0F) + 1),
 124                                                                                                                                                                    MIDIEvent.Data2, MIDIEvent.Data3);
 125                 }
 126         }
 127
 128         CheckJoystickMovement();
 129 }
 130
 131 /** Checks for movement of the board's joystick, and sends corresponding MIDI note on/off
 132  *  messages to the host.
 133  */
 134 void CheckJoystickMovement(void)
 135 {
 136         static uint8_t PrevJoystickStatus;
 137
 138         uint8_t MIDICommand = 0;
 139         uint8_t MIDIPitch;
 140
 141         /* Get current joystick mask, XOR with previous to detect joystick changes */
 142         uint8_t JoystickStatus  = Joystick_GetStatus();
 143         uint8_t JoystickChanges = (JoystickStatus ^ PrevJoystickStatus);
 144
 145         /* Get board button status - if pressed use channel 10 (percussion), otherwise use channel 1 */
 146         uint8_t Channel = ((Buttons_GetStatus() & BUTTONS_BUTTON1) ? MIDI_CHANNEL(10) : MIDI_CHANNEL(1));
 147
 148         if (JoystickChanges & JOY_LEFT)
 149         {
 150                 MIDICommand = ((JoystickStatus & JOY_LEFT)? MIDI_COMMAND_NOTE_ON : MIDI_COMMAND_NOTE_OFF);
 151                 MIDIPitch   = 0x3C;
 152         }
 153         else if (JoystickChanges & JOY_UP)
 154         {
 155                 MIDICommand = ((JoystickStatus & JOY_UP)? MIDI_COMMAND_NOTE_ON : MIDI_COMMAND_NOTE_OFF);
 156                 MIDIPitch   = 0x3D;
 157         }
 158         else if (JoystickChanges & JOY_RIGHT)
 159         {
 160                 MIDICommand = ((JoystickStatus & JOY_RIGHT)? MIDI_COMMAND_NOTE_ON : MIDI_COMMAND_NOTE_OFF);
 161                 MIDIPitch   = 0x3E;
 162         }
 163         else if (JoystickChanges & JOY_DOWN)
 164         {
 165                 MIDICommand = ((JoystickStatus & JOY_DOWN)? MIDI_COMMAND_NOTE_ON : MIDI_COMMAND_NOTE_OFF);
 166                 MIDIPitch   = 0x3F;
 167         }
 168         else if (JoystickChanges & JOY_PRESS)
 169         {
 170                 MIDICommand = ((JoystickStatus & JOY_PRESS)? MIDI_COMMAND_NOTE_ON : MIDI_COMMAND_NOTE_OFF);
 171                 MIDIPitch   = 0x3B;
 172         }
 173
 174         if (MIDICommand)
 175         {
 176                 MIDI_EventPacket_t MIDIEvent = (MIDI_EventPacket_t)
 177                         {
 178                                 .Event       = MIDI_EVENT(0, MIDICommand),
 179
 180                                 .Data1       = MIDICommand | Channel,
 181                                 .Data2       = MIDIPitch,
 182                                 .Data3       = MIDI_STANDARD_VELOCITY,
 183                         };
 184
 185                 MIDI_Host_SendEventPacket(&Keyboard_MIDI_Interface, &MIDIEvent);
 186                 MIDI_Host_Flush(&Keyboard_MIDI_Interface);
 187         }
 188
 189         PrevJoystickStatus = JoystickStatus;
 190 }
 191
 192 /** Event handler for the USB_DeviceAttached event. This indicates that a device has been attached to the host, and
 193  *  starts the library USB task to begin the enumeration and USB management process.
 194  */
 195 void EVENT_USB_Host_DeviceAttached(void)
 196 {
 197         puts_P(PSTR("Device Attached.\r\n"));
 198         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 199 }
 200
 201 /** Event handler for the USB_DeviceUnattached event. This indicates that a device has been removed from the host, and
 202  *  stops the library USB task management process.
 203  */
 204 void EVENT_USB_Host_DeviceUnattached(void)
 205 {
 206         puts_P(PSTR("\r\nDevice Unattached.\r\n"));
 207         LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
 208 }
 209
 210 /** Event handler for the USB_DeviceEnumerationComplete event. This indicates that a device has been successfully
 211  *  enumerated by the host and is now ready to be used by the application.
 212  */
 213 void EVENT_USB_Host_DeviceEnumerationComplete(void)
 214 {
 215         LEDs_SetAllLEDs(LEDMASK_USB_ENUMERATING);
 216
 217         uint16_t ConfigDescriptorSize;
 218         uint8_t  ConfigDescriptorData[512];
 219
 220         if (USB_Host_GetDeviceConfigDescriptor(1, &ConfigDescriptorSize, ConfigDescriptorData,
 221                                                sizeof(ConfigDescriptorData)) != HOST_GETCONFIG_Successful)
 222         {
 223                 puts_P(PSTR("Error Retrieving Configuration Descriptor.\r\n"));
 224                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 225                 return;
 226         }
 227
 228         if (MIDI_Host_ConfigurePipes(&Keyboard_MIDI_Interface,
 229                                      ConfigDescriptorSize, ConfigDescriptorData) != MIDI_ENUMERROR_NoError)
 230         {
 231                 puts_P(PSTR("Attached Device Not a Valid MIDI Class Device.\r\n"));
 232                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 233                 return;
 234         }
 235
 236         if (USB_Host_SetDeviceConfiguration(1) != HOST_SENDCONTROL_Successful)
 237         {
 238                 puts_P(PSTR("Error Setting Device Configuration.\r\n"));
 239                 LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 240                 return;
 241         }
 242
 243         puts_P(PSTR("MIDI Device Enumerated.\r\n"));
 244         LEDs_SetAllLEDs(LEDMASK_USB_READY);
 245 }
 246
 247 /** Event handler for the USB_HostError event. This indicates that a hardware error occurred while in host mode. */
 248 void EVENT_USB_Host_HostError(const uint8_t ErrorCode)
 249 {
 250         USB_Disable();
 251
 252         printf_P(PSTR(ESC_FG_RED "Host Mode Error\r\n"
 253                                  " -- Error Code %d\r\n" ESC_FG_WHITE), ErrorCode);
 254
 255         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 256         for(;;);
 257 }
 258
 259 /** Event handler for the USB_DeviceEnumerationFailed event. This indicates that a problem occurred while
 260  *  enumerating an attached USB device.
 261  */
 262 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode,
 263                                             const uint8_t SubErrorCode)
 264 {
 265         printf_P(PSTR(ESC_FG_RED "Dev Enum Error\r\n"
 266                                  " -- Error Code %d\r\n"
 267                                  " -- Sub Error Code %d\r\n"
 268                                  " -- In State %d\r\n" ESC_FG_WHITE), ErrorCode, SubErrorCode, USB_HostState);
 269
 270         LEDs_SetAllLEDs(LEDMASK_USB_ERROR);
 271 }
 272