no_os_eeprom.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _NO_OS_EEPROM_H_
#define _NO_OS_EEPROM_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
 
#include <stdint.h>
 
/******************************************************************************/
/********************** Macros and Constants Definitions **********************/
/******************************************************************************/
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
 
/* Forward declaration of structure */
struct no_os_eeprom_platform_ops;
 
struct no_os_eeprom_init_param {
    uint32_t device_id;
    const struct no_os_eeprom_platform_ops *platform_ops;
    void *extra;
};
 
struct no_os_eeprom_desc {
    uint32_t device_id;
    const struct no_os_eeprom_platform_ops *platform_ops;
    void *extra;
};
 
struct no_os_eeprom_platform_ops {
    int32_t (*init)(struct no_os_eeprom_desc **,
            const struct no_os_eeprom_init_param *);
    int32_t (*write)(struct no_os_eeprom_desc *, uint32_t, uint8_t *, uint16_t);
    int32_t (*read)(struct no_os_eeprom_desc *, uint32_t, uint8_t *, uint16_t);
    int32_t (*remove)(struct no_os_eeprom_desc *);
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
 
/* Initialize the EEPROM */
int32_t no_os_eeprom_init(struct no_os_eeprom_desc **desc,
              const struct no_os_eeprom_init_param *param);
 
/* Write into EEPROM */
int32_t no_os_eeprom_write(struct no_os_eeprom_desc *desc, uint32_t address,
               uint8_t *data, uint16_t bytes);
 
/* Read from EEPROM */
int32_t no_os_eeprom_read(struct no_os_eeprom_desc *desc, uint32_t address,
              uint8_t *data, uint16_t bytes);
 
/* Free the resources allocated by no_os_eeprom_init() */
int32_t no_os_eeprom_remove(struct no_os_eeprom_desc *desc);
 
#endif // _NO_OS_EEPROM_H_