dt_aon_timer.h File Reference

Device Tables (DT) for IP aon_timer and top englishbreakfast. More...

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

Go to the source code of this file.

Macros
#define	OPENTITAN_AON_TIMER_HAS_WAKEUP_WAKEUP_CONFIG   1
	List of supported hardware features.
#define	OPENTITAN_AON_TIMER_HAS_WAKEUP_WAKEUP_REQUEST   1
#define	OPENTITAN_AON_TIMER_HAS_WAKEUP_INTERRUPT   1
#define	OPENTITAN_AON_TIMER_HAS_WATCHDOG_BARK   1
#define	OPENTITAN_AON_TIMER_HAS_WATCHDOG_BITE   1
#define	OPENTITAN_AON_TIMER_HAS_WATCHDOG_PAUSE   1
#define	OPENTITAN_AON_TIMER_HAS_WATCHDOG_DISABLE_BY_LC_CTRL   1
#define	OPENTITAN_AON_TIMER_HAS_WATCHDOG_INTERRUPT   1

Typedefs
typedef enum dt_aon_timer	dt_aon_timer_t
	List of instances.
typedef enum dt_aon_timer_reg_block	dt_aon_timer_reg_block_t
	List of register blocks.
typedef enum dt_aon_timer_irq	dt_aon_timer_irq_t
	List of IRQs.
typedef enum dt_aon_timer_clock	dt_aon_timer_clock_t
	List of clock ports.
typedef enum dt_aon_timer_reset_req	dt_aon_timer_reset_req_t
	List of reset requests.
typedef enum dt_aon_timer_reset	dt_aon_timer_reset_t
	List of reset ports.
typedef enum dt_aon_timer_wakeup	dt_aon_timer_wakeup_t
	List of wakeups.

Enumerations
enum	dt_aon_timer {   kDtAonTimerAon = 0 ,   kDtAonTimerFirst = 0 ,   kDtAonTimerCount = 1 }
	List of instances. More...
enum	dt_aon_timer_reg_block {   kDtAonTimerRegBlockCore = 0 ,   kDtAonTimerRegBlockCount = 1 }
	List of register blocks. More...
enum	dt_aon_timer_irq {   kDtAonTimerIrqWkupTimerExpired = 0 ,   kDtAonTimerIrqWdogTimerBark = 1 ,   kDtAonTimerIrqCount = 2 }
	List of IRQs. More...
enum	dt_aon_timer_clock {   kDtAonTimerClockClk = 0 ,   kDtAonTimerClockAon = 1 ,   kDtAonTimerClockCount = 2 }
	List of clock ports. More...
enum	dt_aon_timer_reset_req {   kDtAonTimerResetReqAonTimer = 0 ,   kDtAonTimerResetReqCount = 1 }
	List of reset requests. More...
enum	dt_aon_timer_reset {   kDtAonTimerResetRst = 0 ,   kDtAonTimerResetAon = 1 ,   kDtAonTimerResetCount = 2 }
	List of reset ports. More...
enum	dt_aon_timer_wakeup {   kDtAonTimerWakeupWkupReq = 0 ,   kDtAonTimerWakeupCount = 1 }
	List of wakeups. More...

Functions
dt_aon_timer_t	dt_aon_timer_from_instance_id (dt_instance_id_t inst_id)
	Get the aon_timer instance from an instance ID.
dt_instance_id_t	dt_aon_timer_instance_id (dt_aon_timer_t dt)
	Get the instance ID of an instance.
uint32_t	dt_aon_timer_reg_block (dt_aon_timer_t dt, dt_aon_timer_reg_block_t reg_block)
	Get the register base address of an instance.
dt_plic_irq_id_t	dt_aon_timer_irq_to_plic_id (dt_aon_timer_t dt, dt_aon_timer_irq_t irq)
	Get the PLIC ID of a aon_timer IRQ for a given instance.
dt_aon_timer_irq_t	dt_aon_timer_irq_from_plic_id (dt_aon_timer_t dt, dt_plic_irq_id_t irq)
	Convert a global IRQ ID to a local aon_timer IRQ type.
dt_clock_t	dt_aon_timer_clock (dt_aon_timer_t dt, dt_aon_timer_clock_t clk)
	Get the clock signal connected to a clock port of an instance.
dt_reset_t	dt_aon_timer_reset (dt_aon_timer_t dt, dt_aon_timer_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

Device Tables (DT) for IP aon_timer and top englishbreakfast.

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

Definition in file dt_aon_timer.h.

Macro Definition Documentation

OPENTITAN_AON_TIMER_HAS_WAKEUP_INTERRUPT

#define OPENTITAN_AON_TIMER_HAS_WAKEUP_INTERRUPT   1

Definition at line 100 of file dt_aon_timer.h.

OPENTITAN_AON_TIMER_HAS_WAKEUP_WAKEUP_CONFIG

#define OPENTITAN_AON_TIMER_HAS_WAKEUP_WAKEUP_CONFIG   1

List of supported hardware features.

Definition at line 98 of file dt_aon_timer.h.

OPENTITAN_AON_TIMER_HAS_WAKEUP_WAKEUP_REQUEST

#define OPENTITAN_AON_TIMER_HAS_WAKEUP_WAKEUP_REQUEST   1

Definition at line 99 of file dt_aon_timer.h.

OPENTITAN_AON_TIMER_HAS_WATCHDOG_BARK

#define OPENTITAN_AON_TIMER_HAS_WATCHDOG_BARK   1

Definition at line 101 of file dt_aon_timer.h.

OPENTITAN_AON_TIMER_HAS_WATCHDOG_BITE

#define OPENTITAN_AON_TIMER_HAS_WATCHDOG_BITE   1

Definition at line 102 of file dt_aon_timer.h.

OPENTITAN_AON_TIMER_HAS_WATCHDOG_DISABLE_BY_LC_CTRL

#define OPENTITAN_AON_TIMER_HAS_WATCHDOG_DISABLE_BY_LC_CTRL   1

Definition at line 104 of file dt_aon_timer.h.

OPENTITAN_AON_TIMER_HAS_WATCHDOG_INTERRUPT

#define OPENTITAN_AON_TIMER_HAS_WATCHDOG_INTERRUPT   1

Definition at line 105 of file dt_aon_timer.h.

OPENTITAN_AON_TIMER_HAS_WATCHDOG_PAUSE

#define OPENTITAN_AON_TIMER_HAS_WATCHDOG_PAUSE   1

Definition at line 103 of file dt_aon_timer.h.

Typedef Documentation

dt_aon_timer_clock_t

typedef enum dt_aon_timer_clock dt_aon_timer_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

dt_aon_timer_irq_t

typedef enum dt_aon_timer_irq dt_aon_timer_irq_t

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

dt_aon_timer_reg_block_t

typedef enum dt_aon_timer_reg_block dt_aon_timer_reg_block_t

List of register blocks.

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

dt_aon_timer_reset_req_t

typedef enum dt_aon_timer_reset_req dt_aon_timer_reset_req_t

List of reset requests.

Reset requests are guaranteed to be numbered consecutively from 0.

dt_aon_timer_reset_t

typedef enum dt_aon_timer_reset dt_aon_timer_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

dt_aon_timer_wakeup_t

typedef enum dt_aon_timer_wakeup dt_aon_timer_wakeup_t

List of wakeups.

Wakeups are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

dt_aon_timer

enum dt_aon_timer

List of instances.

Enumerator
kDtAonTimerAon	aon_timer_aon

Definition at line 23 of file dt_aon_timer.h.

dt_aon_timer_clock

enum dt_aon_timer_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtAonTimerClockClk	Clock port clk_i.
kDtAonTimerClockAon	Clock port clk_aon_i.

Definition at line 58 of file dt_aon_timer.h.

dt_aon_timer_irq

enum dt_aon_timer_irq

List of IRQs.

IRQs are guaranteed to be numbered consecutively from 0.

Enumerator
kDtAonTimerIrqWkupTimerExpired	Raised if the wakeup timer has hit the specified threshold.
kDtAonTimerIrqWdogTimerBark	Raised if the watchdog timer has hit the bark threshold.

Definition at line 47 of file dt_aon_timer.h.

dt_aon_timer_reg_block

enum dt_aon_timer_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_aon_timer.h.

dt_aon_timer_reset

enum dt_aon_timer_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtAonTimerResetRst	Reset port rst_ni.
kDtAonTimerResetAon	Reset port rst_aon_ni.

Definition at line 79 of file dt_aon_timer.h.

dt_aon_timer_reset_req

enum dt_aon_timer_reset_req

List of reset requests.

Reset requests are guaranteed to be numbered consecutively from 0.

Enumerator
kDtAonTimerResetReqAonTimer	Watchdog reset request.

Definition at line 69 of file dt_aon_timer.h.

dt_aon_timer_wakeup

enum dt_aon_timer_wakeup

List of wakeups.

Wakeups are guaranteed to be numbered consecutively from 0.

Enumerator
kDtAonTimerWakeupWkupReq	Raised if the wakeup or watchdog timer has hit the specified threshold.

Definition at line 90 of file dt_aon_timer.h.

Function Documentation

dt_aon_timer_clock()

dt_clock_t dt_aon_timer_clock	(	dt_aon_timer_t	dt,
		dt_aon_timer_clock_t	clk )

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

Parameters

dt	Instance of aon_timer.
clk	Clock port.

Returns

Clock signal.

Definition at line 129 of file dt_aon_timer.c.

dt_aon_timer_from_instance_id()

dt_aon_timer_t dt_aon_timer_from_instance_id

(

dt_instance_id_t

inst_id

)

Get the aon_timer instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id

Instance ID.

Returns

A aon_timer instance.

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

Definition at line 67 of file dt_aon_timer.c.

dt_aon_timer_instance_id()

dt_instance_id_t dt_aon_timer_instance_id

(

dt_aon_timer_t

dt

)

Get the instance ID of an instance.

Parameters

dt	Instance of aon_timer.

Returns

The instance ID of that instance.

Definition at line 74 of file dt_aon_timer.c.

dt_aon_timer_irq_from_plic_id()

dt_aon_timer_irq_t dt_aon_timer_irq_from_plic_id	(	dt_aon_timer_t	dt,
		dt_plic_irq_id_t	irq )

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

Parameters

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

Returns

The aon_timer IRQ, or kDtAonTimerIrqCount.

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

Definition at line 96 of file dt_aon_timer.c.

dt_aon_timer_irq_to_plic_id()

dt_plic_irq_id_t dt_aon_timer_irq_to_plic_id	(	dt_aon_timer_t	dt,
		dt_aon_timer_irq_t	irq )

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

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

Parameters

dt	Instance of aon_timer.
irq	A aon_timer IRQ.

Returns

The PLIC ID of the IRQ of this instance.

Definition at line 86 of file dt_aon_timer.c.

dt_aon_timer_reg_block()

uint32_t dt_aon_timer_reg_block	(	dt_aon_timer_t	dt,
		dt_aon_timer_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of aon_timer.
reg_block	The register block requested.

Returns

The register base address of the requested block.

Definition at line 79 of file dt_aon_timer.c.

dt_aon_timer_reset()

dt_reset_t dt_aon_timer_reset	(	dt_aon_timer_t	dt,
		dt_aon_timer_reset_t	rst )

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

Parameters

dt	Instance of aon_timer.
rst	Reset port.

Returns

Reset signal.

Definition at line 136 of file dt_aon_timer.c.