syn6288 base driver modules More...

Collaboration diagram for syn6288 base driver function:

Data Structures
struct	syn6288_handle_s
	syn6288 handle structure definition More...
struct	syn6288_info_s
	syn6288 information structure definition More...

Typedefs
typedef struct syn6288_handle_s	syn6288_handle_t
	syn6288 handle structure definition
typedef struct syn6288_info_s	syn6288_info_t
	syn6288 information structure definition

Enumerations
enum	syn6288_sound_t { 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 enumeration definition More...
enum	syn6288_message_t { 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 enumeration definition More...
enum	syn6288_ring_t { 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 enumeration definition More...
enum	syn6288_type_t { SYN6288_TYPE_GB2312 = 0x00 , SYN6288_TYPE_GBK = 0x01 , SYN6288_TYPE_BIG5 = 0x02 , SYN6288_TYPE_UNICODE = 0x03 }
	syn6288 type enumeration definition More...
enum	syn6288_status_t { SYN6288_STATUS_OK = 0x00 , SYN6288_STATUS_BUSY = 0x01 }
	syn6288 status enumeration definition More...

Functions
uint8_t	syn6288_info (syn6288_info_t *info)
	get chip's information
uint8_t	syn6288_init (syn6288_handle_t *handle)
	initialize the chip
uint8_t	syn6288_deinit (syn6288_handle_t *handle)
	close the chip
uint8_t	syn6288_synthesis_text (syn6288_handle_t handle, char text)
	synthesis the test
uint8_t	syn6288_synthesis_sound (syn6288_handle_t *handle, syn6288_sound_t sound)
	synthesis the sound
uint8_t	syn6288_synthesis_message (syn6288_handle_t *handle, syn6288_message_t message)
	synthesis the message
uint8_t	syn6288_synthesis_ring (syn6288_handle_t *handle, syn6288_ring_t ring)
	synthesis the ring
uint8_t	syn6288_get_status (syn6288_handle_t handle, syn6288_status_t status)
	get the current status
uint8_t	syn6288_stop (syn6288_handle_t *handle)
	stop the chip
uint8_t	syn6288_pause (syn6288_handle_t *handle)
	pause the chip
uint8_t	syn6288_resume (syn6288_handle_t *handle)
	resume the chip
uint8_t	syn6288_power_down (syn6288_handle_t *handle)
	power down the chip
uint8_t	syn6288_set_text_type (syn6288_handle_t *handle, syn6288_type_t type)
	set the chip text type
uint8_t	syn6288_get_text_type (syn6288_handle_t handle, syn6288_type_t type)
	get the chip text type

Detailed Description

syn6288 base driver modules

Typedef Documentation

◆ syn6288_handle_t

typedef struct syn6288_handle_s syn6288_handle_t

syn6288 handle structure definition

◆ syn6288_info_t

typedef struct syn6288_info_s syn6288_info_t

syn6288 information structure definition

Enumeration Type Documentation

◆ syn6288_message_t

enum syn6288_message_t

syn6288 message enumeration definition

Enumerator
SYN6288_MESSAGE_A	message A
SYN6288_MESSAGE_B	message B
SYN6288_MESSAGE_C	message C
SYN6288_MESSAGE_D	message D
SYN6288_MESSAGE_E	message E
SYN6288_MESSAGE_F	message F
SYN6288_MESSAGE_G	message G
SYN6288_MESSAGE_H	message H

Definition at line 95 of file driver_syn6288.h.

◆ syn6288_ring_t

enum syn6288_ring_t

syn6288 ring enumeration definition

Enumerator
SYN6288_RING_A	ring A
SYN6288_RING_B	ring B
SYN6288_RING_C	ring C
SYN6288_RING_D	ring D
SYN6288_RING_E	ring E
SYN6288_RING_F	ring F
SYN6288_RING_G	ring G
SYN6288_RING_H	ring H
SYN6288_RING_I	ring I
SYN6288_RING_J	ring J
SYN6288_RING_K	ring K
SYN6288_RING_L	ring L
SYN6288_RING_M	ring M
SYN6288_RING_N	ring N
SYN6288_RING_O	ring O

Definition at line 110 of file driver_syn6288.h.

◆ syn6288_sound_t

enum syn6288_sound_t

syn6288 sound enumeration definition

Enumerator
SYN6288_SOUND_A	sound A
SYN6288_SOUND_B	sound B
SYN6288_SOUND_C	sound C
SYN6288_SOUND_D	sound D
SYN6288_SOUND_E	sound E
SYN6288_SOUND_F	sound F
SYN6288_SOUND_G	sound G
SYN6288_SOUND_H	sound H
SYN6288_SOUND_I	sound I
SYN6288_SOUND_J	sound J
SYN6288_SOUND_K	sound K
SYN6288_SOUND_L	sound L
SYN6288_SOUND_M	sound M
SYN6288_SOUND_N	sound N
SYN6288_SOUND_O	sound O
SYN6288_SOUND_P	sound P
SYN6288_SOUND_Q	sound Q
SYN6288_SOUND_R	sound R
SYN6288_SOUND_S	sound S
SYN6288_SOUND_T	sound T
SYN6288_SOUND_U	sound U
SYN6288_SOUND_V	sound V
SYN6288_SOUND_W	sound W
SYN6288_SOUND_X	sound X
SYN6288_SOUND_Y	sound Y

Definition at line 63 of file driver_syn6288.h.

◆ syn6288_status_t

enum syn6288_status_t

syn6288 status enumeration definition

Enumerator
SYN6288_STATUS_OK	ok status
SYN6288_STATUS_BUSY	busy status

Definition at line 143 of file driver_syn6288.h.

◆ syn6288_type_t

enum syn6288_type_t

syn6288 type enumeration definition

Enumerator
SYN6288_TYPE_GB2312	gb2312 type
SYN6288_TYPE_GBK	gbk type
SYN6288_TYPE_BIG5	big5 type
SYN6288_TYPE_UNICODE	unicode type

Definition at line 132 of file driver_syn6288.h.

Function Documentation

◆ syn6288_deinit()

uint8_t syn6288_deinit ( syn6288_handle_t * handle )

close the chip

Parameters

[in] *handle pointer to a syn6288 handle structure

Returns

status code

0 success
1 uart deinit failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 130 of file driver_syn6288.c.

◆ syn6288_get_status()

uint8_t syn6288_get_status	(	syn6288_handle_t *	handle,
		syn6288_status_t *	status )

get the current status

Parameters

[in]	*handle	pointer to a syn6288 handle structure
[out]	*status	pointer to a status buffer

Returns

status code

0 success
1 get status failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 163 of file driver_syn6288.c.

◆ syn6288_get_text_type()

uint8_t syn6288_get_text_type	(	syn6288_handle_t *	handle,
		syn6288_type_t *	type )

get the chip text type

Parameters

[in]	*handle	pointer to a syn6288 handle structure
[out]	*type	pointer to a chip text type

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 712 of file driver_syn6288.c.

◆ syn6288_info()

uint8_t syn6288_info ( syn6288_info_t * info )

get chip's information

Parameters

[out] *info pointer to a syn6288 info structure

Returns

status code

0 success
2 handle is NULL

Note: none

Definition at line 1298 of file driver_syn6288.c.

◆ syn6288_init()

uint8_t syn6288_init ( syn6288_handle_t * handle )

initialize the chip

Parameters

[in] *handle pointer to a syn6288 handle structure

Returns

status code

0 success
1 uart initialization failed
2 handle is NULL
3 linked functions is NULL

Note: none

Definition at line 62 of file driver_syn6288.c.

◆ syn6288_pause()

uint8_t syn6288_pause ( syn6288_handle_t * handle )

pause the chip

Parameters

[in] *handle pointer to a syn6288 handle structure

Returns

status code

0 success
1 pause failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 313 of file driver_syn6288.c.

◆ syn6288_power_down()

uint8_t syn6288_power_down ( syn6288_handle_t * handle )

power down the chip

Parameters

[in] *handle pointer to a syn6288 handle structure

Returns

status code

0 success
1 power down failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 443 of file driver_syn6288.c.

◆ syn6288_resume()

uint8_t syn6288_resume ( syn6288_handle_t * handle )

resume the chip

Parameters

[in] *handle pointer to a syn6288 handle structure

Returns

status code

0 success
1 resume failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 378 of file driver_syn6288.c.

◆ syn6288_set_text_type()

uint8_t syn6288_set_text_type	(	syn6288_handle_t *	handle,
		syn6288_type_t	type )

set the chip text type

Parameters

[in]	*handle	pointer to a syn6288 handle structure
[in]	type	chip text type

Returns

status code

0 success
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 686 of file driver_syn6288.c.

◆ syn6288_stop()

uint8_t syn6288_stop ( syn6288_handle_t * handle )

stop the chip

Parameters

[in] *handle pointer to a syn6288 handle structure

Returns

status code

0 success
1 stop failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 248 of file driver_syn6288.c.

◆ syn6288_synthesis_message()

uint8_t syn6288_synthesis_message	(	syn6288_handle_t *	handle,
		syn6288_message_t	message )

synthesis the message

Parameters

[in]	*handle	pointer to a syn6288 handle structure
[in]	message	message type

Returns

status code

0 success
1 synthesis message failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 819 of file driver_syn6288.c.

◆ syn6288_synthesis_ring()

uint8_t syn6288_synthesis_ring	(	syn6288_handle_t *	handle,
		syn6288_ring_t	ring )

synthesis the ring

Parameters

[in]	*handle	pointer to a syn6288 handle structure
[in]	ring	ring type

Returns

status code

0 success
1 synthesis ring failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 897 of file driver_syn6288.c.

◆ syn6288_synthesis_sound()

uint8_t syn6288_synthesis_sound	(	syn6288_handle_t *	handle,
		syn6288_sound_t	sound )

synthesis the sound

Parameters

[in]	*handle	pointer to a syn6288 handle structure
[in]	sound	sound type

Returns

status code

0 success
1 synthesis sound failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 739 of file driver_syn6288.c.

◆ syn6288_synthesis_text()

uint8_t syn6288_synthesis_text	(	syn6288_handle_t *	handle,
		char *	text )

synthesis the test

Parameters

[in]	*handle	pointer to a syn6288 handle structure
[in]	*text	pointer to a test buffer

Returns

status code

0 success
1 synthesis text failed
2 handle is NULL
3 handle is not initialized

Note: none

Definition at line 976 of file driver_syn6288.c.

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ syn6288_handle_t

◆ syn6288_info_t

Enumeration Type Documentation

◆ syn6288_message_t

◆ syn6288_ring_t

◆ syn6288_sound_t

◆ syn6288_status_t

◆ syn6288_type_t

Function Documentation

◆ syn6288_deinit()

◆ syn6288_get_status()

◆ syn6288_get_text_type()

◆ syn6288_info()

◆ syn6288_init()

◆ syn6288_pause()

◆ syn6288_power_down()

◆ syn6288_resume()

◆ syn6288_set_text_type()

◆ syn6288_stop()

◆ syn6288_synthesis_message()

◆ syn6288_synthesis_ring()

◆ syn6288_synthesis_sound()

◆ syn6288_synthesis_text()