driver_syn6988.h

Go to the documentation of this file.

 
#ifndef DRIVER_SYN6988_H
#define DRIVER_SYN6988_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifndef SYN6988_BUSY_TIMEOUT
    #define SYN6988_BUSY_TIMEOUT        1000        
#endif
 
#define SYN6988_SOUND_101        "sound101"        
#define SYN6988_SOUND_102        "sound102"        
#define SYN6988_SOUND_103        "sound103"        
#define SYN6988_SOUND_104        "sound104"        
#define SYN6988_SOUND_105        "sound105"        
#define SYN6988_SOUND_106        "sound106"        
#define SYN6988_SOUND_107        "sound107"        
#define SYN6988_SOUND_108        "sound108"        
#define SYN6988_SOUND_109        "sound109"        
#define SYN6988_SOUND_110        "sound110"        
#define SYN6988_SOUND_111        "sound111"        
#define SYN6988_SOUND_112        "sound112"        
#define SYN6988_SOUND_113        "sound113"        
#define SYN6988_SOUND_114        "sound114"        
#define SYN6988_SOUND_115        "sound115"        
#define SYN6988_SOUND_116        "sound116"        
#define SYN6988_SOUND_117        "sound117"        
#define SYN6988_SOUND_118        "sound118"        
#define SYN6988_SOUND_119        "sound119"        
#define SYN6988_SOUND_120        "sound120"        
#define SYN6988_SOUND_121        "sound121"        
#define SYN6988_SOUND_122        "sound122"        
#define SYN6988_SOUND_123        "sound123"        
#define SYN6988_SOUND_124        "sound124"        
#define SYN6988_SOUND_201        "sound201"        
#define SYN6988_SOUND_202        "sound202"        
#define SYN6988_SOUND_203        "sound203"        
#define SYN6988_SOUND_204        "sound204"        
#define SYN6988_SOUND_205        "sound205"        
#define SYN6988_SOUND_206        "sound206"        
#define SYN6988_SOUND_207        "sound207"        
#define SYN6988_SOUND_208        "sound208"        
#define SYN6988_SOUND_209        "sound209"        
#define SYN6988_SOUND_301        "sound301"        
#define SYN6988_SOUND_302        "sound302"        
#define SYN6988_SOUND_303        "sound303"        
#define SYN6988_SOUND_304        "sound304"        
#define SYN6988_SOUND_305        "sound305"        
#define SYN6988_SOUND_306        "sound306"        
#define SYN6988_SOUND_307        "sound307"        
#define SYN6988_SOUND_308        "sound308"        
#define SYN6988_SOUND_309        "sound309"        
#define SYN6988_SOUND_310        "sound310"        
#define SYN6988_SOUND_311        "sound311"        
#define SYN6988_SOUND_312        "sound312"        
#define SYN6988_SOUND_313        "sound313"        
#define SYN6988_SOUND_314        "sound314"        
#define SYN6988_SOUND_315        "sound315"        
#define SYN6988_SOUND_316        "sound316"        
#define SYN6988_SOUND_317        "sound317"        
#define SYN6988_SOUND_318        "sound318"        
#define SYN6988_SOUND_401        "sound401"        
#define SYN6988_SOUND_402        "sound402"        
#define SYN6988_SOUND_403        "sound403"        
#define SYN6988_SOUND_404        "sound404"        
#define SYN6988_SOUND_405        "sound405"        
#define SYN6988_SOUND_406        "sound406"        
#define SYN6988_SOUND_407        "sound407"        
#define SYN6988_SOUND_408        "sound408"        
typedef enum
{
    SYN6988_INTERFACE_UART = 0x00,        
    SYN6988_INTERFACE_SPI  = 0x01,        
} syn6988_interface_t;
 
typedef enum
{
    SYN6988_TYPE_GB2312         = 0x00,         
    SYN6988_TYPE_GBK            = 0x01,         
    SYN6988_TYPE_BIG5           = 0x02,         
    SYN6988_TYPE_UNICODE_LITTLE = 0x03,         
    SYN6988_TYPE_UNICODE_BIG    = 0x04,         
} syn6988_type_t;
 
typedef enum
{
    SYN6988_STATUS_OK   = 0x00,         
    SYN6988_STATUS_BUSY = 0x01,         
} syn6988_status_t;
 
typedef enum
{
    SYN6988_LANGUAGE_AUTO    = 0,        
    SYN6988_LANGUAGE_CHINESE = 1,        
    SYN6988_LANGUAGE_ENGLISH = 2,        
} syn6988_language_t;
 
typedef struct syn6988_handle_s
{
    uint8_t (*gpio_ready_init)(void);                                       
    uint8_t (*gpio_ready_deinit)(void);                                     
    uint8_t (*gpio_ready_read)(uint8_t *value);                             
    uint8_t (*uart_init)(void);                                             
    uint8_t (*uart_deinit)(void);                                           
    uint16_t (*uart_read)(uint8_t *buf, uint16_t len);                      
    uint8_t (*uart_flush)(void);                                            
    uint8_t (*uart_write)(uint8_t *buf, uint16_t len);                      
    uint8_t (*spi_init)(void);                                              
    uint8_t (*spi_deinit)(void);                                            
    uint8_t (*spi_transmit)(uint8_t *tx, uint8_t *rx, uint16_t len);        
    void (*delay_ms)(uint32_t ms);                                          
    void (*debug_print)(const char *const fmt, ...);                        
    uint8_t inited;                                                         
    uint8_t uart_spi;                                                       
    uint8_t type;                                                           
    uint8_t buf[4096];                                                      
} syn6988_handle_t;
 
typedef struct syn6988_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[16];                
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} syn6988_info_t;
 
#define DRIVER_SYN6988_LINK_INIT(HANDLE, STRUCTURE)               memset(HANDLE, 0, sizeof(STRUCTURE))
 
#define DRIVER_SYN6988_LINK_UART_INIT(HANDLE, FUC)               (HANDLE)->uart_init = FUC
 
#define DRIVER_SYN6988_LINK_UART_DEINIT(HANDLE, FUC)             (HANDLE)->uart_deinit = FUC
 
#define DRIVER_SYN6988_LINK_UART_READ(HANDLE, FUC)               (HANDLE)->uart_read = FUC
 
#define DRIVER_SYN6988_LINK_UART_WRITE(HANDLE, FUC)              (HANDLE)->uart_write = FUC
 
#define DRIVER_SYN6988_LINK_UART_FLUSH(HANDLE, FUC)              (HANDLE)->uart_flush = FUC
 
#define DRIVER_SYN6988_LINK_SPI_INIT(HANDLE, FUC)                (HANDLE)->spi_init = FUC
 
#define DRIVER_SYN6988_LINK_SPI_DEINIT(HANDLE, FUC)              (HANDLE)->spi_deinit = FUC
 
#define DRIVER_SYN6988_LINK_SPI_TRANSMIT(HANDLE, FUC)            (HANDLE)->spi_transmit = FUC
 
#define DRIVER_SYN6988_LINK_GPIO_READY_INIT(HANDLE, FUC)         (HANDLE)->gpio_ready_init = FUC
 
#define DRIVER_SYN6988_LINK_GPIO_READY_DEINIT(HANDLE, FUC)       (HANDLE)->gpio_ready_deinit = FUC
 
#define DRIVER_SYN6988_LINK_GPIO_READY_READ(HANDLE, FUC)         (HANDLE)->gpio_ready_read = FUC
 
#define DRIVER_SYN6988_LINK_DELAY_MS(HANDLE, FUC)                (HANDLE)->delay_ms = FUC
 
#define DRIVER_SYN6988_LINK_DEBUG_PRINT(HANDLE, FUC)             (HANDLE)->debug_print = FUC
 
uint8_t syn6988_info(syn6988_info_t *info);
 
uint8_t syn6988_set_interface(syn6988_handle_t *handle, syn6988_interface_t interface);
 
uint8_t syn6988_get_interface(syn6988_handle_t *handle, syn6988_interface_t *interface);
 
uint8_t syn6988_init(syn6988_handle_t *handle);
 
uint8_t syn6988_deinit(syn6988_handle_t *handle);
 
uint8_t syn6988_set_text_type(syn6988_handle_t *handle, syn6988_type_t type);
 
uint8_t syn6988_get_text_type(syn6988_handle_t *handle, syn6988_type_t *type);
 
uint8_t syn6988_synthesis_text(syn6988_handle_t *handle, const char *const fmt, ...);
 
uint8_t syn6988_get_status(syn6988_handle_t *handle, syn6988_status_t *status);
 
uint8_t syn6988_stop(syn6988_handle_t *handle);
 
uint8_t syn6988_pause(syn6988_handle_t *handle);
 
uint8_t syn6988_resume(syn6988_handle_t *handle);
 
uint8_t syn6988_standby(syn6988_handle_t *handle);
 
uint8_t syn6988_wake_up(syn6988_handle_t *handle);
 
uint8_t syn6988_set_synthesis_volume(syn6988_handle_t *handle, uint8_t volume);
 
uint8_t syn6988_set_synthesis_speed(syn6988_handle_t *handle, uint8_t speed);
 
uint8_t syn6988_set_synthesis_language(syn6988_handle_t *handle, syn6988_language_t language);
 
uint8_t syn6988_set_command(syn6988_handle_t *handle, uint8_t command, uint32_t timeout);
 
uint8_t syn6988_set_command_with_arg(syn6988_handle_t *handle, uint8_t command, uint8_t param, char *txt, uint32_t timeout);
 
#ifdef __cplusplus
}
#endif
 
#endif