Subversion Repositories svn.mios32

Rev

Rev 690 | Rev 959 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
32 tk 1
// $Id: mios32_midi.c 944 2010-03-06 00:57:46Z tk $
211 tk 2
//! \defgroup MIOS32_MIDI
3
//!
4
//! MIDI layer functions for MIOS32
5
//!
6
//! the mios32_midi_package_t format complies with USB MIDI spec (details see there)
7
//! and is used for transfers between other MIDI ports as well.
8
//!
9
//! \{
10
/* ==========================================================================
32 tk 11
 *
12
 *  Copyright (C) 2008 Thorsten Klose (tk@midibox.org)
13
 *  Licensed for personal non-commercial use only.
14
 *  All other rights reserved.
15
 *
16
 * ==========================================================================
17
 */
18
 
19
/////////////////////////////////////////////////////////////////////////////
20
// Include files
21
/////////////////////////////////////////////////////////////////////////////
22
 
23
#include <mios32.h>
307 tk 24
#include <string.h>
25
#include <stdarg.h>
32 tk 26
 
27
// this module can be optionally disabled in a local mios32_config.h file (included from mios32.h)
28
#if !defined(MIOS32_DONT_USE_MIDI)
29
 
30
 
31
/////////////////////////////////////////////////////////////////////////////
32
// Global variables
33
/////////////////////////////////////////////////////////////////////////////
34
 
211 tk 35
//! this global array is read from MIOS32_IIC_MIDI and MIOS32_UART_MIDI to
36
//! determine the number of MIDI bytes which are part of a package
80 tk 37
const u8 mios32_midi_pcktype_num_bytes[16] = {
38
  0, // 0: invalid/reserved event
39
  0, // 1: invalid/reserved event
40
  2, // 2: two-byte system common messages like MTC, Song Select, etc.
41
  3, // 3: three-byte system common messages like SPP, etc.
42
  3, // 4: SysEx starts or continues
43
  1, // 5: Single-byte system common message or sysex sends with following single byte
44
  2, // 6: SysEx sends with following two bytes
45
  3, // 7: SysEx sends with following three bytes
46
  3, // 8: Note Off
47
  3, // 9: Note On
48
  3, // a: Poly-Key Press
49
  3, // b: Control Change
50
  2, // c: Program Change
51
  2, // d: Channel Pressure
52
  3, // e: PitchBend Change
53
  1  // f: single byte
54
};
32 tk 55
 
211 tk 56
//! Number if expected bytes for a common MIDI event - 1
89 tk 57
const u8 mios32_midi_expected_bytes_common[8] = {
58
  2, // Note On
59
  2, // Note Off
60
  2, // Poly Preasure
61
  2, // Controller
62
  1, // Program Change
63
  1, // Channel Preasure
64
  2, // Pitch Bender
65
  0, // System Message - must be zero, so that mios32_midi_expected_bytes_system[] will be used
66
};
80 tk 67
 
211 tk 68
//! Number if expected bytes for a system MIDI event - 1
89 tk 69
const u8 mios32_midi_expected_bytes_system[16] = {
70
  1, // SysEx Begin (endless until SysEx End F7)
71
  1, // MTC Data frame
72
  2, // Song Position
73
  1, // Song Select
74
  0, // Reserved
75
  0, // Reserved
76
  0, // Request Tuning Calibration
77
  0, // SysEx End
78
 
79
  // Note: just only for documentation, Realtime Messages don't change the running status
80
  0, // MIDI Clock
81
  0, // MIDI Tick
82
  0, // MIDI Start
83
  0, // MIDI Continue
84
  0, // MIDI Stop
85
  0, // Reserved
86
  0, // Active Sense
87
  0, // Reset
88
};
89
 
225 tk 90
//! should only be used by MIOS32 internally and by the Bootloader!
91
const u8 mios32_midi_sysex_header[5] = { 0xf0, 0x00, 0x00, 0x7e, 0x32 };
89 tk 92
 
225 tk 93
 
32 tk 94
/////////////////////////////////////////////////////////////////////////////
225 tk 95
// Local types
96
/////////////////////////////////////////////////////////////////////////////
97
 
98
typedef union {
99
  struct {
100
    unsigned ALL:8;
101
  };
102
 
103
  struct {
104
    unsigned CTR:3;
624 tk 105
    unsigned MY_SYSEX:1;
225 tk 106
    unsigned CMD:1;
107
  };
623 tk 108
 
109
  struct {
110
    unsigned CTR:3;
624 tk 111
    unsigned MY_SYSEX:1;
623 tk 112
    unsigned CMD:1;
113
    unsigned PING_BYTE_RECEIVED;
114
  };
225 tk 115
} sysex_state_t;
116
 
117
 
550 tk 118
typedef union {
119
  struct {
120
    unsigned ALL:32;
121
  };
122
 
123
  struct {
124
    unsigned usb_receives:16;
125
    unsigned iic_receives:16;
126
  };
127
} sysex_timeout_ctr_flags_t;
128
 
129
 
225 tk 130
/////////////////////////////////////////////////////////////////////////////
32 tk 131
// Local variables
132
/////////////////////////////////////////////////////////////////////////////
133
 
225 tk 134
static mios32_midi_port_t default_port = MIOS32_MIDI_DEFAULT_PORT;
307 tk 135
static mios32_midi_port_t debug_port   = MIOS32_MIDI_DEBUG_PORT;
225 tk 136
 
281 tk 137
static s32 (*direct_rx_callback_func)(mios32_midi_port_t port, u8 midi_byte);
138
static s32 (*direct_tx_callback_func)(mios32_midi_port_t port, mios32_midi_package_t package);
674 tk 139
static s32 (*sysex_callback_func)(mios32_midi_port_t port, u8 sysex_byte);
529 tk 140
static s32 (*timeout_callback_func)(mios32_midi_port_t port);
582 tk 141
static s32 (*debug_command_callback_func)(mios32_midi_port_t port, char c);
32 tk 142
 
225 tk 143
static sysex_state_t sysex_state;
144
static u8 sysex_device_id;
145
static u8 sysex_cmd;
146
static mios32_midi_port_t last_sysex_port = DEFAULT;
155 tk 147
 
225 tk 148
 
550 tk 149
// SysEx timeout counter: in order to save memory and execution time, we only
150
// protect a single SysEx stream for packet oriented interfaces.
151
// Serial interfaces (UART) are protected separately -> see MIOS32_UART_MIDI_PackageReceive
152
// Approach: the first interface which sends F0 resets the timeout counter.
153
// The flag is reset with F7
154
// Once one second has passed, and the flag is still set, MIOS32_MIDI_TimeOut() will
155
// be called to notify the failure.
156
// Drawback: if another interface starts a SysEx transfer at the same time, the stream
157
// will be ignored, and a timeout won't be detected.
158
// It's unlikely that this is an issue in practice, especially if SysEx parsers only
159
// take streams of the first interface which sends F0 like MIOS32_MIDI_SYSEX_Parser()...
160
//
161
// If a stronger protection is desired (SysEx parser handles streams of multiple interfaces),
162
// it's recommented to implement a separate timeout mechanism at application side.
163
static u16 sysex_timeout_ctr;
164
static sysex_timeout_ctr_flags_t sysex_timeout_ctr_flags;
165
 
166
 
32 tk 167
/////////////////////////////////////////////////////////////////////////////
225 tk 168
// Local prototypes
169
/////////////////////////////////////////////////////////////////////////////
170
 
171
static s32 MIOS32_MIDI_SYSEX_Parser(mios32_midi_port_t port, u8 midi_in);
172
static s32 MIOS32_MIDI_SYSEX_CmdFinished(void);
173
static s32 MIOS32_MIDI_SYSEX_Cmd(mios32_midi_port_t port, mios32_midi_sysex_cmd_state_t cmd_state, u8 midi_in);
230 tk 174
static s32 MIOS32_MIDI_SYSEX_Cmd_Query(mios32_midi_port_t port, mios32_midi_sysex_cmd_state_t cmd_state, u8 midi_in);
582 tk 175
static s32 MIOS32_MIDI_SYSEX_Cmd_Debug(mios32_midi_port_t port, mios32_midi_sysex_cmd_state_t cmd_state, u8 midi_in);
225 tk 176
static s32 MIOS32_MIDI_SYSEX_Cmd_Ping(mios32_midi_port_t port, mios32_midi_sysex_cmd_state_t cmd_state, u8 midi_in);
177
static s32 MIOS32_MIDI_SYSEX_SendAck(mios32_midi_port_t port, u8 ack_code, u8 ack_arg);
230 tk 178
static s32 MIOS32_MIDI_SYSEX_SendAckStr(mios32_midi_port_t port, char *str);
529 tk 179
static s32 MIOS32_MIDI_TimeOut(mios32_midi_port_t port);
225 tk 180
 
181
 
182
/////////////////////////////////////////////////////////////////////////////
211 tk 183
//! Initializes MIDI layer
184
//! \param[in] mode currently only mode 0 supported
185
//! \return < 0 if initialisation failed
32 tk 186
/////////////////////////////////////////////////////////////////////////////
187
s32 MIOS32_MIDI_Init(u32 mode)
188
{
189
  s32 ret = 0;
190
 
110 tk 191
  // currently only mode 0 supported
192
  if( mode != 0 )
32 tk 193
    return -1; // unsupported mode
194
 
307 tk 195
  // set default/debug port as defined in mios32.h/mios32_config.h
225 tk 196
  default_port = MIOS32_MIDI_DEFAULT_PORT;
307 tk 197
  debug_port = MIOS32_MIDI_DEBUG_PORT;
225 tk 198
 
582 tk 199
  // disable callback functions
155 tk 200
  direct_rx_callback_func = NULL;
201
  direct_tx_callback_func = NULL;
674 tk 202
  sysex_callback_func = NULL;
203
  timeout_callback_func = NULL;
582 tk 204
  debug_command_callback_func = NULL;
529 tk 205
 
155 tk 206
  // initialize interfaces
101 tk 207
#if !defined(MIOS32_DONT_USE_USB) && !defined(MIOS32_DONT_USE_USB_MIDI)
110 tk 208
  if( MIOS32_USB_MIDI_Init(0) < 0 )
32 tk 209
    ret |= (1 << 0);
210
#endif
211
 
80 tk 212
#if !defined(MIOS32_DONT_USE_UART) && !defined(MIOS32_DONT_USE_UART_MIDI)
110 tk 213
  if( MIOS32_UART_MIDI_Init(0) < 0 )
80 tk 214
    ret |= (1 << 1);
215
#endif
216
 
78 tk 217
#if !defined(MIOS32_DONT_USE_IIC) && !defined(MIOS32_DONT_USE_IIC_MIDI)
110 tk 218
  if( MIOS32_IIC_MIDI_Init(0) < 0 )
80 tk 219
    ret |= (1 << 2);
78 tk 220
#endif
221
 
225 tk 222
  last_sysex_port = DEFAULT;
223
  sysex_state.ALL = 0;
224
 
225
  // TODO: allow to change device ID (read from flash, resp. BSL based EEPROM emulation)
226
  sysex_device_id = 0x00;
227
 
550 tk 228
  // SysEx timeout mechanism
229
  sysex_timeout_ctr = 0;
230
  sysex_timeout_ctr_flags.ALL = 0;
231
 
32 tk 232
  return -ret;
233
}
234
 
235
 
236
/////////////////////////////////////////////////////////////////////////////
211 tk 237
//! This function checks the availability of a MIDI port
238
//! \param[in] port MIDI port (DEFAULT, USB0..USB7, UART0..UART1, IIC0..IIC7)
239
//! \return 1: port available
240
//! \return 0: port not available
78 tk 241
/////////////////////////////////////////////////////////////////////////////
242
s32 MIOS32_MIDI_CheckAvailable(mios32_midi_port_t port)
243
{
307 tk 244
  // if default/debug port: select mapped port
78 tk 245
  if( !(port & 0xf0) ) {
307 tk 246
    port = (port == MIDI_DEBUG) ? debug_port : default_port;
78 tk 247
  }
248
 
249
  // branch depending on selected port
550 tk 250
  switch( port & 0xf0 ) {
251
    case USB0://..15
78 tk 252
#if !defined(MIOS32_DONT_USE_USB) && !defined(MIOS32_DONT_USE_USB_MIDI)
253
      return MIOS32_USB_MIDI_CheckAvailable();
254
#else
255
      return 0; // USB has been disabled
256
#endif
257
 
550 tk 258
    case UART0://..15
80 tk 259
#if !defined(MIOS32_DONT_USE_UART) && !defined(MIOS32_DONT_USE_UART_MIDI)
260
      return MIOS32_UART_MIDI_CheckAvailable(port & 0xf);
261
#else
262
      return 0; // UART_MIDI has been disabled
263
#endif
78 tk 264
 
550 tk 265
    case IIC0://..15
78 tk 266
#if !defined(MIOS32_DONT_USE_IIC) && !defined(MIOS32_DONT_USE_IIC_MIDI)
267
      return MIOS32_IIC_MIDI_CheckAvailable(port & 0xf);
268
#else
269
      return 0; // IIC_MIDI has been disabled
270
#endif
271
  }
528 tk 272
 
273
  return 0; // invalid port
78 tk 274
}
275
 
276
 
277
/////////////////////////////////////////////////////////////////////////////
528 tk 278
//! This function enables/disables running status optimisation for a given
279
//! MIDI OUT port to improve bandwidth if MIDI events with the same
280
//! status byte are sent back-to-back.<BR>
281
//! The optimisation is currently only used for UART based port (enabled by
282
//! default), IIC: TODO, USB: not required).
283
//! \param[in] port MIDI port (DEFAULT, USB0..USB7, UART0..UART1, IIC0..IIC7)
284
//! \param[in] enable 0=optimisation disabled, 1=optimisation enabled
285
//! \return -1 if port not available or if it doesn't support running status
286
//! \return 0 on success
287
/////////////////////////////////////////////////////////////////////////////
288
s32 MIOS32_MIDI_RS_OptimisationSet(mios32_midi_port_t port, u8 enable)
289
{
290
  // if default/debug port: select mapped port
291
  if( !(port & 0xf0) ) {
292
    port = (port == MIDI_DEBUG) ? debug_port : default_port;
293
  }
294
 
295
  // branch depending on selected port
550 tk 296
  switch( port & 0xf0 ) {
297
    case USB0://..15
528 tk 298
      return -1; // not required for USB
299
 
550 tk 300
    case UART0://..15
528 tk 301
#if !defined(MIOS32_DONT_USE_UART) && !defined(MIOS32_DONT_USE_UART_MIDI)
302
      return MIOS32_UART_MIDI_RS_OptimisationSet(port & 0xf, enable);
303
#else
304
      return -1; // UART_MIDI has been disabled
305
#endif
306
 
550 tk 307
    case IIC0://..15
528 tk 308
#if !defined(MIOS32_DONT_USE_IIC) && !defined(MIOS32_DONT_USE_IIC_MIDI)
309
      return MIOS32_IIC_MIDI_RS_OptimisationSet(port & 0xf, enable);
310
#else
311
      return -1; // IIC_MIDI has been disabled
312
#endif
313
  }
314
 
315
  return -1; // invalid port
316
}
317
 
318
 
319
/////////////////////////////////////////////////////////////////////////////
320
//! This function returns the running status optimisation enable/disable flag
321
//! for the given MIDI OUT port.
322
//! \param[in] port MIDI port (DEFAULT, USB0..USB7, UART0..UART1, IIC0..IIC7)
323
//! \return -1 if port not available or if it doesn't support running status
324
//! \return 0 if optimisation disabled
325
//! \return 1 if optimisation enabled
326
/////////////////////////////////////////////////////////////////////////////
327
s32 MIOS32_MIDI_RS_OptimisationGet(mios32_midi_port_t port)
328
{
329
  // if default/debug port: select mapped port
330
  if( !(port & 0xf0) ) {
331
    port = (port == MIDI_DEBUG) ? debug_port : default_port;
332
  }
333
 
334
  // branch depending on selected port
550 tk 335
  switch( port & 0xf0 ) {
336
    case USB0://..15
528 tk 337
      return -1; // not required for USB
338
 
550 tk 339
    case UART0://..15
528 tk 340
#if !defined(MIOS32_DONT_USE_UART) && !defined(MIOS32_DONT_USE_UART_MIDI)
341
      return MIOS32_UART_MIDI_RS_OptimisationGet(port & 0xf);
342
#else
343
      return -1; // UART_MIDI has been disabled
344
#endif
345
 
550 tk 346
    case IIC0://..15
528 tk 347
#if !defined(MIOS32_DONT_USE_IIC) && !defined(MIOS32_DONT_USE_IIC_MIDI)
348
      return MIOS32_IIC_MIDI_RS_OptimisationGet(port & 0xf);
349
#else
350
      return -1; // IIC_MIDI has been disabled
351
#endif
352
  }
353
 
354
  return -1; // invalid port
355
}
356
 
357
 
358
/////////////////////////////////////////////////////////////////////////////
359
//! This function resets the current running status, so that it will be sent
360
//! again with the next MIDI Out package.
361
//! \param[in] port MIDI port (DEFAULT, USB0..USB7, UART0..UART1, IIC0..IIC7)
362
//! \return -1 if port not available or if it doesn't support running status
363
//! \return 0 if optimisation disabled
364
//! \return 1 if optimisation enabled
365
/////////////////////////////////////////////////////////////////////////////
366
s32 MIOS32_MIDI_RS_Reset(mios32_midi_port_t port)
367
{
368
  // if default/debug port: select mapped port
369
  if( !(port & 0xf0) ) {
370
    port = (port == MIDI_DEBUG) ? debug_port : default_port;
371
  }
372
 
373
  // branch depending on selected port
550 tk 374
  switch( port & 0xf0 ) {
375
    case USB0://..15
528 tk 376
      return -1; // not required for USB
377
 
550 tk 378
    case UART0://..15
528 tk 379
#if !defined(MIOS32_DONT_USE_UART) && !defined(MIOS32_DONT_USE_UART_MIDI)
380
      return MIOS32_UART_MIDI_RS_Reset(port & 0xf);
381
#else
382
      return -1; // UART_MIDI has been disabled
383
#endif
384
 
550 tk 385
    case IIC0://..15
528 tk 386
#if !defined(MIOS32_DONT_USE_IIC) && !defined(MIOS32_DONT_USE_IIC_MIDI)
387
      return MIOS32_IIC_MIDI_RS_Reset(port & 0xf);
388
#else
389
      return -1; // IIC_MIDI has been disabled
390
#endif
391
  }
392
 
393
  return -1; // invalid port
394
}
395
 
396
 
397
/////////////////////////////////////////////////////////////////////////////
211 tk 398
//! Sends a package over given port
281 tk 399
//!
211 tk 400
//! This is a low level function. In difference to other MIOS32_MIDI_Send* functions,
401
//! It allows to send packages in non-blocking mode (caller has to retry if -2 is returned)
281 tk 402
//!
403
//! Before the package is forwarded, an optional Tx Callback function will be called
404
//! which allows to filter/monitor/route the package, or extend the MIDI transmitter
405
//! by custom MIDI Output ports (e.g. for internal busses, OSC, AOUT, etc.)
211 tk 406
//! \param[in] port MIDI port (DEFAULT, USB0..USB7, UART0..UART1, IIC0..IIC7)
407
//! \param[in] package MIDI package
408
//! \return -1 if port not available
409
//! \return -2 buffer is full
410
//!         caller should retry until buffer is free again
281 tk 411
//! \return -3 Tx Callback reported an error
412
//! \return 1 if package has been filtered by Tx callback
211 tk 413
//! \return 0 on success
110 tk 414
/////////////////////////////////////////////////////////////////////////////
415
s32 MIOS32_MIDI_SendPackage_NonBlocking(mios32_midi_port_t port, mios32_midi_package_t package)
416
{
307 tk 417
  // if default/debug port: select mapped port
110 tk 418
  if( !(port & 0xf0) ) {
307 tk 419
    port = (port == MIDI_DEBUG) ? debug_port : default_port;
110 tk 420
  }
421
 
422
  // insert subport number into package
423
  package.cable = port & 0xf;
424
 
281 tk 425
  // forward to Tx callback function and break if package has been filtered
426
  if( direct_tx_callback_func != NULL ) {
427
    s32 status;
425 tk 428
    if( (status=direct_tx_callback_func(port, package)) )
281 tk 429
      return status;
430
  }
431
 
110 tk 432
  // branch depending on selected port
550 tk 433
  switch( port & 0xf0 ) {
434
    case USB0://..15
110 tk 435
#if !defined(MIOS32_DONT_USE_USB) && !defined(MIOS32_DONT_USE_USB_MIDI)
191 tk 436
      return MIOS32_USB_MIDI_PackageSend_NonBlocking(package);
110 tk 437
#else
438
      return -1; // USB has been disabled
439
#endif
440
 
550 tk 441
    case UART0://..15
110 tk 442
#if !defined(MIOS32_DONT_USE_UART) && !defined(MIOS32_DONT_USE_UART_MIDI)
443
      return MIOS32_UART_MIDI_PackageSend_NonBlocking(package.cable, package);
444
#else
445
      return -1; // UART_MIDI has been disabled
446
#endif
447
 
550 tk 448
    case IIC0://..15
110 tk 449
#if !defined(MIOS32_DONT_USE_IIC) && !defined(MIOS32_DONT_USE_IIC_MIDI)
450
      return MIOS32_IIC_MIDI_PackageSend_NonBlocking(package.cable, package);
451
#else
452
      return -1; // IIC_MIDI has been disabled
453
#endif
454
 
455
    default:
456
      // invalid port
457
      return -1;
458
  }
459
}
460
 
461
 
462
/////////////////////////////////////////////////////////////////////////////
211 tk 463
//! Sends a package over given port
464
//! This is a low level function - use the remaining MIOS32_MIDI_Send* functions
465
//! to send specific MIDI events
466
//! (blocking function)
467
//! \param[in] port MIDI port (DEFAULT, USB0..USB7, UART0..UART1, IIC0..IIC7)
468
//! \param[in] package MIDI package
469
//! \return -1 if port not available
470
//! \return 0 on success
32 tk 471
/////////////////////////////////////////////////////////////////////////////
69 tk 472
s32 MIOS32_MIDI_SendPackage(mios32_midi_port_t port, mios32_midi_package_t package)
32 tk 473
{
307 tk 474
  // if default/debug port: select mapped port
80 tk 475
  if( !(port & 0xf0) ) {
307 tk 476
    port = (port == MIDI_DEBUG) ? debug_port : default_port;
80 tk 477
  }
478
 
32 tk 479
  // insert subport number into package
89 tk 480
  package.cable = port & 0xf;
32 tk 481
 
301 tk 482
  // forward to Tx callback function and break if package has been filtered
483
  if( direct_tx_callback_func != NULL ) {
484
    s32 status;
425 tk 485
    if( (status=direct_tx_callback_func(port, package)) )
301 tk 486
      return status;
487
  }
488
 
32 tk 489
  // branch depending on selected port
550 tk 490
  switch( port & 0xf0 ) {
491
    case USB0://..15
78 tk 492
#if !defined(MIOS32_DONT_USE_USB) && !defined(MIOS32_DONT_USE_USB_MIDI)
191 tk 493
      return MIOS32_USB_MIDI_PackageSend(package);
32 tk 494
#else
495
      return -1; // USB has been disabled
496
#endif
497
 
550 tk 498
    case UART0://..15
80 tk 499
#if !defined(MIOS32_DONT_USE_UART) && !defined(MIOS32_DONT_USE_UART_MIDI)
500
      return MIOS32_UART_MIDI_PackageSend(package.cable, package);
501
#else
502
      return -1; // UART_MIDI has been disabled
503
#endif
32 tk 504
 
550 tk 505
    case IIC0://..15
78 tk 506
#if !defined(MIOS32_DONT_USE_IIC) && !defined(MIOS32_DONT_USE_IIC_MIDI)
507
      return MIOS32_IIC_MIDI_PackageSend(package.cable, package);
508
#else
509
      return -1; // IIC_MIDI has been disabled
510
#endif
32 tk 511
 
512
    default:
513
      // invalid port
514
      return -1;
515
  }
516
}
517
 
518
 
519
/////////////////////////////////////////////////////////////////////////////
211 tk 520
//! Sends a MIDI Event
521
//! This function is provided for a more comfortable use model
522
//!    o MIOS32_MIDI_SendNoteOff(port, chn, note, vel)
523
//!    o MIOS32_MIDI_SendNoteOn(port, chn, note, vel)
524
//!    o MIOS32_MIDI_SendPolyAftertouch(port, chn, note, val)
525
//!    o MIOS32_MIDI_SendCC(port, chn, cc, val)
526
//!    o MIOS32_MIDI_SendProgramChange(port, chn, prg)
527
//!    o MIOS32_MIDI_ChannelAftertouch(port, chn, val)
528
//!    o MIOS32_MIDI_PitchBend(port, chn, val)
529
//!
530
//! \param[in] port MIDI port (DEFAULT, USB0..USB7, UART0..UART1, IIC0..IIC7)
531
//! \param[in] evnt0 first MIDI byte
225 tk 532
//! \param[in] evnt1 second MIDI byte
533
//! \param[in] evnt2 third MIDI byte
211 tk 534
//! \return -1 if port not available
535
//! \return 0 on success
32 tk 536
/////////////////////////////////////////////////////////////////////////////
69 tk 537
s32 MIOS32_MIDI_SendEvent(mios32_midi_port_t port, u8 evnt0, u8 evnt1, u8 evnt2)
32 tk 538
{
33 tk 539
  mios32_midi_package_t package;
540
 
541
  // MEMO: don't optimize this function by calling MIOS32_MIDI_SendSpecialEvent
542
  // from here, because the 4 * u8 parameter list of this function leads
543
  // to best compile results (4*u8 combined to a single u32)
544
 
545
  package.type  = evnt0 >> 4;
546
  package.evnt0 = evnt0;
547
  package.evnt1 = evnt1;
548
  package.evnt2 = evnt2;
549
  return MIOS32_MIDI_SendPackage(port, package);
32 tk 550
}
551
 
69 tk 552
s32 MIOS32_MIDI_SendNoteOff(mios32_midi_port_t port, mios32_midi_chn_t chn, u8 note, u8 vel)
136 tk 553
{ return MIOS32_MIDI_SendEvent(port, 0x80 | chn, note, vel); }
32 tk 554
 
69 tk 555
s32 MIOS32_MIDI_SendNoteOn(mios32_midi_port_t port, mios32_midi_chn_t chn, u8 note, u8 vel)
136 tk 556
{ return MIOS32_MIDI_SendEvent(port, 0x90 | chn, note, vel); }
69 tk 557
 
558
s32 MIOS32_MIDI_SendPolyPressure(mios32_midi_port_t port, mios32_midi_chn_t chn, u8 note, u8 val)
136 tk 559
{ return MIOS32_MIDI_SendEvent(port, 0xa0 | chn, note, val); }
69 tk 560
 
681 tk 561
s32 MIOS32_MIDI_SendCC(mios32_midi_port_t port, mios32_midi_chn_t chn, u8 cc_number, u8 val)
562
{ return MIOS32_MIDI_SendEvent(port, 0xb0 | chn, cc_number,   val); }
69 tk 563
 
564
s32 MIOS32_MIDI_SendProgramChange(mios32_midi_port_t port, mios32_midi_chn_t chn, u8 prg)
136 tk 565
{ return MIOS32_MIDI_SendEvent(port, 0xc0 | chn, prg,  0x00); }
69 tk 566
 
567
s32 MIOS32_MIDI_SendAftertouch(mios32_midi_port_t port, mios32_midi_chn_t chn, u8 val)
136 tk 568
{ return MIOS32_MIDI_SendEvent(port, 0xd0 | chn, val,  0x00); }
69 tk 569
 
570
s32 MIOS32_MIDI_SendPitchBend(mios32_midi_port_t port, mios32_midi_chn_t chn, u16 val)
136 tk 571
{ return MIOS32_MIDI_SendEvent(port, 0xe0 | chn, val & 0x7f, val >> 7); }
69 tk 572
 
573
 
33 tk 574
/////////////////////////////////////////////////////////////////////////////
211 tk 575
//! Sends a special type MIDI Event
576
//! This function is provided for a more comfortable use model
577
//! It is aliased to following functions
578
//!    o MIOS32_MIDI_SendMTC(port, val)
579
//!    o MIOS32_MIDI_SendSongPosition(port, val)
580
//!    o MIOS32_MIDI_SendSongSelect(port, val)
581
//!    o MIOS32_MIDI_SendTuneRequest()
582
//!    o MIOS32_MIDI_SendClock()
583
//!    o MIOS32_MIDI_SendTick()
584
//!    o MIOS32_MIDI_SendStart()
585
//!    o MIOS32_MIDI_SendStop()
586
//!    o MIOS32_MIDI_SendContinue()
587
//!    o MIOS32_MIDI_SendActiveSense()
588
//!    o MIOS32_MIDI_SendReset()
589
//!
590
//! \param[in] port MIDI port (DEFAULT, USB0..USB7, UART0..UART1, IIC0..IIC7)
591
//! \param[in] type the event type
592
//! \param[in] evnt0 first MIDI byte
225 tk 593
//! \param[in] evnt1 second MIDI byte
594
//! \param[in] evnt2 third MIDI byte
211 tk 595
//! \return -1 if port not available
596
//! \return 0 on success
33 tk 597
/////////////////////////////////////////////////////////////////////////////
69 tk 598
s32 MIOS32_MIDI_SendSpecialEvent(mios32_midi_port_t port, u8 type, u8 evnt0, u8 evnt1, u8 evnt2)
33 tk 599
{
600
  mios32_midi_package_t package;
601
 
602
  package.type  = type;
603
  package.evnt0 = evnt0;
604
  package.evnt1 = evnt1;
605
  package.evnt2 = evnt2;
606
  return MIOS32_MIDI_SendPackage(port, package);
607
}
608
 
609
 
69 tk 610
s32 MIOS32_MIDI_SendMTC(mios32_midi_port_t port, u8 val)
136 tk 611
{ return MIOS32_MIDI_SendSpecialEvent(port, 0x2, 0xf1, val, 0x00); }
69 tk 612
 
613
s32 MIOS32_MIDI_SendSongPosition(mios32_midi_port_t port, u16 val)
136 tk 614
{ return MIOS32_MIDI_SendSpecialEvent(port, 0x3, 0xf2, val & 0x7f, val >> 7); }
69 tk 615
 
616
s32 MIOS32_MIDI_SendSongSelect(mios32_midi_port_t port, u8 val)
136 tk 617
{ return MIOS32_MIDI_SendSpecialEvent(port, 0x2, 0xf3, val, 0x00); }
69 tk 618
 
619
s32 MIOS32_MIDI_SendTuneRequest(mios32_midi_port_t port)
136 tk 620
{ return MIOS32_MIDI_SendSpecialEvent(port, 0x5, 0xf6, 0x00, 0x00); }
69 tk 621
 
622
s32 MIOS32_MIDI_SendClock(mios32_midi_port_t port)
136 tk 623
{ return MIOS32_MIDI_SendSpecialEvent(port, 0x5, 0xf8, 0x00, 0x00); }
69 tk 624
 
625
s32 MIOS32_MIDI_SendTick(mios32_midi_port_t port)
136 tk 626
{ return MIOS32_MIDI_SendSpecialEvent(port, 0x5, 0xf9, 0x00, 0x00); }
69 tk 627
 
628
s32 MIOS32_MIDI_SendStart(mios32_midi_port_t port)
136 tk 629
{ return MIOS32_MIDI_SendSpecialEvent(port, 0x5, 0xfa, 0x00, 0x00); }
69 tk 630
 
397 stryd_one 631
s32 MIOS32_MIDI_SendContinue(mios32_midi_port_t port)
136 tk 632
{ return MIOS32_MIDI_SendSpecialEvent(port, 0x5, 0xfb, 0x00, 0x00); }
69 tk 633
 
397 stryd_one 634
s32 MIOS32_MIDI_SendStop(mios32_midi_port_t port)
136 tk 635
{ return MIOS32_MIDI_SendSpecialEvent(port, 0x5, 0xfc, 0x00, 0x00); }
69 tk 636
 
637
s32 MIOS32_MIDI_SendActiveSense(mios32_midi_port_t port)
136 tk 638
{ return MIOS32_MIDI_SendSpecialEvent(port, 0x5, 0xfe, 0x00, 0x00); }
69 tk 639
 
640
s32 MIOS32_MIDI_SendReset(mios32_midi_port_t port)
136 tk 641
{ return MIOS32_MIDI_SendSpecialEvent(port, 0x5, 0xff, 0x00, 0x00); }
69 tk 642
 
643
 
33 tk 644
/////////////////////////////////////////////////////////////////////////////
211 tk 645
//! Sends a SysEx Stream
307 tk 646
//!
211 tk 647
//! This function is provided for a more comfortable use model
648
//! \param[in] port MIDI port (DEFAULT, USB0..USB7, UART0..UART1, IIC0..IIC7)
649
//! \param[in] stream pointer to SysEx stream
650
//! \param[in] count number of bytes
651
//! \return -1 if port not available
652
//! \return 0 on success
33 tk 653
/////////////////////////////////////////////////////////////////////////////
69 tk 654
s32 MIOS32_MIDI_SendSysEx(mios32_midi_port_t port, u8 *stream, u32 count)
33 tk 655
{
656
  s32 res;
657
  u32 offset;
658
  mios32_midi_package_t package;
659
 
660
  // MEMO: have a look into the project.lss file - gcc optimizes this code pretty well :)
661
 
662
  for(offset=0; offset<count;) {
663
    // package type depends on number of remaining bytes
664
    switch( count-offset ) {
665
      case 1:
666
    package.type = 0x5; // SysEx ends with following single byte. 
667
    package.evnt0 = stream[offset++];
668
    package.evnt1 = 0x00;
669
    package.evnt2 = 0x00;
670
    break;
671
      case 2:
672
    package.type = 0x6; // SysEx ends with following two bytes.
673
    package.evnt0 = stream[offset++];
674
    package.evnt1 = stream[offset++];
675
    package.evnt2 = 0x00;
676
    break;
677
      case 3:
678
    package.type = 0x7; // SysEx ends with following three bytes. 
679
    package.evnt0 = stream[offset++];
680
    package.evnt1 = stream[offset++];
681
    package.evnt2 = stream[offset++];
682
    break;
683
      default:
684
    package.type = 0x4; // SysEx starts or continues
685
    package.evnt0 = stream[offset++];
686
    package.evnt1 = stream[offset++];
687
    package.evnt2 = stream[offset++];
688
    }
689
 
110 tk 690
    res=MIOS32_MIDI_SendPackage(port, package);
33 tk 691
 
110 tk 692
    // expection? (e.g., port not available)
33 tk 693
    if( res < 0 )
694
      return res;
695
  }
696
 
697
  return 0;
698
}
699
 
700
 
701
/////////////////////////////////////////////////////////////////////////////
307 tk 702
//! Sends a formatted Debug Message to the MIOS Terminal in MIOS Studio.
703
//!
704
//! Formatting parameters are like known from printf, e.g.
705
//! \code
706
//!   MIOS32_MIDI_SendDebugMessage("Button %d %s\n", button, value ? "depressed" : "pressed");
707
//! \endcode
708
//!
709
//! The MIDI port used for debugging (MIDI_DEBUG) can be declared in mios32_config.h:
710
//! \code
711
//!   #define MIOS32_MIDI_DEBUG_PORT USB0
712
//! \endcode
713
//! (USB0 is the default value)
714
//!
715
//! Optionally, the port can be changed during runtime with MIOS32_MIDI_DebugPortSet
550 tk 716
//!
717
//! Please note that the resulting string shouldn't be longer than 128 characters!<BR>
718
//! If the *format string is already longer than 100 characters an error message will
719
//! be sent to notify about the programming error.<BR>
720
//! The limit is set to save allocated stack memory! Just reduce the formated string to
721
//! print out the intended message.
307 tk 722
//! \param[in] *format zero-terminated format string - 128 characters supported maximum!
723
//! \param ... additional arguments
724
//! \return < 0 on errors
725
/////////////////////////////////////////////////////////////////////////////
726
s32 MIOS32_MIDI_SendDebugMessage(char *format, ...)
727
{
728
  u8 buffer[128+5+3+1]; // 128 chars allowed + 5 for header + 3 for command + F7
729
  va_list args;
730
  int i;
731
 
550 tk 732
  // failsave: if format string is longer than 100 chars, break here
733
  // note that this is a weak protection: if %s is used, or a lot of other format tokens,
734
  // the resulting string could still lead to a buffer overflow
735
  // other the other hand we don't want to allocate too many byte for buffer[] to save stack
736
  char *str = (char *)((size_t)buffer+sizeof(mios32_midi_sysex_header)+3);
737
  if( strlen(format) > 100 ) {
738
    strcpy(str, "(ERROR: string passed to MIOS32_MIDI_SendDebugMessage() is longer than 100 chars!\n");
739
  } else {
740
    // transform formatted string into string
741
    va_start(args, format);
742
    vsprintf(str, format, args);
743
  }
307 tk 744
 
745
  u8 *sysex_buffer_ptr = buffer;
746
  for(i=0; i<sizeof(mios32_midi_sysex_header); ++i)
747
    *sysex_buffer_ptr++ = mios32_midi_sysex_header[i];
748
 
749
  // device ID
750
  *sysex_buffer_ptr++ = MIOS32_MIDI_DeviceIDGet();
751
 
752
  // debug message: ack code
753
  *sysex_buffer_ptr++ = MIOS32_MIDI_SYSEX_DEBUG;
754
 
755
  // command identifier
582 tk 756
  *sysex_buffer_ptr++ = 0x40; // output string
307 tk 757
 
758
  // search end of string and determine length
759
  u16 len = sizeof(mios32_midi_sysex_header) + 3;
760
  for(i=0; i<128 && (*sysex_buffer_ptr != 0); ++i) {
761
    *sysex_buffer_ptr++ &= 0x7f; // ensure that MIDI protocol won't be violated
762
    ++len;
763
  }
764
 
765
  // send footer
766
  *sysex_buffer_ptr++ = 0xf7;
767
  ++len;
768
 
769
  return MIOS32_MIDI_SendSysEx(debug_port, buffer, len);
770
}
771
 
772
 
773
/////////////////////////////////////////////////////////////////////////////
369 tk 774
//! Sends an hex dump (formatted representation of memory content) to the 
775
//! MIOS Terminal in MIOS Studio.
776
//!
777
//! The MIDI port used for debugging (MIDI_DEBUG) can be declared in mios32_config.h:
778
//! \code
779
//!   #define MIOS32_MIDI_DEBUG_PORT USB0
780
//! \endcode
781
//! (USB0 is the default value)
782
//!
783
//! Optionally, the port can be changed during runtime with MIOS32_MIDI_DebugPortSet
784
//! \param[in] *src pointer to memory location which should be dumped
785
//! \param[in] len number of bytes which should be sent
786
//! \return < 0 on errors
787
/////////////////////////////////////////////////////////////////////////////
788
s32 MIOS32_MIDI_SendDebugHexDump(u8 *src, u32 len)
789
{
790
  // check if any byte has to be sent
791
  if( !len )
792
    return 0;
793
 
794
  // send hex dump line by line
370 tk 795
  u8 *src_begin = src;
369 tk 796
  u8 *src_end;
797
  for(src_end=(u8 *)((size_t)src + len - 1); src < src_end;) {
376 tk 798
    u8 buffer[80+5+3+1]; // we need at least 8+2+3*16+2+16+1 chars + 5 for header + 3 for command + F7
369 tk 799
    int i;
800
 
801
    // create SysEx header
802
    u8 *sysex_buffer_ptr = buffer;
803
    for(i=0; i<sizeof(mios32_midi_sysex_header); ++i)
804
      *sysex_buffer_ptr++ = mios32_midi_sysex_header[i];
805
 
806
    // device ID
807
    *sysex_buffer_ptr++ = MIOS32_MIDI_DeviceIDGet();
808
 
809
    // debug message: ack code
810
    *sysex_buffer_ptr++ = MIOS32_MIDI_SYSEX_DEBUG;
811
 
812
    // command identifier
582 tk 813
    *sysex_buffer_ptr++ = 0x40; // output string
369 tk 814
 
815
    // build line:
816
    // add source address
374 tk 817
    sprintf((char *)sysex_buffer_ptr, "%08X ", (u32)(src-src_begin));
818
    sysex_buffer_ptr += 9;
369 tk 819
 
820
    // add up to 16 bytes
821
    u8 *src_chars = src; // for later
822
    for(i=0; i<16; ++i) {
374 tk 823
      sprintf((char *)sysex_buffer_ptr, (src <= src_end) ? " %02X" : "   ", *src);
824
      sysex_buffer_ptr += 3;
369 tk 825
 
826
      ++src;
827
    }
828
 
829
    // add two spaces
374 tk 830
    for(i=0; i<2; ++i)
831
      *sysex_buffer_ptr++ = ' ';
369 tk 832
 
833
    // add characters
834
    for(i=0; i<16; ++i) {
835
      if( *src_chars < 32 || *src_chars >= 128 )
374 tk 836
    *sysex_buffer_ptr++ = '.';
369 tk 837
      else
374 tk 838
    *sysex_buffer_ptr++ = *src_chars;
369 tk 839
 
840
      if( src_chars == src_end )
841
    break;
842
 
843
      ++src_chars;
844
    }
845
 
376 tk 846
    // linebreak
847
    *sysex_buffer_ptr++ = '\n';
848
 
369 tk 849
    // add F7
374 tk 850
    *sysex_buffer_ptr++ = 0xf7;
369 tk 851
 
374 tk 852
    s32 status = MIOS32_MIDI_SendSysEx(debug_port, buffer, (u32)(sysex_buffer_ptr-buffer));
369 tk 853
    if( status < 0 )
854
      return status;
855
  }
856
 
857
  return 0; // no error
858
}
859
 
860
 
861
/////////////////////////////////////////////////////////////////////////////
674 tk 862
//! Checks for incoming MIDI messages amd calls callback_package function
863
//! with following parameters:
211 tk 864
//! \code
674 tk 865
//!    callback_package(mios32_midi_port_t port, mios32_midi_package_t midi_package)
211 tk 866
//! \endcode
528 tk 867
//!
868
//! Not for use in an application - this function is called by
674 tk 869
//! by a task in the programming model, callback_package is APP_MIDI_NotifyPackage()
870
//!
871
//! SysEx streams can be optionally redirected to a separate callback function 
872
//! which can be installed via MIOS32_MIDI_SysExCallback_Init()
873
//!
211 tk 874
//! \return < 0 on errors
33 tk 875
/////////////////////////////////////////////////////////////////////////////
674 tk 876
s32 MIOS32_MIDI_Receive_Handler(void *_callback_package)
33 tk 877
{
878
  u8 port;
879
  mios32_midi_package_t package;
880
 
674 tk 881
  void (*callback_package)(mios32_midi_port_t port, mios32_midi_package_t midi_package) = _callback_package;
33 tk 882
 
78 tk 883
  u8 intf = 0; // interface to be checked
884
  u8 total_packages_forwarded = 0; // number of forwards - stop after 10 forwards to yield some CPU time for other tasks
885
  u8 packages_forwarded = 0;
886
  u8 again = 1;
33 tk 887
  do {
78 tk 888
    // Round Robin
889
    // TODO: maybe a list based approach would be better
890
    // it would allow to add/remove interfaces dynamically
891
    // this would also allow to give certain ports a higher priority (to add them multiple times to the list)
892
    // it would also improve this spagetthi code ;)
529 tk 893
    s32 status = -1;
78 tk 894
    switch( intf++ ) {
895
#if !defined(MIOS32_DONT_USE_USB) && !defined(MIOS32_DONT_USE_USB_MIDI)
529 tk 896
      case 0: status = MIOS32_USB_MIDI_PackageReceive(&package); port = USB0 + package.cable; break;
78 tk 897
#else
529 tk 898
      case 0: status = -1; break;
78 tk 899
#endif
126 tk 900
#if !defined(MIOS32_DONT_USE_UART) && !defined(MIOS32_DONT_USE_UART_MIDI) && MIOS32_UART0_ASSIGNMENT == 1
529 tk 901
      case 1: status = MIOS32_UART_MIDI_PackageReceive(0, &package); port = UART0; break;
78 tk 902
#else
529 tk 903
      case 1: status = -1; break;
78 tk 904
#endif
126 tk 905
#if !defined(MIOS32_DONT_USE_UART) && !defined(MIOS32_DONT_USE_UART_MIDI) && MIOS32_UART1_ASSIGNMENT == 1
529 tk 906
      case 2: status = MIOS32_UART_MIDI_PackageReceive(1, &package); port = UART1; break;
78 tk 907
#else
529 tk 908
      case 2: status = -1; break;
78 tk 909
#endif
910
#if !defined(MIOS32_DONT_USE_IIC) && !defined(MIOS32_DONT_USE_IIC_MIDI)
529 tk 911
      case 3: status = MIOS32_IIC_MIDI_PackageReceive(0, &package); port = IIC0; break;
78 tk 912
#else
529 tk 913
      case 3: status = -1; break;
78 tk 914
#endif
915
#if !defined(MIOS32_DONT_USE_IIC) && !defined(MIOS32_DONT_USE_IIC_MIDI)
529 tk 916
      case 4: status = MIOS32_IIC_MIDI_PackageReceive(1, &package); port = IIC1; break;
78 tk 917
#else
529 tk 918
      case 4: status = -1; break;
78 tk 919
#endif
920
#if !defined(MIOS32_DONT_USE_IIC) && !defined(MIOS32_DONT_USE_IIC_MIDI)
529 tk 921
      case 5: status = MIOS32_IIC_MIDI_PackageReceive(2, &package); port = IIC2; break;
78 tk 922
#else
529 tk 923
      case 5: status = -1; break;
78 tk 924
#endif
925
#if !defined(MIOS32_DONT_USE_IIC) && !defined(MIOS32_DONT_USE_IIC_MIDI)
529 tk 926
      case 6: status = MIOS32_IIC_MIDI_PackageReceive(3, &package); port = IIC3; break;
78 tk 927
#else
529 tk 928
      case 6: status = -1; break;
78 tk 929
#endif
930
#if !defined(MIOS32_DONT_USE_IIC) && !defined(MIOS32_DONT_USE_IIC_MIDI)
529 tk 931
      case 7: status = MIOS32_IIC_MIDI_PackageReceive(4, &package); port = IIC4; break;
78 tk 932
#else
529 tk 933
      case 7: status = -1; break;
78 tk 934
#endif
935
#if !defined(MIOS32_DONT_USE_IIC) && !defined(MIOS32_DONT_USE_IIC_MIDI)
529 tk 936
      case 8: status = MIOS32_IIC_MIDI_PackageReceive(5, &package); port = IIC5; break;
78 tk 937
#else
529 tk 938
      case 8: status = -1; break;
78 tk 939
#endif
80 tk 940
#if !defined(MIOS32_DONT_USE_IIC) && !defined(MIOS32_DONT_USE_IIC_MIDI)
529 tk 941
      case 9: status = MIOS32_IIC_MIDI_PackageReceive(6, &package); port = IIC6; break;
80 tk 942
#else
529 tk 943
      case 9: status = -1; break;
80 tk 944
#endif
945
#if !defined(MIOS32_DONT_USE_IIC) && !defined(MIOS32_DONT_USE_IIC_MIDI)
529 tk 946
      case 10: status = MIOS32_IIC_MIDI_PackageReceive(7, &package); port = IIC7; break;
80 tk 947
#else
529 tk 948
      case 10: status = -1; break;
80 tk 949
#endif
78 tk 950
      default:
951
    // allow 10 forwards maximum to yield some CPU time for other tasks
952
    if( packages_forwarded && total_packages_forwarded < 10 ) {
953
      intf = 0; // restart with USB
954
      packages_forwarded = 0; // for checking, if packages still have been forwarded in next round
955
    } else {
956
      again = 0; // no more interfaces to be processed
957
    }
529 tk 958
    status = -1; // empty round - no message
78 tk 959
    }
33 tk 960
 
550 tk 961
    // timeout detected by interface?
529 tk 962
    if( status == -10 ) {
963
      MIOS32_MIDI_TimeOut(port);
964
      again = 0;
965
    } else if( status >= 0 ) { // message received?
78 tk 966
      // notify that a package has been forwarded
967
      ++packages_forwarded;
968
      ++total_packages_forwarded;
33 tk 969
 
78 tk 970
      // remove cable number from package (MIOS32_MIDI passes it's own port number)
69 tk 971
      package.cable = 0;
33 tk 972
 
78 tk 973
      // branch depending on package type
582 tk 974
      if( package.type >= 0x8 && package.type < 0xf ) {
674 tk 975
    if( callback_package != NULL )
976
      callback_package(port, package);
33 tk 977
      } else {
675 tk 978
    u8 filter_sysex = 0;
979
 
33 tk 980
    switch( package.type ) {
550 tk 981
      case 0x0: // reserved, ignore
982
      case 0x1: // cable events, ignore
983
        break;
33 tk 984
 
550 tk 985
      case 0x2: // Two-byte System Common messages like MTC, SongSelect, etc. 
986
      case 0x3: // Three-byte System Common messages like SPP, etc. 
674 tk 987
        if( callback_package != NULL )
988
          callback_package(port, package); // -> forwarded as event
550 tk 989
        break;
990
 
991
      case 0x4: // SysEx starts or continues (3 bytes)
582 tk 992
      case 0xf: // Single byte is interpreted as SysEx as well (I noticed that portmidi sometimes sends single bytes!)
674 tk 993
 
994
        if( package.evnt0 >= 0xf8 ) { // relevant for package type 0xf
995
          if( callback_package != NULL )
996
        callback_package(port, package); // -> realtime event is forwarded as event
997
          break;
998
        }
999
 
550 tk 1000
        if( package.evnt0 == 0xf0 ) {
1001
          // cheap timeout mechanism - see comments above the sysex_timeout_ctr declaration
1002
          if( !sysex_timeout_ctr_flags.ALL ) {
1003
        switch( port & 0xf0 ) {
1004
          case USB0://..15
1005
            sysex_timeout_ctr = 0;
1006
            sysex_timeout_ctr_flags.usb_receives = (1 << (port & 0xf));
1007
            break;
1008
          case UART0://..15
1009
            // already done in MIOS32_UART_MIDI_PackageReceive()
1010
            break;
1011
          case IIC0://..15
1012
            sysex_timeout_ctr = 0;
1013
            sysex_timeout_ctr_flags.iic_receives = (1 << (port & 0xf));
1014
            break;
1015
            // no timeout protection for remaining interfaces (yet)
1016
        }
1017
          }
1018
        }
1019
 
1020
        MIOS32_MIDI_SYSEX_Parser(port, package.evnt0); // -> forward to MIOS32 SysEx Parser
582 tk 1021
        if( package.type != 0x0f ) {
1022
          MIOS32_MIDI_SYSEX_Parser(port, package.evnt1); // -> forward to MIOS32 SysEx Parser
1023
          MIOS32_MIDI_SYSEX_Parser(port, package.evnt2); // -> forward to MIOS32 SysEx Parser
1024
        }
1025
 
674 tk 1026
        if( sysex_callback_func != NULL ) {
675 tk 1027
          filter_sysex |= sysex_callback_func(port, package.evnt0); // -> forwarded as SysEx
582 tk 1028
          if( package.type != 0x0f ) {
675 tk 1029
        filter_sysex |= sysex_callback_func(port, package.evnt1); // -> forwarded as SysEx
1030
        filter_sysex |= sysex_callback_func(port, package.evnt2); // -> forwarded as SysEx
582 tk 1031
          }
675 tk 1032
        }
1033
 
1034
        if( callback_package != NULL && !filter_sysex )
674 tk 1035
          callback_package(port, package);
1036
 
550 tk 1037
        break;
1038
 
1039
      case 0x5:   // Single-byte System Common Message or SysEx ends with following single byte. 
1040
        if( package.evnt0 >= 0xf8 ) {
674 tk 1041
          if( callback_package != NULL )
1042
        callback_package(port, package); // -> forwarded as event
550 tk 1043
          break;
1044
        }
1045
        // no >= 0xf8 event: continue!
1046
 
1047
      case 0x6:   // SysEx ends with following two bytes.
1048
      case 0x7: { // SysEx ends with following three bytes.
1049
        u8 num_bytes = package.type - 0x5 + 1;
1050
        u8 current_byte = 0;
1051
 
1052
        if( num_bytes >= 1 ) {
1053
          current_byte = package.evnt0;
1054
          MIOS32_MIDI_SYSEX_Parser(port, current_byte); // -> forward to MIOS32 SysEx Parser
674 tk 1055
          if( sysex_callback_func != NULL )
675 tk 1056
        filter_sysex |= sysex_callback_func(port, current_byte); // -> forwarded as SysEx
550 tk 1057
        }
1058
 
1059
        if( num_bytes >= 2 ) {
1060
          current_byte = package.evnt1;
1061
          MIOS32_MIDI_SYSEX_Parser(port, current_byte); // -> forward to MIOS32 SysEx Parser
674 tk 1062
          if( sysex_callback_func != NULL )
675 tk 1063
        filter_sysex |= sysex_callback_func(port, current_byte); // -> forwarded as SysEx
550 tk 1064
        }
1065
 
1066
        if( num_bytes >= 3 ) {
1067
          current_byte = package.evnt2;
1068
          MIOS32_MIDI_SYSEX_Parser(port, current_byte); // -> forward to MIOS32 SysEx Parser
674 tk 1069
          if( sysex_callback_func != NULL )
675 tk 1070
        filter_sysex |= sysex_callback_func(port, current_byte); // -> forwarded as SysEx
550 tk 1071
        }
1072
 
1073
        // reset timeout protection if required
1074
        if( current_byte == 0xf7 )
1075
          sysex_timeout_ctr_flags.ALL = 0;
674 tk 1076
 
675 tk 1077
        // forward as package if not filtered
1078
        if( callback_package != NULL && !filter_sysex )
674 tk 1079
          callback_package(port, package);
550 tk 1080
 
1081
      } break;
1082
    }    
33 tk 1083
      }
1084
    }
550 tk 1085
 
1086
    // timeout detected by this handler?
1087
    if( sysex_timeout_ctr_flags.ALL && sysex_timeout_ctr > 1000 ) {
1088
      u8 timeout_port = 0;
1089
 
1090
      // determine port
1091
      if( sysex_timeout_ctr_flags.usb_receives ) {
1092
    int i; // i'm missing a prio instruction in C!
1093
    for(i=0; i<16; ++i)
1094
      if( sysex_timeout_ctr_flags.usb_receives & (1 << i) )
1095
        break;
1096
    if( i >= 16 ) // failsafe
1097
      i = 0;
1098
    timeout_port = USB0 + i;
1099
      } else if( sysex_timeout_ctr_flags.iic_receives ) {
1100
    int i; // i'm missing a prio instruction in C!
1101
    for(i=0; i<16; ++i)
1102
      if( sysex_timeout_ctr_flags.iic_receives & (1 << i) )
1103
        break;
1104
    if( i >= 16 ) // failsafe
1105
      i = 0;
1106
    timeout_port = IIC0 + i;
1107
      }
1108
 
1109
      MIOS32_MIDI_TimeOut(timeout_port);
1110
      sysex_timeout_ctr_flags.ALL = 0;
1111
      again = 0;
1112
    }
33 tk 1113
  } while( again );
1114
 
1115
  return 0;
1116
}
1117
 
1118
 
155 tk 1119
/////////////////////////////////////////////////////////////////////////////
528 tk 1120
//! This function should be called periodically each mS to handle timeout
1121
//! and expire counters.
1122
//!
1123
//! Not for use in an application - this function is called by
1124
//! by a task in the programming model!
1125
//! 
1126
//! \param[in] uart_port UART number (0..1)
1127
//! \return < 0 on errors
1128
/////////////////////////////////////////////////////////////////////////////
1129
s32 MIOS32_MIDI_Periodic_mS(void)
1130
{
1131
  s32 status = 0;
1132
 
1133
#ifndef MIOS32_DONT_USE_USB_MIDI
1134
  status |= MIOS32_USB_MIDI_Periodic_mS();
1135
#endif
1136
 
1137
#ifndef MIOS32_DONT_USE_UART_MIDI
1138
  status |= MIOS32_UART_MIDI_Periodic_mS();
1139
#endif
1140
 
1141
#ifndef MIOS32_DONT_USE_IIC_MIDI
1142
  status |= MIOS32_IIC_MIDI_Periodic_mS();
1143
#endif
1144
 
550 tk 1145
  // increment timeout counter for incoming packages
1146
  // an incomplete event will be timed out after 1000 ticks (1 second)
1147
  if( sysex_timeout_ctr < 65535 )
1148
    ++sysex_timeout_ctr;
1149
 
528 tk 1150
  return status;
1151
}
1152
 
1153
 
1154
/////////////////////////////////////////////////////////////////////////////
281 tk 1155
//! Installs the Tx callback function which is executed by
1156
//! MIOS32_MIDI_SendPackage_NonBlocking() before the MIDI package will be
1157
//! forwarded to the physical interface.
1158
//!
1159
//! The callback allows following usecases:
1160
//! <UL>
282 tk 1161
//!   <LI>package filter
281 tk 1162
//!   <LI>duplicating/routing packages
1163
//!   <LI>monitoring packages (sniffer)
1164
//!   <LI>create virtual busses; loopbacks
282 tk 1165
//!   <LI>extend available ports (e.g. by an OSC or AOUT port)<BR>
1166
//!       It is recommented to give port extensions a port number >= 0x80 to
1167
//!       avoid incompatibility with future MIOS32 port extensions.
281 tk 1168
//! </UL>
1169
//! \param[in] *callback_tx pointer to callback function:<BR>
211 tk 1170
//! \code
674 tk 1171
//!    s32 callback_tx(mios32_midi_port_t port, mios32_midi_package_t package)
1172
//!    {
1173
//!    }
211 tk 1174
//! \endcode
281 tk 1175
//! The package will be forwarded to the physical interface if the function 
1176
//! returns 0.<BR>
1177
//! Should return 1 to filter a package.
1178
//! Should return -2 to initiate a retry (function will be called again)
1179
//! Should return -3 to report any other error.
1180
//! These error codes comply with MIOS32_MIDI_SendPackage_NonBlocking()
211 tk 1181
//! \return < 0 on errors
281 tk 1182
//! \note Please use the filtering capabilities with special care - if a port
1183
//! is filtered which is also used for code upload, you won't be able to exchange
1184
//! the erroneous code w/o starting the bootloader in hold mode after power-on.
155 tk 1185
/////////////////////////////////////////////////////////////////////////////
281 tk 1186
s32 MIOS32_MIDI_DirectTxCallback_Init(void *callback_tx)
155 tk 1187
{
1188
  direct_tx_callback_func = callback_tx;
157 tk 1189
 
1190
  return 0; // no error
155 tk 1191
}
1192
 
1193
 
1194
/////////////////////////////////////////////////////////////////////////////
281 tk 1195
//! Installs the Rx callback function which is executed immediately on each
1196
//! incoming/outgoing MIDI byte, partly from interrupt handlers.
1197
//!
1198
//! This function should be executed so fast as possible. It can be used
1199
//! to trigger MIDI Rx LEDs or to trigger on MIDI clock events. In order to
1200
//! avoid MIDI buffer overruns, the max. recommented execution time is 100 uS!
1201
//!
1202
//! It is possible to filter incoming MIDI bytes with the return value of the
1203
//! callback function.<BR>
1204
//! \param[in] *callback_rx pointer to callback function:<BR>
1205
//! \code
674 tk 1206
//!    s32 callback_rx(mios32_midi_port_t port, u8 midi_byte)
1207
//!    {
1208
//!    }
281 tk 1209
//! \endcode
1210
//! The byte will be forwarded into the MIDI Rx queue if the function returns 0.<BR>
1211
//! It will be filtered out if the callback returns != 0 (e.g. 1 for "filter", 
1212
//! or -1 for "error").
1213
//! \return < 0 on errors
1214
//! \note Please use the filtering capabilities with special care - if a port
1215
//! is filtered which is also used for code upload, you won't be able to exchange
1216
//! the erroneous code w/o starting the bootloader in hold mode after power-on.
155 tk 1217
/////////////////////////////////////////////////////////////////////////////
281 tk 1218
s32 MIOS32_MIDI_DirectRxCallback_Init(void *callback_rx)
155 tk 1219
{
281 tk 1220
  direct_rx_callback_func = callback_rx;
155 tk 1221
 
157 tk 1222
  return 0; // no error
155 tk 1223
}
1224
 
281 tk 1225
 
155 tk 1226
/////////////////////////////////////////////////////////////////////////////
211 tk 1227
//! This function is used by MIOS32 internal functions to forward received
281 tk 1228
//! MIDI bytes to the Rx Callback routine.
1229
//!
1230
//! It shouldn't be used by applications.
211 tk 1231
//! \param[in] port MIDI port (DEFAULT, USB0..USB7, UART0..UART1, IIC0..IIC7)
281 tk 1232
//! \param[in] midi_byte received MIDI byte
211 tk 1233
//! \return < 0 on errors
155 tk 1234
/////////////////////////////////////////////////////////////////////////////
281 tk 1235
s32 MIOS32_MIDI_SendByteToRxCallback(mios32_midi_port_t port, u8 midi_byte)
155 tk 1236
{
1237
  // note: here we could filter the user hook execution on special situations
281 tk 1238
  if( direct_rx_callback_func != NULL )
1239
    return direct_rx_callback_func(port, midi_byte);
157 tk 1240
  return 0; // no error
155 tk 1241
}
1242
 
1243
/////////////////////////////////////////////////////////////////////////////
211 tk 1244
//! This function is used by MIOS32 internal functions to forward received
281 tk 1245
//! MIDI packages to the Rx Callback routine (byte by byte)
1246
//!
1247
//! It shouldn't be used by applications.
211 tk 1248
//! \param[in] port MIDI port (DEFAULT, USB0..USB7, UART0..UART1, IIC0..IIC7)
281 tk 1249
//! \param[in] midi_package received MIDI package
211 tk 1250
//! \return < 0 on errors
155 tk 1251
/////////////////////////////////////////////////////////////////////////////
281 tk 1252
s32 MIOS32_MIDI_SendPackageToRxCallback(mios32_midi_port_t port, mios32_midi_package_t midi_package)
155 tk 1253
{
1254
  // note: here we could filter the user hook execution on special situations
281 tk 1255
  if( direct_rx_callback_func != NULL ) {
155 tk 1256
    u8 buffer[3] = {midi_package.evnt0, midi_package.evnt1, midi_package.evnt2};
1257
    int len = mios32_midi_pcktype_num_bytes[midi_package.cin];
1258
    int i;
283 tk 1259
    s32 status = 0;
155 tk 1260
    for(i=0; i<len; ++i)
281 tk 1261
      status |= direct_rx_callback_func(port, buffer[i]);
1262
    return status;
155 tk 1263
  }
157 tk 1264
  return 0; // no error
155 tk 1265
}
1266
 
225 tk 1267
/////////////////////////////////////////////////////////////////////////////
1268
//! This function allows to change the DEFAULT port.<BR>
1269
//! The preset which will be used after application reset can be set in
1270
//! mios32_config.h via "#define MIOS32_MIDI_DEFAULT_PORT <port>".<BR>
1271
//! It's set to USB0 so long not overruled in mios32_config.h
1272
//! \param[in] port MIDI port (USB0..USB7, UART0..UART1, IIC0..IIC7)
1273
//! \return < 0 on errors
1274
/////////////////////////////////////////////////////////////////////////////
1275
s32 MIOS32_MIDI_DefaultPortSet(mios32_midi_port_t port)
1276
{
1277
  if( port == DEFAULT ) // avoid recursion
1278
    return -1;
1279
 
1280
  default_port = port;
1281
 
1282
  return 0; // no error
1283
}
1284
 
1285
/////////////////////////////////////////////////////////////////////////////
1286
//! This function returns the DEFAULT port
1287
//! \return the default port
1288
/////////////////////////////////////////////////////////////////////////////
1289
mios32_midi_port_t MIOS32_MIDI_DefaultPortGet(void)
1290
{
1291
  return default_port;
1292
}
1293
 
1294
 
1295
/////////////////////////////////////////////////////////////////////////////
307 tk 1296
//! This function allows to change the MIDI_DEBUG port.<BR>
1297
//! The preset which will be used after application reset can be set in
1298
//! mios32_config.h via "#define MIOS32_MIDI_DEBUG_PORT <port>".<BR>
1299
//! It's set to USB0 so long not overruled in mios32_config.h
1300
//! \param[in] port MIDI port (USB0..USB7, UART0..UART1, IIC0..IIC7)
1301
//! \return < 0 on errors
1302
/////////////////////////////////////////////////////////////////////////////
1303
s32 MIOS32_MIDI_DebugPortSet(mios32_midi_port_t port)
1304
{
1305
  if( port == MIDI_DEBUG ) // avoid recursion
1306
    return -1;
1307
 
1308
  debug_port = port;
1309
 
1310
  return 0; // no error
1311
}
1312
 
1313
/////////////////////////////////////////////////////////////////////////////
1314
//! This function returns the MIDI_DEBUG port
1315
//! \return the debug port
1316
/////////////////////////////////////////////////////////////////////////////
1317
mios32_midi_port_t MIOS32_MIDI_DebugPortGet(void)
1318
{
1319
  return debug_port;
1320
}
1321
 
1322
 
1323
/////////////////////////////////////////////////////////////////////////////
225 tk 1324
//! This function sets the SysEx Device ID, which is used during parsing
1325
//! incoming SysEx Requests to MIOS32<BR>
1326
//! It can also be used by an application for additional parsing with the same ID.<BR>
1327
//! ID changes will get lost after reset. It can be changed permanently by the
1328
//! user via Bootloader Command 0x0c
1329
//! \param[in] device_id a new (temporary) device ID (0x00..0x7f)
1330
//! \return < 0 on errors
1331
/////////////////////////////////////////////////////////////////////////////
1332
s32 MIOS32_MIDI_DeviceIDSet(u8 device_id)
1333
{
1334
  sysex_device_id = device_id & 0x7f;
1335
  return 0; // no error
1336
}
1337
 
1338
/////////////////////////////////////////////////////////////////////////////
1339
//! This function returns the SysEx Device ID, which is used during parsing
1340
//! incoming SysEx Requests to MIOS32<BR>
1341
//! It can also be used by an application for additional parsing with the same ID.<BR>
1342
//! The initial ID is stored inside the BSL range and will be recovered after
1343
//! reset. It can be changed by the user via Bootloader Command 0x0c
1344
//! \return SysEx device ID (0x00..0x7f)
1345
//! \todo store device ID via BSL based EEPROM emulation
1346
/////////////////////////////////////////////////////////////////////////////
1347
u8 MIOS32_MIDI_DeviceIDGet(void)
1348
{
1349
  return sysex_device_id;
1350
}
1351
 
1352
 
1353
/////////////////////////////////////////////////////////////////////////////
674 tk 1354
//! Installs an optional SysEx callback which is called by 
676 tk 1355
//! MIOS32_MIDI_Receive_Handler() to simplify the parsing of SysEx streams.
674 tk 1356
//!
1357
//! Without this callback (or with MIOS32_MIDI_SysExCallback_Init(NULL)),
676 tk 1358
//! SysEx messages are only forwarded to APP_MIDI_NotifyPackage() in chunks of 
674 tk 1359
//! 1, 2 or 3 bytes, tagged with midi_package.type == 0x4..0x7 or 0xf
1360
//! 
1361
//! In this case, the application has to take care for different transmission
1362
//! approaches which are under control of the package sender. E.g., while Windows
1363
//! uses Package Type 4..7 to transmit a SysEx stream, PortMIDI under MacOS sends 
1364
//! a mix of 0xf (single byte) and 0x4 (continued 3-byte) packages instead.
1365
//! 
677 tk 1366
//! By using the SysEx callback, the type of package doesn't play a role anymore,
674 tk 1367
//! instead the application can parse a serial stream.
1368
//!
1369
//! MIOS32 ensures, that realtime events (0xf8..0xff) are still forwarded to
1370
//! APP_MIDI_NotifyPackage(), regardless if they are transmitted in a package
1371
//! type 0x5 or 0xf, so that the SysEx parser doesn't need to filter out such
1372
//! events, which could otherwise appear inside a SysEx stream.
1373
//! 
1374
//! \param[in] *callback_sysex pointer to callback function:<BR>
1375
//! \code
1376
//!    s32 callback_sysex(mios32_midi_port_t port, u8 sysex_byte)
1377
//!    {
675 tk 1378
//!       //
674 tk 1379
//!       // .. parse stream
675 tk 1380
//!       //
1381
//!     
1382
//!       return 1; // don't forward package to APP_MIDI_NotifyPackage()
674 tk 1383
//!    }
1384
//! \endcode
675 tk 1385
//! If the function returns 0, SysEx bytes will be forwarded to APP_MIDI_NotifyPackage() as well.
1386
//! With return value != 0, APP_MIDI_NotifyPackage() won't get the already processed package.
674 tk 1387
//! \return < 0 on errors
1388
/////////////////////////////////////////////////////////////////////////////
1389
s32 MIOS32_MIDI_SysExCallback_Init(void *callback_sysex)
1390
{
1391
  sysex_callback_func = callback_sysex;
1392
 
1393
  return 0; // no error
1394
}
1395
 
1396
/////////////////////////////////////////////////////////////////////////////
225 tk 1397
// This function parses an incoming sysex stream for MIOS32 commands
1398
/////////////////////////////////////////////////////////////////////////////
1399
static s32 MIOS32_MIDI_SYSEX_Parser(mios32_midi_port_t port, u8 midi_in)
1400
{
1401
  // ignore realtime messages (see MIDI spec - realtime messages can
1402
  // always be injected into events/streams, and don't change the running status)
1403
  if( midi_in >= 0xf8 )
1404
    return 0;
1405
 
1406
  // TODO: here we could send an error notification, that multiple devices are trying to access the device
1407
  if( sysex_state.MY_SYSEX && port != last_sysex_port )
1408
    return -1;
1409
 
1410
  last_sysex_port = port;
1411
 
1412
  // branch depending on state
1413
  if( !sysex_state.MY_SYSEX ) {
1414
    if( (sysex_state.CTR < sizeof(mios32_midi_sysex_header) && midi_in != mios32_midi_sysex_header[sysex_state.CTR]) ||
1415
    (sysex_state.CTR == sizeof(mios32_midi_sysex_header) && midi_in != sysex_device_id) ) {
1416
      // incoming byte doesn't match
1417
      MIOS32_MIDI_SYSEX_CmdFinished();
1418
    } else {
1419
      if( ++sysex_state.CTR > sizeof(mios32_midi_sysex_header) ) {
1420
    // complete header received, waiting for data
1421
    sysex_state.MY_SYSEX = 1;
1422
      }
1423
    }
1424
  } else {
1425
    // check for end of SysEx message or invalid status byte
1426
    if( midi_in >= 0x80 ) {
1427
      if( midi_in == 0xf7 && sysex_state.CMD ) {
1428
        MIOS32_MIDI_SYSEX_Cmd(port, MIOS32_MIDI_SYSEX_CMD_STATE_END, midi_in);
1429
      }
1430
      MIOS32_MIDI_SYSEX_CmdFinished();
1431
    } else {
1432
      // check if command byte has been received
1433
      if( !sysex_state.CMD ) {
1434
    sysex_state.CMD = 1;
1435
    sysex_cmd = midi_in;
1436
    MIOS32_MIDI_SYSEX_Cmd(port, MIOS32_MIDI_SYSEX_CMD_STATE_BEGIN, midi_in);
1437
      }
1438
      else
1439
    MIOS32_MIDI_SYSEX_Cmd(port, MIOS32_MIDI_SYSEX_CMD_STATE_CONT, midi_in);
1440
    }
1441
  }
1442
 
1443
  return 0; // no error
1444
}
1445
 
1446
 
1447
/////////////////////////////////////////////////////////////////////////////
1448
// This function is called at the end of a sysex command or on 
1449
// an invalid message
1450
/////////////////////////////////////////////////////////////////////////////
1451
static s32 MIOS32_MIDI_SYSEX_CmdFinished(void)
1452
{
1453
  // clear all status variables
1454
  sysex_state.ALL = 0;
1455
  sysex_cmd = 0;
1456
 
1457
  return 0; // no error
1458
}
1459
 
1460
/////////////////////////////////////////////////////////////////////////////
1461
// This function handles the sysex commands
1462
/////////////////////////////////////////////////////////////////////////////
1463
static s32 MIOS32_MIDI_SYSEX_Cmd(mios32_midi_port_t port, mios32_midi_sysex_cmd_state_t cmd_state, u8 midi_in)
1464
{
238 tk 1465
#if MIOS32_MIDI_BSL_ENHANCEMENTS
1466
  // this compile switch should only be activated for the bootloader!
1467
  if( BSL_SYSEX_Cmd(port, cmd_state, midi_in, sysex_cmd) >= 0 )
1468
    return 0; // BSL has serviced this command - no error
1469
#endif
225 tk 1470
  switch( sysex_cmd ) {
1471
    case 0x00:
230 tk 1472
      MIOS32_MIDI_SYSEX_Cmd_Query(port, cmd_state, midi_in);
225 tk 1473
      break;
582 tk 1474
    case 0x0d:
1475
      MIOS32_MIDI_SYSEX_Cmd_Debug(port, cmd_state, midi_in);
1476
      break;
626 tk 1477
    case 0x0e: // ignore to avoid loopbacks
1478
      break;
225 tk 1479
    case 0x0f:
1480
      MIOS32_MIDI_SYSEX_Cmd_Ping(port, cmd_state, midi_in);
1481
      break;
1482
    default:
1483
      // unknown command
1484
      // TODO: send 0xf7 if merger enabled
1485
      MIOS32_MIDI_SYSEX_SendAck(port, MIOS32_MIDI_SYSEX_DISACK, MIOS32_MIDI_SYSEX_DISACK_INVALID_COMMAND);
1486
      MIOS32_MIDI_SYSEX_CmdFinished();      
1487
  }
1488
 
1489
  return 0; // no error
1490
}
1491
 
1492
 
1493
 
1494
/////////////////////////////////////////////////////////////////////////////
230 tk 1495
// Command 00: Query core informations and request BSL entry
225 tk 1496
/////////////////////////////////////////////////////////////////////////////
230 tk 1497
static s32 MIOS32_MIDI_SYSEX_Cmd_Query(mios32_midi_port_t port, mios32_midi_sysex_cmd_state_t cmd_state, u8 midi_in)
225 tk 1498
{
230 tk 1499
  static u8 query_req = 0;
1500
  char str_buffer[40];
225 tk 1501
 
1502
  switch( cmd_state ) {
1503
 
1504
    case MIOS32_MIDI_SYSEX_CMD_STATE_BEGIN:
230 tk 1505
      query_req = 0;
225 tk 1506
      break;
1507
 
1508
    case MIOS32_MIDI_SYSEX_CMD_STATE_CONT:
230 tk 1509
      query_req = midi_in;
1510
      break;
1511
 
1512
    default: // MIOS32_MIDI_SYSEX_CMD_STATE_END
1513
      switch( query_req ) {
1514
        case 0x01: // operating system
1515
      MIOS32_MIDI_SYSEX_SendAckStr(port, "MIOS32");
225 tk 1516
      break;
237 tk 1517
        case 0x02: // Board
230 tk 1518
      MIOS32_MIDI_SYSEX_SendAckStr(port, MIOS32_BOARD_STR);
225 tk 1519
      break;
230 tk 1520
        case 0x03: // Core Family
1521
      MIOS32_MIDI_SYSEX_SendAckStr(port, MIOS32_FAMILY_STR);
225 tk 1522
      break;
230 tk 1523
        case 0x04: // Chip ID
1524
      sprintf(str_buffer, "%08x", MIOS32_SYS_ChipIDGet());
1525
      MIOS32_MIDI_SYSEX_SendAckStr(port, (char *)str_buffer);
1526
      break;
1527
        case 0x05: // Serial Number
1528
      if( MIOS32_SYS_SerialNumberGet((char *)str_buffer) >= 0 )
1529
        MIOS32_MIDI_SYSEX_SendAckStr(port, str_buffer);
1530
      else
1531
        MIOS32_MIDI_SYSEX_SendAckStr(port, "?");
1532
      break;
1533
        case 0x06: // Flash Memory Size
1534
      sprintf(str_buffer, "%d", MIOS32_SYS_FlashSizeGet());
1535
      MIOS32_MIDI_SYSEX_SendAckStr(port, str_buffer);
1536
      break;
1537
        case 0x07: // RAM Memory Size
1538
      sprintf(str_buffer, "%d", MIOS32_SYS_RAMSizeGet());
1539
      MIOS32_MIDI_SYSEX_SendAckStr(port, str_buffer);
1540
      break;
1541
        case 0x08: // Application Name Line #1
1542
      MIOS32_MIDI_SYSEX_SendAckStr(port, MIOS32_LCD_BOOT_MSG_LINE1);
1543
      break;
1544
        case 0x09: // Application Name Line #2
1545
      MIOS32_MIDI_SYSEX_SendAckStr(port, MIOS32_LCD_BOOT_MSG_LINE2);
1546
      break;
1547
        case 0x7f:
231 tk 1548
#if MIOS32_MIDI_BSL_ENHANCEMENTS
1549
      // release halt state (or sending upload request) instead of reseting the core
1550
      BSL_SYSEX_ReleaseHaltState();
1551
#else
230 tk 1552
      // reset core (this will send an upload request)
1553
      MIOS32_SYS_Reset();
1554
      // at least on STM32 we will never reach this point
1555
      // but other core families could contain an empty stumb!
231 tk 1556
#endif
230 tk 1557
      break;
1558
        default:
1559
      // unknown query
1560
      MIOS32_MIDI_SYSEX_SendAck(port, MIOS32_MIDI_SYSEX_DISACK, MIOS32_MIDI_SYSEX_DISACK_UNKNOWN_QUERY);
225 tk 1561
      }
1562
  }
1563
 
1564
  return 0; // no error
1565
}
1566
 
582 tk 1567
 
225 tk 1568
/////////////////////////////////////////////////////////////////////////////
582 tk 1569
// Command 0D: Debug Input/Output
1570
/////////////////////////////////////////////////////////////////////////////
1571
static s32 MIOS32_MIDI_SYSEX_Cmd_Debug(mios32_midi_port_t port, mios32_midi_sysex_cmd_state_t cmd_state, u8 midi_in)
1572
{
1573
  static u8 debug_req = 0xff;
1574
 
1575
  switch( cmd_state ) {
1576
 
1577
    case MIOS32_MIDI_SYSEX_CMD_STATE_BEGIN:
1578
      debug_req = 0xff;
1579
      break;
1580
 
1581
    case MIOS32_MIDI_SYSEX_CMD_STATE_CONT:
1582
      if( debug_req == 0xff ) {
1583
    debug_req = midi_in;
1584
      } else {
1585
    switch( debug_req ) {
1586
      case 0x00: // input string
1587
        if( debug_command_callback_func != NULL )
1588
          debug_command_callback_func(last_sysex_port, (char)midi_in);
1589
        break;
1590
 
1591
      case 0x40: // output string
1592
        // not supported - DisAck will be sent
1593
        break;
1594
 
1595
      default: // others
1596
        // not supported - DisAck will be sent
1597
        break;
1598
    }
1599
      }
1600
      break;
1601
 
1602
    default: // MIOS32_MIDI_SYSEX_CMD_STATE_END
1603
      if( debug_req == 0x00 ) {
1604
    // send acknowledge
1605
    MIOS32_MIDI_SYSEX_SendAck(port, MIOS32_MIDI_SYSEX_ACK, 0x00);
944 tk 1606
 
1607
    if( debug_req == 0 && debug_command_callback_func == NULL )
1608
      MIOS32_MIDI_SendDebugMessage("[MIOS32_MIDI_SYSEX_Cmd_Debug] command handler not implemented by application\n", port);
1609
 
582 tk 1610
      } else {
1611
    // send disacknowledge
1612
    MIOS32_MIDI_SYSEX_SendAck(port, MIOS32_MIDI_SYSEX_DISACK, MIOS32_MIDI_SYSEX_DISACK_UNSUPPORTED_DEBUG);
1613
      }
1614
  }
1615
 
1616
  return 0; // no error
1617
}
1618
 
1619
/////////////////////////////////////////////////////////////////////////////
623 tk 1620
// Command 0F: Ping (just send back acknowledge if no additional byte has been received)
225 tk 1621
/////////////////////////////////////////////////////////////////////////////
1622
static s32 MIOS32_MIDI_SYSEX_Cmd_Ping(mios32_midi_port_t port, mios32_midi_sysex_cmd_state_t cmd_state, u8 midi_in)
1623
{
1624
  switch( cmd_state ) {
1625
 
1626
    case MIOS32_MIDI_SYSEX_CMD_STATE_BEGIN:
623 tk 1627
      sysex_state.PING_BYTE_RECEIVED = 0;
225 tk 1628
      break;
1629
 
1630
    case MIOS32_MIDI_SYSEX_CMD_STATE_CONT:
623 tk 1631
      sysex_state.PING_BYTE_RECEIVED = 1;
225 tk 1632
      break;
1633
 
1634
    default: // MIOS32_MIDI_SYSEX_CMD_STATE_END
1635
      // TODO: send 0xf7 if merger enabled
1636
 
623 tk 1637
      // send acknowledge if no additional byte has been received
1638
      // to avoid feedback loop if two cores are directly connected
1639
      if( !sysex_state.PING_BYTE_RECEIVED )
1640
    MIOS32_MIDI_SYSEX_SendAck(port, MIOS32_MIDI_SYSEX_ACK, 0x00);
225 tk 1641
 
1642
      break;
1643
  }
1644
 
1645
  return 0; // no error
1646
}
1647
 
1648
/////////////////////////////////////////////////////////////////////////////
1649
// This function sends a SysEx acknowledge to notify the user about the received command
1650
// expects acknowledge code (e.g. 0x0f for good, 0x0e for error) and additional argument
1651
/////////////////////////////////////////////////////////////////////////////
1652
static s32 MIOS32_MIDI_SYSEX_SendAck(mios32_midi_port_t port, u8 ack_code, u8 ack_arg)
1653
{
1654
  u8 sysex_buffer[32]; // should be enough?
1655
  u8 *sysex_buffer_ptr = &sysex_buffer[0];
1656
  int i;
1657
 
1658
  for(i=0; i<sizeof(mios32_midi_sysex_header); ++i)
1659
    *sysex_buffer_ptr++ = mios32_midi_sysex_header[i];
1660
 
1661
  // device ID
1662
  *sysex_buffer_ptr++ = MIOS32_MIDI_DeviceIDGet();
1663
 
1664
  // send ack code and argument
1665
  *sysex_buffer_ptr++ = ack_code;
1666
  *sysex_buffer_ptr++ = ack_arg;
1667
 
1668
  // send footer
1669
  *sysex_buffer_ptr++ = 0xf7;
1670
 
1671
  // finally send SysEx stream
1672
  return MIOS32_MIDI_SendSysEx(port, (u8 *)sysex_buffer, (u32)sysex_buffer_ptr - ((u32)&sysex_buffer[0]));
1673
}
1674
 
230 tk 1675
/////////////////////////////////////////////////////////////////////////////
1676
// This function sends an SysEx acknowledge with a string (used on queries)
1677
/////////////////////////////////////////////////////////////////////////////
1678
static s32 MIOS32_MIDI_SYSEX_SendAckStr(mios32_midi_port_t port, char *str)
1679
{
1680
  u8 sysex_buffer[128]; // should be enough?
1681
  u8 *sysex_buffer_ptr = &sysex_buffer[0];
1682
  int i;
225 tk 1683
 
230 tk 1684
  for(i=0; i<sizeof(mios32_midi_sysex_header); ++i)
1685
    *sysex_buffer_ptr++ = mios32_midi_sysex_header[i];
155 tk 1686
 
230 tk 1687
  // device ID
1688
  *sysex_buffer_ptr++ = MIOS32_MIDI_DeviceIDGet();
1689
 
1690
  // send ack code
1691
  *sysex_buffer_ptr++ = MIOS32_MIDI_SYSEX_ACK;
1692
 
1693
  // send string
307 tk 1694
  for(i=0; i<100 && (str[i] != 0); ++i)
230 tk 1695
    *sysex_buffer_ptr++ = str[i];
1696
 
1697
  // send footer
1698
  *sysex_buffer_ptr++ = 0xf7;
1699
 
1700
  // finally send SysEx stream
1701
  return MIOS32_MIDI_SendSysEx(port, (u8 *)sysex_buffer, (u32)sysex_buffer_ptr - ((u32)&sysex_buffer[0]));
1702
}
1703
 
529 tk 1704
 
1705
/////////////////////////////////////////////////////////////////////////////
582 tk 1706
//! Installs the debug command callback function which is executed on incoming
1707
//! characters from a MIOS Terminal
1708
//!
1709
//! Example:
1710
//! \code
1711
//! s32 CONSOLE_Parse(mios32_midi_port_t port, char c)
1712
//! {
1713
//!   // see $MIOS32_PATH/apps/examples/midi_console/
1714
//!   
1715
//!   return 0; // no error
1716
//! }
1717
//! \endcode
1718
//!
1719
//! The callback function has been installed in an Init() function with:
1720
//! \code
1721
//!   MIOS32_MIDI_DebugCommandCallback_Init(CONSOLE_Parse);
1722
//! \endcode
1723
//! \param[in] callback_debug_command the callback function (NULL disables the callback)
1724
//! \return < 0 on errors
1725
/////////////////////////////////////////////////////////////////////////////
1726
s32 MIOS32_MIDI_DebugCommandCallback_Init(void *callback_debug_command)
1727
{
1728
  debug_command_callback_func = callback_debug_command;
1729
 
1730
  return 0; // no error
1731
}
1732
 
1733
 
1734
/////////////////////////////////////////////////////////////////////////////
529 tk 1735
//! Installs the Timeout callback function which is executed on incomplete
1736
//! MIDI packages received via UART, or on incomplete SysEx streams.
1737
//!
1738
//! A timeout is detected after 1 second.
1739
//!
1740
//! On a timeout, it is recommented to reset MIDI parsing relevant variables,
1741
//! e.g. the state of a SysEx parser.
1742
//!
1743
//! Example:
1744
//! \code
1745
//! s32 NOTIFY_MIDI_TimeOut(mios32_midi_port_t port)
1746
//! {
1747
//!   // if my SysEx parser receives a command (MY_SYSEX flag set), abort parser if port matches
1748
//!   if( sysex_state.MY_SYSEX && port == last_sysex_port )
1749
//!     MySYSEX_CmdFinished();
1750
//!
1751
//!   return 0; // no error
1752
//! }
1753
//! \endcode
1754
//!
1755
//! The callback function has been installed in an Init() function with:
1756
//! \code
674 tk 1757
//!   MIOS32_MIDI_TimeOutCallback_Init(NOTIFY_MIDI_TimeOut)
1758
//!   {
1759
//!   }
529 tk 1760
//! \endcode
1761
//! \param[in] callback_timeout the callback function (NULL disables the callback)
1762
//! \return < 0 on errors
1763
/////////////////////////////////////////////////////////////////////////////
1764
s32 MIOS32_MIDI_TimeOutCallback_Init(void *callback_timeout)
1765
{
1766
  timeout_callback_func = callback_timeout;
1767
 
1768
  return 0; // no error
1769
}
1770
 
1771
 
1772
/////////////////////////////////////////////////////////////////////////////
1773
// This function is called if a MIDI parser runs into timeout
1774
/////////////////////////////////////////////////////////////////////////////
1775
static s32 MIOS32_MIDI_TimeOut(mios32_midi_port_t port)
1776
{
1777
  // if MIOS32 receives a SysEx command (MY_SYSEX flag set), abort parser if port matches
1778
  if( sysex_state.MY_SYSEX && port == last_sysex_port )
1779
    MIOS32_MIDI_SYSEX_CmdFinished();
1780
 
1781
  // optional hook to application
1782
  if( timeout_callback_func != NULL )
1783
    timeout_callback_func(port);
1784
 
1785
#if 1
1786
  // this debug message should always be active, so that common users are informed about the exception
1787
  MIOS32_MIDI_SendDebugMessage("[MIOS32_MIDI_Receive_Handler] Timeout on port 0x%02x\n", port);
1788
#endif
1789
 
1790
  return 0; // no error
1791
}
1792
 
32 tk 1793
#endif /* MIOS32_DONT_USE_MIDI */