FTDI Click Driver

API for configuring and manipulating FTDI Click driver. More...

Topics
	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.
err_t	ftdi_init (ftdi_t *ctx, ftdi_cfg_t *cfg)
	FTDI initialization function.
err_t	ftdi_generic_write (ftdi_t *ctx, uint8_t *data_in, uint16_t len)
	FTDI data writing function.
err_t	ftdi_generic_read (ftdi_t *ctx, uint8_t *data_out, uint16_t len)
	FTDI data reading function.

Detailed Description

API for configuring and manipulating FTDI Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

ftdi_cfg_setup()

void ftdi_cfg_setup

(

ftdi_cfg_t *

cfg

)

FTDI configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See ftdi_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

ftdi_generic_read()

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.

Parameters

[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.

Returns

• >0 - Number of data bytes read,
• <=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.

Note

None.

ftdi_generic_write()

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.

Parameters

[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.

Returns

• >=0 - Success,
• <0 - Error. See #err_t definition for detailed explanation.

Note

None.

ftdi_init()

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.

Parameters

[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.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.