eeprom10
2.1.0.0
|
API for configuring and manipulating EEPROM 10 Click driver. More...
Modules | |
EEPROM 10 Registers Settings | |
Settings for registers of EEPROM 10 Click driver. | |
EEPROM 10 MikroBUS Map | |
MikroBUS pin mapping of EEPROM 10 Click driver. | |
Functions | |
void | eeprom10_cfg_setup (eeprom10_cfg_t *cfg) |
EEPROM 10 configuration object setup function. More... | |
err_t | eeprom10_init (eeprom10_t *ctx, eeprom10_cfg_t *cfg) |
EEPROM 10 initialization function. More... | |
void | eeprom10_write_enable (eeprom10_t *ctx) |
EEPROM 10 write enable function. More... | |
void | eeprom10_write_protect (eeprom10_t *ctx) |
EEPROM 10 write protection enable function. More... | |
err_t | eeprom10_write_byte (eeprom10_t *ctx, uint16_t address, uint8_t data_in) |
EEPROM 10 write byte function. More... | |
err_t | eeprom10_write_page (eeprom10_t *ctx, uint8_t address, uint8_t *data_in) |
EEPROM 10 write page function. More... | |
err_t | eeprom10_write_n_byte (eeprom10_t *ctx, uint16_t address, uint8_t *data_in, uint8_t len) |
EEPROM 10 write desired number of data function. More... | |
err_t | eeprom10_read_byte (eeprom10_t *ctx, uint16_t address, uint8_t *data_out) |
EEPROM 10 read byte of data function. More... | |
err_t | eeprom10_read_page (eeprom10_t *ctx, uint8_t address, uint8_t *data_out) |
EEPROM 10 read page of data function. More... | |
err_t | eeprom10_read_n_byte (eeprom10_t *ctx, uint16_t address, uint8_t *data_out, uint8_t len) |
EEPROM 10 read desired number of data function. More... | |
API for configuring and manipulating EEPROM 10 Click driver.
void eeprom10_cfg_setup | ( | eeprom10_cfg_t * | cfg | ) |
EEPROM 10 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See eeprom10_cfg_t object definition for detailed explanation. |
err_t eeprom10_init | ( | eeprom10_t * | ctx, |
eeprom10_cfg_t * | cfg | ||
) |
EEPROM 10 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See eeprom10_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See eeprom10_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t eeprom10_read_byte | ( | eeprom10_t * | ctx, |
uint16_t | address, | ||
uint8_t * | data_out | ||
) |
EEPROM 10 read byte of data function.
This function is used to read a byte of data from selected address.
[in] | ctx | : Click context object. See eeprom10_t object definition for detailed explanation. |
[in] | address | : Selected memory address. |
[out] | data_out | : Read data. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t eeprom10_read_n_byte | ( | eeprom10_t * | ctx, |
uint16_t | address, | ||
uint8_t * | data_out, | ||
uint8_t | len | ||
) |
EEPROM 10 read desired number of data function.
This function is used to read a desired number of data from selected address.
[in] | ctx | : Click context object. See eeprom10_t object definition for detailed explanation. |
[in] | address | : Selected memory address. |
[out] | data_out | : Read data. |
[in] | len | : Number of bytes to be read. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t eeprom10_read_page | ( | eeprom10_t * | ctx, |
uint8_t | address, | ||
uint8_t * | data_out | ||
) |
EEPROM 10 read page of data function.
This function is used to read a page of data from selected address.
[in] | ctx | : Click context object. See eeprom10_t object definition for detailed explanation. |
[in] | address | : Selected memory address. |
[out] | data_out | : Read data. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t eeprom10_write_byte | ( | eeprom10_t * | ctx, |
uint16_t | address, | ||
uint8_t | data_in | ||
) |
EEPROM 10 write byte function.
This function is used to write a byte of data into selected address.
[in] | ctx | : Click context object. See eeprom10_t object definition for detailed explanation. |
[in] | address | : Selected memory address. |
[in] | data_in | : Byte of data to be written. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void eeprom10_write_enable | ( | eeprom10_t * | ctx | ) |
EEPROM 10 write enable function.
This function enables write to the EEPROM.
[in] | ctx | : Click context object. See eeprom10_t object definition for detailed explanation. |
err_t eeprom10_write_n_byte | ( | eeprom10_t * | ctx, |
uint16_t | address, | ||
uint8_t * | data_in, | ||
uint8_t | len | ||
) |
EEPROM 10 write desired number of data function.
This function is used to write a desired number of data into selected address.
[in] | ctx | : Click context object. See eeprom10_t object definition for detailed explanation. |
[in] | address | : Selected memory address. |
[in] | data_in | : Data to be written. |
[in] | len | : Number of bytes to be written. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t eeprom10_write_page | ( | eeprom10_t * | ctx, |
uint8_t | address, | ||
uint8_t * | data_in | ||
) |
EEPROM 10 write page function.
This function is used to write a page of data into selected address.
[in] | ctx | : Click context object. See eeprom10_t object definition for detailed explanation. |
[in] | address | : Selected memory address. |
[in] | data_in | : Data to be written. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void eeprom10_write_protect | ( | eeprom10_t * | ctx | ) |
EEPROM 10 write protection enable function.
This function enables write protection to the EEPROM.
[in] | ctx | : Click context object. See eeprom10_t object definition for detailed explanation. |