Changelog
Version | Remark |
|---|---|
1.0 | Initial Release |
Table: Changelog
Introduction
...
This document describes the process of updating the firmware of the ccm module.
Document structure
Chapter | Content |
|---|---|
Introduction | Introduction of this document |
Update Methods | Overview over firmware update methods |
Update Method HTTP | Firmware update method HTTP |
Update Method FoE | Firmware update method EtherCAT/FoE |
Update Method SPI | Firmware update method SPI |
Reset | Reset and Firmware update |
Table: Content of this document
...
Following methods for firmware update are available:
Method | Description |
|---|---|
HTTP | Firmware upload using an HTTP-POST Request, used by the Industrial Communication Explorer |
FoE | Firmware upload using an EtherCAT FoE transfer, used by the communication explorer tool for EtherCAT devices |
SPI | Firmware upload using RPC functions by the application controller |
Table: Firmware update methods
...
The following table shows the default behaviour for firmware update regarding commit:
Method | Firmware Commit configuration |
|---|---|
HTTP | by default commit is required, thus a specific URL has to be requested after firmware update which triggers the commit |
FoE | commit is automatically done after booting of the updated firmware |
SPI | commit is automatically done after booting of the updated firmware |
Table: Firmware update commit configuration
...
Firmware is delivered as a firmware package. This file, e.g. irj45_1.2.0.35_ci1243.pfw, is basically a zip archive which contains the following files:
File | Description |
|---|---|
bundle/bundle.xml | bundle description |
irj45_2port.dat | firmware update file for HTTP method |
irj45_2port.bin | firmware update file for FoE/SPI method |
Table: firmware update bundle content
...
All variables are associated to module id GOAL_CM_HTTP_MOD_ID (25).
Level | varId |
|---|---|
0 | HTTP_CM_VAR_USERLEVEL0 (2) |
1 | HTTP_CM_VAR_USERLEVEL1 (3) |
2 | HTTP_CM_VAR_USERLEVEL2 (4) |
3 | HTTP_CM_VAR_USERLEVEL3 (5) |
Table: HTTP Authentication credentials
...
| Code Block |
|---|
GOAL_STATUS_T appl_ccmUpdateAllow(
void
);
GOAL_STATUS_T appl_ccmUpdateDeny(
void
); |
| Info |
|---|
Please note if you are using uGOAL: Please consider increasing available RPC handles (e.g. per define |
Authentication
Firmware update over FoE supports authentication. Authentication credentials are compared against CM variables:
All variables are associated to module id GOAL_CM_CCM_MOD_ID (72).
Property | varId |
|---|---|
FoE filename | CCM_CM_VAR_FOE_FILENAME (9) |
FoE filename match length | CCM_CM_VAR_FOE_FILENAME_MATCH_LENGTH (12) |
FoE password | CCM_CM_VAR_FOE_PASSWORD (10) |
FoE state | CCM_CM_VAR_FOE_UPDATE_REQUIRES_BOOT (11) |
Table: FoE Authentication credentials
...