dt_otp_macro.h File Reference

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

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

Go to the source code of this file.

Typedefs
typedef enum dt_otp_macro	dt_otp_macro_t
	List of instances.
typedef enum dt_otp_macro_reg_block	dt_otp_macro_reg_block_t
	List of register blocks.
typedef enum dt_otp_macro_clock	dt_otp_macro_clock_t
	List of clock ports.
typedef enum dt_otp_macro_reset	dt_otp_macro_reset_t
	List of reset ports.
typedef enum dt_otp_macro_periph_io	dt_otp_macro_periph_io_t
	List of peripheral I/O.

Enumerations
enum	dt_otp_macro {   kDtOtpMacro = 0 ,   kDtOtpMacroFirst = 0 ,   kDtOtpMacroCount = 1 }
	List of instances. More...
enum	dt_otp_macro_reg_block {   kDtOtpMacroRegBlockCore = 0 ,   kDtOtpMacroRegBlockCount = 1 }
	List of register blocks. More...
enum	dt_otp_macro_clock {   kDtOtpMacroClockClk = 0 ,   kDtOtpMacroClockCount = 1 }
	List of clock ports. More...
enum	dt_otp_macro_reset {   kDtOtpMacroResetRst = 0 ,   kDtOtpMacroResetCount = 1 }
	List of reset ports. More...
enum	dt_otp_macro_periph_io {   kDtOtpMacroPeriphIoTest0 = 0 ,   kDtOtpMacroPeriphIoTest1 = 1 ,   kDtOtpMacroPeriphIoTest2 = 2 ,   kDtOtpMacroPeriphIoTest3 = 3 ,   kDtOtpMacroPeriphIoTest4 = 4 ,   kDtOtpMacroPeriphIoTest5 = 5 ,   kDtOtpMacroPeriphIoTest6 = 6 ,   kDtOtpMacroPeriphIoTest7 = 7 ,   kDtOtpMacroPeriphIoCount = 8 }
	List of peripheral I/O. More...

Functions
dt_otp_macro_t	dt_otp_macro_from_instance_id (dt_instance_id_t inst_id)
	Get the otp_macro instance from an instance ID.
dt_instance_id_t	dt_otp_macro_instance_id (dt_otp_macro_t dt)
	Get the instance ID of an instance.
uint32_t	dt_otp_macro_reg_block (dt_otp_macro_t dt, dt_otp_macro_reg_block_t reg_block)
	Get the register base address of an instance.
dt_periph_io_t	dt_otp_macro_periph_io (dt_otp_macro_t dt, dt_otp_macro_periph_io_t sig)
	Get the peripheral I/O description of an instance.
dt_clock_t	dt_otp_macro_clock (dt_otp_macro_t dt, dt_otp_macro_clock_t clk)
	Get the clock signal connected to a clock port of an instance.
dt_reset_t	dt_otp_macro_reset (dt_otp_macro_t dt, dt_otp_macro_reset_t rst)
	Get the reset signal connected to a reset port of an instance.

Detailed Description

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

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

Definition in file dt_otp_macro.h.

Typedef Documentation

dt_otp_macro_clock_t

typedef enum dt_otp_macro_clock dt_otp_macro_clock_t

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

dt_otp_macro_periph_io_t

typedef enum dt_otp_macro_periph_io dt_otp_macro_periph_io_t

List of peripheral I/O.

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

dt_otp_macro_reg_block_t

typedef enum dt_otp_macro_reg_block dt_otp_macro_reg_block_t

List of register blocks.

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

dt_otp_macro_reset_t

typedef enum dt_otp_macro_reset dt_otp_macro_reset_t

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumeration Type Documentation

dt_otp_macro

enum dt_otp_macro

List of instances.

Enumerator
kDtOtpMacro	otp_macro

Definition at line 23 of file dt_otp_macro.h.

dt_otp_macro_clock

enum dt_otp_macro_clock

List of clock ports.

Clock ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtOtpMacroClockClk	Clock port clk_i.

Definition at line 47 of file dt_otp_macro.h.

dt_otp_macro_periph_io

enum dt_otp_macro_periph_io

List of peripheral I/O.

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

Definition at line 67 of file dt_otp_macro.h.

dt_otp_macro_reg_block

enum dt_otp_macro_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_otp_macro.h.

dt_otp_macro_reset

enum dt_otp_macro_reset

List of reset ports.

Reset ports are guaranteed to be numbered consecutively from 0.

Enumerator
kDtOtpMacroResetRst	Reset port rst_ni.

Definition at line 57 of file dt_otp_macro.h.

Function Documentation

dt_otp_macro_clock()

dt_clock_t dt_otp_macro_clock	(	dt_otp_macro_t	dt,
		dt_otp_macro_clock_t	clk )

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

Parameters

dt	Instance of otp_macro.
clk	Clock port.

Returns

Clock signal.

Definition at line 146 of file dt_otp_macro.c.

dt_otp_macro_from_instance_id()

dt_otp_macro_t dt_otp_macro_from_instance_id

(

dt_instance_id_t

inst_id

)

Get the otp_macro instance from an instance ID.

For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.

Parameters

inst_id

Instance ID.

Returns

A otp_macro instance.

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

Definition at line 118 of file dt_otp_macro.c.

dt_otp_macro_instance_id()

dt_instance_id_t dt_otp_macro_instance_id

(

dt_otp_macro_t

dt

)

Get the instance ID of an instance.

Parameters

dt	Instance of otp_macro.

Returns

The instance ID of that instance.

Definition at line 125 of file dt_otp_macro.c.

dt_otp_macro_periph_io()

dt_periph_io_t dt_otp_macro_periph_io	(	dt_otp_macro_t	dt,
		dt_otp_macro_periph_io_t	sig )

Get the peripheral I/O description of an instance.

Parameters

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

Returns

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

Definition at line 139 of file dt_otp_macro.c.

dt_otp_macro_reg_block()

uint32_t dt_otp_macro_reg_block	(	dt_otp_macro_t	dt,
		dt_otp_macro_reg_block_t	reg_block )

Get the register base address of an instance.

Parameters

dt	Instance of otp_macro.
reg_block	The register block requested.

Returns

The register base address of the requested block.

Definition at line 130 of file dt_otp_macro.c.

dt_otp_macro_reset()

dt_reset_t dt_otp_macro_reset	(	dt_otp_macro_t	dt,
		dt_otp_macro_reset_t	rst )

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

Parameters

dt	Instance of otp_macro.
rst	Reset port.

Returns

Reset signal.

Definition at line 153 of file dt_otp_macro.c.