API for configuring and manipulating MRAM 4 Click driver. More...

Topics
	MRAM 4 instruction command set
	Instruction command set of MRAM 4 Click driver.

	MRAM 4 Registers Settings
	Settings for registers of MRAM 4 Click driver.

	MRAM 4 MikroBUS Map
	MikroBUS pin mapping of MRAM 4 Click driver.

Functions
void	mram4_cfg_setup (mram4_cfg_t *cfg)
	MRAM 4 configuration object setup function.

err_t	mram4_init (mram4_t ctx, mram4_cfg_t cfg)
	MRAM 4 initialization function.

err_t	mram4_default_cfg (mram4_t *ctx)
	MRAM 4 default configuration function.

err_t	mram4_generic_write (mram4_t ctx, uint8_t reg, uint8_t data_in, uint8_t len)
	MRAM 4 data writing function.

err_t	mram4_generic_read (mram4_t ctx, uint8_t reg, uint8_t data_out, uint8_t len)
	MRAM 4 data reading function.

err_t	mram4_write_cmd_addr_data (mram4_t ctx, uint8_t cmd, uint32_t addr, uint8_t data_in, uint32_t len)
	MRAM 4 write command adress data function.

err_t	mram4_read_cmd_addr_data (mram4_t ctx, uint8_t cmd, uint32_t addr, uint8_t data_out, uint32_t len)
	MRAM 4 read command adress data function.

err_t	mram4_memory_write (mram4_t ctx, uint32_t mem_addr, uint8_t data_in, uint8_t len)
	MRAM 4 memory write function.

err_t	mram4_memory_read (mram4_t ctx, uint32_t mem_addr, uint8_t data_out, uint8_t len)
	MRAM 4 memory read function.

err_t	mram4_memory_reset (mram4_t *ctx)
	MRAM 4 memory reset function.

err_t	mram4_set_command (mram4_t *ctx, uint8_t cmd)
	MRAM 4 set the command function.

err_t	mram4_write_enable (mram4_t *ctx)
	MRAM 4 write enable function.

err_t	mram4_write_disable (mram4_t *ctx)
	MRAM 4 write disable function.

err_t	mram4_block_erase (mram4_t *ctx, uint8_t cmd_block_erase, uint32_t mem_addr)
	MRAM 4 block erase function.

err_t	mram4_chip_erase (mram4_t *ctx)
	MRAM 4 chip erase function.

err_t	mram4_set_status (mram4_t *ctx, uint8_t st_reg, uint8_t status)
	MRAM 4 set status function.

err_t	mram4_get_status (mram4_t ctx, uint8_t status)
	MRAM 4 get the status function.

void	mram4_hw_write_protect (mram4_t *ctx, uint8_t en_wp)
	MRAM 4 hardware write protect function.

void	mram4_set_hold (mram4_t *ctx, uint8_t en_hld)
	MRAM 4 set hold function.

Detailed Description

API for configuring and manipulating MRAM 4 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ mram4_block_erase()

err_t mram4_block_erase	(	mram4_t *	ctx,
		uint8_t	cmd_block_erase,
		uint32_t	mem_addr )

MRAM 4 block erase function.

This function erases the desired amount of memory starting from the selected memory address of the EM064LXQADG13IS1R, Industrial STT-MRAM Persistent Memory on the MRAM 4 Click board™.

Parameters

[in]	ctx	: Click context object. See mram4_t object definition for detailed explanation.
[in]	cmd_block_erase	: Block erase command [MRAM4_CMD_ERASE_4KB, MRAM4_CMD_ERASE_32KB, MRAM4_CMD_ERASE_SECTOR].
[in]	mem_addr	: Memory address.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ mram4_cfg_setup()

void mram4_cfg_setup ( mram4_cfg_t * cfg )

MRAM 4 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See mram4_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ mram4_chip_erase()

err_t mram4_chip_erase ( mram4_t * ctx )

MRAM 4 chip erase function.

This function erases the entire memory array of the EM064LXQADG13IS1R, Industrial STT-MRAM Persistent Memory on the MRAM 4 Click board™.

Parameters

[in] ctx : Click context object. See mram4_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ mram4_default_cfg()

err_t mram4_default_cfg ( mram4_t * ctx )

MRAM 4 default configuration function.

This function executes a default configuration of MRAM 4 click board.

Parameters

[in] ctx : Click context object. See mram4_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: This function can consist any necessary configuration or setting to put device into operating mode.

◆ mram4_generic_read()

err_t mram4_generic_read	(	mram4_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out,
		uint8_t	len )

MRAM 4 data reading function.

This function reads a desired number of data bytes starting from the selected register by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See mram4_t object definition for detailed explanation.
[in]	reg	: Start register address.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ mram4_generic_write()

err_t mram4_generic_write	(	mram4_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_in,
		uint8_t	len )

MRAM 4 data writing function.

This function writes a desired number of data bytes starting from the selected register by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See mram4_t object definition for detailed explanation.
[in]	reg	: Start register address.
[in]	data_in	: Data to be written.
[in]	len	: Number of bytes to be written.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ mram4_get_status()

err_t mram4_get_status	(	mram4_t *	ctx,
		uint8_t *	status )

MRAM 4 get the status function.

This function reads status data from the desired status register of the EM064LXQADG13IS1R, Industrial STT-MRAM Persistent Memory on the MRAM 4 Click board™.

Parameters

[in]	ctx	: Click context object. See mram4_t object definition for detailed explanation.
[out]	status	: Status data.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ mram4_hw_write_protect()

void mram4_hw_write_protect	(	mram4_t *	ctx,
		uint8_t	en_wp )

MRAM 4 hardware write protect function.

This function is used for write-protection of the EM064LXQADG13IS1R, Industrial STT-MRAM Persistent Memory on the MRAM 4 Click board™.

Parameters

[in]	ctx	: Click context object. See mram4_t object definition for detailed explanation.
[in]	en_wp	Write-protection [MRAM4_WRITE_PROTECT_ENABLE, MRAM4_WRITE_PROTECT_DISABLE].

Returns: Nothing.

Note: None.

◆ mram4_init()

err_t mram4_init	(	mram4_t *	ctx,
		mram4_cfg_t *	cfg )

MRAM 4 initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters

[out]	ctx	: Click context object. See mram4_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See mram4_cfg_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ mram4_memory_read()

err_t mram4_memory_read	(	mram4_t *	ctx,
		uint32_t	mem_addr,
		uint8_t *	data_out,
		uint8_t	len )

MRAM 4 memory read function.

This function reads a desired number of data bytes starting from the selected memory address of the EM064LXQADG13IS1R, Industrial STT-MRAM Persistent Memory on the MRAM 4 Click board™.

Parameters

[in]	ctx	: Click context object. See mram4_t object definition for detailed explanation.
[in]	mem_addr	: Memory address (0x000000-0x3FFFFF).
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ mram4_memory_reset()

err_t mram4_memory_reset ( mram4_t * ctx )

MRAM 4 memory reset function.

This function performs the software reset of the memory of the EM064LXQADG13IS1R, Industrial STT-MRAM Persistent Memory on the MRAM 4 Click board™.

Parameters

[in] ctx : Click context object. See mram4_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ mram4_memory_write()

err_t mram4_memory_write	(	mram4_t *	ctx,
		uint32_t	mem_addr,
		uint8_t *	data_in,
		uint8_t	len )

MRAM 4 memory write function.

This function writes a desired number of data bytes starting from the selected memory address of the EM064LXQADG13IS1R, Industrial STT-MRAM Persistent Memory on the MRAM 4 Click board™.

Parameters

[in]	ctx	: Click context object. See mram4_t object definition for detailed explanation.
[in]	mem_addr	: Memory address (0x000000-0x3FFFFF).
[in]	data_in	: Data to be written.
[in]	len	: Number of bytes to be written.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ mram4_read_cmd_addr_data()

err_t mram4_read_cmd_addr_data	(	mram4_t *	ctx,
		uint8_t	cmd,
		uint32_t	addr,
		uint8_t *	data_out,
		uint32_t	len )

MRAM 4 read command adress data function.

This function reads a desired number of data bytes starting from a desired address of the selected command of the EM064LXQADG13IS1R, Industrial STT-MRAM Persistent Memory on the MRAM 4 Click board™.

Parameters

[in]	ctx	: Click context object. See mram4_t object definition for detailed explanation.
[in]	cmd	: Instruction command.
[in]	addr	: Memory address (0x000000-0x3FFFFF).
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ mram4_set_command()

err_t mram4_set_command	(	mram4_t *	ctx,
		uint8_t	cmd )

MRAM 4 set the command function.

This function writes the desired instruction command of the EM064LXQADG13IS1R, Industrial STT-MRAM Persistent Memory on the MRAM 4 Click board™.

Parameters

[in]	ctx	: Click context object. See mram4_t object definition for detailed explanation.
[in]	cmd	: Instruction command.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ mram4_set_hold()

void mram4_set_hold	(	mram4_t *	ctx,
		uint8_t	en_hld )

MRAM 4 set hold function.

This function is used for pausing SPI communication of the EM064LXQADG13IS1R, Industrial STT-MRAM Persistent Memory on the MRAM 4 Click board™.

Parameters

[in]	ctx	: Click context object. See mram4_t object definition for detailed explanation.
[in]	en_hld	Write-protection [MRAM4_HOLD_ENABLE, MRAM4_HOLD_DISABLE].

Returns: Nothing.

Note: None.

◆ mram4_set_status()

err_t mram4_set_status	(	mram4_t *	ctx,
		uint8_t	st_reg,
		uint8_t	status )

MRAM 4 set status function.

This function writes data byte to the desired status register of the EM064LXQADG13IS1R, Industrial STT-MRAM Persistent Memory on the MRAM 4 Click board™.

Parameters

[in]	ctx	: Click context object. See mram4_t object definition for detailed explanation.
[in]	st_reg	: Write status register command.
[in]	status	: Status data.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ mram4_write_cmd_addr_data()

err_t mram4_write_cmd_addr_data	(	mram4_t *	ctx,
		uint8_t	cmd,
		uint32_t	addr,
		uint8_t *	data_in,
		uint32_t	len )

MRAM 4 write command adress data function.

This function writes a desired number of data bytes starting from a desired address of the selected command of the EM064LXQADG13IS1R, Industrial STT-MRAM Persistent Memory on the MRAM 4 Click board™.

Parameters

[in]	ctx	: Click context object. See mram4_t object definition for detailed explanation.
[in]	cmd	: Instruction command.
[in]	addr	: Memory address (0x000000-0x3FFFFF).
[in]	data_in	: Data to be written.
[in]	len	: Number of bytes to be written.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ mram4_write_disable()

err_t mram4_write_disable ( mram4_t * ctx )

MRAM 4 write disable function.

This function enable hardware write protection of the entire memory and sets the write disable command of the EM064LXQADG13IS1R, Industrial STT-MRAM Persistent Memory on the MRAM 4 Click board™.

Parameters

[in] ctx : Click context object. See mram4_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ mram4_write_enable()

err_t mram4_write_enable ( mram4_t * ctx )

MRAM 4 write enable function.

This function disable hardware write protection of the entire memory and sets the write enable command of the EM064LXQADG13IS1R, Industrial STT-MRAM Persistent Memory on the MRAM 4 Click board™.

Parameters

[in] ctx : Click context object. See mram4_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ mram4_block_erase()

◆ mram4_cfg_setup()

◆ mram4_chip_erase()

◆ mram4_default_cfg()

◆ mram4_generic_read()

◆ mram4_generic_write()

◆ mram4_get_status()

◆ mram4_hw_write_protect()

◆ mram4_init()

◆ mram4_memory_read()

◆ mram4_memory_reset()

◆ mram4_memory_write()

◆ mram4_read_cmd_addr_data()

◆ mram4_set_command()

◆ mram4_set_hold()

◆ mram4_set_status()

◆ mram4_write_cmd_addr_data()

◆ mram4_write_disable()

◆ mram4_write_enable()