Utility macros for saving and restoring PCGCM & PCGCS peripherals

Utility macros for saving and restoring PCGCM & PCGCS peripherals. More...

Macros
#define	NRF_PCGCMASTER_HAS_SETPOWERCONSUMPTIONBASE   1
	Symbol indicating whether SETPOWERCONSUMPTIONBASE registers are available.
#define	_NRFX_SR_PCGCM_VDMA_LEN(_inst, _)
	Macro for calculating length of a save & restore transfer for the given PCGCM instance.
#define	_NRFX_SR_PCGCS_VDMA_LEN(_inst, _)
	Macro for calculating length of a save & restore transfer for the given PCGCS instance.
#define	_NRFX_SR_PCGCM_VDMA_JOB(_inst, _)
	Macro for generating a set of jobs for a PCGCM peripheral.
#define	_NRFX_SR_PCGCS_VDMA_JOB(_inst, _)
	Macro for generating a set of jobs for a PCGCS peripheral.
#define	NRFX_SR_VDMA_PCGCM_JOB()   NRFX_FOREACH_PRESENT(PCGCM, NRFX_INSTANCE_CONCAT, (), (), _NRFX_SR_PCGCM_VDMA_JOB, _)
	Macro for generating a set of VDMA jobs for transfer engaging all PCGCM instances.
#define	NRFX_SR_VDMA_PCGCM_LEN()   (NRFX_FOREACH_PRESENT(PCGCM, NRFX_INSTANCE_CONCAT, (+), (0), _NRFX_SR_PCGCM_VDMA_LEN, _))
	Macro for calculating length of a save & restore transfer for all PCGCM instances.
#define	NRFX_SR_VDMA_PCGCS_JOB()   NRFX_FOREACH_PRESENT(PCGCS, NRFX_INSTANCE_CONCAT, (), (), _NRFX_SR_PCGCS_VDMA_JOB, _)
	Macro for generating a set of VDMA jobs for transfer engaging all PCGCS instances.
#define	NRFX_SR_VDMA_PCGCS_LEN()   (NRFX_FOREACH_PRESENT(PCGCS, NRFX_INSTANCE_CONCAT, (+), (0), _NRFX_SR_PCGCS_VDMA_LEN, _))
	Macro for calculating length of a save & restore transfer for all PCGCS instances.

Detailed Description

Utility macros for saving and restoring PCGCM & PCGCS peripherals.

Macro Definition Documentation

_NRFX_SR_PCGCM_VDMA_JOB

#define _NRFX_SR_PCGCM_VDMA_JOB	(		_inst,
			_
	)

Value:

 NRFX_SR_VDMA_INST_COND_SET_JOB(_inst, SETPWRCONTHRESHOLDBASE, SETPWRCONTHRESHOLDBASE, 1) \
 NRFX_COND_CODE_1(NRF_PCGCMASTER_HAS_SETPOWERCONSUMPTIONBASE, \
 (NRFX_SR_VDMA_INST_SET_JOB(_inst, SETPOWERCONSUMPTIONBASE, 1)), ()) \
 /* POWERREGFORCE follows ENABLEPOWERREGFORCE */ \
 NRFX_SR_VDMA_INST_REG_JOB(_inst, ENABLEPOWERREGFORCE, 2 * sizeof(uint32_t), 0) \
 NRFX_SR_VDMA_INST_COND_SET_JOB(_inst, MASTERFORCEREG, MASTERFORCEREG, 1) \
 NRFX_SR_VDMA_INST_COND_SET_JOB(_inst, CLOCKFORCEREG, CLOCKFORCEREG, 1)

Macro for generating a set of jobs for a PCGCM peripheral.

Macro attempts to generate jobs for features which are supported by the given instance.

Parameters

[in]	_inst	Instance, e.g. PCGCM010.
[in]	_	Dummy argument required by NRFX_LISTIFY.

Returns

Job descriptors.

_NRFX_SR_PCGCM_VDMA_LEN

#define _NRFX_SR_PCGCM_VDMA_LEN	(		_inst,
			_
	)

Value:

 NRFX_SR_VDMA_INST_COND_SET_LEN(_inst, SETPWRCONTHRESHOLDBASE, SETPWRCONTHRESHOLDBASE) + \
 NRFX_SR_VDMA_INST_COND_SET_LEN(_inst, CLOCKFORCEREG, CLOCKFORCEREG) + \
 NRFX_SR_VDMA_INST_COND_SET_LEN(_inst, MASTERFORCEREG, MASTERFORCEREG) + \
 NRFX_COND_CODE_1(NRF_PCGCMASTER_HAS_SETPOWERCONSUMPTIONBASE, \
 (NRFX_SR_VDMA_INST_SET_LEN(_inst, SETPOWERCONSUMPTIONBASE) +), ()) \
 NRFX_SR_VDMA_INST_SET_LEN(_inst, ENABLEPOWERREGFORCE) + \
 NRFX_SR_VDMA_INST_SET_LEN(_inst, POWERREGFORCE)

Macro for calculating length of a save & restore transfer for the given PCGCM instance.

Macro generates a sum of bytes transferred by jobs for a PCGCM instance.

Parameters

[in]	_inst	Instance, e.g. PCGCM010.
[in]	_	Dummy argument required by NRFX_LISTIFY.

_NRFX_SR_PCGCS_VDMA_JOB

#define _NRFX_SR_PCGCS_VDMA_JOB	(		_inst,
			_
	)

Value:

 NRFX_SR_VDMA_INST_SET_JOB(_inst, PENALTY, 1) \
 NRFX_SR_VDMA_INST_SET_JOB(_inst, FORCEOVERRIDE, 1)

Macro for generating a set of jobs for a PCGCS peripheral.

Macro attempts to generate jobs for features which are supported by the given instance.

Parameters

[in]	_inst	Instance, e.g. PCGCS010.
[in]	_	Dummy argument required by NRFX_LISTIFY.

Returns

Job descriptors.

_NRFX_SR_PCGCS_VDMA_LEN

#define _NRFX_SR_PCGCS_VDMA_LEN	(		_inst,
			_
	)

Value:

 NRFX_SR_VDMA_INST_SET_LEN(_inst, PENALTY) + \
 NRFX_SR_VDMA_INST_SET_LEN(_inst, FORCEOVERRIDE)

Macro for calculating length of a save & restore transfer for the given PCGCS instance.

Macro generates a sum of bytes transferred by jobs for a PCGCS instance.

Parameters

[in]	_inst	Instance, e.g. PCGCS010.
[in]	_	Dummy argument required by NRFX_LISTIFY.

NRFX_SR_VDMA_PCGCM_JOB

#define NRFX_SR_VDMA_PCGCM_JOB

(

)

NRFX_FOREACH_PRESENT(PCGCM, NRFX_INSTANCE_CONCAT, (), (), _NRFX_SR_PCGCM_VDMA_JOB, _)

Macro for generating a set of VDMA jobs for transfer engaging all PCGCM instances.

Returns

Job descriptors.

NRFX_SR_VDMA_PCGCM_LEN

#define NRFX_SR_VDMA_PCGCM_LEN

(

)

(NRFX_FOREACH_PRESENT(PCGCM, NRFX_INSTANCE_CONCAT, (+), (0), _NRFX_SR_PCGCM_VDMA_LEN, _))

Macro for calculating length of a save & restore transfer for all PCGCM instances.

Parameters

_	Dummy argument required by NRFX_LISTIFY.

Returns

Number of bytes to transfer for performing save and restore.

NRFX_SR_VDMA_PCGCS_JOB

#define NRFX_SR_VDMA_PCGCS_JOB

(

)

NRFX_FOREACH_PRESENT(PCGCS, NRFX_INSTANCE_CONCAT, (), (), _NRFX_SR_PCGCS_VDMA_JOB, _)

Macro for generating a set of VDMA jobs for transfer engaging all PCGCS instances.

Returns

Job descriptors.

NRFX_SR_VDMA_PCGCS_LEN

#define NRFX_SR_VDMA_PCGCS_LEN

(

)

(NRFX_FOREACH_PRESENT(PCGCS, NRFX_INSTANCE_CONCAT, (+), (0), _NRFX_SR_PCGCS_VDMA_LEN, _))

Macro for calculating length of a save & restore transfer for all PCGCS instances.

Returns

Number of bytes to transfer for performing save and restore.