From d1a5a8f7217827f93c5514c35c4a13236b51f4b4 Mon Sep 17 00:00:00 2001 From: Donald Delmar Davis Date: Fri, 27 Sep 2013 20:03:24 -0700 Subject: minor docs --- README.md | 15 +++++++++++++-- USB_MIDI.c | 1 + 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 152ffaa..895715c 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,22 @@ The goal is twofold 1) to isolate the lower level usb functions from the actual and 2) to create a minimal framework for identifying resetting and loading code onto midi devices. -Packet midi. The majority of the usb-midi specification is in simgle 4 byte events or packets. The exception to this are sysex messages which are arbitrary in length. -Because of this the two streams are split out. +Because of this the two streams are split out between packets and sysex data. Some of the USB susbsystems are +interupt driven. (maple midi zb) and some like lufa are polling based. The data interface must accomidate this. +I am trying to arrive at some glue where the upper layers can provide hooks for the maintainance tasks and +simply provide an interface like this. + +bool MidiEventAvaliable ([interface]) +void GetMidiEvent ([interface]) +void SendMidiEvent ([interface]) +bool SysexAvaliable ([intervace]) +void GetSysex ([interface]) +void SendSysex (uint8_t *messege, [interface] + +The remaining details should be as hidden and interchangable as possible. diff --git a/USB_MIDI.c b/USB_MIDI.c index b1a505d..a2d8f89 100755 --- a/USB_MIDI.c +++ b/USB_MIDI.c @@ -96,6 +96,7 @@ int main(void) } } + /** Configures the board hardware and chip peripherals for the demo's functionality. */ void SetupHardware(void) { -- cgit v1.2.3