dt_rom_ctrl.c File Reference

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

#include "dt/dt_rom_ctrl.h"

Go to the source code of this file.

Data Structures
struct	dt_desc_rom_ctrl
	Description of instances. More...

Macros
#define	TRY_GET_DT(dt, default)
	Return a pointer to the dt_rom_ctrl_desc_t structure of the requested dt if it's a valid index.

Typedefs
typedef struct dt_desc_rom_ctrl	dt_desc_rom_ctrl_t
	Description of instances.

Functions
dt_rom_ctrl_t	dt_rom_ctrl_from_instance_id (dt_instance_id_t inst_id)
	Get the rom_ctrl instance from an instance ID.
dt_instance_id_t	dt_rom_ctrl_instance_id (dt_rom_ctrl_t dt)
	Get the instance ID of an instance.
uint32_t	dt_rom_ctrl_reg_block (dt_rom_ctrl_t dt, dt_rom_ctrl_reg_block_t reg_block)
	Get the register base address of an instance.
dt_alert_id_t	dt_rom_ctrl_alert_to_alert_id (dt_rom_ctrl_t dt, dt_rom_ctrl_alert_t alert)
	Get the alert ID of a rom_ctrl alert for a given instance.
dt_rom_ctrl_alert_t	dt_rom_ctrl_alert_from_alert_id (dt_rom_ctrl_t dt, dt_alert_id_t alert)
	Convert a global alert ID to a local rom_ctrl alert type.
dt_clock_t	dt_rom_ctrl_clock (dt_rom_ctrl_t dt, dt_rom_ctrl_clock_t clk)
	Get the clock signal connected to a clock port of an instance.
dt_reset_t	dt_rom_ctrl_reset (dt_rom_ctrl_t dt, dt_rom_ctrl_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

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

Definition in file dt_rom_ctrl.c.

---

Data Structure Documentation

dt_desc_rom_ctrl

struct dt_desc_rom_ctrl

Description of instances.

Definition at line 19 of file dt_rom_ctrl.c.

Data Fields
uint32_t	base_addr[kDtRomCtrlRegBlockCount]	Base address of each register block.
dt_clock_t	clock[kDtRomCtrlClockCount]	Clock signal connected to each clock port.
top_darjeeling_alert_id_t	first_alert	Alert ID of the first Alert of this instance. This value is undefined if the block is not connected to the Alert Handler.
top_earlgrey_alert_id_t	first_alert	Alert ID of the first Alert of this instance. This value is undefined if the block is not connected to the Alert Handler.
dt_instance_id_t	inst_id	Instance ID.
dt_reset_t	reset[kDtRomCtrlResetCount]	Reset signal connected to each reset port.

Macro Definition Documentation

TRY_GET_DT

#define TRY_GET_DT	(		dt,
			default )

Value:

({     if ((dt) < (dt_rom_ctrl_t)0 || (dt) >= kDtRomCtrlCount)       return (default);     &rom_ctrl_desc[dt];   })

Return a pointer to the dt_rom_ctrl_desc_t structure of the requested dt if it's a valid index.

Otherwise, this macro will return (i.e. exit the function) with the provided default value.

Definition at line 57 of file dt_rom_ctrl.c.

Function Documentation

dt_rom_ctrl_alert_from_alert_id()

dt_rom_ctrl_alert_t dt_rom_ctrl_alert_from_alert_id	(	dt_rom_ctrl_t	dt,
		dt_alert_id_t	alert )

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

Parameters

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

Returns

The rom_ctrl alert, or kDtRomCtrlAlertCount.

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

Definition at line 85 of file dt_rom_ctrl.c.

dt_rom_ctrl_alert_to_alert_id()

dt_alert_id_t dt_rom_ctrl_alert_to_alert_id	(	dt_rom_ctrl_t	dt,
		dt_rom_ctrl_alert_t	alert )

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

Returns

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

Definition at line 79 of file dt_rom_ctrl.c.

dt_rom_ctrl_clock()

dt_clock_t dt_rom_ctrl_clock	(	dt_rom_ctrl_t	dt,
		dt_rom_ctrl_clock_t	clk )

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

Parameters

dt	Instance of rom_ctrl.
clk	Clock port.

Returns

Clock signal.

Definition at line 97 of file dt_rom_ctrl.c.

dt_rom_ctrl_from_instance_id()

dt_rom_ctrl_t dt_rom_ctrl_from_instance_id

(

dt_instance_id_t

inst_id

)

Get the rom_ctrl instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id

Instance ID.

Returns

A rom_ctrl instance.

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

Definition at line 59 of file dt_rom_ctrl.c.

dt_rom_ctrl_instance_id()

dt_instance_id_t dt_rom_ctrl_instance_id

(

dt_rom_ctrl_t

dt

)

Get the instance ID of an instance.

Parameters

dt	Instance of rom_ctrl.

Returns

The instance ID of that instance.

Definition at line 66 of file dt_rom_ctrl.c.

dt_rom_ctrl_reg_block()

uint32_t dt_rom_ctrl_reg_block	(	dt_rom_ctrl_t	dt,
		dt_rom_ctrl_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of rom_ctrl.
reg_block	The register block requested.

Returns

The register base address of the requested block.

Definition at line 71 of file dt_rom_ctrl.c.

dt_rom_ctrl_reset()

dt_reset_t dt_rom_ctrl_reset	(	dt_rom_ctrl_t	dt,
		dt_rom_ctrl_reset_t	rst )

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

Parameters

dt	Instance of rom_ctrl.
rst	Reset port.

Returns

Reset signal.

Definition at line 104 of file dt_rom_ctrl.c.