SLCDC

Driver for the Segment LCD Controller (SLCDC). More...

Data Structures
struct	slcdc_instance_ctrl_t

Functions
ssp_err_t	R_SLCDC_Open (slcdc_ctrl_t *const p_api_ctrl, slcdc_cfg_t const *const p_cfg)
ssp_err_t	R_SLCDC_Write (slcdc_ctrl_t *const p_api_ctrl, slcdc_size_t const start_segment, slcdc_size_t const *const p_data, slcdc_size_t const segment_count)
ssp_err_t	R_SLCDC_Modify (slcdc_ctrl_t *const p_api_ctrl, slcdc_size_t const segment_number, slcdc_size_t const data, slcdc_size_t const data_mask)
ssp_err_t	R_SLCDC_Start (slcdc_ctrl_t *const p_api_ctrl)
ssp_err_t	R_SLCDC_Stop (slcdc_ctrl_t *const p_api_ctrl)
ssp_err_t	R_SLCDC_ContrastIncrease (slcdc_ctrl_t *const p_api_ctrl)
ssp_err_t	R_SLCDC_ContrastDecrease (slcdc_ctrl_t *const p_api_ctrl)
ssp_err_t	R_SLCDC_SetDisplayArea (slcdc_ctrl_t *const p_api_ctrl, slcdc_display_area_t const display_area)
ssp_err_t	R_SLCDC_Close (slcdc_ctrl_t *const p_api_ctrl)
ssp_err_t	R_SLCDC_VersionGet (ssp_version_t *const p_version)
	Retrieve the API version number. More...

Detailed Description

Driver for the Segment LCD Controller (SLCDC).

Summary

Extends SLCDC Interface.

Function Documentation

R_SLCDC_Close()

ssp_err_t R_SLCDC_Close

(

slcdc_ctrl_t *const

p_api_ctrl

)

Return values

SSP_SUCCESS	Device was opened successfully.
SSP_ERR_ASSERTION	Pointer to the control block structure is NULL.
SSP_ERR_NOT_OPEN	Device is not opened or initialized

Clear all the data segment registers.

Disable the LCD display area. Segment pin outputs de-select signal

Disable voltage circuit

Set voltage generator to External

Protect OFF of CGC.

Disable LCD clock

Protect ON of CGC.

Release hardware lock for SLCD

SLCDC Power off - enter module-stop state for the SLCDC

Mark control block close.

R_SLCDC_ContrastDecrease()

ssp_err_t R_SLCDC_ContrastDecrease

(

slcdc_ctrl_t *const

p_api_ctrl

)

Return values

SSP_SUCCESS	Device was opened successfully.
SSP_ERR_ASSERTION	Pointer to the control block structure is NULL.
SSP_ERR_NOT_OPEN	Device is not opened or initialized
SSP_ERR_UNSUPPORTED	Unsupported operation

The VLCD setting is valid only when the voltage boost circuit is operating

Verify the new volt is within the range.

Stop the internal voltage boost/capacitor split circuit.

Set new voltage value.

Wait 5ms minimum as per HW manual

Enable the voltage boost circuit or capacitor split circuit.

R_SLCDC_ContrastIncrease()

ssp_err_t R_SLCDC_ContrastIncrease

(

slcdc_ctrl_t *const

p_api_ctrl

)

Return values

SSP_SUCCESS	Device was opened successfully.
SSP_ERR_ASSERTION	Pointer to the control block structure is NULL.
SSP_ERR_NOT_OPEN	Device is not opened or initialized
SSP_ERR_UNSUPPORTED	Unsupported operation

The VLCD setting is valid only when the voltage boost circuit is operating

Verify the new volt is within the range.

Stop the internal voltage boost/capacitor split circuit.

Set new voltage value.

Wait 5ms minimum as per HW manual

Enable the voltage boost circuit or capacitor split circuit.

R_SLCDC_Modify()

ssp_err_t R_SLCDC_Modify	(	slcdc_ctrl_t *const	p_api_ctrl,
		slcdc_size_t const	segment_number,
		slcdc_size_t const	data,
		slcdc_size_t const	data_mask
	)

Return values

SSP_SUCCESS	Device was opened successfully.
SSP_ERR_ASSERTION	Pointer to the control block structure is NULL.
SSP_ERR_INVALID_ARGUMENT	Invalid parameter in the argument.
SSP_ERR_NOT_OPEN	Device is not opened or initialized

Masks the data being displayed.

Specifies the data to rewrite.

R_SLCDC_Open()

ssp_err_t R_SLCDC_Open	(	slcdc_ctrl_t *const	p_api_ctrl,
		slcdc_cfg_t const *const	p_cfg
	)

Return values

SSP_SUCCESS	Device was opened successfully.
SSP_ERR_ASSERTION	Pointer to the control block or the configuration structure is NULL.
SSP_ERR_HW_LOCKED	SLCDC resource is locked.

Returns

See Common Error Codes for other possible return codes. This function calls

• fmi_api_t::productFeatureGet

Configure the SLCDC driver

Record the configuration on the device for later use

Mark control block state open so subsequent calls know the device is open.

R_SLCDC_SetDisplayArea()

ssp_err_t R_SLCDC_SetDisplayArea	(	slcdc_ctrl_t *const	p_api_ctrl,
		slcdc_display_area_t const	display_area
	)

Return values

SSP_SUCCESS	Device was opened successfully.
SSP_ERR_ASSERTION	Pointer to the control block structure is NULL.
SSP_ERR_UNSUPPORTED	Unsupported operation
SSP_ERR_NOT_OPEN	Device is not opened or initialized
SSP_ERR_NOT_ENABLED	RTC not enabled for blink operation

Returns

See Common Error Codes for other possible return codes. This function calls

• fmi_api_t::productFeatureGet

When the number of time slices is eight, LCD display data registers (A-pattern, B-pattern, or blinking display) cannot be selected.

Set the LCD display data area.

R_SLCDC_Start()

ssp_err_t R_SLCDC_Start

(

slcdc_ctrl_t *const

p_api_ctrl

)

Return values

SSP_SUCCESS	Device was opened successfully.
SSP_ERR_ASSERTION	Pointer to the control block structure is NULL.
SSP_ERR_NOT_OPEN	Device is not opened or initialized

Enable the voltage boost circuit or capacitor split circuit.

Enable the LCD display.

R_SLCDC_Stop()

ssp_err_t R_SLCDC_Stop

(

slcdc_ctrl_t *const

p_api_ctrl

)

Return values

SSP_SUCCESS	Device was opened successfully.
SSP_ERR_ASSERTION	Pointer to the control block structure is NULL.
SSP_ERR_NOT_OPEN	Device is not opened or initialized

Disable the LCD display

Disable the voltage boost circuit or capacitor split circuit.

R_SLCDC_VersionGet()

ssp_err_t R_SLCDC_VersionGet

(

ssp_version_t *const

p_version

)

Retrieve the API version number.

Return values

SSP_SUCCESS	Successful return.
SSP_ERR_ASSERTION	The parameter p_version is NULL.

R_SLCDC_Write()

ssp_err_t R_SLCDC_Write	(	slcdc_ctrl_t *const	p_api_ctrl,
		slcdc_size_t const	start_segment,
		slcdc_size_t const *const	p_data,
		slcdc_size_t const	segment_count
	)

Return values

SSP_SUCCESS	Device was opened successfully.
SSP_ERR_ASSERTION	Pointer to the control block structure and display data is NULL
SSP_ERR_INVALID_ARGUMENT	Invalid parameter in the argument.
SSP_ERR_NOT_OPEN	Device is not opened or initialized

Get the register address of the specified segment and write data to it.