dt_aes.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_AES_H_
#define OPENTITAN_DT_AES_H_
 
/**
 * @file
 * @brief Device Tables (DT) for IP aes and top englishbreakfast.
 *
 * This file contains the type definitions and global functions of the aes.
 */
 
#include "dt_api.h"
#include <stdint.h>
 
 
 
/**
 * List of instances.
 */
typedef enum dt_aes {
  kDtAes = 0, /**< aes */
  kDtAesFirst = 0, /**< \internal First instance */
  kDtAesCount = 1, /**< \internal Number of instances */
} dt_aes_t;
 
/**
 * List of register blocks.
 *
 * Register blocks are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_aes_reg_block {
  kDtAesRegBlockCore = 0, /**<  */
  kDtAesRegBlockCount = 1, /**< \internal Number of register blocks */
} dt_aes_reg_block_t;
 
/** Primary register block (associated with the "primary" set of registers that control the IP). */
static const dt_aes_reg_block_t kDtAesRegBlockPrimary = kDtAesRegBlockCore;
 
/**
 * List of clock ports.
 *
 * Clock ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_aes_clock {
  kDtAesClockClk = 0, /**< Clock port clk_i */
  kDtAesClockEdn = 1, /**< Clock port clk_edn_i */
  kDtAesClockCount = 2, /**< \internal Number of clock ports */
} dt_aes_clock_t;
 
/**
 * List of reset ports.
 *
 * Reset ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_aes_reset {
  kDtAesResetRst = 0, /**< Reset port rst_ni */
  kDtAesResetEdn = 1, /**< Reset port rst_edn_ni */
  kDtAesResetCount = 2, /**< \internal Number of reset ports */
} dt_aes_reset_t;
 
/**
 * List of supported hardware features.
 */
#define OPENTITAN_AES_HAS_KEY_LEN_128 1
#define OPENTITAN_AES_HAS_KEY_LEN_192 1
#define OPENTITAN_AES_HAS_KEY_LEN_256 1
#define OPENTITAN_AES_HAS_MODE_ECB 1
#define OPENTITAN_AES_HAS_MODE_CBC 1
#define OPENTITAN_AES_HAS_MODE_CFB_128 1
#define OPENTITAN_AES_HAS_MODE_OFB 1
#define OPENTITAN_AES_HAS_MODE_CTR 1
#define OPENTITAN_AES_HAS_KEY_SIDELOAD 1
#define OPENTITAN_AES_HAS_CLEAR_DATA_OUT 1
#define OPENTITAN_AES_HAS_CLEAR_KEY_IV_DATA_IN 1
#define OPENTITAN_AES_HAS_PRNG_RESEED_RATE 1
#define OPENTITAN_AES_HAS_PRNG_KEY_TOUCH_FORCES_RESEED 1
#define OPENTITAN_AES_HAS_PRNG_FORCE_MASKS 1
#define OPENTITAN_AES_HAS_MANUAL_OPERATION 1
 
 
 
/**
 * Get the aes instance from an instance ID
 *
 * For example, `dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3`.
 *
 * @param inst_id Instance ID.
 * @return A aes instance.
 *
 * **Note:** This function only makes sense if the instance ID has device type aes,
 * otherwise the returned value is unspecified.
 */
dt_aes_t dt_aes_from_instance_id(dt_instance_id_t inst_id);
 
/**
 * Get the instance ID of an instance.
 *
 * @param dt Instance of aes.
 * @return The instance ID of that instance.
 */
dt_instance_id_t dt_aes_instance_id(dt_aes_t dt);
 
/**
 * Get the register base address of an instance.
 *
 * @param dt Instance of aes.
 * @param reg_block The register block requested.
 * @return The register base address of the requested block.
 */
uint32_t dt_aes_reg_block(
    dt_aes_t dt,
    dt_aes_reg_block_t reg_block);
 
/**
 * Get the primary register base address of an instance.
 *
 * This is just a convenience function, equivalent to
 * `dt_aes_reg_block(dt, kDtAesRegBlockCore)`
 *
 * @param dt Instance of aes.
 * @return The register base address of the primary register block.
 */
static inline uint32_t dt_aes_primary_reg_block(
    dt_aes_t dt) {
  return dt_aes_reg_block(dt, kDtAesRegBlockCore);
}
 
 
 
 
/**
 * Get the clock signal connected to a clock port of an instance.
 *
 * @param dt Instance of aes.
 * @param clk Clock port.
 * @return Clock signal.
 */
dt_clock_t dt_aes_clock(
    dt_aes_t dt,
    dt_aes_clock_t clk);
 
/**
 * Get the reset signal connected to a reset port of an instance.
 *
 * @param dt Instance of aes.
 * @param rst Reset port.
 * @return Reset signal.
 */
dt_reset_t dt_aes_reset(
    dt_aes_t dt,
    dt_aes_reset_t rst);
 
 
 
#endif  // OPENTITAN_DT_AES_H_