dt_ac_range_check.h File Reference

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

#include "hw/top/dt/dt_api.h"
#include <stdint.h>

Go to the source code of this file.

Typedefs
typedef enum dt_ac_range_check	dt_ac_range_check_t
	List of instances.
typedef enum dt_ac_range_check_reg_block	dt_ac_range_check_reg_block_t
	List of register blocks.
typedef enum dt_ac_range_check_memory	dt_ac_range_check_memory_t
	List of memories.
typedef enum dt_ac_range_check_irq	dt_ac_range_check_irq_t
	List of IRQs.
typedef enum dt_ac_range_check_alert	dt_ac_range_check_alert_t
	List of Alerts.
typedef enum dt_ac_range_check_clock	dt_ac_range_check_clock_t
	List of clock ports.
typedef enum dt_ac_range_check_reset	dt_ac_range_check_reset_t
	List of reset ports.

Enumerations
enum	dt_ac_range_check {   kDtAcRangeCheck = 0 ,   kDtAcRangeCheckFirst = 0 ,   kDtAcRangeCheckCount = 1 }
	List of instances. More...
enum	dt_ac_range_check_reg_block {   kDtAcRangeCheckRegBlockCore = 0 ,   kDtAcRangeCheckRegBlockCount = 1 }
	List of register blocks. More...
enum	dt_ac_range_check_memory { kDtAcRangeCheckMemoryCount = 0 }
	List of memories. More...
enum	dt_ac_range_check_irq {   kDtAcRangeCheckIrqDenyCntReached = 0 ,   kDtAcRangeCheckIrqCount = 1 }
	List of IRQs. More...
enum	dt_ac_range_check_alert {   kDtAcRangeCheckAlertRecovCtrlUpdateErr = 0 ,   kDtAcRangeCheckAlertFatalFault = 1 ,   kDtAcRangeCheckAlertCount = 2 }
	List of Alerts. More...
enum	dt_ac_range_check_clock {   kDtAcRangeCheckClockClk = 0 ,   kDtAcRangeCheckClockCount = 1 }
	List of clock ports. More...
enum	dt_ac_range_check_reset {   kDtAcRangeCheckResetRst = 0 ,   kDtAcRangeCheckResetCount = 1 }
	List of reset ports. More...

Functions
dt_ac_range_check_t	dt_ac_range_check_from_instance_id (dt_instance_id_t inst_id)
	Get the ac_range_check instance from an instance ID.
dt_instance_id_t	dt_ac_range_check_instance_id (dt_ac_range_check_t dt)
	Get the instance ID of an instance.
uint32_t	dt_ac_range_check_reg_block (dt_ac_range_check_t dt, dt_ac_range_check_reg_block_t reg_block)
	Get the register base address of an instance.
uint32_t	dt_ac_range_check_memory_base (dt_ac_range_check_t dt, dt_ac_range_check_memory_t mem)
	Get the base address of a memory.
uint32_t	dt_ac_range_check_memory_size (dt_ac_range_check_t dt, dt_ac_range_check_memory_t mem)
	Get the size of a memory.
dt_plic_irq_id_t	dt_ac_range_check_irq_to_plic_id (dt_ac_range_check_t dt, dt_ac_range_check_irq_t irq)
	Get the PLIC ID of a ac_range_check IRQ for a given instance.
dt_ac_range_check_irq_t	dt_ac_range_check_irq_from_plic_id (dt_ac_range_check_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local ac_range_check IRQ type.
dt_alert_id_t	dt_ac_range_check_alert_to_alert_id (dt_ac_range_check_t dt, dt_ac_range_check_alert_t alert)
	Get the alert ID of a ac_range_check alert for a given instance.
dt_ac_range_check_alert_t	dt_ac_range_check_alert_from_alert_id (dt_ac_range_check_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local ac_range_check alert type.
dt_clock_t	dt_ac_range_check_clock (dt_ac_range_check_t dt, dt_ac_range_check_clock_t clk)
	Get the clock signal connected to a clock port of an instance.
dt_reset_t	dt_ac_range_check_reset (dt_ac_range_check_t dt, dt_ac_range_check_reset_t rst)
	Get the reset signal connected to a reset port of an instance.
uint8_t	dt_ac_range_check_num_ranges (dt_ac_range_check_t dt)
	Get the Number of range registers.

Detailed Description

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

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

Definition in file dt_ac_range_check.h.

Typedef Documentation

dt_ac_range_check_alert_t

typedef enum dt_ac_range_check_alert dt_ac_range_check_alert_t

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

dt_ac_range_check_clock_t

typedef enum dt_ac_range_check_clock dt_ac_range_check_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

dt_ac_range_check_irq_t

typedef enum dt_ac_range_check_irq dt_ac_range_check_irq_t

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

dt_ac_range_check_memory_t

typedef enum dt_ac_range_check_memory dt_ac_range_check_memory_t

List of memories.

Memories are guaranteed to start at 0 and to be consecutively numbered.

dt_ac_range_check_reg_block_t

typedef enum dt_ac_range_check_reg_block dt_ac_range_check_reg_block_t

List of register blocks.

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

dt_ac_range_check_reset_t

typedef enum dt_ac_range_check_reset dt_ac_range_check_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

dt_ac_range_check

enum dt_ac_range_check

List of instances.

Enumerator
kDtAcRangeCheck	ac_range_check

Definition at line 31 of file dt_ac_range_check.h.

dt_ac_range_check_alert

enum dt_ac_range_check_alert

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

Enumerator
kDtAcRangeCheckAlertRecovCtrlUpdateErr	This recoverable alert is triggered upon detecting an update error in the shadowed Control Register.
kDtAcRangeCheckAlertFatalFault	This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected or the internal counter has an error.

Definition at line 74 of file dt_ac_range_check.h.

dt_ac_range_check_clock

enum dt_ac_range_check_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtAcRangeCheckClockClk	Clock port clk_i.

Definition at line 85 of file dt_ac_range_check.h.

dt_ac_range_check_irq

enum dt_ac_range_check_irq

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

Enumerator
kDtAcRangeCheckIrqDenyCntReached	Deny counter has exceeded threshold.

Definition at line 64 of file dt_ac_range_check.h.

dt_ac_range_check_memory

enum dt_ac_range_check_memory

List of memories.

Memories are guaranteed to start at 0 and to be consecutively numbered.

Definition at line 55 of file dt_ac_range_check.h.

dt_ac_range_check_reg_block

enum dt_ac_range_check_reg_block

List of register blocks.

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

Definition at line 42 of file dt_ac_range_check.h.

dt_ac_range_check_reset

enum dt_ac_range_check_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtAcRangeCheckResetRst	Reset port rst_ni.

Definition at line 95 of file dt_ac_range_check.h.

Function Documentation

dt_ac_range_check_alert_from_alert_id()

dt_ac_range_check_alert_t dt_ac_range_check_alert_from_alert_id	(	dt_ac_range_check_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns

The ac_range_check alert, or kDtAcRangeCheckAlertCount.

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

Definition at line 143 of file dt_ac_range_check.c.

dt_ac_range_check_alert_to_alert_id()

dt_alert_id_t dt_ac_range_check_alert_to_alert_id	(	dt_ac_range_check_t	dt,
		dt_ac_range_check_alert_t	alert )

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

Returns

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

Definition at line 137 of file dt_ac_range_check.c.

dt_ac_range_check_clock()

dt_clock_t dt_ac_range_check_clock	(	dt_ac_range_check_t	dt,
		dt_ac_range_check_clock_t	clk )

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

Parameters

dt	Instance of ac_range_check.
clk	Clock port.

Returns

Clock signal.

Definition at line 155 of file dt_ac_range_check.c.

dt_ac_range_check_from_instance_id()

dt_ac_range_check_t dt_ac_range_check_from_instance_id

(

dt_instance_id_t

inst_id

)

Get the ac_range_check instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id

Instance ID.

Returns

A ac_range_check instance.

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

Definition at line 79 of file dt_ac_range_check.c.

dt_ac_range_check_instance_id()

dt_instance_id_t dt_ac_range_check_instance_id

(

dt_ac_range_check_t

dt

)

Get the instance ID of an instance.

Parameters

dt	Instance of ac_range_check.

Returns

The instance ID of that instance.

Definition at line 86 of file dt_ac_range_check.c.

dt_ac_range_check_irq_from_plic_id()

dt_ac_range_check_irq_t dt_ac_range_check_irq_from_plic_id	(	dt_ac_range_check_t	dt,
		dt_plic_irq_id_t	irq )

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

Parameters

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

Returns

The ac_range_check IRQ, or kDtAcRangeCheckIrqCount.

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

Definition at line 122 of file dt_ac_range_check.c.

dt_ac_range_check_irq_to_plic_id()

dt_plic_irq_id_t dt_ac_range_check_irq_to_plic_id	(	dt_ac_range_check_t	dt,
		dt_ac_range_check_irq_t	irq )

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

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

Parameters

dt	Instance of ac_range_check.
irq	A ac_range_check IRQ.

Returns

The PLIC ID of the IRQ of this instance.

Definition at line 112 of file dt_ac_range_check.c.

dt_ac_range_check_memory_base()

uint32_t dt_ac_range_check_memory_base	(	dt_ac_range_check_t	dt,
		dt_ac_range_check_memory_t	mem )

Get the base address of a memory.

Parameters

dt	Instance of ac_range_check.
mem	The memory requested.

Returns

The base address of the requested memory.

Definition at line 98 of file dt_ac_range_check.c.

dt_ac_range_check_memory_size()

uint32_t dt_ac_range_check_memory_size	(	dt_ac_range_check_t	dt,
		dt_ac_range_check_memory_t	mem )

Get the size of a memory.

Parameters

dt	Instance of ac_range_check.
mem	The memory requested.

Returns

The size of the requested memory.

Definition at line 105 of file dt_ac_range_check.c.

dt_ac_range_check_num_ranges()

uint8_t dt_ac_range_check_num_ranges

(

dt_ac_range_check_t

dt

)

Get the Number of range registers.

Parameters

dt	Instance of ac_range_check.

Returns

Number of range registers.

Definition at line 174 of file dt_ac_range_check.c.

dt_ac_range_check_reg_block()

uint32_t dt_ac_range_check_reg_block	(	dt_ac_range_check_t	dt,
		dt_ac_range_check_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of ac_range_check.
reg_block	The register block requested.

Returns

The register base address of the requested block.

Definition at line 91 of file dt_ac_range_check.c.

dt_ac_range_check_reset()

dt_reset_t dt_ac_range_check_reset	(	dt_ac_range_check_t	dt,
		dt_ac_range_check_reset_t	rst )

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

Parameters

dt	Instance of ac_range_check.
rst	Reset port.

Returns

Reset signal.

Definition at line 162 of file dt_ac_range_check.c.