driver_isd17xx.h

Go to the documentation of this file.

 
#ifndef DRIVER_ISD17XX_H
#define DRIVER_ISD17XX_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif



typedef enum
{
    ISD1730  = 0x10,        
    ISD1740  = 0x16,        
    ISD1750  = 0x15,        
    ISD1760  = 0x14,        
    ISD1790  = 0x1A,        
    ISD17120 = 0x19,        
    ISD17150 = 0x18,        
    ISD17180 = 0x1E,        
    ISD17210 = 0x1D,        
    ISD17240 = 0x1C,        
} isd17xx_type_t;

typedef enum
{
    ISD17XX_BOOL_FALSE = 0x00,        
    ISD17XX_BOOL_TRUE  = 0x01,        
} isd17xx_bool_t;

typedef enum
{
    ISD17XX_ANALOG_OUTPUT_AUD = 0x00,        
    ISD17XX_ANALOG_OUTPUT_AUX = 0x01,        
} isd17xx_analog_output_t;

typedef enum
{
    ISD17XX_VOL_CONTROL_BUTTON = 0x00,        
    ISD17XX_VOL_CONTROL_REG    = 0x01,        
} isd17xx_vol_control_t;

typedef enum
{
    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_t;

typedef enum
{
    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_t;

typedef struct isd17xx_handle_s
{
    uint8_t (*spi_init)(void);                                              
    uint8_t (*spi_deinit)(void);                                            
    uint8_t (*spi_read)(uint8_t reg, uint8_t *buf, uint16_t len);           
    uint8_t (*spi_write)(uint8_t reg, uint8_t *buf, uint16_t len);          
    uint8_t (*spi_transmit)(uint8_t *tx, uint8_t *rx, uint16_t len);        
    uint8_t (*gpio_reset_init)(void);                                       
    uint8_t (*gpio_reset_deinit)(void);                                     
    uint8_t (*gpio_reset_write)(uint8_t level);                             
    void (*receive_callback)(uint16_t type);                                
    void (*delay_ms)(uint32_t ms);                                          
    void (*debug_print)(const char *const fmt, ...);                        
    uint16_t end_address;                                                   
    uint8_t vol_control;                                                    
    uint8_t type;                                                           
    uint8_t inited;                                                         
    uint8_t done;                                                           
} isd17xx_handle_t;

typedef struct isd17xx_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} isd17xx_info_t;



#define DRIVER_ISD17XX_LINK_INIT(HANDLE, STRUCTURE)               memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_ISD17XX_LINK_SPI_INIT(HANDLE, FUC)                 (HANDLE)->spi_init = FUC

#define DRIVER_ISD17XX_LINK_SPI_DEINIT(HANDLE, FUC)               (HANDLE)->spi_deinit = FUC

#define DRIVER_ISD17XX_LINK_SPI_READ(HANDLE, FUC)                 (HANDLE)->spi_read = FUC

#define DRIVER_ISD17XX_LINK_SPI_WRITE(HANDLE, FUC)                (HANDLE)->spi_write = FUC

#define DRIVER_ISD17XX_LINK_SPI_TRANSMIT(HANDLE, FUC)             (HANDLE)->spi_transmit = FUC

#define DRIVER_ISD17XX_LINK_GPIO_RESET_INIT(HANDLE, FUC)          (HANDLE)->gpio_reset_init = FUC

#define DRIVER_ISD17XX_LINK_GPIO_RESET_DEINIT(HANDLE, FUC)        (HANDLE)->gpio_reset_deinit = FUC

#define DRIVER_ISD17XX_LINK_GPIO_RESET_WRITE(HANDLE, FUC)         (HANDLE)->gpio_reset_write = FUC

#define DRIVER_ISD17XX_LINK_DELAY_MS(HANDLE, FUC)                 (HANDLE)->delay_ms = FUC

#define DRIVER_ISD17XX_LINK_DEBUG_PRINT(HANDLE, FUC)              (HANDLE)->debug_print = FUC

#define DRIVER_ISD17XX_LINK_RECEIVE_CALLBACK(HANDLE, FUC)         (HANDLE)->receive_callback = FUC



uint8_t isd17xx_info(isd17xx_info_t *info);

uint8_t isd17xx_set_type(isd17xx_handle_t *handle, isd17xx_type_t type);

uint8_t isd17xx_get_type(isd17xx_handle_t *handle, isd17xx_type_t *type);

uint8_t isd17xx_irq_handler(isd17xx_handle_t *handle);

uint8_t isd17xx_init(isd17xx_handle_t *handle);

uint8_t isd17xx_deinit(isd17xx_handle_t *handle);

uint8_t isd17xx_power_up(isd17xx_handle_t *handle);

uint8_t isd17xx_power_down(isd17xx_handle_t *handle);

uint8_t isd17xx_play(isd17xx_handle_t *handle);

uint8_t isd17xx_record(isd17xx_handle_t *handle);

uint8_t isd17xx_stop(isd17xx_handle_t *handle);

uint8_t isd17xx_erase(isd17xx_handle_t *handle);

uint8_t isd17xx_global_erase(isd17xx_handle_t *handle);

uint8_t isd17xx_next(isd17xx_handle_t *handle);

uint8_t isd17xx_check_memory(isd17xx_handle_t *handle);

uint8_t isd17xx_reset(isd17xx_handle_t *handle);

uint8_t isd17xx_hardware_reset(isd17xx_handle_t *handle);

uint8_t isd17xx_clear_interrupt(isd17xx_handle_t *handle);

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

uint8_t isd17xx_get_device_id(isd17xx_handle_t *handle, uint8_t *id);

uint8_t isd17xx_read_play_point(isd17xx_handle_t *handle, uint16_t *point);

uint8_t isd17xx_read_record_point(isd17xx_handle_t *handle, uint16_t *point);

uint8_t isd17xx_set_volume_control(isd17xx_handle_t *handle, isd17xx_vol_control_t control);

uint8_t isd17xx_get_volume_control(isd17xx_handle_t *handle, isd17xx_vol_control_t *control);

uint8_t isd17xx_set_volume(isd17xx_handle_t *handle, uint8_t vol);

uint8_t isd17xx_get_volume(isd17xx_handle_t *handle, uint8_t *vol);

uint8_t isd17xx_set_monitor_input(isd17xx_handle_t *handle, isd17xx_bool_t enable);

uint8_t isd17xx_get_monitor_input(isd17xx_handle_t *handle, isd17xx_bool_t *enable);

uint8_t isd17xx_set_mix_input(isd17xx_handle_t *handle, isd17xx_bool_t enable);

uint8_t isd17xx_get_mix_input(isd17xx_handle_t *handle, isd17xx_bool_t *enable);

uint8_t isd17xx_set_sound_effect_editing(isd17xx_handle_t *handle, isd17xx_bool_t enable);

uint8_t isd17xx_get_sound_effect_editing(isd17xx_handle_t *handle, isd17xx_bool_t *enable);

uint8_t isd17xx_set_spi_ft(isd17xx_handle_t *handle, isd17xx_bool_t enable);

uint8_t isd17xx_get_spi_ft(isd17xx_handle_t *handle, isd17xx_bool_t *enable);

uint8_t isd17xx_set_analog_output(isd17xx_handle_t *handle, isd17xx_analog_output_t output);

uint8_t isd17xx_get_analog_output(isd17xx_handle_t *handle, isd17xx_analog_output_t *output);

uint8_t isd17xx_set_pwm_speaker(isd17xx_handle_t *handle, isd17xx_bool_t enable);

uint8_t isd17xx_get_pwm_speaker(isd17xx_handle_t *handle, isd17xx_bool_t *enable);

uint8_t isd17xx_set_power_up_analog_output(isd17xx_handle_t *handle, isd17xx_bool_t enable);

uint8_t isd17xx_get_power_up_analog_output(isd17xx_handle_t *handle, isd17xx_bool_t *enable);

uint8_t isd17xx_set_v_alert(isd17xx_handle_t *handle, isd17xx_bool_t enable);

uint8_t isd17xx_get_v_alert(isd17xx_handle_t *handle, isd17xx_bool_t *enable);

uint8_t isd17xx_set_eom(isd17xx_handle_t *handle, isd17xx_bool_t enable);

uint8_t isd17xx_get_eom(isd17xx_handle_t *handle, isd17xx_bool_t *enable);

uint8_t isd17xx_write_to_nv(isd17xx_handle_t *handle);

uint8_t isd17xx_load_from_nv(isd17xx_handle_t *handle);

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

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

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

uint8_t isd17xx_toggle_extern_clock(isd17xx_handle_t *handle);



uint8_t isd17xx_set_reg(isd17xx_handle_t *handle, uint8_t cmd, uint8_t *buf, uint16_t len);

uint8_t isd17xx_get_reg(isd17xx_handle_t *handle, uint8_t cmd, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif