Snom m3/Firmware/Update

From Snom User Wiki

Jump to: navigation, search

To ensure that your snom m3 has the proper firmware installed, we recommend to update the firmware once before you have configured and set up the VoIP phone.

Contents

File List

.fwu files

The .fwu files contain binary images of the target software. The file format is optimized for remote firmware updating and is proprietary. A firmware version consists of a handset file and a gateway file.

Handset file

NamePp_<language-_<version-info.fwu
Example: SnakePp_fr01_v0790.fwu

Gateway file

NameGw_<language-_<version-info.fwu
Example: SnakeGw_fr01_v0790.fwu

DirList.txt

Release and address information are published in a text file, dirlist.txt, which must be placed in the same folder as the firmware files. By default, the phone requests its firmware files from <ROOT-</Updates-/. 

Examples:
E:\TFTP-Root\Data\Updates\
E:\TFTP-Root\Data\Updates\UserGroup1\

Example of folder content:
DirList.txt
SnakeGw_fr01_v0790.fwu
SnakePp_fr01_v0790.fwu

NOTE: You may not see an English language file in the list of firmware files. English is embedded in every language file to make it easy to switch back to it without having to load new firmware. The German language file is loaded by default.

NOTE: If you are using a TFTP server, your file path may require a leading forward slash. Enable logging onto your TFTP server to be able to determine if this is the case. Some TFTP servers have a file path limit of 32 characters. In this case, you will have to ensure your path name stays within those limits.

The dirlist.txt is a text file automatically generated by the MakeDirList.exe tool. The tool generates the text file based on information from the .fwu files and the manually edited DisplayInfo.txt.

DisplayInfo.txt

This file contains the information shown in the firmware upgrade user interface on the phone.

Example of DisplayInfo.txt: 

[0605]
DisplayName=Version0605
DisplayInfo=Internal SW release
DisplayRelDate=0605241700

[0001]
DisplayName=Version0001

Example of dirlist.txt 

(DirFileFormat=001
Version v0605

Display name: Version0605
Display info: Internal SW release
Display release date: 24/5 2006 17:00

Filename: SnakeGw_v0605.fwu
 Low area:
   Device ID: 0xd9a0010
   Start address: 0x81000
   Link date: 24/5 2006 16:40
 High area: not used

Filename: SnakePp_v0605.fwu
 Low area:

   Device ID: 0xd9a0011
   Start address: 0x81000
   Link date: 24/5 2006 16:56
 High area:
   Device ID: 0xd9a0011
   Start address: 0x160000

Notification of Available Update

When new firmware is available, the message Update available will appear on the idle display.

Time Required for Update

Depending on the number of handsets registered with any given gateway and the speed of the Internet connection, the update time can vary considerably. The gateway and all handsets registered to it are updated serially.

  • Average time to update gateway: About five minutes
  • Average time to update each handset: About twelve minutes

EXAMPLE: If a firmware update is initiated for a gateway with 4 registered handsets, the total upgrade time will be around 53 minutes (5 + 12 + 12 + 12 + 12).

WARNING: Initiating an update on one of the handsets will trigger updates on all handsets registered to the same gateway as well. Registering a new handset to a gateway will also trigger an update on all handsets registered to the same gateway if the new handset is not running the same firmware version as the gateway.

Update Types

Manual Update

  1. Press the OK key, then select Settings / System Settings.
  2. Enter the access/PIN code. The default value is 0000.
  3. Select Firmware Update.
  4. Select the version currently running on the phone.
  5. Select English. The Update System? prompt appears.
  6. Select Yes.

The update will begin.

Warning: Do not turn off the power to the gateway during the update. The handsets cannot be used to make or receive calls while the update is in progress.

Scheduled Firmware Updates

Make the following changes in the configuration files:

  • At an absolute time
  1. Enable scheduled firmware updates by changing the value of FWU_POLLING_ENABLE to '1': %FWU_POLLING_ENABLE%:1
  2. Change the value of polling mode in FWU_POLLING_ENABLE to '0': %FWU_POLLING_ENABLE%:0
  3. Set the time on the 24-hour clock when the update shall take place by entering the appropriate value in FWU_POLLING_TIME_HH (full hour) and FWU_POLLING_TIME_MM (minutes after the hour)
  4. Reset the gateway.
    • Warning: Do not turn off the power to the gateway during the update. The handsets cannot be used to make or receive calls while the update is in progress.
  • At a relative time upon booting
  1. Enable scheduled firmware updates by changing the value of FWU_POLLING_ENABLE to '1': %FWU_POLLING_ENABLE%:1
  2. Change the value of polling mode in FWU_POLLING_ENABLE to '1': %FWU_POLLING_ENABLE%:1
  3. Enter the number of seconds upon booting after whose passage the update shall take place as the value of FWU_POLLING_PERIOD.
    • Example: The value '21600' will trigger an update six hours after booting:
  4. Reset the gateway.
    • Warning: Do not turn off the power to the gateway during the update. The handsets cannot be used to make or receive calls while the update is in progress.

Update with SIP Check-sync Notification

  1. Send a check-sync notification from the IP PBX to the gateway to be updated. If the gateway is running a different version than the one stored on the update server, it will start start an updateimmediately.
  2. When the update has been completed successfully, the handset's display will show the message Upgraded to <version number>.
    • Warning: Do not turn off the power to the gateway during the update. The handsets cannot be used to make or receive calls while the update is in progress.

Firmware update error codes

A number of errors can occur when initiating a firmware update or while firmware update is in progress. In the following all error codes will be described:

  • Code 0: No problems - This error code indicates that everything is working as specified.
  • Code 1: Wrong parameter - Code 1 is an internal error code that indicates that the firmware update application cannot access the selected software version (The selected software is not present in the dir list).
  • Code 2: Network not available - Network not available is presented to the user when the phone experiences some network problem. This can be due to an unplugged Ethernet cable, furthermore are most HTTP/1.1 response codes are presented to the user as a network error.
  • Code 3: VOIP_FWU_STATUS_UNKNOWN - Code 3 can indicate that the firmware file is not found on the firmware update server (HTTP/1.1 404).
  • Code 4: Firmware files too big - The firmware update file is too big
  • Code 5: Timeout waiting for file - The server is busy and cannot process the get request within a reasonable time.
  • Code 6: Server not specified - Firmware update server is not specified.
  • Code 7: VOIP_FWU_STATUS_UNSPECIFIED_ERROR - Code 7 covers a lot of misc. errors e.g. wrong format for the downloaded firmware update file.
  • Code 8: Illegal use of the Firmware updates API - Abuses of the firmware update API.
  • Code 9: Syntax error found in the DirFile - The DirFile contains all information needed for a firmware update; this includes information about code size, link date, languages and so on. Code 9 indicates that there is a syntax error in the DirFile.
  • Code 10: Unknown format of DirFile - The downloaded DirFile is of an unknown format. This could indicate that the VoIPLan dualphone is downloading firmware from a wrong folder on the firmware update server.
  • Code 11: Server name lookup failed - The DNS server cannot determine the IP address for the provided firmware update server.
  • Code 12: Authentication failed - The HTTP request for the DirFile or firmware files failed with a HTTP/1.1 401 response code. This indicates that either the username or password is incorrect.
Retrieved from "http://wiki.snom.com/Snom_m3/Firmware/Update"
Personal tools
VoIP Products
Interoperability