dt_soc_proxy.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_SOC_PROXY_H_
#define OPENTITAN_DT_SOC_PROXY_H_
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
/**
 * @file
 * @brief Device Tables (DT) for IP soc_proxy and top darjeeling.
 *
 * This file contains the type definitions and global functions of the soc_proxy.
 */
 
#include "hw/top/dt/dt_api.h"
#include <stdint.h>
 
 
 
/**
 * List of instances.
 */
typedef enum dt_soc_proxy {
  kDtSocProxy = 0, /**< soc_proxy */
  kDtSocProxyFirst = 0, /**< \internal First instance */
  kDtSocProxyCount = 1, /**< \internal Number of instances */
} dt_soc_proxy_t;
 
/**
 * List of register blocks.
 *
 * Register blocks are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_soc_proxy_reg_block {
  kDtSocProxyRegBlockCore = 0, /**<  */
  kDtSocProxyRegBlockCount = 1, /**< \internal Number of register blocks */
} dt_soc_proxy_reg_block_t;
 
/** Primary register block (associated with the "primary" set of registers that control the IP). */
static const dt_soc_proxy_reg_block_t kDtSocProxyRegBlockPrimary = kDtSocProxyRegBlockCore;
 
/**
 * List of memories.
 *
 * Memories are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_soc_proxy_memory {
  kDtSocProxyMemoryCtn = 0, /**<  */
  kDtSocProxyMemoryCount = 1, /**< \internal Number of memories */
} dt_soc_proxy_memory_t;
 
/**
 * List of Alerts.
 *
 * Alerts are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_soc_proxy_alert {
  kDtSocProxyAlertFatalAlertIntg = 0, /**< Fatal bus integrity alert */
  kDtSocProxyAlertCount = 1, /**< \internal Number of Alerts */
} dt_soc_proxy_alert_t;
 
/**
 * List of clock ports.
 *
 * Clock ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_soc_proxy_clock {
  kDtSocProxyClockClk = 0, /**< Clock port clk_i */
  kDtSocProxyClockAon = 1, /**< Clock port clk_aon_i */
  kDtSocProxyClockCount = 2, /**< \internal Number of clock ports */
} dt_soc_proxy_clock_t;
 
/**
 * List of reset requests.
 *
 * Reset requests are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_soc_proxy_reset_req {
  kDtSocProxyResetReqExternal = 0, /**< External reset request */
  kDtSocProxyResetReqCount = 1, /**< \internal Number of reset requests */
} dt_soc_proxy_reset_req_t;
 
/**
 * List of reset ports.
 *
 * Reset ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_soc_proxy_reset {
  kDtSocProxyResetRst = 0, /**< Reset port rst_ni */
  kDtSocProxyResetPor = 1, /**< Reset port rst_por_ni */
  kDtSocProxyResetCount = 2, /**< \internal Number of reset ports */
} dt_soc_proxy_reset_t;
 
/**
 * List of peripheral I/O.
 *
 * Peripheral I/O are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_soc_proxy_periph_io {
  kDtSocProxyPeriphIoSocGpi0 = 0, /**<  */
  kDtSocProxyPeriphIoSocGpi1 = 1, /**<  */
  kDtSocProxyPeriphIoSocGpi2 = 2, /**<  */
  kDtSocProxyPeriphIoSocGpi3 = 3, /**<  */
  kDtSocProxyPeriphIoSocGpi4 = 4, /**<  */
  kDtSocProxyPeriphIoSocGpi5 = 5, /**<  */
  kDtSocProxyPeriphIoSocGpi6 = 6, /**<  */
  kDtSocProxyPeriphIoSocGpi7 = 7, /**<  */
  kDtSocProxyPeriphIoSocGpi8 = 8, /**<  */
  kDtSocProxyPeriphIoSocGpi9 = 9, /**<  */
  kDtSocProxyPeriphIoSocGpi10 = 10, /**<  */
  kDtSocProxyPeriphIoSocGpi11 = 11, /**<  */
  kDtSocProxyPeriphIoSocGpi12 = 12, /**<  */
  kDtSocProxyPeriphIoSocGpi13 = 13, /**<  */
  kDtSocProxyPeriphIoSocGpi14 = 14, /**<  */
  kDtSocProxyPeriphIoSocGpi15 = 15, /**<  */
  kDtSocProxyPeriphIoSocGpo0 = 16, /**<  */
  kDtSocProxyPeriphIoSocGpo1 = 17, /**<  */
  kDtSocProxyPeriphIoSocGpo2 = 18, /**<  */
  kDtSocProxyPeriphIoSocGpo3 = 19, /**<  */
  kDtSocProxyPeriphIoSocGpo4 = 20, /**<  */
  kDtSocProxyPeriphIoSocGpo5 = 21, /**<  */
  kDtSocProxyPeriphIoSocGpo6 = 22, /**<  */
  kDtSocProxyPeriphIoSocGpo7 = 23, /**<  */
  kDtSocProxyPeriphIoSocGpo8 = 24, /**<  */
  kDtSocProxyPeriphIoSocGpo9 = 25, /**<  */
  kDtSocProxyPeriphIoSocGpo10 = 26, /**<  */
  kDtSocProxyPeriphIoSocGpo11 = 27, /**<  */
  kDtSocProxyPeriphIoSocGpo12 = 28, /**<  */
  kDtSocProxyPeriphIoSocGpo13 = 29, /**<  */
  kDtSocProxyPeriphIoSocGpo14 = 30, /**<  */
  kDtSocProxyPeriphIoSocGpo15 = 31, /**<  */
  kDtSocProxyPeriphIoCount = 32, /**< \internal Number of peripheral I/O */
} dt_soc_proxy_periph_io_t;
 
/**
 * List of wakeups.
 *
 * Wakeups are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_soc_proxy_wakeup {
  kDtSocProxyWakeupWkupExternalReq = 0, /**< External wakeup request */
  kDtSocProxyWakeupCount = 1, /**< \internal Number of wakeups */
} dt_soc_proxy_wakeup_t;
 
 
/**
 * Get the soc_proxy instance from an instance ID
 *
 * For example, `dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3`.
 *
 * @param inst_id Instance ID.
 * @return A soc_proxy instance.
 *
 * **Note:** This function only makes sense if the instance ID has device type soc_proxy,
 * otherwise the returned value is unspecified.
 */
dt_soc_proxy_t dt_soc_proxy_from_instance_id(dt_instance_id_t inst_id);
 
/**
 * Get the instance ID of an instance.
 *
 * @param dt Instance of soc_proxy.
 * @return The instance ID of that instance.
 */
dt_instance_id_t dt_soc_proxy_instance_id(dt_soc_proxy_t dt);
 
/**
 * Get the register base address of an instance.
 *
 * @param dt Instance of soc_proxy.
 * @param reg_block The register block requested.
 * @return The register base address of the requested block.
 */
uint32_t dt_soc_proxy_reg_block(
    dt_soc_proxy_t dt,
    dt_soc_proxy_reg_block_t reg_block);
 
/**
 * Get the primary register base address of an instance.
 *
 * This is just a convenience function, equivalent to
 * `dt_soc_proxy_reg_block(dt, kDtSocProxyRegBlockCore)`
 *
 * @param dt Instance of soc_proxy.
 * @return The register base address of the primary register block.
 */
static inline uint32_t dt_soc_proxy_primary_reg_block(
    dt_soc_proxy_t dt) {
  return dt_soc_proxy_reg_block(dt, kDtSocProxyRegBlockCore);
}
 
/**
 * Get the base address of a memory.
 *
 * @param dt Instance of soc_proxy.
 * @param mem The memory requested.
 * @return The base address of the requested memory.
 */
uint32_t dt_soc_proxy_memory_base(
    dt_soc_proxy_t dt,
    dt_soc_proxy_memory_t mem);
 
/**
 * Get the size of a memory.
 *
 * @param dt Instance of soc_proxy.
 * @param mem The memory requested.
 * @return The size of the requested memory.
 */
uint32_t dt_soc_proxy_memory_size(
    dt_soc_proxy_t dt,
    dt_soc_proxy_memory_t mem);
 
 
/**
 * Get the alert ID of a soc_proxy alert for a given instance.
 *
 * **Note:** This function only makes sense if the instance is connected to the Alert Handler. For any
 * instances where the instance is not connected, the return value is unspecified.
 *
 * @param dt Instance of soc_proxy.
 * @param alert A soc_proxy alert.
 * @return The Alert Handler alert ID of the alert of this instance.
 */
dt_alert_id_t dt_soc_proxy_alert_to_alert_id(
    dt_soc_proxy_t dt,
    dt_soc_proxy_alert_t alert);
 
/**
 * Convert a global alert ID to a local soc_proxy alert type.
 *
 * @param dt Instance of soc_proxy.
 * @param alert A global alert ID that belongs to this instance.
 * @return The soc_proxy alert, or `kDtSocProxyAlertCount`.
 *
 * **Note:** This function assumes that the global alert ID belongs to the
 * instance of soc_proxy passed in parameter. In other words, it must be the case
 * that `dt_soc_proxy_instance_id(dt) == dt_alert_id_to_instance_id(alert)`. Otherwise,
 * this function will return `kDtSocProxyAlertCount`.
 */
dt_soc_proxy_alert_t dt_soc_proxy_alert_from_alert_id(
    dt_soc_proxy_t dt,
    dt_alert_id_t alert);
 
 
/**
 * Get the peripheral I/O description of an instance.
 *
 * @param dt Instance of soc_proxy.
 * @param sig Requested peripheral I/O.
 * @return Description of the requested peripheral I/O for this instance.
 */
dt_periph_io_t dt_soc_proxy_periph_io(
    dt_soc_proxy_t dt,
    dt_soc_proxy_periph_io_t sig);
 
/**
 * Get the clock signal connected to a clock port of an instance.
 *
 * @param dt Instance of soc_proxy.
 * @param clk Clock port.
 * @return Clock signal.
 */
dt_clock_t dt_soc_proxy_clock(
    dt_soc_proxy_t dt,
    dt_soc_proxy_clock_t clk);
 
/**
 * Get the reset signal connected to a reset port of an instance.
 *
 * @param dt Instance of soc_proxy.
 * @param rst Reset port.
 * @return Reset signal.
 */
dt_reset_t dt_soc_proxy_reset(
    dt_soc_proxy_t dt,
    dt_soc_proxy_reset_t rst);
 
 
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  // OPENTITAN_DT_SOC_PROXY_H_