Flash

Data Structures
struct	msg_flash_program_t
struct	msg_flash_done_t
struct	msg_flash_read_req_t
struct	msg_flash_read_resp_t
struct	msg_flash_erase_t
struct	msg_stm_flash_lock_sector_t
struct	msg_stm_flash_unlock_sector_t
struct	msg_stm_unique_id_resp_t
struct	msg_m25_flash_write_status_t

Macros
#define	SBP_MSG_FLASH_PROGRAM   0x00E6
	Program flash addresses. More...
#define	SBP_MSG_FLASH_DONE   0x00E0
	Flash response message (host <= device). More...
#define	SBP_MSG_FLASH_READ_REQ   0x00E7
	Read STM or M25 flash address request (host => device). More...
#define	SBP_MSG_FLASH_READ_RESP   0x00E1
	Read STM or M25 flash address response (host <= device). More...
#define	SBP_MSG_FLASH_ERASE   0x00E2
	Erase sector of device flash memory (host => device). More...
#define	SBP_MSG_STM_FLASH_LOCK_SECTOR   0x00E3
	Lock sector of STM flash memory (host => device) More...
#define	SBP_MSG_STM_FLASH_UNLOCK_SECTOR   0x00E4
	Unlock sector of STM flash memory (host => device) More...
#define	SBP_MSG_STM_UNIQUE_ID_REQ   0x00E8
	Read device's hardcoded unique ID request (host => device) More...
#define	SBP_MSG_STM_UNIQUE_ID_RESP   0x00E5
	Read device's hardcoded unique ID response (host <= device) More...
#define	SBP_MSG_M25_FLASH_WRITE_STATUS   0x00F3
	Write M25 flash status register (host => device) More...

Detailed Description

• Messages for reading/writing the device's onboard flash memory. Many of these messages target specific flash memory peripherals used in Swift Navigation devices: the STM32 flash and the M25Pxx FPGA configuration flash from Piksi 2.3.1. This module does not apply to Piksi Multi.

Macro Definition Documentation

#define SBP_MSG_FLASH_DONE   0x00E0

Flash response message (host <= device).

This message defines success or failure codes for a variety of flash memory requests from the host to the device. Flash read and write messages, such as MSG_FLASH_READ_REQ, or MSG_FLASH_PROGRAM, may return this message on failure.

Definition at line 62 of file flash.h.

#define SBP_MSG_FLASH_ERASE   0x00E2

Erase sector of device flash memory (host => device).

The flash erase message from the host erases a sector of either the STM or M25 onboard flash memory. The device will reply with a MSG_FLASH_DONE message containing the return code - FLASH_OK (0) on success or FLASH_INVALID_FLASH (1) if the flash specified is invalid.

Definition at line 116 of file flash.h.

#define SBP_MSG_FLASH_PROGRAM   0x00E6

Program flash addresses.

The flash program message programs a set of addresses of either the STM or M25 flash. The device replies with either a MSG_FLASH_DONE message containing the return code FLASH_OK (0) on success, or FLASH_INVALID_LEN (2) if the maximum write size is exceeded. Note that the sector-containing addresses must be erased before addresses can be programmed.

Definition at line 44 of file flash.h.

#define SBP_MSG_FLASH_READ_REQ   0x00E7

Read STM or M25 flash address request (host => device).

The flash read message reads a set of addresses of either the STM or M25 onboard flash. The device replies with a MSG_FLASH_READ_RESP message containing either the read data on success or a MSG_FLASH_DONE message containing the return code FLASH_INVALID_LEN (2) if the maximum read size is exceeded or FLASH_INVALID_ADDR (3) if the address is outside of the allowed range.

Definition at line 78 of file flash.h.

#define SBP_MSG_FLASH_READ_RESP   0x00E1

Read STM or M25 flash address response (host <= device).

The flash read message reads a set of addresses of either the STM or M25 onboard flash. The device replies with a MSG_FLASH_READ_RESP message containing either the read data on success or a MSG_FLASH_DONE message containing the return code FLASH_INVALID_LEN (2) if the maximum read size is exceeded or FLASH_INVALID_ADDR (3) if the address is outside of the allowed range.

Definition at line 98 of file flash.h.

#define SBP_MSG_M25_FLASH_WRITE_STATUS   0x00F3

Write M25 flash status register (host => device)

The flash status message writes to the 8-bit M25 flash status register. The device replies with a MSG_FLASH_DONE message.

Definition at line 177 of file flash.h.

#define SBP_MSG_STM_FLASH_LOCK_SECTOR   0x00E3

Lock sector of STM flash memory (host => device)

The flash lock message locks a sector of the STM flash memory. The device replies with a MSG_FLASH_DONE message.

Definition at line 130 of file flash.h.

#define SBP_MSG_STM_FLASH_UNLOCK_SECTOR   0x00E4

Unlock sector of STM flash memory (host => device)

The flash unlock message unlocks a sector of the STM flash memory. The device replies with a MSG_FLASH_DONE message.

Definition at line 141 of file flash.h.

#define SBP_MSG_STM_UNIQUE_ID_REQ   0x00E8

Read device's hardcoded unique ID request (host => device)

This message reads the device's hardcoded unique ID. The host requests the ID by sending a MSG_STM_UNIQUE_ID_REQ. The device responds with a MSG_STM_UNIQUE_ID_RESP with the 12-byte unique ID in the payload.

Definition at line 155 of file flash.h.

#define SBP_MSG_STM_UNIQUE_ID_RESP   0x00E5

Read device's hardcoded unique ID response (host <= device)

This message reads the device's hardcoded unique ID. The host requests the ID by sending a MSG_STM_UNIQUE_ID_REQ. The device responds with a MSG_STM_UNIQUE_ID_RESP with the 12-byte unique ID in the payload..

Definition at line 166 of file flash.h.