Data Structures | Macros | Typedefs | Enumerations | Variables
SBL Internal Data Structures

The section has a list of all internal data structures which are used internally by the SBL module. More...

Data Structures

struct  SBL_BufferParams_t
 Structure containing buffer structure parameters. More...
 
struct  SBL_InputBuffer_t
 Input buffer structure used for image parsing. More...
 
struct  SBL_sectionParams_t
 Structure describes section parser parameters. More...
 
struct  SBL_ImagePrms_t
 Structure describes image parser parameters. More...
 
struct  SBL_AuthProcess_t
 Authentication state m/c parameters. More...
 
struct  SBL_DecryptProcess_t
 Decryption state m/c parameters. More...
 
struct  SBL_ImageDetails_t
 Structure containing image details. More...
 
struct  SBL_MetaHeader_t
 Structure containing all the metaheader details. More...
 
struct  SBL_Transport_t
 SBL Transport related data structure. More...
 
struct  SBL_MCB_t
 SBL Master Control Block. More...
 

Macros

#define SBL_INPUT_BUFFER_SIZE   (512U)
 
#define SBL_NUM_INPUT_BUFFERS   (2U)
 
#define SBL_RPRC_HDR_LENGTH   (24U)
 
#define SBL_RPRC_MAGIC_WORD   (0x43525052U)
 
#define SBL_RPRC_SEC_HDR_LENGTH   (24U)
 
#define SBL_CONFIG_FILE_SIZE   (2048U)
 
#define SBL_MSS_SUBSYSTEM   (0x3551U)
 
#define SBL_MSS_SUBSYSTEM_DEBUG   (0x355DU)
 
#define SBL_BSS_SUBSYSTEM   (0xB551U)
 
#define SBL_DSS_SUBSYSTEM   (0xD551U)
 
#define SBL_CONFIG_SUBSYSTEM   (0xCF91U)
 
#define SBL_SUBSYSTEM_MASK   (0xFFFF0000U)
 
#define SBL_SUBSYSTEM_SHIFT   (16U)
 
#define SBL_NUM_FILES_SUPPORTED   (5U)
 Maximum number files supported by the parser.
 
#define SBL_META_HDR_START   (0x5254534DU)
 Metaheader start word.
 
#define SBL_META_HDR_END   (0x444E454DU)
 Metaheader end word.
 
#define SBL_VECTOR_TABLE_SIZE   64U
 Size of the vector table.
 
#define SBL_UART_BAUDRATE   115200U
 UART baud rate at which the application metaimage file will be transferred.
 
#define SBL_XMODEM_MAX_RETRANSMISSIONS   10U
 This is the maximum number of retransmissions the xmodem will attempt before canceling the download.
 
#define SBL_XMODEM_MAX_WAIT   20U
 This is the maximum number of times the xmodem will attempt to establish a transfer.
 

Typedefs

typedef enum SBL_BufferState_t SBL_BufferState
 Current buffer states.
 
typedef struct SBL_BufferParams_t SBL_BufferParams
 Structure containing buffer structure parameters.
 
typedef struct SBL_InputBuffer_t SBL_InputBuffer
 Input buffer structure used for image parsing.
 
typedef enum SBL_SECTION_STATE_t SBL_SECTION_STATE
 Section header parser states.
 
typedef enum SBL_RPRC_HDR_STATE_t SBL_RPRC_HDR_STATE
 RPRC header parser states.
 
typedef enum SBL_RPRC_PARSER_STATE_t SBL_RPRC_PARSER_STATE
 RPRC Image parser states.
 
typedef enum SBL_BUFFER_PARSER_STATE_t SBL_BUFFER_PARSER_STATE
 Multicore image buffer parser states.
 
typedef struct SBL_sectionParams_t SBL_sectionParams
 Structure describes section parser parameters.
 
typedef struct SBL_ImagePrms_t SBL_ImageParams
 Structure describes image parser parameters.
 
typedef enum SBL_AUTH_STATE_t SBL_AUTH_STATE
 Authentication states.
 
typedef enum SBL_DECRYPT_STATE_t SBL_DECRYPT_STATE
 Authentication states.
 
typedef struct SBL_AuthProcess_t SBL_AuthProcess
 Authentication state m/c parameters.
 
typedef struct SBL_DecryptProcess_t SBL_DecryptProcess
 Decryption state m/c parameters.
 
typedef enum SBL_DeviceType_t SBL_DeviceType
 Device type.
 
typedef struct SBL_ImageDetails_t SBL_ImageDetails
 Structure containing image details.
 
typedef struct SBL_MetaHeader_t SBL_MetaHeader
 Structure containing all the metaheader details.
 
typedef struct SBL_Transport_t SBL_Transport
 SBL Transport related data structure. More...
 
typedef struct SBL_MCB_t SBL_MCB
 SBL Master Control Block. More...
 

Enumerations

Variables

SBL_MCB gSblMCB
 Global SBL MCB Pointer.
 

Detailed Description

The section has a list of all internal data structures which are used internally by the SBL module.

Macro Definition Documentation

#define SBL_BSS_SUBSYSTEM   (0xB551U)

BSS subsystem identifier.

#define SBL_CONFIG_FILE_SIZE   (2048U)

Config file size max length in bytes.

#define SBL_CONFIG_SUBSYSTEM   (0xCF91U)

Config subsystem identifier.

#define SBL_DSS_SUBSYSTEM   (0xD551U)

DSS subsystem identifier.

#define SBL_INPUT_BUFFER_SIZE   (512U)

Size of the buffers in words.

#define SBL_MSS_SUBSYSTEM   (0x3551U)

MSS subsystem identifier.

#define SBL_MSS_SUBSYSTEM_DEBUG   (0x355DU)

MSS subsystem identifier for debug.

#define SBL_NUM_INPUT_BUFFERS   (2U)

Number of input buffers.

#define SBL_RPRC_HDR_LENGTH   (24U)

RPRC header length in bytes.

#define SBL_RPRC_MAGIC_WORD   (0x43525052U)

RPRC header magic word.

#define SBL_RPRC_SEC_HDR_LENGTH   (24U)

RPRC section header length in bytes.

#define SBL_SUBSYSTEM_MASK   (0xFFFF0000U)

subsystem identifier mask.

#define SBL_SUBSYSTEM_SHIFT   (16U)

subsystem identifier shift.

Typedef Documentation

typedef struct SBL_MCB_t SBL_MCB

SBL Master Control Block.

The structure describes the SBL internal data structures and is used to hold the relevant information with respect to the SBL module.

SBL Transport related data structure.

The structure describes the transport data fields used to download the meta image.

Enumeration Type Documentation

Authentication states.

Enumerator
SBL_AUTH_STATE_START 

Auth State start.

SBL_AUTH_STATE_PROCESS 

Auth state process.

SBL_AUTH_STATE_END 

Auth state end.

SBL_AUTH_STATE_ALIGN 

Auth state align.

Multicore image buffer parser states.

Enumerator
SBL_BUFFER_PARSER_STATE_IDLE 

Multicore image buffer parser state idle.

SBL_BUFFER_PARSER_META_HEADER 

Multicore image buffer parser state meta header.

SBL_BUFFER_PARSER_RPRC_DWLD 

Multicore image buffer parser state RPRC download.

SBL_BUFFER_PARSER_COMPLETED 

Multicore image buffer parser state completed.

Current buffer states.

Enumerator
SBL_BUFFER_EMPTY 

Empty available buffer.

SBL_BUFFER_FILLING 

Buffer busy with data being read into the buffer.

SBL_BUFFER_FULL 

Buffer has data ready to be processed.

Authentication states.

Enumerator
SBL_DECRYPT_STATE_START 

Decrypt State start.

SBL_DECRYPT_STATE_PROCESS 

Decrypt state process.

SBL_DECRYPT_STATE_END 

Decrypt state end.

SBL_DECRYPT_STATE_ALIGN 

Decrypt state align.

Device type.

Enumerator
SBL_DEVICE_HS 

Device type HS.

SBL_DEVICE_GP 

Device type GP.

RPRC header parser states.

Enumerator
SBL_RPRC_HDR_STATE_MAGIC 

RPRC header parser state magic number.

SBL_RPRC_HDR_STATE_LEN 

RPRC header parser state length.

SBL_RPRC_HDR_STATE_RSVD 

RPRC header parser state reserved.

SBL_RPRC_HDR_STATE_END 

RPRC header parser state header end.

RPRC Image parser states.

Enumerator
SBL_RPRC_PARSER_STATE_IDLE 

RPRC parser state idle.

SBL_RPRC_PARSER_SECTION_HEADER 

RPRC parser state section header.

SBL_RPRC_PARSER_SECTION_DOWNLOAD 

RPRC parser state section download.

SBL_RPRC_PARSER_ALIGNMENT_BYTES 

RPRC parser state alignment bytes.

Section header parser states.

Enumerator
SBL_SEC_STATE_START_ADDR 

Section header parser state start address.

SBL_SEC_STATE_SEC_LEN 

Section header parser state section length.

SBL_SEC_STATE_RSVD 

Section header parser state reserved.

SBL_SEC_STATE_HDR_END 

Section header parser state header end.


Copyright 2019, Texas Instruments Incorporated