SIM Firmware and Cargo Update from Removable Media (v5.1)

From Serious Documentation
Jump to: navigation, search

File Names and Locations

All files considered for updating must reside in the "update/" folder located at the root of the removable media. The names are fixed as follows:

File Name Description
SHIPAPPL.shp SHIPEngine installer application. It is a 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
SHIPBOOT.shp Booting splash image Serious Image Format from SHIPTide
SHIPLOAD.shp Application/GUI loading splash image Serious Image Format from SHIPTide
SHIPUPDT.shp Firmware updating splash image Serious Image Format from SHIPTide
SHIPERRR.shp Error splash image Serious Image Format from SHIPTide
SHIPREMV.shp Remove media now splash image Serious Image Format from SHIPTide
SHIPCARG.shp Cargo file from SHIPTide

Note 1:
APPL and INSTALL files are different types but have the same name (SHIPAPPL.shp).

Update Process

Step 1
Insert the media (e.g. a thumb drive is plugged in or an SD Card inserted).
Step 2
If SHIPTug is running when the media is inserted, the media is scanned for the presence of any of the above mentioned files.
  1. If any of the listed files do exist, the OEM-created "update" splash image (SHIPUPDT.shp) will be displayed if it itself exists.
    *** Then the update process will proceed to Step 4. ***
  2. If none of the above listed files exist, the normal boot process will continue to SHIPEngine in Step 3.
Step 3
If SHIPEngine is running at the time the media is inserted, SHIPEngine then scans the media for any of the above mentioned files.
  1. If any of the listed files do exist on the media, the GUI is halted and the system is rebooted.
    *** The process will continue with SHIPTug in Step 3. ***
  2. If none of the listed files exist, update process is exited.
    *** Normal GUI operations continue. ***
Step 4
In the update process, the files, one by one, will be copied over to the SIM. Each file will be stored in its appropriate place within the SIM for its type. The location may vary by SIM.
Step 5
Once the update process has completed, the OEM-created "remove" splash image (SHIPREMV.shp) 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. ***
Step 6
Remove the media and the system will automatically reboot and use any new files uploaded during its boot sequence.


Note 2:
If there is an error during cargo load, the firmware update, or critical error during cargo execution, the splash image (SHERRR.shp) will be displayed until the board reboots.