slcdc_api_t Struct Reference

#include <r_slcdc_api.h>

Data Fields
ssp_err_t(*	open )(slcdc_ctrl_t *const p_ctrl, slcdc_cfg_t const *const p_cfg)
ssp_err_t(*	write )(slcdc_ctrl_t *const p_ctrl, slcdc_size_t const start_segment, slcdc_size_t const *const p_data, slcdc_size_t const segment_count)
ssp_err_t(*	modify )(slcdc_ctrl_t *const p_ctrl, slcdc_size_t const segment, slcdc_size_t const data_mask, slcdc_size_t const data)
ssp_err_t(*	start )(slcdc_ctrl_t *const p_ctrl)
ssp_err_t(*	stop )(slcdc_ctrl_t *const p_ctrl)
ssp_err_t(*	contrastIncrease )(slcdc_ctrl_t *const p_ctrl)
ssp_err_t(*	contrastDecrease )(slcdc_ctrl_t *const p_ctrl)
ssp_err_t(*	setdisplayArea )(slcdc_ctrl_t *const p_ctrl, slcdc_display_area_t const display_area)
ssp_err_t(*	close )(slcdc_ctrl_t *const p_ctrl)
ssp_err_t(*	versionGet )(ssp_version_t *p_version)

Detailed Description

SLCDC functions implemented at the HAL layer will follow this API.

Field Documentation

close

ssp_err_t(* slcdc_api_t::close) (slcdc_ctrl_t *const p_ctrl)

Close display device.

Implemented as

• R_SLCDC_Close()

Parameters

[in]

p_ctrl

Pointer to display interface control block.

contrastDecrease

ssp_err_t(* slcdc_api_t::contrastDecrease) (slcdc_ctrl_t *const p_ctrl)

Decrease the display contrast. Decrease by 1 unit. This function can be selected when the internal voltage boosting method is used for the drive voltage generator

Implemented as

• R_SLCDC_ContrastDecrease()

Parameters

[in]

p_ctrl

Pointer to display interface control block.

contrastIncrease

ssp_err_t(* slcdc_api_t::contrastIncrease) (slcdc_ctrl_t *const p_ctrl)

Increase the display contrast. Increase by 1 unit. This function can be selected when the internal voltage boosting method is used for the drive voltage generator

Implemented as

• R_SLCDC_ContrastIncrease()

Parameters

[in]

p_ctrl

Pointer to display interface control block.

modify

ssp_err_t(* slcdc_api_t::modify) (slcdc_ctrl_t *const p_ctrl, slcdc_size_t const segment, slcdc_size_t const data_mask, slcdc_size_t const data)

Rewrite data in the SLCD segment. Rewrites the LCD display data in 1-bit units. If a bit is not specified for rewriting, the value stored in the bit is held as it is. Specifies the data to rewrite

Implemented as

• R_SLCDC_Modify()

Parameters

[in]	p_ctrl	Pointer to display interface control block.
[in]	seg	Specify the segment to be written.
[in]	data_mask	Mask the data being displayed. Set 0 to the bit to be rewritten and set 1 to the other bits. Multiple bits can be rewritten. Setting value of data_mask, Bit 3 - 0xf7 Bit 2 - 0xfb Bit 1 - 0xfd Bit 0 - 0xfe
[in]	data	Specify display data to rewrite to the specified segment.

open

ssp_err_t(* slcdc_api_t::open) (slcdc_ctrl_t *const p_ctrl, slcdc_cfg_t const *const p_cfg)

Open SLCD device.

Implemented as

• R_SLCDC_Open()

Parameters

[in,out]	p_ctrl	Pointer to display interface control block. Must be declared by user. Value set here.
[in]	p_cfg	Pointer to display configuration structure. All elements of this structure must be set by user.

setdisplayArea

ssp_err_t(* slcdc_api_t::setdisplayArea) (slcdc_ctrl_t *const p_ctrl, slcdc_display_area_t const display_area)

Set LCD display area. This function sets a specified display area, A-pattern or B-pattern. This function can be used to set blink on where A-pattern and B-pattern area data will be alternately displayed.

When using blinking, the RTC is required to operate before this function is executed. To configure the RTC, follow the steps below. 1) Open RTC 2) Set Periodic interrupt request, 1/2 second 3) Start RTC counter 4) Enable IRQ, RTC_EVENT_PERIODIC_IRQ Refer to the User’s Manual: Hardware for the detailed procedure.

Implemented as

• R_SLCDC_SetdisplayArea()

Parameters

[in]	p_ctrl	Pointer to display interface control block.
[in]	display_area	Display area to be used, A-pattern or B-pattern area.

start

ssp_err_t(* slcdc_api_t::start) (slcdc_ctrl_t *const p_ctrl)

Enable display on the SLCD. Displays the specified data on the LCD. Before that data should be written to the segments.

Implemented as

• R_SLCDC_Start()

Parameters

[in]

p_ctrl

Pointer to display interface control block.

stop

ssp_err_t(* slcdc_api_t::stop) (slcdc_ctrl_t *const p_ctrl)

Disable display on the SLCD. Stops displaying data on the SLCD.

Implemented as

• R_SLCDC_Stop()

Parameters

[in]

p_ctrl

Pointer to display interface control block.

versionGet

ssp_err_t(* slcdc_api_t::versionGet) (ssp_version_t *p_version)

Get version.

Implemented as

• R_SLCDC_VersionGet()

Parameters

[in]

p_version

Pointer to the memory to store the version information.

write

ssp_err_t(* slcdc_api_t::write) (slcdc_ctrl_t *const p_ctrl, slcdc_size_t const start_segment, slcdc_size_t const *const p_data, slcdc_size_t const segment_count)

Write data to SLCD segment. Specifies the initial display data. Except for 8-time slice, store values in the lower 4 bits when writing to the A-pattern area, and in the upper 4 bits when writing to the B-pattern area. The display data is stored in the display data register.

Implemented as

• R_SLCDC_Write()

Parameters

[in]	p_ctrl	Pointer to display interface control block.
[in]	start_segment	Specify the start segment number to be written.
[in]	p_data	pointer to the display data to be written to the specified segments
[in]	segment_count	Number of segments to be written

---

The documentation for this struct was generated from the following file:

• r_slcdc_api.h