at24cxxx.h

Go to the documentation of this file.

/*
 * Copyright (C) 2019 Otto-von-Guericke-Universität Magdeburg
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#ifndef AT24CXXX_H
#define AT24CXXX_H
 
#include <stdint.h>
 
#include "periph/gpio.h"
#include "periph/i2c.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum {
    AT24CXXX_OK,
    AT24CXXX_I2C_ERROR
};
 
typedef struct at24cxxx_params {
    i2c_t i2c;                      
    gpio_t pin_wp;                  
    uint32_t eeprom_size;           
    uint8_t dev_addr;               
    uint8_t page_size;              
    uint8_t max_polls;              
} at24cxxx_params_t;
 
typedef struct {
    at24cxxx_params_t params;     
} at24cxxx_t;
 
int at24cxxx_init(at24cxxx_t *dev, const at24cxxx_params_t *params);
 
int at24cxxx_read_byte(const at24cxxx_t *dev, uint32_t pos, void *dest);
 
int at24cxxx_read(const at24cxxx_t *dev, uint32_t pos, void *data,
                  size_t len);
 
int at24cxxx_write_byte(const at24cxxx_t *dev, uint32_t pos, uint8_t data);
 
int at24cxxx_write(const at24cxxx_t *dev, uint32_t pos, const void *data,
                   size_t len);
 
int at24cxxx_write_page(const at24cxxx_t *dev, uint32_t page, uint32_t offset,
                        const void *data, size_t len);
 
int at24cxxx_set(const at24cxxx_t *dev, uint32_t pos, uint8_t val,
                 size_t len);
 
int at24cxxx_clear(const at24cxxx_t *dev, uint32_t pos, size_t len);
 
int at24cxxx_erase(const at24cxxx_t *dev);
 
int at24cxxx_enable_write_protect(const at24cxxx_t *dev);
 
int at24cxxx_disable_write_protect(const at24cxxx_t *dev);
 
#ifdef __cplusplus
}
#endif
 
#endif /* AT24CXXX_H */