driver isd17xx source file More...

#include "driver_isd17xx.h"

Include dependency graph for driver_isd17xx.c:

Macros
#define	CHIP_NAME "Nuvoton ISD17XX"
	chip information definition
#define	MANUFACTURER_NAME "Nuvoton"
#define	SUPPLY_VOLTAGE_MIN 2.4f
#define	SUPPLY_VOLTAGE_MAX 5.5f
#define	MAX_CURRENT 20.0f
#define	TEMPERATURE_MIN -40.0f
#define	TEMPERATURE_MAX 85.0f
#define	DRIVER_VERSION 1000
#define	ISD17XX_COMMAND_PU 0x01
	chip command definition
#define	ISD17XX_COMMAND_STOP 0x02
#define	ISD17XX_COMMAND_RESET 0x03
#define	ISD17XX_COMMAND_CLR_INT 0x04
#define	ISD17XX_COMMAND_RD_STATUS 0x05
#define	ISD17XX_COMMAND_RD_PLAY_PTR 0x06
#define	ISD17XX_COMMAND_PD 0x07
#define	ISD17XX_COMMAND_RD_REC_PTR 0x08
#define	ISD17XX_COMMAND_DEVID 0x09
#define	ISD17XX_COMMAND_PLAY 0x40
#define	ISD17XX_COMMAND_REC 0x41
#define	ISD17XX_COMMAND_ERASE 0x42
#define	ISD17XX_COMMAND_G_ERASE 0x43
#define	ISD17XX_COMMAND_RD_APC 0x44
#define	ISD17XX_COMMAND_WR_APC1 0x45
#define	ISD17XX_COMMAND_WR_APC2 0x65
#define	ISD17XX_COMMAND_WR_NVCFG 0x46
#define	ISD17XX_COMMAND_LD_NVCFG 0x47
#define	ISD17XX_COMMAND_FWD 0x48
#define	ISD17XX_COMMAND_CHK_MEM 0x49
#define	ISD17XX_COMMAND_EXTCLK 0x4A
#define	ISD17XX_COMMAND_SET_PLAY 0x80
#define	ISD17XX_COMMAND_SET_REC 0x81
#define	ISD17XX_COMMAND_SET_ERASE 0x82

Functions
uint8_t	isd17xx_power_up (isd17xx_handle_t *handle)
	power up
uint8_t	isd17xx_stop (isd17xx_handle_t *handle)
	stop
uint8_t	isd17xx_reset (isd17xx_handle_t *handle)
	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_power_down (isd17xx_handle_t *handle)
	power down
uint8_t	isd17xx_get_device_id (isd17xx_handle_t handle, uint8_t id)
	get the device id
uint8_t	isd17xx_play (isd17xx_handle_t *handle)
	play
uint8_t	isd17xx_record (isd17xx_handle_t *handle)
	record
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_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 (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_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_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
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_hardware_reset (isd17xx_handle_t *handle)
	hardware reset
uint8_t	isd17xx_irq_handler (isd17xx_handle_t *handle)
	irq handler
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_set_reg (isd17xx_handle_t handle, uint8_t cmd, uint8_t buf, uint16_t len)
	set the chip register
uint8_t	isd17xx_get_reg (isd17xx_handle_t handle, uint8_t cmd, uint8_t buf, uint16_t len)
	get the chip register
uint8_t	isd17xx_info (isd17xx_info_t *info)
	get chip's information

Detailed Description

driver isd17xx source file

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Version: 1.0.0

Author: Shifeng Li

Date: 2022-10-31

history

Date	Version	Author	Description
2022/10/31	1.0	Shifeng Li	first upload

Definition in file driver_isd17xx.c.

Macro Definition Documentation

◆ CHIP_NAME

#define CHIP_NAME "Nuvoton ISD17XX"

chip information definition

chip name

Definition at line 42 of file driver_isd17xx.c.

◆ DRIVER_VERSION

#define DRIVER_VERSION 1000

driver version

Definition at line 49 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_CHK_MEM

#define ISD17XX_COMMAND_CHK_MEM 0x49

check memory command

Definition at line 73 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_CLR_INT

#define ISD17XX_COMMAND_CLR_INT 0x04

clear interrupt command

Definition at line 57 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_DEVID

#define ISD17XX_COMMAND_DEVID 0x09

device id command

Definition at line 62 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_ERASE

#define ISD17XX_COMMAND_ERASE 0x42

erase command

Definition at line 65 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_EXTCLK

#define ISD17XX_COMMAND_EXTCLK 0x4A

extern clock command

Definition at line 74 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_FWD

#define ISD17XX_COMMAND_FWD 0x48

forward command

Definition at line 72 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_G_ERASE

#define ISD17XX_COMMAND_G_ERASE 0x43

erase all command

Definition at line 66 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_LD_NVCFG

#define ISD17XX_COMMAND_LD_NVCFG 0x47

load nvcfg command

Definition at line 71 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_PD

#define ISD17XX_COMMAND_PD 0x07

power down command

Definition at line 60 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_PLAY

#define ISD17XX_COMMAND_PLAY 0x40

play command

Definition at line 63 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_PU

#define ISD17XX_COMMAND_PU 0x01

chip command definition

power up command

Definition at line 54 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_RD_APC

#define ISD17XX_COMMAND_RD_APC 0x44

read apc command

Definition at line 67 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_RD_PLAY_PTR

#define ISD17XX_COMMAND_RD_PLAY_PTR 0x06

read play point command

Definition at line 59 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_RD_REC_PTR

#define ISD17XX_COMMAND_RD_REC_PTR 0x08

read record point command

Definition at line 61 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_RD_STATUS

#define ISD17XX_COMMAND_RD_STATUS 0x05

read status command

Definition at line 58 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_REC

#define ISD17XX_COMMAND_REC 0x41

record command

Definition at line 64 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_RESET

#define ISD17XX_COMMAND_RESET 0x03

reset command

Definition at line 56 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_SET_ERASE

#define ISD17XX_COMMAND_SET_ERASE 0x82

set erase command

Definition at line 77 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_SET_PLAY

#define ISD17XX_COMMAND_SET_PLAY 0x80

set play command

Definition at line 75 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_SET_REC

#define ISD17XX_COMMAND_SET_REC 0x81

set record command

Definition at line 76 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_STOP

#define ISD17XX_COMMAND_STOP 0x02

stop command

Definition at line 55 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_WR_APC1

#define ISD17XX_COMMAND_WR_APC1 0x45

write apc1 command

Definition at line 68 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_WR_APC2

#define ISD17XX_COMMAND_WR_APC2 0x65

write apc2 command

Definition at line 69 of file driver_isd17xx.c.

◆ ISD17XX_COMMAND_WR_NVCFG

#define ISD17XX_COMMAND_WR_NVCFG 0x46

write nvcfg command

Definition at line 70 of file driver_isd17xx.c.

◆ MANUFACTURER_NAME

#define MANUFACTURER_NAME "Nuvoton"

manufacturer name

Definition at line 43 of file driver_isd17xx.c.

◆ MAX_CURRENT

#define MAX_CURRENT 20.0f

chip max current

Definition at line 46 of file driver_isd17xx.c.

◆ SUPPLY_VOLTAGE_MAX

#define SUPPLY_VOLTAGE_MAX 5.5f

chip max supply voltage

Definition at line 45 of file driver_isd17xx.c.

◆ SUPPLY_VOLTAGE_MIN

#define SUPPLY_VOLTAGE_MIN 2.4f

chip min supply voltage

Definition at line 44 of file driver_isd17xx.c.

◆ TEMPERATURE_MAX

#define TEMPERATURE_MAX 85.0f

chip max operating temperature

Definition at line 48 of file driver_isd17xx.c.

◆ TEMPERATURE_MIN

#define TEMPERATURE_MIN -40.0f

chip min operating temperature

Definition at line 47 of file driver_isd17xx.c.

Macros

Functions