This section describes the programming interface of the SLCD HAL driver.
|
enum | slcd_load_adjust_t {
kSLCDLowLoadOrFastestClkSrc = 0U,
kSLCDLowLoadOrIntermediateClkSrc = 1U,
kSLCDHighLoadOrIntermediateClkSrc = 2U,
kSLCDHighLoadOrSlowestClkSrc = 3U
} |
| SLCD to handle different LCD glass capacitance. More...
|
|
enum | slcd_regulated_voltage_trim_t {
kSLCDRegulatedVolatgeTrim00 = 0U,
kSLCDRegulatedVolatgeTrim01 = 1U,
kSLCDRegulatedVolatgeTrim02 = 2U,
kSLCDRegulatedVolatgeTrim03 = 3U,
kSLCDRegulatedVolatgeTrim04 = 4U,
kSLCDRegulatedVolatgeTrim05 = 5U,
kSLCDRegulatedVolatgeTrim06 = 6U,
kSLCDRegulatedVolatgeTrim07 = 7U,
kSLCDRegulatedVolatgeTrim08 = 8U,
kSLCDRegulatedVolatgeTrim09 = 9U,
kSLCDRegulatedVolatgeTrim10 = 10U,
kSLCDRegulatedVolatgeTrim11 = 11U,
kSLCDRegulatedVolatgeTrim12 = 12U,
kSLCDRegulatedVolatgeTrim13 = 13U,
kSLCDRegulatedVolatgeTrim14 = 14U,
kSLCDRegulatedVolatgeTrim15 = 15U
} |
| adjust the regulated voltage to meet the desired contrast More...
|
|
enum | slcd_alt_clk_div_t {
kSLCDAltClkDivFactor1 = 0U,
kSLCDAltClkDivFactor64 = 1U,
kSLCDAltClkDivFactor256 = 2U,
kSLCDAltClkDivFactor512 = 3U
} |
| SLCD alternate clock divider. More...
|
|
enum | slcd_clk_src_t {
kSLCDDefaultClk = 0U,
kSLCDAlternateClk = 1U
} |
| SLCD clock source. More...
|
|
enum | slcd_alt_clk_src_t {
kSLCDAltClkSrc1 = 0U,
kSLCDAltClkSrc2 = 1U
} |
| SLCD alternate clock source. More...
|
|
enum | slcd_clk_prescaler_t {
kSLCDClkPrescaler00 = 0U,
kSLCDClkPrescaler01 = 1U,
kSLCDClkPrescaler02 = 2U,
kSLCDClkPrescaler03 = 3U,
kSLCDClkPrescaler04 = 4U,
kSLCDClkPrescaler05 = 5U,
kSLCDClkPrescaler06 = 6U,
kSLCDClkPrescaler07 = 7U
} |
| SLCD clock prescaler to generate frame frequency. More...
|
|
enum | slcd_duty_cyc_t {
kSLCD1DutyCyc = 0U,
kSLCD1Div2DutyCyc = 1U,
kSLCD1Div3DutyCyc = 2U,
kSLCD1Div4DutyCyc = 3U,
kSLCD1Div5DutyCyc = 4U,
kSLCD1Div6DutyCyc = 5U,
kSLCD1Div7DutyCyc = 6U,
kSLCD1Div8DutyCyc = 7U
} |
| SLCD duty cycle. More...
|
|
enum | slcd_phase_index_t {
kSLCDPhaseA = 0U,
kSLCDPhaseB = 1U,
kSLCDPhaseC = 2U,
kSLCDPhaseD = 3U,
kSLCDPhaseE = 4U,
kSLCDPhaseF = 5U,
kSLCDPhaseG = 6U,
kSLCDPhaseH = 7U
} |
| SLCD segement index. More...
|
|
enum | slcd_blink_mode_t {
kSLCDBlankDisplay = 0U,
kSLCDAltDisplay = 1U
} |
| SLCD blink mode. More...
|
|
enum | slcd_blink_rate_t {
kSLCDBlinkRate00 = 0U,
kSLCDBlinkRate01 = 1U,
kSLCDBlinkRate02 = 2U,
kSLCDBlinkRate03 = 3U,
kSLCDBlinkRate04 = 4U,
kSLCDBlinkRate05 = 5U,
kSLCDBlinkRate06 = 6U,
kSLCDBlinkRate07 = 7U
} |
| SLCD blink rate. More...
|
|
enum | slcd_power_supply_option_t {
kSLCDPowerReserved0 = 0U,
kSLCDPowerReserved1 = 1U,
kSLCDPowerInternalVll3AndChargePump = 2U,
kSLCDPowerReserved2 = 3U,
kSLCDPowerExternalVll3AndResistorNetWork = 4U,
kSLCDPowerReserved3 = 5U,
kSLCDPowerExternalVll3AndChargePump = 6U,
kSLCDPowerVll1AndChargePump = 7U
} |
| This structure describes SLCD power supply configuration. More...
|
|
enum | slcd_fault_detect_clk_prescaler_t {
kSLCDFaultSampleFreq1BusClk = 0U,
kSLCDFaultSampleFreq1Div2BusClk = 1U,
kSLCDFaultSampleFreq1Div4BusClk = 2U,
kSLCDFaultSampleFreq1Div8BusClk = 3U,
kSLCDFaultSampleFreq1Div16BusClk = 4U,
kSLCDFaultSampleFreq1Div32BusClk = 5U,
kSLCDFaultSampleFreq1Div64BusClk = 6U,
kSLCDFaultSampleFreq1Div128BusClk = 7U
} |
| SLCD fault detect clock prescaler. More...
|
|
enum | slcd_fault_detect_sample_win_width_t {
kSLCDFaultDetectWinWidth4SampleClk = 0U,
kSLCDFaultDetectWinWidth8SampleClk = 1U,
kSLCDFaultDetectWinWidth16SampleClk = 2U,
kSLCDFaultDetectWinWidth32SampleClk = 3U,
kSLCDFaultDetectWinWidth64SampleClk = 4U,
kSLCDFaultDetectWinWidth128SampleClk = 5U,
kSLCDFaultDetectWinWidth256SampleClk = 6U,
kSLCDFaultDetectWinWidth512SampleClk = 7U
} |
| SLCD fault detect sample window width. More...
|
|
enum | slcd_int_type_t {
kSLCDFrameFreqInt = 1U,
kSLCDFaultDetectionCompleteInt = 2U,
kSLCDEnableAllInt = 3U
} |
| This enum structure describes SLCD interrupt configuration. More...
|
|
enum | slcd_status_t {
kStatus_SLCD_Success = 0x0U,
kStatus_SLCD_NullArgument = 0x1U,
kStatus_SLCD_Fail = 0x2U
} |
| SLCD status return codes. More...
|
|
|
SLCD
|
static void | SLCD_HAL_Enable (LCD_Type *base) |
| Enables the SLCD module operation. More...
|
|
static void | SLCD_HAL_Disable (LCD_Type *base) |
| Disables the SLCD module operation. More...
|
|
static void | SLCD_HAL_SetDutyCyc (LCD_Type *base, slcd_duty_cyc_t dutyCyc) |
| Configures the SLCD duty cycle. More...
|
|
static void | SLCD_HAL_SetBlinkCmd (LCD_Type *base, bool enable) |
| Configures the SLCD blink command. More...
|
|
static void | SLCD_HAL_SetAltDisplayModeCmd (LCD_Type *base, bool enable) |
| Configures the SLCD display mode. More...
|
|
static void | SLCD_HAL_SetBlankDisplayModeCmd (LCD_Type *base, bool enable) |
| Configures the SLCD blank mode. More...
|
|
static void | SLCD_HAL_SetFaultDetectCmd (LCD_Type *base, bool enable) |
| Configures the SLCD fault detection enable. More...
|
|
static bool | SLCD_HAL_GetFaultDetectCompleteFlag (LCD_Type *base) |
| Returns the SLCD fault detect complete flag. More...
|
|
static void | SLCD_HAL_ClearFaultDetectCompleteFlag (LCD_Type *base) |
| Clears the SLCD fault detect complete flag. More...
|
|
static uint32_t | SLCD_HAL_GetFaultDetectCounter (LCD_Type *base) |
| Returns the SLCD fault detect counter. More...
|
|
static void | SLCD_HAL_SetPinsEnableCmd (LCD_Type *base, uint8_t highReg, uint32_t data) |
| Configures all SLCD pins enabled states. More...
|
|
static void | SLCD_HAL_SetBackPlanePinsEnableCmd (LCD_Type *base, uint8_t highReg, uint32_t data) |
| Configures all SLCD pins type in high back plane register. More...
|
|
static void | SLCD_HAL_SetPinWaveForm (LCD_Type *base, uint8_t pinIndex, uint8_t waveForm) |
| Configures the SLCD pin waveform phase. More...
|
|
static void | SLCD_HAL_SetBackPlanePhase (LCD_Type *base, uint8_t pinIndex, slcd_phase_index_t phase) |
| Configures the SLCD pin waveform phase. More...
|
|
static void | SLCD_HAL_SetPinWaveFormPhaseCmd (LCD_Type *base, uint8_t pinIndex, slcd_phase_index_t phaseIndex, bool enable) |
| Configures the SLCD pin waveform one phase. More...
|
|
void | SLCD_HAL_VoltageAndPowerSupplyConfig (LCD_Type *base, slcd_power_supply_option_t powerSupply, slcd_load_adjust_t loadAdjust, slcd_regulated_voltage_trim_t trim) |
| Configures the SLCD voltage and power supply. More...
|
|
void | SLCD_HAL_ClockConfig (LCD_Type *base, const slcd_clk_config_t *clkConfigPtr) |
| Configures the SLCD clock. More...
|
|
void | SLCD_HAL_BlinkingModeConfig (LCD_Type *base, const slcd_blink_config_t *blinkConfigPtr) |
| Configures the SLCD blinking mode. More...
|
|
void | SLCD_HAL_FaultDetectionConfig (LCD_Type *base, const slcd_fault_detect_config_t *faultDetectConfigPtr) |
| Configures the SLCD fault detection. More...
|
|
void | SLCD_HAL_SetLowPowerModeConfig (LCD_Type *base, const slcd_work_mode_t *workMode) |
| Configures the SLCD running status in doze mode. More...
|
|
void | SLCD_HAL_SetIntCmd (LCD_Type *base, slcd_int_type_t intType, bool enable) |
| Configures the SLCD frame frequency interrupt. More...
|
|
void | SLCD_HAL_Init (LCD_Type *base) |
| Configures the SLCD to a workable state. More...
|
|