dram.h File Reference

This file contains API for DRAM Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"

Go to the source code of this file.

Data Structures
struct	dram_t
	DRAM Click context object. More...
struct	dram_cfg_t
	DRAM Click configuration object. More...

Macros
#define	DRAM_CMD_READ   0x03
	DRAM commands list.
#define	DRAM_CMD_FAST_READ   0x0B
#define	DRAM_CMD_WRITE   0x02
#define	DRAM_CMD_RESET_ENABLE   0x66
#define	DRAM_CMD_RESET   0x99
#define	DRAM_CMD_WRAP_BOUNDARY_TOGGLE   0xC0
#define	DRAM_CMD_READ_ID   0x9F
#define	DRAM_MIN_ADDRESS   0x000000
	DRAM memory address range.
#define	DRAM_MAX_ADDRESS   0x7FFFFFul
#define	DRAM_MANUFACTURER_ID   0x0D
	DRAM manufacturer ID.
#define	DRAM_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
	Data sample selection.
#define	DRAM_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
#define	DRAM_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	dram_return_value_t { DRAM_OK = 0 , DRAM_ERROR = -1 }
	DRAM Click return value data. More...

Functions
void	dram_cfg_setup (dram_cfg_t *cfg)
	DRAM configuration object setup function.
err_t	dram_init (dram_t *ctx, dram_cfg_t *cfg)
	DRAM initialization function.
err_t	dram_memory_write (dram_t *ctx, uint32_t address, uint8_t *data_in, uint32_t len)
	DRAM memory write function.
err_t	dram_memory_read (dram_t *ctx, uint32_t address, uint8_t *data_out, uint32_t len)
	DRAM memory read function.
err_t	dram_memory_read_fast (dram_t *ctx, uint32_t address, uint8_t *data_out, uint32_t len)
	DRAM memory read fast function.
err_t	dram_reset (dram_t *ctx)
	DRAM reset function.
err_t	dram_toggle_wrap_boundary (dram_t *ctx)
	DRAM toggle wrap boundary function.
err_t	dram_read_id (dram_t *ctx, uint8_t *device_id)
	DRAM read id function.
err_t	dram_check_communication (dram_t *ctx)
	DRAM check communication function.
void	dram_set_io3_pin (dram_t *ctx, uint8_t state)
	DRAM set io3 pin function.
void	dram_set_io2_pin (dram_t *ctx, uint8_t state)
	DRAM set io2 pin function.

Detailed Description

This file contains API for DRAM Click Driver.

Enumeration Type Documentation

dram_return_value_t

enum dram_return_value_t

DRAM Click return value data.

Predefined enum values for driver return values.

Enumerator
DRAM_OK
DRAM_ERROR