m24512.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef __M24512_H__
#define __M24512_H__
 
#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"
 
#define M24512_MEMORY_SIZE              65536U      // 64KB (512Kbit)
#define M24512_PAGE_SIZE                128U        // 128 bytes per page
#define M24512_NUM_PAGES                512U        // Total number of pages
#define M24512_MAX_ADDRESS              (M24512_MEMORY_SIZE - 1)
 
// Timing specifications (in milliseconds)
#define M24512_WRITE_CYCLE_TIME         5U          // Maximum write cycle time
#define M24512_BYTE_WRITE_TIME          5U          // Byte/page write time
#define M24512_PAGE_WRITE_TIME          5U          // Page write time
 
// Address format
#define M24512_ADDR_HIGH_BYTE(addr)     ((uint8_t)((addr >> 8) & 0xFF))
#define M24512_ADDR_LOW_BYTE(addr)      ((uint8_t)(addr & 0xFF))

struct m24512_init_param {
    struct no_os_i2c_init_param i2c_init;
    uint8_t i2c_addr;
    struct no_os_gpio_init_param *wc_gpio_init;
};

struct m24512_dev {
    struct no_os_i2c_desc *i2c_desc;
    uint8_t i2c_addr;
    struct no_os_gpio_desc *wc_gpio_desc;
};

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

int32_t m24512_remove(struct no_os_eeprom_desc *desc);

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

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

bool m24512_is_ready(struct m24512_dev *dev);

int m24512_wait_ready(struct m24512_dev *dev, uint32_t timeout_ms);

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

static inline uint16_t m24512_addr_to_page(uint16_t addr)
{
    return addr / M24512_PAGE_SIZE;
}

static inline uint8_t m24512_addr_to_offset(uint16_t addr)
{
    return addr % M24512_PAGE_SIZE;
}

static inline uint16_t m24512_page_to_addr(uint16_t page, uint8_t offset)
{
    return (page * M24512_PAGE_SIZE) + offset;
}

static inline bool m24512_is_valid_addr(uint16_t addr)
{
    return addr <= M24512_MAX_ADDRESS;
}

static inline bool m24512_is_valid_page(uint16_t page)
{
    return page < M24512_NUM_PAGES;
}

extern const struct no_os_eeprom_platform_ops eeprom_m24512_ops;
 
#endif /* __M24512_H__ */