SPI Isolator 5 Click Driver

API for configuring and manipulating SPI Isolator 5 Click driver. More...

Topics
	SPI Isolator 5 Settings
	Settings of SPI Isolator 5 Click driver.
	SPI Isolator 5 MikroBUS Map
	MikroBUS pin mapping of SPI Isolator 5 Click driver.

Functions
void	spiisolator5_cfg_setup (spiisolator5_cfg_t *cfg)
	SPI Isolator 5 configuration object setup function.
err_t	spiisolator5_init (spiisolator5_t *ctx, spiisolator5_cfg_t *cfg)
	SPI Isolator 5 initialization function.
void	spiisolator5_enable (spiisolator5_t *ctx)
	SPI Isolator 5 enable function.
void	spiisolator5_disable (spiisolator5_t *ctx)
	SPI Isolator 5 disable function.
err_t	spiisolator5_write (spiisolator5_t *ctx, uint8_t *data_in, uint8_t len)
	SPI Isolator 5 data writing function.
err_t	spiisolator5_read (spiisolator5_t *ctx, uint8_t *data_out, uint8_t len_out)
	SPI Isolator 5 data reading function.
err_t	spiisolator5_write_then_read (spiisolator5_t *ctx, uint8_t *data_in, uint8_t len_in, uint8_t *data_out, uint8_t len_out)
	SPI Isolator 5 write then read function.
err_t	spiisolator5_transfer (spiisolator5_t *ctx, uint8_t *data_in, uint8_t *data_out, uint8_t len)
	SPI Isolator 5 transfer function.

Detailed Description

API for configuring and manipulating SPI Isolator 5 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

spiisolator5_cfg_setup()

void spiisolator5_cfg_setup

(

spiisolator5_cfg_t *

cfg

)

SPI Isolator 5 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

spiisolator5_disable()

void spiisolator5_disable

(

spiisolator5_t *

ctx

)

SPI Isolator 5 disable function.

This function performs disabling
the DCL541A01, High Speed Quad Channel Digital Isolators on the SPI Isolator 5 Click board™.

Parameters

[out]

ctx

: Click context object. See spiisolator5_t object definition for detailed explanation.

Returns

Nothing.

Note

None.

spiisolator5_enable()

void spiisolator5_enable

(

spiisolator5_t *

ctx

)

SPI Isolator 5 enable function.

This function performs enabling a device the DCL541A01, High Speed Quad Channel Digital Isolators on the SPI Isolator 5 Click board™.

Parameters

[out]

ctx

: Click context object. See spiisolator5_t object definition for detailed explanation.

Returns

Nothing.

Note

None.

spiisolator5_init()

err_t spiisolator5_init	(	spiisolator5_t *	ctx,
		spiisolator5_cfg_t *	cfg )

SPI Isolator 5 initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters

[out]	ctx	: Click context object. See spiisolator5_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See spiisolator5_cfg_t object definition for detailed explanation.

Returns

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

Note

None.

spiisolator5_read()

err_t spiisolator5_read	(	spiisolator5_t *	ctx,
		uint8_t *	data_out,
		uint8_t	len_out )

SPI Isolator 5 data reading function.

This function reads a desired number of data bytes by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See spiisolator5_t object definition for detailed explanation.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

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

Note

None.

spiisolator5_transfer()

err_t spiisolator5_transfer	(	spiisolator5_t *	ctx,
		uint8_t *	data_in,
		uint8_t *	data_out,
		uint8_t	len )

SPI Isolator 5 transfer function.

This function writes and reads a desired number of data bytes by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See spiisolator5_t object definition for detailed explanation.
[in]	data_in	: Data to be written.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be transferred (written/read).

Returns

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

Note

None.

spiisolator5_write()

err_t spiisolator5_write	(	spiisolator5_t *	ctx,
		uint8_t *	data_in,
		uint8_t	len )

SPI Isolator 5 data writing function.

This function writes a desired number of data bytes by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See spiisolator5_t object definition for detailed explanation.
[in]	data_in	: Data to be written.
[in]	len	: Number of bytes to be written.

Returns

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

Note

None.

spiisolator5_write_then_read()

err_t spiisolator5_write_then_read	(	spiisolator5_t *	ctx,
		uint8_t *	data_in,
		uint8_t	len_in,
		uint8_t *	data_out,
		uint8_t	len_out )

SPI Isolator 5 write then read function.

This function writes and then reads a desired number of data bytes by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See spiisolator5_t object definition for detailed explanation.
[in]	data_in	: Data to be written.
[in]	len_in	: Number of bytes to be written.
[out]	data_out	: Output read data.
[in]	len_out	: Number of bytes to be read.

Returns

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

Note

None.