________________________________________________

ADAM MADI Card - Boot Loader, version 2.2.5 Beta
________________________________________________

Code image CRC: 3d45


-----------
Description
-----------

The MADI firmware consists of two components: A boot loader, and the
"client" firmware.

The boot loader has no audio functionality. Its sole purpose is to provide
for fall-back operation, to allow recovery if a firmware download fails
(e.g. a power failure occurs while the card is reprogramming its flash
with a new version of firmware).

The only functionality supported by the boot loader is the ability to
download new firmware.


------------------------
Updating the Boot Loader
------------------------

The boot loader should rarely, if ever, need to be updated.

The boot loader can be updated as follows:

   Method 1 - MADI card is already running boot loader v2.2.3 (or later)
   ---------------------------------------------------------------------

1. Hold in both of the front-card pushbuttons while hitting the Reset
   pushbutton. This will cause the MADI card to restart in boot download mode.

2. Download a new version of firmware via AZedit.

3. Once the boot loader has downloaded a new code image and reprogrammed
   itself, it will reset, and then restart in normal operating mode.

   Method 2 - Required if the MADI card is running boot loader prior to v2.2.x
   ---------------------------------------------------------------------------

1. Remove the MADI card, and turn on DIP switch #8.

2. Holding in the 2 pushbuttons while installing (or powering up) the
   MADI. This will cause the MADI to restart in boot loader mode.
   The version string (on the I/O Card Version screen in AZedit) will
   identify that the card is in boot loader mode.

3. Download a new version of firmware via AZedit. (You can download either
   a new version of the boot loader, or a new version of the client code.)

4. Once the boot loader has downloaded a new code image and reprogrammed
   itself, it will reset, and then come up in debug-only mode because
   DIP switch #8 is on. Remove the card, turn off DIP switch #8, and
   then reinstall the card.


--------------
Change History
--------------

New in version 2.2.5
--------------------

* Fixed control bus communications problem

  A problem was identified which could cause the MADI card to stop communicating
  on the control bus, requiring the card to be reset. This version includes
  a new version of the PFGA that fixes the problem.


New in version 2.2.4
--------------------

* Fixed control bus communications problem

  This version of firmware includes a new version of the FPGA that fixes a
  control bus problem that could cause communication errors.


New in version 2.2.3
--------------------

* Added support for MADI-2 hardware


New in version 0.0.9 - Transitional version only!
--------------------

* Interim version, for upgrading only

  Starting with MADI Boot Loader v2.2.1 and Client v2.2.2, the MADI firmware
  supports both the MADI and MADI-2 cards. Support for the MADI-2 card requires
  a much larger boot loader (larger than supported by Boot Loader v0.0.1 and
  Client v1.1.0).

  In order to upgrade a MADI card from Boot Loader v0.0.1 / Client v1.1.0 to
  the latest firmware, you must:

    - Restart the MADI card in Boot Loader mode
    - Download Boot Loader v0.0.9
    - Once the card has reprogrammed itself, restart the MADI card in Boot
      Loader mode again
    - Download Boot Loader v2.2.1
    - Once the card has reprogrammed itself, restart the MADI card normally.
      (However, it will still come up in Boot Loader mode, because the
      older version of the Client code is not compatible.)
    - Download Client code v2.2.2


New in version 0.0.1
--------------------

* Initial release