i2s_common.c File Reference

#include "hal/driver/driver.h"

Macros
#define	VSF_I2S_CFG_FUNCTION_RENAME   DISABLED

Functions
vsf_err_t	vsf_i2s_init (vsf_i2s_t *i2s_ptr, vsf_i2s_cfg_t *cfg_ptr)
	initialize a i2s instance.
vsf_err_t	vsf_i2s_tx_init (vsf_i2s_t *i2s_ptr, vsf_i2s_cfg_t *cfg_ptr)
	initialize i2s tx channel.
void	vsf_i2s_tx_fini (vsf_i2s_t *i2s_ptr)
	finalize i2s tx channel.
vsf_err_t	vsf_i2s_tx_start (vsf_i2s_t *i2s_ptr)
	start i2s tx channel.
vsf_err_t	vsf_i2s_rx_init (vsf_i2s_t *i2s_ptr, vsf_i2s_cfg_t *cfg_ptr)
	initialize i2s rx channel.
void	vsf_i2s_rx_fini (vsf_i2s_t *i2s_ptr)
	finalize i2s rx channel.
vsf_err_t	vsf_i2s_rx_start (vsf_i2s_t *i2s_ptr)
	start i2s rx channel.
fsm_rt_t	vsf_i2s_enable (vsf_i2s_t *i2s_ptr)
	enable i2s instance.
fsm_rt_t	vsf_i2s_disable (vsf_i2s_t *i2s_ptr)
	disable i2s instance.
vsf_i2s_status_t	vsf_i2s_status (vsf_i2s_t *i2s_ptr)
	get the status of i2s instance.
vsf_i2s_capability_t	vsf_i2s_capability (vsf_i2s_t *i2s_ptr)
	get the capability of i2s instance.

Macro Definition Documentation

VSF_I2S_CFG_FUNCTION_RENAME

#define VSF_I2S_CFG_FUNCTION_RENAME   DISABLED

Function Documentation

vsf_i2s_init()

vsf_err_t vsf_i2s_init	(	vsf_i2s_t *	i2s_ptr,
		vsf_i2s_cfg_t *	i2s_cfg
	)

initialize a i2s instance.

Parameters

[in]	i2s_ptr	a pointer to structure vsf_i2s_t
[in]	cfg_ptr	a pointer to structure vsf_i2s_cfg_t

Returns

vsf_err_t: VSF_ERR_NONE if i2s was initialized, or a negative error code

Note

It is not necessary to call vsf_i2s_fini() to deinitialization. vsf_i2s_init() should be called before any other i2s API except vsf_i2s_capability().

vsf_i2s_tx_init()

vsf_err_t vsf_i2s_tx_init	(	vsf_i2s_t *	i2s_ptr,
		vsf_i2s_cfg_t *	i2s_cfg
	)

initialize i2s tx channel.

Parameters

[in]	i2s_ptr	a pointer to structure vsf_i2s_t
[in]	cfg_ptr	a pointer to structure vsf_i2s_cfg_t

Returns

vsf_err_t: VSF_ERR_NONE if i2s initialized successfully, or a negative error code

vsf_i2s_tx_fini()

void vsf_i2s_tx_fini

(

vsf_i2s_t *

i2s_ptr

)

finalize i2s tx channel.

Parameters

[in]

i2s_ptr

a pointer to structure vsf_i2s_t

Returns

void

vsf_i2s_tx_start()

vsf_err_t vsf_i2s_tx_start

(

vsf_i2s_t *

i2s_ptr

)

start i2s tx channel.

Parameters

[in]

i2s_ptr

a pointer to structure vsf_i2s_t

Returns

vsf_err_t: VSF_ERR_NONE if i2s started successfully, or a negative error code

vsf_i2s_rx_init()

vsf_err_t vsf_i2s_rx_init	(	vsf_i2s_t *	i2s_ptr,
		vsf_i2s_cfg_t *	i2s_cfg
	)

initialize i2s rx channel.

Parameters

[in]	i2s_ptr	a pointer to structure vsf_i2s_t
[in]	cfg_ptr	a pointer to structure vsf_i2s_cfg_t

Returns

vsf_err_t: VSF_ERR_NONE if i2s initialized successfully, or a negative error code

vsf_i2s_rx_fini()

void vsf_i2s_rx_fini

(

vsf_i2s_t *

i2s_ptr

)

finalize i2s rx channel.

Parameters

[in]

i2s_ptr

a pointer to structure vsf_i2s_t

Returns

void

vsf_i2s_rx_start()

vsf_err_t vsf_i2s_rx_start

(

vsf_i2s_t *

i2s_ptr

)

start i2s rx channel.

Parameters

[in]

i2s_ptr

a pointer to structure vsf_i2s_t

Returns

vsf_err_t: VSF_ERR_NONE if i2s started successfully, or a negative error code

vsf_i2s_enable()

fsm_rt_t vsf_i2s_enable

(

vsf_i2s_t *

i2s_ptr

)

enable i2s instance.

Parameters

[in]

i2s_ptr

a pointer to structure vsf_i2s_t

Returns

fsm_rt_t: fsm_rt_cpl if enable complete, else return fsm_rt_onging

vsf_i2s_disable()

fsm_rt_t vsf_i2s_disable

(

vsf_i2s_t *

i2s_ptr

)

disable i2s instance.

Parameters

[in]

i2s_ptr

a pointer to structure vsf_i2s_t

Returns

fsm_rt_t: fsm_rt_cpl if disable complete, else return fsm_rt_onging

vsf_i2s_status()

vsf_i2s_status_t vsf_i2s_status

(

vsf_i2s_t *

i2s_ptr

)

get the status of i2s instance.

Parameters

[in]

i2s_ptr

a pointer to structure vsf_i2s_t

Returns

vsf_i2s_status_t: return all status of current i2s

vsf_i2s_capability()

vsf_i2s_capability_t vsf_i2s_capability

(

vsf_i2s_t *

i2s_ptr

)

get the capability of i2s instance.

Parameters

[in]

i2s_ptr

a pointer to structure vsf_i2s_t

Returns

vsf_i2s_capability_t: return all capability of current i2s vsf_i2s_capability_t