Overview

The MCUXpresso SDK provides a driver for the RDC module of MCUXpresso SDK devices.

The Resource Domain Controller (RDC) provides robust support for the isolation of destination memory mapped locations such as peripherals and memory to a single core, a bus master, or set of cores and bus masters.
The RDC driver should be used together with the RDC_SEMA42 driver.

Data Structures
struct	rdc_hardware_config_t
	RDC hardware configuration. More...

struct	rdc_domain_assignment_t
	Master domain assignment. More...

struct	rdc_periph_access_config_t
	Peripheral domain access permission configuration. More...

struct	rdc_mem_access_config_t
	Memory region domain access control configuration. More...

struct	rdc_mem_status_t
	Memory region access violation status. More...

Enumerations
enum	_rdc_interrupts { kRDC_RestoreCompleteInterrupt = RDC_INTCTRL_RCI_EN_MASK }
	RDC interrupts. More...

enum	_rdc_flags { kRDC_PowerDownDomainOn = RDC_STAT_PDS_MASK }
	RDC status. More...

enum	_rdc_access_policy { kRDC_NoAccess = 0, kRDC_WriteOnly = 1, kRDC_ReadOnly = 2, kRDC_ReadWrite = 3 }
	Access permission policy. More...

Functions
void	RDC_Init (RDC_Type *base)
	Initializes the RDC module. More...

void	RDC_Deinit (RDC_Type *base)
	De-initializes the RDC module. More...

void	RDC_GetHardwareConfig (RDC_Type base, rdc_hardware_config_t config)
	Gets the RDC hardware configuration. More...

static void	RDC_EnableInterrupts (RDC_Type *base, uint32_t mask)
	Enable interrupts. More...

static void	RDC_DisableInterrupts (RDC_Type *base, uint32_t mask)
	Disable interrupts. More...

static uint32_t	RDC_GetInterruptStatus (RDC_Type *base)
	Get the interrupt pending status. More...

static void	RDC_ClearInterruptStatus (RDC_Type *base, uint32_t mask)
	Clear interrupt pending status. More...

static uint32_t	RDC_GetStatus (RDC_Type *base)
	Get RDC status. More...

static void	RDC_ClearStatus (RDC_Type *base, uint32_t mask)
	Clear RDC status. More...

void	RDC_SetMasterDomainAssignment (RDC_Type base, rdc_master_t master, const rdc_domain_assignment_t domainAssignment)
	Set master domain assignment. More...

void	RDC_GetDefaultMasterDomainAssignment (rdc_domain_assignment_t *domainAssignment)
	Get default master domain assignment. More...

static void	RDC_LockMasterDomainAssignment (RDC_Type *base, rdc_master_t master)
	Lock master domain assignment. More...

void	RDC_SetPeriphAccessConfig (RDC_Type base, const rdc_periph_access_config_t config)
	Set peripheral access policy. More...

void	RDC_GetDefaultPeriphAccessConfig (rdc_periph_access_config_t *config)
	Get default peripheral access policy. More...

static void	RDC_LockPeriphAccessConfig (RDC_Type *base, rdc_periph_t periph)
	Lock peripheral access policy configuration. More...

void	RDC_SetMemAccessConfig (RDC_Type base, const rdc_mem_access_config_t config)
	Set memory region access policy. More...

void	RDC_GetDefaultMemAccessConfig (rdc_mem_access_config_t *config)
	Get default memory region access policy. More...

static void	RDC_LockMemAccessConfig (RDC_Type *base, rdc_mem_t mem)
	Lock memory access policy configuration. More...

static void	RDC_SetMemAccessValid (RDC_Type *base, rdc_mem_t mem, bool valid)
	Enable or disable memory access policy configuration. More...

void	RDC_GetMemViolationStatus (RDC_Type base, rdc_mem_t mem, rdc_mem_status_t status)
	Get the memory region violation status. More...

static void	RDC_ClearMemViolationFlag (RDC_Type *base, rdc_mem_t mem)
	Clear the memory region violation flag. More...

static uint8_t	RDC_GetCurrentMasterDomainId (RDC_Type *base)
	Gets the domain ID of the current bus master. More...

Data Structure Documentation

struct rdc_hardware_config_t

Data Fields
uint32_t	domainNumber: 4
	Number of domains. More...

uint32_t	masterNumber: 8
	Number of bus masters. More...

uint32_t	periphNumber: 8
	Number of peripherals. More...

uint32_t	memNumber: 8
	Number of memory regions. More...

Field Documentation

uint32_t rdc_hardware_config_t::domainNumber

uint32_t rdc_hardware_config_t::masterNumber

uint32_t rdc_hardware_config_t::periphNumber

uint32_t rdc_hardware_config_t::memNumber

struct rdc_domain_assignment_t

Data Fields
uint32_t	domainId: 2U
	Domain ID. More...

uint32_t	__pad0__: 29U
	Reserved. More...

uint32_t	lock: 1U
	Lock the domain assignment. More...

Field Documentation

uint32_t rdc_domain_assignment_t::domainId

uint32_t rdc_domain_assignment_t::__pad0__

uint32_t rdc_domain_assignment_t::lock

struct rdc_periph_access_config_t

Data Fields
rdc_periph_t	periph
	Peripheral name. More...

bool	lock
	Lock the permission until reset. More...

bool	enableSema
	Enable semaphore or not, when enabled, master should call RDC_SEMA42_Lock to lock the semaphore gate accordingly before access the peripheral. More...

uint16_t	policy
	Access policy. More...

Field Documentation

rdc_periph_t rdc_periph_access_config_t::periph

bool rdc_periph_access_config_t::lock

bool rdc_periph_access_config_t::enableSema

uint16_t rdc_periph_access_config_t::policy

struct rdc_mem_access_config_t

Note that when setting the baseAddress and endAddress, should be aligned to the region resolution, see rdc_mem_t definitions.

Data Fields
rdc_mem_t	mem
	Memory region descriptor name. More...

bool	lock
	Lock the configuration. More...

uint64_t	baseAddress
	Start address of the memory region. More...

uint64_t	endAddress
	End address of the memory region. More...

uint16_t	policy
	Access policy. More...

Field Documentation

rdc_mem_t rdc_mem_access_config_t::mem

bool rdc_mem_access_config_t::lock

uint64_t rdc_mem_access_config_t::baseAddress

uint64_t rdc_mem_access_config_t::endAddress

uint16_t rdc_mem_access_config_t::policy

struct rdc_mem_status_t

Data Fields
bool	hasViolation
	Violating happens or not. More...

uint8_t	domainID
	Violating Domain ID. More...

uint64_t	address
	Violating Address. More...

Field Documentation

bool rdc_mem_status_t::hasViolation

uint8_t rdc_mem_status_t::domainID

uint64_t rdc_mem_status_t::address

Enumeration Type Documentation

enum _rdc_interrupts

Enumerator
kRDC_RestoreCompleteInterrupt	Interrupt generated when the RDC has completed restoring state to a recently re-powered memory regions.

enum _rdc_flags

Enumerator
kRDC_PowerDownDomainOn	Power down domain is ON.

enum _rdc_access_policy

Enumerator
kRDC_NoAccess	Could not read or write.
kRDC_WriteOnly	Write only.
kRDC_ReadOnly	Read only.
kRDC_ReadWrite	Read and write.

Function Documentation

void RDC_Init ( RDC_Type * base )

This function enables the RDC clock.

Parameters

base	RDC peripheral base address.

void RDC_Deinit ( RDC_Type * base )

This function disables the RDC clock.

Parameters

base	RDC peripheral base address.

void RDC_GetHardwareConfig	(	RDC_Type *	base,
		rdc_hardware_config_t *	config
	)

This function gets the RDC hardware configurations, including number of bus masters, number of domains, number of memory regions and number of peripherals.

Parameters

base	RDC peripheral base address.
config	Pointer to the structure to get the configuration.

static void RDC_EnableInterrupts	(	RDC_Type *	base,
		uint32_t	mask
	)

inlinestatic

Parameters

base	RDC peripheral base address.
mask	Interrupts to enable, it is OR'ed value of enum _rdc_interrupts.

static void RDC_DisableInterrupts	(	RDC_Type *	base,
		uint32_t	mask
	)

inlinestatic

Parameters

base	RDC peripheral base address.
mask	Interrupts to disable, it is OR'ed value of enum _rdc_interrupts.

static uint32_t RDC_GetInterruptStatus ( RDC_Type * base )

inlinestatic

Parameters

base	RDC peripheral base address.

Returns: Interrupts pending status, it is OR'ed value of enum _rdc_interrupts.

static void RDC_ClearInterruptStatus	(	RDC_Type *	base,
		uint32_t	mask
	)

inlinestatic

Parameters

base	RDC peripheral base address.
mask	Status to clear, it is OR'ed value of enum _rdc_interrupts.

static uint32_t RDC_GetStatus ( RDC_Type * base )

inlinestatic

Parameters

base	RDC peripheral base address.

Returns: mask RDC status, it is OR'ed value of enum _rdc_flags.

static void RDC_ClearStatus	(	RDC_Type *	base,
		uint32_t	mask
	)

inlinestatic

Parameters

base	RDC peripheral base address.
mask	RDC status to clear, it is OR'ed value of enum _rdc_flags.

void RDC_SetMasterDomainAssignment	(	RDC_Type *	base,
		rdc_master_t	master,
		const rdc_domain_assignment_t *	domainAssignment
	)

Parameters

base	RDC peripheral base address.
master	Which master to set.
domainAssignment	Pointer to the assignment.

void RDC_GetDefaultMasterDomainAssignment ( rdc_domain_assignment_t * domainAssignment )

The default configuration is:

assignment->domainId = 0U;

assignment->lock = 0U;

Parameters

domainAssignment Pointer to the assignment.

static void RDC_LockMasterDomainAssignment	(	RDC_Type *	base,
		rdc_master_t	master
	)

inlinestatic

Once locked, it could not be unlocked until next reset.

Parameters

base	RDC peripheral base address.
master	Which master to lock.

void RDC_SetPeriphAccessConfig	(	RDC_Type *	base,
		const rdc_periph_access_config_t *	config
	)

Parameters

base	RDC peripheral base address.
config	Pointer to the policy configuration.

void RDC_GetDefaultPeriphAccessConfig ( rdc_periph_access_config_t * config )

The default configuration is:

config->lock = false;
config->enableSema = false;
config->policy = RDC_ACCESS_POLICY(0, kRDC_ReadWrite) |
                 RDC_ACCESS_POLICY(1, kRDC_ReadWrite) |
                 RDC_ACCESS_POLICY(2, kRDC_ReadWrite) |
                 RDC_ACCESS_POLICY(3, kRDC_ReadWrite);

Parameters

config Pointer to the policy configuration.

static void RDC_LockPeriphAccessConfig	(	RDC_Type *	base,
		rdc_periph_t	periph
	)

inlinestatic

Once locked, it could not be unlocked until reset.

Parameters

base	RDC peripheral base address.
periph	Which peripheral to lock.

void RDC_SetMemAccessConfig	(	RDC_Type *	base,
		const rdc_mem_access_config_t *	config
	)

Note that when setting the baseAddress and endAddress in config, should be aligned to the region resolution, see rdc_mem_t definitions.

Parameters

base	RDC peripheral base address.
config	Pointer to the policy configuration.

void RDC_GetDefaultMemAccessConfig ( rdc_mem_access_config_t * config )

The default configuration is:

config->lock = false;
config->baseAddress = 0;
config->endAddress = 0;
config->policy = RDC_ACCESS_POLICY(0, kRDC_ReadWrite) |
                 RDC_ACCESS_POLICY(1, kRDC_ReadWrite) |
                 RDC_ACCESS_POLICY(2, kRDC_ReadWrite) |
                 RDC_ACCESS_POLICY(3, kRDC_ReadWrite);

Parameters

config Pointer to the policy configuration.

static void RDC_LockMemAccessConfig	(	RDC_Type *	base,
		rdc_mem_t	mem
	)

inlinestatic

Once locked, it could not be unlocked until reset. After locked, you can only call RDC_SetMemAccessValid to enable the configuration, but can not disable it or change other settings.

Parameters

base	RDC peripheral base address.
mem	Which memory region to lock.

static void RDC_SetMemAccessValid	(	RDC_Type *	base,
		rdc_mem_t	mem,
		bool	valid
	)

inlinestatic

Parameters

base	RDC peripheral base address.
mem	Which memory region to operate.
valid	Pass in true to valid, false to invalid.

void RDC_GetMemViolationStatus	(	RDC_Type *	base,
		rdc_mem_t	mem,
		rdc_mem_status_t *	status
	)

The first access violation is captured. Subsequent violations are ignored until the status register is cleared. Contents are cleared upon reading the register. Clearing of contents occurs only when the status is read by the memory region's associated domain ID(s).

Parameters

base	RDC peripheral base address.
mem	Which memory region to get.
status	The returned status.

static void RDC_ClearMemViolationFlag	(	RDC_Type *	base,
		rdc_mem_t	mem
	)

inlinestatic

Parameters

base	RDC peripheral base address.
mem	Which memory region to clear.

static uint8_t RDC_GetCurrentMasterDomainId ( RDC_Type * base )

inlinestatic

This function returns the domain ID of the current bus master.

Parameters

base	RDC peripheral base address.

Returns: Domain ID of current bus master.

Overview

Data Structures

Enumerations

Functions

Data Structure Documentation

Data Fields

Field Documentation

Data Fields

Field Documentation

Data Fields

Field Documentation

Data Fields

Field Documentation

Data Fields

Field Documentation

Enumeration Type Documentation

Function Documentation