dt_spi_host.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_SPI_HOST_H_
#define OPENTITAN_DT_SPI_HOST_H_
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
/**
 * @file
 * @brief Device Tables (DT) for IP spi_host and top darjeeling.
 *
 * This file contains the type definitions and global functions of the spi_host.
 */
 
#include "dt_api.h"
#include <stdint.h>
 
 
 
/**
 * List of instances.
 */
typedef enum dt_spi_host {
  kDtSpiHost0 = 0, /**< spi_host0 */
  kDtSpiHostFirst = 0, /**< \internal First instance */
  kDtSpiHostCount = 1, /**< \internal Number of instances */
} dt_spi_host_t;
 
/**
 * List of register blocks.
 *
 * Register blocks are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_spi_host_reg_block {
  kDtSpiHostRegBlockCore = 0, /**<  */
  kDtSpiHostRegBlockCount = 1, /**< \internal Number of register blocks */
} dt_spi_host_reg_block_t;
 
/** Primary register block (associated with the "primary" set of registers that control the IP). */
static const dt_spi_host_reg_block_t kDtSpiHostRegBlockPrimary = kDtSpiHostRegBlockCore;
 
/**
 * List of IRQs.
 *
 * IRQs are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_spi_host_irq {
  kDtSpiHostIrqError = 0, /**< Error-related interrupts, see !!ERROR_ENABLE register for more
   information. */
  kDtSpiHostIrqSpiEvent = 1, /**< Event-related interrupts, see !!EVENT_ENABLE register for more
   information. */
  kDtSpiHostIrqCount = 2, /**< \internal Number of IRQs */
} dt_spi_host_irq_t;
 
/**
 * List of Alerts.
 *
 * Alerts are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_spi_host_alert {
  kDtSpiHostAlertFatalFault = 0, /**< This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected. */
  kDtSpiHostAlertCount = 1, /**< \internal Number of Alerts */
} dt_spi_host_alert_t;
 
/**
 * List of clock ports.
 *
 * Clock ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_spi_host_clock {
  kDtSpiHostClockClk = 0, /**< Clock port clk_i */
  kDtSpiHostClockCount = 1, /**< \internal Number of clock ports */
} dt_spi_host_clock_t;
 
/**
 * List of reset ports.
 *
 * Reset ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_spi_host_reset {
  kDtSpiHostResetRst = 0, /**< Reset port rst_ni */
  kDtSpiHostResetCount = 1, /**< \internal Number of reset ports */
} dt_spi_host_reset_t;
 
/**
 * List of peripheral I/O.
 *
 * Peripheral I/O are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_spi_host_periph_io {
  kDtSpiHostPeriphIoSck = 0, /**<  */
  kDtSpiHostPeriphIoCsb = 1, /**<  */
  kDtSpiHostPeriphIoSd0 = 2, /**<  */
  kDtSpiHostPeriphIoSd1 = 3, /**<  */
  kDtSpiHostPeriphIoSd2 = 4, /**<  */
  kDtSpiHostPeriphIoSd3 = 5, /**<  */
  kDtSpiHostPeriphIoCount = 6, /**< \internal Number of peripheral I/O */
} dt_spi_host_periph_io_t;
 
/**
 * List of supported hardware features.
 */
#define OPENTITAN_SPI_HOST_HAS_USECASE_SERIALNORFLASH 1
#define OPENTITAN_SPI_HOST_HAS_USECASE_PASSTHROUGH 1
#define OPENTITAN_SPI_HOST_HAS_RATE_STANDARD 1
#define OPENTITAN_SPI_HOST_HAS_RATE_DUAL 1
#define OPENTITAN_SPI_HOST_HAS_RATE_QUAD 1
#define OPENTITAN_SPI_HOST_HAS_CONFIG_CPOL 1
#define OPENTITAN_SPI_HOST_HAS_CONFIG_CLOCKDIV 1
#define OPENTITAN_SPI_HOST_HAS_EVENT_WATERMARK 1
#define OPENTITAN_SPI_HOST_HAS_EVENT_FULL 1
#define OPENTITAN_SPI_HOST_HAS_EVENT_EMPTY 1
 
 
 
/**
 * Get the spi_host instance from an instance ID
 *
 * For example, `dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3`.
 *
 * @param inst_id Instance ID.
 * @return A spi_host instance.
 *
 * **Note:** This function only makes sense if the instance ID has device type spi_host,
 * otherwise the returned value is unspecified.
 */
dt_spi_host_t dt_spi_host_from_instance_id(dt_instance_id_t inst_id);
 
/**
 * Get the instance ID of an instance.
 *
 * @param dt Instance of spi_host.
 * @return The instance ID of that instance.
 */
dt_instance_id_t dt_spi_host_instance_id(dt_spi_host_t dt);
 
/**
 * Get the register base address of an instance.
 *
 * @param dt Instance of spi_host.
 * @param reg_block The register block requested.
 * @return The register base address of the requested block.
 */
uint32_t dt_spi_host_reg_block(
    dt_spi_host_t dt,
    dt_spi_host_reg_block_t reg_block);
 
/**
 * Get the primary register base address of an instance.
 *
 * This is just a convenience function, equivalent to
 * `dt_spi_host_reg_block(dt, kDtSpiHostRegBlockCore)`
 *
 * @param dt Instance of spi_host.
 * @return The register base address of the primary register block.
 */
static inline uint32_t dt_spi_host_primary_reg_block(
    dt_spi_host_t dt) {
  return dt_spi_host_reg_block(dt, kDtSpiHostRegBlockCore);
}
 
/**
 * Get the PLIC ID of a spi_host IRQ for a given instance.
 *
 * If the instance is not connected to the PLIC, this function
 * will return `kDtPlicIrqIdNone`.
 *
 * @param dt Instance of spi_host.
 * @param irq A spi_host IRQ.
 * @return The PLIC ID of the IRQ of this instance.
 */
dt_plic_irq_id_t dt_spi_host_irq_to_plic_id(
    dt_spi_host_t dt,
    dt_spi_host_irq_t irq);
 
/**
 * Convert a global IRQ ID to a local spi_host IRQ type.
 *
 * @param dt Instance of spi_host.
 * @param irq A PLIC ID that belongs to this instance.
 * @return The spi_host IRQ, or `kDtSpiHostIrqCount`.
 *
 * **Note:** This function assumes that the PLIC ID belongs to the instance
 * of spi_host passed in parameter. In other words, it must be the case that
 * `dt_spi_host_instance_id(dt) == dt_plic_id_to_instance_id(irq)`. Otherwise, this function
 * will return `kDtSpiHostIrqCount`.
 */
dt_spi_host_irq_t dt_spi_host_irq_from_plic_id(
    dt_spi_host_t dt,
    dt_plic_irq_id_t irq);
 
 
/**
 * Get the alert ID of a spi_host 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 spi_host.
 * @param alert A spi_host alert.
 * @return The Alert Handler alert ID of the alert of this instance.
 */
dt_alert_id_t dt_spi_host_alert_to_alert_id(
    dt_spi_host_t dt,
    dt_spi_host_alert_t alert);
 
/**
 * Convert a global alert ID to a local spi_host alert type.
 *
 * @param dt Instance of spi_host.
 * @param alert A global alert ID that belongs to this instance.
 * @return The spi_host alert, or `kDtSpiHostAlertCount`.
 *
 * **Note:** This function assumes that the global alert ID belongs to the
 * instance of spi_host passed in parameter. In other words, it must be the case
 * that `dt_spi_host_instance_id(dt) == dt_alert_id_to_instance_id(alert)`. Otherwise,
 * this function will return `kDtSpiHostAlertCount`.
 */
dt_spi_host_alert_t dt_spi_host_alert_from_alert_id(
    dt_spi_host_t dt,
    dt_alert_id_t alert);
 
 
/**
 * Get the peripheral I/O description of an instance.
 *
 * @param dt Instance of spi_host.
 * @param sig Requested peripheral I/O.
 * @return Description of the requested peripheral I/O for this instance.
 */
dt_periph_io_t dt_spi_host_periph_io(
    dt_spi_host_t dt,
    dt_spi_host_periph_io_t sig);
 
/**
 * Get the clock signal connected to a clock port of an instance.
 *
 * @param dt Instance of spi_host.
 * @param clk Clock port.
 * @return Clock signal.
 */
dt_clock_t dt_spi_host_clock(
    dt_spi_host_t dt,
    dt_spi_host_clock_t clk);
 
/**
 * Get the reset signal connected to a reset port of an instance.
 *
 * @param dt Instance of spi_host.
 * @param rst Reset port.
 * @return Reset signal.
 */
dt_reset_t dt_spi_host_reset(
    dt_spi_host_t dt,
    dt_spi_host_reset_t rst);
 
 
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  // OPENTITAN_DT_SPI_HOST_H_