Device Tables (DT) for IP racl_ctrl and top darjeeling. More...

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

Typedefs
typedef enum dt_racl_ctrl	dt_racl_ctrl_t
	List of instances.

typedef enum dt_racl_ctrl_reg_block	dt_racl_ctrl_reg_block_t
	List of register blocks.

typedef enum dt_racl_ctrl_irq	dt_racl_ctrl_irq_t
	List of IRQs.

typedef enum dt_racl_ctrl_alert	dt_racl_ctrl_alert_t
	List of Alerts.

typedef enum dt_racl_ctrl_clock	dt_racl_ctrl_clock_t
	List of clock ports.

typedef enum dt_racl_ctrl_reset	dt_racl_ctrl_reset_t
	List of reset ports.

Enumerations
enum	dt_racl_ctrl { kDtRaclCtrl = 0 , kDtRaclCtrlFirst = 0 , kDtRaclCtrlCount = 1 }
	List of instances. More...

enum	dt_racl_ctrl_reg_block { kDtRaclCtrlRegBlockCore = 0 , kDtRaclCtrlRegBlockCount = 1 }
	List of register blocks. More...

enum	dt_racl_ctrl_irq { kDtRaclCtrlIrqRaclError = 0 , kDtRaclCtrlIrqCount = 1 }
	List of IRQs. More...

enum	dt_racl_ctrl_alert { kDtRaclCtrlAlertFatalFault = 0 , kDtRaclCtrlAlertRecovCtrlUpdateErr = 1 , kDtRaclCtrlAlertCount = 2 }
	List of Alerts. More...

enum	dt_racl_ctrl_clock { kDtRaclCtrlClockClk = 0 , kDtRaclCtrlClockCount = 1 }
	List of clock ports. More...

enum	dt_racl_ctrl_reset { kDtRaclCtrlResetRst = 0 , kDtRaclCtrlResetCount = 1 }
	List of reset ports. More...

Functions
dt_racl_ctrl_t	dt_racl_ctrl_from_instance_id (dt_instance_id_t inst_id)
	Get the racl_ctrl instance from an instance ID.

dt_instance_id_t	dt_racl_ctrl_instance_id (dt_racl_ctrl_t dt)
	Get the instance ID of an instance.

uint32_t	dt_racl_ctrl_reg_block (dt_racl_ctrl_t dt, dt_racl_ctrl_reg_block_t reg_block)
	Get the register base address of an instance.

dt_plic_irq_id_t	dt_racl_ctrl_irq_to_plic_id (dt_racl_ctrl_t dt, dt_racl_ctrl_irq_t irq)
	Get the PLIC ID of a racl_ctrl IRQ for a given instance.

dt_racl_ctrl_irq_t	dt_racl_ctrl_irq_from_plic_id (dt_racl_ctrl_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local racl_ctrl IRQ type.

dt_alert_id_t	dt_racl_ctrl_alert_to_alert_id (dt_racl_ctrl_t dt, dt_racl_ctrl_alert_t alert)
	Get the alert ID of a racl_ctrl alert for a given instance.

dt_racl_ctrl_alert_t	dt_racl_ctrl_alert_from_alert_id (dt_racl_ctrl_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local racl_ctrl alert type.

dt_clock_t	dt_racl_ctrl_clock (dt_racl_ctrl_t dt, dt_racl_ctrl_clock_t clk)
	Get the clock signal connected to a clock port of an instance.

dt_reset_t	dt_racl_ctrl_reset (dt_racl_ctrl_t dt, dt_racl_ctrl_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

Device Tables (DT) for IP racl_ctrl and top darjeeling.

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

Definition in file dt_racl_ctrl.h.

Typedef Documentation

◆ dt_racl_ctrl_alert_t

typedef enum dt_racl_ctrl_alert dt_racl_ctrl_alert_t

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

◆ dt_racl_ctrl_clock_t

typedef enum dt_racl_ctrl_clock dt_racl_ctrl_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

◆ dt_racl_ctrl_irq_t

typedef enum dt_racl_ctrl_irq dt_racl_ctrl_irq_t

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

◆ dt_racl_ctrl_reg_block_t

typedef enum dt_racl_ctrl_reg_block dt_racl_ctrl_reg_block_t

List of register blocks.

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

◆ dt_racl_ctrl_reset_t

typedef enum dt_racl_ctrl_reset dt_racl_ctrl_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

◆ dt_racl_ctrl

enum dt_racl_ctrl

List of instances.

Enumerator
kDtRaclCtrl	racl_ctrl

Definition at line 23 of file dt_racl_ctrl.h.

◆ dt_racl_ctrl_alert

enum dt_racl_ctrl_alert

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

Enumerator
kDtRaclCtrlAlertFatalFault	This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.
kDtRaclCtrlAlertRecovCtrlUpdateErr	This recoverable alert is triggered upon detecting an update error in the shadowed Control Register.

Definition at line 57 of file dt_racl_ctrl.h.

◆ dt_racl_ctrl_clock

enum dt_racl_ctrl_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtRaclCtrlClockClk	Clock port clk_i.

Definition at line 68 of file dt_racl_ctrl.h.

◆ dt_racl_ctrl_irq

enum dt_racl_ctrl_irq

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

Enumerator
kDtRaclCtrlIrqRaclError	RACL error has occurred.

Definition at line 47 of file dt_racl_ctrl.h.

◆ dt_racl_ctrl_reg_block

enum dt_racl_ctrl_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_racl_ctrl.h.

◆ dt_racl_ctrl_reset

enum dt_racl_ctrl_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtRaclCtrlResetRst	Reset port rst_ni.

Definition at line 78 of file dt_racl_ctrl.h.

Function Documentation

◆ dt_racl_ctrl_alert_from_alert_id()

dt_racl_ctrl_alert_t dt_racl_ctrl_alert_from_alert_id	(	dt_racl_ctrl_t	dt,
		dt_alert_id_t	alert )

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

Parameters

dt	Instance of racl_ctrl.
alert	A global alert ID that belongs to this instance.

Returns: The racl_ctrl alert, or kDtRaclCtrlAlertCount.

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

Definition at line 115 of file dt_racl_ctrl.c.

◆ dt_racl_ctrl_alert_to_alert_id()

dt_alert_id_t dt_racl_ctrl_alert_to_alert_id	(	dt_racl_ctrl_t	dt,
		dt_racl_ctrl_alert_t	alert )

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

dt	Instance of racl_ctrl.
alert	A racl_ctrl alert.

Returns: The Alert Handler alert ID of the alert of this instance.

Definition at line 109 of file dt_racl_ctrl.c.

◆ dt_racl_ctrl_clock()

dt_clock_t dt_racl_ctrl_clock	(	dt_racl_ctrl_t	dt,
		dt_racl_ctrl_clock_t	clk )

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

Parameters

dt	Instance of racl_ctrl.
clk	Clock port.

Returns: Clock signal.

Definition at line 127 of file dt_racl_ctrl.c.

◆ dt_racl_ctrl_from_instance_id()

dt_racl_ctrl_t dt_racl_ctrl_from_instance_id ( dt_instance_id_t inst_id )

Get the racl_ctrl instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id Instance ID.

Returns: A racl_ctrl instance.

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

Definition at line 65 of file dt_racl_ctrl.c.

◆ dt_racl_ctrl_instance_id()

dt_instance_id_t dt_racl_ctrl_instance_id ( dt_racl_ctrl_t dt )

Get the instance ID of an instance.

Parameters

dt	Instance of racl_ctrl.

Returns: The instance ID of that instance.

Definition at line 72 of file dt_racl_ctrl.c.

◆ dt_racl_ctrl_irq_from_plic_id()

dt_racl_ctrl_irq_t dt_racl_ctrl_irq_from_plic_id	(	dt_racl_ctrl_t	dt,
		dt_plic_irq_id_t	irq )

Convert a global IRQ ID to a local racl_ctrl IRQ type.

Parameters

dt	Instance of racl_ctrl.
irq	A PLIC ID that belongs to this instance.

Returns: The racl_ctrl IRQ, or kDtRaclCtrlIrqCount.

Note: This function assumes that the PLIC ID belongs to the instance of racl_ctrl passed in parameter. In other words, it must be the case that dt_racl_ctrl_instance_id(dt) == dt_plic_id_to_instance_id(irq). Otherwise, this function will return kDtRaclCtrlIrqCount.

Definition at line 94 of file dt_racl_ctrl.c.

◆ dt_racl_ctrl_irq_to_plic_id()

dt_plic_irq_id_t dt_racl_ctrl_irq_to_plic_id	(	dt_racl_ctrl_t	dt,
		dt_racl_ctrl_irq_t	irq )

Get the PLIC ID of a racl_ctrl IRQ for a given instance.

If the instance is not connected to the PLIC, this function will return kDtPlicIrqIdNone.

Parameters

dt	Instance of racl_ctrl.
irq	A racl_ctrl IRQ.

Returns: The PLIC ID of the IRQ of this instance.

Definition at line 84 of file dt_racl_ctrl.c.

◆ dt_racl_ctrl_reg_block()

uint32_t dt_racl_ctrl_reg_block	(	dt_racl_ctrl_t	dt,
		dt_racl_ctrl_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of racl_ctrl.
reg_block	The register block requested.

Returns: The register base address of the requested block.

Definition at line 77 of file dt_racl_ctrl.c.

◆ dt_racl_ctrl_reset()

dt_reset_t dt_racl_ctrl_reset	(	dt_racl_ctrl_t	dt,
		dt_racl_ctrl_reset_t	rst )

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

Parameters

dt	Instance of racl_ctrl.
rst	Reset port.

Returns: Reset signal.

Definition at line 134 of file dt_racl_ctrl.c.

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ dt_racl_ctrl_alert_t

◆ dt_racl_ctrl_clock_t

◆ dt_racl_ctrl_irq_t

◆ dt_racl_ctrl_reg_block_t

◆ dt_racl_ctrl_reset_t

Enumeration Type Documentation

◆ dt_racl_ctrl

◆ dt_racl_ctrl_alert

◆ dt_racl_ctrl_clock

◆ dt_racl_ctrl_irq

◆ dt_racl_ctrl_reg_block

◆ dt_racl_ctrl_reset

Function Documentation

◆ dt_racl_ctrl_alert_from_alert_id()

◆ dt_racl_ctrl_alert_to_alert_id()

◆ dt_racl_ctrl_clock()

◆ dt_racl_ctrl_from_instance_id()

◆ dt_racl_ctrl_instance_id()

◆ dt_racl_ctrl_irq_from_plic_id()

◆ dt_racl_ctrl_irq_to_plic_id()

◆ dt_racl_ctrl_reg_block()

◆ dt_racl_ctrl_reset()