API for configuring and manipulating EEPROM 12 Click driver. More...

Topics
	EEPROM 12 Registers List
	List of registers of EEPROM 12 Click driver.

	EEPROM 12 Registers Settings
	Settings for registers of EEPROM 12 Click driver.

	EEPROM 12 MikroBUS Map
	MikroBUS pin mapping of EEPROM 12 Click driver.

Functions
void	eeprom12_cfg_setup (eeprom12_cfg_t *cfg)
	EEPROM 12 configuration object setup function.

err_t	eeprom12_init (eeprom12_t ctx, eeprom12_cfg_t cfg)
	EEPROM 12 initialization function.

void	eeprom12_write_enable (eeprom12_t *ctx)
	EEPROM 12 write enable function.

void	eeprom12_write_disable (eeprom12_t *ctx)
	EEPROM 12 write disable function.

err_t	eeprom12_generic_write (eeprom12_t ctx, uint16_t reg, uint8_t data_in, uint8_t len)
	EEPROM 12 I2C writing function.

err_t	eeprom12_generic_read (eeprom12_t ctx, uint16_t reg, uint8_t data_out, uint8_t len)
	EEPROM 12 I2C reading function.

err_t	eeprom12_memory_write (eeprom12_t ctx, uint16_t mem_addr, uint8_t data_in, uint8_t len)
	EEPROM 12 memory write function.

err_t	eeprom12_memory_read (eeprom12_t ctx, uint16_t mem_addr, uint8_t data_out, uint8_t len)
	EEPROM 12 memory read function.

err_t	eeprom12_memory_page_write (eeprom12_t ctx, uint16_t page_addr, uint8_t data_in, uint8_t len)
	EEPROM 12 memory page write function.

err_t	eeprom12_memory_page_read (eeprom12_t ctx, uint16_t page_addr, uint8_t data_out, uint8_t len)
	EEPROM 12 memory page read function.

err_t	eeprom12_id_page_write (eeprom12_t ctx, uint16_t id_page_addr, uint8_t data_in)
	EEPROM 12 identification page write function.

err_t	eeprom12_id_page_read (eeprom12_t ctx, uint16_t id_page_addr, uint8_t data_out)
	EEPROM 12 identification page read function.

err_t	eeprom12_config_dev_addr (eeprom12_t *ctx, uint8_t cda, uint8_t dal)
	EEPROM 12 configuate device address function.

err_t	eeprom12_read_lock_status (eeprom12_t ctx, uint8_t lock_status)
	EEPROM 12 read lock status function.

Detailed Description

API for configuring and manipulating EEPROM 12 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

◆ eeprom12_cfg_setup()

void eeprom12_cfg_setup ( eeprom12_cfg_t * cfg )

EEPROM 12 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ eeprom12_config_dev_addr()

err_t eeprom12_config_dev_addr	(	eeprom12_t *	ctx,
		uint8_t	cda,
		uint8_t	dal )

EEPROM 12 configuate device address function.

This function writes a configurable device address register of the M24256E-FMN6TP, 256-Kbit serial I²C bus EEPROM with configurable device address and preprogrammed device address on the EEPROM 12 Click board™.

Parameters

[in]	ctx	: Click context object. See eeprom12_t object definition for detailed explanation.
[in]	cda	: Configurable device address bits (0x00-0x07).
[in]	dal	: Device address lock bit: `0x00` - Configurable device address can be modified, `0x01` - Configurable device address cannot be modified.

Returns

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

Note: Updating the DAL bit from 0 to 1 is an irreversible action: the C2,C1,C0 and DAL bits cannot be updated any more. If the write control input (WC) is driven high or if the DAL bit is set to 1, the write configurable device address command is not executed and the accompanying data byte is not acknowledged.

◆ eeprom12_generic_read()

err_t eeprom12_generic_read	(	eeprom12_t *	ctx,
		uint16_t	reg,
		uint8_t *	data_out,
		uint8_t	len )

EEPROM 12 I2C reading function.

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

Parameters

[in]	ctx	: Click context object. See eeprom12_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.

◆ eeprom12_generic_write()

err_t eeprom12_generic_write	(	eeprom12_t *	ctx,
		uint16_t	reg,
		uint8_t *	data_in,
		uint8_t	len )

EEPROM 12 I2C writing function.

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

Parameters

[in]	ctx	: Click context object. See eeprom12_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.

◆ eeprom12_id_page_read()

err_t eeprom12_id_page_read	(	eeprom12_t *	ctx,
		uint16_t	id_page_addr,
		uint8_t *	data_out )

EEPROM 12 identification page read function.

This function reads a desired number of data bytes starting from the selected identification page address of the M24256E-FMN6TP, 256-Kbit serial I²C bus EEPROM with configurable device address and preprogrammed device address on the EEPROM 12 Click board™.

Parameters

[in]	ctx	: Click context object. See eeprom12_t object definition for detailed explanation.
[in]	id_page_addr	: Start identification page address (0x00-0x3F).
[out]	data_out	: Output read data.

Returns

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

Note: If the identification page is locked, the data bytes transferred during the write identification page instruction are not acknowledged (NoACK).

◆ eeprom12_id_page_write()

err_t eeprom12_id_page_write	(	eeprom12_t *	ctx,
		uint16_t	id_page_addr,
		uint8_t *	data_in )

EEPROM 12 identification page write function.

This function writes a desired number of data bytes starting from the selected identification page address of the M24256E-FMN6TP, 256-Kbit serial I²C bus EEPROM with configurable device address and preprogrammed device address on the EEPROM 12 Click board™.

Parameters

[in]	ctx	: Click context object. See eeprom12_t object definition for detailed explanation.
[in]	id_page_addr	: Start identification page address (0x00-0x3F).
[in]	data_in	: Data to be written.

Returns

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

Note: If the identification page is locked, the data bytes transferred during the write identification page instruction are not acknowledged (NoACK).

◆ eeprom12_init()

err_t eeprom12_init	(	eeprom12_t *	ctx,
		eeprom12_cfg_t *	cfg )

EEPROM 12 initialization function.

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

Parameters

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

Returns

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

Note: None.

◆ eeprom12_memory_page_read()

err_t eeprom12_memory_page_read	(	eeprom12_t *	ctx,
		uint16_t	page_addr,
		uint8_t *	data_out,
		uint8_t	len )

EEPROM 12 memory page read function.

This function reads a desired number of data bytes starting from the selected memory page address of the M24256E-FMN6TP, 256-Kbit serial I²C bus EEPROM with configurable device address and preprogrammed device address on the EEPROM 12 Click board™.

Parameters

[in]	ctx	: Click context object. See eeprom12_t object definition for detailed explanation.
[in]	page_addr	: Start memory page address (0x0000-0x01FF).
[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.

◆ eeprom12_memory_page_write()

err_t eeprom12_memory_page_write	(	eeprom12_t *	ctx,
		uint16_t	page_addr,
		uint8_t *	data_in,
		uint8_t	len )

EEPROM 12 memory page write function.

This function writes a desired number of data bytes starting from the selected memory page address of the M24256E-FMN6TP, 256-Kbit serial I²C bus EEPROM with configurable device address and preprogrammed device address on the EEPROM 12 Click board™.

Parameters

[in]	ctx	: Click context object. See eeprom12_t object definition for detailed explanation.
[in]	page_addr	: Start memory page address (0x0000-0x0200).
[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.

◆ eeprom12_memory_read()

err_t eeprom12_memory_read	(	eeprom12_t *	ctx,
		uint16_t	mem_addr,
		uint8_t *	data_out,
		uint8_t	len )

EEPROM 12 memory read function.

This function reads a desired number of data bytes starting from the selected memory address of the M24256E-FMN6TP, 256-Kbit serial I²C bus EEPROM with configurable device address and preprogrammed device address on the EEPROM 12 Click board™.

Parameters

[in]	ctx	: Click context object. See eeprom12_t object definition for detailed explanation.
[in]	mem_addr	: Start memory address (0x0000-0x7FFF).
[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.

◆ eeprom12_memory_write()

err_t eeprom12_memory_write	(	eeprom12_t *	ctx,
		uint16_t	mem_addr,
		uint8_t *	data_in,
		uint8_t	len )

EEPROM 12 memory write function.

This function writes a desired number of data bytes starting from the selected memory address of the M24256E-FMN6TP, 256-Kbit serial I²C bus EEPROM with configurable device address and preprogrammed device address on the EEPROM 12 Click board™.

Parameters

[in]	ctx	: Click context object. See eeprom12_t object definition for detailed explanation.
[in]	mem_addr	: Start memory address (0x0000-0x7FFF).
[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.

◆ eeprom12_read_lock_status()

err_t eeprom12_read_lock_status	(	eeprom12_t *	ctx,
		uint8_t *	lock_status )

EEPROM 12 read lock status function.

This function reads a lock status of the M24256E-FMN6TP, 256-Kbit serial I²C bus EEPROM with configurable device address and preprogrammed device address on the EEPROM 12 Click board™.

Parameters

[in]	ctx	: Click context object. See eeprom12_t object definition for detailed explanation.
[out]	lock_status	: `0x00` - Unlocked, configurable device address can be modified, `0x01` - Locked, configurable device address cannot be modified.

Returns

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

Note: None.

◆ eeprom12_write_disable()

void eeprom12_write_disable ( eeprom12_t * ctx )

EEPROM 12 write disable function.

This function enable hardware write protection of the entire memory
of the M24256E-FMN6TP, 256-Kbit serial I²C bus EEPROM with configurable device address and preprogrammed device address on the EEPROM 12 Click board™.

Parameters

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

Returns: Nothing.

Note: None.

◆ eeprom12_write_enable()

void eeprom12_write_enable ( eeprom12_t * ctx )

EEPROM 12 write enable function.

This function disable hardware write protection of the entire memory of the M24256E-FMN6TP, 256-Kbit serial I²C bus EEPROM with configurable device address and preprogrammed device address on the EEPROM 12 Click board™.

Parameters

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

Returns: Nothing.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ eeprom12_cfg_setup()

◆ eeprom12_config_dev_addr()

◆ eeprom12_generic_read()

◆ eeprom12_generic_write()

◆ eeprom12_id_page_read()

◆ eeprom12_id_page_write()

◆ eeprom12_init()

◆ eeprom12_memory_page_read()

◆ eeprom12_memory_page_write()

◆ eeprom12_memory_read()

◆ eeprom12_memory_write()

◆ eeprom12_read_lock_status()

◆ eeprom12_write_disable()

◆ eeprom12_write_enable()