Mem — Requirements

Normative

Defines what a conformant memory driver MUST do. Requirements are clustered by severity — expand a cluster below. Keywords per Requirement Keywords; conformance per Conformance. Requirements do not carry individual status — the set-level status applies to all of them. Signatures, error codes, and configuration properties are in the API Reference, Errors, and Configuration Reference pages. Cross-module rules (types, error model, naming, memory mapping) are in General.

Mandatory (MUST) - 27 Requirements

The conformance contract — an implementation MUST satisfy every requirement here.

Lifecycle and jobs

CHI-MEM-MUST-01 — Initialization and de-initialization

Mem_Init MUST initialize the driver (configPtr MUST be NULL_PTR) and leave each instance’s job result at MEM_JOB_FINISHED; Mem_DeInit MUST cancel any pending job and de-initialize the driver.

CHI-MEM-MUST-02 — Single-job model

The driver MUST process at most one job at a time per instance and MUST NOT implement a job queue.

CHI-MEM-MUST-03 — Job request acceptance

A service request that cannot be accepted (for example while a job is pending) MUST be rejected with E_NOT_OK and MUST NOT disturb the running job.

CHI-MEM-MUST-04 — Asynchronous execution

Accepted jobs MUST be executed asynchronously, advanced by Mem_PollFunction, which the driver MUST provide.

CHI-MEM-MUST-05 — Job status and result

The driver MUST track each instance’s job status and expose the most recent result via Mem_GetJobResult (overwritten by each new job).

CHI-MEM-MUST-06 — Job status transitions

On acceptance the result MUST become MEM_JOB_PENDING; on success MEM_JOB_FINISHED; on failure MEM_JOB_FAILED; and a blank check of a non-blank area MUST yield MEM_JOB_PAGE_INCONSISTENT.

Memory services

CHI-MEM-MUST-07 — Read

Mem_Read MUST start an asynchronous read into the caller’s buffer, and MUST detect the development errors in Errors.

CHI-MEM-MUST-08 — Write

Mem_Write MUST start an asynchronous write (write-page aligned), and MUST detect the development errors in Errors.

CHI-MEM-MUST-09 — Erase

Mem_Erase MUST start an asynchronous erase (sector aligned), and MUST detect the development errors in Errors.

CHI-MEM-MUST-10 — Blank check

Mem_VerifyBlank MUST start an asynchronous blank check, yielding MEM_JOB_PAGE_INCONSISTENT when the area is not blank, and MUST detect its development errors.

CHI-MEM-MUST-11 — Suspend and resume

Mem_SuspendJob and Mem_ResumeJob MUST suspend and resume the active job using the hardware. Where the device does not support it they MUST return E_MEM_SERVICE_NOT_AVAIL. Suspending with nothing suspendable, or resuming with nothing suspended, MUST be rejected.

CHI-MEM-MUST-12 — Hardware-specific service

Mem_HwSpecificService MUST dispatch the device-specific routine identified by hwServiceId, returning E_MEM_SERVICE_NOT_AVAIL for an unsupported id.

CHI-MEM-MUST-13 — ECC error notification

Mem_OnError MUST, when called by the ECC handler, cancel the current job and set MEM_JOB_ERROR_ECC_UNCORRECTED.

CHI-MEM-MUST-14 — Optional service availability

A service a given instance does not implement MUST return E_MEM_SERVICE_NOT_AVAIL rather than fail silently.

Operation constraints

CHI-MEM-MUST-15 — No result verification

The driver MUST NOT read back to verify the result of a write or erase.

CHI-MEM-MUST-16 — No alignment or buffering

The driver MUST NOT perform address/length alignment or buffer sub-page writes; the caller MUST provide aligned parameters, and misalignment MUST be a development error.

CHI-MEM-MUST-17 — Address range

The driver MUST support the device’s address space within a 32-bit address and length.

CHI-MEM-MUST-18 — Configuration validation

The configuration MUST be validated at or before build time; the driver need not check it at runtime.

Multiple instances and invocation

CHI-MEM-MUST-19 — Multiple memory instances

The driver MUST support multiple memory instances of the same device, addressed by Mem_InstanceIdType.

CHI-MEM-MUST-20 — Direct and indirect invocation

Services MUST be invocable directly, and — for a binary image — indirectly through the service function-pointer table.

CHI-MEM-MUST-21 — Self-contained binary image

When built as a separate relocatable image the driver MUST be self-contained: it MUST NOT call external libraries and MUST NOT perform development-error reporting.

Binary image format

CHI-MEM-MUST-22 — Binary byte order

The binary image MUST use the CPU byte order.

CHI-MEM-MUST-23 — Header structure

The image MUST begin with a header carrying a unique id, flags, the header address, and the delimiter address, followed by the service function-pointer table.

CHI-MEM-MUST-24 — ABI version

The header’s ABI version MUST be 0001.

CHI-MEM-MUST-25 — Header and delimiter addresses

For a relocatable image the header address and delimiter address MUST be consistent with the image’s own layout as specified in Concepts.

CHI-MEM-MUST-26 — Delimiter value

The delimiter value MUST be the ones’ complement of the unique id.

Configuration

CHI-MEM-MUST-27 — Configuration model

The driver MUST support the configuration model in Configuration Reference — a General section and a ConfigSet of MemInstance entries — following the common model in General (CHI-GEN-MUST-12).