LibDriver VS1053B
Loading...
Searching...
No Matches
vs1053b interface driver function
vs1053b driver function

vs1053b interface driver modules More...

Collaboration diagram for vs1053b interface driver function:

Functions

uint8_t vs1053b_interface_spi_cmd_init (void)
 interface spi cmd bus init
uint8_t vs1053b_interface_spi_cmd_deinit (void)
 interface spi cmd bus deinit
uint8_t vs1053b_interface_spi_cmd_read_address16 (uint16_t reg, uint8_t *buf, uint16_t len)
 interface spi cmd bus read
uint8_t vs1053b_interface_spi_cmd_write_address16 (uint16_t reg, uint8_t *buf, uint16_t len)
 interface spi cmd bus write
uint8_t vs1053b_interface_spi_dat_init (void)
 interface spi dat bus init
uint8_t vs1053b_interface_spi_dat_deinit (void)
 interface spi dat bus deinit
uint8_t vs1053b_interface_spi_dat_write_cmd (uint8_t *buf, uint16_t len)
 interface spi dat bus write command
uint8_t vs1053b_interface_audio_init (uint8_t type, char *name, uint32_t *size)
 interface audio init
uint8_t vs1053b_interface_audio_deinit (void)
 interface audio deinit
uint8_t vs1053b_interface_audio_read (uint32_t addr, uint16_t size, uint8_t *buffer)
 interface audio read
uint8_t vs1053b_interface_audio_write (uint32_t addr, uint16_t size, uint8_t *buffer)
 interface audio write
void vs1053b_interface_timestamp_read (uint32_t *sec, uint32_t *us)
 interface timestamp read
uint8_t vs1053b_interface_reset_gpio_init (void)
 interface reset gpio init
uint8_t vs1053b_interface_reset_gpio_deinit (void)
 interface reset gpio deinit
uint8_t vs1053b_interface_reset_gpio_write (uint8_t data)
 interface reset gpio write
uint8_t vs1053b_interface_dreq_gpio_init (void)
 interface dreq gpio init
uint8_t vs1053b_interface_dreq_gpio_deinit (void)
 interface dreq gpio deinit
uint8_t vs1053b_interface_dreq_gpio_read (uint8_t *data)
 interface dreq gpio read
void vs1053b_interface_delay_ms (uint32_t ms)
 interface delay ms
void vs1053b_interface_debug_print (const char *const fmt,...)
 interface print format data
void vs1053b_interface_receive_callback (uint8_t type, uint32_t cur_pos)
 interface receive callback

Detailed Description

vs1053b interface driver modules

Function Documentation

◆ vs1053b_interface_audio_deinit()

uint8_t vs1053b_interface_audio_deinit ( void )

interface audio deinit

Returns
status code
  • 0 success
  • 1 audio deinit failed
Note
none

Definition at line 183 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_audio_init()

uint8_t vs1053b_interface_audio_init ( uint8_t type,
char * name,
uint32_t * size )

interface audio init

Parameters
[in]typeopen type, 0 is read and 1 is write.
[in]*namepointer to a name buffer
[out]*sizepointer to a file size buffer
Returns
status code
  • 0 success
  • 1 audio init failed
Note
none

Definition at line 141 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_audio_read()

uint8_t vs1053b_interface_audio_read ( uint32_t addr,
uint16_t size,
uint8_t * buffer )

interface audio read

Parameters
[in]addrmp3 file address
[in]sizeread size
[out]*bufferpointer to a data buffer
Returns
status code
  • 0 success
  • 1 audio read failed
Note
none

Definition at line 156 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_audio_write()

uint8_t vs1053b_interface_audio_write ( uint32_t addr,
uint16_t size,
uint8_t * buffer )

interface audio write

Parameters
[in]addrmp3 file address
[in]sizewrite size
[in]*bufferpointer to a data buffer
Returns
status code
  • 0 success
  • 1 audio write failed
Note
none

Definition at line 171 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_debug_print()

void vs1053b_interface_debug_print ( const char *const fmt,
... )

interface print format data

Parameters
[in]fmtformat data
Note
none

Definition at line 291 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_delay_ms()

void vs1053b_interface_delay_ms ( uint32_t ms)

interface delay ms

Parameters
[in]mstime
Note
none

Definition at line 281 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_dreq_gpio_deinit()

uint8_t vs1053b_interface_dreq_gpio_deinit ( void )

interface dreq gpio deinit

Returns
status code
  • 0 success
  • 1 deinit failed
Note
none

Definition at line 258 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_dreq_gpio_init()

uint8_t vs1053b_interface_dreq_gpio_init ( void )

interface dreq gpio init

Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 246 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_dreq_gpio_read()

uint8_t vs1053b_interface_dreq_gpio_read ( uint8_t * data)

interface dreq gpio read

Parameters
[out]*datapointer to a data buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 271 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_receive_callback()

void vs1053b_interface_receive_callback ( uint8_t type,
uint32_t cur_pos )

interface receive callback

Parameters
[in]typereceive callback type
[in]cur_poscurrent position
Note
none

Definition at line 302 of file driver_vs1053b_interface_template.c.

Here is the call graph for this function:

◆ vs1053b_interface_reset_gpio_deinit()

uint8_t vs1053b_interface_reset_gpio_deinit ( void )

interface reset gpio deinit

Returns
status code
  • 0 success
  • 1 deinit failed
Note
none

Definition at line 221 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_reset_gpio_init()

uint8_t vs1053b_interface_reset_gpio_init ( void )

interface reset gpio init

Returns
status code
  • 0 success
  • 1 init failed
Note
none

Definition at line 209 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_reset_gpio_write()

uint8_t vs1053b_interface_reset_gpio_write ( uint8_t data)

interface reset gpio write

Parameters
[in]datawritten data
Returns
status code
  • 0 success
  • 1 write failed
Note
none

Definition at line 234 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_spi_cmd_deinit()

uint8_t vs1053b_interface_spi_cmd_deinit ( void )

interface spi cmd bus deinit

Returns
status code
  • 0 success
  • 1 spi deinit failed
Note
none

Definition at line 58 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_spi_cmd_init()

uint8_t vs1053b_interface_spi_cmd_init ( void )

interface spi cmd bus init

Returns
status code
  • 0 success
  • 1 spi init failed
Note
none

Definition at line 46 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_spi_cmd_read_address16()

uint8_t vs1053b_interface_spi_cmd_read_address16 ( uint16_t reg,
uint8_t * buf,
uint16_t len )

interface spi cmd bus read

Parameters
[in]regregister address
[out]*bufpointer to a data buffer
[in]lenlength of data buffer
Returns
status code
  • 0 success
  • 1 read failed
Note
none

Definition at line 73 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_spi_cmd_write_address16()

uint8_t vs1053b_interface_spi_cmd_write_address16 ( uint16_t reg,
uint8_t * buf,
uint16_t len )

interface spi cmd bus write

Parameters
[in]regregister address
[in]*bufpointer to a data buffer
[in]lenlength of data buffer
Returns
status code
  • 0 success
  • 1 write failed
Note
none

Definition at line 88 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_spi_dat_deinit()

uint8_t vs1053b_interface_spi_dat_deinit ( void )

interface spi dat bus deinit

Returns
status code
  • 0 success
  • 1 spi deinit failed
Note
none

Definition at line 112 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_spi_dat_init()

uint8_t vs1053b_interface_spi_dat_init ( void )

interface spi dat bus init

Returns
status code
  • 0 success
  • 1 spi init failed
Note
none

Definition at line 100 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_spi_dat_write_cmd()

uint8_t vs1053b_interface_spi_dat_write_cmd ( uint8_t * buf,
uint16_t len )

interface spi dat bus write command

Parameters
[in]*bufpointer to a data buffer
[in]lenlength of data buffer
Returns
status code
  • 0 success
  • 1 write failed
Note
none

Definition at line 126 of file driver_vs1053b_interface_template.c.

◆ vs1053b_interface_timestamp_read()

void vs1053b_interface_timestamp_read ( uint32_t * sec,
uint32_t * us )

interface timestamp read

Parameters
[out]*secpointer to a second buffer
[out]*uspointer to a microsecond buffer
Returns
status code
  • 0 success
  • 1 timestamp read failed
Note
none

Definition at line 197 of file driver_vs1053b_interface_template.c.