ftdi
2.1.0.0
|
API for configuring and manipulating FTDI Click driver. More...
Modules | |
FTDI Device Settings | |
Settings for registers of FTDI Click driver. | |
FTDI MikroBUS Map | |
MikroBUS pin mapping of FTDI Click driver. | |
Functions | |
void | ftdi_cfg_setup (ftdi_cfg_t *cfg) |
FTDI configuration object setup function. More... | |
err_t | ftdi_init (ftdi_t *ctx, ftdi_cfg_t *cfg) |
FTDI initialization function. More... | |
err_t | ftdi_generic_write (ftdi_t *ctx, uint8_t *data_in, uint16_t len) |
FTDI data writing function. More... | |
err_t | ftdi_generic_read (ftdi_t *ctx, uint8_t *data_out, uint16_t len) |
FTDI data reading function. More... | |
API for configuring and manipulating FTDI Click driver.
void ftdi_cfg_setup | ( | ftdi_cfg_t * | cfg | ) |
FTDI configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See ftdi_cfg_t object definition for detailed explanation. |
err_t ftdi_generic_read | ( | ftdi_t * | ctx, |
uint8_t * | data_out, | ||
uint16_t | len | ||
) |
FTDI data reading function.
This function reads a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See ftdi_t object definition for detailed explanation. |
[out] | data_out | : Output read data. |
[in] | len | : Number of bytes to be read. |
>0
- Number of data bytes read, <=0
- Error/Empty Ring buffer. See #err_t definition for detailed explanation. err_t ftdi_generic_write | ( | ftdi_t * | ctx, |
uint8_t * | data_in, | ||
uint16_t | len | ||
) |
FTDI data writing function.
This function writes a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See ftdi_t object definition for detailed explanation. |
[in] | data_in | : Data buffer for sending. |
[in] | len | : Number of bytes for sending. |
>=0
- Success, <0
- Error. See #err_t definition for detailed explanation. err_t ftdi_init | ( | ftdi_t * | ctx, |
ftdi_cfg_t * | cfg | ||
) |
FTDI initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See ftdi_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See ftdi_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation.