129 lines
5.0 KiB
C
129 lines
5.0 KiB
C
/******************************************************************************
|
|
Filename: hal_ota.h
|
|
Revised: $Date: 2010-11-18 08:22:50 -0800 (Thu, 18 Nov 2010) $
|
|
Revision: $Revision: 24438 $
|
|
|
|
Description: This module defines optionally-compiled Boot Code parameters
|
|
for the CC253x.
|
|
|
|
Copyright 2010 Texas Instruments Incorporated. All rights reserved.
|
|
|
|
IMPORTANT: Your use of this Software is limited to those specific rights
|
|
granted under the terms of a software license agreement between the user
|
|
who downloaded the software, his/her employer (which must be your employer)
|
|
and Texas Instruments Incorporated (the "License"). You may not use this
|
|
Software unless you agree to abide by the terms of the License. The License
|
|
limits your use, and you acknowledge, that the Software may not be modified,
|
|
copied or distributed unless embedded on a Texas Instruments microcontroller
|
|
or used solely and exclusively in conjunction with a Texas Instruments radio
|
|
frequency transceiver, which is integrated into your product. Other than for
|
|
the foregoing purpose, you may not use, reproduce, copy, prepare derivative
|
|
works of, modify, distribute, perform, display or sell this Software and/or
|
|
its documentation for any purpose.
|
|
|
|
YOU FURTHER ACKNOWLEDGE AND AGREE THAT THE SOFTWARE AND DOCUMENTATION ARE
|
|
PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
|
|
INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, TITLE,
|
|
NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL
|
|
TEXAS INSTRUMENTS OR ITS LICENSORS BE LIABLE OR OBLIGATED UNDER CONTRACT,
|
|
NEGLIGENCE, STRICT LIABILITY, CONTRIBUTION, BREACH OF WARRANTY, OR OTHER
|
|
LEGAL EQUITABLE THEORY ANY DIRECT OR INDIRECT DAMAGES OR EXPENSES
|
|
INCLUDING BUT NOT LIMITED TO ANY INCIDENTAL, SPECIAL, INDIRECT, PUNITIVE
|
|
OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF PROCUREMENT
|
|
OF SUBSTITUTE GOODS, TECHNOLOGY, SERVICES, OR ANY CLAIMS BY THIRD PARTIES
|
|
(INCLUDING BUT NOT LIMITED TO ANY DEFENSE THEREOF), OR OTHER SIMILAR COSTS.
|
|
|
|
Should you have any questions regarding your right to use this Software,
|
|
contact Texas Instruments Incorporated at www.TI.com.
|
|
******************************************************************************/
|
|
|
|
#ifndef HAL_OTA_H
|
|
#define HAL_OTA_H
|
|
|
|
/******************************************************************************
|
|
* INCLUDES
|
|
*/
|
|
|
|
#include "hal_board_cfg.h"
|
|
#include "hal_types.h"
|
|
|
|
/******************************************************************************
|
|
* MACROS
|
|
*/
|
|
|
|
#if !defined HAL_OTA_BOOT_CODE
|
|
#define HAL_OTA_BOOT_CODE FALSE
|
|
#endif
|
|
|
|
// MSP430 needs to explicitly pack OTA data structures - 8051 is automatic with byte alignment.
|
|
#define PACK_1
|
|
|
|
/******************************************************************************
|
|
* CONSTANTS
|
|
*/
|
|
|
|
// Placement controlled by ota.xcl.
|
|
#define HAL_OTA_RC_START 0x0800
|
|
#define HAL_OTA_CRC_ADDR 0x0888
|
|
#define HAL_OTA_CRC_OSET (HAL_OTA_CRC_ADDR - HAL_OTA_RC_START)
|
|
|
|
/* Note that corresponding changes must be made to ota.xcl when changing the source of Xtra-NV.
|
|
* When using internal flash for XNV, (HAL_OTA_BOOT_PG_CNT + HAL_NV_PAGE_CNT) must be even.
|
|
*/
|
|
#define HAL_OTA_XNV_IS_INT FALSE
|
|
#define HAL_OTA_XNV_IS_SPI !HAL_OTA_XNV_IS_INT
|
|
|
|
/* The ota/ota-boot.xcl files only need 1 page of boot code (located on the first flash page),
|
|
* but the Lock Bits Page is lost with OTA since it is not programmable.
|
|
* So discard it here by faking that boot needs 2 pages.
|
|
*/
|
|
#define HAL_OTA_BOOT_PG_CNT 2
|
|
|
|
/* To reduce the binary image size due to padding un-used code space, reduce HAL_OTA_DL_SIZE
|
|
* to the minimum required for your Application and make the corresponding changes to ota_app.xcl.
|
|
* This size must be an even multiple of HAL_FLASH_PAGE_SIZE.
|
|
*/
|
|
#if HAL_OTA_XNV_IS_SPI && !defined HAL_BOARD_CC2530EB_REV13
|
|
#define HAL_OTA_DL_MAX 0x40000
|
|
#define HAL_OTA_DL_SIZE (0x40000 - ((HAL_NV_PAGE_CNT+HAL_OTA_BOOT_PG_CNT)*HAL_FLASH_PAGE_SIZE))
|
|
#define HAL_OTA_DL_OSET 0x0 // Configurable offset into an external NV.
|
|
#else
|
|
#define HAL_OTA_DL_MAX (0x40000 - ((HAL_NV_PAGE_CNT+HAL_OTA_BOOT_PG_CNT)*HAL_FLASH_PAGE_SIZE))
|
|
#define HAL_OTA_DL_SIZE (HAL_OTA_DL_MAX / 2)
|
|
#define HAL_OTA_DL_OSET (HAL_OTA_DL_MAX / 2)
|
|
#endif
|
|
|
|
#define PREAMBLE_OFFSET 0x8C
|
|
|
|
/*********************************************************************
|
|
* TYPEDEFS
|
|
*/
|
|
|
|
typedef enum {
|
|
HAL_OTA_RC, /* Run code / active image. */
|
|
HAL_OTA_DL /* Downloaded code to be activated later. */
|
|
} image_t;
|
|
|
|
typedef struct {
|
|
uint16 crc;
|
|
uint16 crc_shadow;
|
|
} otaCrc_t;
|
|
|
|
typedef struct {
|
|
uint32 programLength;
|
|
uint16 manufacturerId;
|
|
uint16 imageType;
|
|
uint32 imageVersion;
|
|
} preamble_t;
|
|
|
|
/*********************************************************************
|
|
* FUNCTIONS
|
|
*/
|
|
|
|
uint8 HalOTAChkDL(uint8 dlImagePreambleOffset);
|
|
void HalOTAInvRC(void);
|
|
uint32 HalOTAAvail(void);
|
|
void HalOTARead(uint32 oset, uint8 *pBuf, uint16 len, image_t type);
|
|
void HalOTAWrite(uint32 oset, uint8 *pBuf, uint16 len, image_t type);
|
|
#endif
|