Software APIs
Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12]
 Cac_range_check_isr_ctxA handle to a ac_range_check ISR context struct
 Cadc_ctrl_isr_ctxA handle to a adc_ctrl ISR context struct
 Calert_handler_isr_ctxA handle to a alert_handler ISR context struct
 Calert_info_testutils_infoRepresents the hardware alert crash dump in a more software-friendly manner
 Caon_timer_isr_ctxA handle to a aon_timer ISR context struct
 Cbase_hexdump_fmtConfiguration options for base_hexdump and friends
 Cmock_mmio::BitFieldRepresents a single bit field in an integer, useable with EXPECT_* macros defined in this file
 Cbitfield_field32A field of a 32-bit bitfield
 Cboot_dataBoot data stored in the flash info partition
 Cboot_logThe boot_log encodes information about how the chip booted
 Cboot_svc_emptyAn empty boot services message
 Cboot_svc_headerBoot services message header
 Cboot_svc_min_bl0_sec_ver_reqA Set Minimum Security Version request
 Cboot_svc_min_bl0_sec_ver_resA Set Minimum Security Version response
 Cboot_svc_msgA Boot Services message
 Cboot_svc_next_boot_bl0_slot_reqA Next Boot BL0 Slot request message
 Cboot_svc_next_boot_bl0_slot_resA Next Boot BL0 Slot response message
 Cboot_svc_ownership_activate_reqAn Ownership Activate request
 Cboot_svc_ownership_activate_resAn Ownership Activate response
 Cboot_svc_ownership_unlock_reqAn ownership unlock request
 Cboot_svc_ownership_unlock_resAn ownership unlock response
 Cbuffer_sinkA buffer_sink_t represents a place to write bytes to, implemented as a C-style "closure"
 Cchip_info
 Cchip_info_scm_revisionA truncated commit hash from the open-source OpenTitan repo that can be used to reproduce the ROM binary
 Ccsrng_app_cmdCSRNG application interface command header parameters
 Ccsrng_isr_ctxA handle to a csrng ISR context struct
 Cdif_ac_range_checkA handle to ac_range_check
 Cdif_adc_ctrlA handle to adc_ctrl
 Cdif_adc_ctrl_configRuntime configuration for an ADC Controller
 Cdif_adc_ctrl_filter_configRuntime configuration for an ADC Controller filter
 Cdif_aesA handle to aes
 Cdif_aes_dataA typed representation of the AES data
 Cdif_aes_ivA typed representation of the AES Initialisation Vector (IV)
 Cdif_aes_key_shareA typed representation of the AES key share
 Cdif_aes_transactionParameters for an AES transaction
 Cdif_alert_handlerA handle to alert_handler
 Cdif_alert_handler_class_configRuntime configuration for a particular alert class
 Cdif_alert_handler_configRuntime configuration for the alert handler
 Cdif_alert_handler_escalation_phaseRuntime configuration for an escalation phase
 Cdif_aon_timerA handle to aon_timer
 Cdif_astA handle to ast
 Cdif_clkmgrA handle to clkmgr
 Cdif_csrngA handle to csrng
 Cdif_csrng_cmd_statusThe status of the CSRNG block at a particular moment in time
 Cdif_csrng_internal_stateCSRNG internal state
 Cdif_csrng_output_statusGenerated output state
 Cdif_csrng_seed_materialCSRNG common transaction parameters
 Cdif_dmaA handle to dma
 Cdif_dma_address_configAddressing configuration
 Cdif_dma_transactionParameters for a DMA Controller transaction
 Cdif_dma_transaction_addressDefine the transaction address space
 Cdif_ednA handle to edn
 Cdif_edn_auto_paramsAuto-generate EDN module configuration parameters
 Cdif_edn_cmdCSRNG command parameters for instantiate, reseed and generate commands
 Cdif_edn_seed_materialCSRNG seed material for instantiate, reseed and generate commands
 Cdif_entropy_srcA handle to entropy_src
 Cdif_entropy_src_alert_fail_countsStatistics on entropy source health tests failures that triggered alerts
 Cdif_entropy_src_configRuntime configuration for an entropy source
 Cdif_entropy_src_debug_stateDebug status information
 Cdif_entropy_src_fw_override_configFirmware override parameters for an entropy source
 Cdif_entropy_src_health_test_configCriteria used by various entropy source health tests to decide whether the test has failed
 Cdif_entropy_src_health_test_statsStatistics on entropy source health tests
 Cdif_entropy_src_revisionRevision information for an entropy source
 Cdif_flash_ctrlA handle to flash_ctrl
 Cdif_flash_ctrl_data_region_propertiesA composite of a data region and its memory properties
 Cdif_flash_ctrl_device_info
 Cdif_flash_ctrl_ecc_errors
 Cdif_flash_ctrl_errorRepresents recoverable errors and synchronous errors caused by software
 Cdif_flash_ctrl_error_codes
 Cdif_flash_ctrl_faults
 Cdif_flash_ctrl_info_regionRepresentation of the memory protection regions for the info pages
 Cdif_flash_ctrl_output
 Cdif_flash_ctrl_phy_status
 Cdif_flash_ctrl_prog_capabilitiesRepresents programming capabilities of the flash controller
 Cdif_flash_ctrl_region_propertiesMemory protection configuration options
 Cdif_flash_ctrl_stateCarries state for a flash controller device
 Cdif_flash_ctrl_statusStatus bits that can be queried
 Cdif_flash_ctrl_transaction
 Cdif_gpioA handle to gpio
 Cdif_hmacA handle to hmac
 Cdif_hmac_digestA typed representation of the HMAC digest
 Cdif_hmac_transactionConfiguration for a single HMAC Transaction
 Cdif_i2cA handle to i2c
 Cdif_i2c_configRuntime configuration for I2C
 Cdif_i2c_controller_halt_events
 Cdif_i2c_fmt_flagsFlags for a formatted I2C byte, used by the dif_i2c_write_byte_raw() function
 Cdif_i2c_idConfiguration for the addressing behavior of the I2C, can be disabled or configured to look for multiple addresses by masking certain bits
 Cdif_i2c_statusFlags representing the status of an I2C block
 Cdif_i2c_target_tx_halt_events
 Cdif_i2c_timing_configTiming configuration parameters for I2C
 Cdif_keymgrA handle to keymgr
 Cdif_keymgr_binding_valueAttestation and sealing binding value
 Cdif_keymgr_configRuntime configuration for key manager
 Cdif_keymgr_dpeA handle to keymgr_dpe
 Cdif_keymgr_dpe_advance_paramsInput parameters for advancing a DPE context/slot
 Cdif_keymgr_dpe_erase_paramsInput parameters for erasing a DPE context/slot
 Cdif_keymgr_dpe_generate_paramsInput parameters for advancing a DPE context/slot
 Cdif_keymgr_dpe_outputUseed to represent the output of SW generated key
 Cdif_keymgr_identity_seed_paramsParameters for generating an identity seed
 Cdif_keymgr_max_key_version
 Cdif_keymgr_outputOutput of a key manager operation
 Cdif_keymgr_state_paramsParameters for a key manager state
 Cdif_keymgr_versioned_key_paramsParameters for generating a versioned key
 Cdif_kmacA handle to kmac
 Cdif_kmac_configRuntime configuration for KMAC
 Cdif_kmac_customization_stringAn encoded bit string used for customization string (S)
 Cdif_kmac_function_nameAn encoded bit string used for function name (N)
 Cdif_kmac_keyA key for KMAC operations
 Cdif_kmac_operation_stateA KMAC operation state context
 Cdif_kmac_status
 Cdif_lc_ctrlA handle to lc_ctrl
 Cdif_lc_ctrl_device_idA 256-bit device id stored in OTP's hw_cfg0 partition
 Cdif_lc_ctrl_hw_rev_tA 32-bit hardware revision number
 Cdif_lc_ctrl_tokenA 128-bit unlock token used for certain kinds of lifecycle transitions
 Cdif_mbxA handle to mbx
 Cdif_mbx_range_configInbound and outbound range for DOE Mailbox
 Cdif_mbx_transactionDOE object transferred on the inbound or outbound mailbox
 Cdif_otbnA handle to otbn
 Cdif_otp_ctrlA handle to otp_ctrl
 Cdif_otp_ctrl_configRuntime configuration for OTP
 Cdif_otp_ctrl_statusThe overall status of the OTP controller
 Cdif_otp_macroA handle to otp_macro
 Cdif_pattgenA handle to pattgen
 Cdif_pattgen_channel_configRuntime configuration for a Pattern Generator channel
 Cdif_pinmuxA handle to pinmux
 Cdif_pinmux_pad_attrPin multiplexer padring pad attributes
 Cdif_pinmux_wakeup_configA Pin Multiplexer common wake-up configuration between different modes
 Cdif_pwmA handle to pwm
 Cdif_pwm_channel_configRuntime configuration for a specific PWM channel
 Cdif_pwm_configRuntime configuration for PWM
 Cdif_pwrmgrA handle to pwrmgr
 Cdif_pwrmgr_wakeup_reasonWakeup types and requests from sources since the last time recording started
 Cdif_racl_ctrlA handle to racl_ctrl
 Cdif_rom_ctrlA handle to rom_ctrl
 Cdif_rom_ctrl_digestA typed representation of the ROM digest
 Cdif_rstmgrA handle to rstmgr
 Cdif_rv_core_ibexA handle to rv_core_ibex
 Cdif_rv_core_ibex_addr_translation_mappingAddress translation matching region
 Cdif_rv_core_ibex_crash_dump_infoUnder normal circumstances, only the current crash dump state is valid
 Cdif_rv_core_ibex_crash_dump_state
 Cdif_rv_core_ibex_nmi_stateNMI enabled status and current state
 Cdif_rv_core_ibex_previous_crash_dump_state
 Cdif_rv_dmA handle to rv_dm
 Cdif_rv_plicA handle to rv_plic
 Cdif_rv_timerA handle to rv_timer
 Cdif_rv_timer_tick_paramsRepresents timekeeping parameters for a particular timer
 Cdif_sensor_ctrlA handle to sensor_ctrl
 Cdif_soc_dbg_ctrlA handle to soc_dbg_ctrl
 Cdif_soc_proxyA handle to soc_proxy
 Cdif_spi_deviceA handle to spi_device
 Cdif_spi_device_buffer_info
 Cdif_spi_device_configRuntime configuration for SPI
 Cdif_spi_device_flash_command
 Cdif_spi_device_flash_id
 Cdif_spi_device_handleStruct containing the relevant run-time information for the DIF
 Cdif_spi_device_passthrough_intercept_configRepresents which optional hardware features may intercept commands in passthrough mode
 Cdif_spi_device_tpm_caps
 Cdif_spi_device_tpm_config
 Cdif_spi_device_tpm_data_status
 Cdif_spi_device_tpm_id
 Cdif_spi_hostA handle to spi_host
 Cdif_spi_host_configRuntime configuration for SPI Host
 Cdif_spi_host_config.chip_select
 Cdif_spi_host_segmentSegment descriptor for each segment in a transaction
 Cdif_spi_host_segment.__unnamed0__
 Cdif_spi_host_segment.__unnamed0__.address
 Cdif_spi_host_segment.__unnamed0__.bidir
 Cdif_spi_host_segment.__unnamed0__.dummy
 Cdif_spi_host_segment.__unnamed0__.opcode
 Cdif_spi_host_segment.__unnamed0__.rx
 Cdif_spi_host_segment.__unnamed0__.tx
 Cdif_spi_host_status
 Cdif_sram_ctrlA handle to sram_ctrl
 Cdif_sysrst_ctrlA handle to sysrst_ctrl
 Cdif_sysrst_ctrl_auto_override_configRuntime configuration for the System Reset Controller key signal auto-override feature
 Cdif_sysrst_ctrl_input_change_configRuntime configuration for the System Reset Controller input signal change detection feature
 Cdif_sysrst_ctrl_key_combo_configRuntime configuration for the System Reset Controller key combination detection feature
 Cdif_sysrst_ctrl_pin_config_tRuntime configuration for the System Reset Controller output pin override feature
 Cdif_sysrst_ctrl_ulp_wakeup_config_tRuntime configuration for the System Reset Controller ultra-low-power (ULP) wakeup feature
 Cdif_uartA handle to uart
 Cdif_uart_configRuntime configuration for UART
 Cdif_usbdevA handle to usbdev
 Cdif_usbdev_bufferA USB device buffer
 Cdif_usbdev_buffer_poolFree buffer pool
 Cdif_usbdev_configConfiguration for initializing a USB device
 Cdif_usbdev_endpoint_id
 Cdif_usbdev_phy_pins_drive
 Cdif_usbdev_phy_pins_sense
 Cdif_usbdev_rx_packet_infoInformation about a received packet
 Cdif_usbdev_wake_status
 Cdma_isr_ctxA handle to a dma ISR context struct
 Cdt_desc_ac_range_checkDescription of instances
 Cdt_desc_adc_ctrlDescription of instances
 Cdt_desc_aesDescription of instances
 Cdt_desc_alert_handlerDescription of instances
 Cdt_desc_aon_timerDescription of instances
 Cdt_desc_astDescription of instances
 Cdt_desc_clkmgrDescription of instances
 Cdt_desc_clkmgr.ext
 Cdt_desc_csrngDescription of instances
 Cdt_desc_dmaDescription of instances
 Cdt_desc_ednDescription of instances
 Cdt_desc_entropy_srcDescription of instances
 Cdt_desc_flash_ctrlDescription of instances
 Cdt_desc_gpioDescription of instances
 Cdt_desc_hmacDescription of instances
 Cdt_desc_i2cDescription of instances
 Cdt_desc_keymgrDescription of instances
 Cdt_desc_keymgr_dpeDescription of instances
 Cdt_desc_kmacDescription of instances
 Cdt_desc_lc_ctrlDescription of instances
 Cdt_desc_mbxDescription of instances
 Cdt_desc_otbnDescription of instances
 Cdt_desc_otp_ctrlDescription of instances
 Cdt_desc_otp_macroDescription of instances
 Cdt_desc_pattgenDescription of instances
 Cdt_desc_pinmuxDescription of instances
 Cdt_desc_pwmDescription of instances
 Cdt_desc_pwrmgrDescription of instances
 Cdt_desc_pwrmgr.ext
 Cdt_desc_racl_ctrlDescription of instances
 Cdt_desc_rom_ctrlDescription of instances
 Cdt_desc_rstmgrDescription of instances
 Cdt_desc_rstmgr.ext
 Cdt_desc_rv_core_ibexDescription of instances
 Cdt_desc_rv_dmDescription of instances
 Cdt_desc_rv_plicDescription of instances
 Cdt_desc_rv_timerDescription of instances
 Cdt_desc_sensor_ctrlDescription of instances
 Cdt_desc_soc_dbg_ctrlDescription of instances
 Cdt_desc_soc_proxyDescription of instances
 Cdt_desc_spi_deviceDescription of instances
 Cdt_desc_spi_hostDescription of instances
 Cdt_desc_sram_ctrlDescription of instances
 Cdt_desc_sysrst_ctrlDescription of instances
 Cdt_desc_uartDescription of instances
 Cdt_desc_usbdevDescription of instances
 Cdt_pad_descPad description
 Cdt_periph_ioPeripheral I/O description
 Cdt_periph_io.__internal
 Cdt_pwrmgr_reset_req_srcDescription of a reset request source
 Cdt_pwrmgr_wakeup_srcDescription of a wakeup source
 Cdt_rstmgr_reset_req_srcDescription of a reset request source
 Cecdsa_p256_public_keyHolds an attestation public key (ECDSA-P256)
 Cecdsa_p256_signatureHolds an attestation signature (ECDSA-P256)
 Cedn_isr_ctxA handle to a edn ISR context struct
 Cendpoint_hw_infoHardware information for endpoints
 Centropy_src_isr_ctxA handle to a entropy_src ISR context struct
 Cexpected_count_info
 Cflash_ctrl_isr_ctxA handle to a flash_ctrl ISR context struct
 Cformat_specifierRepresents a parsed format specifier
 Cglobal_mock::GlobalMock< Mock >Base class for mocks used in unit tests
 Cglobal_mock::GlobalMock< MockAbsMmio >
 Crom_test::internal::MockAbsMmioMock class for abs_mmio.c
 Cglobal_mock::GlobalMock< MockCrc32 >
 Crom_test::internal::MockCrc32Mock class for crc32
 Cglobal_mock::GlobalMock< MockCsr >
 Cmock_csr::internal::MockCsr
 Cglobal_mock::GlobalMock< MockSecMmio >
 Crom_test::internal::MockSecMmioMock class for abs_mmio.c
 Cgpio_isr_ctxA handle to a gpio ISR context struct
 Chmac_contextStored SHA256 operation state
 Chmac_digestA typed representation of the HMAC digest
 Chmac_isr_ctxA handle to a hmac ISR context struct
 Chybrid_key
 Ci2c_isr_ctxA handle to a i2c ISR context struct
 Ci2c_pinmux_pinsDefine an i2c pinmux configuration
 Ci2c_platform_pinsDefine an i2c pinmux configuration
 Cibex_addr_translation_regsError code constants of dif_rv_core_ibex_error_status_t are masks for the bits of RV_CORE_IBEX_ERR_STATUS_REG register
 Cibex_timeoutA spinwait timeout type
 Ckeymgr_dpe_isr_ctxA handle to a keymgr_dpe ISR context struct
 Ckeymgr_isr_ctxA handle to a keymgr ISR context struct
 Ckeymgr_testutils_secretStruct to hold the creator or owner secrets for the key manager
 Ckmac_isr_ctxA handle to a kmac ISR context struct
 Clifecycle_device_id256-bit device identifier that is stored in the HW_CFG0 partition in OTP
 Clifecycle_hw_revHardware revision
 Cmock_mmio::LittleEndianBytesImplicit conversion guard around char *
 Clog_fieldsRepresents log metadata used to format a log line
 Cmock_mmio::MaskedBitFieldRepresents a single bit field in an integer, similar to BitField
 Cmax_key_version_reg_infoMax key version register information for a state transition
 Cmbx_isr_ctxA handle to a mbx ISR context struct
 Cmmio_region"Instrumented" mmio_region_t
 Cmock_mmio::MmioTestConveninence fixture for creating device tests
 Cmock_mmio::MockDeviceA MockDevice represents a mock implementation of an MMIO device
 CnonceA nonce value used for challenge/response in boot services message
 Cot_status_create_record
 Cotbn_appInformation about an embedded OTBN application image
 Cotbn_isr_ctxA handle to a otbn ISR context struct
 Cotp_ctrl_isr_ctxA handle to a otp_ctrl ISR context struct
 COtSignConversionUnsupportedType
 Cowner_application_keyThe owner application key encodes keys for verifying the owner's application firmware
 Cowner_application_key.__unnamed0__
 Cowner_application_key.__unnamed0__.__unnamed0__
 Cowner_application_key.dataKey material
 Cowner_blockThe owner configuration block describes an owner identity and configuration
 Cowner_flash_configThe owner flash config is a collection of owner region configuration items
 Cowner_flash_info_config
 Cowner_flash_regionThe owner flash region describes a region of flash and its configuration properties (ie: ECC, Scrambling, High Endurance, etc)
 Cowner_info_pageThe owner info page describes an INFO page in flash and its configuration properties (ie: ECC, Scrambling, High Endurance, etc)
 Cowner_keyAn owner_key can be either a ECDSA P256 or SPX+ key
 Cowner_rescue_configThe owner rescue configuration describes how the rescue protocol should behave when invoked in the ROM_EXT
 Cowner_signatureAn owner_signature is an ECDSA P256 signature
 Cpartition_info
 Cpattgen_isr_ctxA handle to a pattgen ISR context struct
 Cpinmux_pad_attributesA convenience struct to associate pad attributes with a specific pad
 Cpinmux_testutils_mio_pinDefine a pinmux configuration for a mio input and output
 Cpinmux_testutils_peripheral_pinDefine a pinmux configuration for a peripheral input and output
 Cplic_isr_ctxA handle to a PLIC ISR context struct
 Cplic_reg_infoPLIC register info
 Cpwrmgr_isr_ctxA handle to a pwrmgr ISR context struct
 Cqueue
 Cracl_ctrl_isr_ctxA handle to a racl_ctrl ISR context struct
 Crand_testutils_rngA random number generator testutil type
 Crandom_orderContext for a random traversal order
 Crequest_reg_infodif_pwrmgr_irq_t constants must match the corresponding generated values
 Cretention_sramThe retention SRAM is memory that is used to retain information, such as a boot service request, across a device reset
 Cretention_sram_creatorRetention SRAM silicon creator area
 Cretention_sram_ownerRetention SRAM silicon owner area
 Crv_timer_isr_ctxA handle to a rv_timer ISR context struct
 Csec_mmio_ctxWorking context
 Csensor_ctrl_isr_ctxA handle to a sensor_ctrl ISR context struct
 Csigverify_rsa_bufferA type that holds kSigVerifyRsaNumWords words
 Csigverify_rsa_keyAn RSA public key with exponent 65537
 Csigverify_spx_keyAn SPX public key
 Csigverify_spx_rootAn SPX root node
 Csigverify_spx_signatureAn SPX signature
 Csnprintf_captures_t
 Csoc_proxy_isr_ctxA handle to a soc_proxy ISR context struct
 Cspi_device_isr_ctxA handle to a spi_device ISR context struct
 Cspi_host_isr_ctxA handle to a spi_host ISR context struct
 Csram_ctrl_testutils_dataA typed representation of the test data
 Cstart_operation_paramsParameters for starting a key manager operation
 CstatusWe use the error category codes from absl_status.h
 Cstruct_version
 Csysrst_ctrl_isr_ctxA handle to a sysrst_ctrl ISR context struct
 CT
 Crom_test::Unordered< T >Mixin for unordered calls
 Ctesting::Test
 Crom_test::RomTestTest fixture for ROM tests
 Ctlv_header
 Cu32x2Helper type for fussing with the upper and lower halves of an i64
 Cu32x2.__unnamed0__
 Cu32x2.__unnamed0__.__unnamed0__
 Cuart_cfg_params
 Cuart_isr_ctxA handle to a uart ISR context struct
 CujsonInput/Output context for ujson
 Cusbdev_isr_ctxA handle to a usbdev ISR context struct