driver_syn6288.h

Go to the documentation of this file.

 
#ifndef DRIVER_SYN6288_H
#define DRIVER_SYN6288_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif
 
typedef enum
{
    SYN6288_SOUND_A = 'a',        
    SYN6288_SOUND_B = 'b',        
    SYN6288_SOUND_C = 'c',        
    SYN6288_SOUND_D = 'd',        
    SYN6288_SOUND_E = 'e',        
    SYN6288_SOUND_F = 'f',        
    SYN6288_SOUND_G = 'g',        
    SYN6288_SOUND_H = 'h',        
    SYN6288_SOUND_I = 'i',        
    SYN6288_SOUND_J = 'j',        
    SYN6288_SOUND_K = 'k',        
    SYN6288_SOUND_L = 'l',        
    SYN6288_SOUND_M = 'm',        
    SYN6288_SOUND_N = 'n',        
    SYN6288_SOUND_O = 'o',        
    SYN6288_SOUND_P = 'p',        
    SYN6288_SOUND_Q = 'q',        
    SYN6288_SOUND_R = 'r',        
    SYN6288_SOUND_S = 's',        
    SYN6288_SOUND_T = 't',        
    SYN6288_SOUND_U = 'u',        
    SYN6288_SOUND_V = 'v',        
    SYN6288_SOUND_W = 'w',        
    SYN6288_SOUND_X = 'x',        
    SYN6288_SOUND_Y = 'y',        
} syn6288_sound_t;
 
typedef enum
{
    SYN6288_MESSAGE_A = 'a',        
    SYN6288_MESSAGE_B = 'b',        
    SYN6288_MESSAGE_C = 'c',        
    SYN6288_MESSAGE_D = 'd',        
    SYN6288_MESSAGE_E = 'e',        
    SYN6288_MESSAGE_F = 'f',        
    SYN6288_MESSAGE_G = 'g',        
    SYN6288_MESSAGE_H = 'h',        
} syn6288_message_t;
 
typedef enum
{
    SYN6288_RING_A = 'a',        
    SYN6288_RING_B = 'b',        
    SYN6288_RING_C = 'c',        
    SYN6288_RING_D = 'd',        
    SYN6288_RING_E = 'e',        
    SYN6288_RING_F = 'f',        
    SYN6288_RING_G = 'g',        
    SYN6288_RING_H = 'h',        
    SYN6288_RING_I = 'i',        
    SYN6288_RING_J = 'j',        
    SYN6288_RING_K = 'k',        
    SYN6288_RING_L = 'l',        
    SYN6288_RING_M = 'm',        
    SYN6288_RING_N = 'n',        
    SYN6288_RING_O = 'o',        
} syn6288_ring_t;
 
typedef enum
{
    SYN6288_TYPE_GB2312  = 0x00,         
    SYN6288_TYPE_GBK     = 0x01,         
    SYN6288_TYPE_BIG5    = 0x02,         
    SYN6288_TYPE_UNICODE = 0x03,         
} syn6288_type_t;
 
typedef enum
{
    SYN6288_STATUS_OK   = 0x00,         
    SYN6288_STATUS_BUSY = 0x01,         
} syn6288_status_t;
 
typedef enum
{
    SYN6288_MODE_COMMON        = (0x00),           
    SYN6288_MODE_BACKGROUND_1  = (1 << 3),         
    SYN6288_MODE_BACKGROUND_2  = (2 << 3),         
    SYN6288_MODE_BACKGROUND_3  = (3 << 3),         
    SYN6288_MODE_BACKGROUND_4  = (4 << 3),         
    SYN6288_MODE_BACKGROUND_5  = (5 << 3),         
    SYN6288_MODE_BACKGROUND_6  = (6 << 3),         
    SYN6288_MODE_BACKGROUND_7  = (7 << 3),         
    SYN6288_MODE_BACKGROUND_8  = (8 << 3),         
    SYN6288_MODE_BACKGROUND_9  = (9 << 3),         
    SYN6288_MODE_BACKGROUND_10 = (10 << 3),        
    SYN6288_MODE_BACKGROUND_11 = (11 << 3),        
    SYN6288_MODE_BACKGROUND_12 = (12 << 3),        
    SYN6288_MODE_BACKGROUND_13 = (13 << 3),        
    SYN6288_MODE_BACKGROUND_14 = (14 << 3),        
    SYN6288_MODE_BACKGROUND_15 = (15 << 3),        
} syn6288_mode_t;
 
 
typedef enum
{
    SYN6288_BAUD_RATE_9600_BPS  = 0x00,         
    SYN6288_BAUD_RATE_19200_BPS = 0x01,         
    SYN6288_BAUD_RATE_38400_BPS = 0x02,         
} syn6288_baud_rate_t;
 
typedef struct syn6288_handle_s
{
    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);        
    void (*delay_ms)(uint32_t ms);                            
    void (*debug_print)(const char *const fmt, ...);          
    uint8_t type;                                             
    uint8_t mode;                                             
    uint8_t rate;                                             
    uint8_t volume;                                           
    uint8_t background_volume;                                
    uint8_t speed;                                            
    uint8_t inited;                                           
    uint8_t buf[256];                                         
} syn6288_handle_t;
 
typedef struct syn6288_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;           
} syn6288_info_t;
 
#define DRIVER_SYN6288_LINK_INIT(HANDLE, STRUCTURE)   memset(HANDLE, 0, sizeof(STRUCTURE))
 
#define DRIVER_SYN6288_LINK_UART_INIT(HANDLE, FUC)   (HANDLE)->uart_init = FUC
 
#define DRIVER_SYN6288_LINK_UART_DEINIT(HANDLE, FUC) (HANDLE)->uart_deinit = FUC
 
#define DRIVER_SYN6288_LINK_UART_READ(HANDLE, FUC)   (HANDLE)->uart_read = FUC
 
#define DRIVER_SYN6288_LINK_UART_WRITE(HANDLE, FUC)  (HANDLE)->uart_write = FUC
 
#define DRIVER_SYN6288_LINK_UART_FLUSH(HANDLE, FUC)  (HANDLE)->uart_flush = FUC
 
#define DRIVER_SYN6288_LINK_DELAY_MS(HANDLE, FUC)    (HANDLE)->delay_ms = FUC
 
#define DRIVER_SYN6288_LINK_DEBUG_PRINT(HANDLE, FUC) (HANDLE)->debug_print = FUC
 
uint8_t syn6288_info(syn6288_info_t *info);
 
uint8_t syn6288_init(syn6288_handle_t *handle);
 
uint8_t syn6288_deinit(syn6288_handle_t *handle);
 
uint8_t syn6288_synthesis_text(syn6288_handle_t *handle, char *text);
 
uint8_t syn6288_synthesis_sound(syn6288_handle_t *handle, syn6288_sound_t sound);
 
uint8_t syn6288_synthesis_message(syn6288_handle_t *handle, syn6288_message_t message);
 
uint8_t syn6288_synthesis_ring(syn6288_handle_t *handle, syn6288_ring_t ring);
 
uint8_t syn6288_get_status(syn6288_handle_t *handle, syn6288_status_t *status);
 
uint8_t syn6288_stop(syn6288_handle_t *handle);
 
uint8_t syn6288_pause(syn6288_handle_t *handle);
 
uint8_t syn6288_resume(syn6288_handle_t *handle);
 
uint8_t syn6288_power_down(syn6288_handle_t *handle);
 
uint8_t syn6288_set_text_type(syn6288_handle_t *handle, syn6288_type_t type);
 
uint8_t syn6288_get_text_type(syn6288_handle_t *handle, syn6288_type_t *type);
 
uint8_t syn6288_set_baud_rate(syn6288_handle_t *handle, syn6288_baud_rate_t rate);
 
uint8_t syn6288_get_baud_rate(syn6288_handle_t *handle, syn6288_baud_rate_t *rate);
 
uint8_t syn6288_set_mode(syn6288_handle_t *handle, syn6288_mode_t mode);
 
uint8_t syn6288_get_mode(syn6288_handle_t *handle, syn6288_mode_t *mode);
 
uint8_t syn6288_set_synthesis_volume(syn6288_handle_t *handle, uint8_t volume);
 
uint8_t syn6288_get_synthesis_volume(syn6288_handle_t *handle, uint8_t *volume);
 
uint8_t syn6288_set_background_volume(syn6288_handle_t *handle, uint8_t volume);
 
uint8_t syn6288_get_background_volume(syn6288_handle_t *handle, uint8_t *volume);
 
uint8_t syn6288_set_synthesis_speed(syn6288_handle_t *handle, uint8_t speed);
 
uint8_t syn6288_get_synthesis_speed(syn6288_handle_t *handle, uint8_t *speed);
 
uint8_t syn6288_set_command(syn6288_handle_t *handle, char *command);
 
#ifdef __cplusplus
}
#endif
 
#endif