1.1.3.4 Library Interface
Memory driver library provides the following interfaces:
Functions
| Name | Description |
|---|---|
| DRV_MEMORY_Initialize | Initializes the Memory instance for the specified driver index |
| DRV_MEMORY_Status | Gets the current status of the Memory driver module |
| DRV_MEMORY_Tasks | Maintains the Memory driver's internal state machine |
| DRV_MEMORY_Open | Opens the specified Memory driver instance and returns a handle to it |
| DRV_MEMORY_Close | Closes an opened-instance of the Memory driver |
| DRV_MEMORY_AsyncErase | Erase the specified number of memory blocks in Asynchronous mode |
| DRV_MEMORY_SyncErase | Erase the specified number of memory blocks in Synchronous mode |
| DRV_MEMORY_AsyncEraseWrite | Erase and Write data for the specified number of memory blocks in Asynchronous mode |
| DRV_MEMORY_SyncEraseWrite | Erase and Write data for the specified number of memory blocks in Synchronous mode |
| DRV_MEMORY_AsyncWrite | Writes data for the specified number of memory blocks in Asynchronous mode |
| DRV_MEMORY_SyncWrite | Writes data for the specified number of memory blocks in Synchronous mode |
| DRV_MEMORY_AsyncRead | Reads data for the specified number of memory blocks in Asynchronous mode |
| DRV_MEMORY_SyncRead | Reads data for the specified number of memory blocks in Synchronous mode |
| DRV_MEMORY_GeometryGet | Returns the geometry of the memory device |
| DRV_MEMORY_TransferStatusGet | Gets the current status of the transfer request on attached device |
| DRV_MEMORY_CommandStatusGet | Gets the current status of the command |
| DRV_MEMORY_TransferHandlerSet | Sets the pointer to the function (and it's context) to be called when queued operation has completed |
| DRV_MEMORY_IsAttached | Returns the physical attach status of the Media |
| DRV_MEMORY_IsWriteProtected | Returns the write protect status of the Memory |
| DRV_MEMORY_AddressGet | Returns the Memory media start address |
| DRV_MEMORY_Erase | Interface to the file system to perform a erase operation in Synchronous mode |
| DRV_MEMORY_EraseWrite | Interface to the file system to perform a erase-write operation in Synchronous mode |
| DRV_MEMORY_Write | Interface to the file system to perform a write operation in Synchronous mode |
| DRV_MEMORY_Read | Interface to the file system to perform a read operation in Synchronous mode |
Data types and constants
| Name | Type | Description |
|---|---|---|
| DRV_MEMORY_COMMAND_HANDLE | Typedef | Handle to identify commands queued in the driver |
| DRV_MEMORY_COMMAND_HANDLE_INVALID | Macro | This value defines the Memory Driver's Invalid Command Handle |
| DRV_MEMORY_EVENT | Enum | Identifies the possible events that can result from a request |
| DRV_MEMORY_COMMAND_STATUS | Enum | Memory Driver command Status |
| DRV_MEMORY_TRANSFER_HANDLER | Typedef | Pointer to a Memory Driver Event handler function |
| MEMORY_DEVICE_TRANSFER_STATUS | Enum | Memory Device Transfer Status |
| MEMORY_DEVICE_GEOMETRY | Struct | Memory Device Geometry Table |
| DRV_MEMORY_DEVICE_INTERFACE | Struct | Memory Device API Interface |
| DRV_MEMORY_INIT | Struct | Memory Driver Initialization Data |