dt_pattgen.h File Reference

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

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

Go to the source code of this file.

Macros
#define	OPENTITAN_PATTGEN_HAS_CHANNEL_ONE   1
	List of supported hardware features.
#define	OPENTITAN_PATTGEN_HAS_CHANNEL_TWO   1
#define	OPENTITAN_PATTGEN_HAS_CONFIG_PATTERN   1
#define	OPENTITAN_PATTGEN_HAS_CONFIG_DIVIDER   1
#define	OPENTITAN_PATTGEN_HAS_CONFIG_REPEAT   1
#define	OPENTITAN_PATTGEN_HAS_CONFIG_POLARITY   1
#define	OPENTITAN_PATTGEN_HAS_CONFIG_INACTIVE_LEVEL   1
#define	OPENTITAN_PATTGEN_HAS_COMPLETE   1

Typedefs
typedef enum dt_pattgen	dt_pattgen_t
	List of instances.
typedef enum dt_pattgen_reg_block	dt_pattgen_reg_block_t
	List of register blocks.
typedef enum dt_pattgen_memory	dt_pattgen_memory_t
	List of memories.
typedef enum dt_pattgen_irq	dt_pattgen_irq_t
	List of IRQs.
typedef enum dt_pattgen_alert	dt_pattgen_alert_t
	List of Alerts.
typedef enum dt_pattgen_clock	dt_pattgen_clock_t
	List of clock ports.
typedef enum dt_pattgen_reset	dt_pattgen_reset_t
	List of reset ports.
typedef enum dt_pattgen_periph_io	dt_pattgen_periph_io_t
	List of peripheral I/O.

Enumerations
enum	dt_pattgen {   kDtPattgen = 0 ,   kDtPattgenFirst = 0 ,   kDtPattgenCount = 1 }
	List of instances. More...
enum	dt_pattgen_reg_block {   kDtPattgenRegBlockCore = 0 ,   kDtPattgenRegBlockCount = 1 }
	List of register blocks. More...
enum	dt_pattgen_memory { kDtPattgenMemoryCount = 0 }
	List of memories. More...
enum	dt_pattgen_irq {   kDtPattgenIrqDoneCh0 = 0 ,   kDtPattgenIrqDoneCh1 = 1 ,   kDtPattgenIrqCount = 2 }
	List of IRQs. More...
enum	dt_pattgen_alert {   kDtPattgenAlertFatalFault = 0 ,   kDtPattgenAlertCount = 1 }
	List of Alerts. More...
enum	dt_pattgen_clock {   kDtPattgenClockClk = 0 ,   kDtPattgenClockCount = 1 }
	List of clock ports. More...
enum	dt_pattgen_reset {   kDtPattgenResetRst = 0 ,   kDtPattgenResetCount = 1 }
	List of reset ports. More...
enum	dt_pattgen_periph_io {   kDtPattgenPeriphIoPda0Tx = 0 ,   kDtPattgenPeriphIoPcl0Tx = 1 ,   kDtPattgenPeriphIoPda1Tx = 2 ,   kDtPattgenPeriphIoPcl1Tx = 3 ,   kDtPattgenPeriphIoCount = 4 }
	List of peripheral I/O. More...

Functions
dt_pattgen_t	dt_pattgen_from_instance_id (dt_instance_id_t inst_id)
	Get the pattgen instance from an instance ID.
dt_instance_id_t	dt_pattgen_instance_id (dt_pattgen_t dt)
	Get the instance ID of an instance.
uint32_t	dt_pattgen_reg_block (dt_pattgen_t dt, dt_pattgen_reg_block_t reg_block)
	Get the register base address of an instance.
uint32_t	dt_pattgen_memory_base (dt_pattgen_t dt, dt_pattgen_memory_t mem)
	Get the base address of a memory.
uint32_t	dt_pattgen_memory_size (dt_pattgen_t dt, dt_pattgen_memory_t mem)
	Get the size of a memory.
dt_plic_irq_id_t	dt_pattgen_irq_to_plic_id (dt_pattgen_t dt, dt_pattgen_irq_t irq)
	Get the PLIC ID of a pattgen IRQ for a given instance.
dt_pattgen_irq_t	dt_pattgen_irq_from_plic_id (dt_pattgen_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local pattgen IRQ type.
dt_alert_id_t	dt_pattgen_alert_to_alert_id (dt_pattgen_t dt, dt_pattgen_alert_t alert)
	Get the alert ID of a pattgen alert for a given instance.
dt_pattgen_alert_t	dt_pattgen_alert_from_alert_id (dt_pattgen_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local pattgen alert type.
dt_periph_io_t	dt_pattgen_periph_io (dt_pattgen_t dt, dt_pattgen_periph_io_t sig)
	Get the peripheral I/O description of an instance.
dt_clock_t	dt_pattgen_clock (dt_pattgen_t dt, dt_pattgen_clock_t clk)
	Get the clock signal connected to a clock port of an instance.
dt_reset_t	dt_pattgen_reset (dt_pattgen_t dt, dt_pattgen_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

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

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

Definition in file dt_pattgen.h.

Macro Definition Documentation

OPENTITAN_PATTGEN_HAS_CHANNEL_ONE

#define OPENTITAN_PATTGEN_HAS_CHANNEL_ONE   1

List of supported hardware features.

Definition at line 114 of file dt_pattgen.h.

OPENTITAN_PATTGEN_HAS_CHANNEL_TWO

#define OPENTITAN_PATTGEN_HAS_CHANNEL_TWO   1

Definition at line 115 of file dt_pattgen.h.

OPENTITAN_PATTGEN_HAS_COMPLETE

#define OPENTITAN_PATTGEN_HAS_COMPLETE   1

Definition at line 121 of file dt_pattgen.h.

OPENTITAN_PATTGEN_HAS_CONFIG_DIVIDER

#define OPENTITAN_PATTGEN_HAS_CONFIG_DIVIDER   1

Definition at line 117 of file dt_pattgen.h.

OPENTITAN_PATTGEN_HAS_CONFIG_INACTIVE_LEVEL

#define OPENTITAN_PATTGEN_HAS_CONFIG_INACTIVE_LEVEL   1

Definition at line 120 of file dt_pattgen.h.

OPENTITAN_PATTGEN_HAS_CONFIG_PATTERN

#define OPENTITAN_PATTGEN_HAS_CONFIG_PATTERN   1

Definition at line 116 of file dt_pattgen.h.

OPENTITAN_PATTGEN_HAS_CONFIG_POLARITY

#define OPENTITAN_PATTGEN_HAS_CONFIG_POLARITY   1

Definition at line 119 of file dt_pattgen.h.

OPENTITAN_PATTGEN_HAS_CONFIG_REPEAT

#define OPENTITAN_PATTGEN_HAS_CONFIG_REPEAT   1

Definition at line 118 of file dt_pattgen.h.

Typedef Documentation

dt_pattgen_alert_t

typedef enum dt_pattgen_alert dt_pattgen_alert_t

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

dt_pattgen_clock_t

typedef enum dt_pattgen_clock dt_pattgen_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

dt_pattgen_irq_t

typedef enum dt_pattgen_irq dt_pattgen_irq_t

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

dt_pattgen_memory_t

typedef enum dt_pattgen_memory dt_pattgen_memory_t

List of memories.

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

dt_pattgen_periph_io_t

typedef enum dt_pattgen_periph_io dt_pattgen_periph_io_t

List of peripheral I/O.

Peripheral I/O are guaranteed to be numbered consecutively from 0.

dt_pattgen_reg_block_t

typedef enum dt_pattgen_reg_block dt_pattgen_reg_block_t

List of register blocks.

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

dt_pattgen_reset_t

typedef enum dt_pattgen_reset dt_pattgen_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

dt_pattgen

enum dt_pattgen

List of instances.

Enumerator
kDtPattgen	pattgen

Definition at line 29 of file dt_pattgen.h.

dt_pattgen_alert

enum dt_pattgen_alert

List of Alerts.

Alerts are guaranteed to be numbered consecutively from 0.

Enumerator
kDtPattgenAlertFatalFault	This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected.

Definition at line 73 of file dt_pattgen.h.

dt_pattgen_clock

enum dt_pattgen_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtPattgenClockClk	Clock port clk_i.

Definition at line 83 of file dt_pattgen.h.

dt_pattgen_irq

enum dt_pattgen_irq

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

Enumerator
kDtPattgenIrqDoneCh0	raise if pattern generation on Channel 0 is complete
kDtPattgenIrqDoneCh1	raise if pattern generation on Channel 1 is complete

Definition at line 62 of file dt_pattgen.h.

dt_pattgen_memory

enum dt_pattgen_memory

List of memories.

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

Definition at line 53 of file dt_pattgen.h.

dt_pattgen_periph_io

enum dt_pattgen_periph_io

List of peripheral I/O.

Peripheral I/O are guaranteed to be numbered consecutively from 0.

Definition at line 103 of file dt_pattgen.h.

dt_pattgen_reg_block

enum dt_pattgen_reg_block

List of register blocks.

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

Definition at line 40 of file dt_pattgen.h.

dt_pattgen_reset

enum dt_pattgen_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtPattgenResetRst	Reset port rst_ni.

Definition at line 93 of file dt_pattgen.h.

Function Documentation

dt_pattgen_alert_from_alert_id()

dt_pattgen_alert_t dt_pattgen_alert_from_alert_id	(	dt_pattgen_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns

The pattgen alert, or kDtPattgenAlertCount.

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

Definition at line 170 of file dt_pattgen.c.

dt_pattgen_alert_to_alert_id()

dt_alert_id_t dt_pattgen_alert_to_alert_id	(	dt_pattgen_t	dt,
		dt_pattgen_alert_t	alert )

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

Returns

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

Definition at line 164 of file dt_pattgen.c.

dt_pattgen_clock()

dt_clock_t dt_pattgen_clock	(	dt_pattgen_t	dt,
		dt_pattgen_clock_t	clk )

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

Parameters

dt	Instance of pattgen.
clk	Clock port.

Returns

Clock signal.

Definition at line 188 of file dt_pattgen.c.

dt_pattgen_from_instance_id()

dt_pattgen_t dt_pattgen_from_instance_id

(

dt_instance_id_t

inst_id

)

Get the pattgen instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id

Instance ID.

Returns

A pattgen instance.

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

Definition at line 106 of file dt_pattgen.c.

dt_pattgen_instance_id()

dt_instance_id_t dt_pattgen_instance_id

(

dt_pattgen_t

dt

)

Get the instance ID of an instance.

Parameters

dt	Instance of pattgen.

Returns

The instance ID of that instance.

Definition at line 113 of file dt_pattgen.c.

dt_pattgen_irq_from_plic_id()

dt_pattgen_irq_t dt_pattgen_irq_from_plic_id	(	dt_pattgen_t	dt,
		dt_plic_irq_id_t	irq )

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

Parameters

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

Returns

The pattgen IRQ, or kDtPattgenIrqCount.

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

Definition at line 149 of file dt_pattgen.c.

dt_pattgen_irq_to_plic_id()

dt_plic_irq_id_t dt_pattgen_irq_to_plic_id	(	dt_pattgen_t	dt,
		dt_pattgen_irq_t	irq )

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

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

Parameters

dt	Instance of pattgen.
irq	A pattgen IRQ.

Returns

The PLIC ID of the IRQ of this instance.

Definition at line 139 of file dt_pattgen.c.

dt_pattgen_memory_base()

uint32_t dt_pattgen_memory_base	(	dt_pattgen_t	dt,
		dt_pattgen_memory_t	mem )

Get the base address of a memory.

Parameters

dt	Instance of pattgen.
mem	The memory requested.

Returns

The base address of the requested memory.

Definition at line 125 of file dt_pattgen.c.

dt_pattgen_memory_size()

uint32_t dt_pattgen_memory_size	(	dt_pattgen_t	dt,
		dt_pattgen_memory_t	mem )

Get the size of a memory.

Parameters

dt	Instance of pattgen.
mem	The memory requested.

Returns

The size of the requested memory.

Definition at line 132 of file dt_pattgen.c.

dt_pattgen_periph_io()

dt_periph_io_t dt_pattgen_periph_io	(	dt_pattgen_t	dt,
		dt_pattgen_periph_io_t	sig )

Get the peripheral I/O description of an instance.

Parameters

dt	Instance of pattgen.
sig	Requested peripheral I/O.

Returns

Description of the requested peripheral I/O for this instance.

Definition at line 181 of file dt_pattgen.c.

dt_pattgen_reg_block()

uint32_t dt_pattgen_reg_block	(	dt_pattgen_t	dt,
		dt_pattgen_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of pattgen.
reg_block	The register block requested.

Returns

The register base address of the requested block.

Definition at line 118 of file dt_pattgen.c.

dt_pattgen_reset()

dt_reset_t dt_pattgen_reset	(	dt_pattgen_t	dt,
		dt_pattgen_reset_t	rst )

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

Parameters

dt	Instance of pattgen.
rst	Reset port.

Returns

Reset signal.

Definition at line 195 of file dt_pattgen.c.