MIOS Functions Reference (C Version)

  // send the MIDI event B0 07 7F
  MIOS_MIDI_BeginStream();
  MIOS_MIDI_TxBufferPut(0xb0);
  MIOS_MIDI_TxBufferPut(0x07);
  MIOS_MIDI_TxBufferPut(0x7f);
  MIOS_MIDI_EndStream();

  // set device ID to the specified value in the PIC ID header
  MIOS_MIDI_DeviceIDAutoSet();

  // print device ID on display
  MIOS_LCD_PrintHex2(MIOS_MIDI_DeviceIDGet());

  ;; change device ID
  MIOS_MIDI_DeviceIDSet(0x03);

  // send the MIDI event 90 36 7F
  MIOS_MIDI_BeginStream();
  MIOS_MIDI_TxBufferPut(0x90);
  MIOS_MIDI_TxBufferPut(0x36);
  MIOS_MIDI_TxBufferPut(0x7f);
  MIOS_MIDI_EndStream();

  // set MIDI interface to the specified type in the PIC ID header
  MIOS_MIDI_InterfaceAutoSet();

  // get current interface type and branch depending on setting
  switch( MIOS_MIDI_InterfaceGet() ) {
    case MIOS_MIDI_INTERFACE_COMMON:
      // do this...
      break;
    case MIOS_MIDI_INTERFACE_TO_HOST:
      // do that...
      break;
    default:
      // IIC slave selected...
  }

  // send MIDI clock over internal MIDI Out with normal baudrate
  MIOS_MIDI_InterfaceSet(MIOS_MIDI_INTERFACE_COMMON);
  MIOS_MIDI_TxBufferPut(0xf8);

  // send MIDI clock over MBHP_IIC_MIDI with address 0x10
  MIOS_MIDI_InterfaceSet(0x10);
  MIOS_MIDI_TxBufferPut(0xf8);

  // switch back to the default interface
  MIOS_MIDI_InterfaceAutoSet();

  // get current merger configuration and branch depending on setting
  switch( MIOS_MIDI_MergerGet() ) {
    case MIOS_MIDI_MERGER_ENABLED:
      // do this...
      break;
    case MIOS_MIDI_MERGER_MBLINK_EP:
      // do this...
      break;
    case MIOS_MIDI_MERGER_MBLINK_FP:
      // do this...
      break;
    default: // MIOS_MIDI_MERGER_DISABLED:
      // do that...
  }

  // configure the MIDIbox as MIDIbox Link End Point
  // (means: merger enabled only for events which has
  // been generated by another MIDIbox which is configured
  // as MIDIbox Link Forwarding Point)
  MIOS_MIDI_MergerSet(MIOS_MIDI_MERGER_MBLINK_EP);

  // put a MIDI byte into the Rx Buffer if it isn't full
  if( MIOS_MIDI_RxBufferFree() ) {
    MIOS_MIDI_RxBufferPut(0xf8); // MIDI Clock
  }

  unsigned char b;

  // get a MIDI byte from the Rx Buffer if something has been received
  if( MIOS_MIDI_RxBufferUsed() ) {
    b = MIOS_MIDI_RxBufferGet();
  }

  // put a MIDI byte into the Rx Buffer if it isn't full
  if( MIOS_MIDI_RxBufferFree() ) {
    MIOS_MIDI_RxBufferPut(0xf8); // MIDI Clock
  }

  // branch if something has been received via MIDI
  if( MIOS_MIDI_RxBufferUsed() ) {
    // do something...
  }

  // wait until buffer is empty, thereafter send a bunch of new bytes
  MIOS_MIDI_TxBufferFlush();
  MIOS_MIDI_TxBufferPut(0xf0);
  //  ...

  // put a MIDI byte into the Tx Buffer if it isn't full
  if( MIOS_MIDI_TxBufferFree() ) {
    MIOS_MIDI_TxBufferPut(0xf8);
  }

  unsigned char b;

  // get a MIDI byte from the Tx Buffer if new byte is available
  if( MIOS_MIDI_TxBufferUsed() ) {
    b = MIOS_MIDI_TxBufferGet();
  }

  // put a MIDI byte into the Tx Buffer
  MIOS_MIDI_TxBufferPut(0xf8); // MIDI Clock

  // branch if something has been put into the Tx Buffer
  if( MIOS_MIDI_TxBufferUsed() ) {
    // got something
  }

  ;; initialize the MF driver for Alps RSAON11M9 faders
  MIOS_MF_Enable();
  MIOS_MF_DeadbandSet(3);
  MIOS_MF_PWM_DutyCycleUpSet(1);
  MIOS_MF_PWM_DutyCycleDownSet(1);
  MIOS_MF_PWM_PeriodSet(3);

  // move fader #7 to highest position (0x3ff)
  MIOS_MF_FaderMove(0x07, 0x3ff);

  // subtract -5 from the 7-bit value of encoder #0
  MIOS_ENC_Abs7bitAdd(0, -5);

  // get the current 7-bit value of encoder #0
  value = MIOS_ENC_Abs7bitGet(0);

  // set the 7-bit value of encoder #0 to 0x40
  MIOS_ENC_Abs7bitSet(0, 0x40);

  // return the speed setting of encoder #0
  speed = MIOS_ENC_SpeedGet(0);

  MIOS_ENC_SPEED_NORMAL
  ~~~~~~~~~~~~~~~~~~~~~
  // this speed mode requires no additional parameter (should be zero)

  // set speed of encoder #0 to "normal"
  MIOS_ENC_SpeedSet(0, MIOS_ENC_SPEED_NORMAL, 0);

  MIOS_ENC_SPEED_SLOW
  ~~~~~~~~~~~~~~~~~~~
  // this speed mode allows to define a predivider value
  // from 0 to 7

  // set speed for encoder #0 to "slow", use a predivider
  // of 3 so that the encoder will increment every 4th
  // step (predivider value (- 1))
  MIOS_ENC_SpeedSet(0, MIOS_ENC_SPEED_SLOW, 3);

  MIOS_ENC_SPEED_FAST
  ~~~~~~~~~~~~~~~~~~~
  // in this speed mode the increment value depends on the
  // rotational speed based on the following formula:

  //    speed_ctr: decremented with every update cycle
  //    (-> MIOS_SRIO_UpdateFrqSet)
  //     (normaly 1 ms) to measure the time between
  //     two encoder steps
  //     Init value: 0x7f
  //     reaches 0x00 after 127 update cycles
  //    (normaly after 127 ms)
  //    <parameter>: specified with the MIOS_ENC_SpeedSet
  //
  //           function, allowed values:
  //        0 (fast)     -> divider = 2^(7-0) = 128
  //        1 (faster)   -> divider = 2^(7-1) =  64
  //        ...
  //        7 (fastest)  -> divider = 2^(7-7) =  1
  // ->
  //    incrementer = speed_ctr / (2^(7-parameter))

  // set speed for encoder #0 to "fast", speed exponent value is 2
  MIOS_ENC_SpeedSet(0, MIOS_ENC_SPEED_FAST, 2);

  // clear LCD and print a character
  MIOS_LCD_Clear();
  MIOS_LCD_PrintChar('A');

  // print char at first line, first column
  MIOS_LCD_CursorSet(0x00 + 0);
  MIOS_LCD_PrintChar('A');

  // print char at second line, last column (2x16 LCD)
  MIOS_LCD_CursorSet(0x40 + 15);
  MIOS_LCD_PrintChar('B');

  // print chars on second LCD
  // (or 3rd and 4th line, see see MIOS_LCD_YAddressSet)
  MIOS_LCD_CursorSet(0x80 + 0);
  MIOS_LCD_PrintChar('C');
  MIOS_LCD_CursorSet(0xc0 + 15);
  MIOS_LCD_PrintChar('D');

  // print message on LCD for 2 seconds
  MIOS_LCD_CursorSet(0x00 + 0);
  MIOS_LCD_PrintCString("Pot value: ");
  MIOS_LCD_PrintHex2(MIOS_AIN_Pin7bitGet(0));
  MIOS_LCD_MessageStart(255);

  // stop message immediately and invoke DISPLAY_Tick again
  MIOS_LCD_MessageStop();

  unsigned char value;

  // print leftmost digit of 'value' on screen
  MIOS_LCD_PrintBCD1(value);

  unsigned char value;

  // print two leftmost digits of 'value' on screen
  MIOS_LCD_PrintBCD2(value);

  unsigned char value;

  // print all three digits of 'value' on screen
  MIOS_LCD_PrintBCD3(value);

  unsigned int value;

  // print four leftmost digits of 'value' on screen
  MIOS_LCD_PrintBCD4(value);

  unsigned int value;

  // print all five digits of 'value' on screen
  MIOS_LCD_PrintBCD5(value);

  // print string on LCD - first line, first column
  MIOS_LCD_CursorSet(0x00 + 0);
  MIOS_LCD_PrintCString("Hello World!");

  ;; print four characters on screen
  MIOS_LCD_PrintChar('M');
  MIOS_LCD_PrintChar('I');
  MIOS_LCD_PrintChar('O');
  MIOS_LCD_PrintChar('S');

  unsigned char value;

  // print leftmost nibble of 'value' on screen
  MIOS_LCD_PrintHex1(value);

  unsigned char value;

  // print content of 'value' on screen
  MIOS_LCD_PrintHex2(value);

  // consider the use of MIOS_LCD_PrintMessageStart
        // see also the appr. example

  // defined somewhere *outside* the function!
  const unsigned char text_welcome_0[] = { "Hello World!" };

  // within the function: print string
  MIOS_LCD_CursorSet(0x00 + 0);
  MIOS_LCD_PrintPreconfString(12, text_welcome_0);

  // please see also the MIOS_LCD_PrintCString function!

  // defined somewhere *outside* the function!
  const unsigned char text_welcome_0[] = { 12, 0x00, "Hello World!" };

  // within the function: print string
  MIOS_LCD_PrintString(text_welcome_0);

  // please see also the MIOS_LCD_PrintCString function!

  // set LCD type to the specified type in the PIC ID header
  MIOS_LCD_TypeAutoSet();

  // branch depending on LCD type
  if( MIOS_LCD_TypeGet() == MIOS_LCD_TYPE_CLCD ) {
    // do something special if CLCD connected
  }


  // !!! Better for branching depending on CLCD/GLCD type display !!!
  // !!! (works also with custom LCD driver                       !!!
  if( !MIOS_BOX_CFG0.USE_GLCD ) {
    // do something special if CLCD connected
  }

  The available LCD options differ with the used LCD type, here a list:

  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  Type 0, CLCD:
     with <par1> and <par2> the enable (E) pins of
     the character displays are specified. By default the E input of
     the first CLCD should be connected to pin D.7, the E input of
     the second CLCD (if available) to C.4
     Following lines of code are necessary to achieve this:

  // use a CLCD, E input of first CLCD at D.7, E of second CLCD @C.4
  MIOS_LCD_TypeSet(MIOS_LCD_TYPE_CLCD, 0x37, 0x24);

     Note: the first digit of the parameter value sets the port number
             (A=0, B=1, C=2, D=3, E=4)
             the second digit sets the pin number (0-7)
             bit #7 sets the interface (0=8bit, 0=7bit)

     Example for CLCD with 4bit interface:
  ;; use a CLCD, E input of first CLCD at D.7, E of second CLCD @C.4
  ;; using the 4-bit interface:
  ;; -> connect MBHP_CORE:J15:D7-D4 of the core module to D7-D4 of the LCD
        ;; -> left MBHP_CORE:J15:D3-D0 of the core module open!
  ;; -> tie D3-D0 of the LCD to ground
  MIOS_LCD_TypeSet(MIOS_LCD_TYPE_CLCD, 0x80 | 0x37, 0x80 | 0x24);

     Tip: by changing these parameters dynamically you are also able to
            drive more than 2 LCDs with one core module. Only the number
            of free pins limit the number of CLCDs which can be driven!
            Don't forget to switch the appr. pins to output before using
            them, and call MIOS_LCD_Init for every display pair in your
            USER_Init

  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

 Type 1, KS0108 or HD61202 based
     with <par1> it has to be specified if the chip select
     lines are inverted

  // use a KS0108 or HD61202 compatible graphical LCD with
  // non-inverted chip selects
  MIOS_LCD_TypeSet(MIOS_LCD_TYPE_GLCD0, 0x00, 0x00); // (par2 unusued)

   OR:
  // use a KS0108 or HD61202 compatible graphical LCD with inverted
  // chip selects
  MIOS_LCD_TypeSet(MIOS_LCD_TYPE_GLCD0, 0x01, 0x00); // (par2 unusued)

  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

 Type 2, T6963C based
     not supported anymore, use the custom driver instead which are
     available in the MIOS download section

  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

 Type 6, MIDI display
     see the MIOS SysEx implementation which is available in the MIOS
     download section
     MIOS_PARAMETER1 defines the device ID of the target core:

  ;; send MIDI messages to core with device ID 0x42
  MIOS_LCD_TypeSet(MIOS_LCD_TYPE_MLCD, 0x42, 0x00); // (par2 unusued)

  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

 Type 7, custom LCD driver
     options are forwarded to the custom LCD driver
     following hooks have been prepared for an easy integration into
     MIOS:
          USER_LCD_Init
          USER_LCD_Clear
          USER_LCD_CursorSet
          USER_LCD_PrintChar

  // configure the offsets for a 4x16 LCD:
  MIOS_LCD_YAddressSet(0x00, 0x40, 0x10, 0x50);

  // configure MIOS for 2 character LCDs:
        // (see also http://www.ucapps.de/mbhp_lcd.html )
  MIOS_LCD_YAddressSet(0x00, 0x40, 0x80, 0xc0);

    see http://www.ucapps.de/mios_c_lcd_schars.html

    see http://www.ucapps.de/mios_c_lcd_schars.html

  // set default font:
  MIOS_GLCD_FontInit(MIOS_GLCD_FONT)
  // set cursor to 0
  MIOS_LCD_CursorSet(0x00);
  // print character 'A'
  MIOS_LCD_PrintChar('A');

  // set graphical cursor to 160/7:
  MIOS_GLCD_GCursorSet(160, 7);

  // load a byte from address 0x80
  value = MIOS_EEPROM_Read(0x80);

  unsigned char buffer[64];

  // read a page of 64 bytes from EEPROM at address 0x40
  MIOS_EEPROM_ReadPage(0x40, buffer);

  unsigned char error = 0;

  // write 0x47 0x11 into EEPROM at address 0x80/0x81
  error |= MIOS_EEPROM_Write(0x80, 0x47);
  error |= MIOS_EEPROM_Write(0x81, 0x11);

  if( error ) {
    // here you could do some error handling
  }



  // note: it's very unlikely that an error happens when writing
  // to internal EEPROM, therefore you can use following shortcut:

  // write 0x47 0x11 into EEPROM at address 0x80/0x81
  MIOS_EEPROM_Write(0x80, 0x47);
  MIOS_EEPROM_Write(0x81, 0x11);

  unsigned char buffer[64];
  unsigned char i;

  // fill buffer with some bytes
  for(i=0; i<64; ++i)
    buffer[i] = i;

  // write a page of 64 bytes to EEPROM memory at address 0x80
  MIOS_EEPROM_WritePage(0x80, buffer);

  unsigned char buffer[64];

  // read a page of 64 bytes from flash memory at address 0x7000
  MIOS_FLASH_Read(0x7000, buffer);

  unsigned char buffer[64];
  unsigned char i;

  // fill buffer with some bytes
  for(i=0; i<64; ++i)
    buffer[i] = i;

  // write a page of 64 bytes to flash memory at address 0x7000
  if( MIOS_FLASH_Write(0x7000, buffer) ) {
    // error handler
  }

  unsigned char error = 0;

  // write 0x47 0x11 to address 0x3000-0x3001 of the BankStick number 7
  MIOS_BANKSTICK_CtrlSet(0x07); // select 8th BankStick
  error |= MIOS_BANKSTICK_Write(0x3000, 0x47);
  error |= MIOS_BANKSTICK_Write(0x3001, 0x11);

  // load a byte from address 0x7fff (the last in a 32k BankStick)
  value = MIOS_BANKSTICK_Read(0x7fff);

  if( !MIOS_BOX_STAT.BS_AVAILABLE ) {
    // here you could do some error handling
  }

  unsigned char buffer[64];

  // read a page of 64 bytes from BankStick memory at address 0x1240
  MIOS_BANKSTICK_ReadPage(0x1240, buffer);

  if( !MIOS_BOX_STAT.BS_AVAILABLE ) {
    // here you could do some error handling
  }

  unsigned char error = 0;

  // write 0x47 0x11 to address 0x3000-0x3001 of the BankStick
  error |= MIOS_BANKSTICK_Write(0x3000, 0x47);
  error |= MIOS_BANKSTICK_Write(0x3001, 0x11);

  if( error ) {
    // here you could do some error handling
  }

  unsigned char buffer[64];
  unsigned char i;

  // fill buffer with some bytes
  for(i=0; i<64; ++i)
    buffer[i] = i;

  // write a page of 64 bytes to BankStick memory at address 0x3000
  if( MIOS_BANKSTICK_WritePage(0x3000, buffer) ) {
    // here you could do some error handling
  }

        see MIOS_IIC_ByteSend and MIOS_IIC_ByteReceive

  // receive three bytes from the IIC slave with ID 0x12

  MIOS_IIC_Start();    // start IIC
  MIOS_IIC_ByteSend(0x12 | 1);  // send device address -
                                //    set bit #0 to notify a read!!!
  // don't continue if IIC device not available
  if( MIOS_BOX_STAT.BS_AVAILABLE ) {
    b0 = MIOS_IIC_ByteReceive();  // read first byte
    MIOS_IIC_AckSend();    // send acknowledge
    b1 = MIOS_IIC_ByteReceive();  // read second byte
    MIOS_IIC_AckSend();    // send acknowledge
    b2 = MIOS_IIC_ByteReceive();  // read third byte
  }
  MIOS_IIC_NakSend();    // send disacknowledge!!!
  MIOS_IIC_Stop();    // stop IIC

  For more details about the IIC protocol (officially called I2C), see
     http://www.semiconductors.philips.com/buses/i2c/

  // send 0x34, 0x56, 0x78 to the IIC slave with ID 0x12

  MIOS_IIC_Start();    // start IIC
  MIOS_IIC_ByteSend(0x12);  // send device address
                                // bit #0 cleared to notify a write!!!
  MIOS_IIC_ByteSend(0x34);  // send first data byte
  MIOS_IIC_ByteSend(0x56);  // send second data byte
  MIOS_IIC_ByteSend(0x78);  // send third data byte
  MIOS_IIC_Stop();    // stop IIC

  For more details about the IIC protocol (officially called I2C), see
     http://www.semiconductors.philips.com/buses/i2c/

  An enhanced example with retry on NAK's can be
  found at the MBHP_IIC_MIDI page

  // enable clock stretching
  MIOS_IIC_CtrlSet(0x01);

        see MIOS_IIC_ByteSend and MIOS_IIC_ByteReceive

        see MIOS_IIC_ByteSend and MIOS_IIC_ByteReceive

        see MIOS_IIC_ByteSend and MIOS_IIC_ByteReceive

  // we want to setup the timer with a frequency of 500 Hz = 2 mS
  // prescaler 1:1 should be used
  // calculate the required number of clocks for this period:
  // clocks = period / 100 nS = 2 mS / 100 nS = 20000
  // therefore:
  MIOS_TIMER_Init(0x00, 20000);

  // now the Timer() function is called every 2 mS!

  // subtract -5 from the 16-bit value (unsigned int)
  MIOS_HLP_16bitAddSaturate(-5, &value, 0x0fff);

  // get the BCD code from 12345
  MIOS_HLP_Dec2BCD(12345);
  // now:
  //    MIOS_PARAMETER3 contains the hex-value 0x01
  //    MIOS_PARAMETER2 contains the hex-value 0x23
  //    MIOS_PARAMETER1 contains the hex-value 0x45

  // wait for exact 250 ms
  MIOS_Delay(250);