Memory Abstraction Interface (MemIf)

MemIf stuurt de geheugenopdrachten van de NVRAM Manager door naar Fee- of Ea-modules en verbergt het aantal daarvan achter een uniforme API SWS MemIf p. 7. De parameter DeviceIndex selecteert de module; als er slechts één geconfigureerd is, wordt deze genegeerd en wordt MemIf geïmplementeerd als een macroset SWS MemIf p. 17. De services nemen opdrachten synchroon aan en geven de retourwaarde door, terwijl de geheugenoperatie daaronder asynchroon verloopt. Status en resultaat worden geleverd door MemIf_GetStatus en MemIf_GetJobResult. Bij actieve detectie van ontwikkelfouten leveren foutieve aanroepen E_NOT_OK resp. MEMIF_JOB_FAILED op.

meer ›

De Memory Abstraction Interface vervangt de vroegere driver-interfacelagen voor Flash en EEPROM. Hiermee kan de NVRAM Manager via een uniforme API meerdere abstractiemodules aanspreken: de Flash EEPROM Emulation (Fee) en de EEPROM Abstraction (Ea) SRS MemHwAb p. 5. MemIf verbergt het aantal van deze modules en biedt een virtuele segmentatie op een lineaire adresruimte SWS MemIf p. 7.

Contextdiagram: MemIf bemiddelt tussen NvM en Fee/Ea; gereedmeldingen gaan direct van Fee/Ea naar de NvM. Bronnen: SWS Fee p. 6, [SWS_MemIf_00047]

MemIf heeft zelf geen geheugenlogica. De parameter DeviceIndex selecteert de module; als er slechts één geconfigureerd is, wordt deze genegeerd en wordt MemIf geïmplementeerd als macroset. Bij meerdere modules vindt de verdeling bijvoorbeeld plaats via functiewijzertabellen SWS MemIf p. 17. In R20-11 is DeviceIndex van het type uint8 [SWS_MemIf_00039]; latere versies gebruiken uint16.

De services nemen opdrachten synchroon aan en geven de retourwaarde van de module door [SWS_MemIf_00040]. De geheugenoperatie draait daarna asynchroon in de hoofdfunctie van de onderliggende laag. De NvM verneemt de voltooiing via callback vanuit Fee/Ea of door polling van MemIf_GetJobResult SWS Fee p. 48. MemIf_GetStatus meldt UNINIT, IDLE, BUSY of BUSY_INTERNAL [SWS_MemIf_00064]. Het jobresultaat heeft altijd betrekking op de laatste opdracht en onderscheidt onder andere afgebroken, inconsistente en ongeldige blokken [SWS_MemIf_00065]. MemIf_SetMode heeft effect op alle modules tegelijk [SWS_MemIf_00038].

Sequentiediagram: synchrone aanname via MemIf, asynchrone uitvoering in de driver, voltooiing via callback of polling. Bronnen: SWS Ea p. 41, [SWS_MemIf_00040]

In geval van een fout meldt MemIf ongeldige apparaatindices en NULL-pointers als ontwikkelfouten [SWS_MemIf_00006]. De services leveren dan E_NOT_OK op, MemIf_GetJobResult levert MEMIF_JOB_FAILED op SWS MemIf p. 21. Runtimefouten van het geheugen worden gedetecteerd door Fee resp. Ea; de NvM leest deze bij pollingbedrijf als MEMIF_JOB_FAILED en is verantwoordelijk voor het herstel ErrorDescription p. 58.

meer ›

Rol in de geheugenstack: wissel tussen NvM en Fee/Ea

De Memory Abstraction Interface (MemIf) vervangt de vroegere driver-interfacelagen voor Flash en EEPROM. Hiermee kan de NVRAM Manager (NvM) via één enkele API meerdere geheugenabstractiemodules aanspreken: de Flash EEPROM Emulation (Fee) en de EEPROM Abstraction (Ea) SRS MemHwAb p. 5. Naar boven toe verbergt MemIf hoeveel Fee- en Ea-modules eronder liggen. Het biedt een virtuele segmentatie op een uniforme lineaire adresruimte SWS MemIf p. 7. Fee en Ea leveren de blokgebaseerde adressering en een „virtueel onbeperkt” aantal wis-schrijfcycli. Daarom hoeft de NvM niet te worden gewijzigd als de driver of het component verandert SRS MemHwAb p. 5.

MemIf bevat zelf geen geheugenlogica. De API ervan moet worden gemapt op de API van de abstractiemodules, en het functionele gedrag wordt vastgelegd door de specificaties daarvan resp. die van de geheugendrivers SWS MemIf p. 17. Dienovereenkomstig heeft MemIf de services van de abstractiemodules nodig, voor Ea bijvoorbeeld Ea_Read, Ea_Cancel, Ea_GetStatus en Ea_GetJobResult [SWS_MemIf_00047]. Optioneel gebruikt het Det_ReportError [SWS_MemIf_00048]. De in MemIf.h gedefinieerde types MemIf_StatusType, MemIf_JobResultType en MemIf_ModeType vormen het gemeenschappelijke vocabulaire van de stack [SWS_MemIf_00064] [SWS_MemIf_00065] [SWS_MemIf_00066]. Zo levert bijvoorbeeld Fls_GetJobResult direct MemIf_JobResultType op SWS Fls p. 36.

De afbeeldingen van recentere releases tonen onder Ea en Fee aanvullend de modules MemAcc en Mem SWS Ea p. 42. Voor R20-11 is vermoedelijk het oudere overzicht doorslaggevend, waarin Fee op de Flash-driver en Ea op de EEPROM-driver rusten SWS Fee p. 6. Voor MemIf is het verschil niet van belang, omdat het alleen doorstuurt tot aan het abstractieniveau SWS MemIf p. 17. Vraag Q-3c74a6029dd0d159 (open)

Contextdiagram: MemIf ligt tussen NvM en de abstractiemodules Fee/Ea; gereedmeldingen bereiken de NvM direct vanuit Fee/Ea. Bronnen: SWS Fee p. 6, SRS MemHwAb p. 5, [SWS_MemIf_00047], [SWS_MemIf_00048]

Apparaatselectie via DeviceIndex: macro's of distributietabel

De parameter DeviceIndex selecteert de abstractiemodule en daarmee het geheugencomponent. Als er slechts één module is geconfigureerd, wordt deze genegeerd SWS MemIf p. 17. In dat geval moet MemIf worden geïmplementeerd als een set macro's, zoals #define MemIf_Write(DeviceIndex, BlockNumber, DataPtr) Fee_Write(BlockNumber, DataPtr). Bij meerdere modules moeten de aanroepen via efficiënte mechanismen worden verdeeld; als één oplossing noemt de specificatie tabellen van functiewijzers die via DeviceIndex worden geïndexeerd SWS MemIf p. 17. Vervangt een fabrikantspecifieke bibliotheek alle benodigde Fee- en Ea-modules, dan bestaat MemIf uitsluitend uit macro's SRS MemHwAb p. 5.

In R20-11 is DeviceIndex van het type uint8 [SWS_MemIf_00039] [SWS_MemIf_00041]. Latere versies van de specificatie vermelden dit als uint16 SWS MemIf p. 18. Normatief voor deze release is uint8.

Activiteitendiagram: het aantal geconfigureerde abstractiemodules bepaalt de keuze tussen macromapping en distributie via DeviceIndex. Bronnen: SWS MemIf p. 17, SRS MemHwAb p. 5

Opdrachtverloop: synchrone aanname, asynchrone uitvoering

Alle MemIf-services zijn synchroon gespecificeerd. Elk roept de gelijknamige functie van de geselecteerde module aan en retourneert de retourwaarde daarvan, zoals Read, Write en InvalidateBlock [SWS_MemIf_00039] [SWS_MemIf_00040] [SWS_MemIf_00044]. De feitelijke geheugenoperatie draait daarna asynchroon in de cyclisch aangeroepen hoofdfunctie van de onderliggende laag. De Ea-sequentie toont daartoe een lus over Eep_MainFunction in de BSW-taak SWS Ea p. 41. Volgens de Fee-specificatie geldt dit patroon ook voor de overige asynchrone services SWS Fee p. 48.

Het einde van een opdracht verneemt de NvM afhankelijk van de stackconfiguratie op een van twee manieren. Ofwel roept de abstractiemodule een callback zoals NvM_JobEndNotification resp. NvM_JobErrorNotification aan, ofwel pollt de NvM MemIf_GetJobResult SWS Fee p. 48 EXP ErrorDescription p. 45. MemIf zelf stelt geen callbackfunctie beschikbaar; de API ervan bestaat uit de volgende services [SWS_MemIf_00038] [SWS_MemIf_00046].

Service	Service-ID	Retourwaarde	Werking
MemIf_SetMode	0x01	–	roept SetMode van alle abstractiemodules aan [SWS_MemIf_00038]
MemIf_Read	0x02	Std_ReturnType	leest Length bytes van het blok vanaf BlockOffset naar DataBufferPtr [SWS_MemIf_00039]
MemIf_Write	0x03	Std_ReturnType	schrijft een blok [SWS_MemIf_00040]
MemIf_Cancel	0x04	–	breekt de lopende opdracht af [SWS_MemIf_00041]
MemIf_GetStatus	0x05	MemIf_StatusType	modulestatus [SWS_MemIf_00042]
MemIf_GetJobResult	0x06	MemIf_JobResultType	resultaat van de laatste opdracht [SWS_MemIf_00043]
MemIf_InvalidateBlock	0x07	Std_ReturnType	invalideert een blok [SWS_MemIf_00044]
MemIf_GetVersionInfo	0x08	–	versie-informatie, re-entrant [SWS_MemIf_00045]
MemIf_EraseImmediateBlock	0x09	Std_ReturnType	wist een blok [SWS_MemIf_00046]

Sequentiediagram: een schrijfopdracht wordt synchroon via MemIf aangenomen, asynchroon in de driver uitgevoerd en via callback of polling afgerond. Bronnen: SWS Ea p. 41, SWS Fee p. 48, ErrorDescription p. 60, [SWS_MemIf_00040]

Status, jobresultaat en bedrijfsmodus

MemIf_GetStatus levert de status van de geselecteerde module op [SWS_MemIf_00042]. Mogelijk zijn MEMIF_UNINIT, MEMIF_IDLE, MEMIF_BUSY en MEMIF_BUSY_INTERNAL. Bij MEMIF_BUSY_INTERNAL is de abstractiemodule bezig met intern beheer, terwijl de driver busy of idle kan zijn [SWS_MemIf_00064]. De Fee-specificatie concretiseert de voorwaarden en noemt als voorbeeld voor intern beheer de reorganisatie van het flashgeheugen (garbage collection) SWS Fee p. 30. Bij de Flash-driver mag de status al vóór de initialisatie worden opgevraagd en luidt deze dan MEMIF_UNINIT SWS Fls p. 35.

Toestandsdiagram: levenscyclus van de via MemIf_GetStatus zichtbare modulestatus. Bronnen: [SWS_MemIf_00064], SWS Fee p. 30

MemIf_GetJobResult levert het resultaat van de laatste opdracht op [SWS_MemIf_00043] [SWS_MemIf_00065]. Lezen, schrijven en wissen delen één enkel jobresultaat, zodat alleen dat van de laatste opdracht opvraagbaar is. Bij de aanname van een nieuwe opdracht wordt dit op MEMIF_JOB_PENDING gezet SWS Fls p. 36; Fee spreekt over de laatste aangenomen opdracht SWS Fee p. 31. Naast OK, FAILED en CANCELED zijn er twee blokgerelateerde resultaten. MEMIF_BLOCK_INCONSISTENT betekent dat het blok corrupt is of niet is gevonden; MEMIF_BLOCK_INVALID betekent dat het als ongeldig is gemarkeerd [SWS_MemIf_00065].

Toestandsdiagram: een aangenomen opdracht staat op PENDING en eindigt in precies een van de eindresultaten. Bronnen: [SWS_MemIf_00065], SWS Fls p. 36, SWS Fee p. 31

MemIf_SetMode heeft als enige service geen DeviceIndex en roept SetMode van alle abstractiemodules aan [SWS_MemIf_00038]. De modi zijn MEMIF_MODE_SLOW en MEMIF_MODE_FAST [SWS_MemIf_00066]. Bij de drivers staat dit voor langzame leestoegang resp. normale SPI-toegang enerzijds en snelle leestoegang resp. SPI-burst anderzijds. Eep_SetMode mag niet tijdens een lopende operatie worden aangeroepen SWS Eep p. 34. Fls_SetMode wijst bij actieve controle een verzoek in de busy-toestand af SWS Fls p. 42. Interpretatie: aangezien MemIf_SetMode alle modules bereikt, dient deze alleen te worden aangeroepen wanneer alle apparaten MEMIF_IDLE melden. Vraag Q-d6ee630fca619042 (open)

Afbreken van lopende opdrachten

MemIf_Cancel roept de Cancel-functie van de geselecteerde module aan [SWS_MemIf_00041]. Het afbreken zelf is synchroon, maar met betrekking tot de hardware asynchroon: de hardware kan nog naloop vertonen wanneer de aanroep al is teruggekeerd SWS Fee p. 45 SWS Ea p. 44. Het jobresultaat luidt daarna MEMIF_JOB_CANCELED [SWS_MemIf_00065], wat Fee uitdrukkelijk als mislukking beschouwt SWS Fee p. 31.

Voor het Flash-pad toont de driverspecificatie de keten MemIf_Cancel → Fee_Cancel → Fls_Cancel met aansluitende foutnotificaties. Ze eist bovendien Fls_Cancel niet tijdens een lopende Fls_MainFunction aan te roepen. Daarvoor zijn er twee manieren: de jobfuncties van NvM en Flash-driver worden gesynchroniseerd, of de taak van de Fls_MainFunction wordt niet onderbroken SWS Fls p. 58.

Sequentiediagram: het afbreken loopt synchroon door alle lagen, de foutnotificatie volgt, daarna meldt GetJobResult CANCELED. Bronnen: SWS Fls p. 58, SWS Fee p. 45, [SWS_MemIf_00041]

Aanroepregels, re-entrantie en inbedding in de BSW

Met uitzondering van MemIf_GetVersionInfo zijn alle services niet re-entrant [SWS_MemIf_00045] [SWS_MemIf_00040]. Parallelle aanroepen vanuit meerdere contexten moeten daarom worden uitgesloten. Omdat status en jobresultaat per module alleen de laatste opdracht weerspiegelen, dient de aanroeper een nieuwe opdracht pas na voltooiing van de vorige te verstrekken SWS Fls p. 36.

Het memory-mapping-voorbeeld van een ICC2-cluster „MEM” voert MemIf gezamenlijk met de NvM op. Daar is MemIf_SetMode gemodelleerd als BswCalledEntity, en MemIf heeft het sectievoorvoegsel MEMIF SWS MemoryMapping p. 50. De BSW Distribution Guide noemt MEMIF naast FLS en FEE als voorbeeld van „Type I”; het geldigheidsgebied kan via SwAddrMethod met lokale scope tot één core worden beperkt EXP BSWDistributionGuide p. 31. Vermoedelijk dient MemIf in multicore-systemen daarmee core-lokaal te worden gebruikt. Vraag Q-d998fdc58e0bcddd (open)

Gedrag in het foutgeval

MemIf kent twee ontwikkelfouten. MEMIF_E_PARAM_DEVICE (0x01) staat voor een onjuiste DeviceIndex, MEMIF_E_PARAM_POINTER (0x02) voor een NULL-pointer [SWS_MemIf_00006]. Ze worden gemeld via het optionele Det_ReportError [SWS_MemIf_00048]. Specifieke foutcodes worden volgens de tracing-tabel niet via de API geretourneerd SWS MemIf p. 12.

Als de detectie van ontwikkelfouten actief is en een fout wordt gedetecteerd, leveren Read, Write, InvalidateBlock en EraseImmediateBlock E_NOT_OK op [SWS_MemIf_00039] [SWS_MemIf_00040] [SWS_MemIf_00044] [SWS_MemIf_00046]. MemIf_GetJobResult levert in dit geval MEMIF_JOB_FAILED op SWS MemIf p. 21. Anders wordt de waarde van de module ongewijzigd doorgegeven.

Activiteitendiagram: parametercontrole bij actieve detectie van ontwikkelfouten en het doorgeven van het moduleresultaat. Bronnen: [SWS_MemIf_00006], [SWS_MemIf_00048], SWS MemIf p. 18, SWS MemIf p. 21

Runtimefouten van het geheugen worden niet gedetecteerd door MemIf, maar door Fee resp. Ea; MemIf zelf reageert hier niet op („N/A”). Bij pollingbedrijf leest de NvM de fout via MemIf_GetJobResult als MEMIF_JOB_FAILED, en het herstel ligt bij de NvM ErrorDescription p. 58 ErrorDescription p. 60. Een recentere versie beschrijft dit herstel nader. Volgens deze versie verhoogt de NvM bij schrijfopdrachten een herhaalteller, breekt na overschrijding af en meldt NVM_E_REQ_FAILED aan de DEM EXP ErrorDescription p. 45. Voor R20-11 is dit detail hier niet normatief onderbouwd.

Verdere gedetailleerde bewijzen

• API-definities met service-ID's, re-entrantie en retourwaarden: [SWS_MemIf_00038] tot [SWS_MemIf_00046].
• Datatypes voor status, jobresultaat en modus: [SWS_MemIf_00064], [SWS_MemIf_00065], [SWS_MemIf_00066]; geïmporteerde types: [SWS_MemIf_00037].
• Mappingregels (macro's, DeviceIndex, distributie): SWS MemIf p. 17.
• Vereiste en optionele interfaces: [SWS_MemIf_00047], [SWS_MemIf_00048]; foutcodes: [SWS_MemIf_00006].
• Verlopen voor schrijven en afbreken: SWS Fee p. 48, SWS Fls p. 58.
• Foutketen tot aan de NvM in R20-11: ErrorDescription p. 58.