dt_otp_macro.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_OTP_MACRO_H_
#define OPENTITAN_DT_OTP_MACRO_H_
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
/**
 * @file
 * @brief Device Tables (DT) for IP otp_macro and top earlgrey.
 *
 * This file contains the type definitions and global functions of the otp_macro.
 */
 
#include "hw/top/dt/dt_api.h"
#include <stdint.h>
 
 
 
/**
 * List of instances.
 */
typedef enum dt_otp_macro {
  kDtOtpMacro = 0, /**< otp_macro */
  kDtOtpMacroFirst = 0, /**< \internal First instance */
  kDtOtpMacroCount = 1, /**< \internal Number of instances */
} dt_otp_macro_t;
 
/**
 * List of register blocks.
 *
 * Register blocks are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_otp_macro_reg_block {
  kDtOtpMacroRegBlockPrim = 0, /**<  */
  kDtOtpMacroRegBlockCount = 1, /**< \internal Number of register blocks */
} dt_otp_macro_reg_block_t;
 
/** Primary register block (associated with the "primary" set of registers that control the IP). */
static const dt_otp_macro_reg_block_t kDtOtpMacroRegBlockPrimary = kDtOtpMacroRegBlockPrim;
 
/**
 * List of memories.
 *
 * Memories are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_otp_macro_memory {
  kDtOtpMacroMemoryCount = 0, /**< \internal Number of memories */
} dt_otp_macro_memory_t;
 
/**
 * List of clock ports.
 *
 * Clock ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_otp_macro_clock {
  kDtOtpMacroClockClk = 0, /**< Clock port clk_i */
  kDtOtpMacroClockCount = 1, /**< \internal Number of clock ports */
} dt_otp_macro_clock_t;
 
/**
 * List of reset ports.
 *
 * Reset ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_otp_macro_reset {
  kDtOtpMacroResetRst = 0, /**< Reset port rst_ni */
  kDtOtpMacroResetCount = 1, /**< \internal Number of reset ports */
} dt_otp_macro_reset_t;
 
/**
 * List of peripheral I/O.
 *
 * Peripheral I/O are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_otp_macro_periph_io {
  kDtOtpMacroPeriphIoTest0 = 0, /**<  */
  kDtOtpMacroPeriphIoTest1 = 1, /**<  */
  kDtOtpMacroPeriphIoTest2 = 2, /**<  */
  kDtOtpMacroPeriphIoTest3 = 3, /**<  */
  kDtOtpMacroPeriphIoTest4 = 4, /**<  */
  kDtOtpMacroPeriphIoTest5 = 5, /**<  */
  kDtOtpMacroPeriphIoTest6 = 6, /**<  */
  kDtOtpMacroPeriphIoTest7 = 7, /**<  */
  kDtOtpMacroPeriphIoCount = 8, /**< \internal Number of peripheral I/O */
} dt_otp_macro_periph_io_t;
 
 
/**
 * Get the otp_macro instance from an instance ID
 *
 * For example, `dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3`.
 *
 * @param inst_id Instance ID.
 * @return A otp_macro instance.
 *
 * **Note:** This function only makes sense if the instance ID has device type otp_macro,
 * otherwise the returned value is unspecified.
 */
dt_otp_macro_t dt_otp_macro_from_instance_id(dt_instance_id_t inst_id);
 
/**
 * Get the instance ID of an instance.
 *
 * @param dt Instance of otp_macro.
 * @return The instance ID of that instance.
 */
dt_instance_id_t dt_otp_macro_instance_id(dt_otp_macro_t dt);
 
/**
 * Get the register base address of an instance.
 *
 * @param dt Instance of otp_macro.
 * @param reg_block The register block requested.
 * @return The register base address of the requested block.
 */
uint32_t dt_otp_macro_reg_block(
    dt_otp_macro_t dt,
    dt_otp_macro_reg_block_t reg_block);
 
/**
 * Get the primary register base address of an instance.
 *
 * This is just a convenience function, equivalent to
 * `dt_otp_macro_reg_block(dt, kDtOtpMacroRegBlockPrim)`
 *
 * @param dt Instance of otp_macro.
 * @return The register base address of the primary register block.
 */
static inline uint32_t dt_otp_macro_primary_reg_block(
    dt_otp_macro_t dt) {
  return dt_otp_macro_reg_block(dt, kDtOtpMacroRegBlockPrim);
}
 
/**
 * Get the base address of a memory.
 *
 * @param dt Instance of otp_macro.
 * @param mem The memory requested.
 * @return The base address of the requested memory.
 */
uint32_t dt_otp_macro_memory_base(
    dt_otp_macro_t dt,
    dt_otp_macro_memory_t mem);
 
/**
 * Get the size of a memory.
 *
 * @param dt Instance of otp_macro.
 * @param mem The memory requested.
 * @return The size of the requested memory.
 */
uint32_t dt_otp_macro_memory_size(
    dt_otp_macro_t dt,
    dt_otp_macro_memory_t mem);
 
 
 
/**
 * Get the peripheral I/O description of an instance.
 *
 * @param dt Instance of otp_macro.
 * @param sig Requested peripheral I/O.
 * @return Description of the requested peripheral I/O for this instance.
 */
dt_periph_io_t dt_otp_macro_periph_io(
    dt_otp_macro_t dt,
    dt_otp_macro_periph_io_t sig);
 
/**
 * Get the clock signal connected to a clock port of an instance.
 *
 * @param dt Instance of otp_macro.
 * @param clk Clock port.
 * @return Clock signal.
 */
dt_clock_t dt_otp_macro_clock(
    dt_otp_macro_t dt,
    dt_otp_macro_clock_t clk);
 
/**
 * Get the reset signal connected to a reset port of an instance.
 *
 * @param dt Instance of otp_macro.
 * @param rst Reset port.
 * @return Reset signal.
 */
dt_reset_t dt_otp_macro_reset(
    dt_otp_macro_t dt,
    dt_otp_macro_reset_t rst);
 
 
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  // OPENTITAN_DT_OTP_MACRO_H_