Difference between revisions of "Updating your SIM Firmware & Cargo from Removable Media"

From Serious Documentation
Jump to: navigation, search
(Created page with "== Release/Platform Support == Starting with 5.0.211 firmware release, Serious will begin introducing the ability to upgrade firmware, splash images, and GUI cargo file via re...")
 
(→‎Release/Platform Support)
Line 1: Line 1:
−
== Release/Platform Support ==
+
== Supported Platforms by Release ==
 
Starting with 5.0.211 firmware release, Serious will begin introducing the ability to upgrade firmware, splash images, and GUI cargo file via removable media.
 
Starting with 5.0.211 firmware release, Serious will begin introducing the ability to upgrade firmware, splash images, and GUI cargo file via removable media.
  
Line 24: Line 24:
 
|}
 
|}
  
−
The 5.0.211 release supports the SIM115, 225, and 231, with a future release planned to add support for the SIM535's USB Host port and SD Card socket.
+
== File Names and Locations ==
 +
 
 +
All files must be in the root directory of the removable media. The names are fixed as follows:
 +
 
 +
{| class="wikitable" style="text-align:center; width:100%; margin: 1em 0;"
 +
! File Name
 +
! Content
 +
! Type
 +
|-
 +
| SHIPAPPL.shp
 +
| SHIPEngine or installer application
 +
| .shp SHIP Firmware Executable
 +
|-
 +
| SHIPTUGB.shp
 +
| [[SHIPTug]] full-featured boot loader
 +
| .shp SHIP Firmware Executable
 +
|-
 +
| SHIPPADD.shp
 +
| [[SHIPPaddle]] early stage boot loader
 +
| .shp SHIP Firmware Executable
 +
|-
 +
| SHIPUSER.shp
 +
| User binary, unused by SHIP
 +
| Any user format
 +
|-
 +
| SHIPBOOT.shi
 +
| Booting splash image
 +
| Serious Image Format from SHIPTide
 +
|-
 +
| SHIPAPPL.shi
 +
| Application/GUI loading splash image
 +
| Serious Image Format from SHIPTide
 +
|-
 +
| SHIPUPDT.shi
 +
| Firmware updating splash image
 +
| Serious Image Format from SHIPTide
 +
|-
 +
| SHIPERRR.shi
 +
| Error splash image
 +
| Serious Image Format from SHIPTide
 +
|-
 +
| SHIPREMV.shi
 +
| Remove media now splash image
 +
| Serious Image Format from SHIPTide
 +
|}
 +
 
 +
== Update Process ==
 +
 
 +
Removable media updates can only be performed from the [[SHIPTug]] boot loader.
 +
 
 +
In [[SHIPEngine]], when media is inserted (e.g. a thumb drive is plugged in or an SD Card inserted), [[SHIPEngine]] scans the media for any of these files.  If any of these files exist on the media, the GUI is halted and the system is rebooted. As part of the [[SHIPv5 Boot System]], the [[SHIPTug]] boot loader is then executed.
 +
 
 +
In [[SHIPTug]] any inserted media is (re)scanned for the presence of any update files. If they do not exist, the normal boot process will continue.
 +
 
 +
If any of the named files exist, the OEM-created "update" splash image (SHIPUPDT.shi) will displayed if it exists, then the update process will proceed.
 +
 
 +
In the update process, the files, one by one, will be copied over to the SIM. Each file will be stored in the appropriate place on the SIM for its type, which may vary by SIM.
 +
 
 +
When the update process is complete, the OEM-created "remove" splash image (SHIPREMV.shi) will be displayed if it exists, otherwise a fixed English language only prompt will be displayed, indicating to the operator to remove the media. The system will not continue until this is performed.
 +
 
 +
When the media is removed, the system will automatically reboot and use any new files uploaded.
 +
 
 +
== Preventing Auto-Updates ==
 +
 
 +
There are several upcoming mechanisms to prevent and control the update process.
 +
 
 +
In Bridge Version 2 (coming in 5.0.300) any firmware content on a Bridge Device can be "locked" from an Bridge Host. Locked files will not be considered for update.
 +
 
 +
Also coming in 5.0.300 is the ability to set various persistent variables to control/prevent the update of each content type. For example, setting a specific Boolean persistent variable to "true" will prevent the auto-updating of the [[SHIPTug]] boot loader from the 'SHIPTUGB.shp' file even if it exists on the removable media -- that file will be ignored.

Revision as of 06:48, 10 October 2015

Supported Platforms by Release

Starting with 5.0.211 firmware release, Serious will begin introducing the ability to upgrade firmware, splash images, and GUI cargo file via removable media.

Release Platform(s) Port
5.0.211 SIM115, SIM225, SIM231 USB Host
future SIM535 SD Card
future SIM535 USB Host
future SIM245, SIM255, SIM555, SIM855 SD Card, USB Host

File Names and Locations

All files must be in the root directory of the removable media. The names are fixed as follows:

File Name Content Type
SHIPAPPL.shp SHIPEngine or installer application .shp SHIP Firmware Executable
SHIPTUGB.shp SHIPTug full-featured boot loader .shp SHIP Firmware Executable
SHIPPADD.shp SHIPPaddle early stage boot loader .shp SHIP Firmware Executable
SHIPUSER.shp User binary, unused by SHIP Any user format
SHIPBOOT.shi Booting splash image Serious Image Format from SHIPTide
SHIPAPPL.shi Application/GUI loading splash image Serious Image Format from SHIPTide
SHIPUPDT.shi Firmware updating splash image Serious Image Format from SHIPTide
SHIPERRR.shi Error splash image Serious Image Format from SHIPTide
SHIPREMV.shi Remove media now splash image Serious Image Format from SHIPTide

Update Process

Removable media updates can only be performed from the SHIPTug boot loader.

In SHIPEngine, when media is inserted (e.g. a thumb drive is plugged in or an SD Card inserted), SHIPEngine scans the media for any of these files. If any of these files exist on the media, the GUI is halted and the system is rebooted. As part of the SHIPv5 Boot System, the SHIPTug boot loader is then executed.

In SHIPTug any inserted media is (re)scanned for the presence of any update files. If they do not exist, the normal boot process will continue.

If any of the named files exist, the OEM-created "update" splash image (SHIPUPDT.shi) will displayed if it exists, then the update process will proceed.

In the update process, the files, one by one, will be copied over to the SIM. Each file will be stored in the appropriate place on the SIM for its type, which may vary by SIM.

When the update process is complete, the OEM-created "remove" splash image (SHIPREMV.shi) will be displayed if it exists, otherwise a fixed English language only prompt will be displayed, indicating to the operator to remove the media. The system will not continue until this is performed.

When the media is removed, the system will automatically reboot and use any new files uploaded.

Preventing Auto-Updates

There are several upcoming mechanisms to prevent and control the update process.

In Bridge Version 2 (coming in 5.0.300) any firmware content on a Bridge Device can be "locked" from an Bridge Host. Locked files will not be considered for update.

Also coming in 5.0.300 is the ability to set various persistent variables to control/prevent the update of each content type. For example, setting a specific Boolean persistent variable to "true" will prevent the auto-updating of the SHIPTug boot loader from the 'SHIPTUGB.shp' file even if it exists on the removable media -- that file will be ignored.

Retrieved from "https://techref.myserious.com/index.php?title=Updating_your_SIM_Firmware_%26_Cargo_from_Removable_Media&oldid=5057"