This repository has been archived on 2023-07-17. You can view files and clone it, but cannot push or open issues or pull requests.
bl_mcu_sdk/examples/boot2_isp/bflb_eflash_loader_cmds.h

268 lines
8.5 KiB
C

/**
******************************************************************************
* @file blsp_eflash_loader_cmds.h
* @version V1.2
* @date
* @brief This file is the peripheral case header file
******************************************************************************
* @attention
*
* <h2><center>&copy; COPYRIGHT(c) 2018 Bouffalo Lab</center></h2>
*
* 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 Bouffalo Lab 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.
*
******************************************************************************
*/
#ifndef __BFLB_EFLASH_LOADER_CMDS_H__
#define __BFLB_EFLASH_LOADER_CMDS_H__
#include "stdint.h"
#include "bflb_core.h"
#include "bl616_sflash.h"
#define BFLB_EFLASH_LOADER_CMD_GET_BOOTINFO 0x0010
#define BFLB_EFLASH_LOADER_CMD_LOAD_BOOTHEADER 0x0011
#define BFLB_EFLASH_LOADER_CMD_LOAD_PUBLICKEY 0x0012
#define BFLB_EFLASH_LOADER_CMD_LOAD_PUBLICKEY2 0x0013
#define BFLB_EFLASH_LOADER_CMD_LOAD_SIGNATURE 0x0014
#define BFLB_EFLASH_LOADER_CMD_LOAD_SIGNATURE2 0x0015
#define BFLB_EFLASH_LOADER_CMD_LOAD_AESIV 0x0016
#define BFLB_EFLASH_LOADER_CMD_LOAD_SEGHEADER 0x0017
#define BFLB_EFLASH_LOADER_CMD_LOAD_SEGDATA 0x0018
#define BFLB_EFLASH_LOADER_CMD_CHECK_IMG 0x0019
#define BFLB_EFLASH_LOADER_CMD_RUN 0x001A
#define BFLB_EFLASH_LOADER_CMD_CHANGE_RATE 0x0020
#define BFLB_EFLASH_LOADER_CMD_RESET 0x0021
#define BFLB_EFLASH_LOADER_CMD_CLK_SET 0x0022
#define BFLB_EFLASH_LOADER_CMD_FLASH_ERASE 0x0030
#define BFLB_EFLASH_LOADER_CMD_FLASH_WRITE 0x0031
#define BFLB_EFLASH_LOADER_CMD_FLASH_READ 0x0032
#define BFLB_EFLASH_LOADER_CMD_FLASH_BOOT 0x0033
#define BFLB_EFLASH_LOADER_CMD_FLASH_WRITE_CHECK 0x003A
#define BFLB_EFLASH_LOADER_CMD_FLASH_SET_PARA 0x003B
#define BFLB_EFLASH_LOADER_CMD_FLASH_CHIPERASE 0x003C
#define BFLB_EFLASH_LOADER_CMD_FLASH_READSHA 0x003D
#define BFLB_EFLASH_LOADER_CMD_FLASH_XIP_READSHA 0x003E
#define BFLB_EFLASH_LOADER_CMD_FLASH_XIP_READ 0x0034
#define BFLB_EFLASH_LOADER_CMD_FLASH_SBUS_XIP_READ 0x0035
#define BFLB_EFLASH_LOADER_CMD_FLASH_READ_JEDECID 0x0036
#define BFLB_EFLASH_LOADER_CMD_FLASH_READ_STATUS_REG 0x0037
#define BFLB_EFLASH_LOADER_CMD_FLASH_WRITE_STATUS_REG 0x0038
#define BFLB_EFLASH_LOADER_CMD_EFUSE_WRITE 0x0040
#define BFLB_EFLASH_LOADER_CMD_EFUSE_READ 0x0041
#define BFLB_EFLASH_LOADER_CMD_EFUSE_READ_MAC_ADDR 0x0042
#define BFLB_EFLASH_LOADER_CMD_MEM_WRITE 0x0050
#define BFLB_EFLASH_LOADER_CMD_MEM_READ 0x0051
#define BFLB_EFLASH_LOADER_CMD_LOG_READ 0x0071
#define BFLB_EFLASH_LOADER_CMD_XIP_READ_START 0x0060
#define BFLB_EFLASH_LOADER_CMD_XIP_READ_FINISH 0x0061
#define BFLB_EFLASH_LOADER_CMD_ISP_MODE 0x00a0
#define BFLB_EFLASH_LOADER_CMD_IAP_MODE 0x00a1
#define BFLB_EFLASH_LOADER_CMD_GET_ECDH_PK 0x0090
#define BFLB_EFLASH_LOADER_CMD_ECDH_CHANLLENGE 0x0091
/* public key hash type and length */
#define BFLB_EFLASH_LOADER_PK_HASH_TYPE BFLB_HASH_TYPE_SHA256
#define BFLB_EFLASH_LOADER_PK_HASH_SIZE 256 / 8
#define BFLB_EFLASH_LOADER_HASH_TYPE BFLB_HASH_TYPE_SHA256
#define BFLB_EFLASH_LOADER_AES_TYPE BFLB_CRYPT_TYPE_AES_CBC
#define BFLB_EFLASH_LOADER_HASH_SIZE 256 / 8
#define BFLB_BOOTROM_CMD_ACK 0x00004B4F
#define BFLB_BOOTROM_CMD_NACK 0x00004C46
#define BFLB_BOOTROM_VERSION 0x08080001
#define BOOTROM_DEADBEEF_VAL 0xdeadbeef
#define BFLB_BOOTROM_IF_TX_IDLE_TIMEOUT 40 /*ms*/
void bflb_eflash_loader_cmd_disable(uint8_t cmdid);
void bflb_eflash_loader_cmd_enable(uint8_t cmdid);
int32_t bflb_eflash_loader_cmd_process(uint8_t cmdid, uint8_t *data, uint16_t len);
typedef int32_t (*pfun_cmd_process)(uint16_t cmd, uint8_t *data, uint16_t len);
struct eflash_loader_cmd_cfg_t {
uint8_t cmd;
uint8_t enabled;
pfun_cmd_process cmd_process;
};
__PACKED_STRUCT boot_flash_cfg_t
{
uint32_t magiccode; /*'FCFG'*/
SPI_Flash_Cfg_Type cfg;
uint32_t crc32;
};
__PACKED_STRUCT sys_clk_cfg_t
{
uint8_t xtal_type;
uint8_t pll_clk;
uint8_t hclk_div;
uint8_t bclk_div;
uint8_t flash_clk_type;
uint8_t flash_clk_div;
uint8_t rsvd[2];
};
__PACKED_STRUCT boot_clk_cfg_t
{
uint32_t magiccode; /*'PCFG'*/
struct sys_clk_cfg_t cfg;
uint32_t crc32;
};
__PACKED_STRUCT bootheader_t
{
uint32_t magiccode; /*'BFXP'*/
uint32_t rivison;
struct boot_flash_cfg_t flashCfg;
struct boot_clk_cfg_t clkCfg;
__PACKED_UNION
{
__PACKED_STRUCT
{
uint32_t sign : 2; /* [1: 0] for sign*/
uint32_t encrypt_type : 2; /* [3: 2] for encrypt */
uint32_t key_sel : 2; /* [5: 4] for key sel in boot interface*/
uint32_t rsvd6_7 : 2; /* [7: 6] for encrypt*/
uint32_t no_segment : 1; /* [8] no segment info */
uint32_t cache_select : 1; /* [9] for cache */
uint32_t notload_in_bootrom : 1; /* [10] not load this img in bootrom */
uint32_t aes_region_lock : 1; /* [11] aes region lock */
uint32_t cache_way_disable : 4; /* [15: 12] cache way disable info*/
uint32_t crc_ignore : 1; /* [16] ignore crc */
uint32_t hash_ignore : 1; /* [17] hash crc */
uint32_t halt_ap : 1; /* [18] halt ap */
uint32_t rsvd19_31 : 13; /* [31:19] rsvd */
}
bval;
uint32_t wval;
}
bootcfg;
__PACKED_UNION
{
uint32_t segment_cnt;
uint32_t img_len;
}
img_segment_info;
uint32_t bootentry; /* entry point of the image*/
__PACKED_UNION
{
uint32_t ramaddr;
uint32_t flashoffset;
}
img_start;
uint8_t hash[256 / 8];
uint32_t rsv1;
uint32_t rsv2;
uint32_t crc32;
};
__PACKED_STRUCT image_cfg_t
{
uint8_t encrypt_type;
uint8_t sign_type;
uint8_t key_sel;
uint8_t img_valid;
uint8_t no_segment;
uint8_t cache_select;
uint8_t cache_way_disable;
uint8_t hash_ignore;
uint8_t aes_region_lock;
uint8_t halt_ap;
uint8_t r[2];
__PACKED_UNION
{
uint32_t segment_cnt;
uint32_t img_len;
}
img_segment_info;
uint32_t mspval;
uint32_t entrypoint;
__PACKED_UNION
{
uint32_t ramaddr;
uint32_t flashoffset;
}
img_start;
uint32_t sig_len;
uint32_t sig_len2;
uint32_t deallen;
uint32_t maxinputlen;
};
__PACKED_STRUCT bootrom_img_ctrl_t
{
uint8_t segment_cnt;
uint8_t state;
uint8_t pkhash_src;
uint8_t rvsd;
uint32_t segdata_recv_len;
};
__PACKED_STRUCT segment_header_t
{
uint32_t destaddr;
uint32_t len;
uint32_t rsv;
uint32_t crc32;
};
typedef enum tag_bootrom_img_state_t {
BOOTROM_IMG_BOOTHEADER = 0,
BOOTROM_IMG_PK,
BOOTROM_IMG_SIGNATURE,
BOOTROM_IMG_AESIV,
BOOTROM_IMG_SEGHEADER,
BOOTROM_IMG_SEGDATA,
BOOTROM_IMG_CHECK,
BOOTROM_IMG_RUN,
} bootrom_img_state_t;
typedef enum {
EFLASH_LOADER_DOWNLOAD_MODE_IAP = 0,
EFLASH_LOADER_DOWNLOAD_MODE_ISP,
} eflash_loader_download_mode_t;
#endif