Software APIs
dt_aes.h File Reference

Device Tables (DT) for IP aes and top earlgrey. More...

#include "dt_api.h"
#include <stdint.h>

Go to the source code of this file.

Macros

#define OPENTITAN_AES_HAS_KEY_LEN_128   1
 List of supported hardware features.
 
#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
 

Typedefs

typedef enum dt_aes dt_aes_t
 List of instances.
 
typedef enum dt_aes_reg_block dt_aes_reg_block_t
 List of register blocks.
 
typedef enum dt_aes_alert dt_aes_alert_t
 List of Alerts.
 
typedef enum dt_aes_clock dt_aes_clock_t
 List of clock ports.
 
typedef enum dt_aes_reset dt_aes_reset_t
 List of reset ports.
 

Enumerations

enum  dt_aes {
  kDtAes = 0 ,
  kDtAesFirst = 0 ,
  kDtAesCount = 1
}
 List of instances. More...
 
enum  dt_aes_reg_block {
  kDtAesRegBlockCore = 0 ,
  kDtAesRegBlockCount = 1
}
 List of register blocks. More...
 
enum  dt_aes_alert {
  kDtAesAlertRecovCtrlUpdateErr = 0 ,
  kDtAesAlertFatalFault = 1 ,
  kDtAesAlertCount = 2
}
 List of Alerts. More...
 
enum  dt_aes_clock {
  kDtAesClockClk = 0 ,
  kDtAesClockEdn = 1 ,
  kDtAesClockCount = 2
}
 List of clock ports. More...
 
enum  dt_aes_reset {
  kDtAesResetRst = 0 ,
  kDtAesResetEdn = 1 ,
  kDtAesResetCount = 2
}
 List of reset ports. More...
 

Functions

dt_aes_t dt_aes_from_instance_id (dt_instance_id_t inst_id)
 Get the aes instance from an instance ID.
 
dt_instance_id_t dt_aes_instance_id (dt_aes_t dt)
 Get the instance ID of an instance.
 
uint32_t dt_aes_reg_block (dt_aes_t dt, dt_aes_reg_block_t reg_block)
 Get the register base address of an instance.
 
dt_alert_id_t dt_aes_alert_to_alert_id (dt_aes_t dt, dt_aes_alert_t alert)
 Get the alert ID of a aes alert for a given instance.
 
dt_aes_alert_t dt_aes_alert_from_alert_id (dt_aes_t dt, dt_alert_id_t alert)
 Convert a global alert ID to a local aes alert type.
 
dt_clock_t dt_aes_clock (dt_aes_t dt, dt_aes_clock_t clk)
 Get the clock signal connected to a clock port of an instance.
 
dt_reset_t dt_aes_reset (dt_aes_t dt, dt_aes_reset_t rst)
 Get the reset signal connected to a reset port of an instance.
 

Detailed Description

Device Tables (DT) for IP aes and top earlgrey.

This file contains the type definitions and global functions of the aes.

Definition in file dt_aes.h.

Macro Definition Documentation

◆ OPENTITAN_AES_HAS_CLEAR_DATA_OUT

#define OPENTITAN_AES_HAS_CLEAR_DATA_OUT   1

Definition at line 98 of file dt_aes.h.

◆ OPENTITAN_AES_HAS_CLEAR_KEY_IV_DATA_IN

#define OPENTITAN_AES_HAS_CLEAR_KEY_IV_DATA_IN   1

Definition at line 99 of file dt_aes.h.

◆ OPENTITAN_AES_HAS_KEY_LEN_128

#define OPENTITAN_AES_HAS_KEY_LEN_128   1

List of supported hardware features.

Definition at line 89 of file dt_aes.h.

◆ OPENTITAN_AES_HAS_KEY_LEN_192

#define OPENTITAN_AES_HAS_KEY_LEN_192   1

Definition at line 90 of file dt_aes.h.

◆ OPENTITAN_AES_HAS_KEY_LEN_256

#define OPENTITAN_AES_HAS_KEY_LEN_256   1

Definition at line 91 of file dt_aes.h.

◆ OPENTITAN_AES_HAS_KEY_SIDELOAD

#define OPENTITAN_AES_HAS_KEY_SIDELOAD   1

Definition at line 97 of file dt_aes.h.

◆ OPENTITAN_AES_HAS_MANUAL_OPERATION

#define OPENTITAN_AES_HAS_MANUAL_OPERATION   1

Definition at line 103 of file dt_aes.h.

◆ OPENTITAN_AES_HAS_MODE_CBC

#define OPENTITAN_AES_HAS_MODE_CBC   1

Definition at line 93 of file dt_aes.h.

◆ OPENTITAN_AES_HAS_MODE_CFB_128

#define OPENTITAN_AES_HAS_MODE_CFB_128   1

Definition at line 94 of file dt_aes.h.

◆ OPENTITAN_AES_HAS_MODE_CTR

#define OPENTITAN_AES_HAS_MODE_CTR   1

Definition at line 96 of file dt_aes.h.

◆ OPENTITAN_AES_HAS_MODE_ECB

#define OPENTITAN_AES_HAS_MODE_ECB   1

Definition at line 92 of file dt_aes.h.

◆ OPENTITAN_AES_HAS_MODE_OFB

#define OPENTITAN_AES_HAS_MODE_OFB   1

Definition at line 95 of file dt_aes.h.

◆ OPENTITAN_AES_HAS_PRNG_FORCE_MASKS

#define OPENTITAN_AES_HAS_PRNG_FORCE_MASKS   1

Definition at line 102 of file dt_aes.h.

◆ OPENTITAN_AES_HAS_PRNG_KEY_TOUCH_FORCES_RESEED

#define OPENTITAN_AES_HAS_PRNG_KEY_TOUCH_FORCES_RESEED   1

Definition at line 101 of file dt_aes.h.

◆ OPENTITAN_AES_HAS_PRNG_RESEED_RATE

#define OPENTITAN_AES_HAS_PRNG_RESEED_RATE   1

Definition at line 100 of file dt_aes.h.

Typedef Documentation

◆ dt_aes_alert_t

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

◆ dt_aes_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

◆ dt_aes_reg_block_t

List of register blocks.

Register blocks are guaranteed to start at 0 and to be consecutively numbered.

◆ dt_aes_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

◆ dt_aes

enum dt_aes

List of instances.

Enumerator
kDtAes 

aes

Definition at line 23 of file dt_aes.h.

◆ dt_aes_alert

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

Enumerator
kDtAesAlertRecovCtrlUpdateErr 

This recoverable alert is triggered upon detecting an update error in the shadowed Control Register.

The content of the Control Register is not modified (See Control Register). The AES unit can be recovered from such a condition by restarting the AES operation, i.e., by re-writing the Control Register. This should be monitored by the system.

kDtAesAlertFatalFault 

This fatal alert is triggered upon detecting a fatal fault inside the AES unit.

Examples for such faults include i) storage errors in the shadowed Control Register, ii) any internal FSM entering an invalid state, iii) any sparsely encoded signal taking on an invalid value, iv) errors in the internal round counter, v) escalations triggered by the life cycle controller, and vi) fatal integrity failures on the TL-UL bus. The AES unit cannot recover from such an error and needs to be reset.

Definition at line 47 of file dt_aes.h.

◆ dt_aes_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtAesClockClk 

Clock port clk_i.

kDtAesClockEdn 

Clock port clk_edn_i.

Definition at line 69 of file dt_aes.h.

◆ dt_aes_reg_block

List of register blocks.

Register blocks are guaranteed to start at 0 and to be consecutively numbered.

Definition at line 34 of file dt_aes.h.

◆ dt_aes_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtAesResetRst 

Reset port rst_ni.

kDtAesResetEdn 

Reset port rst_edn_ni.

Definition at line 80 of file dt_aes.h.

Function Documentation

◆ dt_aes_alert_from_alert_id()

dt_aes_alert_t dt_aes_alert_from_alert_id ( dt_aes_t dt,
dt_alert_id_t alert )

Convert a global alert ID to a local aes alert type.

Parameters
dtInstance of aes.
alertA global alert ID that belongs to this instance.
Returns
The aes alert, or kDtAesAlertCount.

Note: This function assumes that the global alert ID belongs to the instance of aes passed in parameter. In other words, it must be the case that dt_aes_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtAesAlertCount.

Definition at line 86 of file dt_aes.c.

◆ dt_aes_alert_to_alert_id()

dt_alert_id_t dt_aes_alert_to_alert_id ( dt_aes_t dt,
dt_aes_alert_t alert )

Get the alert ID of a aes 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.

Parameters
dtInstance of aes.
alertA aes alert.
Returns
The Alert Handler alert ID of the alert of this instance.

Definition at line 80 of file dt_aes.c.

◆ dt_aes_clock()

Get the clock signal connected to a clock port of an instance.

Parameters
dtInstance of aes.
clkClock port.
Returns
Clock signal.

Definition at line 98 of file dt_aes.c.

◆ dt_aes_from_instance_id()

dt_aes_t dt_aes_from_instance_id ( dt_instance_id_t inst_id)

Get the aes instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters
inst_idInstance ID.
Returns
A aes instance.

Note: This function only makes sense if the instance ID has device type aes, otherwise the returned value is unspecified.

Definition at line 60 of file dt_aes.c.

◆ dt_aes_instance_id()

dt_instance_id_t dt_aes_instance_id ( dt_aes_t dt)

Get the instance ID of an instance.

Parameters
dtInstance of aes.
Returns
The instance ID of that instance.

Definition at line 67 of file dt_aes.c.

◆ dt_aes_reg_block()

uint32_t dt_aes_reg_block ( dt_aes_t dt,
dt_aes_reg_block_t reg_block )

Get the register base address of an instance.

Parameters
dtInstance of aes.
reg_blockThe register block requested.
Returns
The register base address of the requested block.

Definition at line 72 of file dt_aes.c.

◆ dt_aes_reset()

Get the reset signal connected to a reset port of an instance.

Parameters
dtInstance of aes.
rstReset port.
Returns
Reset signal.

Definition at line 105 of file dt_aes.c.