Demos/Host/LowLevel/MIDIHost/MIDIHost.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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 disclaim 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  *  Header file for MIDIHost.c.
  34  */
  35
  36 #ifndef _MIDI_HOST_H_
  37 #define _MIDI_HOST_H_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/wdt.h>
  42                 #include <avr/pgmspace.h>
  43                 #include <avr/power.h>
  44                 #include <stdio.h>
  45
  46                 #include <LUFA/Version.h>
  47                 #include <LUFA/Drivers/Misc/TerminalCodes.h>
  48                 #include <LUFA/Drivers/USB/USB.h>
  49                 #include <LUFA/Drivers/Peripheral/SerialStream.h>
  50                 #include <LUFA/Drivers/Board/LEDs.h>
  51                 #include <LUFA/Drivers/Board/Buttons.h>
  52                 #include <LUFA/Drivers/Board/Joystick.h>
  53
  54                 #include "ConfigDescriptor.h"
  55
  56         /* Macros: */
  57                 /** MIDI command for a note on (activation) event */
  58                 #define MIDI_COMMAND_NOTE_ON      0x90
  59
  60                 /** MIDI command for a note off (deactivation) event */
  61                 #define MIDI_COMMAND_NOTE_OFF     0x80
  62
  63                 /** Standard key press velocity value used for all note events, as no pressure sensor is mounted */
  64                 #define MIDI_STANDARD_VELOCITY    64
  65
  66                 /** Convenience macro. MIDI channels are numbered from 1-10 (natural numbers) however the logical channel
  67                  *  addresses are zero-indexed. This converts a natural MIDI channel number into the logical channel address.
  68                  *
  69                  *  \param[in] channel  MIDI channel number to address
  70                  */
  71                 #define MIDI_CHANNEL(channel)     (channel - 1)
  72
  73                 /** Pipe number for the MIDI data IN pipe */
  74                 #define MIDI_DATAPIPE_IN          1
  75
  76                 /** Pipe number for the MIDI data OUT pipe */
  77                 #define MIDI_DATAPIPE_OUT         2
  78
  79                 /** LED mask for the library LED driver, to indicate that the USB interface is not ready. */
  80                 #define LEDMASK_USB_NOTREADY      LEDS_LED1
  81
  82                 /** LED mask for the library LED driver, to indicate that the USB interface is enumerating. */
  83                 #define LEDMASK_USB_ENUMERATING  (LEDS_LED2 | LEDS_LED3)
  84
  85                 /** LED mask for the library LED driver, to indicate that the USB interface is ready. */
  86                 #define LEDMASK_USB_READY        (LEDS_LED2 | LEDS_LED4)
  87
  88                 /** LED mask for the library LED driver, to indicate that an error has occurred in the USB interface. */
  89                 #define LEDMASK_USB_ERROR        (LEDS_LED1 | LEDS_LED3)
  90
  91         /* Type Defines: */
  92                 /** Type define for a USB MIDI event packet, used to encapsulate sent and received MIDI messages from a USB MIDI interface. */
  93                 typedef struct
  94                 {
  95                         unsigned char Command     : 4; /**< MIDI command being sent or received in the event packet */
  96                         unsigned char CableNumber : 4; /**< Virtual cable number of the event being sent or received in the given MIDI interface */
  97
  98                         uint8_t Data1; /**< First byte of data in the MIDI event */
  99                         uint8_t Data2; /**< Second byte of data in the MIDI event */
 100                         uint8_t Data3; /**< Third byte of data in the MIDI event */
 101                 } USB_MIDI_EventPacket_t;
 102
 103         /* Function Prototypes: */
 104                 void SetupHardware(void);
 105                 void MIDI_Host_Task(void);
 106
 107                 void EVENT_USB_Host_HostError(const uint8_t ErrorCode);
 108                 void EVENT_USB_Host_DeviceAttached(void);
 109                 void EVENT_USB_Host_DeviceUnattached(void);
 110                 void EVENT_USB_Host_DeviceEnumerationFailed(const uint8_t ErrorCode, const uint8_t SubErrorCode);
 111                 void EVENT_USB_Host_DeviceEnumerationComplete(void);
 112
 113 #endif