vs1053b basic driver modules More...

Collaboration diagram for vs1053b basic driver function:

Data Structures
struct	vs1053b_audio_info_s
	vs1053b audio info structure definition More...
struct	vs1053b_wav_s
	vs1053b wav structure definition More...
struct	vs1053b_handle_s
	vs1053b handle structure definition More...
struct	vs1053b_info_s
	vs1053b information structure definition More...

Macros
#define	VS1053B_BUFFER_SIZE 512 /* 512 bytes */
	vs1053b buffer size definition
#define	VS1053B_OGG_VENC08K1Q00 0
	check buffer size valid
#define	VS1053B_OGG_VENC08K1Q01 0
	vs1053b venc08k1q01 definition
#define	VS1053B_OGG_VENC08K1Q02 0
	vs1053b venc08k1q02 definition
#define	VS1053B_OGG_VENC08K1Q03 0
	vs1053b venc08k1q03 definition
#define	VS1053B_OGG_VENC08K1Q04 0
	vs1053b venc08k1q04 definition
#define	VS1053B_OGG_VENC08K1Q05 0
	vs1053b venc08k1q05 definition
#define	VS1053B_OGG_VENC08K1Q06 0
	vs1053b venc08k1q06 definition
#define	VS1053B_OGG_VENC08K1Q07 0
	vs1053b venc08k1q07 definition
#define	VS1053B_OGG_VENC08K1Q08 0
	vs1053b venc08k1q08 definition
#define	VS1053B_OGG_VENC08K1Q09 0
	vs1053b venc08k1q09 definition
#define	VS1053B_OGG_VENC08K1Q10 0
	vs1053b venc08k1q10 definition
#define	VS1053B_OGG_VENC16K1Q00 0
	vs1053b venc16k1q00 definition
#define	VS1053B_OGG_VENC16K1Q01 0
	vs1053b venc16k1q01 definition
#define	VS1053B_OGG_VENC16K1Q02 0
	vs1053b venc16k1q02 definition
#define	VS1053B_OGG_VENC16K1Q03 0
	vs1053b venc16k1q03 definition
#define	VS1053B_OGG_VENC16K1Q04 0
	vs1053b venc16k1q04 definition
#define	VS1053B_OGG_VENC16K1Q05 0
	vs1053b venc16k1q05 definition
#define	VS1053B_OGG_VENC16K1Q06 0
	vs1053b venc16k1q06 definition
#define	VS1053B_OGG_VENC16K1Q07 0
	vs1053b venc16k1q07 definition
#define	VS1053B_OGG_VENC16K1Q08 0
	vs1053b venc16k1q08 definition
#define	VS1053B_OGG_VENC16K1Q09 0
	vs1053b venc16k1q09 definition
#define	VS1053B_OGG_VENC16K1Q10 0
	vs1053b venc16k1q10 definition
#define	VS1053B_OGG_VENC16K2Q00 0
	vs1053b venc16k2q00 definition
#define	VS1053B_OGG_VENC16K2Q01 0
	vs1053b venc16k2q01 definition
#define	VS1053B_OGG_VENC16K2Q02 0
	vs1053b venc16k2q02 definition
#define	VS1053B_OGG_VENC16K2Q03 0
	vs1053b venc16k2q03 definition
#define	VS1053B_OGG_VENC16K2Q04 0
	vs1053b venc16k2q04 definition
#define	VS1053B_OGG_VENC16K2Q05 0
	vs1053b venc16k2q05 definition
#define	VS1053B_OGG_VENC16K2Q06 0
	vs1053b venc16k2q06 definition
#define	VS1053B_OGG_VENC16K2Q07 0
	vs1053b venc16k2q07 definition
#define	VS1053B_OGG_VENC16K2Q08 0
	vs1053b venc16k2q08 definition
#define	VS1053B_OGG_VENC16K2Q09 0
	vs1053b venc16k2q09 definition
#define	VS1053B_OGG_VENC16K2Q10 0
	vs1053b venc16k2q10 definition
#define	VS1053B_OGG_VENC44K1Q00 0
	vs1053b venc44k1q00 definition
#define	VS1053B_OGG_VENC44K1Q01 0
	vs1053b venc44k1q01 definition
#define	VS1053B_OGG_VENC44K1Q02 0
	vs1053b venc44k1q02 definition
#define	VS1053B_OGG_VENC44K1Q03 0
	vs1053b venc44k1q03 definition
#define	VS1053B_OGG_VENC44K1Q04 0
	vs1053b venc44k1q04 definition
#define	VS1053B_OGG_VENC44K1Q05 0
	vs1053b venc44k1q05 definition
#define	VS1053B_OGG_VENC44K2Q00 0
	vs1053b venc44k2q00 definition
#define	VS1053B_OGG_VENC44K2Q01 0
	vs1053b venc44k2q01 definition
#define	VS1053B_OGG_VENC44K2Q02 0
	vs1053b venc44k2q02 definition
#define	VS1053B_OGG_VENC44K2Q03 0
	vs1053b venc44k2q03 definition
#define	VS1053B_OGG_VENC44K2Q04 0
	vs1053b venc44k2q04 definition
#define	VS1053B_OGG_VENC44K2Q05 1
	vs1053b venc44k2q05 definition
#define	VS1053B_AICTRL3_MODE_IMA ADPCM (0 << 2)
	aictrl3 control definition
#define	VS1053B_AICTRL3_MODE_LINEAR_PCM (1 << 2)
#define	VS1053B_AICTRL3_ADC_JOINT_STEREO (0 << 0)
#define	VS1053B_AICTRL3_ADC_DUAL_CHANNEL (1 << 0)
#define	VS1053B_AICTRL3_ADC_LEFT_CHANNEL (2 << 0)
#define	VS1053B_AICTRL3_ADC_RIGHT_CHANNEL (3 << 0)

Typedefs
typedef struct vs1053b_audio_info_s	vs1053b_audio_info_t
	vs1053b audio info structure definition
typedef struct vs1053b_wav_s	vs1053b_wav_t
	vs1053b wav structure definition
typedef struct vs1053b_handle_s	vs1053b_handle_t
	vs1053b handle structure definition
typedef struct vs1053b_info_s	vs1053b_info_t
	vs1053b information structure definition

Enumerations
enum	vs1053b_bool_t { VS1053B_BOOL_FALSE = 0x00 , VS1053B_BOOL_TRUE = 0x01 }
	vs1053b bool enumeration definition More...
enum	vs1053b_clock_range_t { VS1053B_CLOCK_RANGE_12MHZ_13MHZ = 0x00 , VS1053B_CLOCK_RANGE_24MHZ_26MHZ = 0x01 }
	vs1053b clock range enumeration definition More...
enum	vs1053b_selector_t { VS1053B_SELECTOR_MICP = 0x00 , VS1053B_SELECTOR_LINE1 = 0x01 }
	vs1053b selector enumeration definition More...
enum	vs1053b_bit_order_t { VS1053B_BIT_ORDER_MSB_FIRST = 0x00 , VS1053B_BIT_ORDER_MSB_LAST = 0x01 }
	vs1053b bit order enumeration definition More...
enum	vs1053b_dclk_edge_t { VS1053B_DCLK_EDGE_RISING = 0x00 , VS1053B_DCLK_EDGE_FALLING = 0x01 }
	vs1053b dclk edge enumeration definition More...
enum	vs1053b_diff_t { VS1053B_DIFF_NORMAL = 0x00 , VS1053B_DIFF_LEFT_INVERTED = 0x01 }
	vs1053b diff enumeration definition More...
enum	vs1053b_ad_clock_t { VS1053B_AD_CLOCK_6MHZ = 0x00 , VS1053B_AD_CLCOK_3MHZ = 0x01 }
	vs1053b ad clock enumeration definition More...
enum	vs1053b_reference_voltage_t { VS1053B_REFERENCE_VOLTAGE_1P23V = 0x00 , VS1053B_REFERENCE_VOLTAGE_1P65V = 0x01 }
	vs1053b reference voltage enumeration definition More...
enum	vs1053b_clock_multiplier_t { VS1053B_CLOCK_MULTIPLIER_1P0_XTALI = 0x00 , VS1053B_CLOCK_MULTIPLIER_2P0_XTALI = 0x01 , VS1053B_CLOCK_MULTIPLIER_2P5_XTALI = 0x02 , VS1053B_CLOCK_MULTIPLIER_3P0_XTALI = 0x03 , VS1053B_CLOCK_MULTIPLIER_3P5_XTALI = 0x04 , VS1053B_CLOCK_MULTIPLIER_4P0_XTALI = 0x05 , VS1053B_CLOCK_MULTIPLIER_4P5_XTALI = 0x06 , VS1053B_CLOCK_MULTIPLIER_5P0_XTALI = 0x07 }
	vs1053b clock multiplier enumeration definition More...
enum	vs1053b_allowed_multiplier_addition_t { VS1053B_ALLOWED_MULTIPLIER_ADDITION_NONE = 0x00 , VS1053B_ALLOWED_MULTIPLIER_ADDITION_1P0_XTALI = 0x01 , VS1053B_ALLOWED_MULTIPLIER_ADDITION_1P5_XTALI = 0x02 , VS1053B_ALLOWED_MULTIPLIER_ADDITION_2P0_XTALI = 0x03 }
	vs1053b allowed multiplier addition enumeration definition More...
enum	vs1053b_channel_t { VS1053B_CHANNEL_MONO = 0x00 , VS1053B_CHANNEL_STEREO = 0x01 }
	vs1053b channel enumeration definition More...
enum	vs1053b_application_t { VS1053B_APPLICATION_0 = 0x00 , VS1053B_APPLICATION_1 = 0x01 , VS1053B_APPLICATION_2 = 0x02 , VS1053B_APPLICATION_3 = 0x03 }
	vs1053b application enumeration definition More...
enum	vs1053b_play_speed_t { VS1053B_PLAY_SPEED_1_X = 0x00 , VS1053B_PLAY_SPEED_1P0_X = 0x01 , VS1053B_PLAY_SPEED_2P0_X = 0x02 , VS1053B_PLAY_SPEED_3P0_X = 0x03 }
	vs1053b play speed enumeration definition More...
enum	vs1053b_type_t { VS1053B_TYPE_PLAY_READ = 0x00 , VS1053B_TYPE_PLAY_WRITE = 0x01 , VS1053B_TYPE_PLAY_END = 0x02 , VS1053B_TYPE_RECORD_READ = 0x03 , VS1053B_TYPE_RECORD_WRITE = 0x04 , VS1053B_TYPE_RECORD_END = 0x05 , VS1053B_TYPE_RECORD_OVER = 0x06 , VS1053B_TYPE_PERIOD = 0x07 }
	vs1053b type enumeration definition More...
enum	vs1053b_format_t { VS1053B_FORMAT_WAV = 0x7665 , VS1053B_FORMAT_MIDI = 0X4D54 , VS1053B_FORMAT_AAC_ADTS = 0X4154 , VS1053B_FORMAT_AAC_ADIF = 0X4144 , VS1053B_FORMAT_AAC_MP4 = 0X4D34 , VS1053B_FORMAT_OGG = 0X4F67 , VS1053B_FORMAT_WMA = 0X574D , VS1053B_FORMAT_FLAC = 0X664C , VS1053B_FORMAT_MP3 = 0xFFE0 }
	vs1053b format enumeration definition More...
enum	vs1053b_patch_t { VS1053B_PATCH_FLAC = 0x00 , VS1053B_PATCH_WAV = 0x01 , VS1053B_PATCH_OGG_VENC08K1Q00 = 0x02 , VS1053B_PATCH_OGG_VENC08K1Q01 = 0x03 , VS1053B_PATCH_OGG_VENC08K1Q02 = 0x04 , VS1053B_PATCH_OGG_VENC08K1Q03 = 0x05 , VS1053B_PATCH_OGG_VENC08K1Q04 = 0x06 , VS1053B_PATCH_OGG_VENC08K1Q05 = 0x07 , VS1053B_PATCH_OGG_VENC08K1Q06 = 0x08 , VS1053B_PATCH_OGG_VENC08K1Q07 = 0x09 , VS1053B_PATCH_OGG_VENC08K1Q08 = 0x0A , VS1053B_PATCH_OGG_VENC08K1Q09 = 0x0B , VS1053B_PATCH_OGG_VENC08K1Q10 = 0x0C , VS1053B_PATCH_OGG_VENC16K1Q00 = 0x0D , VS1053B_PATCH_OGG_VENC16K1Q01 = 0x0E , VS1053B_PATCH_OGG_VENC16K1Q02 = 0x0F , VS1053B_PATCH_OGG_VENC16K1Q03 = 0x10 , VS1053B_PATCH_OGG_VENC16K1Q04 = 0x11 , VS1053B_PATCH_OGG_VENC16K1Q05 = 0x12 , VS1053B_PATCH_OGG_VENC16K1Q06 = 0x13 , VS1053B_PATCH_OGG_VENC16K1Q07 = 0x14 , VS1053B_PATCH_OGG_VENC16K1Q08 = 0x15 , VS1053B_PATCH_OGG_VENC16K1Q09 = 0x16 , VS1053B_PATCH_OGG_VENC16K1Q10 = 0x17 , VS1053B_PATCH_OGG_VENC16K2Q00 = 0x18 , VS1053B_PATCH_OGG_VENC16K2Q01 = 0x19 , VS1053B_PATCH_OGG_VENC16K2Q02 = 0x1A , VS1053B_PATCH_OGG_VENC16K2Q03 = 0x1B , VS1053B_PATCH_OGG_VENC16K2Q04 = 0x1C , VS1053B_PATCH_OGG_VENC16K2Q05 = 0x1D , VS1053B_PATCH_OGG_VENC16K2Q06 = 0x1E , VS1053B_PATCH_OGG_VENC16K2Q07 = 0x1F , VS1053B_PATCH_OGG_VENC16K2Q08 = 0x20 , VS1053B_PATCH_OGG_VENC16K2Q09 = 0x21 , VS1053B_PATCH_OGG_VENC16K2Q10 = 0x22 , VS1053B_PATCH_OGG_VENC44K1Q00 = 0x23 , VS1053B_PATCH_OGG_VENC44K1Q01 = 0x24 , VS1053B_PATCH_OGG_VENC44K1Q02 = 0x25 , VS1053B_PATCH_OGG_VENC44K1Q03 = 0x26 , VS1053B_PATCH_OGG_VENC44K1Q04 = 0x27 , VS1053B_PATCH_OGG_VENC44K1Q05 = 0x28 , VS1053B_PATCH_OGG_VENC44K2Q00 = 0x29 , VS1053B_PATCH_OGG_VENC44K2Q01 = 0x2A , VS1053B_PATCH_OGG_VENC44K2Q02 = 0x2B , VS1053B_PATCH_OGG_VENC44K2Q03 = 0x2C , VS1053B_PATCH_OGG_VENC44K2Q04 = 0x2D , VS1053B_PATCH_OGG_VENC44K2Q05 = 0x2E }
	vs1053b patch enumeration definition More...
enum	vs1053b_iis_rate_t { VS1053B_IIS_RATE_48KHZ = 0x00 , VS1053B_IIS_RATE_96KHZ = 0x01 , VS1053B_IIS_RATE_192KHZ = 0x02 }
	vs1053b iis rate enumeration definition More...
enum	vs1053b_record_format_t { VS1053B_RECORD_FORMAT_WAV = 0x00 , VS1053B_RECORD_FORMAT_OGG = 0x01 }
	vs1053b record format enumeration definition More...

Functions
uint8_t	vs1053b_info (vs1053b_info_t *info)
	get chip's information
uint8_t	vs1053b_init (vs1053b_handle_t *handle)
	initialize the chip
uint8_t	vs1053b_deinit (vs1053b_handle_t *handle)
	deinit the chip
uint8_t	vs1053b_play (vs1053b_handle_t handle, char path)
	play audio
uint8_t	vs1053b_record (vs1053b_handle_t handle, char path, uint32_t sample_rate)
	record audio
uint8_t	vs1053b_set_record_format (vs1053b_handle_t *handle, vs1053b_record_format_t format)
	set record format
uint8_t	vs1053b_get_record_format (vs1053b_handle_t handle, vs1053b_record_format_t format)
	get record format
uint8_t	vs1053b_pause (vs1053b_handle_t *handle)
	pause audio
uint8_t	vs1053b_stop (vs1053b_handle_t *handle)
	stop audio
uint8_t	vs1053b_process (vs1053b_handle_t *handle)
	audio process
uint8_t	vs1053b_set_period_callback (vs1053b_handle_t *handle, uint32_t second, uint32_t microsecond, vs1053b_bool_t enable)
	set period callback
uint8_t	vs1053b_get_period_callback (vs1053b_handle_t handle, uint32_t second, uint32_t microsecond, vs1053b_bool_t enable)
	get period callback
uint8_t	vs1053b_parse_info (vs1053b_handle_t handle, uint16_t dat0, uint16_t dat1, vs1053b_audio_info_t info)
	parse info
uint8_t	vs1053b_hard_reset (vs1053b_handle_t *handle)
	hard reset
uint8_t	vs1053b_set_diff (vs1053b_handle_t *handle, vs1053b_diff_t diff)
	set the audio differential
uint8_t	vs1053b_get_diff (vs1053b_handle_t handle, vs1053b_diff_t diff)
	get the audio differential
uint8_t	vs1053b_set_mpeg_layer_i_and_ii (vs1053b_handle_t *handle, vs1053b_bool_t enable)
	enable or disable mpeg layer i and ii
uint8_t	vs1053b_get_mpeg_layer_i_and_ii (vs1053b_handle_t handle, vs1053b_bool_t enable)
	get mpeg layer i and ii status
uint8_t	vs1053b_set_soft_reset (vs1053b_handle_t *handle, vs1053b_bool_t enable)
	enable or disable soft reset
uint8_t	vs1053b_get_soft_reset (vs1053b_handle_t handle, vs1053b_bool_t enable)
	get soft reset status
uint8_t	vs1053b_set_cancel_decoding_current_file (vs1053b_handle_t *handle, vs1053b_bool_t enable)
	enable or disable cancel decoding current file
uint8_t	vs1053b_get_cancel_decoding_current_file (vs1053b_handle_t handle, vs1053b_bool_t enable)
	get cancel decoding current file status
uint8_t	vs1053b_set_ear_speaker_low_setting (vs1053b_handle_t *handle, vs1053b_bool_t enable)
	enable or disable ear speaker low setting
uint8_t	vs1053b_get_ear_speaker_low_setting (vs1053b_handle_t handle, vs1053b_bool_t enable)
	get ear speaker low setting status
uint8_t	vs1053b_set_allow_sdi_test (vs1053b_handle_t *handle, vs1053b_bool_t enable)
	enable or disable allow sdi test
uint8_t	vs1053b_get_allow_sdi_test (vs1053b_handle_t handle, vs1053b_bool_t enable)
	get allow sdi test status
uint8_t	vs1053b_set_stream_mode (vs1053b_handle_t *handle, vs1053b_bool_t enable)
	enable or disable stream mode
uint8_t	vs1053b_get_stream_mode (vs1053b_handle_t handle, vs1053b_bool_t enable)
	get stream mode status
uint8_t	vs1053b_set_ear_speaker_high_setting (vs1053b_handle_t *handle, vs1053b_bool_t enable)
	enable or disable ear speaker high setting
uint8_t	vs1053b_get_ear_speaker_high_setting (vs1053b_handle_t handle, vs1053b_bool_t enable)
	get ear speaker high setting status
uint8_t	vs1053b_set_dclk_edge (vs1053b_handle_t *handle, vs1053b_dclk_edge_t edge)
	set dclk edge
uint8_t	vs1053b_get_dclk_edge (vs1053b_handle_t handle, vs1053b_dclk_edge_t edge)
	get dclk edge
uint8_t	vs1053b_set_sdi_bit_order (vs1053b_handle_t *handle, vs1053b_bit_order_t order)
	set sdi bit order
uint8_t	vs1053b_get_sdi_bit_order (vs1053b_handle_t handle, vs1053b_bit_order_t order)
	get sdi bit order
uint8_t	vs1053b_set_share_spi_chip_select (vs1053b_handle_t *handle, vs1053b_bool_t enable)
	enable or disable share spi chip select
uint8_t	vs1053b_get_share_spi_chip_select (vs1053b_handle_t handle, vs1053b_bool_t enable)
	get share spi chip select status
uint8_t	vs1053b_set_native_spi_modes (vs1053b_handle_t *handle, vs1053b_bool_t enable)
	enable or disable native spi modes
uint8_t	vs1053b_get_native_spi_modes (vs1053b_handle_t handle, vs1053b_bool_t enable)
	get native spi modes status
uint8_t	vs1053b_set_pcm_adpcm_recording_active (vs1053b_handle_t *handle, vs1053b_bool_t enable)
	enable or disable pcm adpcm recording active
uint8_t	vs1053b_get_pcm_adpcm_recording_active (vs1053b_handle_t handle, vs1053b_bool_t enable)
	get pcm adpcm recording active status
uint8_t	vs1053b_set_selector (vs1053b_handle_t *handle, vs1053b_selector_t selector)
	set selector
uint8_t	vs1053b_get_selector (vs1053b_handle_t handle, vs1053b_selector_t selector)
	get selector
uint8_t	vs1053b_set_clock_range (vs1053b_handle_t *handle, vs1053b_clock_range_t range)
	set clock range
uint8_t	vs1053b_get_clock_range (vs1053b_handle_t handle, vs1053b_clock_range_t range)
	get clock range
uint8_t	vs1053b_set_do_not_jump (vs1053b_handle_t *handle, vs1053b_bool_t enable)
	enable or disable do not jump
uint8_t	vs1053b_get_do_not_jump (vs1053b_handle_t handle, vs1053b_bool_t enable)
	get do not jump status
uint8_t	vs1053b_set_swing (vs1053b_handle_t *handle, uint8_t swing)
	set swing
uint8_t	vs1053b_get_swing (vs1053b_handle_t handle, uint8_t swing)
	get swing
uint8_t	vs1053b_swing_convert_to_register (vs1053b_handle_t handle, float db, uint8_t reg)
	convert the swing to the register raw data
uint8_t	vs1053b_swing_convert_to_data (vs1053b_handle_t handle, uint8_t reg, float db)
	convert the register raw data to the swing
uint8_t	vs1053b_set_overload_indicator (vs1053b_handle_t *handle, vs1053b_bool_t enable)
	enable or disable overload indicator
uint8_t	vs1053b_get_overload_indicator (vs1053b_handle_t handle, vs1053b_bool_t enable)
	get overload indicator status
uint8_t	vs1053b_set_overload_detection (vs1053b_handle_t *handle, vs1053b_bool_t enable)
	enable or disable overload detection
uint8_t	vs1053b_get_overload_detection (vs1053b_handle_t handle, vs1053b_bool_t enable)
	get overload detection status
uint8_t	vs1053b_get_version (vs1053b_handle_t handle, uint8_t version)
	get version
uint8_t	vs1053b_set_analog_driver_power_down (vs1053b_handle_t *handle, vs1053b_bool_t enable)
	enable or disable analog driver power down
uint8_t	vs1053b_get_analog_driver_power_down (vs1053b_handle_t handle, vs1053b_bool_t enable)
	get analog driver power down status
uint8_t	vs1053b_set_analog_internal_power_down (vs1053b_handle_t *handle, vs1053b_bool_t enable)
	enable or disable analog internal power down
uint8_t	vs1053b_get_analog_internal_power_down (vs1053b_handle_t handle, vs1053b_bool_t enable)
	get analog internal power down status
uint8_t	vs1053b_set_ad_clock (vs1053b_handle_t *handle, vs1053b_ad_clock_t ad_clock)
	set ad clock
uint8_t	vs1053b_get_ad_clock (vs1053b_handle_t handle, vs1053b_ad_clock_t ad_clock)
	get ad clock
uint8_t	vs1053b_set_reference_voltage (vs1053b_handle_t *handle, vs1053b_reference_voltage_t voltage)
	set reference voltage
uint8_t	vs1053b_get_reference_voltage (vs1053b_handle_t handle, vs1053b_reference_voltage_t voltage)
	get reference voltage
uint8_t	vs1053b_set_treble_control (vs1053b_handle_t *handle, uint8_t db)
	set treble control
uint8_t	vs1053b_get_treble_control (vs1053b_handle_t handle, uint8_t db)
	get treble control
uint8_t	vs1053b_treble_control_convert_to_register (vs1053b_handle_t handle, float db, uint8_t reg)
	convert the treble control to the register raw data
uint8_t	vs1053b_treble_control_convert_to_data (vs1053b_handle_t handle, uint8_t reg, float db)
	convert the register raw data to the treble control
uint8_t	vs1053b_set_lower_limit_frequency_in_1000_hz (vs1053b_handle_t *handle, uint8_t step)
	set lower limit frequency in 1000 hz
uint8_t	vs1053b_get_lower_limit_frequency_in_1000_hz (vs1053b_handle_t handle, uint8_t step)
	get lower limit frequency in 1000 hz
uint8_t	vs1053b_lower_limit_frequency_in_1000_hz_convert_to_register (vs1053b_handle_t handle, uint32_t hz, uint8_t reg)
	convert the lower limit frequency in 1000 hz to the register raw data
uint8_t	vs1053b_lower_limit_frequency_in_1000_hz_convert_to_data (vs1053b_handle_t handle, uint8_t reg, uint32_t hz)
	convert the register raw data to the lower limit frequency in 1000 hz
uint8_t	vs1053b_set_bass_enhancement (vs1053b_handle_t *handle, uint8_t db)
	set bass enhancement
uint8_t	vs1053b_get_bass_enhancement (vs1053b_handle_t handle, uint8_t db)
	get bass enhancement
uint8_t	vs1053b_set_lower_limit_frequency_in_10_hz (vs1053b_handle_t *handle, uint8_t step)
	set lower limit frequency in 10 hz
uint8_t	vs1053b_get_lower_limit_frequency_in_10_hz (vs1053b_handle_t handle, uint8_t step)
	get lower limit frequency in 10 hz
uint8_t	vs1053b_lower_limit_frequency_in_10_hz_convert_to_register (vs1053b_handle_t handle, uint32_t hz, uint8_t reg)
	convert the lower limit frequency in 10 hz to the register raw data
uint8_t	vs1053b_lower_limit_frequency_in_10_hz_convert_to_data (vs1053b_handle_t handle, uint8_t reg, uint32_t hz)
	convert the register raw data to the lower limit frequency in 10 hz
uint8_t	vs1053b_set_clock_multiplier (vs1053b_handle_t *handle, vs1053b_clock_multiplier_t multiplier)
	set clock multiplier
uint8_t	vs1053b_get_clock_multiplier (vs1053b_handle_t handle, vs1053b_clock_multiplier_t multiplier)
	get clock multiplier
uint8_t	vs1053b_set_allowed_multiplier_addition (vs1053b_handle_t *handle, vs1053b_allowed_multiplier_addition_t addition)
	set allowed multiplier addition
uint8_t	vs1053b_get_allowed_multiplier_addition (vs1053b_handle_t handle, vs1053b_allowed_multiplier_addition_t addition)
	get allowed multiplier addition
uint8_t	vs1053b_set_clock_frequency (vs1053b_handle_t *handle, uint16_t clk)
	set clock frequency
uint8_t	vs1053b_get_clock_frequency (vs1053b_handle_t handle, uint16_t clk)
	get clock frequency
uint8_t	vs1053b_clock_frequency_convert_to_register (vs1053b_handle_t handle, float hz, uint16_t reg)
	convert the clock frequency to the register raw data
uint8_t	vs1053b_clock_frequency_convert_to_data (vs1053b_handle_t handle, uint16_t reg, float hz)
	convert the register raw data to the clock frequency
uint8_t	vs1053b_set_decode_time (vs1053b_handle_t *handle, uint16_t decode_time)
	set decode time
uint8_t	vs1053b_get_decode_time (vs1053b_handle_t handle, uint16_t decode_time)
	get decode time
uint8_t	vs1053b_set_sample_rate (vs1053b_handle_t *handle, uint16_t rate, vs1053b_channel_t channel)
	set sample rate
uint8_t	vs1053b_get_sample_rate (vs1053b_handle_t handle, uint16_t rate, vs1053b_channel_t *channel)
	get sample rate
uint8_t	vs1053b_write_ram (vs1053b_handle_t handle, uint8_t buf, uint16_t len)
	write ram
uint8_t	vs1053b_read_ram (vs1053b_handle_t handle, uint8_t buf, uint16_t len)
	read ram
uint8_t	vs1053b_set_ram_address (vs1053b_handle_t *handle, uint16_t addr)
	set ram address
uint8_t	vs1053b_get_hdata (vs1053b_handle_t handle, uint16_t dat0, uint16_t *dat1)
	get hdata
uint8_t	vs1053b_get_hdata0 (vs1053b_handle_t handle, uint16_t dat0)
	get hdata0
uint8_t	vs1053b_get_hdata1 (vs1053b_handle_t handle, uint16_t dat1)
	get hdata1
uint8_t	vs1053b_set_start_address (vs1053b_handle_t *handle, uint16_t addr)
	set start address
uint8_t	vs1053b_get_start_address (vs1053b_handle_t handle, uint16_t addr)
	get start address
uint8_t	vs1053b_set_vol (vs1053b_handle_t *handle, uint8_t left, uint8_t right)
	set vol
uint8_t	vs1053b_get_vol (vs1053b_handle_t handle, uint8_t left, uint8_t *right)
	get vol
uint8_t	vs1053b_vol_convert_to_register (vs1053b_handle_t handle, float db, uint8_t reg)
	convert vol to the register raw data
uint8_t	vs1053b_vol_convert_to_data (vs1053b_handle_t handle, uint8_t reg, float db)
	convert the register raw data to vol
uint8_t	vs1053b_write_application (vs1053b_handle_t handle, vs1053b_application_t num, uint8_t buf, uint16_t len)
	write application
uint8_t	vs1053b_read_application (vs1053b_handle_t handle, vs1053b_application_t num, uint8_t buf, uint16_t len)
	read application
uint8_t	vs1053b_set_play_speed (vs1053b_handle_t *handle, vs1053b_play_speed_t speed)
	set play speed
uint8_t	vs1053b_get_play_speed (vs1053b_handle_t handle, vs1053b_play_speed_t speed)
	get play speed
uint8_t	vs1053b_get_byte_rate (vs1053b_handle_t handle, uint16_t rate)
	get byte rate
uint8_t	vs1053b_get_end_fill_byte (vs1053b_handle_t handle, uint16_t byte)
	get end fill byte
uint8_t	vs1053b_get_patch (vs1053b_handle_t handle, vs1053b_patch_t type, const uint16_t patch_addr, uint16_t len)
	get patch info
uint8_t	vs1053b_load_patch (vs1053b_handle_t handle, const uint16_t patch, uint16_t len)
	load patch
uint8_t	vs1053b_set_iis_mclk (vs1053b_handle_t *handle, vs1053b_bool_t enable)
	enable or disable iis mclk
uint8_t	vs1053b_get_iis_mclk (vs1053b_handle_t handle, vs1053b_bool_t enable)
	get iis mclk status
uint8_t	vs1053b_set_iis (vs1053b_handle_t *handle, vs1053b_bool_t enable)
	enable or disable iis
uint8_t	vs1053b_get_iis (vs1053b_handle_t handle, vs1053b_bool_t enable)
	get iis status
uint8_t	vs1053b_set_iis_rate (vs1053b_handle_t *handle, vs1053b_iis_rate_t iis_rate)
	set iis rate
uint8_t	vs1053b_get_iis_rate (vs1053b_handle_t handle, vs1053b_iis_rate_t iis_rate)
	get iis rate
uint8_t	vs1053b_set_gpio_direction (vs1053b_handle_t *handle, uint16_t mask)
	set gpio direction
uint8_t	vs1053b_get_gpio_direction (vs1053b_handle_t handle, uint16_t mask)
	get gpio direction
uint8_t	vs1053b_get_gpio_input (vs1053b_handle_t handle, uint16_t data)
	get gpio input
uint8_t	vs1053b_set_gpio_output (vs1053b_handle_t *handle, uint16_t data)
	set gpio output
uint8_t	vs1053b_get_gpio_output (vs1053b_handle_t handle, uint16_t data)
	get gpio output

Detailed Description

vs1053b basic driver modules

Macro Definition Documentation

◆ VS1053B_AICTRL3_ADC_DUAL_CHANNEL

#define VS1053B_AICTRL3_ADC_DUAL_CHANNEL (1 << 0)

adc dual channel

Definition at line 394 of file driver_vs1053b.h.

◆ VS1053B_AICTRL3_ADC_JOINT_STEREO

#define VS1053B_AICTRL3_ADC_JOINT_STEREO (0 << 0)

adc joint stereo

Definition at line 393 of file driver_vs1053b.h.

◆ VS1053B_AICTRL3_ADC_LEFT_CHANNEL

#define VS1053B_AICTRL3_ADC_LEFT_CHANNEL (2 << 0)

adc left channel

Definition at line 395 of file driver_vs1053b.h.

◆ VS1053B_AICTRL3_ADC_RIGHT_CHANNEL

#define VS1053B_AICTRL3_ADC_RIGHT_CHANNEL (3 << 0)

adc right channel

Definition at line 396 of file driver_vs1053b.h.

◆ VS1053B_AICTRL3_MODE_IMA

#define VS1053B_AICTRL3_MODE_IMA ADPCM (0 << 2)

aictrl3 control definition

ima adpcm mode

Definition at line 391 of file driver_vs1053b.h.

◆ VS1053B_AICTRL3_MODE_LINEAR_PCM

#define VS1053B_AICTRL3_MODE_LINEAR_PCM (1 << 2)

linear pcm mode

Definition at line 392 of file driver_vs1053b.h.

◆ VS1053B_BUFFER_SIZE

#define VS1053B_BUFFER_SIZE 512 /* 512 bytes */

vs1053b buffer size definition

Definition at line 63 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC08K1Q00

#define VS1053B_OGG_VENC08K1Q00 0

check buffer size valid

vs1053b venc08k1q00 definition ogg venc08k1q00

Definition at line 77 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC08K1Q01

#define VS1053B_OGG_VENC08K1Q01 0

vs1053b venc08k1q01 definition

ogg venc08k1q01

Definition at line 84 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC08K1Q02

#define VS1053B_OGG_VENC08K1Q02 0

vs1053b venc08k1q02 definition

ogg venc08k1q02

Definition at line 91 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC08K1Q03

#define VS1053B_OGG_VENC08K1Q03 0

vs1053b venc08k1q03 definition

ogg venc08k1q03

Definition at line 98 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC08K1Q04

#define VS1053B_OGG_VENC08K1Q04 0

vs1053b venc08k1q04 definition

ogg venc08k1q04

Definition at line 105 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC08K1Q05

#define VS1053B_OGG_VENC08K1Q05 0

vs1053b venc08k1q05 definition

ogg venc08k1q05

Definition at line 112 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC08K1Q06

#define VS1053B_OGG_VENC08K1Q06 0

vs1053b venc08k1q06 definition

ogg venc08k1q06

Definition at line 119 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC08K1Q07

#define VS1053B_OGG_VENC08K1Q07 0

vs1053b venc08k1q07 definition

ogg venc08k1q07

Definition at line 126 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC08K1Q08

#define VS1053B_OGG_VENC08K1Q08 0

vs1053b venc08k1q08 definition

ogg venc08k1q08

Definition at line 133 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC08K1Q09

#define VS1053B_OGG_VENC08K1Q09 0

vs1053b venc08k1q09 definition

ogg venc08k1q09

Definition at line 140 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC08K1Q10

#define VS1053B_OGG_VENC08K1Q10 0

vs1053b venc08k1q10 definition

ogg venc08k1q10

Definition at line 147 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K1Q00

#define VS1053B_OGG_VENC16K1Q00 0

vs1053b venc16k1q00 definition

ogg venc16k1q00

Definition at line 154 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K1Q01

#define VS1053B_OGG_VENC16K1Q01 0

vs1053b venc16k1q01 definition

ogg venc16k1q01

Definition at line 161 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K1Q02

#define VS1053B_OGG_VENC16K1Q02 0

vs1053b venc16k1q02 definition

ogg venc16k1q02

Definition at line 168 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K1Q03

#define VS1053B_OGG_VENC16K1Q03 0

vs1053b venc16k1q03 definition

ogg venc16k1q03

Definition at line 175 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K1Q04

#define VS1053B_OGG_VENC16K1Q04 0

vs1053b venc16k1q04 definition

ogg venc16k1q04

Definition at line 182 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K1Q05

#define VS1053B_OGG_VENC16K1Q05 0

vs1053b venc16k1q05 definition

ogg venc16k1q05

Definition at line 189 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K1Q06

#define VS1053B_OGG_VENC16K1Q06 0

vs1053b venc16k1q06 definition

ogg venc16k1q06

Definition at line 196 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K1Q07

#define VS1053B_OGG_VENC16K1Q07 0

vs1053b venc16k1q07 definition

ogg venc16k1q07

Definition at line 203 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K1Q08

#define VS1053B_OGG_VENC16K1Q08 0

vs1053b venc16k1q08 definition

ogg venc16k1q08

Definition at line 210 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K1Q09

#define VS1053B_OGG_VENC16K1Q09 0

vs1053b venc16k1q09 definition

ogg venc16k1q09

Definition at line 217 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K1Q10

#define VS1053B_OGG_VENC16K1Q10 0

vs1053b venc16k1q10 definition

ogg venc16k1q10

Definition at line 224 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K2Q00

#define VS1053B_OGG_VENC16K2Q00 0

vs1053b venc16k2q00 definition

ogg venc16k2q00

Definition at line 231 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K2Q01

#define VS1053B_OGG_VENC16K2Q01 0

vs1053b venc16k2q01 definition

ogg venc16k2q01

Definition at line 238 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K2Q02

#define VS1053B_OGG_VENC16K2Q02 0

vs1053b venc16k2q02 definition

ogg venc16k2q02

Definition at line 245 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K2Q03

#define VS1053B_OGG_VENC16K2Q03 0

vs1053b venc16k2q03 definition

ogg venc16k2q03

Definition at line 252 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K2Q04

#define VS1053B_OGG_VENC16K2Q04 0

vs1053b venc16k2q04 definition

ogg venc16k2q04

Definition at line 259 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K2Q05

#define VS1053B_OGG_VENC16K2Q05 0

vs1053b venc16k2q05 definition

ogg venc16k2q05

Definition at line 266 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K2Q06

#define VS1053B_OGG_VENC16K2Q06 0

vs1053b venc16k2q06 definition

ogg venc16k2q06

Definition at line 273 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K2Q07

#define VS1053B_OGG_VENC16K2Q07 0

vs1053b venc16k2q07 definition

ogg venc16k2q07

Definition at line 280 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K2Q08

#define VS1053B_OGG_VENC16K2Q08 0

vs1053b venc16k2q08 definition

ogg venc16k2q08

Definition at line 287 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K2Q09

#define VS1053B_OGG_VENC16K2Q09 0

vs1053b venc16k2q09 definition

ogg venc16k2q09

Definition at line 294 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC16K2Q10

#define VS1053B_OGG_VENC16K2Q10 0

vs1053b venc16k2q10 definition

ogg venc16k2q10

Definition at line 301 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC44K1Q00

#define VS1053B_OGG_VENC44K1Q00 0

vs1053b venc44k1q00 definition

ogg venc44k1q00

Definition at line 308 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC44K1Q01

#define VS1053B_OGG_VENC44K1Q01 0

vs1053b venc44k1q01 definition

ogg venc44k1q01

Definition at line 315 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC44K1Q02

#define VS1053B_OGG_VENC44K1Q02 0

vs1053b venc44k1q02 definition

ogg venc44k1q02

Definition at line 322 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC44K1Q03

#define VS1053B_OGG_VENC44K1Q03 0

vs1053b venc44k1q03 definition

ogg venc44k1q03

Definition at line 329 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC44K1Q04

#define VS1053B_OGG_VENC44K1Q04 0

vs1053b venc44k1q04 definition

ogg venc44k1q04

Definition at line 336 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC44K1Q05

#define VS1053B_OGG_VENC44K1Q05 0

vs1053b venc44k1q05 definition

ogg venc44k1q05

Definition at line 343 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC44K2Q00

#define VS1053B_OGG_VENC44K2Q00 0

vs1053b venc44k2q00 definition

ogg venc44k2q00

Definition at line 350 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC44K2Q01

#define VS1053B_OGG_VENC44K2Q01 0

vs1053b venc44k2q01 definition

ogg venc44k2q01

Definition at line 357 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC44K2Q02

#define VS1053B_OGG_VENC44K2Q02 0

vs1053b venc44k2q02 definition

ogg venc44k2q02

Definition at line 364 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC44K2Q03

#define VS1053B_OGG_VENC44K2Q03 0

vs1053b venc44k2q03 definition

ogg venc44k2q03

Definition at line 371 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC44K2Q04

#define VS1053B_OGG_VENC44K2Q04 0

vs1053b venc44k2q04 definition

ogg venc44k2q04

Definition at line 378 of file driver_vs1053b.h.

◆ VS1053B_OGG_VENC44K2Q05

#define VS1053B_OGG_VENC44K2Q05 1

vs1053b venc44k2q05 definition

ogg venc44k2q05

Definition at line 385 of file driver_vs1053b.h.

Typedef Documentation

◆ vs1053b_audio_info_t

typedef struct vs1053b_audio_info_s vs1053b_audio_info_t

vs1053b audio info structure definition

◆ vs1053b_handle_t

typedef struct vs1053b_handle_s vs1053b_handle_t

vs1053b handle structure definition

◆ vs1053b_info_t

typedef struct vs1053b_info_s vs1053b_info_t

vs1053b information structure definition

◆ vs1053b_wav_t

typedef struct vs1053b_wav_s vs1053b_wav_t

vs1053b wav structure definition

Enumeration Type Documentation

◆ vs1053b_ad_clock_t

enum vs1053b_ad_clock_t

vs1053b ad clock enumeration definition

Enumerator
VS1053B_AD_CLOCK_6MHZ	6MHz
VS1053B_AD_CLCOK_3MHZ	3MHz

Definition at line 455 of file driver_vs1053b.h.

◆ vs1053b_allowed_multiplier_addition_t

enum vs1053b_allowed_multiplier_addition_t

vs1053b allowed multiplier addition enumeration definition

Enumerator
VS1053B_ALLOWED_MULTIPLIER_ADDITION_NONE	no modification is allowed
VS1053B_ALLOWED_MULTIPLIER_ADDITION_1P0_XTALI	1.0 xtali
VS1053B_ALLOWED_MULTIPLIER_ADDITION_1P5_XTALI	1.5 xtali
VS1053B_ALLOWED_MULTIPLIER_ADDITION_2P0_XTALI	2.0 xtali

Definition at line 488 of file driver_vs1053b.h.

◆ vs1053b_application_t

enum vs1053b_application_t

vs1053b application enumeration definition

Enumerator
VS1053B_APPLICATION_0	application 0
VS1053B_APPLICATION_1	application 1
VS1053B_APPLICATION_2	application 2
VS1053B_APPLICATION_3	application 3

Definition at line 508 of file driver_vs1053b.h.

◆ vs1053b_bit_order_t

enum vs1053b_bit_order_t

vs1053b bit order enumeration definition

Enumerator
VS1053B_BIT_ORDER_MSB_FIRST	msb first
VS1053B_BIT_ORDER_MSB_LAST	msb last

Definition at line 428 of file driver_vs1053b.h.

◆ vs1053b_bool_t

enum vs1053b_bool_t

vs1053b bool enumeration definition

Enumerator
VS1053B_BOOL_FALSE	disable
VS1053B_BOOL_TRUE	enable

Definition at line 401 of file driver_vs1053b.h.

◆ vs1053b_channel_t

enum vs1053b_channel_t

vs1053b channel enumeration definition

Enumerator
VS1053B_CHANNEL_MONO	mono
VS1053B_CHANNEL_STEREO	stereo

Definition at line 499 of file driver_vs1053b.h.

◆ vs1053b_clock_multiplier_t

enum vs1053b_clock_multiplier_t

vs1053b clock multiplier enumeration definition

Enumerator
VS1053B_CLOCK_MULTIPLIER_1P0_XTALI	1.0 xtali
VS1053B_CLOCK_MULTIPLIER_2P0_XTALI	2.0 xtali
VS1053B_CLOCK_MULTIPLIER_2P5_XTALI	2.5 xtali
VS1053B_CLOCK_MULTIPLIER_3P0_XTALI	3.0 xtali
VS1053B_CLOCK_MULTIPLIER_3P5_XTALI	3.5 xtali
VS1053B_CLOCK_MULTIPLIER_4P0_XTALI	4.0 xtali
VS1053B_CLOCK_MULTIPLIER_4P5_XTALI	4.5 xtali
VS1053B_CLOCK_MULTIPLIER_5P0_XTALI	5.0 xtali

Definition at line 473 of file driver_vs1053b.h.

◆ vs1053b_clock_range_t

enum vs1053b_clock_range_t

vs1053b clock range enumeration definition

Enumerator
VS1053B_CLOCK_RANGE_12MHZ_13MHZ	12MHz - 13MHz
VS1053B_CLOCK_RANGE_24MHZ_26MHZ	24MHz - 26MHz

Definition at line 410 of file driver_vs1053b.h.

◆ vs1053b_dclk_edge_t

enum vs1053b_dclk_edge_t

vs1053b dclk edge enumeration definition

Enumerator
VS1053B_DCLK_EDGE_RISING	rising edge
VS1053B_DCLK_EDGE_FALLING	falling edge

Definition at line 437 of file driver_vs1053b.h.

◆ vs1053b_diff_t

enum vs1053b_diff_t

vs1053b diff enumeration definition

Enumerator
VS1053B_DIFF_NORMAL	normal in phase audio
VS1053B_DIFF_LEFT_INVERTED	left channel inverted

Definition at line 446 of file driver_vs1053b.h.

◆ vs1053b_format_t

enum vs1053b_format_t

vs1053b format enumeration definition

Enumerator
VS1053B_FORMAT_WAV	wav
VS1053B_FORMAT_MIDI	midi
VS1053B_FORMAT_AAC_ADTS	acc adts
VS1053B_FORMAT_AAC_ADIF	acc adif
VS1053B_FORMAT_AAC_MP4	acc mp4
VS1053B_FORMAT_OGG	ogg
VS1053B_FORMAT_WMA	wma
VS1053B_FORMAT_FLAC	flac
VS1053B_FORMAT_MP3	mp3

Definition at line 545 of file driver_vs1053b.h.

◆ vs1053b_iis_rate_t

enum vs1053b_iis_rate_t

vs1053b iis rate enumeration definition

Enumerator
VS1053B_IIS_RATE_48KHZ	48khz
VS1053B_IIS_RATE_96KHZ	96khz
VS1053B_IIS_RATE_192KHZ	192khz

Definition at line 615 of file driver_vs1053b.h.

◆ vs1053b_patch_t

enum vs1053b_patch_t

vs1053b patch enumeration definition

Enumerator
VS1053B_PATCH_FLAC	flac
VS1053B_PATCH_WAV	wav
VS1053B_PATCH_OGG_VENC08K1Q00	ogg venc08k1q00
VS1053B_PATCH_OGG_VENC08K1Q01	ogg venc08k1q01
VS1053B_PATCH_OGG_VENC08K1Q02	ogg venc08k1q02
VS1053B_PATCH_OGG_VENC08K1Q03	ogg venc08k1q03
VS1053B_PATCH_OGG_VENC08K1Q04	ogg venc08k1q04
VS1053B_PATCH_OGG_VENC08K1Q05	ogg venc08k1q05
VS1053B_PATCH_OGG_VENC08K1Q06	ogg venc08k1q06
VS1053B_PATCH_OGG_VENC08K1Q07	ogg venc08k1q07
VS1053B_PATCH_OGG_VENC08K1Q08	ogg venc08k1q08
VS1053B_PATCH_OGG_VENC08K1Q09	ogg venc08k1q09
VS1053B_PATCH_OGG_VENC08K1Q10	ogg venc08k1q10
VS1053B_PATCH_OGG_VENC16K1Q00	ogg venc16k1q00
VS1053B_PATCH_OGG_VENC16K1Q01	ogg venc16k1q01
VS1053B_PATCH_OGG_VENC16K1Q02	ogg venc16k1q02
VS1053B_PATCH_OGG_VENC16K1Q03	ogg venc16k1q03
VS1053B_PATCH_OGG_VENC16K1Q04	ogg venc16k1q04
VS1053B_PATCH_OGG_VENC16K1Q05	ogg venc16k1q05
VS1053B_PATCH_OGG_VENC16K1Q06	ogg venc16k1q06
VS1053B_PATCH_OGG_VENC16K1Q07	ogg venc16k1q07
VS1053B_PATCH_OGG_VENC16K1Q08	ogg venc16k1q08
VS1053B_PATCH_OGG_VENC16K1Q09	ogg venc16k1q09
VS1053B_PATCH_OGG_VENC16K1Q10	ogg venc16k1q10
VS1053B_PATCH_OGG_VENC16K2Q00	ogg venc16k2q00
VS1053B_PATCH_OGG_VENC16K2Q01	ogg venc16k2q01
VS1053B_PATCH_OGG_VENC16K2Q02	ogg venc16k2q02
VS1053B_PATCH_OGG_VENC16K2Q03	ogg venc16k2q03
VS1053B_PATCH_OGG_VENC16K2Q04	ogg venc16k2q04
VS1053B_PATCH_OGG_VENC16K2Q05	ogg venc16k2q05
VS1053B_PATCH_OGG_VENC16K2Q06	ogg venc16k2q06
VS1053B_PATCH_OGG_VENC16K2Q07	ogg venc16k2q07
VS1053B_PATCH_OGG_VENC16K2Q08	ogg venc16k2q08
VS1053B_PATCH_OGG_VENC16K2Q09	ogg venc16k2q09
VS1053B_PATCH_OGG_VENC16K2Q10	ogg venc16k2q10
VS1053B_PATCH_OGG_VENC44K1Q00	ogg venc44k1q00
VS1053B_PATCH_OGG_VENC44K1Q01	ogg venc44k1q01
VS1053B_PATCH_OGG_VENC44K1Q02	ogg venc44k1q02
VS1053B_PATCH_OGG_VENC44K1Q03	ogg venc44k1q03
VS1053B_PATCH_OGG_VENC44K1Q04	ogg venc44k1q04
VS1053B_PATCH_OGG_VENC44K1Q05	ogg venc44k1q05
VS1053B_PATCH_OGG_VENC44K2Q00	ogg venc44k2q00
VS1053B_PATCH_OGG_VENC44K2Q01	ogg venc44k2q01
VS1053B_PATCH_OGG_VENC44K2Q02	ogg venc44k2q02
VS1053B_PATCH_OGG_VENC44K2Q03	ogg venc44k2q03
VS1053B_PATCH_OGG_VENC44K2Q04	ogg venc44k2q04
VS1053B_PATCH_OGG_VENC44K2Q05	ogg venc44k2q05

Definition at line 561 of file driver_vs1053b.h.

◆ vs1053b_play_speed_t

enum vs1053b_play_speed_t

vs1053b play speed enumeration definition

Enumerator
VS1053B_PLAY_SPEED_1_X	1.0x
VS1053B_PLAY_SPEED_1P0_X	1.0x
VS1053B_PLAY_SPEED_2P0_X	2.0x
VS1053B_PLAY_SPEED_3P0_X	3.0x

Definition at line 519 of file driver_vs1053b.h.

◆ vs1053b_record_format_t

enum vs1053b_record_format_t

vs1053b record format enumeration definition

Enumerator
VS1053B_RECORD_FORMAT_WAV	wav format
VS1053B_RECORD_FORMAT_OGG	ogg format

Definition at line 625 of file driver_vs1053b.h.

◆ vs1053b_reference_voltage_t

enum vs1053b_reference_voltage_t

vs1053b reference voltage enumeration definition

Enumerator
VS1053B_REFERENCE_VOLTAGE_1P23V	1.23V
VS1053B_REFERENCE_VOLTAGE_1P65V	1.65V

Definition at line 464 of file driver_vs1053b.h.

◆ vs1053b_selector_t

enum vs1053b_selector_t

vs1053b selector enumeration definition

Enumerator
VS1053B_SELECTOR_MICP	microphone
VS1053B_SELECTOR_LINE1	line1

Definition at line 419 of file driver_vs1053b.h.

◆ vs1053b_type_t

enum vs1053b_type_t

vs1053b type enumeration definition

Enumerator
VS1053B_TYPE_PLAY_READ	read data during playing
VS1053B_TYPE_PLAY_WRITE	write data during playing
VS1053B_TYPE_PLAY_END	play end
VS1053B_TYPE_RECORD_READ	read data during recording
VS1053B_TYPE_RECORD_WRITE	write data during recording
VS1053B_TYPE_RECORD_END	record end
VS1053B_TYPE_RECORD_OVER	record over buffer
VS1053B_TYPE_PERIOD	period

Definition at line 530 of file driver_vs1053b.h.

Function Documentation

◆ vs1053b_clock_frequency_convert_to_data()

uint8_t vs1053b_clock_frequency_convert_to_data	(	vs1053b_handle_t *	handle,
		uint16_t	reg,
		float *	hz )

convert the register raw data to the clock frequency

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	reg	register raw data
[out]	*hz	pointer to an hz buffer

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3924 of file driver_vs1053b.c.

◆ vs1053b_clock_frequency_convert_to_register()

uint8_t vs1053b_clock_frequency_convert_to_register	(	vs1053b_handle_t *	handle,
		float	hz,
		uint16_t *	reg )

convert the clock frequency to the register raw data

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	hz	set hz
[out]	*reg	pointer to a register raw buffer

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3897 of file driver_vs1053b.c.

◆ vs1053b_deinit()

uint8_t vs1053b_deinit ( vs1053b_handle_t * handle )

deinit the chip

Parameters

[in] *handle pointer to a vs1053b handle structure

Returns

status code

0 success
1 deinit failed
2 handle is NULL
3 handle is not initialized
4 reset failed

Note: none

Definition at line 6253 of file driver_vs1053b.c.

◆ vs1053b_get_ad_clock()

uint8_t vs1053b_get_ad_clock	(	vs1053b_handle_t *	handle,
		vs1053b_ad_clock_t *	ad_clock )

get ad clock

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*ad_clock	pointer to a ad clock buffer

Returns

status code

0 success
1 get ad clock failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2855 of file driver_vs1053b.c.

◆ vs1053b_get_allow_sdi_test()

uint8_t vs1053b_get_allow_sdi_test	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t *	enable )

get allow sdi test status

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*enable	pointer to a bool buffer

Returns

status code

0 success
1 get allow sdi test failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1149 of file driver_vs1053b.c.

◆ vs1053b_get_allowed_multiplier_addition()

uint8_t vs1053b_get_allowed_multiplier_addition	(	vs1053b_handle_t *	handle,
		vs1053b_allowed_multiplier_addition_t *	addition )

get allowed multiplier addition

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*addition	pointer to an allowed multiplier addition buffer

Returns

status code

0 success
1 get allowed multiplier addition failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3745 of file driver_vs1053b.c.

◆ vs1053b_get_analog_driver_power_down()

uint8_t vs1053b_get_analog_driver_power_down	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t *	enable )

get analog driver power down status

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*enable	pointer to a bool buffer

Returns

status code

0 success
1 get analog driver power down failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2655 of file driver_vs1053b.c.

◆ vs1053b_get_analog_internal_power_down()

uint8_t vs1053b_get_analog_internal_power_down	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t *	enable )

get analog internal power down status

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*enable	pointer to a bool buffer

Returns

status code

0 success
1 get analog internal power down failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2755 of file driver_vs1053b.c.

◆ vs1053b_get_bass_enhancement()

uint8_t vs1053b_get_bass_enhancement	(	vs1053b_handle_t *	handle,
		uint8_t *	db )

get bass enhancement

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*db	pointer to a db buffer

Returns

status code

0 success
1 get bass enhancement failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3384 of file driver_vs1053b.c.

◆ vs1053b_get_byte_rate()

uint8_t vs1053b_get_byte_rate	(	vs1053b_handle_t *	handle,
		uint16_t *	rate )

get byte rate

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*rate	pointer to a rate buffer

Returns

status code

0 success
1 get byte rate failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4921 of file driver_vs1053b.c.

◆ vs1053b_get_cancel_decoding_current_file()

uint8_t vs1053b_get_cancel_decoding_current_file	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t *	enable )

get cancel decoding current file status

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*enable	pointer to a bool buffer

Returns

status code

0 success
1 get cancel decoding current file failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 949 of file driver_vs1053b.c.

◆ vs1053b_get_clock_frequency()

uint8_t vs1053b_get_clock_frequency	(	vs1053b_handle_t *	handle,
		uint16_t *	clk )

get clock frequency

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*clk	pointer to a clock buffer

Returns

status code

0 success
1 get clock frequency failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3852 of file driver_vs1053b.c.

◆ vs1053b_get_clock_multiplier()

uint8_t vs1053b_get_clock_multiplier	(	vs1053b_handle_t *	handle,
		vs1053b_clock_multiplier_t *	multiplier )

get clock multiplier

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*multiplier	pointer to a clock multiplier buffer

Returns

status code

0 success
1 get clock multiplier failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3645 of file driver_vs1053b.c.

◆ vs1053b_get_clock_range()

uint8_t vs1053b_get_clock_range	(	vs1053b_handle_t *	handle,
		vs1053b_clock_range_t *	range )

get clock range

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*range	pointer to a range buffer

Returns

status code

0 success
1 get clock range failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2049 of file driver_vs1053b.c.

◆ vs1053b_get_dclk_edge()

uint8_t vs1053b_get_dclk_edge	(	vs1053b_handle_t *	handle,
		vs1053b_dclk_edge_t *	edge )

get dclk edge

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*edge	pointer to a dclk edge buffer

Returns

status code

0 success
1 get dclk edge failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1449 of file driver_vs1053b.c.

◆ vs1053b_get_decode_time()

uint8_t vs1053b_get_decode_time	(	vs1053b_handle_t *	handle,
		uint16_t *	decode_time )

get decode time

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*decode_time	pointer to a decode time buffer

Returns

status code

0 success
1 get decode time failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4008 of file driver_vs1053b.c.

◆ vs1053b_get_diff()

uint8_t vs1053b_get_diff	(	vs1053b_handle_t *	handle,
		vs1053b_diff_t *	diff )

get the audio differential

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*diff	pointer to an audio differential buffer

Returns

status code

0 success
1 get diff failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 648 of file driver_vs1053b.c.

◆ vs1053b_get_do_not_jump()

uint8_t vs1053b_get_do_not_jump	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t *	enable )

get do not jump status

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*enable	pointer to a bool buffer

Returns

status code

0 success
1 get do not jump failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2149 of file driver_vs1053b.c.

◆ vs1053b_get_ear_speaker_high_setting()

uint8_t vs1053b_get_ear_speaker_high_setting	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t *	enable )

get ear speaker high setting status

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*enable	pointer to a bool buffer

Returns

status code

0 success
1 get ear speaker high setting failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1349 of file driver_vs1053b.c.

◆ vs1053b_get_ear_speaker_low_setting()

uint8_t vs1053b_get_ear_speaker_low_setting	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t *	enable )

get ear speaker low setting status

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*enable	pointer to a bool buffer

Returns

status code

0 success
1 get ear speaker low setting failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1049 of file driver_vs1053b.c.

◆ vs1053b_get_end_fill_byte()

uint8_t vs1053b_get_end_fill_byte	(	vs1053b_handle_t *	handle,
		uint16_t *	byte )

get end fill byte

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*byte	pointer to a byte buffer

Returns

status code

0 success
1 get end fill byte failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4982 of file driver_vs1053b.c.

◆ vs1053b_get_gpio_direction()

uint8_t vs1053b_get_gpio_direction	(	vs1053b_handle_t *	handle,
		uint16_t *	mask )

get gpio direction

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*mask	pointer to a gpio direction mask buffer

Returns

status code

0 success
1 get gpio direction failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 5623 of file driver_vs1053b.c.

◆ vs1053b_get_gpio_input()

uint8_t vs1053b_get_gpio_input	(	vs1053b_handle_t *	handle,
		uint16_t *	data )

get gpio input

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*data	pointer to a data buffer

Returns

status code

0 success
1 get gpio input failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 5684 of file driver_vs1053b.c.

◆ vs1053b_get_gpio_output()

uint8_t vs1053b_get_gpio_output	(	vs1053b_handle_t *	handle,
		uint16_t *	data )

get gpio output

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*data	pointer to a data buffer

Returns

status code

0 success
1 get gpio output failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 5842 of file driver_vs1053b.c.

◆ vs1053b_get_hdata()

uint8_t vs1053b_get_hdata	(	vs1053b_handle_t *	handle,
		uint16_t *	dat0,
		uint16_t *	dat1 )

get hdata

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*dat0	pointer to a data buffer
[out]	*dat1	pointer to a data buffer

Returns

status code

0 success
1 get hdata failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4274 of file driver_vs1053b.c.

◆ vs1053b_get_hdata0()

uint8_t vs1053b_get_hdata0	(	vs1053b_handle_t *	handle,
		uint16_t *	dat0 )

get hdata0

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*dat0	pointer to a data buffer

Returns

status code

0 success
1 get hdata0 failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4325 of file driver_vs1053b.c.

◆ vs1053b_get_hdata1()

uint8_t vs1053b_get_hdata1	(	vs1053b_handle_t *	handle,
		uint16_t *	dat1 )

get hdata1

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*dat1	pointer to a data buffer

Returns

status code

0 success
1 get hdata1 failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4368 of file driver_vs1053b.c.

◆ vs1053b_get_iis()

uint8_t vs1053b_get_iis	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t *	enable )

get iis status

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

0 success
1 get iis failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 5301 of file driver_vs1053b.c.

◆ vs1053b_get_iis_mclk()

uint8_t vs1053b_get_iis_mclk	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t *	enable )

get iis mclk status

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*enable	pointer to a bool value buffer

Returns

status code

0 success
1 get iis mclk failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 5140 of file driver_vs1053b.c.

◆ vs1053b_get_iis_rate()

uint8_t vs1053b_get_iis_rate	(	vs1053b_handle_t *	handle,
		vs1053b_iis_rate_t *	iis_rate )

get iis rate

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*iis_rate	pointer to an iis rate buffer

Returns

status code

0 success
1 get iis rate failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 5462 of file driver_vs1053b.c.

◆ vs1053b_get_lower_limit_frequency_in_1000_hz()

uint8_t vs1053b_get_lower_limit_frequency_in_1000_hz	(	vs1053b_handle_t *	handle,
		uint8_t *	step )

get lower limit frequency in 1000 hz

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*step	pointer to a step buffer

Returns

status code

0 success
1 get lower limit frequency in 1000 hz failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3223 of file driver_vs1053b.c.

◆ vs1053b_get_lower_limit_frequency_in_10_hz()

uint8_t vs1053b_get_lower_limit_frequency_in_10_hz	(	vs1053b_handle_t *	handle,
		uint8_t *	step )

get lower limit frequency in 10 hz

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*step	pointer to a step buffer

Returns

status code

0 success
1 get lower limit frequency in 10 hz failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3491 of file driver_vs1053b.c.

◆ vs1053b_get_mpeg_layer_i_and_ii()

uint8_t vs1053b_get_mpeg_layer_i_and_ii	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t *	enable )

get mpeg layer i and ii status

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*enable	pointer to a bool buffer

Returns

status code

0 success
1 get mpeg layer i and ii failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 748 of file driver_vs1053b.c.

◆ vs1053b_get_native_spi_modes()

uint8_t vs1053b_get_native_spi_modes	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t *	enable )

get native spi modes status

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*enable	pointer to a bool buffer

Returns

status code

0 success
1 get native spi modes failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1749 of file driver_vs1053b.c.

◆ vs1053b_get_overload_detection()

uint8_t vs1053b_get_overload_detection	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t *	enable )

get overload detection status

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*enable	pointer to a bool buffer

Returns

status code

0 success
1 get overload detection failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2510 of file driver_vs1053b.c.

◆ vs1053b_get_overload_indicator()

uint8_t vs1053b_get_overload_indicator	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t *	enable )

get overload indicator status

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*enable	pointer to a bool buffer

Returns

status code

0 success
1 get overload indicator failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2410 of file driver_vs1053b.c.

◆ vs1053b_get_patch()

uint8_t vs1053b_get_patch	(	vs1053b_handle_t *	handle,
		vs1053b_patch_t	type,
		const uint16_t **	patch_addr,
		uint16_t *	len )

get patch info

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	type	patch info
[out]	**patch_addr	pointer to a patch address
[out]	*len	pointer to a length address

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 7393 of file driver_vs1053b.c.

◆ vs1053b_get_pcm_adpcm_recording_active()

uint8_t vs1053b_get_pcm_adpcm_recording_active	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t *	enable )

get pcm adpcm recording active status

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*enable	pointer to a bool buffer

Returns

status code

0 success
1 get pcm adpcm recording active failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1849 of file driver_vs1053b.c.

◆ vs1053b_get_period_callback()

uint8_t vs1053b_get_period_callback	(	vs1053b_handle_t *	handle,
		uint32_t *	second,
		uint32_t *	microsecond,
		vs1053b_bool_t *	enable )

get period callback

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*second	pointer to a second buffer
[out]	*microsecond	pointer to a microsecond buffer
[out]	*enable	pointer to a bool value buffer

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 7237 of file driver_vs1053b.c.

◆ vs1053b_get_play_speed()

uint8_t vs1053b_get_play_speed	(	vs1053b_handle_t *	handle,
		vs1053b_play_speed_t *	speed )

get play speed

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*speed	pointer to a play speed buffer

Returns

status code

0 success
1 get play speed failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4859 of file driver_vs1053b.c.

◆ vs1053b_get_record_format()

uint8_t vs1053b_get_record_format	(	vs1053b_handle_t *	handle,
		vs1053b_record_format_t *	format )

get record format

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*format	pointer to a record format buffer

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 5928 of file driver_vs1053b.c.

◆ vs1053b_get_reference_voltage()

uint8_t vs1053b_get_reference_voltage	(	vs1053b_handle_t *	handle,
		vs1053b_reference_voltage_t *	voltage )

get reference voltage

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*voltage	pointer to a reference voltage buffer

Returns

status code

0 success
1 get reference voltage failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2955 of file driver_vs1053b.c.

◆ vs1053b_get_sample_rate()

uint8_t vs1053b_get_sample_rate	(	vs1053b_handle_t *	handle,
		uint16_t *	rate,
		vs1053b_channel_t *	channel )

get sample rate

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*rate	pointer to a sample rate buffer
[out]	*channel	pointer to a channel buffer

Returns

status code

0 success
1 get sample rate failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4099 of file driver_vs1053b.c.

◆ vs1053b_get_sdi_bit_order()

uint8_t vs1053b_get_sdi_bit_order	(	vs1053b_handle_t *	handle,
		vs1053b_bit_order_t *	order )

get sdi bit order

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*order	pointer to a bit order buffer

Returns

status code

0 success
1 get sdi bit order failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1549 of file driver_vs1053b.c.

◆ vs1053b_get_selector()

uint8_t vs1053b_get_selector	(	vs1053b_handle_t *	handle,
		vs1053b_selector_t *	selector )

get selector

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*selector	pointer to a param buffer

Returns

status code

0 success
1 get selector failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1949 of file driver_vs1053b.c.

◆ vs1053b_get_share_spi_chip_select()

uint8_t vs1053b_get_share_spi_chip_select	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t *	enable )

get share spi chip select status

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*enable	pointer to a bool buffer

Returns

status code

0 success
1 get share spi chip select failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1649 of file driver_vs1053b.c.

◆ vs1053b_get_soft_reset()

uint8_t vs1053b_get_soft_reset	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t *	enable )

get soft reset status

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*enable	pointer to a bool buffer

Returns

status code

0 success
1 get soft reset failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 849 of file driver_vs1053b.c.

◆ vs1053b_get_start_address()

uint8_t vs1053b_get_start_address	(	vs1053b_handle_t *	handle,
		uint16_t *	addr )

get start address

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*addr	pointer to an address buffer

Returns

status code

0 success
1 get start address failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4455 of file driver_vs1053b.c.

◆ vs1053b_get_stream_mode()

uint8_t vs1053b_get_stream_mode	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t *	enable )

get stream mode status

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*enable	pointer to a bool buffer

Returns

status code

0 success
1 get stream mode failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1249 of file driver_vs1053b.c.

◆ vs1053b_get_swing()

uint8_t vs1053b_get_swing	(	vs1053b_handle_t *	handle,
		uint8_t *	swing )

get swing

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*swing	pointer to a param buffer

Returns

status code

0 success
1 get swing failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2256 of file driver_vs1053b.c.

◆ vs1053b_get_treble_control()

uint8_t vs1053b_get_treble_control	(	vs1053b_handle_t *	handle,
		uint8_t *	db )

get treble control

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*db	pointer to a db buffer

Returns

status code

0 success
1 get treble control failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3062 of file driver_vs1053b.c.

◆ vs1053b_get_version()

uint8_t vs1053b_get_version	(	vs1053b_handle_t *	handle,
		uint8_t *	version )

get version

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*version	pointer to a version buffer

Returns

status code

0 success
1 get version failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2555 of file driver_vs1053b.c.

◆ vs1053b_get_vol()

uint8_t vs1053b_get_vol	(	vs1053b_handle_t *	handle,
		uint8_t *	left,
		uint8_t *	right )

get vol

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*left	pointer to a left vol buffer
[out]	*right	pointer to a right vol buffer

Returns

status code

0 success
1 get vol failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4546 of file driver_vs1053b.c.

◆ vs1053b_hard_reset()

uint8_t vs1053b_hard_reset ( vs1053b_handle_t * handle )

hard reset

Parameters

[in] *handle pointer to a vs1053b handle structure

Returns

status code

0 success
1 hard reset failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 7158 of file driver_vs1053b.c.

◆ vs1053b_info()

uint8_t vs1053b_info ( vs1053b_info_t * info )

get chip's information

Parameters

[out] *info pointer to a vs1053b info structure

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 8192 of file driver_vs1053b.c.

◆ vs1053b_init()

uint8_t vs1053b_init ( vs1053b_handle_t * handle )

initialize the chip

Parameters

[in] *handle pointer to a vs1053b handle structure

Returns

status code

0 success
1 spi initialization failed
2 handle is NULL
3 linked functions is NULL
4 reset or dreq gpio initialization failed
5 reset failed

Note: none

Definition at line 5956 of file driver_vs1053b.c.

◆ vs1053b_load_patch()

uint8_t vs1053b_load_patch	(	vs1053b_handle_t *	handle,
		const uint16_t *	patch,
		uint16_t	len )

load patch

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	*patch	pointer to a patch buffer
[in]	len	length of length

Returns

status code

0 success
1 load patch failed
2 handle is NULL
3 handle is not initialized
4 invalid path address

Note: none

Definition at line 7746 of file driver_vs1053b.c.

◆ vs1053b_lower_limit_frequency_in_1000_hz_convert_to_data()

uint8_t vs1053b_lower_limit_frequency_in_1000_hz_convert_to_data	(	vs1053b_handle_t *	handle,
		uint8_t	reg,
		uint32_t *	hz )

convert the register raw data to the lower limit frequency in 1000 hz

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	reg	register raw data
[out]	*hz	pointer to an hz buffer

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3295 of file driver_vs1053b.c.

◆ vs1053b_lower_limit_frequency_in_1000_hz_convert_to_register()

uint8_t vs1053b_lower_limit_frequency_in_1000_hz_convert_to_register	(	vs1053b_handle_t *	handle,
		uint32_t	hz,
		uint8_t *	reg )

convert the lower limit frequency in 1000 hz to the register raw data

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	hz	set hz
[out]	*reg	pointer to a register raw buffer

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3268 of file driver_vs1053b.c.

◆ vs1053b_lower_limit_frequency_in_10_hz_convert_to_data()

uint8_t vs1053b_lower_limit_frequency_in_10_hz_convert_to_data	(	vs1053b_handle_t *	handle,
		uint8_t	reg,
		uint32_t *	hz )

convert the register raw data to the lower limit frequency in 10 hz

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	reg	register raw data
[out]	*hz	pointer to an hz buffer

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3563 of file driver_vs1053b.c.

◆ vs1053b_lower_limit_frequency_in_10_hz_convert_to_register()

uint8_t vs1053b_lower_limit_frequency_in_10_hz_convert_to_register	(	vs1053b_handle_t *	handle,
		uint32_t	hz,
		uint8_t *	reg )

convert the lower limit frequency in 10 hz to the register raw data

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	hz	set hz
[out]	*reg	pointer to a register raw buffer

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3536 of file driver_vs1053b.c.

◆ vs1053b_parse_info()

uint8_t vs1053b_parse_info	(	vs1053b_handle_t *	handle,
		uint16_t	dat0,
		uint16_t	dat1,
		vs1053b_audio_info_t *	info )

parse info

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	dat0	hdata0
[in]	dat1	hdata1
[out]	*info	pointer to a vs1053b audio info structure

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 7267 of file driver_vs1053b.c.

◆ vs1053b_pause()

uint8_t vs1053b_pause ( vs1053b_handle_t * handle )

pause audio

Parameters

[in] *handle pointer to a vs1053b handle structure

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized
4 audio working

Note: none

Definition at line 6636 of file driver_vs1053b.c.

◆ vs1053b_play()

uint8_t vs1053b_play	(	vs1053b_handle_t *	handle,
		char *	path )

play audio

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	*path	pointer to a path buffer

Returns

status code

0 success
1 play failed
2 handle is NULL
3 handle is not initialized
4 audio working

Note: none

Definition at line 6670 of file driver_vs1053b.c.

◆ vs1053b_process()

uint8_t vs1053b_process ( vs1053b_handle_t * handle )

audio process

Parameters

[in] *handle pointer to a vs1053b handle structure

Returns

status code

0 success
1 process failed
2 handle is NULL
3 handle is not initialized
4 no working
5 status is invalid

Note: none

Definition at line 6327 of file driver_vs1053b.c.

◆ vs1053b_read_application()

uint8_t vs1053b_read_application	(	vs1053b_handle_t *	handle,
		vs1053b_application_t	num,
		uint8_t *	buf,
		uint16_t	len )

read application

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	num	application num
[out]	*buf	pointer to an output buffer
[in]	len	buffer length

Returns

status code

0 success
1 read application failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4722 of file driver_vs1053b.c.

◆ vs1053b_read_ram()

uint8_t vs1053b_read_ram	(	vs1053b_handle_t *	handle,
		uint8_t *	buf,
		uint16_t	len )

read ram

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[out]	*buf	pointer to an output buffer
[in]	len	buffer length

Returns

status code

0 success
1 read ram failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4188 of file driver_vs1053b.c.

◆ vs1053b_record()

uint8_t vs1053b_record	(	vs1053b_handle_t *	handle,
		char *	path,
		uint32_t	sample_rate )

record audio

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	*path	pointer to a path buffer
[in]	sample_rate	set sample rate

Returns

status code

0 success
1 record failed
2 handle is NULL
3 handle is not initialized
4 audio working
5 sample rate doesn't match patch

Note: none

Definition at line 6733 of file driver_vs1053b.c.

◆ vs1053b_set_ad_clock()

uint8_t vs1053b_set_ad_clock	(	vs1053b_handle_t *	handle,
		vs1053b_ad_clock_t	ad_clock )

set ad clock

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	ad_clock	ad clock

Returns

status code

0 success
1 set ad clock failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2800 of file driver_vs1053b.c.

◆ vs1053b_set_allow_sdi_test()

uint8_t vs1053b_set_allow_sdi_test	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t	enable )

enable or disable allow sdi test

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set allow sdi test failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1094 of file driver_vs1053b.c.

◆ vs1053b_set_allowed_multiplier_addition()

uint8_t vs1053b_set_allowed_multiplier_addition	(	vs1053b_handle_t *	handle,
		vs1053b_allowed_multiplier_addition_t	addition )

set allowed multiplier addition

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	addition	allowed multiplier addition

Returns

status code

0 success
1 set allowed multiplier addition failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3690 of file driver_vs1053b.c.

◆ vs1053b_set_analog_driver_power_down()

uint8_t vs1053b_set_analog_driver_power_down	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t	enable )

enable or disable analog driver power down

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set analog driver power down failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2600 of file driver_vs1053b.c.

◆ vs1053b_set_analog_internal_power_down()

uint8_t vs1053b_set_analog_internal_power_down	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t	enable )

enable or disable analog internal power down

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set analog internal power down failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2700 of file driver_vs1053b.c.

◆ vs1053b_set_bass_enhancement()

uint8_t vs1053b_set_bass_enhancement	(	vs1053b_handle_t *	handle,
		uint8_t	db )

set bass enhancement

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	db	set db

Returns

status code

0 success
1 set bass enhancement failed
2 handle is NULL
3 handle is not initialized
4 db > 15

Note: none

Definition at line 3323 of file driver_vs1053b.c.

◆ vs1053b_set_cancel_decoding_current_file()

uint8_t vs1053b_set_cancel_decoding_current_file	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t	enable )

enable or disable cancel decoding current file

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set cancel decoding current file failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 894 of file driver_vs1053b.c.

◆ vs1053b_set_clock_frequency()

uint8_t vs1053b_set_clock_frequency	(	vs1053b_handle_t *	handle,
		uint16_t	clk )

set clock frequency

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	clk	clock frequency

Returns

status code

0 success
1 set clock frequency failed
2 handle is NULL
3 handle is not initialized
4 clk > 0x3FF

Note: none

Definition at line 3791 of file driver_vs1053b.c.

◆ vs1053b_set_clock_multiplier()

uint8_t vs1053b_set_clock_multiplier	(	vs1053b_handle_t *	handle,
		vs1053b_clock_multiplier_t	multiplier )

set clock multiplier

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	multiplier	clock multiplier

Returns

status code

0 success
1 set clock multiplier failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3590 of file driver_vs1053b.c.

◆ vs1053b_set_clock_range()

uint8_t vs1053b_set_clock_range	(	vs1053b_handle_t *	handle,
		vs1053b_clock_range_t	range )

set clock range

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	range	clock range

Returns

status code

0 success
1 set clock range failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1994 of file driver_vs1053b.c.

◆ vs1053b_set_dclk_edge()

uint8_t vs1053b_set_dclk_edge	(	vs1053b_handle_t *	handle,
		vs1053b_dclk_edge_t	edge )

set dclk edge

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	edge	dclk edge

Returns

status code

0 success
1 set dclk edge failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1394 of file driver_vs1053b.c.

◆ vs1053b_set_decode_time()

uint8_t vs1053b_set_decode_time	(	vs1053b_handle_t *	handle,
		uint16_t	decode_time )

set decode time

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	decode_time	decode time

Returns

status code

0 success
1 set decode time failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3951 of file driver_vs1053b.c.

◆ vs1053b_set_diff()

uint8_t vs1053b_set_diff	(	vs1053b_handle_t *	handle,
		vs1053b_diff_t	diff )

set the audio differential

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	diff	audio differential

Returns

status code

0 success
1 set diff failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 593 of file driver_vs1053b.c.

◆ vs1053b_set_do_not_jump()

uint8_t vs1053b_set_do_not_jump	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t	enable )

enable or disable do not jump

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set do not jump failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2094 of file driver_vs1053b.c.

◆ vs1053b_set_ear_speaker_high_setting()

uint8_t vs1053b_set_ear_speaker_high_setting	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t	enable )

enable or disable ear speaker high setting

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set ear speaker high setting failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1294 of file driver_vs1053b.c.

◆ vs1053b_set_ear_speaker_low_setting()

uint8_t vs1053b_set_ear_speaker_low_setting	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t	enable )

enable or disable ear speaker low setting

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set ear speaker low setting failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 994 of file driver_vs1053b.c.

◆ vs1053b_set_gpio_direction()

uint8_t vs1053b_set_gpio_direction	(	vs1053b_handle_t *	handle,
		uint16_t	mask )

set gpio direction

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	mask	set gpio direction mask

Returns

status code

0 success
1 set gpio direction failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 5526 of file driver_vs1053b.c.

◆ vs1053b_set_gpio_output()

uint8_t vs1053b_set_gpio_output	(	vs1053b_handle_t *	handle,
		uint16_t	data )

set gpio output

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	data	set data

Returns

status code

0 success
1 set gpio output failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 5745 of file driver_vs1053b.c.

◆ vs1053b_set_iis()

uint8_t vs1053b_set_iis	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t	enable )

enable or disable iis

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set iis failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 5204 of file driver_vs1053b.c.

◆ vs1053b_set_iis_mclk()

uint8_t vs1053b_set_iis_mclk	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t	enable )

enable or disable iis mclk

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set iis mclk failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 5043 of file driver_vs1053b.c.

◆ vs1053b_set_iis_rate()

uint8_t vs1053b_set_iis_rate	(	vs1053b_handle_t *	handle,
		vs1053b_iis_rate_t	iis_rate )

set iis rate

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	iis_rate	set iis rate

Returns

status code

0 success
1 set iis rate failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 5365 of file driver_vs1053b.c.

◆ vs1053b_set_lower_limit_frequency_in_1000_hz()

uint8_t vs1053b_set_lower_limit_frequency_in_1000_hz	(	vs1053b_handle_t *	handle,
		uint8_t	step )

set lower limit frequency in 1000 hz

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	step	set step

Returns

status code

0 success
1 set lower limit frequency in 1000 hz failed
2 handle is NULL
3 handle is not initialized
4 step > 15

Note: none

Definition at line 3162 of file driver_vs1053b.c.

◆ vs1053b_set_lower_limit_frequency_in_10_hz()

uint8_t vs1053b_set_lower_limit_frequency_in_10_hz	(	vs1053b_handle_t *	handle,
		uint8_t	step )

set lower limit frequency in 10 hz

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	step	set step

Returns

status code

0 success
1 set lower limit frequency in 10 hz failed
2 handle is NULL
3 handle is not initialized
4 step > 15

Note: none

Definition at line 3430 of file driver_vs1053b.c.

◆ vs1053b_set_mpeg_layer_i_and_ii()

uint8_t vs1053b_set_mpeg_layer_i_and_ii	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t	enable )

enable or disable mpeg layer i and ii

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set mpeg layer i and ii failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 693 of file driver_vs1053b.c.

◆ vs1053b_set_native_spi_modes()

uint8_t vs1053b_set_native_spi_modes	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t	enable )

enable or disable native spi modes

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set native spi modes failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1694 of file driver_vs1053b.c.

◆ vs1053b_set_overload_detection()

uint8_t vs1053b_set_overload_detection	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t	enable )

enable or disable overload detection

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set overload detection failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2455 of file driver_vs1053b.c.

◆ vs1053b_set_overload_indicator()

uint8_t vs1053b_set_overload_indicator	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t	enable )

enable or disable overload indicator

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set overload indicator failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2355 of file driver_vs1053b.c.

◆ vs1053b_set_pcm_adpcm_recording_active()

uint8_t vs1053b_set_pcm_adpcm_recording_active	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t	enable )

enable or disable pcm adpcm recording active

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set pcm adpcm recording active failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1794 of file driver_vs1053b.c.

◆ vs1053b_set_period_callback()

uint8_t vs1053b_set_period_callback	(	vs1053b_handle_t *	handle,
		uint32_t	second,
		uint32_t	microsecond,
		vs1053b_bool_t	enable )

set period callback

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	second	set second
[in]	microsecond	set microsecond
[in]	enable	bool value

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 7208 of file driver_vs1053b.c.

◆ vs1053b_set_play_speed()

uint8_t vs1053b_set_play_speed	(	vs1053b_handle_t *	handle,
		vs1053b_play_speed_t	speed )

set play speed

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	speed	play speed

Returns

status code

0 success
1 set play speed failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4796 of file driver_vs1053b.c.

◆ vs1053b_set_ram_address()

uint8_t vs1053b_set_ram_address	(	vs1053b_handle_t *	handle,
		uint16_t	addr )

set ram address

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	addr	ram address

Returns

status code

0 success
1 set ram address failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4229 of file driver_vs1053b.c.

◆ vs1053b_set_record_format()

uint8_t vs1053b_set_record_format	(	vs1053b_handle_t *	handle,
		vs1053b_record_format_t	format )

set record format

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	format	set record format

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 5902 of file driver_vs1053b.c.

◆ vs1053b_set_reference_voltage()

uint8_t vs1053b_set_reference_voltage	(	vs1053b_handle_t *	handle,
		vs1053b_reference_voltage_t	voltage )

set reference voltage

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	voltage	reference voltage

Returns

status code

0 success
1 set reference voltage failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2900 of file driver_vs1053b.c.

◆ vs1053b_set_sample_rate()

uint8_t vs1053b_set_sample_rate	(	vs1053b_handle_t *	handle,
		uint16_t	rate,
		vs1053b_channel_t	channel )

set sample rate

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	rate	sample rate
[in]	channel	set channel

Returns

status code

0 success
1 set sample rate failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4052 of file driver_vs1053b.c.

◆ vs1053b_set_sdi_bit_order()

uint8_t vs1053b_set_sdi_bit_order	(	vs1053b_handle_t *	handle,
		vs1053b_bit_order_t	order )

set sdi bit order

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	order	bit order

Returns

status code

0 success
1 set sdi bit order failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1494 of file driver_vs1053b.c.

◆ vs1053b_set_selector()

uint8_t vs1053b_set_selector	(	vs1053b_handle_t *	handle,
		vs1053b_selector_t	selector )

set selector

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	selector	set param

Returns

status code

0 success
1 set selector failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1894 of file driver_vs1053b.c.

◆ vs1053b_set_share_spi_chip_select()

uint8_t vs1053b_set_share_spi_chip_select	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t	enable )

enable or disable share spi chip select

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set share spi chip select failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1594 of file driver_vs1053b.c.

◆ vs1053b_set_soft_reset()

uint8_t vs1053b_set_soft_reset	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t	enable )

enable or disable soft reset

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set soft reset failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 793 of file driver_vs1053b.c.

◆ vs1053b_set_start_address()

uint8_t vs1053b_set_start_address	(	vs1053b_handle_t *	handle,
		uint16_t	addr )

set start address

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	addr	start address

Returns

status code

0 success
1 set start address failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4411 of file driver_vs1053b.c.

◆ vs1053b_set_stream_mode()

uint8_t vs1053b_set_stream_mode	(	vs1053b_handle_t *	handle,
		vs1053b_bool_t	enable )

enable or disable stream mode

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	enable	bool value

Returns

status code

0 success
1 set stream mode failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 1194 of file driver_vs1053b.c.

◆ vs1053b_set_swing()

uint8_t vs1053b_set_swing	(	vs1053b_handle_t *	handle,
		uint8_t	swing )

set swing

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	swing	set param

Returns

status code

0 success
1 set swing failed
2 handle is NULL
3 handle is not initialized
4 swing > 7

Note: none

Definition at line 2195 of file driver_vs1053b.c.

◆ vs1053b_set_treble_control()

uint8_t vs1053b_set_treble_control	(	vs1053b_handle_t *	handle,
		uint8_t	db )

set treble control

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	db	set db

Returns

status code

0 success
1 set treble control failed
2 handle is NULL
3 handle is not initialized
4 db > 15

Note: none

Definition at line 3001 of file driver_vs1053b.c.

◆ vs1053b_set_vol()

uint8_t vs1053b_set_vol	(	vs1053b_handle_t *	handle,
		uint8_t	left,
		uint8_t	right )

set vol

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	left	left vol
[in]	right	right vol

Returns

status code

0 success
1 set vol failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4499 of file driver_vs1053b.c.

◆ vs1053b_stop()

uint8_t vs1053b_stop ( vs1053b_handle_t * handle )

stop audio

Parameters

[in] *handle pointer to a vs1053b handle structure

Returns

status code

0 success
1 stop failed
2 handle is NULL
3 handle is not initialized
4 audio not working
5 status is invalid

Note: none

Definition at line 6882 of file driver_vs1053b.c.

◆ vs1053b_swing_convert_to_data()

uint8_t vs1053b_swing_convert_to_data	(	vs1053b_handle_t *	handle,
		uint8_t	reg,
		float *	db )

convert the register raw data to the swing

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	reg	register raw data
[out]	*db	pointer to a db buffer

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2328 of file driver_vs1053b.c.

◆ vs1053b_swing_convert_to_register()

uint8_t vs1053b_swing_convert_to_register	(	vs1053b_handle_t *	handle,
		float	db,
		uint8_t *	reg )

convert the swing to the register raw data

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	db	set db
[out]	*reg	pointer to a register raw buffer

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 2301 of file driver_vs1053b.c.

◆ vs1053b_treble_control_convert_to_data()

uint8_t vs1053b_treble_control_convert_to_data	(	vs1053b_handle_t *	handle,
		uint8_t	reg,
		float *	db )

convert the register raw data to the treble control

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	reg	register raw data
[out]	*db	pointer to a db buffer

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3134 of file driver_vs1053b.c.

◆ vs1053b_treble_control_convert_to_register()

uint8_t vs1053b_treble_control_convert_to_register	(	vs1053b_handle_t *	handle,
		float	db,
		uint8_t *	reg )

convert the treble control to the register raw data

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	db	set db
[out]	*reg	pointer to a register raw buffer

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 3107 of file driver_vs1053b.c.

◆ vs1053b_vol_convert_to_data()

uint8_t vs1053b_vol_convert_to_data	(	vs1053b_handle_t *	handle,
		uint8_t	reg,
		float *	db )

convert the register raw data to vol

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	reg	register raw data
[out]	*db	pointer to a db buffer

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4617 of file driver_vs1053b.c.

◆ vs1053b_vol_convert_to_register()

uint8_t vs1053b_vol_convert_to_register	(	vs1053b_handle_t *	handle,
		float	db,
		uint8_t *	reg )

convert vol to the register raw data

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	db	set db
[out]	*reg	pointer to a register raw buffer

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4590 of file driver_vs1053b.c.

◆ vs1053b_write_application()

uint8_t vs1053b_write_application	(	vs1053b_handle_t *	handle,
		vs1053b_application_t	num,
		uint8_t *	buf,
		uint16_t	len )

write application

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	num	application num
[in]	*buf	pointer to an input buffer
[in]	len	buffer length

Returns

status code

0 success
1 write application failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4646 of file driver_vs1053b.c.

◆ vs1053b_write_ram()

uint8_t vs1053b_write_ram	(	vs1053b_handle_t *	handle,
		uint8_t *	buf,
		uint16_t	len )

write ram

Parameters

[in]	*handle	pointer to a vs1053b handle structure
[in]	*buf	pointer to an input buffer
[in]	len	buffer length

Returns

status code

0 success
1 write ram failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 4146 of file driver_vs1053b.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ VS1053B_AICTRL3_ADC_DUAL_CHANNEL

◆ VS1053B_AICTRL3_ADC_JOINT_STEREO

◆ VS1053B_AICTRL3_ADC_LEFT_CHANNEL

◆ VS1053B_AICTRL3_ADC_RIGHT_CHANNEL

◆ VS1053B_AICTRL3_MODE_IMA

◆ VS1053B_AICTRL3_MODE_LINEAR_PCM

◆ VS1053B_BUFFER_SIZE

◆ VS1053B_OGG_VENC08K1Q00

◆ VS1053B_OGG_VENC08K1Q01

◆ VS1053B_OGG_VENC08K1Q02

◆ VS1053B_OGG_VENC08K1Q03

◆ VS1053B_OGG_VENC08K1Q04

◆ VS1053B_OGG_VENC08K1Q05

◆ VS1053B_OGG_VENC08K1Q06

◆ VS1053B_OGG_VENC08K1Q07

◆ VS1053B_OGG_VENC08K1Q08

◆ VS1053B_OGG_VENC08K1Q09

◆ VS1053B_OGG_VENC08K1Q10

◆ VS1053B_OGG_VENC16K1Q00

◆ VS1053B_OGG_VENC16K1Q01

◆ VS1053B_OGG_VENC16K1Q02

◆ VS1053B_OGG_VENC16K1Q03

◆ VS1053B_OGG_VENC16K1Q04

◆ VS1053B_OGG_VENC16K1Q05

◆ VS1053B_OGG_VENC16K1Q06

◆ VS1053B_OGG_VENC16K1Q07

◆ VS1053B_OGG_VENC16K1Q08

◆ VS1053B_OGG_VENC16K1Q09

◆ VS1053B_OGG_VENC16K1Q10

◆ VS1053B_OGG_VENC16K2Q00

◆ VS1053B_OGG_VENC16K2Q01

◆ VS1053B_OGG_VENC16K2Q02

◆ VS1053B_OGG_VENC16K2Q03

◆ VS1053B_OGG_VENC16K2Q04

◆ VS1053B_OGG_VENC16K2Q05

◆ VS1053B_OGG_VENC16K2Q06

◆ VS1053B_OGG_VENC16K2Q07

◆ VS1053B_OGG_VENC16K2Q08

◆ VS1053B_OGG_VENC16K2Q09

◆ VS1053B_OGG_VENC16K2Q10

◆ VS1053B_OGG_VENC44K1Q00

◆ VS1053B_OGG_VENC44K1Q01

◆ VS1053B_OGG_VENC44K1Q02

◆ VS1053B_OGG_VENC44K1Q03

◆ VS1053B_OGG_VENC44K1Q04

◆ VS1053B_OGG_VENC44K1Q05

◆ VS1053B_OGG_VENC44K2Q00

◆ VS1053B_OGG_VENC44K2Q01

◆ VS1053B_OGG_VENC44K2Q02

◆ VS1053B_OGG_VENC44K2Q03

◆ VS1053B_OGG_VENC44K2Q04

◆ VS1053B_OGG_VENC44K2Q05

Typedef Documentation

◆ vs1053b_audio_info_t

◆ vs1053b_handle_t

◆ vs1053b_info_t

◆ vs1053b_wav_t

Enumeration Type Documentation

◆ vs1053b_ad_clock_t

◆ vs1053b_allowed_multiplier_addition_t

◆ vs1053b_application_t

◆ vs1053b_bit_order_t

◆ vs1053b_bool_t

◆ vs1053b_channel_t

◆ vs1053b_clock_multiplier_t

◆ vs1053b_clock_range_t

◆ vs1053b_dclk_edge_t

◆ vs1053b_diff_t

◆ vs1053b_format_t

◆ vs1053b_iis_rate_t

◆ vs1053b_patch_t

◆ vs1053b_play_speed_t

◆ vs1053b_record_format_t