LibDriver ISD17XX
Loading...
Searching...
No Matches
isd17xx base driver function

isd17xx base driver modules More...

Collaboration diagram for isd17xx base driver function:

Data Structures

struct  isd17xx_handle_s
 isd17xx handle structure definition More...
struct  isd17xx_info_s
 isd17xx information structure definition More...

Typedefs

typedef struct isd17xx_handle_s isd17xx_handle_t
 isd17xx handle structure definition
typedef struct isd17xx_info_s isd17xx_info_t
 isd17xx information structure definition

Enumerations

enum  isd17xx_type_t {
  ISD1730 = 0x10 , ISD1740 = 0x16 , ISD1750 = 0x15 , ISD1760 = 0x14 ,
  ISD1790 = 0x1A , ISD17120 = 0x19 , ISD17150 = 0x18 , ISD17180 = 0x1E ,
  ISD17210 = 0x1D , ISD17240 = 0x1C
}
 isd17xx type enumeration definition More...
enum  isd17xx_bool_t { ISD17XX_BOOL_FALSE = 0x00 , ISD17XX_BOOL_TRUE = 0x01 }
 isd17xx bool enumeration definition More...
enum  isd17xx_analog_output_t { ISD17XX_ANALOG_OUTPUT_AUD = 0x00 , ISD17XX_ANALOG_OUTPUT_AUX = 0x01 }
 isd17xx analog output enumeration definition More...
enum  isd17xx_vol_control_t { ISD17XX_VOL_CONTROL_BUTTON = 0x00 , ISD17XX_VOL_CONTROL_REG = 0x01 }
 isd17xx vol control enumeration definition More...
enum  isd17xx_status1_t {
  ISD17XX_STATUS1_CMD_ERR = (1 << 0) , ISD17XX_STATUS1_FULL = (1 << 1) , ISD17XX_STATUS1_PU = (1 << 2) , ISD17XX_STATUS1_EOM = (1 << 3) ,
  ISD17XX_STATUS1_INT = (1 << 4)
}
 isd17xx status1 enumeration definition More...
enum  isd17xx_status2_t {
  ISD17XX_STATUS2_RDY = (1 << 0) , ISD17XX_STATUS2_ERASE = (1 << 1) , ISD17XX_STATUS2_PLAY = (1 << 2) , ISD17XX_STATUS2_REC = (1 << 3) ,
  ISD17XX_STATUS2_SE4 = (1 << 4) , ISD17XX_STATUS2_SE3 = (1 << 5) , ISD17XX_STATUS2_SE2 = (1 << 6) , ISD17XX_STATUS2_SE1 = (1 << 7)
}
 isd17xx status2 enumeration definition More...

Functions

uint8_t isd17xx_info (isd17xx_info_t *info)
 get chip's information
uint8_t isd17xx_set_type (isd17xx_handle_t *handle, isd17xx_type_t type)
 set the chip type
uint8_t isd17xx_get_type (isd17xx_handle_t *handle, isd17xx_type_t *type)
 get the chip type
uint8_t isd17xx_irq_handler (isd17xx_handle_t *handle)
 irq handler
uint8_t isd17xx_init (isd17xx_handle_t *handle)
 initialize the chip
uint8_t isd17xx_deinit (isd17xx_handle_t *handle)
 close the chip
uint8_t isd17xx_power_up (isd17xx_handle_t *handle)
 power up
uint8_t isd17xx_power_down (isd17xx_handle_t *handle)
 power down
uint8_t isd17xx_play (isd17xx_handle_t *handle)
 play
uint8_t isd17xx_record (isd17xx_handle_t *handle)
 record
uint8_t isd17xx_stop (isd17xx_handle_t *handle)
 stop
uint8_t isd17xx_erase (isd17xx_handle_t *handle)
 erase
uint8_t isd17xx_global_erase (isd17xx_handle_t *handle)
 global erase
uint8_t isd17xx_next (isd17xx_handle_t *handle)
 next
uint8_t isd17xx_check_memory (isd17xx_handle_t *handle)
 check memory
uint8_t isd17xx_reset (isd17xx_handle_t *handle)
 reset
uint8_t isd17xx_hardware_reset (isd17xx_handle_t *handle)
 hardware reset
uint8_t isd17xx_clear_interrupt (isd17xx_handle_t *handle)
 clear interrupt
uint8_t isd17xx_get_status (isd17xx_handle_t *handle, uint16_t *status1, uint8_t *status2)
 get the status
uint8_t isd17xx_get_device_id (isd17xx_handle_t *handle, uint8_t *id)
 get the device id
uint8_t isd17xx_read_play_point (isd17xx_handle_t *handle, uint16_t *point)
 read the play point
uint8_t isd17xx_read_record_point (isd17xx_handle_t *handle, uint16_t *point)
 read the record point
uint8_t isd17xx_set_volume_control (isd17xx_handle_t *handle, isd17xx_vol_control_t control)
 set the volume control type
uint8_t isd17xx_get_volume_control (isd17xx_handle_t *handle, isd17xx_vol_control_t *control)
 get the volume control type
uint8_t isd17xx_set_volume (isd17xx_handle_t *handle, uint8_t vol)
 set the volume
uint8_t isd17xx_get_volume (isd17xx_handle_t *handle, uint8_t *vol)
 get the volume
uint8_t isd17xx_set_monitor_input (isd17xx_handle_t *handle, isd17xx_bool_t enable)
 enable or disable the monitor input
uint8_t isd17xx_get_monitor_input (isd17xx_handle_t *handle, isd17xx_bool_t *enable)
 get the monitor input status
uint8_t isd17xx_set_mix_input (isd17xx_handle_t *handle, isd17xx_bool_t enable)
 enable or disable the mix input
uint8_t isd17xx_get_mix_input (isd17xx_handle_t *handle, isd17xx_bool_t *enable)
 get the mix input status
uint8_t isd17xx_set_sound_effect_editing (isd17xx_handle_t *handle, isd17xx_bool_t enable)
 enable or disable sound effect editing
uint8_t isd17xx_get_sound_effect_editing (isd17xx_handle_t *handle, isd17xx_bool_t *enable)
 get the sound effect editing status
uint8_t isd17xx_set_spi_ft (isd17xx_handle_t *handle, isd17xx_bool_t enable)
 enable or disable spi ft
uint8_t isd17xx_get_spi_ft (isd17xx_handle_t *handle, isd17xx_bool_t *enable)
 get the spi ft status
uint8_t isd17xx_set_analog_output (isd17xx_handle_t *handle, isd17xx_analog_output_t output)
 set the analog output type
uint8_t isd17xx_get_analog_output (isd17xx_handle_t *handle, isd17xx_analog_output_t *output)
 get the analog output type
uint8_t isd17xx_set_pwm_speaker (isd17xx_handle_t *handle, isd17xx_bool_t enable)
 enable or disable pwm speaker
uint8_t isd17xx_get_pwm_speaker (isd17xx_handle_t *handle, isd17xx_bool_t *enable)
 get the pwm speaker status
uint8_t isd17xx_set_power_up_analog_output (isd17xx_handle_t *handle, isd17xx_bool_t enable)
 enable or disable power up analog output
uint8_t isd17xx_get_power_up_analog_output (isd17xx_handle_t *handle, isd17xx_bool_t *enable)
 get the power up analog output status
uint8_t isd17xx_set_v_alert (isd17xx_handle_t *handle, isd17xx_bool_t enable)
 enable or disable v alert
uint8_t isd17xx_get_v_alert (isd17xx_handle_t *handle, isd17xx_bool_t *enable)
 get the v alert status
uint8_t isd17xx_set_eom (isd17xx_handle_t *handle, isd17xx_bool_t enable)
 enable or disable eom stop playing
uint8_t isd17xx_get_eom (isd17xx_handle_t *handle, isd17xx_bool_t *enable)
 get the eom status
uint8_t isd17xx_write_to_nv (isd17xx_handle_t *handle)
 write config to non volatile memory
uint8_t isd17xx_load_from_nv (isd17xx_handle_t *handle)
 load config from non volatile memory
uint8_t isd17xx_set_play (isd17xx_handle_t *handle, uint16_t start_addr, uint16_t end_addr)
 set the play point
uint8_t isd17xx_set_record (isd17xx_handle_t *handle, uint16_t start_addr, uint16_t end_addr)
 set the record point
uint8_t isd17xx_set_erase (isd17xx_handle_t *handle, uint16_t start_addr, uint16_t end_addr)
 set the erase point
uint8_t isd17xx_toggle_extern_clock (isd17xx_handle_t *handle)
 toggle the enable and disable of the external clock

Detailed Description

isd17xx base driver modules

Typedef Documentation

◆ isd17xx_handle_t

isd17xx handle structure definition

◆ isd17xx_info_t

isd17xx information structure definition

Enumeration Type Documentation

◆ isd17xx_analog_output_t

isd17xx analog output enumeration definition

Enumerator
ISD17XX_ANALOG_OUTPUT_AUD 

aud

ISD17XX_ANALOG_OUTPUT_AUX 

aux

Definition at line 88 of file driver_isd17xx.h.

◆ isd17xx_bool_t

isd17xx bool enumeration definition

Enumerator
ISD17XX_BOOL_FALSE 

disable

ISD17XX_BOOL_TRUE 

enable

Definition at line 79 of file driver_isd17xx.h.

◆ isd17xx_status1_t

isd17xx status1 enumeration definition

Enumerator
ISD17XX_STATUS1_CMD_ERR 

command error

ISD17XX_STATUS1_FULL 

full

ISD17XX_STATUS1_PU 

power up

ISD17XX_STATUS1_EOM 

eom

ISD17XX_STATUS1_INT 

interrupt

Definition at line 106 of file driver_isd17xx.h.

◆ isd17xx_status2_t

isd17xx status2 enumeration definition

Enumerator
ISD17XX_STATUS2_RDY 

ready

ISD17XX_STATUS2_ERASE 

erase

ISD17XX_STATUS2_PLAY 

play

ISD17XX_STATUS2_REC 

record

ISD17XX_STATUS2_SE4 

se4

ISD17XX_STATUS2_SE3 

se3

ISD17XX_STATUS2_SE2 

se2

ISD17XX_STATUS2_SE1 

se1

Definition at line 118 of file driver_isd17xx.h.

◆ isd17xx_type_t

isd17xx type enumeration definition

Enumerator
ISD1730 

isd1730

ISD1740 

isd1740

ISD1750 

isd1750

ISD1760 

isd1760

ISD1790 

isd1790

ISD17120 

isd17120

ISD17150 

isd17150

ISD17180 

isd17180

ISD17210 

isd17210

ISD17240 

isd17240

Definition at line 62 of file driver_isd17xx.h.

◆ isd17xx_vol_control_t

isd17xx vol control enumeration definition

Enumerator
ISD17XX_VOL_CONTROL_BUTTON 

button control

ISD17XX_VOL_CONTROL_REG 

register control

Definition at line 97 of file driver_isd17xx.h.

Function Documentation

◆ isd17xx_check_memory()

uint8_t isd17xx_check_memory ( isd17xx_handle_t * handle)

check memory

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 check memory failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 770 of file driver_isd17xx.c.

◆ isd17xx_clear_interrupt()

uint8_t isd17xx_clear_interrupt ( isd17xx_handle_t * handle)

clear interrupt

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 clear interrupt failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 411 of file driver_isd17xx.c.

◆ isd17xx_deinit()

uint8_t isd17xx_deinit ( isd17xx_handle_t * handle)

close the chip

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 deinit failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 set power down failed
Note
none

Definition at line 2563 of file driver_isd17xx.c.

◆ isd17xx_erase()

uint8_t isd17xx_erase ( isd17xx_handle_t * handle)

erase

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 erase failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 656 of file driver_isd17xx.c.

◆ isd17xx_get_analog_output()

uint8_t isd17xx_get_analog_output ( isd17xx_handle_t * handle,
isd17xx_analog_output_t * output )

get the analog output type

Parameters
[in]*handlepointer to an isd17xx handle structure
[out]*outputpointer to an analog output type buffer
Returns
status code
  • 0 success
  • 1 get analog output failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1495 of file driver_isd17xx.c.

◆ isd17xx_get_device_id()

uint8_t isd17xx_get_device_id ( isd17xx_handle_t * handle,
uint8_t * id )

get the device id

Parameters
[in]*handlepointer to an isd17xx handle structure
[in]*idpointer to an id buffer
Returns
status code
  • 0 success
  • 1 get device id failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 539 of file driver_isd17xx.c.

◆ isd17xx_get_eom()

uint8_t isd17xx_get_eom ( isd17xx_handle_t * handle,
isd17xx_bool_t * enable )

get the eom status

Parameters
[in]*handlepointer to an isd17xx handle structure
[out]*enablepointer to a bool value buffer
Returns
status code
  • 0 success
  • 1 get eom failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1919 of file driver_isd17xx.c.

◆ isd17xx_get_mix_input()

uint8_t isd17xx_get_mix_input ( isd17xx_handle_t * handle,
isd17xx_bool_t * enable )

get the mix input status

Parameters
[in]*handlepointer to an isd17xx handle structure
[out]*enablepointer to a bool value buffer
Returns
status code
  • 0 success
  • 1 get mix input failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1177 of file driver_isd17xx.c.

◆ isd17xx_get_monitor_input()

uint8_t isd17xx_get_monitor_input ( isd17xx_handle_t * handle,
isd17xx_bool_t * enable )

get the monitor input status

Parameters
[in]*handlepointer to an isd17xx handle structure
[out]*enablepointer to a bool value buffer
Returns
status code
  • 0 success
  • 1 get monitor input failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1071 of file driver_isd17xx.c.

◆ isd17xx_get_power_up_analog_output()

uint8_t isd17xx_get_power_up_analog_output ( isd17xx_handle_t * handle,
isd17xx_bool_t * enable )

get the power up analog output status

Parameters
[in]*handlepointer to an isd17xx handle structure
[out]*enablepointer to a bool value buffer
Returns
status code
  • 0 success
  • 1 get power up analog output failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1707 of file driver_isd17xx.c.

◆ isd17xx_get_pwm_speaker()

uint8_t isd17xx_get_pwm_speaker ( isd17xx_handle_t * handle,
isd17xx_bool_t * enable )

get the pwm speaker status

Parameters
[in]*handlepointer to an isd17xx handle structure
[out]*enablepointer to a bool value buffer
Returns
status code
  • 0 success
  • 1 get pwm speaker failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1601 of file driver_isd17xx.c.

◆ isd17xx_get_sound_effect_editing()

uint8_t isd17xx_get_sound_effect_editing ( isd17xx_handle_t * handle,
isd17xx_bool_t * enable )

get the sound effect editing status

Parameters
[in]*handlepointer to an isd17xx handle structure
[out]*enablepointer to a bool value buffer
Returns
status code
  • 0 success
  • 1 get sound effect editing failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1283 of file driver_isd17xx.c.

◆ isd17xx_get_spi_ft()

uint8_t isd17xx_get_spi_ft ( isd17xx_handle_t * handle,
isd17xx_bool_t * enable )

get the spi ft status

Parameters
[in]*handlepointer to an isd17xx handle structure
[out]*enablepointer to a bool value buffer
Returns
status code
  • 0 success
  • 1 get spi ft failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1389 of file driver_isd17xx.c.

◆ isd17xx_get_status()

uint8_t isd17xx_get_status ( isd17xx_handle_t * handle,
uint16_t * status1,
uint8_t * status2 )

get the status

Parameters
[in]*handlepointer to an isd17xx handle structure
[in]*status1pointer to a status1 buffer
[out]*status2pointer to a status2 buffer
Returns
status code
  • 0 success
  • 1 get status failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 449 of file driver_isd17xx.c.

◆ isd17xx_get_type()

uint8_t isd17xx_get_type ( isd17xx_handle_t * handle,
isd17xx_type_t * type )

get the chip type

Parameters
[in]*handlepointer to an isd17xx handle structure
[out]*typepointer to a chip type buffer
Returns
status code
  • 0 success
  • 2 handle is NULL
Note
none

Definition at line 2718 of file driver_isd17xx.c.

◆ isd17xx_get_v_alert()

uint8_t isd17xx_get_v_alert ( isd17xx_handle_t * handle,
isd17xx_bool_t * enable )

get the v alert status

Parameters
[in]*handlepointer to an isd17xx handle structure
[out]*enablepointer to a bool value buffer
Returns
status code
  • 0 success
  • 1 get v alert failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1813 of file driver_isd17xx.c.

◆ isd17xx_get_volume()

uint8_t isd17xx_get_volume ( isd17xx_handle_t * handle,
uint8_t * vol )

get the volume

Parameters
[in]*handlepointer to an isd17xx handle structure
[out]*volpointer to a volume buffer
Returns
status code
  • 0 success
  • 1 get volume failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 965 of file driver_isd17xx.c.

◆ isd17xx_get_volume_control()

uint8_t isd17xx_get_volume_control ( isd17xx_handle_t * handle,
isd17xx_vol_control_t * control )

get the volume control type

Parameters
[in]*handlepointer to an isd17xx handle structure
[out]*controlpointer to a volume control type buffer
Returns
status code
  • 0 success
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 2023 of file driver_isd17xx.c.

◆ isd17xx_global_erase()

uint8_t isd17xx_global_erase ( isd17xx_handle_t * handle)

global erase

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 global erase failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 694 of file driver_isd17xx.c.

◆ isd17xx_hardware_reset()

uint8_t isd17xx_hardware_reset ( isd17xx_handle_t * handle)

hardware reset

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 reset failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 2610 of file driver_isd17xx.c.

◆ isd17xx_info()

uint8_t isd17xx_info ( isd17xx_info_t * info)

get chip's information

Parameters
[out]*infopointer to an isd17xx info structure
Returns
status code
  • 0 success
  • 2 handle is NULL
Note
none

Definition at line 2792 of file driver_isd17xx.c.

◆ isd17xx_init()

uint8_t isd17xx_init ( isd17xx_handle_t * handle)

initialize the chip

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 spi or gpio initialization failed
  • 2 handle is NULL
  • 3 linked functions is NULL
  • 4 get device id failed.
  • 5 chip type is invalid
  • 6 unknown type
  • 7 set power up failed
  • 8 set reset failed
Note
spi need lsb fist

Definition at line 2324 of file driver_isd17xx.c.

◆ isd17xx_irq_handler()

uint8_t isd17xx_irq_handler ( isd17xx_handle_t * handle)

irq handler

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 run failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 2639 of file driver_isd17xx.c.

Here is the call graph for this function:

◆ isd17xx_load_from_nv()

uint8_t isd17xx_load_from_nv ( isd17xx_handle_t * handle)

load config from non volatile memory

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 load from nvc failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 2083 of file driver_isd17xx.c.

◆ isd17xx_next()

uint8_t isd17xx_next ( isd17xx_handle_t * handle)

next

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 next failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 732 of file driver_isd17xx.c.

◆ isd17xx_play()

uint8_t isd17xx_play ( isd17xx_handle_t * handle)

play

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 play failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 580 of file driver_isd17xx.c.

◆ isd17xx_power_down()

uint8_t isd17xx_power_down ( isd17xx_handle_t * handle)

power down

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 power down failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 502 of file driver_isd17xx.c.

◆ isd17xx_power_up()

uint8_t isd17xx_power_up ( isd17xx_handle_t * handle)

power up

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 power up failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 301 of file driver_isd17xx.c.

◆ isd17xx_read_play_point()

uint8_t isd17xx_read_play_point ( isd17xx_handle_t * handle,
uint16_t * point )

read the play point

Parameters
[in]*handlepointer to an isd17xx handle structure
[out]*pointpointer to a play point buffer
Returns
status code
  • 0 success
  • 1 read play point failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 807 of file driver_isd17xx.c.

◆ isd17xx_read_record_point()

uint8_t isd17xx_read_record_point ( isd17xx_handle_t * handle,
uint16_t * point )

read the record point

Parameters
[in]*handlepointer to an isd17xx handle structure
[out]*pointpointer to a record point buffer
Returns
status code
  • 0 success
  • 1 read record point failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 850 of file driver_isd17xx.c.

◆ isd17xx_record()

uint8_t isd17xx_record ( isd17xx_handle_t * handle)

record

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 record failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 618 of file driver_isd17xx.c.

◆ isd17xx_reset()

uint8_t isd17xx_reset ( isd17xx_handle_t * handle)

reset

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 reset failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 375 of file driver_isd17xx.c.

◆ isd17xx_set_analog_output()

uint8_t isd17xx_set_analog_output ( isd17xx_handle_t * handle,
isd17xx_analog_output_t output )

set the analog output type

Parameters
[in]*handlepointer to an isd17xx handle structure
[in]outputanalog output type
Returns
status code
  • 0 success
  • 1 set analog output failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1431 of file driver_isd17xx.c.

◆ isd17xx_set_eom()

uint8_t isd17xx_set_eom ( isd17xx_handle_t * handle,
isd17xx_bool_t enable )

enable or disable eom stop playing

Parameters
[in]*handlepointer to an isd17xx handle structure
[in]enablebool value
Returns
status code
  • 0 success
  • 1 set eom failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1855 of file driver_isd17xx.c.

◆ isd17xx_set_erase()

uint8_t isd17xx_set_erase ( isd17xx_handle_t * handle,
uint16_t start_addr,
uint16_t end_addr )

set the erase point

Parameters
[in]*handlepointer to an isd17xx handle structure
[in]start_addrstart address
[in]end_addrend address
Returns
status code
  • 0 success
  • 1 set erase failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 start_addr >= end_addr
  • 5 address is invalid
Note
none

Definition at line 2233 of file driver_isd17xx.c.

◆ isd17xx_set_mix_input()

uint8_t isd17xx_set_mix_input ( isd17xx_handle_t * handle,
isd17xx_bool_t enable )

enable or disable the mix input

Parameters
[in]*handlepointer to an isd17xx handle structure
[in]enablebool value
Returns
status code
  • 0 success
  • 1 set mix input failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1113 of file driver_isd17xx.c.

◆ isd17xx_set_monitor_input()

uint8_t isd17xx_set_monitor_input ( isd17xx_handle_t * handle,
isd17xx_bool_t enable )

enable or disable the monitor input

Parameters
[in]*handlepointer to an isd17xx handle structure
[in]enablebool value
Returns
status code
  • 0 success
  • 1 set monitor input failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1007 of file driver_isd17xx.c.

◆ isd17xx_set_play()

uint8_t isd17xx_set_play ( isd17xx_handle_t * handle,
uint16_t start_addr,
uint16_t end_addr )

set the play point

Parameters
[in]*handlepointer to an isd17xx handle structure
[in]start_addrstart address
[in]end_addrend address
Returns
status code
  • 0 success
  • 1 set play failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 start_addr >= end_addr
  • 5 address is invalid
Note
none

Definition at line 2121 of file driver_isd17xx.c.

◆ isd17xx_set_power_up_analog_output()

uint8_t isd17xx_set_power_up_analog_output ( isd17xx_handle_t * handle,
isd17xx_bool_t enable )

enable or disable power up analog output

Parameters
[in]*handlepointer to an isd17xx handle structure
[in]enablebool value
Returns
status code
  • 0 success
  • 1 set power up analog output failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1643 of file driver_isd17xx.c.

◆ isd17xx_set_pwm_speaker()

uint8_t isd17xx_set_pwm_speaker ( isd17xx_handle_t * handle,
isd17xx_bool_t enable )

enable or disable pwm speaker

Parameters
[in]*handlepointer to an isd17xx handle structure
[in]enablebool value
Returns
status code
  • 0 success
  • 1 set pwm speaker failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1537 of file driver_isd17xx.c.

◆ isd17xx_set_record()

uint8_t isd17xx_set_record ( isd17xx_handle_t * handle,
uint16_t start_addr,
uint16_t end_addr )

set the record point

Parameters
[in]*handlepointer to an isd17xx handle structure
[in]start_addrstart address
[in]end_addrend address
Returns
status code
  • 0 success
  • 1 set record failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 start_addr >= end_addr
  • 5 address is invalid
Note
none

Definition at line 2177 of file driver_isd17xx.c.

◆ isd17xx_set_sound_effect_editing()

uint8_t isd17xx_set_sound_effect_editing ( isd17xx_handle_t * handle,
isd17xx_bool_t enable )

enable or disable sound effect editing

Parameters
[in]*handlepointer to an isd17xx handle structure
[in]enablebool value
Returns
status code
  • 0 success
  • 1 set sound effect editing failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1219 of file driver_isd17xx.c.

◆ isd17xx_set_spi_ft()

uint8_t isd17xx_set_spi_ft ( isd17xx_handle_t * handle,
isd17xx_bool_t enable )

enable or disable spi ft

Parameters
[in]*handlepointer to an isd17xx handle structure
[in]enablebool value
Returns
status code
  • 0 success
  • 1 set spi ft failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1325 of file driver_isd17xx.c.

◆ isd17xx_set_type()

uint8_t isd17xx_set_type ( isd17xx_handle_t * handle,
isd17xx_type_t type )

set the chip type

Parameters
[in]*handlepointer to an isd17xx handle structure
[in]typechip type
Returns
status code
  • 0 success
  • 2 handle is NULL
Note
none

Definition at line 2697 of file driver_isd17xx.c.

◆ isd17xx_set_v_alert()

uint8_t isd17xx_set_v_alert ( isd17xx_handle_t * handle,
isd17xx_bool_t enable )

enable or disable v alert

Parameters
[in]*handlepointer to an isd17xx handle structure
[in]enablebool value
Returns
status code
  • 0 success
  • 1 set v alert failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1749 of file driver_isd17xx.c.

◆ isd17xx_set_volume()

uint8_t isd17xx_set_volume ( isd17xx_handle_t * handle,
uint8_t vol )

set the volume

Parameters
[in]*handlepointer to an isd17xx handle structure
[in]volset volume
Returns
status code
  • 0 success
  • 1 set volume failed
  • 2 handle is NULL
  • 3 handle is not initialized
  • 4 vol is over 7
Note
-4dB per step volume adjustment 0 is max and 7 is min

Definition at line 895 of file driver_isd17xx.c.

◆ isd17xx_set_volume_control()

uint8_t isd17xx_set_volume_control ( isd17xx_handle_t * handle,
isd17xx_vol_control_t control )

set the volume control type

Parameters
[in]*handlepointer to an isd17xx handle structure
[in]controlvolume control type
Returns
status code
  • 0 success
  • 1 set volume control failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 1961 of file driver_isd17xx.c.

◆ isd17xx_stop()

uint8_t isd17xx_stop ( isd17xx_handle_t * handle)

stop

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 stop failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 338 of file driver_isd17xx.c.

◆ isd17xx_toggle_extern_clock()

uint8_t isd17xx_toggle_extern_clock ( isd17xx_handle_t * handle)

toggle the enable and disable of the external clock

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 toggle extern clock failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 2285 of file driver_isd17xx.c.

◆ isd17xx_write_to_nv()

uint8_t isd17xx_write_to_nv ( isd17xx_handle_t * handle)

write config to non volatile memory

Parameters
[in]*handlepointer to an isd17xx handle structure
Returns
status code
  • 0 success
  • 1 write to nvc failed
  • 2 handle is NULL
  • 3 handle is not initialized
Note
none

Definition at line 2049 of file driver_isd17xx.c.