1 /* -------------------------------- Arctic Core ------------------------------
\r
2 * Arctic Core - the open source AUTOSAR platform http://arccore.com
\r
4 * Copyright (C) 2009 ArcCore AB <contact@arccore.com>
\r
6 * This source code is free software; you can redistribute it and/or modify it
\r
7 * under the terms of the GNU General Public License version 2 as published by the
\r
8 * Free Software Foundation; See <http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt>.
\r
10 * This program is distributed in the hope that it will be useful, but
\r
11 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
\r
12 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
\r
14 * -------------------------------- Arctic Core ------------------------------*/
\r
26 #include "Fee_Cbk.h"
\r
27 #include "Fee_Memory_Cfg.h"
\r
30 #include "Rte.h" // ???
\r
31 #if defined(USE_DEM)
\r
34 //#include "SchM_NvM.h"
\r
44 #if ( FEE_DEV_ERROR_DETECT == STD_ON )
\r
46 #define VALIDATE(_exp,_api,_err ) \
\r
48 Det_ReportError(MODULE_ID_FEE, 0, _api, _err); \
\r
51 #define VALIDATE_RV(_exp,_api,_err,_rv ) \
\r
53 Det_ReportError(MODULE_ID_FEE, 0, _api, _err); \
\r
54 /* PC-Lint exception (MISRA 14.7) - Allow return statement before end of function in validate macros */ \
\r
55 /*lint -e(904)*/return _rv; \
\r
58 #define VALIDATE_NO_RV(_exp,_api,_err ) \
\r
60 Det_ReportError(MODULE_ID_FEE, 0, _api, _err); \
\r
61 /* PC-Lint exception (MISRA 14.7)- Allow return statement before end of function in validate macros */ \
\r
62 /*lint -e(904)*/ return; \
\r
65 #define DET_REPORTERROR(_module,_instance,_api,_err) Det_ReportError(_module,_instance,_api,_err)
\r
67 #define MIN_BLOCKNR ((uint16)((uint16)1 << NVM_DATASET_SELECTION_BITS))
\r
70 #define VALIDATE(_exp,_api,_err )
\r
71 #define VALIDATE_RV(_exp,_api,_err,_rv )
\r
72 #define VALIDATE_NO_RV(_exp,_api,_err )
\r
73 #define DET_REPORTERROR(_module,_instance,_api,_err)
\r
78 * Block numbering recalculation macros
80 #define GET_BLOCK_INDEX_FROM_BLOCK_NUMBER(_blocknr) (((_blocknr) >> NVM_DATASET_SELECTION_BITS) - 1u)
\r
81 #define GET_DATASET_FROM_BLOCK_NUMBER(_blocknr) ((_blocknr) & ((uint16)((uint16)1u << NVM_DATASET_SELECTION_BITS) - 1u))
\r
82 #define BLOCK_INDEX_AND_SET_TO_BLOCKNR(_blocknr, _set) ((uint16)((_blocknr + 1u) << NVM_DATASET_SELECTION_BITS) | set)
\r
85 * Page alignment macros
87 #define PAGE_ALIGN(_size) ((uint16)((((_size) + FEE_VIRTUAL_PAGE_SIZE - 1) / FEE_VIRTUAL_PAGE_SIZE) * FEE_VIRTUAL_PAGE_SIZE))
\r
90 * Bank properties list
92 #define NUM_OF_BANKS 2
\r
94 Fls_AddressType Start;
\r
98 static const BankPropType BankProp[NUM_OF_BANKS] = {
\r
100 .Start = FEE_BANK1_OFFSET,
\r
101 .End = FEE_BANK1_OFFSET + FEE_BANK1_LENGTH
\r
104 .Start = FEE_BANK2_OFFSET,
\r
105 .End = FEE_BANK2_OFFSET + FEE_BANK2_LENGTH
\r
112 * Macros and variables for flash bank administration
114 #define BANK_STATUS_OLD 0x00
\r
115 #define BANK_STATUS_NEW 0xFF
\r
116 typedef uint8 FlsBankStatusType;
\r
118 #define BANK_CTRL_PAGE_SIZE PAGE_ALIGN(sizeof(FlsBankStatusType))
\r
121 FlsBankStatusType BankStatus;
\r
122 uint8 Data[BANK_CTRL_PAGE_SIZE];
\r
123 } FlsBankCtrlPageType;
\r
127 * Macros and variables for flash block administration in flash
129 #define BLOCK_STATUS_INUSE 0x00
\r
130 #define BLOCK_STATUS_INVALIDATED 0x02
\r
131 #define BLOCK_STATUS_EMPTY 0xFF
\r
132 typedef uint8 BlockStatusType;
\r
135 BlockStatusType Status;
\r
137 Fls_AddressType BlockDataAddress;
\r
138 uint16 BlockDataLength;
\r
139 } FlsBlockCtrlDataType;
\r
141 #define BLOCK_CTRL_DATA_PAGE_SIZE PAGE_ALIGN(sizeof(FlsBlockCtrlDataType))
\r
144 FlsBlockCtrlDataType Data;
\r
145 uint8 Byte[BLOCK_CTRL_DATA_PAGE_SIZE];
\r
146 } FlsBlockCtrlDataPageType;
\r
149 #define BLOCK_MAGIC_LEN 4
\r
150 static const uint8 BlockMagicMaster[BLOCK_MAGIC_LEN] = { 0xeb, 0xba, 0xba, 0xbe };
\r
151 #define BLOCK_CTRL_MAGIC_PAGE_SIZE PAGE_ALIGN(BLOCK_MAGIC_LEN)
\r
155 uint8 Magic[BLOCK_MAGIC_LEN];
\r
156 uint8 Byte[BLOCK_CTRL_MAGIC_PAGE_SIZE];
\r
157 } FlsBlockCtrlMagicPageType;
\r
160 FlsBlockCtrlDataPageType DataPage;
\r
161 FlsBlockCtrlMagicPageType MagicPage;
\r
162 } FlsBlockControlType;
\r
164 #define BLOCK_CTRL_PAGE_SIZE PAGE_ALIGN(sizeof(FlsBlockControlType))
\r
166 #define BLOCK_CTRL_DATA_POS_OFFSET (/*lint --e(835)*/0) // Inform PC-Lint that I want the constant to be zero
\r
167 #define BLOCK_CTRL_MAGIC_POS_OFFSET BLOCK_CTRL_DATA_PAGE_SIZE
\r
170 FlsBlockControlType BlockCtrl;
\r
171 FlsBankCtrlPageType BankCtrl;
\r
172 uint8 Byte[BLOCK_CTRL_PAGE_SIZE];
\r
173 } ReadWriteBufferType;
\r
175 static ReadWriteBufferType RWBuffer;
\r
177 #define RWBUFFER_SIZE sizeof(ReadWriteBufferType)
\r
181 * Variables for flash administration
\r
184 BlockStatusType Status;
\r
185 Fls_AddressType BlockAdminAddress;
\r
186 Fls_AddressType BlockDataAddress;
\r
187 } AdminFlsBlockType;
\r
191 Fls_AddressType NewBlockAdminAddress;
\r
192 Fls_AddressType NewBlockDataAddress;
\r
193 FlsBankStatusType BankStatus[NUM_OF_BANKS];
\r
194 AdminFlsBlockType BlockDescrTbl[FEE_NUM_OF_BLOCKS][FEE_MAX_NUM_SETS];
\r
197 static AdminFlsType AdminFls;
\r
201 * Variables for quick reporting of status and job result
203 static MemIf_StatusType ModuleStatus = MEMIF_UNINIT;
\r
204 static MemIf_JobResultType JobResult = MEMIF_JOB_OK;
\r
207 * Variables for the current job
210 FEE_UNINITIALIZED = 0,
\r
211 FEE_STARTUP_REQUESTED,
\r
212 FEE_STARTUP_READ_BANK1_STATUS,
\r
213 FEE_STARTUP_READ_BANK2_STATUS_REQUESTED,
\r
214 FEE_STARTUP_READ_BANK2_STATUS,
\r
215 FEE_STARTUP_READ_BLOCK_ADMIN_REQUESTED,
\r
216 FEE_STARTUP_READ_BLOCK_ADMIN,
\r
220 FEE_WRITE_REQUESTED,
\r
221 FEE_WRITE_MARK_BANK_OLD,
\r
222 FEE_WRITE_HEADER_REQUESTED,
\r
224 FEE_WRITE_DATA_REQUESTED,
\r
226 FEE_WRITE_MAGIC_REQUESTED,
\r
229 FEE_READ_REQUESTED,
\r
232 FEE_INVALIDATE_REQUESTED,
\r
233 FEE_INVALIDATE_MARK_BANK_OLD,
\r
234 FEE_WRITE_INVALIDATE_HEADER_REQUESTED,
\r
235 FEE_WRITE_INVALIDATE_HEADER,
\r
237 FEE_GARBAGE_COLLECT_REQUESTED,
\r
238 FEE_GARBAGE_COLLECT_HEADER_WRITE,
\r
239 FEE_GARBAGE_COLLECT_DATA_READ_REQUESTED,
\r
240 FEE_GARBAGE_COLLECT_DATA_READ,
\r
241 FEE_GARBAGE_COLLECT_DATA_WRITE_REQUESTED,
\r
242 FEE_GARBAGE_COLLECT_DATA_WRITE,
\r
243 FEE_GARBAGE_COLLECT_MAGIC_WRITE_REQUESTED,
\r
244 FEE_GARBAGE_COLLECT_MAGIC_WRITE,
\r
245 FEE_GARBAGE_COLLECT_ERASE
\r
246 } CurrentJobStateType;
\r
249 CurrentJobStateType State;
\r
250 uint16 InStateCounter;
\r
251 uint16 BlockNumber;
\r
253 const Fee_BlockConfigType *BlockConfigPtr;
\r
254 AdminFlsBlockType *AdminFlsBlockPtr;
\r
259 Fls_AddressType BlockAdminAddress;
\r
267 Fls_AddressType WriteAdminAddress;
\r
268 Fls_AddressType WriteDataAddress;
\r
271 Fls_AddressType WriteAdminAddress;
\r
272 Fls_AddressType WriteDataAddress;
\r
276 Fls_AddressType WriteAdminAddress;
\r
277 Fls_AddressType WriteDataAddress;
\r
284 static CurrentJobType CurrentJob = {
\r
286 .InStateCounter = 0
\r
287 //lint -e{785} PC-Lint (785) - rest of structure members is initialized when used.
\r
293 #define STATE_COUNTER_MAX 0xffff
\r
294 #define GARBAGE_COLLECTION_DELAY 10
\r
296 /***************************************
\r
297 * Local functions *
\r
298 ***************************************/
\r
300 #if (FEE_POLLING_MODE == STD_ON)
\r
301 #define SetFlsJobBusy() /* Nothing needs to be done here */
\r
303 static boolean CheckFlsJobFinnished(void)
\r
305 MemIf_JobResultType flsJobResult;
\r
307 flsJobResult = Fls_GetJobResult();
\r
308 return (flsJobResult != MEMIF_JOB_PENDING);
\r
311 static boolean FlsJobReady = TRUE;
\r
313 static void SetFlsJobBusy()
\r
315 FlsJobReady = FALSE;
\r
318 static boolean CheckFlsJobFinnished(void)
\r
320 return (FlsJobReady);
\r
326 static void FinnishStartup(void)
\r
328 CurrentJob.State = FEE_IDLE;
\r
329 ModuleStatus = MEMIF_IDLE;
\r
330 JobResult = MEMIF_JOB_OK;
\r
334 static void AbortStartup(MemIf_JobResultType result)
\r
336 CurrentJob.State = FEE_IDLE;
\r
337 ModuleStatus = MEMIF_IDLE;
\r
338 JobResult = result;
\r
342 static void FinnishJob(void)
\r
344 CurrentJob.State = FEE_IDLE;
\r
345 ModuleStatus = MEMIF_IDLE;
\r
346 JobResult = MEMIF_JOB_OK;
\r
348 if (Fee_Config.General.NvmJobEndCallbackNotificationCallback != NULL) {
\r
349 Fee_Config.General.NvmJobEndCallbackNotificationCallback();
\r
354 static void AbortJob(MemIf_JobResultType result)
\r
356 CurrentJob.State = FEE_IDLE;
\r
357 ModuleStatus = MEMIF_IDLE;
\r
358 JobResult = result;
\r
360 if (Fee_Config.General.NvmJobErrorCallbackNotificationCallback != NULL) {
\r
361 Fee_Config.General.NvmJobErrorCallbackNotificationCallback();
\r
367 * Start of bank status 1 read
\r
369 static void StartupStartJob(void)
\r
371 if (Fls_GetStatus() == MEMIF_IDLE) {
\r
372 CurrentJob.State = FEE_STARTUP_READ_BANK1_STATUS;
\r
373 /* Read bank status of bank 1 */
\r
374 // PC-Lint exception (MISRA 11.4) - Pointer to pointer conversion ok by AUTOSAR
\r
375 if (Fls_Read(BankProp[0].End - BANK_CTRL_PAGE_SIZE, /*lint -e(926)*/(uint8*)&AdminFls.BankStatus[0], sizeof(FlsBankStatusType)) == E_OK) {
\r
378 AbortStartup(Fls_GetJobResult());
\r
385 * Check job result of bank 1 status read, if ok request for bank 2 status read
\r
387 static void StartupReadBank1Status(void)
\r
389 if (CheckFlsJobFinnished()) {
\r
390 if (Fls_GetJobResult() == MEMIF_JOB_OK) {
\r
391 CurrentJob.State = FEE_STARTUP_READ_BANK2_STATUS_REQUESTED;
\r
393 AbortStartup(Fls_GetJobResult());
\r
400 * Start of bank status 2 read
\r
402 static void StartupReadBank2StatusRequested(void)
\r
404 if (Fls_GetStatus() == MEMIF_IDLE) {
\r
405 /* Read bank status of bank 2 */
\r
406 CurrentJob.State = FEE_STARTUP_READ_BANK2_STATUS;
\r
407 // PC-Lint exception (MISRA 11.4) - Pointer to pointer conversion ok by AUTOSAR
\r
408 if (Fls_Read(BankProp[1].End - BANK_CTRL_PAGE_SIZE, /*lint -e(926)*/(uint8*)&AdminFls.BankStatus[1], sizeof(FlsBankStatusType)) == E_OK) {
\r
411 AbortStartup(Fls_GetJobResult());
\r
418 * Check job result of bank status 2 read - request for block status reading
420 static void StartupReadBank2Status(void)
\r
422 MemIf_JobResultType jobResult;
\r
424 if (CheckFlsJobFinnished()) {
\r
425 jobResult = Fls_GetJobResult();
\r
426 if (jobResult == MEMIF_JOB_OK) {
\r
427 /* Select which bank to start with */
\r
428 if ((AdminFls.BankStatus[0] != BANK_STATUS_OLD) && (AdminFls.BankStatus[1] != BANK_STATUS_OLD)){
\r
429 /* None is marked as old, just start with one of them */
\r
430 CurrentJob.Op.Startup.BankNumber = 0;
\r
431 CurrentJob.Op.Startup.NrOfBanks = 2;
\r
432 } else if ((AdminFls.BankStatus[0] == BANK_STATUS_OLD) && (AdminFls.BankStatus[1] == BANK_STATUS_OLD) ) {
\r
433 /* Both banks are marked as old, this shall not be possible */
\r
434 DET_REPORTERROR(MODULE_ID_FEE, 0, FEE_STARTUP_ID, FEE_FLASH_CORRUPT);
\r
435 jobResult = MEMIF_JOB_FAILED;
\r
436 } else if (AdminFls.BankStatus[0] == BANK_STATUS_OLD) {
\r
437 CurrentJob.Op.Startup.BankNumber = 0;
\r
438 CurrentJob.Op.Startup.NrOfBanks = 2;
\r
440 CurrentJob.Op.Startup.BankNumber = 1;
\r
441 CurrentJob.Op.Startup.NrOfBanks = 2;
\r
445 if (jobResult != MEMIF_JOB_OK) {
\r
446 AbortStartup(jobResult);
\r
448 CurrentJob.Op.Startup.BlockAdminAddress = BankProp[CurrentJob.Op.Startup.BankNumber].End - (BLOCK_CTRL_PAGE_SIZE + BANK_CTRL_PAGE_SIZE);
\r
449 CurrentJob.State = FEE_STARTUP_READ_BLOCK_ADMIN_REQUESTED;
\r
455 * Start of block admin read
457 static void StartupReadBlockAdminRequested(void)
\r
459 if (Fls_GetStatus() == MEMIF_IDLE) {
\r
460 /* Start reading the banks */
\r
461 CurrentJob.State = FEE_STARTUP_READ_BLOCK_ADMIN;
\r
462 if (Fls_Read(CurrentJob.Op.Startup.BlockAdminAddress, RWBuffer.Byte, BLOCK_CTRL_PAGE_SIZE) == E_OK) {
\r
465 AbortStartup(Fls_GetJobResult());
\r
472 * Check job result of block admin read, if all block processed finish
\r
473 * otherwise request for a new block admin read
475 static void StartupReadBlockAdmin(void)
\r
477 if (CheckFlsJobFinnished()) {
\r
478 if (Fls_GetJobResult() == MEMIF_JOB_OK) {
\r
479 if (RWBuffer.BlockCtrl.DataPage.Data.Status == BLOCK_STATUS_EMPTY) {
\r
480 VALIDATE(CurrentJob.Op.Startup.NrOfBanks != 0, FEE_STARTUP_ID, FEE_FLASH_CORRUPT);
\r
481 CurrentJob.Op.Startup.NrOfBanks--;
\r
482 CurrentJob.Op.Startup.BankNumber = (CurrentJob.Op.Startup.BankNumber + 1) % 2;
\r
483 CurrentJob.Op.Startup.BlockAdminAddress = BankProp[CurrentJob.Op.Startup.BankNumber].End - (BLOCK_CTRL_PAGE_SIZE + BANK_CTRL_PAGE_SIZE);
\r
484 } else { /* Block not empty */
\r
485 if ((memcmp(RWBuffer.BlockCtrl.MagicPage.Magic, BlockMagicMaster, BLOCK_MAGIC_LEN) == 0) &&
\r
486 ((RWBuffer.BlockCtrl.DataPage.Data.Status == BLOCK_STATUS_INUSE) || (RWBuffer.BlockCtrl.DataPage.Data.Status == BLOCK_STATUS_INVALIDATED))) {
\r
487 /* This is a valid admin block */
\r
491 blockIndex = GET_BLOCK_INDEX_FROM_BLOCK_NUMBER(RWBuffer.BlockCtrl.DataPage.Data.BlockNo);
\r
492 dataSet = GET_DATASET_FROM_BLOCK_NUMBER(RWBuffer.BlockCtrl.DataPage.Data.BlockNo);
\r
494 if ((blockIndex < FEE_NUM_OF_BLOCKS) && (dataSet < FEE_MAX_NUM_SETS)) {
\r
495 AdminFls.BlockDescrTbl[blockIndex][dataSet].BlockAdminAddress = CurrentJob.Op.Startup.BlockAdminAddress;
\r
496 AdminFls.BlockDescrTbl[blockIndex][dataSet].BlockDataAddress = RWBuffer.BlockCtrl.DataPage.Data.BlockDataAddress;
\r
497 AdminFls.BlockDescrTbl[blockIndex][dataSet].Status = RWBuffer.BlockCtrl.DataPage.Data.Status;
\r
499 AdminFls.BankNumber = CurrentJob.Op.Startup.BankNumber;
\r
500 AdminFls.NewBlockDataAddress = RWBuffer.BlockCtrl.DataPage.Data.BlockDataAddress + RWBuffer.BlockCtrl.DataPage.Data.BlockDataLength;
\r
501 if (CurrentJob.Op.Startup.BlockAdminAddress <= AdminFls.NewBlockDataAddress) {
\r
502 /* This shall never happen */
\r
503 DET_REPORTERROR(MODULE_ID_FEE, 0, FEE_STARTUP_ID, FEE_FLASH_CORRUPT);
\r
507 CurrentJob.Op.Startup.BlockAdminAddress -= BLOCK_CTRL_PAGE_SIZE;
\r
508 AdminFls.NewBlockAdminAddress = CurrentJob.Op.Startup.BlockAdminAddress;
\r
511 if (CurrentJob.Op.Startup.NrOfBanks == 0) {
\r
512 /* If current bank is marked as old we need to switch to a new bank */
\r
513 if (AdminFls.BankStatus[AdminFls.BankNumber] == BANK_STATUS_OLD) {
\r
514 AdminFls.BankNumber = (AdminFls.BankNumber + 1) % 2;
\r
515 AdminFls.NewBlockAdminAddress = BankProp[AdminFls.BankNumber].End - (BLOCK_CTRL_PAGE_SIZE + BANK_CTRL_PAGE_SIZE);
\r
516 AdminFls.NewBlockDataAddress = BankProp[AdminFls.BankNumber].Start;
\r
521 CurrentJob.State = FEE_STARTUP_READ_BLOCK_ADMIN_REQUESTED;
\r
525 } else { /* ErrorStatus not E_OK */
\r
526 AbortStartup(Fls_GetJobResult());
\r
533 * Start of read block data
\r
535 static void ReadStartJob(void)
\r
537 if (Fls_GetStatus() == MEMIF_IDLE) {
\r
538 if (CurrentJob.AdminFlsBlockPtr->Status != BLOCK_STATUS_EMPTY) {
\r
539 if (CurrentJob.AdminFlsBlockPtr->Status != BLOCK_STATUS_INVALIDATED) {
\r
540 CurrentJob.State = FEE_READ;
\r
541 /* Read the actual data */
\r
542 if (Fls_Read(CurrentJob.AdminFlsBlockPtr->BlockDataAddress + CurrentJob.Op.Read.Offset, CurrentJob.Op.Read.RamPtr, CurrentJob.Length) == E_OK) {
\r
545 AbortJob(Fls_GetJobResult());
\r
549 AbortJob(MEMIF_BLOCK_INVALID);
\r
553 AbortJob(MEMIF_BLOCK_INCONSISTENT);
\r
559 * Check job result of block data read
561 static void Reading(void)
\r
563 if (CheckFlsJobFinnished()) {
\r
564 if (Fls_GetJobResult() == MEMIF_JOB_OK) {
\r
567 AbortJob(Fls_GetJobResult());
\r
574 * Write bank header
\r
576 static void BankHeaderOldWrite(uint8 bank)
\r
578 /* Mark the bank as old */
\r
579 memset(RWBuffer.BankCtrl.Data, 0xff, BANK_CTRL_PAGE_SIZE);
\r
580 RWBuffer.BankCtrl.BankStatus = BANK_STATUS_OLD;
\r
581 if (Fls_Write(BankProp[bank].End - BANK_CTRL_PAGE_SIZE, RWBuffer.BankCtrl.Data, BANK_CTRL_PAGE_SIZE) == E_OK) {
\r
584 AbortJob(Fls_GetJobResult());
\r
590 * Write block header
\r
592 static void BlockHeaderDataWrite(void)
\r
594 /* Write the header excluding the magic */
\r
595 memset(RWBuffer.BlockCtrl.DataPage.Byte, 0xff, BLOCK_CTRL_DATA_PAGE_SIZE);
\r
596 RWBuffer.BlockCtrl.DataPage.Data.Status = BLOCK_STATUS_INUSE;
\r
597 RWBuffer.BlockCtrl.DataPage.Data.BlockNo = CurrentJob.BlockNumber;
\r
598 RWBuffer.BlockCtrl.DataPage.Data.BlockDataAddress = AdminFls.NewBlockDataAddress;
\r
599 RWBuffer.BlockCtrl.DataPage.Data.BlockDataLength = CurrentJob.Length;
\r
600 if (Fls_Write(CurrentJob.Op.Write.WriteAdminAddress + BLOCK_CTRL_DATA_POS_OFFSET, RWBuffer.Byte, BLOCK_CTRL_DATA_PAGE_SIZE) == E_OK) {
\r
602 AdminFls.NewBlockDataAddress += CurrentJob.Length;
\r
603 AdminFls.NewBlockAdminAddress -= BLOCK_CTRL_PAGE_SIZE;
\r
605 AbortJob(Fls_GetJobResult());
\r
611 * Check if bank switch needed:
\r
612 * - Yes, start mark current bank as old
\r
613 * - No, start of header write
\r
615 static void WriteStartJob(void)
\r
617 if (Fls_GetStatus() == MEMIF_IDLE) {
\r
618 if (AdminFls.NewBlockDataAddress + CurrentJob.BlockConfigPtr->BlockSize > AdminFls.NewBlockAdminAddress - BLOCK_CTRL_PAGE_SIZE) {
\r
619 /* Bank switch needed, mark current bank as "old" */
\r
620 CurrentJob.State = FEE_WRITE_MARK_BANK_OLD;
\r
621 BankHeaderOldWrite(AdminFls.BankNumber);
\r
623 CurrentJob.Op.Write.WriteDataAddress = AdminFls.NewBlockDataAddress;
\r
624 CurrentJob.Op.Write.WriteAdminAddress = AdminFls.NewBlockAdminAddress;
\r
626 CurrentJob.State = FEE_WRITE_HEADER;
\r
627 BlockHeaderDataWrite();
\r
634 * Check job result of mark bank as old, if ok request for header write
\r
636 static void WriteMarkBankOldState(void)
\r
638 if (CheckFlsJobFinnished()) {
\r
639 if (Fls_GetJobResult() == MEMIF_JOB_OK) {
\r
640 /* Mark for garbage collection */
\r
641 AdminFls.BankStatus[AdminFls.BankNumber] = BANK_STATUS_OLD;
\r
643 /* Change of bank */
\r
644 AdminFls.BankNumber ^= 0x1u;
\r
645 AdminFls.NewBlockDataAddress = BankProp[AdminFls.BankNumber].Start;
\r
646 AdminFls.NewBlockAdminAddress = BankProp[AdminFls.BankNumber].End - (BLOCK_CTRL_PAGE_SIZE + BANK_CTRL_PAGE_SIZE);
\r
648 CurrentJob.Op.Write.WriteDataAddress = AdminFls.NewBlockDataAddress;
\r
649 CurrentJob.Op.Write.WriteAdminAddress = AdminFls.NewBlockAdminAddress;
\r
651 CurrentJob.State = FEE_WRITE_HEADER_REQUESTED;
\r
653 AbortJob(Fls_GetJobResult());
\r
660 * Start of header write
662 static void WriteHeaderRequested()
\r
664 if (Fls_GetStatus() == MEMIF_IDLE) {
\r
665 CurrentJob.State = FEE_WRITE_HEADER;
\r
666 BlockHeaderDataWrite();
\r
672 * Check job result of write header, if ok request for block data write
\r
674 static void WriteHeaderState(void)
\r
676 if (CheckFlsJobFinnished()) {
\r
677 if (Fls_GetJobResult() == MEMIF_JOB_OK) {
\r
678 CurrentJob.State = FEE_WRITE_DATA_REQUESTED;
\r
680 AbortJob(Fls_GetJobResult());
\r
687 * Start block data write
689 static void WriteDataRequested(void)
\r
691 if (Fls_GetStatus() == MEMIF_IDLE) {
\r
692 CurrentJob.State = FEE_WRITE_DATA;
\r
693 /* Write the actual data */
\r
694 if (Fls_Write(CurrentJob.Op.Write.WriteDataAddress, CurrentJob.Op.Write.RamPtr, CurrentJob.Length) == E_OK) {
\r
697 AbortJob(Fls_GetJobResult());
\r
704 * Check job result of data write - request for magic write
\r
706 static void WriteDataState(void)
\r
708 if (CheckFlsJobFinnished()) {
\r
709 if (Fls_GetJobResult() == MEMIF_JOB_OK) {
\r
710 CurrentJob.State = FEE_WRITE_MAGIC_REQUESTED;
\r
712 AbortJob(Fls_GetJobResult());
\r
721 static void WriteMagicRequested(void)
\r
723 if (Fls_GetStatus() == MEMIF_IDLE) {
\r
724 CurrentJob.State = FEE_WRITE_MAGIC;
\r
725 memset(RWBuffer.BlockCtrl.MagicPage.Byte, 0xff, BLOCK_CTRL_MAGIC_PAGE_SIZE);
\r
726 memcpy(RWBuffer.BlockCtrl.MagicPage.Magic, BlockMagicMaster, BLOCK_MAGIC_LEN);
\r
727 if (Fls_Write(CurrentJob.Op.Write.WriteAdminAddress + BLOCK_CTRL_MAGIC_POS_OFFSET, RWBuffer.BlockCtrl.MagicPage.Byte, BLOCK_CTRL_MAGIC_PAGE_SIZE) == E_OK) {
\r
730 AbortJob(Fls_GetJobResult());
\r
737 * Check job result of write magic, if ok update the block admin table and finish
\r
739 static void WriteMagicState(void)
\r
741 if (CheckFlsJobFinnished()) {
\r
742 if (Fls_GetJobResult() == MEMIF_JOB_OK) {
\r
743 /* Update the block admin table */
\r
744 CurrentJob.AdminFlsBlockPtr->Status = BLOCK_STATUS_INUSE;
\r
745 CurrentJob.AdminFlsBlockPtr->BlockAdminAddress = CurrentJob.Op.Write.WriteAdminAddress;
\r
746 CurrentJob.AdminFlsBlockPtr->BlockDataAddress = CurrentJob.Op.Write.WriteDataAddress;
\r
750 AbortJob(Fls_GetJobResult());
\r
757 * Check if any bank is marked as old
\r
759 static void CheckIfGarbageCollectionNeeded(void)
\r
761 if ((AdminFls.BankStatus[0] == BANK_STATUS_OLD) || (AdminFls.BankStatus[1] == BANK_STATUS_OLD)) {
\r
762 ModuleStatus = MEMIF_BUSY_INTERNAL;
\r
763 JobResult = MEMIF_JOB_PENDING;
\r
765 CurrentJob.State = FEE_GARBAGE_COLLECT_REQUESTED;
\r
771 * Checks if any blocks needs to be moved if so start with writing a new header
\r
772 * or if no blocks needs to be moved request for bank erase.
\r
774 static void GarbageCollectStartJob(void)
\r
778 boolean found = FALSE;
\r
781 if (Fls_GetStatus() == MEMIF_IDLE) {
\r
782 if ((AdminFls.BankStatus[0] == BANK_STATUS_OLD) || (AdminFls.BankStatus[1] == BANK_STATUS_OLD)) {
\r
783 if (AdminFls.BankStatus[0] == BANK_STATUS_OLD) {
\r
789 for (blockIndex = 0; (blockIndex < FEE_NUM_OF_BLOCKS) && (!found); blockIndex++) {
\r
790 for (set = 0; (set < FEE_MAX_NUM_SETS) && (!found); set++) {
\r
791 if (AdminFls.BlockDescrTbl[blockIndex][set].Status != BLOCK_STATUS_EMPTY) {
\r
792 if ((AdminFls.BlockDescrTbl[blockIndex][set].BlockAdminAddress >= BankProp[sourceBank].Start) && (AdminFls.BlockDescrTbl[blockIndex][set].BlockAdminAddress < (BankProp[sourceBank].End))) {
\r
793 CurrentJob.AdminFlsBlockPtr = &AdminFls.BlockDescrTbl[blockIndex][set];
\r
794 CurrentJob.BlockConfigPtr = &Fee_Config.BlockConfig[blockIndex];
\r
795 CurrentJob.BlockNumber = BLOCK_INDEX_AND_SET_TO_BLOCKNR(blockIndex, set);
\r
796 if (AdminFls.BlockDescrTbl[blockIndex][set].Status == BLOCK_STATUS_INVALIDATED) {
\r
797 CurrentJob.Length = 0;
\r
799 CurrentJob.Length = PAGE_ALIGN(CurrentJob.BlockConfigPtr->BlockSize);
\r
809 CurrentJob.Op.GarbageCollect.WriteDataAddress = AdminFls.NewBlockDataAddress;
\r
810 CurrentJob.Op.GarbageCollect.WriteAdminAddress = AdminFls.NewBlockAdminAddress;
\r
812 CurrentJob.State = FEE_GARBAGE_COLLECT_HEADER_WRITE;
\r
813 BlockHeaderDataWrite();
\r
815 if (Fls_Erase(BankProp[sourceBank].Start, BankProp[sourceBank].End - BankProp[sourceBank].Start) == E_OK) {
\r
818 AbortJob(Fls_GetJobResult());
\r
820 CurrentJob.Op.GarbageCollect.BankNumber = sourceBank;
\r
821 CurrentJob.State = FEE_GARBAGE_COLLECT_ERASE;
\r
824 CurrentJob.State = FEE_IDLE;
\r
831 * Check job result of write header, if ok request for read block data
\r
833 static void GarbageCollectWriteHeader(void)
\r
835 if (CheckFlsJobFinnished()) {
\r
836 if (Fls_GetJobResult() == MEMIF_JOB_OK) {
\r
837 if (CurrentJob.AdminFlsBlockPtr->Status == BLOCK_STATUS_INUSE) {
\r
838 CurrentJob.Op.GarbageCollect.BytesLeft = PAGE_ALIGN(CurrentJob.BlockConfigPtr->BlockSize);
\r
839 CurrentJob.Op.GarbageCollect.DataOffset = 0;
\r
840 CurrentJob.State = FEE_GARBAGE_COLLECT_DATA_READ_REQUESTED;
\r
842 /* Yes, we are finished */
\r
843 VALIDATE_NO_RV(CurrentJob.AdminFlsBlockPtr->Status == BLOCK_STATUS_INVALIDATED, FEE_GARBAGE_WRITE_HEADER_ID, FEE_UNEXPECTED_STATUS);
\r
844 CurrentJob.State = FEE_GARBAGE_COLLECT_MAGIC_WRITE_REQUESTED;
\r
847 AbortJob(Fls_GetJobResult());
\r
854 * Start of read block data, if data length is more than buffer size
\r
855 * the reading is segmented.
\r
857 static void GarbageCollectReadDataRequested(void)
\r
859 if (Fls_GetStatus() == MEMIF_IDLE) {
\r
860 CurrentJob.State = FEE_GARBAGE_COLLECT_DATA_READ;
\r
861 if (CurrentJob.Op.GarbageCollect.BytesLeft <= RWBUFFER_SIZE) {
\r
862 CurrentJob.Length = CurrentJob.Op.GarbageCollect.BytesLeft;
\r
864 CurrentJob.Length = RWBUFFER_SIZE;
\r
866 if (Fls_Read(CurrentJob.AdminFlsBlockPtr->BlockDataAddress + CurrentJob.Op.GarbageCollect.DataOffset, RWBuffer.Byte, CurrentJob.Length) == E_OK) {
\r
869 AbortJob(Fls_GetJobResult());
\r
876 * Check job result of read block data, if ok request for a data write
\r
878 static void GarbageCollectReadData(void)
\r
880 if (CheckFlsJobFinnished()) {
\r
881 if (Fls_GetJobResult() == MEMIF_JOB_OK) {
\r
882 CurrentJob.State = FEE_GARBAGE_COLLECT_DATA_WRITE_REQUESTED;
\r
884 AbortJob(Fls_GetJobResult());
\r
891 * Start of write block data
\r
893 static void GarbageCollectWriteDataRequested(void)
\r
895 if (Fls_GetStatus() == MEMIF_IDLE) {
\r
896 CurrentJob.State = FEE_GARBAGE_COLLECT_DATA_WRITE;
\r
897 /* Write the actual data */
\r
898 if (Fls_Write(CurrentJob.Op.GarbageCollect.WriteDataAddress + CurrentJob.Op.GarbageCollect.DataOffset, RWBuffer.Byte, CurrentJob.Length) == E_OK) {
\r
901 AbortJob(Fls_GetJobResult());
\r
904 AbortJob(Fls_GetJobResult());
\r
910 * Check job result of write data, if ok request for write magic or
\r
911 * next data read depending on if there are more block data to move.
\r
913 static void GarbageCollectWriteData(void)
\r
915 if (CheckFlsJobFinnished()) {
\r
916 if (Fls_GetJobResult() == MEMIF_JOB_OK) {
\r
917 if (CurrentJob.Op.GarbageCollect.BytesLeft <= RWBUFFER_SIZE) {
\r
918 /* Yes, we are finished */
\r
919 CurrentJob.State = FEE_GARBAGE_COLLECT_MAGIC_WRITE_REQUESTED;
\r
921 /* More data to move */
\r
922 CurrentJob.Op.GarbageCollect.DataOffset += RWBUFFER_SIZE;
\r
923 CurrentJob.Op.GarbageCollect.BytesLeft -= RWBUFFER_SIZE;
\r
924 CurrentJob.State = FEE_GARBAGE_COLLECT_DATA_READ_REQUESTED;
\r
927 AbortJob(Fls_GetJobResult());
\r
934 * Start write magic
\r
936 static void GarbageCollectWriteMagicRequested(void)
\r
938 if (Fls_GetStatus() == MEMIF_IDLE) {
\r
939 CurrentJob.State = FEE_GARBAGE_COLLECT_MAGIC_WRITE;
\r
940 memset(RWBuffer.BlockCtrl.MagicPage.Byte, 0xff, BLOCK_CTRL_MAGIC_PAGE_SIZE);
\r
941 memcpy(RWBuffer.BlockCtrl.MagicPage.Magic, BlockMagicMaster, BLOCK_MAGIC_LEN);
\r
942 if (Fls_Write(CurrentJob.Op.GarbageCollect.WriteAdminAddress + BLOCK_CTRL_MAGIC_POS_OFFSET, RWBuffer.BlockCtrl.MagicPage.Byte, BLOCK_CTRL_MAGIC_PAGE_SIZE) == E_OK) {
\r
945 AbortJob(Fls_GetJobResult());
\r
952 * Check the job result of write magic, if ok update the admin table with the new position of data.
\r
954 static void GarbageCollectWriteMagic(void)
\r
956 if (CheckFlsJobFinnished()) {
\r
957 if (Fls_GetJobResult() == MEMIF_JOB_OK) {
\r
958 CurrentJob.AdminFlsBlockPtr->BlockAdminAddress = CurrentJob.Op.GarbageCollect.WriteAdminAddress;
\r
959 CurrentJob.AdminFlsBlockPtr->BlockDataAddress = CurrentJob.Op.GarbageCollect.WriteDataAddress;
\r
962 AbortJob(Fls_GetJobResult());
\r
969 * Check the result of the erase job
\r
971 static void GarbageCollectErase(void)
\r
973 if (CheckFlsJobFinnished()) {
\r
974 if (Fls_GetJobResult() == MEMIF_JOB_OK) {
\r
975 AdminFls.BankStatus[CurrentJob.Op.GarbageCollect.BankNumber] = BANK_STATUS_NEW;
\r
978 AbortJob(Fls_GetJobResult());
\r
985 * Write an "Invalidated" block header
\r
987 static void BlockHeaderInvalidWrite(void)
\r
989 // Write the header including the magic
\r
990 memset(RWBuffer.Byte, 0xff, BLOCK_CTRL_PAGE_SIZE);
\r
991 RWBuffer.BlockCtrl.DataPage.Data.Status = BLOCK_STATUS_INVALIDATED;
\r
992 RWBuffer.BlockCtrl.DataPage.Data.BlockNo = CurrentJob.BlockNumber;
\r
993 RWBuffer.BlockCtrl.DataPage.Data.BlockDataAddress = AdminFls.NewBlockDataAddress;
\r
994 RWBuffer.BlockCtrl.DataPage.Data.BlockDataLength = 0;
\r
995 memset(RWBuffer.BlockCtrl.MagicPage.Byte, 0xff, BLOCK_CTRL_MAGIC_PAGE_SIZE);
\r
996 memcpy(RWBuffer.BlockCtrl.MagicPage.Magic, BlockMagicMaster, BLOCK_MAGIC_LEN);
\r
998 if (Fls_Write(CurrentJob.Op.Invalidate.WriteAdminAddress + BLOCK_CTRL_DATA_POS_OFFSET, RWBuffer.Byte, BLOCK_CTRL_PAGE_SIZE) == E_OK) {
\r
1000 AdminFls.NewBlockDataAddress += CurrentJob.Length;
\r
1001 AdminFls.NewBlockAdminAddress -= BLOCK_CTRL_PAGE_SIZE;
\r
1003 AbortJob(Fls_GetJobResult());
\r
1009 * Check if bank switch is needed, if yes request for marking current bank as old,
\r
1010 * if no request for writing a header with "Invalid" status set.
\r
1012 static void InvalidateStartJob(void)
\r
1014 if (Fls_GetStatus() == MEMIF_IDLE) {
\r
1015 if (AdminFls.NewBlockDataAddress + CurrentJob.BlockConfigPtr->BlockSize > AdminFls.NewBlockAdminAddress - BLOCK_CTRL_PAGE_SIZE) {
\r
1016 /* Bank switch needed, mark current bank as "old" */
\r
1017 CurrentJob.State = FEE_INVALIDATE_MARK_BANK_OLD;
\r
1018 BankHeaderOldWrite(AdminFls.BankNumber);
\r
1020 CurrentJob.Op.Invalidate.WriteDataAddress = AdminFls.NewBlockDataAddress;
\r
1021 CurrentJob.Op.Invalidate.WriteAdminAddress = AdminFls.NewBlockAdminAddress;
\r
1023 CurrentJob.State = FEE_WRITE_INVALIDATE_HEADER;
\r
1024 BlockHeaderInvalidWrite();
\r
1031 * Check job result of mark bank old, if ok continue with request for writing
\r
1032 * a header with "Invalid" status set.
\r
1034 static void InvalidateMarkBankOld(void)
\r
1036 if (CheckFlsJobFinnished()) {
\r
1037 if (Fls_GetJobResult() == MEMIF_JOB_OK) {
\r
1038 // Mark for garbage collection
\r
1039 AdminFls.BankStatus[AdminFls.BankNumber] = BANK_STATUS_OLD;
\r
1042 AdminFls.BankNumber ^= 0x1u;
\r
1043 AdminFls.NewBlockDataAddress = BankProp[AdminFls.BankNumber].Start;
\r
1044 AdminFls.NewBlockAdminAddress = BankProp[AdminFls.BankNumber].End - (BLOCK_CTRL_PAGE_SIZE + BANK_CTRL_PAGE_SIZE);
\r
1046 CurrentJob.Op.Invalidate.WriteDataAddress = AdminFls.NewBlockDataAddress;
\r
1047 CurrentJob.Op.Invalidate.WriteAdminAddress = AdminFls.NewBlockAdminAddress;
\r
1049 CurrentJob.State = FEE_WRITE_INVALIDATE_HEADER_REQUESTED;
\r
1051 AbortJob(Fls_GetJobResult());
\r
1057 * Start the writing of the "Invalid" header.
1059 static void InvalidateWriteInvalidateHeaderRequested(void)
\r
1061 if (Fls_GetStatus() == MEMIF_IDLE) {
\r
1062 CurrentJob.State = FEE_WRITE_INVALIDATE_HEADER;
\r
1063 BlockHeaderInvalidWrite();
\r
1069 * Check the job result of "Invalid" header write, if ok update the block admin table
\r
1071 static void InvalidateWriteInvalidateHeader(void)
\r
1073 if (CheckFlsJobFinnished()) {
\r
1074 if (Fls_GetJobResult() == MEMIF_JOB_OK) {
\r
1075 // Update the block admin table
\r
1076 CurrentJob.AdminFlsBlockPtr->Status = BLOCK_STATUS_INVALIDATED;
\r
1077 CurrentJob.AdminFlsBlockPtr->BlockAdminAddress = CurrentJob.Op.Invalidate.WriteAdminAddress;
\r
1078 CurrentJob.AdminFlsBlockPtr->BlockDataAddress = CurrentJob.Op.Invalidate.WriteDataAddress;
\r
1082 AbortJob(Fls_GetJobResult());
\r
1088 /***************************************
\r
1089 * External accessible functions *
\r
1090 ***************************************/
\r
1092 * Procedure: Fee_Init
\r
1095 void Fee_Init(void)
\r
1099 /* Reporting information */
\r
1100 ModuleStatus = MEMIF_BUSY_INTERNAL;
\r
1101 JobResult = MEMIF_JOB_OK;
\r
1103 /* State of device */
\r
1104 CurrentJob.State = FEE_STARTUP_REQUESTED;
\r
1105 CurrentJob.InStateCounter = 0;
\r
1106 #if (FEE_POLLING_MODE == STD_OFF)
\r
1107 FlsJobReady = TRUE;
\r
1110 AdminFls.BankNumber = 0;
\r
1111 AdminFls.NewBlockDataAddress = BankProp[AdminFls.BankNumber].Start;
\r
1112 AdminFls.NewBlockAdminAddress = BankProp[AdminFls.BankNumber].End - (BLOCK_CTRL_PAGE_SIZE + BANK_CTRL_PAGE_SIZE);
\r
1114 for (i = 0; i < NUM_OF_BANKS; i++) {
\r
1115 AdminFls.BankStatus[i] = BANK_STATUS_NEW;
\r
1118 for (i = 0; i < FEE_NUM_OF_BLOCKS; i++) {
\r
1119 for (j = 0; j < FEE_MAX_NUM_SETS; j++) {
\r
1120 AdminFls.BlockDescrTbl[i][j].Status = BLOCK_STATUS_EMPTY;
\r
1121 AdminFls.BlockDescrTbl[i][j].BlockAdminAddress= 0;
\r
1122 AdminFls.BlockDescrTbl[i][j].BlockDataAddress = 0;
\r
1129 * Procedure: Fee_SetMode
\r
1132 void Fee_SetMode(MemIf_ModeType mode)
\r
1134 #if ( FLS_SET_MODE_API == STD_ON )
\r
1135 Fls_SetMode(mode);
\r
1137 //lint --e{715} PC-Lint (715) - variable "mode" not used in this case
\r
1138 DET_REPORTERROR(MODULE_ID_FEE, 0, FEE_SET_MODE_ID, FEE_E_NOT_SUPPORTED);
\r
1143 * Procedure: Fee_Read
\r
1146 Std_ReturnType Fee_Read(uint16 blockNumber, uint16 blockOffset, uint8* dataBufferPtr, uint16 length)
\r
1148 uint16 blockIndex;
\r
1151 VALIDATE_RV(ModuleStatus != MEMIF_UNINIT, FEE_READ_ID, FEE_E_UNINIT, E_NOT_OK);
\r
1152 VALIDATE_RV(ModuleStatus == MEMIF_IDLE, FEE_READ_ID, FEE_E_BUSY, E_NOT_OK);
\r
1154 VALIDATE_RV(blockNumber >= MIN_BLOCKNR, FEE_READ_ID, FEE_E_INVALID_BLOCK_NO, E_NOT_OK);
\r
1155 blockIndex = GET_BLOCK_INDEX_FROM_BLOCK_NUMBER(blockNumber);
\r
1156 VALIDATE_RV(blockIndex < FEE_NUM_OF_BLOCKS, FEE_READ_ID, FEE_E_INVALID_BLOCK_NO, E_NOT_OK);
\r
1157 VALIDATE_RV(dataBufferPtr != NULL, FEE_READ_ID, FEE_E_INVALID_DATA_PTR, E_NOT_OK);
\r
1158 VALIDATE_RV(blockOffset < Fee_Config.BlockConfig[blockIndex].BlockSize, FEE_READ_ID, FEE_E_INVALID_BLOCK_OFS, E_NOT_OK);
\r
1159 VALIDATE_RV(blockOffset + length <= Fee_Config.BlockConfig[blockIndex].BlockSize, FEE_READ_ID, FEE_E_INVALID_BLOCK_LEN, E_NOT_OK);
\r
1161 dataset = GET_DATASET_FROM_BLOCK_NUMBER(blockNumber);
\r
1162 VALIDATE_RV(dataset < FEE_MAX_NUM_SETS, FEE_READ_ID, FEE_E_INVALID_BLOCK_NO, E_NOT_OK);
\r
1165 /** @req FEE022 */
\r
1166 ModuleStatus = MEMIF_BUSY;
\r
1167 JobResult = MEMIF_JOB_PENDING;
\r
1169 CurrentJob.BlockNumber = blockNumber;
\r
1170 CurrentJob.BlockConfigPtr = &Fee_Config.BlockConfig[blockIndex];
\r
1171 CurrentJob.AdminFlsBlockPtr = &AdminFls.BlockDescrTbl[blockIndex][dataset];
\r
1172 CurrentJob.Length = length;
\r
1173 CurrentJob.Op.Read.Offset = blockOffset;
\r
1174 CurrentJob.Op.Read.RamPtr = dataBufferPtr;
\r
1175 CurrentJob.State = FEE_READ_REQUESTED;
\r
1182 * Procedure: Fee_Write
\r
1185 Std_ReturnType Fee_Write(uint16 blockNumber, uint8* dataBufferPtr)
\r
1187 uint16 blockIndex;
\r
1190 VALIDATE_RV(ModuleStatus != MEMIF_UNINIT, FEE_WRITE_ID, FEE_E_UNINIT, E_NOT_OK);
\r
1191 VALIDATE_RV(ModuleStatus == MEMIF_IDLE, FEE_WRITE_ID, FEE_E_BUSY, E_NOT_OK);
\r
1193 VALIDATE_RV(blockNumber >= MIN_BLOCKNR, FEE_WRITE_ID, FEE_E_INVALID_BLOCK_NO, E_NOT_OK);
\r
1194 blockIndex = GET_BLOCK_INDEX_FROM_BLOCK_NUMBER(blockNumber);
\r
1195 VALIDATE_RV(blockIndex < FEE_NUM_OF_BLOCKS, FEE_WRITE_ID, FEE_E_INVALID_BLOCK_NO, E_NOT_OK);
\r
1196 VALIDATE_RV(dataBufferPtr != NULL, FEE_WRITE_ID, FEE_E_INVALID_DATA_PTR, E_NOT_OK);
\r
1198 dataset = GET_DATASET_FROM_BLOCK_NUMBER(blockNumber);
\r
1199 VALIDATE_RV(dataset < FEE_MAX_NUM_SETS, FEE_WRITE_ID, FEE_E_INVALID_BLOCK_NO, E_NOT_OK);
\r
1202 /** @req FEE025 */
\r
1203 ModuleStatus = MEMIF_BUSY;
\r
1204 JobResult = MEMIF_JOB_PENDING;
\r
1206 CurrentJob.BlockConfigPtr = &Fee_Config.BlockConfig[blockIndex];
\r
1207 CurrentJob.AdminFlsBlockPtr = &AdminFls.BlockDescrTbl[blockIndex][dataset];
\r
1208 CurrentJob.BlockNumber = blockNumber;
\r
1209 CurrentJob.Length = PAGE_ALIGN(CurrentJob.BlockConfigPtr->BlockSize);
\r
1210 CurrentJob.Op.Write.RamPtr = dataBufferPtr;
\r
1211 CurrentJob.State = FEE_WRITE_REQUESTED;
\r
1218 * Procedure: Fee_Cancel
\r
1221 void Fee_Cancel(void)
\r
1223 DET_REPORTERROR(MODULE_ID_FEE, 0, FEE_CANCEL_ID, FEE_E_NOT_IMPLEMENTED_YET);
\r
1228 * Procedure: Fee_GetStatus
\r
1231 MemIf_StatusType Fee_GetStatus(void)
\r
1233 return ModuleStatus;
\r
1238 * Procedure: Fee_GetJobResult
\r
1241 MemIf_JobResultType Fee_GetJobResult(void)
\r
1248 * Procedure: Fee_InvalidateBlock
\r
1251 Std_ReturnType Fee_InvalidateBlock(uint16 blockNumber)
\r
1253 uint16 blockIndex;
\r
1256 VALIDATE_RV(ModuleStatus != MEMIF_UNINIT, FEE_INVALIDATE_BLOCK_ID, FEE_E_UNINIT, E_NOT_OK);
\r
1257 VALIDATE_RV(ModuleStatus == MEMIF_IDLE, FEE_INVALIDATE_BLOCK_ID, FEE_E_BUSY, E_NOT_OK);
\r
1259 VALIDATE_RV(blockNumber >= MIN_BLOCKNR, FEE_INVALIDATE_BLOCK_ID, FEE_E_INVALID_BLOCK_NO, E_NOT_OK);
\r
1260 blockIndex = GET_BLOCK_INDEX_FROM_BLOCK_NUMBER(blockNumber);
\r
1261 VALIDATE_RV(blockIndex < FEE_NUM_OF_BLOCKS, FEE_INVALIDATE_BLOCK_ID, FEE_E_INVALID_BLOCK_NO, E_NOT_OK);
\r
1263 dataset = GET_DATASET_FROM_BLOCK_NUMBER(blockNumber);
\r
1264 VALIDATE_RV(dataset < FEE_MAX_NUM_SETS, FEE_INVALIDATE_BLOCK_ID, FEE_E_INVALID_BLOCK_NO, E_NOT_OK);
\r
1267 ModuleStatus = MEMIF_BUSY;
\r
1268 JobResult = MEMIF_JOB_PENDING;
\r
1270 CurrentJob.BlockConfigPtr = &Fee_Config.BlockConfig[blockIndex];
\r
1271 CurrentJob.AdminFlsBlockPtr = &AdminFls.BlockDescrTbl[blockIndex][dataset];
\r
1272 CurrentJob.BlockNumber = blockNumber;
\r
1273 CurrentJob.State = FEE_INVALIDATE_REQUESTED;
\r
1280 * Procedure: Fee_EraseImmediateBlock
\r
1283 Std_ReturnType Fee_EraseImmediateBlock(uint16 blockNumber)
\r
1285 //lint --e{715} PC-Lint (715) - function is not implemented and thus variable "blockNumber" is not used yet
\r
1287 DET_REPORTERROR(MODULE_ID_FEE, 0, FEE_ERASE_IMMEDIATE_ID, FEE_E_NOT_IMPLEMENTED_YET);
\r
1294 /***************************************
\r
1295 * Scheduled functions *
\r
1296 ***************************************/
\r
1298 * Procedure: Fee_MainFunction
\r
1301 void Fee_MainFunction(void)
\r
1303 static CurrentJobStateType LastState = FEE_UNINITIALIZED;
\r
1305 if (CurrentJob.State == LastState) {
\r
1306 if (CurrentJob.InStateCounter < STATE_COUNTER_MAX) {
\r
1307 CurrentJob.InStateCounter++;
\r
1310 LastState = CurrentJob.State;
\r
1311 CurrentJob.InStateCounter = 0;
\r
1314 switch (CurrentJob.State) {
\r
1315 case FEE_UNINITIALIZED:
\r
1319 if (CurrentJob.InStateCounter > GARBAGE_COLLECTION_DELAY) {
\r
1320 CheckIfGarbageCollectionNeeded();
\r
1327 case FEE_STARTUP_REQUESTED:
\r
1328 StartupStartJob();
\r
1331 case FEE_STARTUP_READ_BANK1_STATUS:
\r
1332 StartupReadBank1Status();
\r
1335 case FEE_STARTUP_READ_BANK2_STATUS_REQUESTED:
\r
1336 StartupReadBank2StatusRequested();
\r
1339 case FEE_STARTUP_READ_BANK2_STATUS:
\r
1340 StartupReadBank2Status();
\r
1343 case FEE_STARTUP_READ_BLOCK_ADMIN_REQUESTED:
\r
1344 StartupReadBlockAdminRequested();
\r
1347 case FEE_STARTUP_READ_BLOCK_ADMIN:
\r
1348 StartupReadBlockAdmin();
\r
1354 case FEE_READ_REQUESTED:
\r
1365 case FEE_WRITE_REQUESTED:
\r
1369 case FEE_WRITE_MARK_BANK_OLD:
\r
1370 WriteMarkBankOldState();
\r
1373 case FEE_WRITE_HEADER_REQUESTED:
\r
1374 WriteHeaderRequested();
\r
1377 case FEE_WRITE_HEADER:
\r
1378 WriteHeaderState();
\r
1381 case FEE_WRITE_DATA_REQUESTED:
\r
1382 WriteDataRequested();
\r
1385 case FEE_WRITE_DATA:
\r
1389 case FEE_WRITE_MAGIC_REQUESTED:
\r
1390 WriteMagicRequested();
\r
1393 case FEE_WRITE_MAGIC:
\r
1394 WriteMagicState();
\r
1398 * Garbage collection states
1400 case FEE_GARBAGE_COLLECT_REQUESTED:
\r
1401 GarbageCollectStartJob();
\r
1404 case FEE_GARBAGE_COLLECT_HEADER_WRITE:
\r
1405 GarbageCollectWriteHeader();
\r
1408 case FEE_GARBAGE_COLLECT_DATA_READ_REQUESTED:
\r
1409 GarbageCollectReadDataRequested();
\r
1412 case FEE_GARBAGE_COLLECT_DATA_READ:
\r
1413 GarbageCollectReadData();
\r
1416 case FEE_GARBAGE_COLLECT_DATA_WRITE_REQUESTED:
\r
1417 GarbageCollectWriteDataRequested();
\r
1420 case FEE_GARBAGE_COLLECT_DATA_WRITE:
\r
1421 GarbageCollectWriteData();
\r
1424 case FEE_GARBAGE_COLLECT_MAGIC_WRITE_REQUESTED:
\r
1425 GarbageCollectWriteMagicRequested();
\r
1428 case FEE_GARBAGE_COLLECT_MAGIC_WRITE:
\r
1429 GarbageCollectWriteMagic();
\r
1432 case FEE_GARBAGE_COLLECT_ERASE:
\r
1433 GarbageCollectErase();
\r
1439 case FEE_INVALIDATE_REQUESTED:
\r
1440 InvalidateStartJob();
\r
1443 case FEE_INVALIDATE_MARK_BANK_OLD:
\r
1444 InvalidateMarkBankOld();
\r
1447 case FEE_WRITE_INVALIDATE_HEADER_REQUESTED:
\r
1448 InvalidateWriteInvalidateHeaderRequested();
\r
1451 case FEE_WRITE_INVALIDATE_HEADER:
\r
1452 InvalidateWriteInvalidateHeader();
\r
1465 /***************************************
\r
1466 * Call-back notifications functions *
\r
1467 ***************************************/
\r
1468 #if (FEE_POLLING_MODE == STD_OFF)
\r
1470 * Procedure: Fee_JobEndNotification
\r
1473 void Fee_JobEndNotification(void)
\r
1475 FlsJobReady = TRUE;
\r
1480 * Procedure: Fee_JobErrorNotification
\r
1483 void Fee_JobErrorNotification(void)
\r
1485 FlsJobReady = TRUE;
\r