ram.h File Reference

Go to the source code of this file.

Data Structures
struct	Ram_Attrs
struct	Ram_Fxns
	Driver implementation callbacks. More...
struct	Ram_Config
	Ram driver configuration, these are filled by SysCfg based on the ram device that is selected. More...
struct	Ram_Params
	Parameters passed during RAM_open() More...

Typedefs
typedef void *	Ram_Handle
	Handle to the RAM driver returned by Ram_open() More...
typedef struct Ram_Config_s	Ram_Config
	Forward declaration of Ram_Config. More...
typedef struct Ram_Params_s	Ram_Params
	Forward declaration of Ram_Params. More...
RAM driver implementation callbacks
typedef int32_t(*	Ram_OpenFxn) (Ram_Config *config)
	Driver implementation to open a specific RAM driver. More...
typedef void(*	Ram_CloseFxn) (Ram_Config *config)
	Driver implementation to close a specific RAM driver. More...
typedef int32_t(*	Ram_ReadFxn) (Ram_Config *config, uint32_t offset, uint8_t *buf, uint32_t len)
	Driver implementation to read from RAM using a specific RAM driver. More...
typedef int32_t(*	Ram_WriteFxn) (Ram_Config *config, uint32_t offset, uint8_t *buf, uint32_t len)
	Driver implementation to write to RAM using specific RAM driver. More...
typedef int32_t(*	Ram_quirksFxn) (Ram_Config *config)
	Ram device config. This will be part of the ram config, so has to be filled by sysconfig or otherwise before invoking Ram_open. More...
typedef int32_t(*	Ram_custProtocolFxn) (Ram_Config *config)
	User implementation of a custom function to configure RAM to operate in a specific protocol. More...

Functions
Ram_Attrs *	Ram_getAttrs (uint32_t instanceId)
Ram_Handle	Ram_open (uint32_t instanceId, Ram_Params *params)
	Open RAM driver. More...
void	Ram_close (Ram_Handle handle)
	Close RAM driver. More...
int32_t	Ram_write (Ram_Handle handle, uint32_t offset, uint8_t *buf, uint32_t len)
	Write to RAM device. More...
int32_t	Ram_read (Ram_Handle handle, uint32_t offset, uint8_t *buf, uint32_t len)
	Read data from RAM device. More...