FM24C.h File Reference

FM24C FRAM Driver (bank switching at I2C address level protocol) More...

#include "sarmfsw.h"
#include "I2C_component.h"
#include "I2C_peripheral.h"
#include "FM24C_ex.h"

Include dependency graph for FM24C.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	FM24C_t
	FM24C user interface struct. More...

Macros
#define	I2C_FM24C_NB   1U
	Number of FM24C peripherals.
#define	FM24C_BASE_ADDR   0x50U
	FM24C Base address.
#define	FM24C_BANK_SIZE   0x100U
	FM24C bank size (in bytes)
#define	FM24C04B_SIZE   0x200U
	FM24C04 size (in bytes)
#define	FM24C16B_SIZE   0x800U
	FM24C16 size (in bytes)
#define	FM24C_SIZE   FM24C16B_SIZE
	FM24C size.

Functions
FctERR	FM24C_Init (const uint8_t idx, I2C_HandleTypeDef *const hi2c, const uint16_t devAddress)
	Initialization for FM24C peripheral.
FctERR	FM24C_Init_Single (void)
	Initialization for FM24C peripheral.
FctERR	FM24C_Write (FM24C_t *const pCpnt, const uint8_t *const data, const uint16_t addr, const uint16_t nb)
	I2C Write function for FM24C.
FctERR	FM24C_Read (FM24C_t *const pCpnt, uint8_t *const data, const uint16_t addr, const uint16_t nb)
	I2C Read function for FM24C.

Variables
FM24C_t	FM24C [I2C_FM24C_NB]
	FM24C User structure.

Detailed Description

FM24C FRAM Driver (bank switching at I2C address level protocol)

Author

SMFSW

Copyright

MIT (c) 2017-2026, SMFSW

FM24C16B: 16-Kbit (2K * 8) Serial I2C F-RAM FM24C04B: 4-Kbit (512 * 8) Serial I2C F-RAM

Note

Legacy component: consider switching to I2CMEM component for new designs

Compatibility (tested):

• FM24C16B
• FM24C04B
• BR24T04FVM

Macro Definition Documentation

FM24C04B_SIZE

#define FM24C04B_SIZE   0x200U

FM24C04 size (in bytes)

FM24C16B_SIZE

#define FM24C16B_SIZE   0x800U

FM24C16 size (in bytes)

FM24C_BANK_SIZE

#define FM24C_BANK_SIZE   0x100U

FM24C bank size (in bytes)

FM24C_BASE_ADDR

#define FM24C_BASE_ADDR   0x50U

FM24C Base address.

Note

Define FM24C_BASE_ADDR to change default device base address

FM24C_SIZE

#define FM24C_SIZE   FM24C16B_SIZE

FM24C size.

Note

FM24C_SIZE defaults to FM24C16B size, but can be defined to FM24C04B_SIZE (for example)

I2C_FM24C_NB

#define I2C_FM24C_NB   1U

Number of FM24C peripherals.

Note

Define I2C_FM24C_NB to enable multiple peripherals of this type

Function Documentation

FM24C_Init()

FctERR FM24C_Init	(	const uint8_t	idx,
		I2C_HandleTypeDef *const	hi2c,
		const uint16_t	devAddress )

Initialization for FM24C peripheral.

Parameters

[in]	idx	- FM24C index
[in]	hi2c	- pointer to FM24C I2C instance
[in]	devAddress	- FM24C device address

Returns

FctERR - error code

Here is the call graph for this function:

Here is the caller graph for this function:

FM24C_Init_Single()

FctERR FM24C_Init_Single

(

void

)

Initialization for FM24C peripheral.

Warning

In case multiple devices (defined by I2C_FM24C_NB > 1), you shall use FM24C_Init instead

Returns

FctERR - error code

Here is the call graph for this function:

FM24C_Read()

FctERR FM24C_Read	(	FM24C_t *const	pCpnt,
		uint8_t *const	data,
		const uint16_t	addr,
		const uint16_t	nb )

I2C Read function for FM24C.

Parameters

[in]	pCpnt	- Pointer to FM24C component
[in,out]	data	- pointer to read/write to/from
[in]	addr	- Address to read from
[in]	nb	- Number of bytes to read

Returns

FctERR - error code

FM24C_Write()

FctERR FM24C_Write	(	FM24C_t *const	pCpnt,
		const uint8_t *const	data,
		const uint16_t	addr,
		const uint16_t	nb )

I2C Write function for FM24C.

Parameters

[in]	pCpnt	- Pointer to FM24C component
[in,out]	data	- pointer to read/write to/from
[in]	addr	- Address to read from
[in]	nb	- Number of bytes to read

Returns

FctERR - error code

Here is the caller graph for this function:

Variable Documentation

FM24C

FM24C_t FM24C[I2C_FM24C_NB]

extern

FM24C User structure.