System Reset Controller Device Interface Functions More...
Go to the source code of this file.
Data Structures | |
struct | dif_sysrst_ctrl_key_combo_config |
Runtime configuration for the System Reset Controller key combination detection feature. More... | |
struct | dif_sysrst_ctrl_input_change_config |
Runtime configuration for the System Reset Controller input signal change detection feature. More... | |
struct | dif_sysrst_ctrl_auto_override_config |
Runtime configuration for the System Reset Controller key signal auto-override feature. More... | |
struct | dif_sysrst_ctrl_pin_config_t |
Runtime configuration for the System Reset Controller output pin override feature. More... | |
struct | dif_sysrst_ctrl_ulp_wakeup_config_t |
Runtime configuration for the System Reset Controller ultra-low-power (ULP) wakeup feature. More... | |
Typedefs | |
typedef enum dif_sysrst_ctrl_key_combo | dif_sysrst_ctrl_key_combo_t |
A System Reset Controller key combination. | |
typedef enum dif_sysrst_ctrl_key | dif_sysrst_ctrl_key_t |
System Reset Controller keys that can form a key combination. | |
typedef enum dif_sysrst_ctrl_key_combo_action | dif_sysrst_ctrl_key_combo_action_t |
System Reset Controller key combination detection actions. | |
typedef struct dif_sysrst_ctrl_key_combo_config | dif_sysrst_ctrl_key_combo_config_t |
Runtime configuration for the System Reset Controller key combination detection feature. | |
typedef enum dif_sysrst_ctrl_input_change | dif_sysrst_ctrl_input_change_t |
System Reset Controller input signal changes that may be detected. | |
typedef enum dif_sysrst_ctrl_key_intr_src | dif_sysrst_ctrl_key_intr_src_t |
System Reset Controller key interrupt sources. | |
typedef enum dif_sysrst_ctrl_combo_intr_src | dif_sysrst_ctrl_combo_intr_src_t |
System Reset Controller combo interrupt sources. | |
typedef struct dif_sysrst_ctrl_input_change_config | dif_sysrst_ctrl_input_change_config_t |
Runtime configuration for the System Reset Controller input signal change detection feature. | |
typedef struct dif_sysrst_ctrl_auto_override_config | dif_sysrst_ctrl_auto_override_config_t |
Runtime configuration for the System Reset Controller key signal auto-override feature. More... | |
typedef enum dif_sysrst_ctrl_pin | dif_sysrst_ctrl_pin_t |
System Reset Controller pins that can be inverted, read, or overridden. | |
typedef struct dif_sysrst_ctrl_pin_config_t | dif_sysrst_ctrl_pin_config_t |
Runtime configuration for the System Reset Controller output pin override feature. | |
typedef struct dif_sysrst_ctrl_ulp_wakeup_config_t | dif_sysrst_ctrl_ulp_wakeup_config_t |
Runtime configuration for the System Reset Controller ultra-low-power (ULP) wakeup feature. More... | |
Functions | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_key_combo_detect_configure (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_key_combo_t key_combo, dif_sysrst_ctrl_key_combo_config_t config) |
Configures a System Reset Controller's key combination detection feature. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_input_change_detect_configure (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_input_change_config_t config) |
Configures a System Reset Controller's input signal change detection feature. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_output_pin_override_configure (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_pin_t output_pin, dif_sysrst_ctrl_pin_config_t config) |
Configures a System Reset Controller's output pin override feature. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_auto_override_configure (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_auto_override_config_t config, dif_toggle_t enabled) |
Configures a System Reset Controller's key signal auto-override feature. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_ulp_wakeup_configure (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_ulp_wakeup_config_t config) |
Configures a System Reset Controller's ultra-low-power (ULP) wakeup feature. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_ulp_wakeup_set_enabled (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_toggle_t enabled) |
Sets the enablement state of a System Reset Controller's ultra-low-power (ULP) wakeup feature. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_ulp_wakeup_get_enabled (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_toggle_t *is_enabled) |
Gets the enablement state of a System Reset Controller's ultra-low-power (ULP) wakeup feature. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_pins_set_inverted (const dif_sysrst_ctrl_t *sysrst_ctrl, uint32_t pins, bool inverted) |
Sets the inversion state a System Reset Controller's input and output pins. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_pins_get_inverted (const dif_sysrst_ctrl_t *sysrst_ctrl, uint32_t *inverted_pins) |
Gets the inversion state a System Reset Controller's input and output pins. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_output_pin_override_set_allowed (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_pin_t pin, bool allow_zero, bool allow_one) |
Sets allowable override values for a System Reset Controller's output pin. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_output_pin_override_get_allowed (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_pin_t pin, bool *allow_zero, bool *allow_one) |
Gets allowable override values for a System Reset Controller's output pin. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_output_pin_override_set_enabled (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_pin_t pin, dif_toggle_t enabled) |
Sets the enablement of a System Reset Controller's output pin override feature. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_output_pin_override_get_enabled (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_pin_t pin, dif_toggle_t *is_enabled) |
Gets the enablement of a System Reset Controller's output pin override feature. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_output_pin_set_override (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_pin_t pin, bool value) |
Sets the override value of a System Reset Controller's output pin (like writing to a GPIO pin). More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_output_pin_get_override (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_pin_t pin, bool *value) |
Gets the override value of a System Reset Controller's output pin (like writing to a GPIO pin). More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_input_pin_read (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_pin_t pin, bool *value) |
Reads a System Reset Controller's input pin (like a GPIO pin). More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_auto_override_set_enabled (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_key_t key, dif_toggle_t enabled) |
Sets the enablement of a System Reset Controller's key signal auto-override feature. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_auto_override_get_enabled (const dif_sysrst_ctrl_t *sysrst_ctrl, dif_sysrst_ctrl_key_t key, dif_toggle_t *is_enabled) |
Gets the enablement of a System Reset Controller's key signal auto-override feature. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_key_combo_irq_get_causes (const dif_sysrst_ctrl_t *sysrst_ctrl, uint32_t *causes) |
Gets the cause(s) of a key combination detection IRQ. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_key_combo_irq_clear_causes (const dif_sysrst_ctrl_t *sysrst_ctrl, uint32_t causes) |
Clears the cause(s) of a key combination detection IRQ. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_input_change_irq_get_causes (const dif_sysrst_ctrl_t *sysrst_ctrl, uint32_t *causes) |
Gets the cause(s) of an input signal change detection IRQ. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_input_change_irq_clear_causes (const dif_sysrst_ctrl_t *sysrst_ctrl, uint32_t causes) |
Clears the cause(s) of an input signal change detection IRQ. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_ulp_wakeup_get_status (const dif_sysrst_ctrl_t *sysrst_ctrl, bool *wakeup_detected) |
Gets the ultra-low-power wakeup status. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_ulp_wakeup_clear_status (const dif_sysrst_ctrl_t *sysrst_ctrl) |
Clears the ultra-low-power wakeup status. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_lock (const dif_sysrst_ctrl_t *sysrst_ctrl) |
Locks System Reset Controller configurations. More... | |
OT_WARN_UNUSED_RESULT dif_result_t | dif_sysrst_ctrl_is_locked (const dif_sysrst_ctrl_t *sysrst_ctrl, bool *is_locked) |
Checks whether System Reset Controller configurations are locked. More... | |
System Reset Controller Device Interface Functions
Definition in file dif_sysrst_ctrl.h.
struct dif_sysrst_ctrl_key_combo_config |
Runtime configuration for the System Reset Controller key combination detection feature.
Definition at line 110 of file dif_sysrst_ctrl.h.
struct dif_sysrst_ctrl_input_change_config |
Runtime configuration for the System Reset Controller input signal change detection feature.
Definition at line 322 of file dif_sysrst_ctrl.h.
struct dif_sysrst_ctrl_auto_override_config |
Runtime configuration for the System Reset Controller key signal auto-override feature.
Upon detection of a Power Button high-to-low transition, the signals from generic keys 0 through 2 may be overriden with specified values.
Definition at line 344 of file dif_sysrst_ctrl.h.
Data Fields | ||
---|---|---|
uint16_t | debounce_time_threshold |
The time to allow the Power Button signal to stabilize before reevaluating its value to decide whether it was pressed. Units: increments of 5us; [0, 2^16) represents [0, 200) milliseconds. |
bool | key_0_override_value | The value to override onto the key 0 signal. |
bool | key_1_override_value | The value to override onto the key 1 signal. |
bool | key_2_override_value | The value to override onto the key 2 signal. |
dif_toggle_t | override_key_0 | Whether to override the key 0 signal. |
dif_toggle_t | override_key_1 | Whether to override the key 1 signal. |
dif_toggle_t | override_key_2 | Whether to override the key 2 signal. |
struct dif_sysrst_ctrl_pin_config_t |
Runtime configuration for the System Reset Controller output pin override feature.
Definition at line 448 of file dif_sysrst_ctrl.h.
Data Fields | ||
---|---|---|
bool | allow_one | Whether to allow overriding the output pin with a value of 1. |
bool | allow_zero | Whether to allow overriding the output pin with a value of 0. |
dif_toggle_t | enabled | The enablement of the output pin's override feature. |
bool | override_value |
The override value to write. Note: writing a non-allowable value will cause |
struct dif_sysrst_ctrl_ulp_wakeup_config_t |
Runtime configuration for the System Reset Controller ultra-low-power (ULP) wakeup feature.
When enabled, detection of any of the following conditions:
will cause the System Reset Controller to assert the Z3 Wakeup output signal and trigger an interrupt, which will also issue a wakeup request to the power manager.
Definition at line 484 of file dif_sysrst_ctrl.h.
Data Fields | ||
---|---|---|
uint16_t | ac_power_debounce_time_threshold |
The time to allow the AC Power present signal to stabilize before reevaluating its value to decide whether it was activated. Units: increments of 5us; [0, 2^16) represents [10, 200) milliseconds. |
dif_toggle_t | enabled | The enablement of the ULP wakeup feature. |
uint16_t | lid_open_debounce_time_threshold |
The time to allow the Lid Open signal to stabilize before reevaluating its value to decide whether it was activated. Units: increments of 5us; [0, 2^16) represents [10, 200) milliseconds. |
uint16_t | power_button_debounce_time_threshold |
The time to allow the Power Button signal to stabilize before reevaluating its value to decide whether it was pressed. Units: increments of 5us; [0, 2^16) represents [10, 200) milliseconds. |
Runtime configuration for the System Reset Controller key signal auto-override feature.
Upon detection of a Power Button high-to-low transition, the signals from generic keys 0 through 2 may be overriden with specified values.
Runtime configuration for the System Reset Controller ultra-low-power (ULP) wakeup feature.
When enabled, detection of any of the following conditions:
will cause the System Reset Controller to assert the Z3 Wakeup output signal and trigger an interrupt, which will also issue a wakeup request to the power manager.
System Reset Controller combo interrupt sources.
Definition at line 295 of file dif_sysrst_ctrl.h.
System Reset Controller input signal changes that may be detected.
Definition at line 153 of file dif_sysrst_ctrl.h.
enum dif_sysrst_ctrl_key |
System Reset Controller keys that can form a key combination.
Definition at line 53 of file dif_sysrst_ctrl.h.
A System Reset Controller key combination.
Definition at line 24 of file dif_sysrst_ctrl.h.
System Reset Controller key combination detection actions.
Definition at line 83 of file dif_sysrst_ctrl.h.
System Reset Controller key interrupt sources.
Definition at line 219 of file dif_sysrst_ctrl.h.
enum dif_sysrst_ctrl_pin |
System Reset Controller pins that can be inverted, read, or overridden.
Definition at line 381 of file dif_sysrst_ctrl.h.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_auto_override_configure | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
dif_sysrst_ctrl_auto_override_config_t | config, | ||
dif_toggle_t | enabled | ||
) |
Configures a System Reset Controller's key signal auto-override feature.
Upon detection of a Power Button high-to-low transition, the signals from generic keys 0 through 2 may be overriden with specified values.
sysrst_ctrl | A System Reset Controller handle. |
config | Runtime configuration parameters. |
enabled | Whether to enable the feature or not. |
Definition at line 615 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_auto_override_get_enabled | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
dif_sysrst_ctrl_key_t | key, | ||
dif_toggle_t * | is_enabled | ||
) |
Gets the enablement of a System Reset Controller's key signal auto-override feature.
Note, this feature is only available for keys 0, 1, and 2. Attempting to check whether the auto-override feature is enabled non-supported keys will return kDifBadArg
.
sysrst_ctrl | A System Reset Controller handle. | |
key | The key the override feature is enabled for. | |
[out] | is_enabled | Whether the feature is enabled or not. |
Definition at line 714 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_auto_override_set_enabled | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
dif_sysrst_ctrl_key_t | key, | ||
dif_toggle_t | enabled | ||
) |
Sets the enablement of a System Reset Controller's key signal auto-override feature.
Note, this feature is only available for keys 0, 1, and 2. Attempting to enable the auto-override feature on non-supported keys will return kDifBadArg
.
sysrst_ctrl | A System Reset Controller handle. |
key | The key to enable the override feature for. |
enabled | Whether to enable the feature or not. |
Definition at line 686 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_input_change_detect_configure | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
dif_sysrst_ctrl_input_change_config_t | config | ||
) |
Configures a System Reset Controller's input signal change detection feature.
sysrst_ctrl | A System Reset Controller handle. |
config | Runtime configuration parameters. |
Definition at line 105 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_input_change_irq_clear_causes | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
uint32_t | causes | ||
) |
Clears the cause(s) of an input signal change detection IRQ.
sysrst_ctrl | An sysrst_ctrl handle. |
causes | The causes of the IRQ (one or more dif_sysrst_ctrl_input_change_t s ORed together). |
Definition at line 770 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_input_change_irq_get_causes | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
uint32_t * | causes | ||
) |
Gets the cause(s) of an input signal change detection IRQ.
sysrst_ctrl | An sysrst_ctrl handle. | |
[out] | causes | The causes of the IRQ (one or more dif_sysrst_ctrl_input_change_t s ORed together). |
Definition at line 758 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_input_pin_read | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
dif_sysrst_ctrl_pin_t | pin, | ||
bool * | value | ||
) |
Reads a System Reset Controller's input pin (like a GPIO pin).
Note, only input (or inout) pins may be read. Attempting to read the value of an output pin will return kDifBadArg
.
sysrst_ctrl | A System Reset Controller handle. | |
pin | The pin to read. | |
[out] | value | The value set on the pin. |
Definition at line 596 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_is_locked | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
bool * | is_locked | ||
) |
Checks whether System Reset Controller configurations are locked.
sysrst_ctrl | A System Reset Controller handle. | |
[out] | is_locked | Out-param for the locked state. |
Definition at line 816 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_key_combo_detect_configure | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
dif_sysrst_ctrl_key_combo_t | key_combo, | ||
dif_sysrst_ctrl_key_combo_config_t | config | ||
) |
Configures a System Reset Controller's key combination detection feature.
sysrst_ctrl | A System Reset Controller handle. |
key_combo | Key combination to configure. |
config | Runtime configuration parameters. |
Definition at line 22 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_key_combo_irq_clear_causes | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
uint32_t | causes | ||
) |
Clears the cause(s) of a key combination detection IRQ.
sysrst_ctrl | An sysrst_ctrl handle. |
causes | The causes of the IRQ (one or more dif_sysrst_ctrl_key_combo_t s ORed together). |
Definition at line 746 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_key_combo_irq_get_causes | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
uint32_t * | causes | ||
) |
Gets the cause(s) of a key combination detection IRQ.
sysrst_ctrl | An sysrst_ctrl handle. | |
[out] | causes | The causes of the IRQ (one or more dif_sysrst_ctrl_key_combo_t s ORed together). |
Definition at line 734 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_lock | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl | ) |
Locks System Reset Controller configurations.
This function is reentrant: calling it while locked will have no effect and return kDifOk
.
sysrst_ctrl | A System Reset Controller handle. |
Definition at line 806 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_output_pin_get_override | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
dif_sysrst_ctrl_pin_t | pin, | ||
bool * | value | ||
) |
Gets the override value of a System Reset Controller's output pin (like writing to a GPIO pin).
Note, only output (or inout) pins may be overriden, i.e., set to a specific value. Attempting to get the override value of an input pin will return kDifBadArg
.
Additionally, this will return the configured override value of an output pin regardless if the override function is enabled or the override value is allowed.
sysrst_ctrl | A System Reset Controller handle. | |
pin | The output pin to override. | |
[out] | value | The override value set on the pin. |
Definition at line 544 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_output_pin_override_configure | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
dif_sysrst_ctrl_pin_t | output_pin, | ||
dif_sysrst_ctrl_pin_config_t | config | ||
) |
Configures a System Reset Controller's output pin override feature.
Note, only output (or inout) pins may be overriden, i.e., set to a specific value. Attempting to configure the override feature for input pins will return kDifBadArg
.
sysrst_ctrl | A System Reset Controller handle. |
output_pin | Output pin to configure. |
config | Output pin override configuration parameters. |
Definition at line 127 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_output_pin_override_get_allowed | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
dif_sysrst_ctrl_pin_t | pin, | ||
bool * | allow_zero, | ||
bool * | allow_one | ||
) |
Gets allowable override values for a System Reset Controller's output pin.
Note, only output (or inout) pins may be overriden, i.e., set to a specific value. Attempting to get the allowable override values for input pins will return kDifBadArg
.
sysrst_ctrl | A System Reset Controller handle. | |
pin | The allowable override values to get for an output pin. | |
[out] | allow_zero | Whether overriding the pin's value to 0 is allowed. |
[out] | allow_one | Whether overriding the pin's value to 1 is allowed. |
Definition at line 393 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_output_pin_override_get_enabled | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
dif_sysrst_ctrl_pin_t | pin, | ||
dif_toggle_t * | is_enabled | ||
) |
Gets the enablement of a System Reset Controller's output pin override feature.
Note, only output (or inout) pins may be overriden, i.e., set to a specific value. Attempting to get the enablement of the override feature for input pins will return kDifBadArg
.
sysrst_ctrl | A System Reset Controller handle. | |
pin | The output pin whose override feature should be set. | |
[out] | is_enabled | The enablement state the override feature is configured in. |
Definition at line 470 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_output_pin_override_set_allowed | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
dif_sysrst_ctrl_pin_t | pin, | ||
bool | allow_zero, | ||
bool | allow_one | ||
) |
Sets allowable override values for a System Reset Controller's output pin.
Note, only output (or inout) pins may be overriden, i.e., set to a specific value. Attempting to set the allowable override values for input pins will return kDifBadArg
.
sysrst_ctrl | A System Reset Controller handle. |
pin | The output pin whose allowable override values should be set. |
allow_zero | Whether to allow overriding the pin's value to 0. |
allow_one | Whether to allow overriding the pin's value to 1. |
Definition at line 361 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_output_pin_override_set_enabled | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
dif_sysrst_ctrl_pin_t | pin, | ||
dif_toggle_t | enabled | ||
) |
Sets the enablement of a System Reset Controller's output pin override feature.
Note, only output (or inout) pins may be overriden, i.e., set to a specific value. Attempting to set the enablement of the override feature for input pins will return kDifBadArg
.
sysrst_ctrl | A System Reset Controller handle. |
pin | The output pin whose override feature should be set. |
enabled | The enablement state to configure the override feature in. |
Definition at line 448 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_output_pin_set_override | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
dif_sysrst_ctrl_pin_t | pin, | ||
bool | value | ||
) |
Sets the override value of a System Reset Controller's output pin (like writing to a GPIO pin).
Note, only output (or inout) pins may be overriden, i.e., set to a specific value. Attempting to set the override value of an input pin will return kDifBadArg
.
sysrst_ctrl | A System Reset Controller handle. |
pin | The output pin to override. |
value | The override value to set on the pin. |
Definition at line 522 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_pins_get_inverted | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
uint32_t * | inverted_pins | ||
) |
Gets the inversion state a System Reset Controller's input and output pins.
sysrst_ctrl | A System Reset Controller handle. | |
[out] | inverted_pins | The input and output pins that are inverted (i.e., one or more dif_sysrst_ctrl_pin_t s ORed together). |
Definition at line 307 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_pins_set_inverted | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
uint32_t | pins, | ||
bool | inverted | ||
) |
Sets the inversion state a System Reset Controller's input and output pins.
Note, only input and output (NOT inout) pins may be inverted. Attempting to set the inversion state of inout pins will return kDifBadArg
.
sysrst_ctrl | A System Reset Controller handle. |
pins | The input and output pins to set the inverted state of (i.e., one or more dif_sysrst_ctrl_pin_t s ORed together). |
inverted | The inverted state to configure for the pins. |
Definition at line 281 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_ulp_wakeup_clear_status | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl | ) |
Clears the ultra-low-power wakeup status.
sysrst_ctrl | An sysrst_ctrl handle. |
Definition at line 794 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_ulp_wakeup_configure | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
dif_sysrst_ctrl_ulp_wakeup_config_t | config | ||
) |
Configures a System Reset Controller's ultra-low-power (ULP) wakeup feature.
sysrst_ctrl | A System Reset Controller handle. |
config | Runtime configuration parameters. |
Definition at line 230 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_ulp_wakeup_get_enabled | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
dif_toggle_t * | is_enabled | ||
) |
Gets the enablement state of a System Reset Controller's ultra-low-power (ULP) wakeup feature.
sysrst_ctrl | A System Reset Controller handle. | |
[out] | is_enabled | The enablement state of the ULP wakeup feature. |
Definition at line 269 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_ulp_wakeup_get_status | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
bool * | wakeup_detected | ||
) |
Gets the ultra-low-power wakeup status.
sysrst_ctrl | An sysrst_ctrl handle. | |
[out] | wakeup_detected | The ULP wakeup detection state. |
Definition at line 782 of file dif_sysrst_ctrl.c.
OT_WARN_UNUSED_RESULT dif_result_t dif_sysrst_ctrl_ulp_wakeup_set_enabled | ( | const dif_sysrst_ctrl_t * | sysrst_ctrl, |
dif_toggle_t | enabled | ||
) |
Sets the enablement state of a System Reset Controller's ultra-low-power (ULP) wakeup feature.
sysrst_ctrl | A System Reset Controller handle. |
enabled | The enablement state to configure the ULP wakeup feature in. |
Definition at line 257 of file dif_sysrst_ctrl.c.