123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516 |
- enum _flash_driver_version_constants
- {
- kFLASH_DriverVersionName = 'F',
- kFLASH_DriverVersionMajor = 2,
- kFLASH_DriverVersionMinor = 0,
- kFLASH_DriverVersionBugfix = 0
- };
- enum _flash_status
- {
- kStatus_FLASH_Success = MAKE_STATUS(kStatusGroupGeneric, 0),
- kStatus_FLASH_InvalidArgument = MAKE_STATUS(kStatusGroupGeneric, 4),
- kStatus_FLASH_SizeError = MAKE_STATUS(kStatusGroupFlashDriver, 0),
- kStatus_FLASH_AlignmentError =
- MAKE_STATUS(kStatusGroupFlashDriver, 1),
- kStatus_FLASH_AddressError = MAKE_STATUS(kStatusGroupFlashDriver, 2),
- kStatus_FLASH_AccessError =
- MAKE_STATUS(kStatusGroupFlashDriver, 3),
- kStatus_FLASH_ProtectionViolation = MAKE_STATUS(
- kStatusGroupFlashDriver, 4),
- kStatus_FLASH_CommandFailure =
- MAKE_STATUS(kStatusGroupFlashDriver, 5),
- kStatus_FLASH_UnknownProperty = MAKE_STATUS(kStatusGroupFlashDriver, 6),
- kStatus_FLASH_EraseKeyError = MAKE_STATUS(kStatusGroupFlashDriver, 7),
- kStatus_FLASH_RegionExecuteOnly =
- MAKE_STATUS(kStatusGroupFlashDriver, 8),
- kStatus_FLASH_ExecuteInRamFunctionNotReady =
- MAKE_STATUS(kStatusGroupFlashDriver, 9),
- kStatus_FLASH_CommandNotSupported = MAKE_STATUS(kStatusGroupFlashDriver, 11),
- kStatus_FLASH_ReadOnlyProperty = MAKE_STATUS(kStatusGroupFlashDriver, 12),
- kStatus_FLASH_InvalidPropertyValue =
- MAKE_STATUS(kStatusGroupFlashDriver, 13),
- kStatus_FLASH_InvalidSpeculationOption =
- MAKE_STATUS(kStatusGroupFlashDriver, 14),
- kStatus_FLASH_EccError = MAKE_STATUS(kStatusGroupFlashDriver,
- 0x10),
- kStatus_FLASH_CompareError =
- MAKE_STATUS(kStatusGroupFlashDriver, 0x11),
- kStatus_FLASH_RegulationLoss = MAKE_STATUS(kStatusGroupFlashDriver, 0x12),
- kStatus_FLASH_InvalidWaitStateCycles =
- MAKE_STATUS(kStatusGroupFlashDriver, 0x13),
- kStatus_FLASH_OutOfDateCfpaPage =
- MAKE_STATUS(kStatusGroupFlashDriver, 0x20),
- kStatus_FLASH_BlankIfrPageData = MAKE_STATUS(kStatusGroupFlashDriver, 0x21),
- kStatus_FLASH_EncryptedRegionsEraseNotDoneAtOnce =
- MAKE_STATUS(kStatusGroupFlashDriver, 0x22),
- kStatus_FLASH_ProgramVerificationNotAllowed = MAKE_STATUS(
- kStatusGroupFlashDriver, 0x23),
- kStatus_FLASH_HashCheckError =
- MAKE_STATUS(kStatusGroupFlashDriver, 0x24),
- kStatus_FLASH_SealedFfrRegion = MAKE_STATUS(kStatusGroupFlashDriver, 0x25),
- kStatus_FLASH_FfrRegionWriteBroken = MAKE_STATUS(
- kStatusGroupFlashDriver, 0x26),
- kStatus_FLASH_NmpaAccessNotAllowed =
- MAKE_STATUS(kStatusGroupFlashDriver, 0x27),
- kStatus_FLASH_CmpaCfgDirectEraseNotAllowed =
- MAKE_STATUS(kStatusGroupFlashDriver, 0x28),
- kStatus_FLASH_FfrBankIsLocked = MAKE_STATUS(kStatusGroupFlashDriver, 0x29),
- };
- enum _flash_driver_api_keys
- {
- kFLASH_ApiEraseKey = FOUR_CHAR_CODE('l', 'f', 'e', 'k')
- };
- typedef enum _flash_property_tag
- {
- kFLASH_PropertyPflashSectorSize = 0x00U,
- kFLASH_PropertyPflashTotalSize = 0x01U,
- kFLASH_PropertyPflashBlockSize = 0x02U,
- kFLASH_PropertyPflashBlockCount = 0x03U,
- kFLASH_PropertyPflashBlockBaseAddr = 0x04U,
- kFLASH_PropertyPflashPageSize = 0x30U,
- kFLASH_PropertyPflashSystemFreq = 0x31U,
- kFLASH_PropertyFfrSectorSize = 0x40U,
- kFLASH_PropertyFfrTotalSize = 0x41U,
- kFLASH_PropertyFfrBlockBaseAddr = 0x42U,
- kFLASH_PropertyFfrPageSize = 0x43U,
- } flash_property_tag_t;
- enum _flash_max_erase_page_value
- {
- kFLASH_MaxPagesToErase = 100U
- };
- enum _flash_freq_tag
- {
- kSysToFlashFreq_lowInMHz = 12u,
- kSysToFlashFreq_defaultInMHz = 96u,
- kSysToFlashFreq_100MHz = 100u
- };
- enum _flash_alignment_property
- {
- kFLASH_AlignementUnitVerifyErase = 4,
- kFLASH_AlignementUnitProgram = 512,
-
- kFLASH_AlignementUnitSingleWordRead = 16
- };
- enum _flash_read_ecc_option
- {
- kFLASH_ReadWithEccOn = 0,
- kFLASH_ReadWithEccOff = 1,
- };
- enum _flash_read_margin_option
- {
- kFLASH_ReadMarginNormal = 0,
- kFLASH_ReadMarginVsProgram = 1,
- kFLASH_ReadMarginVsErase = 2,
- kFLASH_ReadMarginIllegalBitCombination = 3
- };
- enum _flash_read_dmacc_option
- {
- kFLASH_ReadDmaccDisabled = 0,
- kFLASH_ReadDmaccEnabled = 1,
- };
- enum _flash_ramp_control_option
- {
- kFLASH_RampControlDivisionFactorReserved = 0,
- kFLASH_RampControlDivisionFactor256 = 1,
- kFLASH_RampControlDivisionFactor128 = 2,
- kFLASH_RampControlDivisionFactor64 = 3
- };
- typedef struct _flash_ecc_log
- {
- uint32_t firstEccEventAddress;
- uint32_t eccErrorCount;
- uint32_t eccCorrectionCount;
- uint32_t reserved;
- } flash_ecc_log_t;
- typedef struct _flash_mode_config
- {
- uint32_t sysFreqInMHz;
-
- struct
- {
- uint8_t readWithEccOff : 1;
- uint8_t readMarginLevel : 2;
- uint8_t readDmaccWord : 1;
- uint8_t reserved0 : 4;
- uint8_t reserved1[3];
- } readSingleWord;
-
- struct
- {
- uint8_t programRampControl;
- uint8_t eraseRampControl;
- uint8_t reserved[2];
- } setWriteMode;
-
- struct
- {
- uint16_t readInterfaceTimingTrim;
- uint16_t readControllerTimingTrim;
- uint8_t readWaitStates;
- uint8_t reserved[3];
- } setReadMode;
- } flash_mode_config_t;
- typedef struct _flash_ffr_config
- {
- uint32_t ffrBlockBase;
- uint32_t ffrTotalSize;
- uint32_t ffrPageSize;
- uint32_t cfpaPageVersion;
- uint32_t cfpaPageOffset;
- } flash_ffr_config_t;
- typedef struct _flash_config
- {
- uint32_t PFlashBlockBase;
- uint32_t PFlashTotalSize;
- uint32_t PFlashBlockCount;
- uint32_t PFlashPageSize;
- uint32_t PFlashSectorSize;
- flash_ffr_config_t ffrConfig;
- flash_mode_config_t modeConfig;
- } flash_config_t;
- extern "C" {
- status_t FLASH_Init(flash_config_t *config);
- status_t FLASH_Erase(flash_config_t *config, uint32_t start, uint32_t lengthInBytes, uint32_t key);
- status_t FLASH_Program(flash_config_t *config, uint32_t start, uint8_t *src, uint32_t lengthInBytes);
- status_t FLASH_VerifyErase(flash_config_t *config, uint32_t start, uint32_t lengthInBytes);
- status_t FLASH_VerifyProgram(flash_config_t *config,
- uint32_t start,
- uint32_t lengthInBytes,
- const uint8_t *expectedData,
- uint32_t *failedAddress,
- uint32_t *failedData);
- status_t FLASH_GetProperty(flash_config_t *config, flash_property_tag_t whichProperty, uint32_t *value);
- status_t FLASH_SetProperty(flash_config_t *config, flash_property_tag_t whichProperty, uint32_t value);
- }
|