Functions that manage interrupts and exceptions via the NVIC. More...

Collaboration diagram for NVIC Functions:

Macros
#define	NVIC_SetPriorityGrouping __NVIC_SetPriorityGrouping

#define	NVIC_GetPriorityGrouping __NVIC_GetPriorityGrouping

#define	NVIC_EnableIRQ __NVIC_EnableIRQ

#define	NVIC_GetEnableIRQ __NVIC_GetEnableIRQ

#define	NVIC_DisableIRQ __NVIC_DisableIRQ

#define	NVIC_GetPendingIRQ __NVIC_GetPendingIRQ

#define	NVIC_SetPendingIRQ __NVIC_SetPendingIRQ

#define	NVIC_ClearPendingIRQ __NVIC_ClearPendingIRQ

#define	NVIC_SetPriority __NVIC_SetPriority

#define	NVIC_GetPriority __NVIC_GetPriority

#define	NVIC_SystemReset __NVIC_SystemReset

#define	NVIC_SetVector __NVIC_SetVector

#define	NVIC_GetVector __NVIC_GetVector

#define	NVIC_USER_IRQ_OFFSET 16

#define	EXC_RETURN_HANDLER (0xFFFFFFF1UL) /* return to Handler mode, uses MSP after return */

#define	EXC_RETURN_THREAD_MSP (0xFFFFFFF9UL) /* return to Thread mode, uses MSP after return */

#define	EXC_RETURN_THREAD_PSP (0xFFFFFFFDUL) /* return to Thread mode, uses PSP after return */

#define	_BIT_SHIFT(IRQn) ( ((((uint32_t)(int32_t)(IRQn)) ) & 0x03UL) * 8UL)

#define	_SHP_IDX(IRQn) ( (((((uint32_t)(int32_t)(IRQn)) & 0x0FUL)-8UL) >> 2UL) )

#define	_IP_IDX(IRQn) ( (((uint32_t)(int32_t)(IRQn)) >> 2UL) )

#define	__NVIC_SetPriorityGrouping(X) (void)(X)

#define	__NVIC_GetPriorityGrouping() (0U)

Functions
__STATIC_INLINE void	__NVIC_EnableIRQ (IRQn_Type IRQn)
	Enable Interrupt. More...

__STATIC_INLINE uint32_t	__NVIC_GetEnableIRQ (IRQn_Type IRQn)
	Get Interrupt Enable status. More...

__STATIC_INLINE void	__NVIC_DisableIRQ (IRQn_Type IRQn)
	Disable Interrupt. More...

__STATIC_INLINE uint32_t	__NVIC_GetPendingIRQ (IRQn_Type IRQn)
	Get Pending Interrupt. More...

__STATIC_INLINE void	__NVIC_SetPendingIRQ (IRQn_Type IRQn)
	Set Pending Interrupt. More...

__STATIC_INLINE void	__NVIC_ClearPendingIRQ (IRQn_Type IRQn)
	Clear Pending Interrupt. More...

__STATIC_INLINE void	__NVIC_SetPriority (IRQn_Type IRQn, uint32_t priority)
	Set Interrupt Priority. More...

__STATIC_INLINE uint32_t	__NVIC_GetPriority (IRQn_Type IRQn)
	Get Interrupt Priority. More...

__STATIC_INLINE uint32_t	NVIC_EncodePriority (uint32_t PriorityGroup, uint32_t PreemptPriority, uint32_t SubPriority)
	Encode Priority. More...

__STATIC_INLINE void	NVIC_DecodePriority (uint32_t Priority, uint32_t PriorityGroup, uint32_t const pPreemptPriority, uint32_t const pSubPriority)
	Decode Priority. More...

__STATIC_INLINE void	__NVIC_SetVector (IRQn_Type IRQn, uint32_t vector)
	Set Interrupt Vector. More...

__STATIC_INLINE uint32_t	__NVIC_GetVector (IRQn_Type IRQn)
	Get Interrupt Vector. More...

__NO_RETURN __STATIC_INLINE void	__NVIC_SystemReset (void)
	System Reset. More...

Detailed Description

Functions that manage interrupts and exceptions via the NVIC.

Macro Definition Documentation

§ NVIC_SetPriorityGrouping

#define NVIC_SetPriorityGrouping __NVIC_SetPriorityGrouping

§ NVIC_GetPriorityGrouping

#define NVIC_GetPriorityGrouping __NVIC_GetPriorityGrouping

§ NVIC_EnableIRQ

#define NVIC_EnableIRQ __NVIC_EnableIRQ

§ NVIC_GetEnableIRQ

#define NVIC_GetEnableIRQ __NVIC_GetEnableIRQ

§ NVIC_DisableIRQ

#define NVIC_DisableIRQ __NVIC_DisableIRQ

§ NVIC_GetPendingIRQ

#define NVIC_GetPendingIRQ __NVIC_GetPendingIRQ

§ NVIC_SetPendingIRQ

#define NVIC_SetPendingIRQ __NVIC_SetPendingIRQ

§ NVIC_ClearPendingIRQ

#define NVIC_ClearPendingIRQ __NVIC_ClearPendingIRQ

§ NVIC_SetPriority

#define NVIC_SetPriority __NVIC_SetPriority

Referenced by SCB_GetFPUType().

§ NVIC_GetPriority

#define NVIC_GetPriority __NVIC_GetPriority

§ NVIC_SystemReset

#define NVIC_SystemReset __NVIC_SystemReset

§ NVIC_SetVector

#define NVIC_SetVector __NVIC_SetVector

§ NVIC_GetVector

#define NVIC_GetVector __NVIC_GetVector

§ NVIC_USER_IRQ_OFFSET

#define NVIC_USER_IRQ_OFFSET 16

Referenced by __NVIC_GetVector(), and __NVIC_SetVector().

§ EXC_RETURN_HANDLER

#define EXC_RETURN_HANDLER (0xFFFFFFF1UL) /* return to Handler mode, uses MSP after return */

§ EXC_RETURN_THREAD_MSP

#define EXC_RETURN_THREAD_MSP (0xFFFFFFF9UL) /* return to Thread mode, uses MSP after return */

§ EXC_RETURN_THREAD_PSP

#define EXC_RETURN_THREAD_PSP (0xFFFFFFFDUL) /* return to Thread mode, uses PSP after return */

§ _BIT_SHIFT

#define _BIT_SHIFT ( IRQn ) ( ((((uint32_t)(int32_t)(IRQn)) ) & 0x03UL) * 8UL)

Referenced by __NVIC_GetPriority(), and __NVIC_SetPriority().

§ _SHP_IDX

#define _SHP_IDX ( IRQn ) ( (((((uint32_t)(int32_t)(IRQn)) & 0x0FUL)-8UL) >> 2UL) )

Referenced by __NVIC_GetPriority(), and __NVIC_SetPriority().

§ _IP_IDX

#define _IP_IDX ( IRQn ) ( (((uint32_t)(int32_t)(IRQn)) >> 2UL) )

Referenced by __NVIC_GetPriority(), and __NVIC_SetPriority().

§ __NVIC_SetPriorityGrouping

#define __NVIC_SetPriorityGrouping ( X ) (void)(X)

§ __NVIC_GetPriorityGrouping

#define __NVIC_GetPriorityGrouping ( ) (0U)

Function Documentation

§ __NVIC_EnableIRQ()

__STATIC_INLINE void __NVIC_EnableIRQ ( IRQn_Type IRQn )

Enable Interrupt.

Enables a device specific interrupt in the NVIC interrupt controller.

Parameters

[in] IRQn Device specific interrupt number.

Note: IRQn must not be negative.

References __COMPILER_BARRIER, and NVIC.

§ __NVIC_GetEnableIRQ()

__STATIC_INLINE uint32_t __NVIC_GetEnableIRQ ( IRQn_Type IRQn )

Get Interrupt Enable status.

Returns a device specific interrupt enable status from the NVIC interrupt controller.

Parameters

[in] IRQn Device specific interrupt number.

Returns: 0 Interrupt is not enabled.; 1 Interrupt is enabled.

Note: IRQn must not be negative.

References NVIC.

§ __NVIC_DisableIRQ()

__STATIC_INLINE void __NVIC_DisableIRQ ( IRQn_Type IRQn )

Disable Interrupt.

Disables a device specific interrupt in the NVIC interrupt controller.

Parameters

[in] IRQn Device specific interrupt number.

Note: IRQn must not be negative.

References __DSB(), __ISB(), and NVIC.

§ __NVIC_GetPendingIRQ()

__STATIC_INLINE uint32_t __NVIC_GetPendingIRQ ( IRQn_Type IRQn )

Get Pending Interrupt.

Reads the NVIC pending register and returns the pending bit for the specified device specific interrupt.

Parameters

[in] IRQn Device specific interrupt number.

Returns: 0 Interrupt status is not pending.; 1 Interrupt status is pending.

Note: IRQn must not be negative.

References NVIC.

§ __NVIC_SetPendingIRQ()

__STATIC_INLINE void __NVIC_SetPendingIRQ ( IRQn_Type IRQn )

Set Pending Interrupt.

Sets the pending bit of a device specific interrupt in the NVIC pending register.

Parameters

[in] IRQn Device specific interrupt number.

Note: IRQn must not be negative.

References NVIC.

§ __NVIC_ClearPendingIRQ()

__STATIC_INLINE void __NVIC_ClearPendingIRQ ( IRQn_Type IRQn )

Clear Pending Interrupt.

Clears the pending bit of a device specific interrupt in the NVIC pending register.

Parameters

[in] IRQn Device specific interrupt number.

Note: IRQn must not be negative.

References NVIC.

§ __NVIC_SetPriority()

__STATIC_INLINE void __NVIC_SetPriority	(	IRQn_Type	IRQn,
		uint32_t	priority
	)

Set Interrupt Priority.

Sets the priority of a device specific interrupt or a processor exception. The interrupt number can be positive to specify a device specific interrupt, or negative to specify a processor exception.

Parameters

[in]	IRQn	Interrupt number.
[in]	priority	Priority to set.

Note: The priority cannot be set for every processor exception.

References __NVIC_PRIO_BITS, _BIT_SHIFT, _IP_IDX, _SHP_IDX, NVIC, and SCB.

§ __NVIC_GetPriority()

__STATIC_INLINE uint32_t __NVIC_GetPriority ( IRQn_Type IRQn )

Get Interrupt Priority.

Reads the priority of a device specific interrupt or a processor exception. The interrupt number can be positive to specify a device specific interrupt, or negative to specify a processor exception.

Parameters

[in] IRQn Interrupt number.

Returns: Interrupt Priority. Value is aligned automatically to the implemented priority bits of the microcontroller.

References __NVIC_PRIO_BITS, _BIT_SHIFT, _IP_IDX, _SHP_IDX, NVIC, and SCB.

§ NVIC_EncodePriority()

__STATIC_INLINE uint32_t NVIC_EncodePriority	(	uint32_t	PriorityGroup,
		uint32_t	PreemptPriority,
		uint32_t	SubPriority
	)

Encode Priority.

Encodes the priority for an interrupt with the given priority group, preemptive priority value, and subpriority value. In case of a conflict between priority grouping and available priority bits (__NVIC_PRIO_BITS), the smallest possible priority group is set.

Parameters

[in]	PriorityGroup	Used priority group.
[in]	PreemptPriority	Preemptive priority value (starting from 0).
[in]	SubPriority	Subpriority value (starting from 0).

Returns: Encoded priority. Value can be used in the function NVIC_SetPriority().

References __NVIC_PRIO_BITS.

§ NVIC_DecodePriority()

__STATIC_INLINE void NVIC_DecodePriority	(	uint32_t	Priority,
		uint32_t	PriorityGroup,
		uint32_t *const	pPreemptPriority,
		uint32_t *const	pSubPriority
	)

Decode Priority.

Decodes an interrupt priority value with a given priority group to preemptive priority value and subpriority value. In case of a conflict between priority grouping and available priority bits (__NVIC_PRIO_BITS) the smallest possible priority group is set.

Parameters

[in]	Priority	Priority value, which can be retrieved with the function NVIC_GetPriority().
[in]	PriorityGroup	Used priority group.
[out]	pPreemptPriority	Preemptive priority value (starting from 0).
[out]	pSubPriority	Subpriority value (starting from 0).

References __NVIC_PRIO_BITS.

§ __NVIC_SetVector()

__STATIC_INLINE void __NVIC_SetVector	(	IRQn_Type	IRQn,
		uint32_t	vector
	)

Set Interrupt Vector.

Sets an interrupt vector in SRAM based interrupt vector table. The interrupt number can be positive to specify a device specific interrupt, or negative to specify a processor exception. VTOR must been relocated to SRAM before. If VTOR is not present address 0 must be mapped to SRAM.

Parameters

[in]	IRQn	Interrupt number
[in]	vector	Address of interrupt handler function

References NVIC_USER_IRQ_OFFSET, and SCB.

§ __NVIC_GetVector()

__STATIC_INLINE uint32_t __NVIC_GetVector ( IRQn_Type IRQn )

Get Interrupt Vector.

Reads an interrupt vector from interrupt vector table. The interrupt number can be positive to specify a device specific interrupt, or negative to specify a processor exception.

Parameters

[in] IRQn Interrupt number.

Returns: Address of interrupt handler function

References NVIC_USER_IRQ_OFFSET, and SCB.

§ __NVIC_SystemReset()

__NO_RETURN __STATIC_INLINE void __NVIC_SystemReset ( void )

System Reset.

Initiates a system reset request to reset the MCU.

References __DSB(), __NOP, SCB, SCB_AIRCR_SYSRESETREQ_Msk, and SCB_AIRCR_VECTKEY_Pos.

Macros

Functions

Detailed Description

Macro Definition Documentation

§ NVIC_SetPriorityGrouping

§ NVIC_GetPriorityGrouping

§ NVIC_EnableIRQ

§ NVIC_GetEnableIRQ

§ NVIC_DisableIRQ

§ NVIC_GetPendingIRQ

§ NVIC_SetPendingIRQ

§ NVIC_ClearPendingIRQ

§ NVIC_SetPriority

§ NVIC_GetPriority

§ NVIC_SystemReset

§ NVIC_SetVector

§ NVIC_GetVector

§ NVIC_USER_IRQ_OFFSET

§ EXC_RETURN_HANDLER

§ EXC_RETURN_THREAD_MSP

§ EXC_RETURN_THREAD_PSP

§ _BIT_SHIFT

§ _SHP_IDX

§ _IP_IDX

§ __NVIC_SetPriorityGrouping

§ __NVIC_GetPriorityGrouping

Function Documentation

§ __NVIC_EnableIRQ()

§ __NVIC_GetEnableIRQ()

§ __NVIC_DisableIRQ()

§ __NVIC_GetPendingIRQ()

§ __NVIC_SetPendingIRQ()

§ __NVIC_ClearPendingIRQ()

§ __NVIC_SetPriority()

§ __NVIC_GetPriority()

§ NVIC_EncodePriority()

§ NVIC_DecodePriority()

§ __NVIC_SetVector()

§ __NVIC_GetVector()

§ __NVIC_SystemReset()