Functions
platform_result_t	platform_i2c_deinit (const platform_i2c_t i2c, const platform_i2c_config_t config)

platform_result_t	platform_i2c_init (const platform_i2c_t i2c, const platform_i2c_config_t config)

platform_result_t	platform_i2c_init_rx_message (platform_i2c_message_t message, void rx_buffer, uint16_t rx_buffer_length, uint16_t retries, wiced_bool_t disable_dma)

platform_result_t	platform_i2c_init_tx_message (platform_i2c_message_t message, const void tx_buffer, uint16_t tx_buffer_length, uint16_t retries, wiced_bool_t disable_dma)

wiced_bool_t	platform_i2c_probe_device (const platform_i2c_t i2c, const platform_i2c_config_t config, int retries)

platform_result_t	platform_i2c_read (const platform_i2c_t i2c, const platform_i2c_config_t config, uint16_t flags, void *buffer, uint16_t buffer_length)

platform_result_t	platform_i2c_transfer (const platform_i2c_t i2c, const platform_i2c_config_t config, platform_i2c_message_t *messages, uint16_t number_of_messages)

platform_result_t	platform_i2c_write (const platform_i2c_t i2c, const platform_i2c_config_t config, uint16_t flags, const void *buffer, uint16_t buffer_length)

platform_result_t	platform_spi_chip_select_toggle (const platform_spi_t spi, const platform_spi_config_t config, wiced_bool_t activate)

platform_result_t	platform_spi_deinit (const platform_spi_t *spi)

platform_result_t	platform_spi_init (const platform_spi_t spi, const platform_spi_config_t config)

platform_result_t	platform_spi_transfer (const platform_spi_t spi, const platform_spi_config_t config, const platform_spi_message_segment_t *segments, uint16_t number_of_segments)

platform_result_t	platform_spi_transfer_nosetup (const platform_spi_t spi, const platform_spi_config_t config, const uint8_t send_ptr, uint8_t rcv_ptr, uint32_t length)

Function Documentation

◆ platform_i2c_deinit()

platform_result_t platform_i2c_deinit	(	const platform_i2c_t *	i2c,
		const platform_i2c_config_t *	config )

Deinitialise I2C interface

Parameters

[in] i2c_interface : I2C interface

Returns: platform_result_t

◆ platform_i2c_init()

platform_result_t platform_i2c_init	(	const platform_i2c_t *	i2c,
		const platform_i2c_config_t *	config )

Initialise I2C interface

Parameters

[in]	i2c_interface	: I2C interface
[in]	config	: I2C configuration

Returns: platform_result_t

◆ platform_i2c_init_rx_message()

platform_result_t platform_i2c_init_rx_message	(	platform_i2c_message_t *	message,
		void *	rx_buffer,
		uint16_t	rx_buffer_length,
		uint16_t	retries,
		wiced_bool_t	disable_dma )

Initialise I2C receive message

Parameters

[in,out]	message	: I2C message
[in]	rx_buffer	: receive buffer
[in]	rx_buffer_length	: receive buffer length is bytes
[in]	retries	: number of transmission retries
[in]	disable_dma	: WICED_TRUE if DMA is disabled

Returns: platform_result_t

◆ platform_i2c_init_tx_message()

platform_result_t platform_i2c_init_tx_message	(	platform_i2c_message_t *	message,
		const void *	tx_buffer,
		uint16_t	tx_buffer_length,
		uint16_t	retries,
		wiced_bool_t	disable_dma )

Initialise I2C transmit message

Parameters

[in,out]	message	: I2C message
[in]	tx_buffer	: transmit buffer
[in]	tx_buffer_length	: transmit buffer length is bytes
[in]	retries	: number of transmission retries
[in]	disable_dma	: WICED_TRUE if DMA is disabled

Returns: platform_result_t

◆ platform_i2c_probe_device()

wiced_bool_t platform_i2c_probe_device	(	const platform_i2c_t *	i2c,
		const platform_i2c_config_t *	config,
		int	retries )

Probe I2C slave device

Parameters

[in]	i2c_interface	: I2C interface
[in]	retries	: number of retries

Returns: platform_result_t

◆ platform_i2c_read()

platform_result_t platform_i2c_read	(	const platform_i2c_t *	i2c,
		const platform_i2c_config_t *	config,
		uint16_t	flags,
		void *	buffer,
		uint16_t	buffer_length )

Read bytes via the I2C interface

Parameters

[in]	i2c	: I2C interface
[in]	config	: settings and flags used for transfer
[in]	flags	: flags for controlling the the transfer
[out]	buffer	: pointer to a receiving buffer
[in]	buffer_length	: length in bytes of the receiving buffer

Returns: platform_result_t

◆ platform_i2c_transfer()

platform_result_t platform_i2c_transfer	(	const platform_i2c_t *	i2c,
		const platform_i2c_config_t *	config,
		platform_i2c_message_t *	messages,
		uint16_t	number_of_messages )

Transfer data via the I2C interface

Parameters

[in]	i2c_interface	: I2C interface
[in]	messages	: pointer to an array of messages to transceive
[in]	number_of_messages	: number of messages in the array

Returns: platform_result_t

◆ platform_i2c_write()

platform_result_t platform_i2c_write	(	const platform_i2c_t *	i2c,
		const platform_i2c_config_t *	config,
		uint16_t	flags,
		const void *	buffer,
		uint16_t	buffer_length )

Write bytes via the I2C interface

Parameters

[in]	i2c	: I2C interface
[in]	config	: settings and flags used for transfer
[in]	flags	: flags for controlling the the transfer
[in]	buffer	: pointer to a transmit buffer
[in]	buffer_length	: length in bytes of the transmit buffer

Returns: platform_result_t

◆ platform_spi_chip_select_toggle()

platform_result_t platform_spi_chip_select_toggle	(	const platform_spi_t *	spi,
		const platform_spi_config_t *	config,
		wiced_bool_t	activate )

Toggle chip-select for the specified SPI interface.

Returns: platform_result_t

◆ platform_spi_deinit()

platform_result_t platform_spi_deinit ( const platform_spi_t * spi )

Deinitialise the specified SPI interface

Returns: platform_result_t

◆ platform_spi_init()

platform_result_t platform_spi_init	(	const platform_spi_t *	spi,
		const platform_spi_config_t *	config )

Initialise the specified SPI interface

Parameters

[in]	spi_interface	: SPI interface
[in]	config	: SPI configuratin

Returns: platform_result_t

◆ platform_spi_transfer()

platform_result_t platform_spi_transfer	(	const platform_spi_t *	spi,
		const platform_spi_config_t *	config,
		const platform_spi_message_segment_t *	segments,
		uint16_t	number_of_segments )

Transfer data over the specified SPI interface

Returns: platform_result_t

◆ platform_spi_transfer_nosetup()

platform_result_t platform_spi_transfer_nosetup	(	const platform_spi_t *	spi,
		const platform_spi_config_t *	config,
		const uint8_t *	send_ptr,
		uint8_t *	recv_ptr,
		uint32_t	length )

Transfer raw data over the specified SPI interface. No prior setup (toggle chip-select, etc.) is done.

Returns: platform_result_t

Functions

Function Documentation

◆ platform_i2c_deinit()

◆ platform_i2c_init()

◆ platform_i2c_init_rx_message()

◆ platform_i2c_init_tx_message()

◆ platform_i2c_probe_device()

◆ platform_i2c_read()

◆ platform_i2c_transfer()

◆ platform_i2c_write()

◆ platform_spi_chip_select_toggle()

◆ platform_spi_deinit()

◆ platform_spi_init()

◆ platform_spi_transfer()

◆ platform_spi_transfer_nosetup()