Revision d54d2f07 Target/Modules/LightRing_1-0/Boot/blt_conf.h

View differences:

Target/Modules/LightRing_1-0/Boot/blt_conf.h
23 23
* You should have received a copy of the GNU General Public License along with OpenBLT.
24 24
* If not, see <http://www.gnu.org/licenses/>.
25 25
*
26
* A special exception to the GPL is included to allow you to distribute a combined work 
27
* that includes OpenBLT without being obliged to provide the source code for any 
26
* A special exception to the GPL is included to allow you to distribute a combined work
27
* that includes OpenBLT without being obliged to provide the source code for any
28 28
* proprietary components. The exception text is included at the bottom of the license
29 29
* file <license.html>.
30
* 
30
*
31 31
* \endinternal
32 32
****************************************************************************************/
33 33
#ifndef BLT_CONF_H
......
37 37
*   C P U   D R I V E R   C O N F I G U R A T I O N
38 38
****************************************************************************************/
39 39
/* To properly initialize the baudrate clocks of the communication interface, typically
40
 * the speed of the crystal oscillator and/or the speed at which the system runs is 
40
 * the speed of the crystal oscillator and/or the speed at which the system runs is
41 41
 * needed. Set these through configurables BOOT_CPU_XTAL_SPEED_KHZ and
42 42
 * BOOT_CPU_SYSTEM_SPEED_KHZ, respectively. To enable data exchange with the host that is
43
 * not dependent on the targets architecture, the byte ordering needs to be known. 
44
 * Setting BOOT_CPU_BYTE_ORDER_MOTOROLA to 1 selects little endian mode and 0 selects 
43
 * not dependent on the targets architecture, the byte ordering needs to be known.
44
 * Setting BOOT_CPU_BYTE_ORDER_MOTOROLA to 1 selects little endian mode and 0 selects
45 45
 * big endian mode.
46
 * 
46
 *
47 47
 * Set BOOT_CPU_USER_PROGRAM_START_HOOK to 1 if you would like a hook function to be
48 48
 * called the moment the user program is about to be started. This could be used to
49 49
 * de-initialize application specific parts, for example to stop blinking an LED, etc.
50
 */ 
50
 */
51 51
/** \brief Frequency of the external crystal oscillator. */
52 52
#define BOOT_CPU_XTAL_SPEED_KHZ         (8000)
53 53
/** \brief Desired system speed. */
......
66 66
 * have to be controlled by this bootloader. Additionally the bootloader should be able
67 67
 * to send program code of user programs for other devices.
68 68
 * Make sure that one of the communication interfaces is the gateway!
69
 */ 
69
 */
70 70
/** \brief Bootloader of main device. */
71 71
#define BOOTLOADER_OF_MAIN_DEVICE       (0)
72 72

  
......
74 74
/****************************************************************************************
75 75
*   C O M M U N I C A T I O N   I N T E R F A C E   C O N F I G U R A T I O N
76 76
****************************************************************************************/
77
/* The CAN communication interface is selected by setting the BOOT_COM_CAN_ENABLE 
77
/* The CAN communication interface is selected by setting the BOOT_COM_CAN_ENABLE
78 78
 * configurable to 1. Configurable BOOT_COM_CAN_BAUDRATE selects the communication speed
79
 * in bits/second. Two CAN messages are reserved for communication with the host. The 
79
 * in bits/second. Two CAN messages are reserved for communication with the host. The
80 80
 * message identifier for sending data from the target to the host is configured with
81 81
 * BOOT_COM_CAN_TXMSG_ID. The one for receiving data from the host is configured with
82
 * BOOT_COM_CAN_RXMSG_ID. The maximum amount of data bytes in a message for data 
83
 * transmission and reception is set through BOOT_COM_CAN_TX_MAX_DATA and 
82
 * BOOT_COM_CAN_RXMSG_ID. The maximum amount of data bytes in a message for data
83
 * transmission and reception is set through BOOT_COM_CAN_TX_MAX_DATA and
84 84
 * BOOT_COM_CAN_RX_MAX_DATA, respectively. It is common for a microcontroller to have more
85 85
 * than 1 CAN controller on board. The zero-based BOOT_COM_CAN_CHANNEL_INDEX selects the
86 86
 * CAN controller channel.
87
 * 
87
 *
88 88
 */
89 89
/** \brief Enable/disable CAN transport layer. */
90 90
#define BOOT_COM_CAN_ENABLE             (1)
91 91
/** \brief Configure the desired CAN baudrate. */
92
#define BOOT_COM_CAN_BAUDRATE           (500000)
92
#define BOOT_COM_CAN_BAUDRATE           (1000000)
93 93
/** \brief Configure CAN message ID target->host. */
94
#define BOOT_COM_CAN_TX_MSG_ID          (0x700) //(0x667) //(0x7E1)
94
#define BOOT_COM_CAN_TX_MSG_ID          (0x700)
95 95
/** \brief Configure number of bytes in the target->host CAN message. */
96 96
#define BOOT_COM_CAN_TX_MAX_DATA        (255)
97 97
/** \brief Configure CAN message ID host->target. */
98
#define BOOT_COM_CAN_RX_MSG_ID          (0x600) //(0x7E1) //(0x667)
98
#define BOOT_COM_CAN_RX_MSG_ID          (0x600)
99 99
/** \brief Configure number of bytes in the host->target CAN message. */
100 100
#define BOOT_COM_CAN_RX_MAX_DATA        (255)
101 101
/** \brief Select the desired CAN peripheral as a zero based index. */
102 102
#define BOOT_COM_CAN_CHANNEL_INDEX      (0)
103
/** \brief Configure CAN message acknowledgement ID addition (ORed with original ID). */
104
#define BOOT_COM_CAN_MSG_ACK            (0x001)
105
/** \brief Configure CAN message ID addition for continuous messages (ORed with original ID). */
106
#define BOOT_COM_CAN_MSG_SUBSEQUENT     (0x002)
107

  
108
/**
109
 * \brief Configure device ID for communication (start with 1).
110
 * \details The device ID is a 32 bit integer, which can be interpreted bytewise:
111
 *            <AMiRo_revision>:<moduleID>:<moduleVersion_major>:<moduleVersion_minor>
112
 *          For this module the according values are
113
 *            1:127:1:0 = 0x017F0100
114
 */
115
#define BOOT_COM_DEVICE_ID              (0x017F0100)
116
/** \brief Configure legacy device ID. */
117
#define BOOT_COM_DEVICE_LEGACY_ID       (0x3)
103 118

  
104
/** \brief Configure device ID for communication (start with 1). */
105
#define BOOT_COM_DEVICE_ID              (0x3)
106 119

  
107
/* The UART communication interface is selected by setting the BOOT_COM_UART_ENABLE 
120
/* The UART communication interface is selected by setting the BOOT_COM_UART_ENABLE
108 121
 * configurable to 1. Configurable BOOT_COM_UART_BAUDRATE selects the communication speed
109
 * in bits/second. The maximum amount of data bytes in a message for data transmission 
110
 * and reception is set through BOOT_COM_UART_TX_MAX_DATA and BOOT_COM_UART_RX_MAX_DATA, 
122
 * in bits/second. The maximum amount of data bytes in a message for data transmission
123
 * and reception is set through BOOT_COM_UART_TX_MAX_DATA and BOOT_COM_UART_RX_MAX_DATA,
111 124
 * respectively. It is common for a microcontroller to have more than 1 UART interface
112 125
 * on board. The zero-based BOOT_COM_UART_CHANNEL_INDEX selects the UART interface.
113
 * 
126
 *
114 127
 */
115 128
/** \brief Enable/disable UART transport layer. */
116 129
#define BOOT_COM_UART_ENABLE            (1)
117 130
/** \brief Configure the desired communication speed. */
118
#define BOOT_COM_UART_BAUDRATE          (115200) //(57600)
131
#define BOOT_COM_UART_BAUDRATE          (115200)
119 132
/** \brief Configure number of bytes in the target->host data packet. */
120 133
#define BOOT_COM_UART_TX_MAX_DATA       (255)
121 134
/** \brief Configure number of bytes in the host->target data packet. */
......
130 143
*   F I L E   S Y S T E M   I N T E R F A C E   C O N F I G U R A T I O N
131 144
****************************************************************************************/
132 145
/* The file system interface is selected by setting the BOOT_FILE_SYS_ENABLE configurable
133
 * to 1. This enables support for firmware updates from a file stored on a locally 
134
 * attached file system such as an SD-card. Note that this interface can be enabled 
146
 * to 1. This enables support for firmware updates from a file stored on a locally
147
 * attached file system such as an SD-card. Note that this interface can be enabled
135 148
 * together with one of the remote communication interfaces such as UART, CAN or USB.
136 149
 *
137 150
 * Set BOOT_FILE_LOGGING_ENABLE to 1 if you would like log messages to be created during
......
145 158
 * additional information on the error cause.
146 159
 *
147 160
 * Set BOOT_FILE_STARTED_HOOK_ENABLE to 1 if you would like to be informed when a new
148
 * firmware update is started by the bootloader. 
161
 * firmware update is started by the bootloader.
149 162
 *
150 163
 * Set BOOT_FILE_COMPLETED_HOOK_ENABLE to 1 if you would like to be informed when a
151
 * firmware update is completed by the bootloader. 
164
 * firmware update is completed by the bootloader.
152 165
 */
153 166
/** \brief Enable/disable support for firmware updates from a locally attached storage.*/
154 167
#define BOOT_FILE_SYS_ENABLE            (0)
155 168
/** \brief Enable/disable logging messages during firmware updates. */
156 169
#define BOOT_FILE_LOGGING_ENABLE        (1)
157 170
/** \brief Enable/disable a hook function that is called upon detection of an error. */
158
#define BOOT_FILE_ERROR_HOOK_ENABLE     (1)   
171
#define BOOT_FILE_ERROR_HOOK_ENABLE     (1)
159 172
/** \brief Enable/disable a hook function that is called at the start of the update. */
160
#define BOOT_FILE_STARTED_HOOK_ENABLE   (1)   
173
#define BOOT_FILE_STARTED_HOOK_ENABLE   (1)
161 174
/** \brief Enable/disable a hook function that is called at the end of the update. */
162
#define BOOT_FILE_COMPLETED_HOOK_ENABLE (1)   
175
#define BOOT_FILE_COMPLETED_HOOK_ENABLE (1)
176

  
163 177

  
164
   
165 178
/****************************************************************************************
166 179
*   B A C K D O O R   E N T R Y   C O N F I G U R A T I O N
167 180
****************************************************************************************/
168 181
/* It is possible to implement an application specific method to force the bootloader to
169 182
 * stay active after a reset. Such a backdoor entry into the bootloader is desired in
170
 * situations where the user program does not run properly and therefore cannot 
183
 * situations where the user program does not run properly and therefore cannot
171 184
 * reactivate the bootloader. By enabling these hook functions, the application can
172 185
 * implement the backdoor, which overrides the default backdoor entry that is programmed
173 186
 * into the bootloader. When desired for security purposes, these hook functions can
......
213 226
*   S E E D / K E Y   S E C U R I T Y   C O N F I G U R A T I O N
214 227
****************************************************************************************/
215 228
/* A security mechanism can be enabled in the bootloader's XCP module by setting configu-
216
 * rable BOOT_XCP_SEED_KEY_ENABLE to 1. Before any memory erase or programming 
217
 * operations can be performed, access to this resource need to be unlocked. 
218
 * In the Microboot settings on tab "XCP Protection" you need to specify a DLL that 
219
 * implements the unlocking algorithm. The demo programs are configured for the (simple) 
220
 * algorithm in "FeaserKey.dll". The source code for this DLL is available so it can be 
221
 * customized to your needs. 
229
 * rable BOOT_XCP_SEED_KEY_ENABLE to 1. Before any memory erase or programming
230
 * operations can be performed, access to this resource need to be unlocked.
231
 * In the Microboot settings on tab "XCP Protection" you need to specify a DLL that
232
 * implements the unlocking algorithm. The demo programs are configured for the (simple)
233
 * algorithm in "FeaserKey.dll". The source code for this DLL is available so it can be
234
 * customized to your needs.
222 235
 * During the unlock sequence, Microboot requests a seed from the bootloader, which is in
223
 * the format of a byte array. Using this seed the unlock algorithm in the DLL computes 
224
 * a key, which is also a byte array, and sends this back to the bootloader. The 
236
 * the format of a byte array. Using this seed the unlock algorithm in the DLL computes
237
 * a key, which is also a byte array, and sends this back to the bootloader. The
225 238
 * bootloader then verifies this key to determine if programming and erase operations are
226 239
 * permitted.
227 240
 * After enabling this feature the hook functions XcpGetSeedHook() and XcpVerifyKeyHook()

Also available in: Unified diff