Memory Driver (Mem)

Initialization function - initializes all variables and sets the module state to initialized.

Service to return the version information of the Mem module.

Service to handle the requested jobs and the internal management operations.

Service to return results of the most recent job.

Triggers a read job to copy the from the source address into the referenced destination data buffer. The result of this service can be retrieved using the Mem_GetJobResult API. If the read operation was successful, the result of the job is MEM_JOB_OK. If the read operation failed, the result of the job is either MEM_JOB_FAILED in case of a general error or MEM_ECC_ CORRECTED/MEM_ECC_UNCORRECTED in case of a correctable/uncorrectable ECC error.

Triggers a write job to store the passed data to the provided address area with given address and length. The result of this service can be retrieved using the Mem_GetJobResult API. If the write operation was successful, the job result is MEM_JOB_OK. If there was an issue writing the data, the result is MEM_FAILED.

Triggers an erase job of the given sector/sector batch defined by targetAddress and length. The result of this service can be retrieved using the Mem_GetJobResult API. If the erase operation was successful, the result of the job is MEM_JOB_OK. If the erase operation failed, e.g. due to a hardware issue, the result of the job is MEM_JOB_FAILED.

This service can be used to report an access error in case the Mem driver cannot provide the access error information - typically for ECC faults. It is called by the system ECC handler to propagate an ECC error to the memory upper layers..

Triggers a job to check the erased state of the page which is referenced by targetAddress. The result of this service can be retrieved using the Mem_GetJobResult API. If the checked page is blank, the result of the job is MEM_JOB_OK. Otherwise, if the page is not blank, the result is MEM_INCONSISTENT.

Triggers a hardware specific memory driver job. dataPtr can be used to pass and return data to/ from this service. This service is just a dispatcher to the hardware specific service implementation referenced by hwServiceId. The result of this service can be retrieved using the Mem_GetJobResult API. If the hardware specific operation was successful, the result of the job is MEM_JOB_OK. If the hardware specific operation failed, the result of the job is MEM_JOB_ FAILED. Tags: atp.Status=draft

De-initialize module. If there is still an access job pending, it is immediately terminated (using hardware cancel operation) and the Mem driver module state is set to unitialized. Therefore, Mem must be re-initialized before it will accept any new job requests after this service is processed.

Suspend active memory operation using hardware mechanism. Tags: atp.Status=draft

Resume suspended memory operation using hardware mechanism. Tags: atp.Status=draft

Postbuild configuration structure type

Physical memory device address type

Read data user buffer type

Job end notification function called by Mem in case the job processing is configured for job end notification.

Physical memory device length type

Asynchronous job result type

Hardware specific service request identifier type

The service Mem_Init shall initialize the Mem driver internal states and set the Mem driver job processing state to MEM_JOB_OK .

If development error detection is enabled by MemDevEr- rorDetect , the service Mem_GetVersionInfo shall raise the development er- ror MEM_E_PARAM_POINTER if the versionInfoPtr argument is a NULL pointer.

If development error detection is enabled by MemDevErrorDe- tect , the service Mem_Read shall check that the Mem driver has been initialized. If this check fails, Mem_Read shall raise the development error MEM_E_UNINIT .

If development error detection is enabled by MemDevErrorDe- tect , the service Mem_Read shall check that the provided instanceId is consistent with the configuration. If this check fails, Mem_Read shall raise the development error MEM_E_PARAM_INSTANCE_ID .

If development error detection is enabled by MemDe- vErrorDetect , the service Mem_Read shall raise the development error MEM_E_PARAM_POINTER if the destinationDataPtr argument is a NULL pointer.

If development error detection is enabled by MemDe- vErrorDetect , the service Mem_Read shall raise the development error MEM_E_PARAM_ADDRESS if the address defined by sourceAddress is invalid.

If development error detection is enabled by MemDevErrorDe- tect , the service Mem_Read shall raise the development error MEM_E_JOB_PENDING if a previous Mem job is still being processed.

If development error detection is enabled by MemDevErrorDe- tect , the service Mem_Write shall check that the Mem driver has been initialized. If this check fails, Mem_Write shall raise the development error MEM_E_UNINIT .

If development error detection is enabled by MemDevEr- rorDetect , the service Mem_Write shall check that the provided instanceId is consistent with the configuration. If this check fails, Mem_Write shall raise the development error MEM_E_PARAM_INSTANCE_ID .

If development error detection is enabled by MemDev- ErrorDetect , the service Mem_Write shall raise the development error MEM_E_PARAM_POINTER if the sourceDataPtr argument is a NULL pointer.

If development error detection is enabled by MemDev- ErrorDetect , the service Mem_Write shall raise the development error MEM_E_PARAM_ADDRESS if the address defined by targetAddress is invalid.

If development error detection is enabled by MemDev- ErrorDetect , the service Mem_Write shall raise the development error MEM_E_PARAM_LENGTH if the write length defined by length is invalid.

If development error detection is enabled by MemDe- vErrorDetect , the service Mem_Write shall raise the development error MEM_E_JOB_PENDING if a previous Mem job is still being processed.

If development error detection is enabled by MemDevErrorDe- tect , the service Mem_Erase shall check that the Mem driver has been initialized. If this check fails, Mem_Erase shall raise the development error MEM_E_UNINIT .

If development error detection is enabled by MemDevEr- rorDetect , the service Mem_Erase shall check that the provided instanceId is consistent with the configuration. If this check fails, Mem_Erase shall raise the development error MEM_E_PARAM_INSTANCE_ID .

If development error detection is enabled by MemDev- ErrorDetect , the service Mem_Erase shall raise the development error MEM_E_PARAM_ADDRESS if the address defined by targetAddress is invalid.

If development error detection is enabled by MemDev- ErrorDetect , the service Mem_Erase shall raise the development error MEM_E_PARAM_LENGTH if the read length defined by length is invalid.

If development error detection is enabled by MemDe- vErrorDetect , the service Mem_Erase shall raise the development error MEM_E_JOB_PENDING if a previous Mem job is still being processed.

If development error detection is enabled by MemDevErrorDe- tect , the service Mem_PropagateError shall check that the Mem driver has been initialized. If this check fails, Mem_PropagateError shall raise the development error MEM_E_UNINIT .

If development error detection is enabled by MemDevErrorDe- tect , the service Mem_PropagateError shall check that the provided instanceId is consistent with the configuration. If this check fails, Mem_PropagateError shall raise the development error MEM_E_PARAM_INSTANCE_ID .

If development error detection is enabled by MemDevErrorDe- tect , the service Mem_BlankCheck shall check that the Mem driver has been initialized. If this check fails, Mem_BlankCheck shall raise the development error MEM_E_UNINIT .

If development error detection is enabled by MemDevErrorDe- tect , the service Mem_BlankCheck shall check that the provided instanceId is consistent with the configuration. If this check fails, Mem_BlankCheck shall raise the development error MEM_E_PARAM_INSTANCE_ID .

If development error detection is enabled by MemDevEr- rorDetect , the service Mem_BlankCheck shall raise the development error MEM_E_PARAM_ADDRESS if the address defined by targetAddress is invalid.

If development error detection is enabled by MemDevEr- rorDetect , the service Mem_BlankCheck shall raise the development error MEM_E_PARAM_LENGTH if the read length defined by length is invalid.

If development error detection is enabled by MemDevEr- rorDetect , the service Mem_BlankCheck shall raise the development error MEM_E_JOB_PENDING if a previous Mem job is still being processed.

If development error detection is enabled by MemDevErrorDe- tect , the service Mem_HwSpecificService shall check that the provided instan- ceId is consistent with the configuration. If this check fails, Mem_HwSpecificSer- vice shall raise the development error MEM_E_PARAM_INSTANCE_ID .

If development error detection is enabled by MemDevEr- rorDetect , the service Mem_HwSpecificService shall raise the development error MEM_E_PARAM_POINTER if the dataPtr or lengthPtr argument is a NULL pointer.

The Mem driver shall keep track of the job processing and the result of the last processed job.

Once a job request is accepted, the job processing status shall be set to MEM_JOB_PENDING .

In case a pending job was not able to complete, the job processing status shall be set to MEM_JOB_FAILED .

The Mem driver shall check static configuration parameters statically (at the latest during compile time) for correctness.

The Mem driver shall not perform any sort of address or length alignment in case physical segmentation needs to be considered, e.g. for flash mem- ory.

The Mem driver shall inherit the size of Mem_AddressType from MemAcc_AddressType to support memories larger than 4GBytes.

If the maximum physical memory size of a device does not ex- ceed 4GBytes, the Mem driver shall perform an explicit cast and work internally with a 32-Bit address type.

The Mem driver shall provide two ways for the service function invocation: • Direct service invocation • Indirect service invocation by a function pointer table

If built as a separate image, the Mem driver shall be completely self contained, i.e. it must not call any library or any other external functions.

Since Mem drivers are always hardware/CPU specific, the byte order of data fields and address information within the Mem driver binary shall follow the standard CPU byte order.

The header part of the Mem driver binary shall follow the struc- ture defined in table 7.1. The size of the address information depends on the configured MemAcc_AddressType (4 or 8 bytes).

The unique identifier is used for unique identification of Mem drivers. The format of the unique identifier shall follow the structure defined in table 7.2.

The ABI version of a Mem driver following this specification shall be 0001.

The header address is used for development error checks to verify the consistency of the linked Mem driver binary image with the location of the RAM buffer which is used for execution of the Mem driver. In case of a relocatable/position independent Mem driver binary, the header address shall be set to zero, otherwise, the header address shall hold the physical start address of the Mem driver binary.

The flag part of the Mem driver header is a bit-field which holds additional information for develop error checks. The format of the flag bit-field shall follow the structure defined in table 7.3.

The delimiter address part of the Mem driver header is used for development error checks to verify that the Mem driver binary is complete by checking the delimiter pattern linked to the end of the Mem driver binary. In case of a relocatable/position independent Mem driver binary, the delimiter address shall be set to zero, otherwise, the delimiter address shall hold the physical address of the delimiter pattern.

The size of the Mem driver function pointers shall be ma- chine/CPU specific.

The value of the delimiter field shall be the ones' complement of the unique identifier value.

Development Error Types The development error types defined for Mem are listed in table Table 7.5.

All hardware specific routines shall be accessed by the Mem_HwSpecificService() service.

A Mem driver instance shall allow only one job request at a time.

If the Mem driver is not able to process a job request, e.g. due to a pending request or due to an invalid parameter, the job request shall be rejected by an E_NOT_OK return code.

The Mem driver implementation shall support multiple instances of the same memory device.

If the Mem_PropagateError service is called, the Mem driver shall set the job result code to MEM_ECC_UNCORRECTED and cancel the current job processing.

⌊ DRAFT g If the memory hardware provides ECC information, the Mem driver shall check for correctable ECC errors and set the job result code to MEM_ECC_CORRECTED and proceed with the current job processing.

If the memory hardware provides ECC information, the Mem driver shall check for uncorrectable ECC errors and set the job result code to MEM_ECC_UNCORRECTED and abort the current job processing.

{DRAFT} The Mem driver does not use transient faults. In case the memory device supports extended error checks, the Mem driver shall indicate them to the upper layer using the normal fault handling.

All job requests triggered by asynchronous Mem driver services shall be executed within the Mem_MainFunction .

After a job was successfully processed, the job processing status shall be set to MEM_JOB_OK .

If development error detection is enabled by MemDevErrorDe- tect , the service Mem_HwSpecificService shall check that the Mem driver has been initialized. If this check fails, Mem_HwSpecificService shall raise the development error MEM_E_UNINIT .

In case a service is not relevant for a specific memory device technology, the service shall always return E_MEM_SERVICE_NOT_AVAIL .

If development error detection is enabled by MemDe- vErrorDetect , the service Mem_Read shall raise the development error MEM_E_PARAM_LENGTH if the read length defined by length is invalid.

The function pointer table is a standardized structure used to reference the Mem driver service functions. The format of function pointer table shall follow the structure defined in table 7.4.

The Mem driver API names, type definitions and file naming scheme shall follow the standard AUTOSAR BSW Module implementation prefix with vendorId and vendorApiInfix .

In case the job processing was completed but the results of the last Mem job didn't meet the expected result, e.g. a blank check operation was applied on a non-blank memory area, the job result shall be set to MEM_INCONSISTENT .

If the memory hardware supplies ECC information, the Mem driver shall check for correctable ECC errors and, in the case of correctable ECC errors, continue with the job processing. After completion of the job, the job result shall be set to MEM_ECC_CORRECTED .

In case the last memory operation didn't complete due to an un- correctable ECC error, the job result shall be set to MEM_ECC_UNCORRECTED .

The service Mem_DeInit shall cancel any ongoing flash oper- ations in the hardware and de-initialize the Mem driver internal states.

The service Mem_Suspend shall suspend any ongoing flash operations using an according hardware mechanism.

The service Mem_Resume shall resume a flash operations that was suspended by the service Mem_Suspend .

In case a memory device provides a hardware-based sus- pend/resume mechanism, the Mem driver shall utilize the hardware capabilities to implement the Mem_Suspend and Mem_Resume services. If no hardware suspend/re- sume support is available, the Mem_Suspend and Mem_Resume services shall return E_MEM_SERVICE_NOT_AVAIL .

In case a suspend operation is already in pending, Mem_- Suspend shall reject the request by returning E_NOT_OK without further actions.

In case no suspend operation is pending, Mem_Resume shall reject the request by returning E_NOT_OK without further actions.

If development error detection is enabled by MemDevErrorDe- tect , the service Mem_Suspend shall check that the Mem driver has been initialized. If this check fails, Mem_Suspend shall raise the development error MEM_E_UNINIT .

If development error detection is enabled by MemDevErrorDe- tect , the service Mem_Resume shall check that the Mem driver has been initialized. If this check fails, Mem_Resume shall raise the development error MEM_E_UNINIT .

If development error detection is enabled by MemDe- vErrorDetect , the service Mem_Init shall raise the development error MEM_E_PARAM_POINTER if the configPtr argument is not a NULL pointer.

The Mem driver shall not verify the result of a write or erase operation.

If development error detection is enabled by MemDevErrorDe- tect , the service Mem_GetJobResult shall check that the provided instanceId is consistent with the configuration. If this check fails, Mem_GetJobResult shall raise the development error MEM_E_PARAM_INSTANCE_ID .

If development error detection is enabled by MemDevErrorDe- tect , the service Mem_Suspend shall check that the provided instanceId is con- sistent with the configuration. If this check fails, Mem_Suspend shall raise the develop- ment error MEM_E_PARAM_INSTANCE_ID .

If development error detection is enabled by MemDevErrorDe- tect , the service Mem_Resume shall check that the provided instanceId is consis- tent with the configuration. If this check fails, Mem_Resume shall raise the development error MEM_E_PARAM_INSTANCE_ID .

Module Header File Imported Type MemAcc MemAcc_GeneralTypes.h MemAcc_AddressType Std_Types.h Std_ReturnType Std Std_Types.h Std_VersionInfoType

Det_ReportError Det.h Service to report development errors.

There are no mandatory interfaces.