Flashing

Requirements

For flashing the frame grabber with an applet file (*.hap or *.dll), the applet file needs to be available in the file system of your host PC.

Standard Acquisition Applets (*.dll files) need to be stored in [runtime installation directory]/Dll/LB-ACL. You have probably already installed them either

If you want to flash individual applets (*.hap files), copy them into [runtime installation directory]/Hardware Applets/LB-ACL (as described in Adding an Applet Manually).

Flashing

To flash applet(s) onto the frame grabber:

  1. Close microDisplay/microDisplay X if open and make sure no instance of microDisplay/microDisplay X is open on your system.
  2. Start the tool microDiagnostics (e.g., directly out of the installation directory [runtime installation directory]/bin/microDiagnostics.exe)

In the microDiagnostics program window that opens:

  1. Select the the frame grabber device you want to install the applet(s) on:

Start window of microDiagnostics

  1. Click the button Manage Firmware/Applet(s).

A list of all applets that are available (flashed) on the board is displayed:

List of applets available on the frame grabber

the frame grabber offers up to 8 partitions for applets (depending on the frame grabber model you are using). Each partition contains one applet. On partition 0, the SAVE configuration is stored. For partitions (1 to 7), you can define which applet(s) you want to store there.

You can use any of the applets you flashed onto partitions 1 to 7 for frame grabber (FPGA) configuration. To switch between these applets does not require new flashing. (How to switch, see Re-Configuring the FPGA with Another Applet .

The applets are marked as follows:

Symbol

Meaning

This is the currently active applet, i.e., the applet the frame grabber is configured with at the moment.
The frame grabber will be configured with this applet at system start (boot partition). 1
This applet is available in the file system (in the same version). No newer version available in the file system.
This applet is not available in the file system (or in another version than the one that is flashed on the frame grabber).
This is the Safe Configuration. It's a fall back option. In case a problem occurs with the active configuration (i.e., during flashing) , the frame grabber uses this configuration. The Safe Configuration is always stored on partition 0.

To flash a partition with an applet, or to re-flash a partition with another applet:

  1. Click the search button.

The program leads you to a file selection dialog. 

  1. Select the applet (*.dll file or *.hap file) you need by clicking on the file name.

DLL files: You find all *.dll files in the following sub-directory (default): [runtime installation directory]/Dll/LB-ACL

HAP files: You find all *.hap files in the following sub-directory (default): [runtime installation directory]/Hardware Applets/LB-ACL


Cannot See the Applet You Want to Flash?

 

If you want to flash an individual applet (*.hap file), you need to copy it to the file system of your host PC (into folder Hardware Applets in the runtime installation directory) before you can flash it onto the frame grabber. For instructions on how to do this, refer to Adding an Applet Manually.

   
  1. Click on Open.

The selected file is displayed now for the partition; the selected file is highlighted in yellow.

  1. Continue and select applets for all partitions you want to flash.
  2. Repeat steps 3 to 8 for all the frame grabber boards in your system you want to flash.
  3. Click the Flash Now button .

The Flash Dialog opens. The dialog lists the boards and partitions you want to flash together with the names of the selected applets:

  1. Click Flash.

The flashing process gets started now:

Flashing in progress – as displayed in microDiagnostics

Flashing Multiple Boards in Parallel

 

You may define more than one frame grabber board for flashing. When you then click the Flash Now button and confirm the boards and applets listed in the Flash Dialog by clicking Flash, the boards are flashed in parallel.

   

 

Attention!

 

If you experience any problems, keep the frame grabber powered and call the Silicon Software Support department.

 

 
  1. Wait until the new applet(s) is/are completely installed. You will get an according message.

Possible Effects of Flashing an Active Partition

 

Flashing an active partition on one the frame grabber board will result in the following system behavior if the Siso Generic Service (gs) is used to manage camera connections: 

  • The Siso Generic Service (gs) is re-started for all frame grabber boards in the host PC that use the service. Depending on the number of boards installed in the host, this may take some time.
  • The camera connections on all frame grabbers connected to the host PC are reset. The cameras need to be re-discovered.
  • During restart of the Siso Generic Service (gs) , all GUI applications (microDisplay/microDisplay X, microDiagnostics, GenICam Explorer) will appear as "Not Responding".

   

After flashing non-active partitions

If you flashed only partitions that did not contain the currently active applet, you will get the following message: Flashing Done.

In this case, you are done with flashing and can continue with other activities, e.g., with configuring the FPGA on the frame grabber (Re-Configuring the FPGA with Another Applet ).

  1. Close the Flash Dialog.

You can now see the applet selection that is available on the frame grabber

Using Virtual COM Ports

 

If you are using virtual COM Ports (using the Silicon Software ClSerCOM Wrapper): You always need to re-start the host PC after flashing.

This is not reflected in the messages output by microDisplay/microDisplay X.

   

After flashing the active partition

If, on the contrary, you flashed the partition that did contain the active applet, and if your host PC supports live reconfiguration2 of the FPGA (see chipset lists below), you get one of the following messages (A, B or C) after flashing:

A) Restarting Applications: 

Flashing Done. Please restart all applications using the board.

The applets have been flashed successfully.

  1. Close all applications of the Silicon Software runtime environment (microDisplay/microDisplay X, microDiagnostics, GenICam Explorer).

After re-opening the runtime programs, the programs will provide access to the applet you just flashed onto the active partition of the FPGA. You can continue with configuring the applet via microDisplay X (see Initial System Test) or via SDK.

 

PCs supporting Live Reconfiguration, Behavior A

 

High-end mainboards with server level chipset support this behavior. The following chipsets are known to support FPGA live configuration without reboot in some mainboards:

  • Intel® X58 Express
  • Intel® X79 Express
  • Intel® Z87 (Z99)

We do not guarantee behaviour A with the aforementioned chipsets.

   

B) Optionally rebooting host PC:

Flashing Done. You should reboot your computer for the changes to be completed.

The applets have been flashed successfully, but due to the new applet on the active partition of the FPGA, the PCI speed is reduced3 after flashing. To get the full PCI bandwidth4 when using this applet, you need to reboot your host PC:

  1. Reboot your host PC to get the full PCI bandwidth.

After re-boot, you get the full bandwidth on the PCI interface. The runtime programs will provide access to the applet you just flashed onto the active partition of the FPGA. You can continue with configuring this applet via microDisplay X (see Initial System Test) or via SDK.

 

PCs supporting Live Reconfiguration, Behavior B

 

High-end mainboards with server level chipset support this behavior. The following chipsets are known to support FPGA live configuration without reboot in some mainboards:

  • Intel® X58 Express
  • Intel® X79 Express
  • Intel® Z87 (Z99)

We do not guarantee behaviour B with the aforementioned chipsets.

   

C) Rebooting host PC:

Flashing Done. You must reboot your computer for the changes to take effect.

The applets have been successfully flashed, also the one that has been flashed onto the active partition of the frame grabber. To configure the applet on the active partition, you need to reboot your host PC.

  1. Reboot your host PC.

After re-boot, the runtime programs will provide access to the applet on the active partition. You can continue with configuring this applet via microDisplay X (see Initial System Test) or via SDK.

 

PCs Requiring Reboot, Behavior C

 

The following chipsets are known to require a reboot after FPGA configuration:

  • Intel® C220
  • Intel® H87
   

 

Using Virtual COM Ports

 

If you are using virtual COM Ports (using the Silicon Software ClSerCOM Wrapper): You always need to re-start the host PC after flashing.

This is not reflected in the messages output by microDisplay/microDisplay X.

 

 

What do I flash on microEnable IV? 

 

Firmware: To use a new firmware version, you will need to flash your mE4 frame grabber board.

Applets: To configure the image processing FPGA with another applet, you do not need to re-flash your mE4 frame grabber board. Any applet available in the runtime installation (directories [runtime installation directory]/Runtime5.5\Dll or [runtime installation directory]/Hardware Applets) can be used for frame grabber re-configuration without flashing the board.

   

To flash a microEnable 4 board with new firmware:

  1. Make sure the new firmware version is available in your runtime installation (directory [runtime installation directory]/Firmware). If not available, copy the firmware file into this directory.
  1. Close microDisplay if open and make sure no instance of microDisplay is open on your system.
  2. Start the tool microDiagnostics (e.g., directly out of the installation directory [runtime installation directory]/bin/microDiagnostics.exe).

In the microDiagnostics program window that opens:

  1. Select the microEnable 4 board you want to install the firmware on:

  1. Click the button Manage Firmware/Applet(s).

In the lower part of the program window, the firmware currently flashed on the board is listed:

If you see the icon: The firmware version on the board is different to the firmware version that is available in your runtime installation.

  1. Click the search button .

The Select new Firmware dialog opens:

If you want to use the newer firmware version:

  1. Select the file provided in the Select new Firmware dialog and click Open.

The firmware you selected for flashing is now displayed in microDiagnostics. It is highlighed in yellow to show that it has been selected, but is not flashed yet.

If you are sure you want to use this firmware version on your mE4 frame grabber board:

  1. Click the Flash Now button .

The Flash Dialog opens.

  1. Check if the board and firmware version that are displayed are the ones you intend to flash.
  2. If yes, click on Flash.

The flashing Process is started now: 

As soon as the flashing process is finished, you get the message Flashing is complete in the Flash Dialog:

To complete flashing, you need to power cycle your computer.

To power cycle your computer: 

  1. Shut Down your computer.
  2. After the computer is completely off, wait for some seconds.
  3. Start the computer again.

Complete Shut Down Essential

 

For power cycling, it is not enough to use the Restart option of Windows. Complete shut down and following new start are essential when you need to power cycle your computer.

   

Afterward, the new firmware is available on the board: 

  1. Proceed with

 

Individual Applets

 

If you got an individual applet not in form of an installer, but as a single *.hap file from an external source: Make sure the applet has come to you in a *.zip archive.

The applet file (*.hap) has to be transferred from the VisualApplet developers machine savely protected in a *.zip archive. Otherwise, it may get corrupted under way.

microDiagnostics will tell you when the applet has become corrupted. In this case, get an uncorrupted version of the applet (*.hap) file you intend to use, and re-flash the frame grabber.

   

Requirements

Before you can flashthe frame grabberwith an applet file (*.hap or *.dll), you need to have this file available in the file system of your host PC:

To install an applet on the frame grabber:

  1. Close microDisplay if open and make sure no instance of microDisplay is open on your system.
  2. Start the tool microDiagnostics (e.g., directly out of the installation directory: [runtime installation directory]/bin/microDiagnostics.exe)

In the microDiagnostics program window that opens:

  1. Select the the frame grabber device you want to install the applet on:

  1. Click the button Manage Firmware and Applets.

The applet that is currently flashed onto the board is displayed:

  1. To flash the board with another applet, click on the search button .

In the dialog Select new Firmware, all applets that are available for the board in your runtime installation are displayed:

  1. Select the applet you want to flash the board with, and click Open.

 

Cannot See the Applet You Want to Flash?

 

If you want to flash an applet (*.hap file) onto the frame grabber, you need to have it available in the file system of your host PC .

  • Applets that come as *.dll files you need to have stored in directory [runtime installation directory]/DLL.
  • Applets Applets that come as *.hap files you need to have stored in directory [runtime installation directory]/Hardware Applets.
   

The selected applet is now displayed in microDiagnostics. It is highlighed in yellow to show that it has been selected, but is not flashed yet.

To actually flash the applet to the SPI/BPI flash memory on the frame grabber:

  1. Click the Flash Now button .

The Flash Dialog opens.

  1. Check if stated selected board and applet are the ones you intend to flash.
  2. Click on Flash.

The flashing Process is started now: 

As soon as the flashing process is finished, you get the message Flashing is complete in the Flash Dialog:

  1. To complete flashing, follow the instructions the Flash Dialog displays:

The applet that has been flashed and is available now in the SPI/BPI flash memory of the frame grabber is displayed in microDiagnostics:

 

Possible Effects of Flashing

 

Flashing on the frame grabber board will result in the following system behavior if the Siso Generic Service (gs) is used to manage camera connections: 

  • The Siso Generic Service (gs) is re-started for all frame grabber boards in the host PC that use the service. Depending on the number of boards installed in the host, this may take some time.
  • The camera connections on all frame grabbers connected to the host PC are reset. The cameras need to be re-discovered.
  • During restart of the Siso Generic Service (gs) , all GUI applications (microDisplay, microDiagnostics, GenICam Explorer) will appear as "Not Responding".