no-OS
Loading...
Searching...
No Matches
Classes | Macros | Functions | Variables
m24512.h File Reference

Header file for M24512 EEPROM driver. More...

#include <stdint.h>
#include <stdbool.h>
#include "no_os_i2c.h"
#include "no_os_gpio.h"
#include "no_os_error.h"
#include "no_os_eeprom.h"
Include dependency graph for m24512.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  m24512_init_param
 M24512 initialization parameters. More...
 
struct  m24512_dev
 M24512 device descriptor. More...
 

Macros

#define M24512_MEMORY_SIZE   65536U
 
#define M24512_PAGE_SIZE   128U
 
#define M24512_NUM_PAGES   512U
 
#define M24512_MAX_ADDRESS   (M24512_MEMORY_SIZE - 1)
 
#define M24512_WRITE_CYCLE_TIME   5U
 
#define M24512_BYTE_WRITE_TIME   5U
 
#define M24512_PAGE_WRITE_TIME   5U
 
#define M24512_ADDR_HIGH_BYTE(addr)
 
#define M24512_ADDR_LOW_BYTE(addr)
 

Functions

int32_t m24512_init (struct no_os_eeprom_desc **desc, const struct no_os_eeprom_init_param *param)
 Initialize the M24512 EEPROM device.
 
int32_t m24512_remove (struct no_os_eeprom_desc *desc)
 Free resources allocated by M24512 device.
 
int32_t m24512_read_data (struct no_os_eeprom_desc *desc, uint32_t address, uint8_t *data, uint16_t len)
 Read multiple bytes from EEPROM.
 
int32_t m24512_write_data (struct no_os_eeprom_desc *desc, uint32_t address, uint8_t *data, uint16_t len)
 Write multiple bytes to EEPROM (handles page boundaries)
 
bool m24512_is_ready (struct m24512_dev *dev)
 Check if EEPROM is ready (write cycle completed)
 
int m24512_wait_ready (struct m24512_dev *dev, uint32_t timeout_ms)
 Wait for write cycle completion.
 
int m24512_get_info (struct m24512_dev *dev, uint32_t *memory_size, uint16_t *page_size, uint16_t *num_pages)
 Get device information.
 

Variables

const struct no_os_eeprom_platform_ops eeprom_m24512_ops
 M24512 EEPROM specific ops structure.
 

Detailed Description

Header file for M24512 EEPROM driver.

Author
rober.nosp@m.t.bu.nosp@m.dai@a.nosp@m.nalo.nosp@m.g.com

Copyright 2025(c) Analog Devices, Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Macro Definition Documentation

◆ M24512_ADDR_HIGH_BYTE

#define M24512_ADDR_HIGH_BYTE ( addr)
Value:
((uint8_t)((addr >> 8) & 0xFF))

◆ M24512_ADDR_LOW_BYTE

#define M24512_ADDR_LOW_BYTE ( addr)
Value:
((uint8_t)(addr & 0xFF))

◆ M24512_BYTE_WRITE_TIME

#define M24512_BYTE_WRITE_TIME   5U

◆ M24512_MAX_ADDRESS

#define M24512_MAX_ADDRESS   (M24512_MEMORY_SIZE - 1)

◆ M24512_MEMORY_SIZE

#define M24512_MEMORY_SIZE   65536U

◆ M24512_NUM_PAGES

#define M24512_NUM_PAGES   512U

◆ M24512_PAGE_SIZE

#define M24512_PAGE_SIZE   128U

◆ M24512_PAGE_WRITE_TIME

#define M24512_PAGE_WRITE_TIME   5U

◆ M24512_WRITE_CYCLE_TIME

#define M24512_WRITE_CYCLE_TIME   5U

Function Documentation

◆ m24512_get_info()

int m24512_get_info ( struct m24512_dev * dev,
uint32_t * memory_size,
uint16_t * page_size,
uint16_t * num_pages )

Get device information.

Parameters
dev- Device descriptor
memory_size- Pointer to store memory size
page_size- Pointer to store page size
num_pages- Pointer to store number of pages
Returns
0 in case of success, negative error code otherwise

◆ m24512_init()

int32_t m24512_init ( struct no_os_eeprom_desc ** desc,
const struct no_os_eeprom_init_param * param )

Initialize the M24512 EEPROM device.

Parameters
desc- Pointer to device descriptor
param- Initialization parameters
Returns
0 in case of success, negative error code otherwise

◆ m24512_is_ready()

bool m24512_is_ready ( struct m24512_dev * dev)

Check if EEPROM is ready (write cycle completed)

Parameters
dev- Device descriptor
Returns
true if ready, false if busy

◆ m24512_read_data()

int32_t m24512_read_data ( struct no_os_eeprom_desc * desc,
uint32_t address,
uint8_t * data,
uint16_t len )

Read multiple bytes from EEPROM.

Parameters
desc- Device descriptor
address- Starting memory address
data- Buffer to store read data
len- Number of bytes to read
Returns
0 in case of success, negative error code otherwise

◆ m24512_remove()

int32_t m24512_remove ( struct no_os_eeprom_desc * desc)

Free resources allocated by M24512 device.

Parameters
desc- Device descriptor
Returns
0 in case of success, negative error code otherwise

◆ m24512_wait_ready()

int m24512_wait_ready ( struct m24512_dev * dev,
uint32_t timeout_ms )

Wait for write cycle completion.

Parameters
dev- Device descriptor
timeout_ms- Maximum timeout in milliseconds
Returns
0 if ready, negative error code on timeout
Here is the caller graph for this function:

◆ m24512_write_data()

int32_t m24512_write_data ( struct no_os_eeprom_desc * desc,
uint32_t address,
uint8_t * data,
uint16_t len )

Write multiple bytes to EEPROM (handles page boundaries)

Parameters
desc- Device descriptor
address- Starting memory address
data- Data buffer to write
len- Number of bytes to write
Returns
0 in case of success, negative error code otherwise

Variable Documentation

◆ eeprom_m24512_ops

const struct no_os_eeprom_platform_ops eeprom_m24512_ops
extern

M24512 EEPROM specific ops structure.

M24512 EEPROM specific ops structure