syn6288 advance driver function

syn6288 advance driver modules More...

Enumerations
enum	syn6288_mode_t {   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 enumeration definition More...
enum	syn6288_baud_rate_t { SYN6288_BAUD_RATE_9600_BPS = 0x00 , SYN6288_BAUD_RATE_19200_BPS = 0x01 , SYN6288_BAUD_RATE_38400_BPS = 0x02 }
	syn6288 baud rate enumeration definition More...

Functions
uint8_t	syn6288_set_baud_rate (syn6288_handle_t *handle, syn6288_baud_rate_t rate)
	set the baud rate More...
uint8_t	syn6288_get_baud_rate (syn6288_handle_t *handle, syn6288_baud_rate_t *rate)
	get the baud rate More...
uint8_t	syn6288_set_mode (syn6288_handle_t *handle, syn6288_mode_t mode)
	set the chip mode More...
uint8_t	syn6288_get_mode (syn6288_handle_t *handle, syn6288_mode_t *mode)
	get the chip mode More...
uint8_t	syn6288_set_synthesis_volume (syn6288_handle_t *handle, uint8_t volume)
	set the chip synthesis volume More...
uint8_t	syn6288_get_synthesis_volume (syn6288_handle_t *handle, uint8_t *volume)
	get the chip synthesis volume More...
uint8_t	syn6288_set_background_volume (syn6288_handle_t *handle, uint8_t volume)
	set the synthesis background volume More...
uint8_t	syn6288_get_background_volume (syn6288_handle_t *handle, uint8_t *volume)
	get the chip synthesis background volume More...
uint8_t	syn6288_set_synthesis_speed (syn6288_handle_t *handle, uint8_t speed)
	set the synthesis speed More...
uint8_t	syn6288_get_synthesis_speed (syn6288_handle_t *handle, uint8_t *speed)
	get the synthesis speed More...

Detailed Description

syn6288 advance driver modules

Enumeration Type Documentation

syn6288_baud_rate_t

enum syn6288_baud_rate_t

syn6288 baud rate enumeration definition

Enumerator
SYN6288_BAUD_RATE_9600_BPS	9600 bps
SYN6288_BAUD_RATE_19200_BPS	19200 bps
SYN6288_BAUD_RATE_38400_BPS	38400 bps

Definition at line 185 of file driver_syn6288.h.

syn6288_mode_t

enum syn6288_mode_t

syn6288 mode enumeration definition

Enumerator
SYN6288_MODE_COMMON	common
SYN6288_MODE_BACKGROUND_1	background 1
SYN6288_MODE_BACKGROUND_2	background 2
SYN6288_MODE_BACKGROUND_3	background 3
SYN6288_MODE_BACKGROUND_4	background 4
SYN6288_MODE_BACKGROUND_5	background 5
SYN6288_MODE_BACKGROUND_6	background 6
SYN6288_MODE_BACKGROUND_7	background 7
SYN6288_MODE_BACKGROUND_8	background 8
SYN6288_MODE_BACKGROUND_9	background 9
SYN6288_MODE_BACKGROUND_10	background 10
SYN6288_MODE_BACKGROUND_11	background 11
SYN6288_MODE_BACKGROUND_12	background 12
SYN6288_MODE_BACKGROUND_13	background 13
SYN6288_MODE_BACKGROUND_14	background 14
SYN6288_MODE_BACKGROUND_15	background 15

Definition at line 161 of file driver_syn6288.h.

Function Documentation

syn6288_get_background_volume()

uint8_t syn6288_get_background_volume	(	syn6288_handle_t *	handle,
		uint8_t *	volume
	)

get the chip synthesis background volume

Parameters

[in]	*handle	pointer to a syn6288 handle structure
[out]	*volume	pointer to a synthesis background volume buffer

Returns

status code

• 0 success
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 1139 of file driver_syn6288.c.

syn6288_get_baud_rate()

uint8_t syn6288_get_baud_rate	(	syn6288_handle_t *	handle,
		syn6288_baud_rate_t *	rate
	)

get the baud rate

Parameters

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

Returns

status code

• 0 success
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 608 of file driver_syn6288.c.

syn6288_get_mode()

uint8_t syn6288_get_mode	(	syn6288_handle_t *	handle,
		syn6288_mode_t *	mode
	)

get the chip mode

Parameters

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

Returns

status code

• 0 success
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 660 of file driver_syn6288.c.

syn6288_get_synthesis_speed()

uint8_t syn6288_get_synthesis_speed	(	syn6288_handle_t *	handle,
		uint8_t *	speed
	)

get the synthesis speed

Parameters

[in]	*handle	pointer to a syn6288 handle structure
[out]	*speed	pointer to a synthesis speed

Returns

status code

• 0 success
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 1194 of file driver_syn6288.c.

syn6288_get_synthesis_volume()

uint8_t syn6288_get_synthesis_volume	(	syn6288_handle_t *	handle,
		uint8_t *	volume
	)

get the chip synthesis volume

Parameters

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

Returns

status code

• 0 success
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 1084 of file driver_syn6288.c.

syn6288_set_background_volume()

uint8_t syn6288_set_background_volume	(	syn6288_handle_t *	handle,
		uint8_t	volume
	)

set the synthesis background volume

Parameters

[in]	*handle	pointer to a syn6288 handle structure
[in]	volume	background volume

Returns

status code

• 0 success
• 1 set background volume failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 1111 of file driver_syn6288.c.

syn6288_set_baud_rate()

uint8_t syn6288_set_baud_rate	(	syn6288_handle_t *	handle,
		syn6288_baud_rate_t	rate
	)

set the baud rate

Parameters

[in]	*handle	pointer to a syn6288 handle structure
[in]	rate	baud rate

Returns

status code

• 0 success
• 1 set baud rate failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 509 of file driver_syn6288.c.

syn6288_set_mode()

uint8_t syn6288_set_mode	(	syn6288_handle_t *	handle,
		syn6288_mode_t	mode
	)

set the chip mode

Parameters

[in]	*handle	pointer to a syn6288 handle structure
[in]	mode	chip mode

Returns

status code

• 0 success
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 634 of file driver_syn6288.c.

syn6288_set_synthesis_speed()

uint8_t syn6288_set_synthesis_speed	(	syn6288_handle_t *	handle,
		uint8_t	speed
	)

set the synthesis speed

Parameters

[in]	*handle	pointer to a syn6288 handle structure
[in]	speed	synthesis speed

Returns

status code

• 0 success
• 1 set synthesis speed failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 1166 of file driver_syn6288.c.

syn6288_set_synthesis_volume()

uint8_t syn6288_set_synthesis_volume	(	syn6288_handle_t *	handle,
		uint8_t	volume
	)

set the chip synthesis volume

Parameters

[in]	*handle	pointer to a syn6288 handle structure
[in]	volume	synthesis volume

Returns

status code

• 0 success
• 1 set synthesis volume failed
• 2 handle is NULL
• 3 handle is not initialized

Note

none

Definition at line 1056 of file driver_syn6288.c.