giomba/nes-proj
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
a6dbc589a1
nes-proj/arch/cpu/cc2538/dev/flash.h

128 lines
4.9 KiB
C
Raw Normal View History

cc2538: Add header file for flash CCA page and use it Create a dedicated header file with all the definitions for the flash lock bit page and customer configuration area. This avoids duplicating those definitions in the startup-gcc.c files of all CC2538-based platforms, and this also allows to easily manipulate the CCA from outside startup-gcc.c (e.g. for on-the-air firmware update). The definitions are now complete contrary to what was in startup-gcc.c: - Definitions have been added to select the bootloader backdoor pin and active level if enabled. - Definitions have been added to access the page and debug lock bits. The debug lock bit can be used to prevent someone from reading back a programmed firmware through JTAG if the firmware binary image has to be confidential, which should be combined with a disabled bootloader backdoor. - The application entry point is now tied to the beginning of the .text section instead of to the beginning of the flash. This allows projects using custom linker scripts to place the application entry point anywhere in the flash, which can be useful e.g. for on-the-air firmware update. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau@advansee.com>
2013-11-27 20:55:18 +00:00
/*
* Copyright (C) 2012 Texas Instruments Incorporated - http://www.ti.com/
* All rights reserved.
*
* Copyright (c) 2013, ADVANSEE - http://www.advansee.com/
* Benoît Thébaudeau <benoit.thebaudeau@advansee.com>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**
* \addtogroup cc2538
* @{
*
cc2538: Define the flash memory organization Define the flash memory page and word sizes. These definitions are grouped with the flash lock bit page and CCA definitions, so flash-cca.h is renamed to flash.h. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau.dev@gmail.com>
2015-06-25 20:37:22 +00:00
* \defgroup cc2538-flash cc2538 flash memory
cc2538: Add header file for flash CCA page and use it Create a dedicated header file with all the definitions for the flash lock bit page and customer configuration area. This avoids duplicating those definitions in the startup-gcc.c files of all CC2538-based platforms, and this also allows to easily manipulate the CCA from outside startup-gcc.c (e.g. for on-the-air firmware update). The definitions are now complete contrary to what was in startup-gcc.c: - Definitions have been added to select the bootloader backdoor pin and active level if enabled. - Definitions have been added to access the page and debug lock bits. The debug lock bit can be used to prevent someone from reading back a programmed firmware through JTAG if the firmware binary image has to be confidential, which should be combined with a disabled bootloader backdoor. - The application entry point is now tied to the beginning of the .text section instead of to the beginning of the flash. This allows projects using custom linker scripts to place the application entry point anywhere in the flash, which can be useful e.g. for on-the-air firmware update. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau@advansee.com>
2013-11-27 20:55:18 +00:00
*
cc2538: Define the flash memory organization Define the flash memory page and word sizes. These definitions are grouped with the flash lock bit page and CCA definitions, so flash-cca.h is renamed to flash.h. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau.dev@gmail.com>
2015-06-25 20:37:22 +00:00
* Definitions for the cc2538 flash memory
cc2538: Add header file for flash CCA page and use it Create a dedicated header file with all the definitions for the flash lock bit page and customer configuration area. This avoids duplicating those definitions in the startup-gcc.c files of all CC2538-based platforms, and this also allows to easily manipulate the CCA from outside startup-gcc.c (e.g. for on-the-air firmware update). The definitions are now complete contrary to what was in startup-gcc.c: - Definitions have been added to select the bootloader backdoor pin and active level if enabled. - Definitions have been added to access the page and debug lock bits. The debug lock bit can be used to prevent someone from reading back a programmed firmware through JTAG if the firmware binary image has to be confidential, which should be combined with a disabled bootloader backdoor. - The application entry point is now tied to the beginning of the .text section instead of to the beginning of the flash. This allows projects using custom linker scripts to place the application entry point anywhere in the flash, which can be useful e.g. for on-the-air firmware update. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau@advansee.com>
2013-11-27 20:55:18 +00:00
* @{
*
* \file
cc2538: Define the flash memory organization Define the flash memory page and word sizes. These definitions are grouped with the flash lock bit page and CCA definitions, so flash-cca.h is renamed to flash.h. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau.dev@gmail.com>
2015-06-25 20:37:22 +00:00
* Header file for the flash memory definitions
cc2538: Add header file for flash CCA page and use it Create a dedicated header file with all the definitions for the flash lock bit page and customer configuration area. This avoids duplicating those definitions in the startup-gcc.c files of all CC2538-based platforms, and this also allows to easily manipulate the CCA from outside startup-gcc.c (e.g. for on-the-air firmware update). The definitions are now complete contrary to what was in startup-gcc.c: - Definitions have been added to select the bootloader backdoor pin and active level if enabled. - Definitions have been added to access the page and debug lock bits. The debug lock bit can be used to prevent someone from reading back a programmed firmware through JTAG if the firmware binary image has to be confidential, which should be combined with a disabled bootloader backdoor. - The application entry point is now tied to the beginning of the .text section instead of to the beginning of the flash. This allows projects using custom linker scripts to place the application entry point anywhere in the flash, which can be useful e.g. for on-the-air firmware update. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau@advansee.com>
2013-11-27 20:55:18 +00:00
*/
cc2538: Define the flash memory organization Define the flash memory page and word sizes. These definitions are grouped with the flash lock bit page and CCA definitions, so flash-cca.h is renamed to flash.h. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau.dev@gmail.com>
2015-06-25 20:37:22 +00:00
#ifndef FLASH_H_
#define FLASH_H_
cc2538: Add header file for flash CCA page and use it Create a dedicated header file with all the definitions for the flash lock bit page and customer configuration area. This avoids duplicating those definitions in the startup-gcc.c files of all CC2538-based platforms, and this also allows to easily manipulate the CCA from outside startup-gcc.c (e.g. for on-the-air firmware update). The definitions are now complete contrary to what was in startup-gcc.c: - Definitions have been added to select the bootloader backdoor pin and active level if enabled. - Definitions have been added to access the page and debug lock bits. The debug lock bit can be used to prevent someone from reading back a programmed firmware through JTAG if the firmware binary image has to be confidential, which should be combined with a disabled bootloader backdoor. - The application entry point is now tied to the beginning of the .text section instead of to the beginning of the flash. This allows projects using custom linker scripts to place the application entry point anywhere in the flash, which can be useful e.g. for on-the-air firmware update. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau@advansee.com>
2013-11-27 20:55:18 +00:00
cc2538: Define and use device features Define the available CC2538 devices and their features, and use them to define the linker script memory regions. The .nrdata output section is now always defined in order to trigger an error if it is used but no memory is available for it. The CC2538 device used by Contiki is made a configuration option, the CC2538SF53 device being the default. This makes more sense than defining the flash memory address and size as configuration options like previously, all the more not all values are possible and all the features are linked by each device. This change also makes it possible to: - use the correct SRAM parameters for the CC2538NF11, - know at build time if the AES, SHA, ECC and RSA hardware features are available on the selected CC2538 device. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau.dev@gmail.com>
2015-06-18 20:31:53 +00:00
#include "dev/cc2538-dev.h"
cc2538: Add configuration for firmware location Introduce FLASH_CONF_FW_ADDR and FLASH_CONF_FW_SIZE in order to make it possible to place the firmware anywhere, regardless of Coffee, and without having to write a custom linker script. Also, handle the default values properly in order to fix the link breakage reported by Arthur Fabre <arthur@arthurfabre.com> with COFFEE_CONF_CUSTOM_PORT. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau.dev@gmail.com>
2016-06-19 20:57:36 +00:00
#include "cfs-coffee-arch.h"
cc2538: Define and use device features Define the available CC2538 devices and their features, and use them to define the linker script memory regions. The .nrdata output section is now always defined in order to trigger an error if it is used but no memory is available for it. The CC2538 device used by Contiki is made a configuration option, the CC2538SF53 device being the default. This makes more sense than defining the flash memory address and size as configuration options like previously, all the more not all values are possible and all the features are linked by each device. This change also makes it possible to: - use the correct SRAM parameters for the CC2538NF11, - know at build time if the AES, SHA, ECC and RSA hardware features are available on the selected CC2538 device. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau.dev@gmail.com>
2015-06-18 20:31:53 +00:00
cc2538: Add header file for flash CCA page and use it Create a dedicated header file with all the definitions for the flash lock bit page and customer configuration area. This avoids duplicating those definitions in the startup-gcc.c files of all CC2538-based platforms, and this also allows to easily manipulate the CCA from outside startup-gcc.c (e.g. for on-the-air firmware update). The definitions are now complete contrary to what was in startup-gcc.c: - Definitions have been added to select the bootloader backdoor pin and active level if enabled. - Definitions have been added to access the page and debug lock bits. The debug lock bit can be used to prevent someone from reading back a programmed firmware through JTAG if the firmware binary image has to be confidential, which should be combined with a disabled bootloader backdoor. - The application entry point is now tied to the beginning of the .text section instead of to the beginning of the flash. This allows projects using custom linker scripts to place the application entry point anywhere in the flash, which can be useful e.g. for on-the-air firmware update. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau@advansee.com>
2013-11-27 20:55:18 +00:00
#include <stdint.h>
/*---------------------------------------------------------------------------*/
cc2538: Define the flash memory organization Define the flash memory page and word sizes. These definitions are grouped with the flash lock bit page and CCA definitions, so flash-cca.h is renamed to flash.h. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau.dev@gmail.com>
2015-06-25 20:37:22 +00:00
/** \name Flash memory organization
* @{
*/
#define FLASH_PAGE_SIZE 2048
#define FLASH_WORD_SIZE 4
/** @} */
/*---------------------------------------------------------------------------*/
cc2538: Define and use device features Define the available CC2538 devices and their features, and use them to define the linker script memory regions. The .nrdata output section is now always defined in order to trigger an error if it is used but no memory is available for it. The CC2538 device used by Contiki is made a configuration option, the CC2538SF53 device being the default. This makes more sense than defining the flash memory address and size as configuration options like previously, all the more not all values are possible and all the features are linked by each device. This change also makes it possible to: - use the correct SRAM parameters for the CC2538NF11, - know at build time if the AES, SHA, ECC and RSA hardware features are available on the selected CC2538 device. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau.dev@gmail.com>
2015-06-18 20:31:53 +00:00
/** \name Flash lock bit page and CCA location
* @{
*/
#define FLASH_CCA_ADDR (CC2538_DEV_FLASH_ADDR + CC2538_DEV_FLASH_SIZE - \
FLASH_CCA_SIZE) /**< Address */
#define FLASH_CCA_SIZE 0x0000002C /**< Size in bytes */
/** @} */
/*---------------------------------------------------------------------------*/
cc2538: Add header file for flash CCA page and use it Create a dedicated header file with all the definitions for the flash lock bit page and customer configuration area. This avoids duplicating those definitions in the startup-gcc.c files of all CC2538-based platforms, and this also allows to easily manipulate the CCA from outside startup-gcc.c (e.g. for on-the-air firmware update). The definitions are now complete contrary to what was in startup-gcc.c: - Definitions have been added to select the bootloader backdoor pin and active level if enabled. - Definitions have been added to access the page and debug lock bits. The debug lock bit can be used to prevent someone from reading back a programmed firmware through JTAG if the firmware binary image has to be confidential, which should be combined with a disabled bootloader backdoor. - The application entry point is now tied to the beginning of the .text section instead of to the beginning of the flash. This allows projects using custom linker scripts to place the application entry point anywhere in the flash, which can be useful e.g. for on-the-air firmware update. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau@advansee.com>
2013-11-27 20:55:18 +00:00
/** \name Bootloader backdoor configuration bit fields
* @{
*/
#define FLASH_CCA_BOOTLDR_CFG_DISABLE 0xEFFFFFFF /**< Disable backdoor function */
#define FLASH_CCA_BOOTLDR_CFG_ENABLE 0xF0FFFFFF /**< Enable backdoor function */
#define FLASH_CCA_BOOTLDR_CFG_ACTIVE_HIGH 0x08000000 /**< Selected pin on pad A active high */
#define FLASH_CCA_BOOTLDR_CFG_PORT_A_PIN_M 0x07000000 /**< Selected pin on pad A mask */
#define FLASH_CCA_BOOTLDR_CFG_PORT_A_PIN_S 24 /**< Selected pin on pad A shift */
/** @} */
/*---------------------------------------------------------------------------*/
/** \name Image valid definitions
* @{
*/
#define FLASH_CCA_IMAGE_VALID 0x00000000 /**< Indicates valid image in flash */
/** @} */
/*---------------------------------------------------------------------------*/
/** \name Lock page / debug definitions
* @{
*/
#define FLASH_CCA_LOCKED 0 /**< Page or debug locked if bit == 0 */
#define FLASH_CCA_LOCK_DEBUG_BYTE 31 /**< Lock byte containing the debug lock bit */
#define FLASH_CCA_LOCK_DEBUG_BIT 7 /**< Debug lock bit position in the corresponding lock byte */
/** @} */
/*---------------------------------------------------------------------------*/
cc2538: Add configuration for firmware location Introduce FLASH_CONF_FW_ADDR and FLASH_CONF_FW_SIZE in order to make it possible to place the firmware anywhere, regardless of Coffee, and without having to write a custom linker script. Also, handle the default values properly in order to fix the link breakage reported by Arthur Fabre <arthur@arthurfabre.com> with COFFEE_CONF_CUSTOM_PORT. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau.dev@gmail.com>
2016-06-19 20:57:36 +00:00
/** \name Firmware location in flash memory
* @{
*/
#ifdef FLASH_CONF_FW_ADDR
#define FLASH_FW_ADDR FLASH_CONF_FW_ADDR
#elif !defined(COFFEE_CONF_CUSTOM_PORT)
#define FLASH_FW_ADDR (COFFEE_START + COFFEE_SIZE)
#else
#define FLASH_FW_ADDR CC2538_DEV_FLASH_ADDR
#endif
#ifdef FLASH_CONF_FW_SIZE
#define FLASH_FW_SIZE FLASH_CONF_FW_SIZE
#else
#define FLASH_FW_SIZE (FLASH_CCA_ADDR - FLASH_FW_ADDR)
#endif
/** @} */
/*---------------------------------------------------------------------------*/
cc2538: Add header file for flash CCA page and use it Create a dedicated header file with all the definitions for the flash lock bit page and customer configuration area. This avoids duplicating those definitions in the startup-gcc.c files of all CC2538-based platforms, and this also allows to easily manipulate the CCA from outside startup-gcc.c (e.g. for on-the-air firmware update). The definitions are now complete contrary to what was in startup-gcc.c: - Definitions have been added to select the bootloader backdoor pin and active level if enabled. - Definitions have been added to access the page and debug lock bits. The debug lock bit can be used to prevent someone from reading back a programmed firmware through JTAG if the firmware binary image has to be confidential, which should be combined with a disabled bootloader backdoor. - The application entry point is now tied to the beginning of the .text section instead of to the beginning of the flash. This allows projects using custom linker scripts to place the application entry point anywhere in the flash, which can be useful e.g. for on-the-air firmware update. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau@advansee.com>
2013-11-27 20:55:18 +00:00
/** \name Flash lock bit page and CCA layout
* @{
*/
typedef struct {
uint32_t bootldr_cfg; /**< Bootloader backdoor configuration (page bytes 2004 - 2007) */
uint32_t image_valid; /**< Image valid (page bytes 2008 - 2011) */
const void *app_entry_point; /**< Flash vector table address (page bytes 2012 - 2015) */
uint8_t lock[32]; /**< Page and debug lock bits (page bytes 2016 - 2047) */
} flash_cca_lock_page_t;
/** @} */
cc2538: Define the flash memory organization Define the flash memory page and word sizes. These definitions are grouped with the flash lock bit page and CCA definitions, so flash-cca.h is renamed to flash.h. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau.dev@gmail.com>
2015-06-25 20:37:22 +00:00
#endif /* FLASH_H_ */
cc2538: Add header file for flash CCA page and use it Create a dedicated header file with all the definitions for the flash lock bit page and customer configuration area. This avoids duplicating those definitions in the startup-gcc.c files of all CC2538-based platforms, and this also allows to easily manipulate the CCA from outside startup-gcc.c (e.g. for on-the-air firmware update). The definitions are now complete contrary to what was in startup-gcc.c: - Definitions have been added to select the bootloader backdoor pin and active level if enabled. - Definitions have been added to access the page and debug lock bits. The debug lock bit can be used to prevent someone from reading back a programmed firmware through JTAG if the firmware binary image has to be confidential, which should be combined with a disabled bootloader backdoor. - The application entry point is now tied to the beginning of the .text section instead of to the beginning of the flash. This allows projects using custom linker scripts to place the application entry point anywhere in the flash, which can be useful e.g. for on-the-air firmware update. Signed-off-by: Benoît Thébaudeau <benoit.thebaudeau@advansee.com>
2013-11-27 20:55:18 +00:00
/**
* @}
* @}
*/
Reference in New Issue Copy Permalink