==============================================================
MVR-mkII multiverter Firmware Update Procedure
Document status: 2023-07-22
==============================================================

*** IMPORTANT *************************************************
*
*  It is ABSOLUTELY REQUIRED that you follow *BOTH* steps described below
*  because both parts are matched with each other:
*
*    A) FPGA/Control firmware update via USB 
*    B) Dante firmware update via Ethernet
*
*  Also, please make sure this updater package is moved and executed
*  from a location where Windows 10 allows batch files to run.
*  A safe place is the Desktop, network drives usually won't work.
*
***************************************************************

A) Control+FPGA firmware update
===============================

1. Switch the multiverter OFF.

2. Connect the multiverter via USB to your PC (anything from Windows 7 on should work). 
   Push the encoder and hold it down while switching the multiverter ON again.     
   After 3 seconds, release the encoder knob.
   
3. The display should remain dark (except for the power LEDs) to indicate it is set to 
   firmware update mode. If any other LEDs on the frontpanel are still lit, switch it off 
   and on again while holding down the encoder until the display remains dark.  
   
4. Run "MVR-64-Updater.bat" and confirm with "U". The update process takes about 
   2-3 minutes. Check the screen output for any error messages. If an error occured
   try again (unplug the Multiverter from USB and reconnect) or refer to the 
   "Troubleshooting" section below.
   
5. Switch the multiverter off and on again to activate the new firmware.
   
6. Continue in section B) for Dante firmware update (only required if you don't have 
   already the latest version which is packed with this firmware).
   

B) Dante firmware update 
======================== 

1. Connect the multiverter via Ethernet to your PC, or to your local network).

2. IMPORTANT: Make sure >>> Windows Firewall is turned off <<< before proceeding, 
   it may prevent the Dante Updater from executing correctly.

3. Install or execute the "Dante Controller":
   https://www.audinate.com/products/software/dante-controller
 
4. Start "Dante Controller", lauch "Dante Updater", go to "LIBRARY", to "IMPORTED FILES"
   and import the *.dnt file from the "firmware" subdirectory of this package.
   Then, go to "HOME", "IMPORTED FIRMWARE FILES", expand the "MVR-*" device and choose "RELOAD".
   The update process takes several minutes.
   
5. Restart the device   
   
6. (Optional) Allow 20 seconds for booting, then open a web browser, type the IP address of the 
   multiverter (normally the same as the Dante IP address) and go to the "ABOUT" page. 
   If all firmware updates were executed correctly, you should see the new firmware version number 
   in the lower left corner of the background picture.

   
Troubleshooting
---------------
The multiverter should be detected by Windows as USB-to-RS232 converter (FT2232) without 
the need to manually install a driver. In case you still need a driver, a version is available in 
the "win\driver" subdirectory or alternatively from FTDI.  You need the "Virtual COM Port" (VCP driver) 
from here:
  http://www.ftdichip.com/Drivers/VCP.htm
The installation procedure is described here:
  http://www.ftdichip.com/Support/Documents/InstallGuides.htm   

1. Upgrade the Control Firmware manually:
   - In Windows Device Manager, move to the "Ports (COM & LPT)" section and locate 
     the pair of "USB Serial Ports" e.g. COM3 and COM4. Note the number of the
     lower of both ports (e.g. COM3).      
   - Open a command prompt and navigate to the directory where README.TXT is located.
     Run the following command:
     "win\stm32flash -v -w firmware\frontpanel.bin \\.\COMxx"
     (with COMxx beeing the one of the COM ports from the Device Manager, you might
      have to try both).
2. Upgrade the FPGA Firmware manually:
   - Open a command prompt and navigate to the directory where README.TXT is located.
     Run the following command:
    "win\fwloader -f firmware\multiverter.rpd -m 1 -e 16"
3. Disable Windows Firewall and continue in section B) for Dante firmware update