dif_sensor_ctrl.h
To use this DIF, include the following C header:
#include "/home/runner/work/opentitan/opentitan/sw/device/lib/dif/dif_sensor_ctrl.h"
This header provides the following device interface functions:
dif_sensor_ctrl_clear_recov_event
Clears the specified recoverable events.dif_sensor_ctrl_get_ast_event_trigger
Gets the value of a particular AST event trigger.dif_sensor_ctrl_get_ast_init_done_status
Gets the current ast init done status.dif_sensor_ctrl_get_fatal_events
Gets the current vector of fatal events.dif_sensor_ctrl_get_io_power_status
Gets the current io power status.dif_sensor_ctrl_get_recov_events
Gets the current vector of recoverable events.dif_sensor_ctrl_lock_cfg
Locks sensor control configuration from further updates.dif_sensor_ctrl_set_alert_en
Enable a particular alert event.dif_sensor_ctrl_set_alert_fatal
Sets the fatality configuration of a particular event.dif_sensor_ctrl_set_ast_event_trigger
Sets the value for a particular AST event trigger.
Generated from dif_sensor_ctrl.h
// Copyright lowRISC contributors (OpenTitan project).
// Licensed under the Apache License, Version 2.0, see LICENSE for details.
// SPDX-License-Identifier: Apache-2.0
#ifndef OPENTITAN_SW_DEVICE_LIB_DIF_DIF_SENSOR_CTRL_H_
#define OPENTITAN_SW_DEVICE_LIB_DIF_DIF_SENSOR_CTRL_H_
/**
* @file
* @brief <a href="/hw/top_earlgrey/ip/sensor_ctrl/doc/">Sensor Controller</a>
* Device Interface Functions
*/
#include <stdint.h>
#include "sw/device/lib/base/macros.h"
#include "sw/device/lib/base/mmio.h"
#include "sw/device/lib/dif/dif_base.h"
#include "sw/device/lib/dif/autogen/dif_sensor_ctrl_autogen.h"
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
/**
* An event, identified by a numeric id.
*
*/
typedef uint32_t dif_sensor_ctrl_event_idx_t;
/**
* A vector of AST events, where each bit represents one event.
*
*/
typedef uint32_t dif_sensor_ctrl_events_t;
/**
* IO power status
* Each bit represents the current status of a particular IO rail.
*
*/
typedef uint32_t dif_sensor_ctrl_io_power_status_t;
/**
* Locks sensor control configuration from further updates.
*
*
* @param sensor_ctrl A sensor_ctrl handle.
* @return 'kDifBadArg' if `handle` is null.
*/
OT_WARN_UNUSED_RESULT
dif_result_t dif_sensor_ctrl_lock_cfg(const dif_sensor_ctrl_t *sensor_ctrl);
/**
* Gets the value of a particular AST event trigger.
*
* @param sensor_ctrl A sensor_ctrl handle.
* @param event_idx The event to read.
* @param[out] enable The current trigger enable status.
* @return 'kDifBadArg' if `sensor_ctrl` or `enable` are null, or if `event_idx`
* is larger than the number of events supported.
*/
OT_WARN_UNUSED_RESULT
dif_result_t dif_sensor_ctrl_get_ast_event_trigger(
const dif_sensor_ctrl_t *sensor_ctrl, dif_sensor_ctrl_event_idx_t event_idx,
dif_toggle_t *enable);
/**
* Sets the value for a particular AST event trigger.
*
* @param sensor_ctrl A sensor_ctrl handle.
* @param event_idx The event to configure.
* @param enable The toggle status to set.
* @return 'kDifBadArg' if `handle` is null or if `event_idx` is larger than the
* number of events supported.
*/
OT_WARN_UNUSED_RESULT
dif_result_t dif_sensor_ctrl_set_ast_event_trigger(
const dif_sensor_ctrl_t *sensor_ctrl, dif_sensor_ctrl_event_idx_t event_idx,
dif_toggle_t enable);
/**
* Enable a particular alert event..
*
* @param sensor_ctrl A sensor_ctrl handle.
* @param event_idx The event to configure.
* @param en Whether an event is enabled or not. If
* `kDifToggleEnabled`, the event is enabled. Otherwise, it is disabled.
* @return 'kDifBadArg' if `handle` is null or `event_idx` is larger than the
* number of events supported.
*/
OT_WARN_UNUSED_RESULT
dif_result_t dif_sensor_ctrl_set_alert_en(const dif_sensor_ctrl_t *sensor_ctrl,
dif_sensor_ctrl_event_idx_t event_idx,
dif_toggle_t en);
/**
* Sets the fatality configuration of a particular event.
*
* An event can be configured to be either fatal or recoverable.
*
* @param sensor_ctrl A sensor_ctrl handle.
* @param event_idx The event to configure.
* @param en_fatal The fatality enablement state of an event. If
* `kDifToggleEnabled`, the event is fatal. Otherwise, it is recoverable.
* @return 'kDifBadArg' if `handle` is null or `event_idx` is larger than the
* number of events supported.
*/
OT_WARN_UNUSED_RESULT
dif_result_t dif_sensor_ctrl_set_alert_fatal(
const dif_sensor_ctrl_t *sensor_ctrl, dif_sensor_ctrl_event_idx_t event_idx,
dif_toggle_t en_fatal);
/**
* Gets the current vector of recoverable events.
*
* @param sensor_ctrl A sensor_ctrl handle.
* @param[out] events The set of current recoverable events
* @return 'kDifBadArg' if `handle` is null.
*/
OT_WARN_UNUSED_RESULT
dif_result_t dif_sensor_ctrl_get_recov_events(
const dif_sensor_ctrl_t *sensor_ctrl, dif_sensor_ctrl_events_t *events);
/**
* Clears the specified recoverable events.
*
* @param sensor_ctrl A sensor_ctrl handle.
* @param event_idx The event to clear.
* @return 'kDifBadArg' if `handle` is null or 'event_idx' is larger than the
* number of events supported..
*/
OT_WARN_UNUSED_RESULT
dif_result_t dif_sensor_ctrl_clear_recov_event(
const dif_sensor_ctrl_t *sensor_ctrl,
dif_sensor_ctrl_event_idx_t event_idx);
/**
* Gets the current vector of fatal events.
*
* @param sensor_ctrl A sensor_ctrl handle.
* @param[out] events The set of current fatal events.
* @return 'kDifBadArg' if `handle` is null.
*/
OT_WARN_UNUSED_RESULT
dif_result_t dif_sensor_ctrl_get_fatal_events(
const dif_sensor_ctrl_t *sensor_ctrl, dif_sensor_ctrl_events_t *events);
/**
* Gets the current ast init done status.
*
* @param sensor_ctrl A sensor_ctrl handle.
* @param[out] done Current init_done status.
* @return 'kDifBadArg' if `handle` is null.
*/
OT_WARN_UNUSED_RESULT
dif_result_t dif_sensor_ctrl_get_ast_init_done_status(
const dif_sensor_ctrl_t *sensor_ctrl, dif_toggle_t *done);
/**
* Gets the current io power status.
*
* @param sensor_ctrl A sensor_ctrl handle.
* @param[out] done Current io power status.
* @return 'kDifBadArg' if `handle` is null.
*/
OT_WARN_UNUSED_RESULT
dif_result_t dif_sensor_ctrl_get_io_power_status(
const dif_sensor_ctrl_t *sensor_ctrl,
dif_sensor_ctrl_io_power_status_t *io_status);
#ifdef __cplusplus
} // extern "C"
#endif // __cplusplus
#endif // OPENTITAN_SW_DEVICE_LIB_DIF_DIF_SENSOR_CTRL_H_