| Copyright | Copyright (C) 2015-2021 Swift Navigation Inc. |
|---|---|
| License | MIT |
| Stability | experimental |
| Portability | portable |
| Safe Haskell | None |
| Language | Haskell2010 |
SwiftNav.SBP.Flash
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. >
Synopsis
- msgFlashProgram :: Word16
- data MsgFlashProgram = MsgFlashProgram {}
- msgFlashDone :: Word16
- data MsgFlashDone = MsgFlashDone {}
- msgFlashReadReq :: Word16
- data MsgFlashReadReq = MsgFlashReadReq {}
- msgFlashReadResp :: Word16
- data MsgFlashReadResp = MsgFlashReadResp {}
- msgFlashErase :: Word16
- data MsgFlashErase = MsgFlashErase {}
- msgStmFlashLockSector :: Word16
- data MsgStmFlashLockSector = MsgStmFlashLockSector {}
- msgStmFlashUnlockSector :: Word16
- data MsgStmFlashUnlockSector = MsgStmFlashUnlockSector {}
- msgStmUniqueIdReq :: Word16
- data MsgStmUniqueIdReq = MsgStmUniqueIdReq
- msgStmUniqueIdResp :: Word16
- data MsgStmUniqueIdResp = MsgStmUniqueIdResp {}
- msgM25FlashWriteStatus :: Word16
- data MsgM25FlashWriteStatus = MsgM25FlashWriteStatus {}
- msgFlashProgram_addr_len :: Lens' MsgFlashProgram Word8
- msgFlashProgram_addr_start :: Lens' MsgFlashProgram [Word8]
- msgFlashProgram_data :: Lens' MsgFlashProgram [Word8]
- msgFlashProgram_target :: Lens' MsgFlashProgram Word8
- msgFlashDone_response :: Iso' MsgFlashDone Word8
- msgFlashReadReq_addr_len :: Lens' MsgFlashReadReq Word8
- msgFlashReadReq_addr_start :: Lens' MsgFlashReadReq [Word8]
- msgFlashReadReq_target :: Lens' MsgFlashReadReq Word8
- msgFlashReadResp_addr_len :: Lens' MsgFlashReadResp Word8
- msgFlashReadResp_addr_start :: Lens' MsgFlashReadResp [Word8]
- msgFlashReadResp_target :: Lens' MsgFlashReadResp Word8
- msgFlashErase_sector_num :: Lens' MsgFlashErase Word32
- msgFlashErase_target :: Lens' MsgFlashErase Word8
- msgStmFlashLockSector_sector :: Iso' MsgStmFlashLockSector Word32
- msgStmFlashUnlockSector_sector :: Iso' MsgStmFlashUnlockSector Word32
- msgStmUniqueIdResp_stm_id :: Iso' MsgStmUniqueIdResp [Word8]
- msgM25FlashWriteStatus_status :: Iso' MsgM25FlashWriteStatus [Word8]
Documentation
data MsgFlashProgram Source #
SBP class for message MSG_FLASH_PROGRAM (0x00E6).
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.
Constructors
| MsgFlashProgram | |
Fields
| |
Instances
data MsgFlashDone Source #
SBP class for message MSG_FLASH_DONE (0x00E0).
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.
Constructors
| MsgFlashDone | |
Fields
| |
Instances
| FromJSON MsgFlashDone Source # | |
Defined in SwiftNav.SBP.Flash | |
| ToJSON MsgFlashDone Source # | |
Defined in SwiftNav.SBP.Flash Methods toJSON :: MsgFlashDone -> Value # toEncoding :: MsgFlashDone -> Encoding # toJSONList :: [MsgFlashDone] -> Value # toEncodingList :: [MsgFlashDone] -> Encoding # omitField :: MsgFlashDone -> Bool # | |
| Read MsgFlashDone Source # | |
Defined in SwiftNav.SBP.Flash Methods readsPrec :: Int -> ReadS MsgFlashDone # readList :: ReadS [MsgFlashDone] # | |
| Show MsgFlashDone Source # | |
Defined in SwiftNav.SBP.Flash Methods showsPrec :: Int -> MsgFlashDone -> ShowS # show :: MsgFlashDone -> String # showList :: [MsgFlashDone] -> ShowS # | |
| Binary MsgFlashDone Source # | |
Defined in SwiftNav.SBP.Flash | |
| Eq MsgFlashDone Source # | |
Defined in SwiftNav.SBP.Flash | |
| ToSBP MsgFlashDone Source # | |
Defined in SwiftNav.SBP.Flash | |
data MsgFlashReadReq Source #
SBP class for message MSG_FLASH_READ_REQ (0x00E7).
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.
Constructors
| MsgFlashReadReq | |
Fields
| |
Instances
data MsgFlashReadResp Source #
SBP class for message MSG_FLASH_READ_RESP (0x00E1).
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.
Constructors
| MsgFlashReadResp | |
Fields
| |
Instances
data MsgFlashErase Source #
SBP class for message MSG_FLASH_ERASE (0x00E2).
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.
Constructors
| MsgFlashErase | |
Fields
| |
Instances
data MsgStmFlashLockSector Source #
SBP class for message MSG_STM_FLASH_LOCK_SECTOR (0x00E3).
The flash lock message locks a sector of the STM flash memory. The device replies with a MSG_FLASH_DONE message.
Constructors
| MsgStmFlashLockSector | |
Fields
| |
Instances
data MsgStmFlashUnlockSector Source #
SBP class for message MSG_STM_FLASH_UNLOCK_SECTOR (0x00E4).
The flash unlock message unlocks a sector of the STM flash memory. The device replies with a MSG_FLASH_DONE message.
Constructors
| MsgStmFlashUnlockSector | |
Fields
| |
Instances
data MsgStmUniqueIdReq Source #
SBP class for message MSG_STM_UNIQUE_ID_REQ (0x00E8).
This message reads the device's hard-coded 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.
Constructors
| MsgStmUniqueIdReq |
Instances
data MsgStmUniqueIdResp Source #
SBP class for message MSG_STM_UNIQUE_ID_RESP (0x00E5).
This message reads the device's hard-coded 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.
Constructors
| MsgStmUniqueIdResp | |
Fields
| |
Instances
data MsgM25FlashWriteStatus Source #
SBP class for message MSG_M25_FLASH_WRITE_STATUS (0x00F3).
The flash status message writes to the 8-bit M25 flash status register. The device replies with a MSG_FLASH_DONE message.
Constructors
| MsgM25FlashWriteStatus | |
Fields
| |