SMIX driver APIs

SMIX driver APIs. More...

Data Structures
struct	smix_dma_linked_descriptor_t
struct	smix_dma_ch_config_t
struct	smix_mixer_dst_config_t
struct	smix_mixer_source_config_t

Enumerations
enum	smix_dma_transfer_burst_t {   smix_dma_transfer_burst_1t = 0U , smix_dma_transfer_burst_2t = 1U , smix_dma_transfer_burst_4t = 2U , smix_dma_transfer_burst_8t = 3U ,   smix_dma_transfer_burst_16t = 4U , smix_dma_transfer_burst_32t = 5U , smix_dma_transfer_burst_64t = 6U , smix_dma_transfer_burst_128t = 7U }
enum	smix_dma_transfer_width_t { smix_dma_transfer_byte = 0U , smix_dma_transfer_half_word = 1U , smix_dma_transfer_word = 2U }
enum	smix_dma_address_control_t { smix_dma_address_increment = 0U , smix_dma_address_decrement = 1U , smix_dma_address_fixed = 2U }
enum	smix_dma_handshake_mode_t { smix_dma_mode_normal = 0 , smix_dma_mode_handshake = 1 }
enum	smix_dma_req_t {   smix_dma_req_i2s0_rx = 6 , smix_dma_req_i2s0_tx = 7 , smix_dma_req_i2s1_rx = 8 , smix_dma_req_i2s1_tx = 9 ,   smix_dma_req_i2s2_rx = 10 , smix_dma_req_i2s2_tx = 11 , smix_dma_req_i2s3_rx = 12 , smix_dma_req_i2s3_tx = 13 ,   smix_dma_req_mixer_src_ch0 = 16 , smix_dma_req_mixer_src_ch1 = 17 , smix_dma_req_mixer_src_ch2 = 18 , smix_dma_req_mixer_src_ch3 = 19 ,   smix_dma_req_mixer_src_ch4 = 20 , smix_dma_req_mixer_src_ch5 = 21 , smix_dma_req_mixer_src_ch6 = 22 , smix_dma_req_mixer_src_ch7 = 23 ,   smix_dma_req_mixer_src_ch8 = 24 , smix_dma_req_mixer_src_ch9 = 25 , smix_dma_req_mixer_src_ch10 = 26 , smix_dma_req_mixer_src_ch11 = 27 ,   smix_dma_req_mixer_src_ch12 = 28 , smix_dma_req_mixer_src_ch13 = 29 , smix_dma_req_mixer_dst_ch0 = 30 , smix_dma_req_mixer_dst_ch1 = 31 }
enum	smix_src_clk_source_t {   smix_src_clk_i2s0_bclk = 0 , smix_src_clk_i2s0_fclk = 1 , smix_src_clk_i2s0_mclk = 2 , smix_src_clk_i2s1_bclk = 3 ,   smix_src_clk_i2s1_fclk = 4 , smix_src_clk_i2s1_mclk = 5 , smix_src_clk_i2s2_bclk = 6 , smix_src_clk_i2s2_fclk = 7 ,   smix_src_clk_i2s2_mclk = 8 , smix_src_clk_i2s3_bclk = 9 , smix_src_clk_i2s3_fclk = 10 , smix_src_clk_i2s3_mclk = 11 ,   smix_src_clk_none = 15 }
enum	smix_mixer_gain_t {   smix_mixer_gain_decrease_12db = 0x400 , smix_mixer_gain_decrease_6db = 0x800 , smix_mixer_gain_0db = 0xfff , smix_mixer_gain_increase_6db = 0x1800 ,   smix_mixer_gain_increase_12db = 0x1fff }
enum	smix_mixer_rate_convert_t {   smix_mixer_no_rate_convert , smix_mixer_upper_2x_sample , smix_mixer_upper_3x_sample , smix_mixer_upper_4x_sample ,   smix_mixer_upper_6x_sample , smix_mixer_upper_8x_sample , smix_mixer_upper_12x_sample , smix_mixer_lower_2x_sample }

Functions
static bool	smix_dma_check_transfer_complete (SMIX_Type *ptr, uint8_t ch_index)
	smix dma check transfer complete status More...
static bool	smix_dma_check_transfer_abort (SMIX_Type *ptr, uint8_t ch_index)
	smix dma check transfer abort status More...
static bool	smix_dma_check_transfer_error (SMIX_Type *ptr, uint8_t ch_index)
	smix dma check transfer error status More...
static void	smix_mixer_dst_enable_source_channel (SMIX_Type *ptr, uint8_t dst_ch, uint32_t source_ch_mask)
	smix mixer enable source channel for dst More...
static void	smix_mixer_dst_disable_source_channel (SMIX_Type *ptr, uint8_t dst_ch, uint32_t source_ch_mask)
	smix mixer disable source channel for dst More...
static void	smix_mixer_dst_active_source_channel (SMIX_Type *ptr, uint8_t dst_ch, uint32_t source_ch_mask)
	smix mixer active source channel for dst More...
static void	smix_mixer_dst_deactive_source_channel (SMIX_Type *ptr, uint8_t dst_ch, uint32_t source_ch_mask)
	smix mixer deactive source channel for dst More...
static void	smix_mixer_dst_fadein_source_channel (SMIX_Type *ptr, uint8_t dst_ch, uint32_t source_ch_mask)
	smix mixer fadein source channel for dst More...
static void	smix_mixer_dst_fadeout_source_channel (SMIX_Type *ptr, uint8_t dst_ch, uint32_t source_ch_mask)
	smix mixer fadeout source channel for dst More...
static void	smix_mixer_dst_enable (SMIX_Type *ptr)
	smix mixer enable dst channel More...
static void	smix_mixer_dst_disable (SMIX_Type *ptr)
	smix mixer disable dst channel More...
static uint32_t	smix_mixer_get_calsat_status (SMIX_Type *ptr)
	smix mixer get calculate saturation register value More...
static bool	smix_mixer_check_dst_cal_saturation_error (SMIX_Type *ptr, uint8_t dst_ch)
	smix mixer check dst channel calculate saturation error More...
static bool	smix_mixer_check_source_cal_saturation_error (SMIX_Type *ptr, uint8_t source_ch)
	smix mixer check source channel calculate saturation error More...
static bool	smix_mixer_check_dst_data_underflew (SMIX_Type *ptr, uint8_t dst_ch)
	smix mixer check dst channel data ubderflew More...
static bool	smix_mixer_check_dst_data_available (SMIX_Type *ptr, uint8_t dst_ch)
	smix mixer check dst channel data available More...
static bool	smix_mixer_check_source_data_needed (SMIX_Type *ptr, uint8_t source_ch)
	smix mixer check source channel data available More...
hpm_stat_t	smix_mixer_config_dst_fadein_delta (SMIX_Type *ptr, uint8_t ch, uint32_t target_sample_rate, uint32_t ms)
	smix mixer config dst channel fadein delta More...
hpm_stat_t	smix_mixer_config_dst_fadeout_delta (SMIX_Type *ptr, uint8_t ch, uint32_t target_sample_rate, uint32_t ms)
	smix mixer config dst channel fadeout delta More...
hpm_stat_t	smix_mixer_config_source_fadein_delta (SMIX_Type *ptr, uint8_t ch, uint32_t target_sample_rate, uint32_t ms)
	smix mixer config source channel fadein delta More...
hpm_stat_t	smix_mixer_config_source_fadeout_delta (SMIX_Type *ptr, uint8_t ch, uint32_t target_sample_rate, uint32_t ms)
	smix mixer config source channel fadeout delta More...
void	smix_get_dma_default_ch_config (SMIX_Type *ptr, smix_dma_ch_config_t *config)
	smix get dma channel default config More...
void	smix_get_mixer_dst_ch_default_config (SMIX_Type *ptr, smix_mixer_dst_config_t *config)
	smix get dst channel default config More...
void	smix_get_mixer_source_ch_default_config (SMIX_Type *ptr, smix_mixer_source_config_t *config)
	smix get source channel default config More...
hpm_stat_t	smix_config_dma_channel (SMIX_Type *ptr, uint8_t ch, smix_dma_ch_config_t *config, bool start)
	smix config dma channel More...
hpm_stat_t	smix_mixer_config_source_ch (SMIX_Type *ptr, uint8_t ch, smix_mixer_source_config_t *src)
	smix mixer config source channel More...
hpm_stat_t	smix_mixer_config_dst_ch (SMIX_Type *ptr, uint8_t ch, smix_mixer_dst_config_t *dst)
	smix mixer config dst channel More...

Detailed Description

SMIX driver APIs.

Enumeration Type Documentation

smix_dma_address_control_t

enum smix_dma_address_control_t

#include <drivers/inc/hpm_smix_drv.h>

Enumerator
smix_dma_address_increment
smix_dma_address_decrement
smix_dma_address_fixed

smix_dma_handshake_mode_t

enum smix_dma_handshake_mode_t

#include <drivers/inc/hpm_smix_drv.h>

Enumerator
smix_dma_mode_normal
smix_dma_mode_handshake

smix_dma_req_t

enum smix_dma_req_t

#include <drivers/inc/hpm_smix_drv.h>

Enumerator
smix_dma_req_i2s0_rx
smix_dma_req_i2s0_tx
smix_dma_req_i2s1_rx
smix_dma_req_i2s1_tx
smix_dma_req_i2s2_rx
smix_dma_req_i2s2_tx
smix_dma_req_i2s3_rx
smix_dma_req_i2s3_tx
smix_dma_req_mixer_src_ch0
smix_dma_req_mixer_src_ch1
smix_dma_req_mixer_src_ch2
smix_dma_req_mixer_src_ch3
smix_dma_req_mixer_src_ch4
smix_dma_req_mixer_src_ch5
smix_dma_req_mixer_src_ch6
smix_dma_req_mixer_src_ch7
smix_dma_req_mixer_src_ch8
smix_dma_req_mixer_src_ch9
smix_dma_req_mixer_src_ch10
smix_dma_req_mixer_src_ch11
smix_dma_req_mixer_src_ch12
smix_dma_req_mixer_src_ch13
smix_dma_req_mixer_dst_ch0
smix_dma_req_mixer_dst_ch1

smix_dma_transfer_burst_t

enum smix_dma_transfer_burst_t

#include <drivers/inc/hpm_smix_drv.h>

Enumerator
smix_dma_transfer_burst_1t
smix_dma_transfer_burst_2t
smix_dma_transfer_burst_4t
smix_dma_transfer_burst_8t
smix_dma_transfer_burst_16t
smix_dma_transfer_burst_32t
smix_dma_transfer_burst_64t
smix_dma_transfer_burst_128t

smix_dma_transfer_width_t

enum smix_dma_transfer_width_t

#include <drivers/inc/hpm_smix_drv.h>

Enumerator
smix_dma_transfer_byte
smix_dma_transfer_half_word
smix_dma_transfer_word

smix_mixer_gain_t

enum smix_mixer_gain_t

#include <drivers/inc/hpm_smix_drv.h>

Enumerator
smix_mixer_gain_decrease_12db
smix_mixer_gain_decrease_6db
smix_mixer_gain_0db
smix_mixer_gain_increase_6db
smix_mixer_gain_increase_12db

smix_mixer_rate_convert_t

enum smix_mixer_rate_convert_t

#include <drivers/inc/hpm_smix_drv.h>

Enumerator
smix_mixer_no_rate_convert
smix_mixer_upper_2x_sample
smix_mixer_upper_3x_sample
smix_mixer_upper_4x_sample
smix_mixer_upper_6x_sample
smix_mixer_upper_8x_sample
smix_mixer_upper_12x_sample
smix_mixer_lower_2x_sample

smix_src_clk_source_t

enum smix_src_clk_source_t

#include <drivers/inc/hpm_smix_drv.h>

Enumerator
smix_src_clk_i2s0_bclk
smix_src_clk_i2s0_fclk
smix_src_clk_i2s0_mclk
smix_src_clk_i2s1_bclk
smix_src_clk_i2s1_fclk
smix_src_clk_i2s1_mclk
smix_src_clk_i2s2_bclk
smix_src_clk_i2s2_fclk
smix_src_clk_i2s2_mclk
smix_src_clk_i2s3_bclk
smix_src_clk_i2s3_fclk
smix_src_clk_i2s3_mclk
smix_src_clk_none

Function Documentation

smix_config_dma_channel()

hpm_stat_t smix_config_dma_channel	(	SMIX_Type *	ptr,
		uint8_t	ch,
		smix_dma_ch_config_t *	config,
		bool	start
	)

#include <drivers/inc/hpm_smix_drv.h>

smix config dma channel

Parameters

[in]	ptr	SMIX base address
[in]	ch	dma channel
[in]	config	smix_dma_ch_config_t
[in]	start	true for start dma

Return values

status_success

if no error occurs

smix_dma_check_transfer_abort()

static bool smix_dma_check_transfer_abort ( SMIX_Type *  ptr, uint8_t  ch_index  )

inlinestatic

#include <drivers/inc/hpm_smix_drv.h>

smix dma check transfer abort status

Parameters

[in]	ptr	SMIX base address
[in]	ch_index	dma channel

Return values

true	for transfer abort

smix_dma_check_transfer_complete()

static bool smix_dma_check_transfer_complete ( SMIX_Type *  ptr, uint8_t  ch_index  )

inlinestatic

#include <drivers/inc/hpm_smix_drv.h>

smix dma check transfer complete status

Parameters

[in]	ptr	SMIX base address
[in]	ch_index	dma channel

Return values

true	for transfer complete

smix_dma_check_transfer_error()

static bool smix_dma_check_transfer_error ( SMIX_Type *  ptr, uint8_t  ch_index  )

inlinestatic

#include <drivers/inc/hpm_smix_drv.h>

smix dma check transfer error status

Parameters

[in]	ptr	SMIX base address
[in]	ch_index	dma channel

Return values

true	for transfer error

smix_get_dma_default_ch_config()

void smix_get_dma_default_ch_config	(	SMIX_Type *	ptr,
		smix_dma_ch_config_t *	config
	)

#include <drivers/inc/hpm_smix_drv.h>

smix get dma channel default config

Parameters

[in]	ptr	SMIX base address
[in]	config	smix_dma_ch_config_t

smix_get_mixer_dst_ch_default_config()

void smix_get_mixer_dst_ch_default_config	(	SMIX_Type *	ptr,
		smix_mixer_dst_config_t *	config
	)

#include <drivers/inc/hpm_smix_drv.h>

smix get dst channel default config

Parameters

[in]	ptr	SMIX base address
[in]	config	smix_mixer_dst_config_t

smix_get_mixer_source_ch_default_config()

void smix_get_mixer_source_ch_default_config	(	SMIX_Type *	ptr,
		smix_mixer_source_config_t *	config
	)

#include <drivers/inc/hpm_smix_drv.h>

smix get source channel default config

Parameters

[in]	ptr	SMIX base address
[in]	config	smix_mixer_source_config_t

smix_mixer_check_dst_cal_saturation_error()

static bool smix_mixer_check_dst_cal_saturation_error ( SMIX_Type *  ptr, uint8_t  dst_ch  )

inlinestatic

#include <drivers/inc/hpm_smix_drv.h>

smix mixer check dst channel calculate saturation error

Parameters

[in]	ptr	SMIX base address
[in]	dst_ch	dst channel

Return values

true	for calculate saturation error occurred

smix_mixer_check_dst_data_available()

static bool smix_mixer_check_dst_data_available ( SMIX_Type *  ptr, uint8_t  dst_ch  )

inlinestatic

#include <drivers/inc/hpm_smix_drv.h>

smix mixer check dst channel data available

Parameters

[in]	ptr	SMIX base address
[in]	dst_ch	dst channel

Return values

true	for data available

smix_mixer_check_dst_data_underflew()

static bool smix_mixer_check_dst_data_underflew ( SMIX_Type *  ptr, uint8_t  dst_ch  )

inlinestatic

#include <drivers/inc/hpm_smix_drv.h>

smix mixer check dst channel data ubderflew

Parameters

[in]	ptr	SMIX base address
[in]	dst_ch	dst channel

Return values

true	for data underflew

smix_mixer_check_source_cal_saturation_error()

static bool smix_mixer_check_source_cal_saturation_error ( SMIX_Type *  ptr, uint8_t  source_ch  )

inlinestatic

#include <drivers/inc/hpm_smix_drv.h>

smix mixer check source channel calculate saturation error

Parameters

[in]	ptr	SMIX base address
[in]	source_ch	source channel

Return values

true	for calculate saturation error occurred

smix_mixer_check_source_data_needed()

static bool smix_mixer_check_source_data_needed ( SMIX_Type *  ptr, uint8_t  source_ch  )

inlinestatic

#include <drivers/inc/hpm_smix_drv.h>

smix mixer check source channel data available

Parameters

[in]	ptr	SMIX base address
[in]	source_ch	source channel

Return values

true	for source channel need new data

smix_mixer_config_dst_ch()

hpm_stat_t smix_mixer_config_dst_ch	(	SMIX_Type *	ptr,
		uint8_t	ch,
		smix_mixer_dst_config_t *	dst
	)

#include <drivers/inc/hpm_smix_drv.h>

smix mixer config dst channel

Parameters

[in]	ptr	SMIX base address
[in]	ch	dst channel
[in]	dst	smix_mixer_dst_config_t

Return values

status_success

if no error occurs

smix_mixer_config_dst_fadein_delta()

hpm_stat_t smix_mixer_config_dst_fadein_delta	(	SMIX_Type *	ptr,
		uint8_t	ch,
		uint32_t	target_sample_rate,
		uint32_t	ms
	)

#include <drivers/inc/hpm_smix_drv.h>

smix mixer config dst channel fadein delta

Parameters

[in]	ptr	SMIX base address
[in]	ch	dst channel
[in]	target_sample_rate	target sample rate
[in]	ms	fadein consumed time in ms

Return values

status_success

if no error occurs

smix_mixer_config_dst_fadeout_delta()

hpm_stat_t smix_mixer_config_dst_fadeout_delta	(	SMIX_Type *	ptr,
		uint8_t	ch,
		uint32_t	target_sample_rate,
		uint32_t	ms
	)

#include <drivers/inc/hpm_smix_drv.h>

smix mixer config dst channel fadeout delta

Parameters

[in]	ptr	SMIX base address
[in]	ch	dst channel
[in]	target_sample_rate	target sample rate
[in]	ms	fadeout consumed time in ms

Return values

status_success

if no error occurs

smix_mixer_config_source_ch()

hpm_stat_t smix_mixer_config_source_ch	(	SMIX_Type *	ptr,
		uint8_t	ch,
		smix_mixer_source_config_t *	src
	)

#include <drivers/inc/hpm_smix_drv.h>

smix mixer config source channel

Parameters

[in]	ptr	SMIX base address
[in]	ch	source channel
[in]	src	smix_mixer_source_config_t

Return values

status_success

if no error occurs

smix_mixer_config_source_fadein_delta()

hpm_stat_t smix_mixer_config_source_fadein_delta	(	SMIX_Type *	ptr,
		uint8_t	ch,
		uint32_t	target_sample_rate,
		uint32_t	ms
	)

#include <drivers/inc/hpm_smix_drv.h>

smix mixer config source channel fadein delta

Parameters

[in]	ptr	SMIX base address
[in]	ch	source channel
[in]	target_sample_rate	target sample rate
[in]	ms	fadein consumed time in ms

Return values

status_success

if no error occurs

smix_mixer_config_source_fadeout_delta()

hpm_stat_t smix_mixer_config_source_fadeout_delta	(	SMIX_Type *	ptr,
		uint8_t	ch,
		uint32_t	target_sample_rate,
		uint32_t	ms
	)

#include <drivers/inc/hpm_smix_drv.h>

smix mixer config source channel fadeout delta

Parameters

[in]	ptr	SMIX base address
[in]	ch	source channel
[in]	target_sample_rate	target sample rate
[in]	ms	fadeout consumed time in ms

Return values

status_success

if no error occurs

smix_mixer_dst_active_source_channel()

static void smix_mixer_dst_active_source_channel ( SMIX_Type *  ptr, uint8_t  dst_ch, uint32_t  source_ch_mask  )

inlinestatic

#include <drivers/inc/hpm_smix_drv.h>

smix mixer active source channel for dst

Parameters

[in]	ptr	SMIX base address
[in]	dst_ch	dst channel
[in]	source_ch_mask	source channel mask

smix_mixer_dst_deactive_source_channel()

static void smix_mixer_dst_deactive_source_channel ( SMIX_Type *  ptr, uint8_t  dst_ch, uint32_t  source_ch_mask  )

inlinestatic

#include <drivers/inc/hpm_smix_drv.h>

smix mixer deactive source channel for dst

Parameters

[in]	ptr	SMIX base address
[in]	dst_ch	dst channel
[in]	source_ch_mask	source channel mask

smix_mixer_dst_disable()

static void smix_mixer_dst_disable ( SMIX_Type *  ptr )

inlinestatic

#include <drivers/inc/hpm_smix_drv.h>

smix mixer disable dst channel

Parameters

[in]

ptr

SMIX base address

Note

two dst channel share same enable bit in DST_CH[0].CTRL.MIXER_EN, DST_CH[1].CTRL.MIXER_EN should not be set

smix_mixer_dst_disable_source_channel()

static void smix_mixer_dst_disable_source_channel ( SMIX_Type *  ptr, uint8_t  dst_ch, uint32_t  source_ch_mask  )

inlinestatic

#include <drivers/inc/hpm_smix_drv.h>

smix mixer disable source channel for dst

Parameters

[in]	ptr	SMIX base address
[in]	dst_ch	dst channel
[in]	source_ch_mask	source channel mask

smix_mixer_dst_enable()

static void smix_mixer_dst_enable ( SMIX_Type *  ptr )

inlinestatic

#include <drivers/inc/hpm_smix_drv.h>

smix mixer enable dst channel

Parameters

[in]

ptr

SMIX base address

Note

two dst channel share same enable bit in DST_CH[0].CTRL.MIXER_EN, DST_CH[1].CTRL.MIXER_EN should not be set

smix_mixer_dst_enable_source_channel()

static void smix_mixer_dst_enable_source_channel ( SMIX_Type *  ptr, uint8_t  dst_ch, uint32_t  source_ch_mask  )

inlinestatic

#include <drivers/inc/hpm_smix_drv.h>

smix mixer enable source channel for dst

Parameters

[in]	ptr	SMIX base address
[in]	dst_ch	dst channel
[in]	source_ch_mask	source channel mask

smix_mixer_dst_fadein_source_channel()

static void smix_mixer_dst_fadein_source_channel ( SMIX_Type *  ptr, uint8_t  dst_ch, uint32_t  source_ch_mask  )

inlinestatic

#include <drivers/inc/hpm_smix_drv.h>

smix mixer fadein source channel for dst

Parameters

[in]	ptr	SMIX base address
[in]	dst_ch	dst channel
[in]	source_ch_mask	source channel mask

smix_mixer_dst_fadeout_source_channel()

static void smix_mixer_dst_fadeout_source_channel ( SMIX_Type *  ptr, uint8_t  dst_ch, uint32_t  source_ch_mask  )

inlinestatic

#include <drivers/inc/hpm_smix_drv.h>

smix mixer fadeout source channel for dst

Parameters

[in]	ptr	SMIX base address
[in]	dst_ch	dst channel
[in]	source_ch_mask	source channel mask

smix_mixer_get_calsat_status()

static uint32_t smix_mixer_get_calsat_status ( SMIX_Type *  ptr )

inlinestatic

#include <drivers/inc/hpm_smix_drv.h>

smix mixer get calculate saturation register value

Parameters

[in]

ptr

SMIX base address

Return values

calculate

saturation register value