dt_alert_handler.h

Go to the documentation of this file.

// Copyright lowRISC contributors (OpenTitan project).
// Licensed under the Apache License, Version 2.0, see LICENSE for details.
// SPDX-License-Identifier: Apache-2.0
//
// Device table API auto-generated by `dtgen`
 
#ifndef OPENTITAN_DT_ALERT_HANDLER_H_
#define OPENTITAN_DT_ALERT_HANDLER_H_
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
/**
 * @file
 * @brief Device Tables (DT) for IP alert_handler and top earlgrey.
 *
 * This file contains the type definitions and global functions of the alert_handler.
 */
 
#include "hw/top/dt/dt_api.h"
#include <stdint.h>
 
 
 
/**
 * List of instances.
 */
typedef enum dt_alert_handler {
  kDtAlertHandler = 0, /**< alert_handler */
  kDtAlertHandlerFirst = 0, /**< \internal First instance */
  kDtAlertHandlerCount = 1, /**< \internal Number of instances */
} dt_alert_handler_t;
 
/**
 * List of register blocks.
 *
 * Register blocks are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_alert_handler_reg_block {
  kDtAlertHandlerRegBlockCore = 0, /**<  */
  kDtAlertHandlerRegBlockCount = 1, /**< \internal Number of register blocks */
} dt_alert_handler_reg_block_t;
 
/**
 * List of memories.
 *
 * Memories are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_alert_handler_memory {
  kDtAlertHandlerMemoryCount = 0, /**< \internal Number of memories */
} dt_alert_handler_memory_t;
 
/** Primary register block (associated with the "primary" set of registers that control the IP). */
static const dt_alert_handler_reg_block_t kDtAlertHandlerRegBlockPrimary = kDtAlertHandlerRegBlockCore;
 
/**
 * List of IRQs.
 *
 * IRQs are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_alert_handler_irq {
  kDtAlertHandlerIrqClassa = 0, /**< Interrupt state bit of Class A. Set by HW in case an alert within this class triggered. Defaults true, write one to clear. */
  kDtAlertHandlerIrqClassb = 1, /**< Interrupt state bit of Class B. Set by HW in case an alert within this class triggered. Defaults true, write one to clear. */
  kDtAlertHandlerIrqClassc = 2, /**< Interrupt state bit of Class C. Set by HW in case an alert within this class triggered. Defaults true, write one to clear. */
  kDtAlertHandlerIrqClassd = 3, /**< Interrupt state bit of Class D. Set by HW in case an alert within this class triggered. Defaults true, write one to clear. */
  kDtAlertHandlerIrqCount = 4, /**< \internal Number of IRQs */
} dt_alert_handler_irq_t;
 
/**
 * List of clock ports.
 *
 * Clock ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_alert_handler_clock {
  kDtAlertHandlerClockClk = 0, /**< Clock port clk_i */
  kDtAlertHandlerClockEdn = 1, /**< Clock port clk_edn_i */
  kDtAlertHandlerClockCount = 2, /**< \internal Number of clock ports */
} dt_alert_handler_clock_t;
 
/**
 * List of reset ports.
 *
 * Reset ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_alert_handler_reset {
  kDtAlertHandlerResetRst = 0, /**< Reset port rst_ni */
  kDtAlertHandlerResetEdn = 1, /**< Reset port rst_edn_ni */
  kDtAlertHandlerResetCount = 2, /**< \internal Number of reset ports */
} dt_alert_handler_reset_t;
 
/**
 * List of supported hardware features.
 */
#define OPENTITAN_ALERT_HANDLER_HAS_ALERT_OBSERVE 1
#define OPENTITAN_ALERT_HANDLER_HAS_ALERT_INTERRUPT 1
#define OPENTITAN_ALERT_HANDLER_HAS_ALERT_ESCALATE 1
#define OPENTITAN_ALERT_HANDLER_HAS_PING_TIMER 1
#define OPENTITAN_ALERT_HANDLER_HAS_ESCALATION_COUNT 1
#define OPENTITAN_ALERT_HANDLER_HAS_ESCALATION_TIMEOUT 1
#define OPENTITAN_ALERT_HANDLER_HAS_ESCALATION_PHASES 1
#define OPENTITAN_ALERT_HANDLER_HAS_CRASH_DUMP 1
 
 
 
/**
 * Get the alert_handler instance from an instance ID
 *
 * For example, `dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3`.
 *
 * @param inst_id Instance ID.
 * @return A alert_handler instance.
 *
 * **Note:** This function only makes sense if the instance ID has device type alert_handler,
 * otherwise the returned value is unspecified.
 */
dt_alert_handler_t dt_alert_handler_from_instance_id(dt_instance_id_t inst_id);
 
/**
 * Get the instance ID of an instance.
 *
 * @param dt Instance of alert_handler.
 * @return The instance ID of that instance.
 */
dt_instance_id_t dt_alert_handler_instance_id(dt_alert_handler_t dt);
 
/**
 * Get the register base address of an instance.
 *
 * @param dt Instance of alert_handler.
 * @param reg_block The register block requested.
 * @return The register base address of the requested block.
 */
uint32_t dt_alert_handler_reg_block(
    dt_alert_handler_t dt,
    dt_alert_handler_reg_block_t reg_block);
 
/**
 * Get the primary register base address of an instance.
 *
 * This is just a convenience function, equivalent to
 * `dt_alert_handler_reg_block(dt, kDtAlertHandlerRegBlockCore)`
 *
 * @param dt Instance of alert_handler.
 * @return The register base address of the primary register block.
 */
static inline uint32_t dt_alert_handler_primary_reg_block(
    dt_alert_handler_t dt) {
  return dt_alert_handler_reg_block(dt, kDtAlertHandlerRegBlockCore);
}
 
/**
 * Get the base address of a memory.
 *
 * @param dt Instance of alert_handler.
 * @param mem The memory requested.
 * @return The base address of the requested memory.
 */
uint32_t dt_alert_handler_memory_base(
    dt_alert_handler_t dt,
    dt_alert_handler_memory_t mem);
 
/**
 * Get the size of a memory.
 *
 * @param dt Instance of alert_handler.
 * @param mem The memory requested.
 * @return The size of the requested memory.
 */
uint32_t dt_alert_handler_memory_size(
    dt_alert_handler_t dt,
    dt_alert_handler_memory_t mem);
 
/**
 * Get the PLIC ID of a alert_handler IRQ for a given instance.
 *
 * If the instance is not connected to the PLIC, this function
 * will return `kDtPlicIrqIdNone`.
 *
 * @param dt Instance of alert_handler.
 * @param irq A alert_handler IRQ.
 * @return The PLIC ID of the IRQ of this instance.
 */
dt_plic_irq_id_t dt_alert_handler_irq_to_plic_id(
    dt_alert_handler_t dt,
    dt_alert_handler_irq_t irq);
 
/**
 * Convert a global IRQ ID to a local alert_handler IRQ type.
 *
 * @param dt Instance of alert_handler.
 * @param irq A PLIC ID that belongs to this instance.
 * @return The alert_handler IRQ, or `kDtAlertHandlerIrqCount`.
 *
 * **Note:** This function assumes that the PLIC ID belongs to the instance
 * of alert_handler passed in parameter. In other words, it must be the case that
 * `dt_alert_handler_instance_id(dt) == dt_plic_id_to_instance_id(irq)`. Otherwise, this function
 * will return `kDtAlertHandlerIrqCount`.
 */
dt_alert_handler_irq_t dt_alert_handler_irq_from_plic_id(
    dt_alert_handler_t dt,
    dt_plic_irq_id_t irq);
 
 
 
 
/**
 * Get the clock signal connected to a clock port of an instance.
 *
 * @param dt Instance of alert_handler.
 * @param clk Clock port.
 * @return Clock signal.
 */
dt_clock_t dt_alert_handler_clock(
    dt_alert_handler_t dt,
    dt_alert_handler_clock_t clk);
 
/**
 * Get the reset signal connected to a reset port of an instance.
 *
 * @param dt Instance of alert_handler.
 * @param rst Reset port.
 * @return Reset signal.
 */
dt_reset_t dt_alert_handler_reset(
    dt_alert_handler_t dt,
    dt_alert_handler_reset_t rst);
 
 
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  // OPENTITAN_DT_ALERT_HANDLER_H_