SPI Isolator 6 Click Driver

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

Topics
	SPI Isolator 6 Registers Settings
	Settings for registers of SPI Isolator 6 Click driver.
	SPI Isolator 6 MikroBUS Map
	MikroBUS pin mapping of SPI Isolator 6 Click driver.

Functions
void	spiisolator6_cfg_setup (spiisolator6_cfg_t *cfg)
	SPI Isolator 6 configuration object setup function.
err_t	spiisolator6_init (spiisolator6_t *ctx, spiisolator6_cfg_t *cfg)
	SPI Isolator 6 initialization function.
err_t	spiisolator6_generic_write (spiisolator6_t *ctx, uint8_t *data_in, uint8_t in_len)
	SPI Isolator 6 data writing function.
err_t	spiisolator6_generic_read (spiisolator6_t *ctx, uint8_t *data_in, uint8_t in_len, uint8_t *data_out, uint8_t out_len)
	SPI Isolator 6 data reading function.

Detailed Description

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

spiisolator6_cfg_setup()

void spiisolator6_cfg_setup

(

spiisolator6_cfg_t *

cfg

)

SPI Isolator 6 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out]

cfg

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

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

spiisolator6_generic_read()

err_t spiisolator6_generic_read	(	spiisolator6_t *	ctx,
		uint8_t *	data_in,
		uint8_t	in_len,
		uint8_t *	data_out,
		uint8_t	out_len )

SPI Isolator 6 data reading 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 spiisolator6_t object definition for detailed explanation.
[in]	data_in	: Data to be written.
[in]	in_len	: Number of bytes to be written.
[out]	data_out	: Output read data.
[in]	out_len	: Number of bytes to be read.

Returns

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

Note

None.

spiisolator6_generic_write()

err_t spiisolator6_generic_write	(	spiisolator6_t *	ctx,
		uint8_t *	data_in,
		uint8_t	in_len )

SPI Isolator 6 data writing function.

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

Parameters

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

Returns

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

Note

None.

spiisolator6_init()

err_t spiisolator6_init	(	spiisolator6_t *	ctx,
		spiisolator6_cfg_t *	cfg )

SPI Isolator 6 initialization function.

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

Parameters

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

Returns

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

Note

None.