AMiRo-OS

/************************************************************************************//**

* \file         Demo\ARMCM4_STM32_Olimex_STM32E407_GCC\Boot\blt_conf.h

* \brief        Bootloader configuration header file.

* \ingroup      Boot_ARMCM4_STM32_Olimex_STM32E407_GCC

* \internal

*----------------------------------------------------------------------------------------

*                          C O P Y R I G H T

*----------------------------------------------------------------------------------------

*   Copyright (c) 2013  by Feaser    http://www.feaser.com    All rights reserved

*

*----------------------------------------------------------------------------------------

*                            L I C E N S E

*----------------------------------------------------------------------------------------

* This file is part of OpenBLT. OpenBLT is free software: you can redistribute it and/or

* modify it under the terms of the GNU General Public License as published by the Free

* Software Foundation, either version 3 of the License, or (at your option) any later

* version.

*

* OpenBLT is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;

* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR

* PURPOSE. See the GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License along with OpenBLT.

* If not, see <http://www.gnu.org/licenses/>.

*

* A special exception to the GPL is included to allow you to distribute a combined work

* that includes OpenBLT without being obliged to provide the source code for any

* proprietary components. The exception text is included at the bottom of the license

* file <license.html>.

*

* \endinternal

****************************************************************************************/

#ifndef BLT_CONF_H

#define BLT_CONF_H

/****************************************************************************************

*   C P U   D R I V E R   C O N F I G U R A T I O N

****************************************************************************************/

/* To properly initialize the baudrate clocks of the communication interface, typically

 * the speed of the crystal oscillator and/or the speed at which the system runs is

 * needed. Set these through configurables BOOT_CPU_XTAL_SPEED_KHZ and

 * BOOT_CPU_SYSTEM_SPEED_KHZ, respectively. To enable data exchange with the host that is

 * not dependent on the targets architecture, the byte ordering needs to be known.

 * Setting BOOT_CPU_BYTE_ORDER_MOTOROLA to 1 selects little endian mode and 0 selects

 * big endian mode.

 *

 * Set BOOT_CPU_USER_PROGRAM_START_HOOK to 1 if you would like a hook function to be

 * called the moment the user program is about to be started. This could be used to

 * de-initialize application specific parts, for example to stop blinking an LED, etc.

 */

/** \brief Frequency of the external crystal oscillator. */

#define BOOT_CPU_XTAL_SPEED_KHZ           (8000)

/** \brief Desired system speed. */

#define BOOT_CPU_SYSTEM_SPEED_KHZ         (168000)

/** \brief Motorola or Intel style byte ordering. */

#define BOOT_CPU_BYTE_ORDER_MOTOROLA      (0)

/** \brief Enable/disable hook function call right before user program start. */

#define BOOT_CPU_USER_PROGRAM_START_HOOK  (1)

/****************************************************************************************

*   B O O T L O A D E R   O F   M A I N   D E V I C E

****************************************************************************************/

/* It is important to initialize if the bootloader is part of the main device. In this

 * case some backdoor loops have to stay opened and backdoor loops of other bootloaders

 * have to be controlled by this bootloader. Additionally the bootloader should be able

 * to send program code of user programs for other devices.

 * Make sure that one of the communication interfaces is the gateway!

 */

/** \brief Bootloader of main device. */

#define BOOTLOADER_OF_MAIN_DEVICE       (1)

/****************************************************************************************

*   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

****************************************************************************************/

/* The CAN communication interface is selected by setting the BOOT_COM_CAN_ENABLE

 * configurable to 1. Configurable BOOT_COM_CAN_BAUDRATE selects the communication speed

 * in bits/second. Two CAN messages are reserved for communication with the host. The

 * message identifier for sending data from the target to the host is configured with

 * BOOT_COM_CAN_TXMSG_ID. The one for receiving data from the host is configured with

 * BOOT_COM_CAN_RXMSG_ID. The maximum amount of data bytes in a message for data

 * transmission and reception is set through BOOT_COM_CAN_TX_MAX_DATA and

 * BOOT_COM_CAN_RX_MAX_DATA, respectively. It is common for a microcontroller to have more

 * than 1 CAN controller on board. The zero-based BOOT_COM_CAN_CHANNEL_INDEX selects the

 * CAN controller channel.

 *

 */

/** \brief Enable/disable CAN transport layer. */

#define BOOT_GATE_CAN_ENABLE            (1)

/** \brief Configure the desired CAN baudrate. */

#define BOOT_COM_CAN_BAUDRATE           (1000000)

/** \brief Configure CAN message ID target->host. */

#define BOOT_COM_CAN_TX_MSG_ID          (0x700)

/** \brief Configure number of bytes in the target->host CAN message. */

#define BOOT_COM_CAN_TX_MAX_DATA        (255)

/** \brief Configure CAN message ID host->target. */

#define BOOT_COM_CAN_RX_MSG_ID          (0x600)

/** \brief Configure number of bytes in the host->target CAN message. */

#define BOOT_COM_CAN_RX_MAX_DATA        (255)

/** \brief Select the desired CAN peripheral as a zero based index. */

#define BOOT_COM_CAN_CHANNEL_INDEX      (0)

/** \brief Configure CAN message acknowledgement ID addition (ORed with original ID). */

#define BOOT_COM_CAN_MSG_ACK            (0x001)

/** \brief Configure CAN message ID addition for continuous messages (ORed with original ID). */

#define BOOT_COM_CAN_MSG_SUBSEQUENT     (0x002)

/**

 * \brief Configure device ID for communication (start with 1).

 * \details The device ID is a 32 bit integer, which can be interpreted bytewise:

 *            <AMiRo_revision>:<moduleID>:<moduleVersion_major>:<moduleVersion_minor>

 *          For this module the according values are

 *            1:1:1:1 = 0x01010101

 */

#define BOOT_COM_DEVICE_ID              (0x01010101)

/** \brief Configure legacy device ID. */

#define BOOT_COM_DEVICE_LEGACY_ID       (0x2)

/* The UART communication interface is selected by setting the BOOT_COM_UART_ENABLE

 * configurable to 1. Configurable BOOT_COM_UART_BAUDRATE selects the communication speed

 * in bits/second. The maximum amount of data bytes in a message for data transmission

 * and reception is set through BOOT_COM_UART_TX_MAX_DATA and BOOT_COM_UART_RX_MAX_DATA,

 * respectively. It is common for a microcontroller to have more than 1 UART interface

 * on board. The zero-based BOOT_COM_UART_CHANNEL_INDEX selects the UART interface.

 *

 */

/** \brief Enable/disable UART transport layer. */

#define BOOT_COM_UART_ENABLE            (1)

/** \brief Enable/disable BLUETOOTH UART transport layer. */

#define BOOT_COM_BLUETOOTH_UART_ENABLE  (0)

/** \brief Configure the desired communication speed. */

#define BOOT_COM_UART_BAUDRATE          (115200)

/** \brief Configure number of bytes in the target->host data packet. */

#define BOOT_COM_UART_TX_MAX_DATA       (255)

/** \brief Configure number of bytes in the host->target data packet. */

#define BOOT_COM_UART_RX_MAX_DATA       (255)

/** \brief Select the desired UART peripheral as a zero based index. */

#define BOOT_COM_UART_CHANNEL_INDEX     (0)

/** \brief Select the desired BLUETOOTH UART peripheral as a zero based index. */

#define BOOT_COM_BLUETOOTH_UART_CHANNEL_INDEX (2)

/* The NET communication interface for firmware updates via TCP/IP is selected by setting

 * the BOOT_COM_NET_ENABLE configurable to 1. The maximum amount of data bytes in a

 * message for data transmission and reception is set through BOOT_COM_NET_TX_MAX_DATA

 * and BOOT_COM_NET_RX_MAX_DATA, respectively. The default IP address is configured

 * with the macros BOOT_COM_NET_IPADDRx. The default netmask is configued with the macros

 * BOOT_COM_NET_NETMASKx. The default gateway is configured with the macros

 * BOOT_COM_NET_GATEWAYx. The bootloader acts and a TCP/IP server. The port the server

 * listen on for connections is configured with BOOT_COM_NET_PORT.

 */

/** \brief Enable/disable the NET transport layer. */

#define BOOT_COM_NET_ENABLE              (0)

/** \brief Configure number of bytes in the target->host data packet. */

#define BOOT_COM_NET_TX_MAX_DATA         (64)

/** \brief Configure number of bytes in the host->target data packet. */

#define BOOT_COM_NET_RX_MAX_DATA         (64)

/** \brief Configure the port that the TCP/IP server listens on */

#define BOOT_COM_NET_PORT                (1000)

/** \brief Configure the 1st byte of the IP address */

#define BOOT_COM_NET_IPADDR0             (169)

/** \brief Configure the 2nd byte of the IP address */

#define BOOT_COM_NET_IPADDR1             (254)

/** \brief Configure the 3rd byte of the IP address */

#define BOOT_COM_NET_IPADDR2             (19)

/** \brief Configure the 4th byte of the IP address */

#define BOOT_COM_NET_IPADDR3             (63)

/** \brief Configure the 1st byte of the network mask */

#define BOOT_COM_NET_NETMASK0            (255)

/** \brief Configure the 2nd byte of the network mask */

#define BOOT_COM_NET_NETMASK1            (255)

/** \brief Configure the 3rd byte of the network mask */

#define BOOT_COM_NET_NETMASK2            (0)

/** \brief Configure the 4th byte of the network mask */

#define BOOT_COM_NET_NETMASK3            (0)

/** \brief Configure the 1st byte of the gateway address */

#define BOOT_COM_NET_GATEWAY0            (169)

/** \brief Configure the 2nd byte of the gateway address */

#define BOOT_COM_NET_GATEWAY1            (254)

/** \brief Configure the 3rd byte of the gateway address */

#define BOOT_COM_NET_GATEWAY2            (19)

/** \brief Configure the 4th byte of the gateway address */

#define BOOT_COM_NET_GATEWAY3            (1)

/** \brief Enable/disable a hook function that is called when the IP address is about

 *         to be set. This allows a dynamic override of the BOOT_COM_NET_IPADDRx values.

 */

#define BOOT_COM_NET_IPADDR_HOOK_ENABLE  (0)

/** \brief Enable/disable a hook function that is called when the netmask is about

 *         to be set. This allows a dynamic override of the BOOT_COM_NET_NETMASKx values.

 */

#define BOOT_COM_NET_NETMASK_HOOK_ENABLE (0)

/** \brief Enable/disable a hook function that is called when the gateway address is

 *         about to be set. This allows a dynamic override of the BOOT_COM_NET_GATEWAYx

 *         values.

 */

#define BOOT_COM_NET_GATEWAY_HOOK_ENABLE (0)

/****************************************************************************************

*   B A C K D O O R    C O N F I G U R A T I O N

****************************************************************************************/

#if (BOOT_COM_NET_ENABLE > 0)

/* Override the default time that the backdoor is open if firmware updates via TCP/IP

 * are supported. in this case a reactivation of the bootloader results in a re-

 * initialization of the ethernet MAC. when directly connected to the ethernet port of

 * a PC this will go relatively fast (depending on what MS Windows is being used), but

 * when connected to the network via a router this can take several seconds. feel free to

 * shorten/lengthen this time for finetuning. the only downside of a long backdoor open

 * time is that the starting of the user program will also be delayed for this time.

 *

 * Also note that when the target is directly connected to the ethernet port of a PC,

 * the checkbox "Automatically retry socket connection" should be checked in the

 * Microboot settings. if connecting via a router the uncheck this checkbox.

 */

#define BACKDOOR_ENTRY_TIMEOUT_MS  (10000)

#endif

/****************************************************************************************

*   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

****************************************************************************************/

/* The file system interface is selected by setting the BOOT_FILE_SYS_ENABLE configurable

 * to 1. This enables support for firmware updates from a file stored on a locally

 * attached file system such as an SD-card. Note that this interface can be enabled

 * together with one of the remote communication interfaces such as UART, CAN or USB.

 *

 * Set BOOT_FILE_LOGGING_ENABLE to 1 if you would like log messages to be created during

 * a firmware update. The hook function FileFirmwareUpdateLogHook() will be called each

 * time a new string formatted log entry is available. This could be used during testing

 * by outputting the string on UART or to create a log file on the file system itself.

 *

 * Set BOOT_FILE_ERROR_HOOK_ENABLE to 1 if you would like to be informed in case an error

 * occurs during the firmware update. This could for example be used to turn on an error

 * LED to inform the user that something went wrong. Inspecting the log messages provides

 * additional information on the error cause.

 *

 * Set BOOT_FILE_STARTED_HOOK_ENABLE to 1 if you would like to be informed when a new

 * firmware update is started by the bootloader.

 *

 * Set BOOT_FILE_COMPLETED_HOOK_ENABLE to 1 if you would like to be informed when a

 * firmware update is completed by the bootloader.

 */

/** \brief Enable/disable support for firmware updates from a locally attached storage.*/

#define BOOT_FILE_SYS_ENABLE            (0)

/** \brief Enable/disable logging messages during firmware updates. */

#define BOOT_FILE_LOGGING_ENABLE        (1)

/** \brief Enable/disable a hook function that is called upon detection of an error. */

#define BOOT_FILE_ERROR_HOOK_ENABLE     (1)

/** \brief Enable/disable a hook function that is called at the start of the update. */

#define BOOT_FILE_STARTED_HOOK_ENABLE   (1)

/** \brief Enable/disable a hook function that is called at the end of the update. */

#define BOOT_FILE_COMPLETED_HOOK_ENABLE (1)

/****************************************************************************************

*   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

****************************************************************************************/

/* It is possible to implement an application specific method to force the bootloader to

 * stay active after a reset. Such a backdoor entry into the bootloader is desired in

 * situations where the user program does not run properly and therefore cannot

 * reactivate the bootloader. By enabling these hook functions, the application can

 * implement the backdoor, which overrides the default backdoor entry that is programmed

 * into the bootloader. When desired for security purposes, these hook functions can

 * also be implemented in a way that disables the backdoor entry altogether.

 */

/** \brief Enable/disable the backdoor override hook functions. */

#define BOOT_BACKDOOR_HOOKS_ENABLE      (1)

/****************************************************************************************

*   N O N - V O L A T I L E   M E M O R Y   D R I V E R   C O N F I G U R A T I O N

****************************************************************************************/

/* The NVM driver typically supports erase and program operations of the internal memory

 * present on the microcontroller. Through these hook functions the NVM driver can be

 * extended to support additional memory types such as external flash memory and serial

 * eeproms. The size of the internal memory in kilobytes is specified with configurable

 * BOOT_NVM_SIZE_KB. If desired the internal checksum writing and verification method can

 * be overridden with a application specific method by enabling configuration switch

 * BOOT_NVM_CHECKSUM_HOOKS_ENABLE.

 */

/** \brief Enable/disable the NVM hook function for supporting additional memory devices. */

#define BOOT_NVM_HOOKS_ENABLE           (0)

/** \brief Configure the size of the default memory device (typically flash EEPROM). */

#define BOOT_NVM_SIZE_KB                (1024)

/** \brief Enable/disable hooks functions to override the user program checksum handling. */

#define BOOT_NVM_CHECKSUM_HOOKS_ENABLE  (0)

/****************************************************************************************

*   W A T C H D O G   D R I V E R   C O N F I G U R A T I O N

****************************************************************************************/

/* The COP driver cannot be configured internally in the bootloader, because its use

 * and configuration is application specific. The bootloader does need to service the

 * watchdog in case it is used. When the application requires the use of a watchdog,

 * set BOOT_COP_HOOKS_ENABLE to be able to initialize and service the watchdog through

 * hook functions.

 */

/** \brief Enable/disable the hook functions for controlling the watchdog. */

#define BOOT_COP_HOOKS_ENABLE           (0)

/****************************************************************************************

*   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

****************************************************************************************/

/* A security mechanism can be enabled in the bootloader's XCP module by setting configu-

 * rable BOOT_XCP_SEED_KEY_ENABLE to 1. Before any memory erase or programming

 * operations can be performed, access to this resource need to be unlocked.

 * In the Microboot settings on tab "XCP Protection" you need to specify a DLL that

 * implements the unlocking algorithm. The demo programs are configured for the (simple)

 * algorithm in "FeaserKey.dll". The source code for this DLL is available so it can be

 * customized to your needs.

 * During the unlock sequence, Microboot requests a seed from the bootloader, which is in

 * the format of a byte array. Using this seed the unlock algorithm in the DLL computes

 * a key, which is also a byte array, and sends this back to the bootloader. The

 * bootloader then verifies this key to determine if programming and erase operations are

 * permitted.

 * After enabling this feature the hook functions XcpGetSeedHook() and XcpVerifyKeyHook()

 * are called by the bootloader to obtain the seed and to verify the key, respectively.

 */

#define BOOT_XCP_SEED_KEY_ENABLE        (0)

#endif /* BLT_CONF_H */

/*********************************** end of blt_conf.h *********************************/