LibDriver ISD17XX
Loading...
Searching...
No Matches
driver_isd17xx.h File Reference

driver isd17xx header file More...

#include <stdio.h>
#include <stdint.h>
#include <string.h>
Include dependency graph for driver_isd17xx.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

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

Macros

#define DRIVER_ISD17XX_LINK_INIT(HANDLE, STRUCTURE)
 initialize isd17xx_handle_t structure
#define DRIVER_ISD17XX_LINK_SPI_INIT(HANDLE, FUC)
 link spi_init function
#define DRIVER_ISD17XX_LINK_SPI_DEINIT(HANDLE, FUC)
 link spi_deinit function
#define DRIVER_ISD17XX_LINK_SPI_READ(HANDLE, FUC)
 link spi_read function
#define DRIVER_ISD17XX_LINK_SPI_WRITE(HANDLE, FUC)
 link spi_write function
#define DRIVER_ISD17XX_LINK_SPI_TRANSMIT(HANDLE, FUC)
 link spi_transmit function
#define DRIVER_ISD17XX_LINK_GPIO_RESET_INIT(HANDLE, FUC)
 link gpio_reset_init function
#define DRIVER_ISD17XX_LINK_GPIO_RESET_DEINIT(HANDLE, FUC)
 link gpio_reset_deinit function
#define DRIVER_ISD17XX_LINK_GPIO_RESET_WRITE(HANDLE, FUC)
 link gpio_reset_write function
#define DRIVER_ISD17XX_LINK_DELAY_MS(HANDLE, FUC)
 link delay_ms function
#define DRIVER_ISD17XX_LINK_DEBUG_PRINT(HANDLE, FUC)
 link debug_print function
#define DRIVER_ISD17XX_LINK_RECEIVE_CALLBACK(HANDLE, FUC)
 link receive_callback function

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
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

Detailed Description

driver isd17xx header file

Copyright (c) 2015 - present LibDriver All rights reserved

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.h.