KEYSCAN - Keyboard Scan#

Keyscan (KEYSCAN) Peripheral API.

This module contains functions to control the KEYSCAN peripheral of Silicon Labs 32-bit MCUs and SoCs. The KEYSCAN module connects through rows and columns of GPIOs to an external mechanical keypad.

Modules#

sl_hal_keyscan_config_t

Enumerations#

enum
SL_HAL_KEYSCAN_DELAY_2MS = 0
SL_HAL_KEYSCAN_DELAY_4MS
SL_HAL_KEYSCAN_DELAY_6MS
SL_HAL_KEYSCAN_DELAY_8MS
SL_HAL_KEYSCAN_DELAY_10MS
SL_HAL_KEYSCAN_DELAY_12MS
SL_HAL_KEYSCAN_DELAY_14MS
SL_HAL_KEYSCAN_DELAY_16MS
SL_HAL_KEYSCAN_DELAY_18MS
SL_HAL_KEYSCAN_DELAY_20MS
SL_HAL_KEYSCAN_DELAY_22MS
SL_HAL_KEYSCAN_DELAY_24MS
SL_HAL_KEYSCAN_DELAY_26MS
SL_HAL_KEYSCAN_DELAY_28MS
SL_HAL_KEYSCAN_DELAY_30MS
SL_HAL_KEYSCAN_DELAY_32MS
}

KEYSCAN configuration delay values.

Functions#

void
sl_hal_keyscan_init(const sl_hal_keyscan_config_t *p_config)

Initializes KEYSCAN module.

void

Enables KEYSCAN module.

void

Disables KEYSCAN module.

void

Restores KEYSCAN to its reset state.

void

Waits for the KEYSCAN to complete reseting or disabling procedure.

void

Waits for the KEYSCAN to complete all synchronization of register changes and commands.

void

Starts KEYSCAN scan.

void

Stops the KEYSCAN scan.

uint32_t

Gets KEYSCAN STATUS register value.

void

Enables one or more KEYSCAN interrupts.

void

Disables one or more KEYSCAN interrupts.

void

Clears one or more pending KEYSCAN interrupts.

uint32_t

Gets pending KEYSCAN interrupt flags.

uint32_t

Gets enabled and pending KEYSCAN interrupt flags.

void

Sets one or more pending KEYSCAN interrupts from Software.

Macros#

#define

Suggested default values for KEYSCAN configuration structure.

Enumeration Documentation#

sl_hal_keyscan_delay_t#

sl_hal_keyscan_delay_t

KEYSCAN configuration delay values.

Enumerator
SL_HAL_KEYSCAN_DELAY_2MS

2 ms delay.

SL_HAL_KEYSCAN_DELAY_4MS

4 ms delay.

SL_HAL_KEYSCAN_DELAY_6MS

6 ms delay.

SL_HAL_KEYSCAN_DELAY_8MS

8 ms delay.

SL_HAL_KEYSCAN_DELAY_10MS

10 ms delay.

SL_HAL_KEYSCAN_DELAY_12MS

12 ms delay.

SL_HAL_KEYSCAN_DELAY_14MS

14 ms delay.

SL_HAL_KEYSCAN_DELAY_16MS

16 ms delay.

SL_HAL_KEYSCAN_DELAY_18MS

18 ms delay.

SL_HAL_KEYSCAN_DELAY_20MS

20 ms delay.

SL_HAL_KEYSCAN_DELAY_22MS

22 ms delay.

SL_HAL_KEYSCAN_DELAY_24MS

24 ms delay.

SL_HAL_KEYSCAN_DELAY_26MS

26 ms delay.

SL_HAL_KEYSCAN_DELAY_28MS

28 ms delay.

SL_HAL_KEYSCAN_DELAY_30MS

30 ms delay.

SL_HAL_KEYSCAN_DELAY_32MS

32 ms delay.


Definition at line 56 of file platform/peripheral/inc/peripheral_keyscan.h

Function Documentation#

sl_hal_keyscan_init#

void sl_hal_keyscan_init (const sl_hal_keyscan_config_t * p_config)

Initializes KEYSCAN module.

Parameters
[in]p_config

A pointer to the KEYSCAN initialization structure variable.


Definition at line 49 of file platform/peripheral/src/peripheral_keyscan.c

sl_hal_keyscan_enable#

void sl_hal_keyscan_enable (void )

Enables KEYSCAN module.

Parameters
N/A

Definition at line 85 of file platform/peripheral/src/peripheral_keyscan.c

sl_hal_keyscan_disable#

void sl_hal_keyscan_disable (void )

Disables KEYSCAN module.

Parameters
N/A

Note

  • The disabling of the module could take some time. This function will not wait for the disabling to finish before returning. Use the function sl_hal_keyscan_wait_ready to wait for the module to be fully disable.


Definition at line 99 of file platform/peripheral/src/peripheral_keyscan.c

sl_hal_keyscan_reset#

void sl_hal_keyscan_reset (void )

Restores KEYSCAN to its reset state.

Parameters
N/A

Note

  • The register STATUS get reset value after enabling the module because it is of type RSYNC

  • The resetting of the module could take some time. This function will not wait for the resetting to finish before returning. Use the function sl_hal_keyscan_wait_ready to wait for the module to be fully reset.


Definition at line 125 of file platform/peripheral/src/peripheral_keyscan.c

sl_hal_keyscan_wait_ready#

void sl_hal_keyscan_wait_ready (void )

Waits for the KEYSCAN to complete reseting or disabling procedure.

Parameters
N/A

Definition at line 133 of file platform/peripheral/inc/peripheral_keyscan.h

sl_hal_keyscan_wait_sync#

void sl_hal_keyscan_wait_sync (void )

Waits for the KEYSCAN to complete all synchronization of register changes and commands.

Parameters
N/A

Definition at line 144 of file platform/peripheral/inc/peripheral_keyscan.h

sl_hal_keyscan_start_scan#

void sl_hal_keyscan_start_scan (void )

Starts KEYSCAN scan.

Parameters
N/A

Note

  • This function will send a start command to the KEYSCAN peripheral. The sl_hal_keyscan_wait_sync function can be used to wait for the start command to be executed.

  • This function requires the KEYSCAN to be enabled.


Definition at line 160 of file platform/peripheral/inc/peripheral_keyscan.h

sl_hal_keyscan_stop_scan#

void sl_hal_keyscan_stop_scan (void )

Stops the KEYSCAN scan.

Parameters
N/A

Note

  • This function will send a stop command to the KEYSCAN peripheral. The sl_hal_keyscan_wait_sync function can be used to wait for the stop command to be executed.

  • This function requires the KEYSCAN to be enabled.


Definition at line 176 of file platform/peripheral/inc/peripheral_keyscan.h

sl_hal_keyscan_get_status#

uint32_t sl_hal_keyscan_get_status (void )

Gets KEYSCAN STATUS register value.

Parameters
N/A

Returns

  • Current STATUS register value.


Definition at line 197 of file platform/peripheral/inc/peripheral_keyscan.h

sl_hal_keyscan_enable_interrupts#

void sl_hal_keyscan_enable_interrupts (uint32_t flags)

Enables one or more KEYSCAN interrupts.

Parameters
[in]flags

KEYSCAN interrupt sources to enable. Use a set of interrupt flags OR-ed together to set multiple interrupt sources.

Note

  • Depending on the use, a pending interrupt may already be set prior to enabling the interrupt. To ignore a pending interrupt, consider using sl_hal_keyscan_clear_interrupts prior to enabling the interrupt.


Definition at line 213 of file platform/peripheral/inc/peripheral_keyscan.h

sl_hal_keyscan_disable_interrupts#

void sl_hal_keyscan_disable_interrupts (uint32_t flags)

Disables one or more KEYSCAN interrupts.

Parameters
[in]flags

KEYSCAN interrupt sources to disable. Use a set of interrupt flags OR-ed together to disable multiple interrupt sources.


Definition at line 225 of file platform/peripheral/inc/peripheral_keyscan.h

sl_hal_keyscan_clear_interrupts#

void sl_hal_keyscan_clear_interrupts (uint32_t flags)

Clears one or more pending KEYSCAN interrupts.

Parameters
[in]flags

KEYSCAN interrupt sources to clear. Use a set of interrupt flags OR-ed together to clear multiple interrupt sources.


Definition at line 237 of file platform/peripheral/inc/peripheral_keyscan.h

sl_hal_keyscan_get_interrupts#

uint32_t sl_hal_keyscan_get_interrupts (void )

Gets pending KEYSCAN interrupt flags.

Parameters
N/A

Note

  • Event bits are not cleared by using this function.

Returns

  • Pending KEYSCAN interrupt sources. Returns a set of interrupt flags OR-ed together for multiple interrupt sources.


Definition at line 251 of file platform/peripheral/inc/peripheral_keyscan.h

sl_hal_keyscan_get_enabled_interrupts#

uint32_t sl_hal_keyscan_get_enabled_interrupts (void )

Gets enabled and pending KEYSCAN interrupt flags.

Parameters
N/A

Useful for handling more interrupt sources in the same interrupt handler.

Note

  • Interrupt flags are not cleared by using this function.

Returns

  • Pending and enabled KEYSCAN interrupt sources. The return value is the bitwise AND of

    • the enabled interrupt sources in KEYSCAN_IEN and

    • the pending interrupt flags KEYSCAN_IF.


Definition at line 267 of file platform/peripheral/inc/peripheral_keyscan.h

sl_hal_keyscan_set_interrupts#

void sl_hal_keyscan_set_interrupts (uint32_t flags)

Sets one or more pending KEYSCAN interrupts from Software.

Parameters
[in]flags

KEYSCAN interrupt sources to set to pending. Use a set of interrupt flags OR-ed together to set multiple interrupt sources.


Definition at line 279 of file platform/peripheral/inc/peripheral_keyscan.h

Macro Definition Documentation#

KEYSCAN_CONFIG_DEFAULT#

#define KEYSCAN_CONFIG_DEFAULT
Value:
{ \
0x1387F, /* Clock divider default value = 79999. */ \
3u, /* 3 columns by default. */ \
6u, /* 6 rows by default. */ \
SL_HAL_KEYSCAN_DELAY_2MS, /* value 0 = 2ms Scan Delay*/ \
SL_HAL_KEYSCAN_DELAY_2MS, /* value 0 = 2ms Debounce Delay */ \
SL_HAL_KEYSCAN_DELAY_2MS, /* value 0 = 2ms Row Stable Delay */ \
false, /* Multi-press by default.*/ \
false, /* No auto-start by default. */ \
}

Suggested default values for KEYSCAN configuration structure.


Definition at line 92 of file platform/peripheral/inc/peripheral_keyscan.h