Hilscher netX microcontroller driver
V0.0.5.0
Documentation of the netX driver package
|
Macros | |
#define | __NOP __nop |
No Operation. More... | |
#define | __WFI __wfi |
Wait For Interrupt. More... | |
#define | __WFE __wfe |
Wait For Event. More... | |
#define | __SEV __sev |
Send Event. More... | |
#define | __ISB() |
Instruction Synchronization Barrier. More... | |
#define | __DSB() |
Data Synchronization Barrier. More... | |
#define | __DMB() |
Data Memory Barrier. More... | |
#define | __REV __rev |
Reverse byte order (32 bit) More... | |
#define | __ROR __ror |
Rotate Right in unsigned value (32 bit) More... | |
#define | __BKPT(value) __breakpoint(value) |
Breakpoint. More... | |
#define | __CLZ __clz |
Count leading zeros. More... | |
#define | __CMSIS_GCC_OUT_REG(r) "=r" (r) |
#define | __CMSIS_GCC_USE_REG(r) "r" (r) |
#define | __NOP __builtin_arm_nop |
No Operation. More... | |
#define | __WFI __builtin_arm_wfi |
Wait For Interrupt. More... | |
#define | __WFE __builtin_arm_wfe |
Wait For Event. More... | |
#define | __SEV __builtin_arm_sev |
Send Event. More... | |
#define | __ISB() __builtin_arm_isb(0xF); |
Instruction Synchronization Barrier. More... | |
#define | __DSB() __builtin_arm_dsb(0xF); |
Data Synchronization Barrier. More... | |
#define | __DMB() __builtin_arm_dmb(0xF); |
Data Memory Barrier. More... | |
#define | __REV(value) __builtin_bswap32(value) |
Reverse byte order (32 bit) More... | |
#define | __REV16(value) __ROR(__REV(value), 16) |
Reverse byte order (16 bit) More... | |
#define | __REVSH(value) (int16_t)__builtin_bswap16(value) |
Reverse byte order (16 bit) More... | |
#define | __BKPT(value) __ASM volatile ("bkpt "#value) |
Breakpoint. More... | |
#define | __RBIT __builtin_arm_rbit |
Reverse bit order of value. More... | |
#define | __CLZ (uint8_t)__builtin_clz |
Count leading zeros. More... | |
#define | __CMSIS_GCC_OUT_REG(r) "=r" (r) |
#define | __CMSIS_GCC_RW_REG(r) "+r" (r) |
#define | __CMSIS_GCC_USE_REG(r) "r" (r) |
#define | __NOP() __ASM volatile ("nop") |
No Operation. More... | |
#define | __WFI() __ASM volatile ("wfi") |
Wait For Interrupt. More... | |
#define | __WFE() __ASM volatile ("wfe") |
Wait For Event. More... | |
#define | __SEV() __ASM volatile ("sev") |
Send Event. More... | |
#define | __BKPT(value) __ASM volatile ("bkpt "#value) |
Breakpoint. More... | |
#define | __CLZ (uint8_t)__builtin_clz |
Count leading zeros. More... | |
Functions | |
__STATIC_INLINE __ASM uint32_t | __REV16 (uint32_t value) |
Reverse byte order (16 bit) More... | |
__STATIC_INLINE __ASM int16_t | __REVSH (int16_t value) |
Reverse byte order (16 bit) More... | |
__STATIC_INLINE uint32_t | __RBIT (uint32_t value) |
Reverse bit order of value. More... | |
__STATIC_INLINE int32_t | __SSAT (int32_t val, uint32_t sat) |
Signed Saturate. More... | |
__STATIC_INLINE uint32_t | __USAT (int32_t val, uint32_t sat) |
Unsigned Saturate. More... | |
__STATIC_FORCEINLINE uint32_t | __ROR (uint32_t op1, uint32_t op2) |
Rotate Right in unsigned value (32 bit) More... | |
__STATIC_FORCEINLINE void | __ISB (void) |
Instruction Synchronization Barrier. More... | |
__STATIC_FORCEINLINE void | __DSB (void) |
Data Synchronization Barrier. More... | |
__STATIC_FORCEINLINE void | __DMB (void) |
Data Memory Barrier. More... | |
__STATIC_FORCEINLINE uint32_t | __REV (uint32_t value) |
Reverse byte order (32 bit) More... | |
Access to dedicated instructions
#define __BKPT | ( | value | ) | __breakpoint(value) |
Breakpoint.
Causes the processor to enter Debug state. Debug tools can use this to investigate system state when the instruction at a particular address is reached.
[in] | value | is ignored by the processor. If required, a debugger can use it to store additional information about the breakpoint. |
Definition at line 508 of file cmsis_armcc.h.
#define __BKPT | ( | value | ) | __ASM volatile ("bkpt "#value) |
Breakpoint.
Causes the processor to enter Debug state. Debug tools can use this to investigate system state when the instruction at a particular address is reached.
[in] | value | is ignored by the processor. If required, a debugger can use it to store additional information about the breakpoint. |
Definition at line 902 of file cmsis_armclang.h.
#define __BKPT | ( | value | ) | __ASM volatile ("bkpt "#value) |
Breakpoint.
Causes the processor to enter Debug state. Debug tools can use this to investigate system state when the instruction at a particular address is reached.
[in] | value | is ignored by the processor. If required, a debugger can use it to store additional information about the breakpoint. |
Definition at line 975 of file cmsis_gcc.h.
#define __CLZ __clz |
Count leading zeros.
Counts the number of leading zeros of a data value.
[in] | value | Value to count the leading zeros |
Definition at line 545 of file cmsis_armcc.h.
#define __CLZ (uint8_t)__builtin_clz |
Count leading zeros.
Counts the number of leading zeros of a data value.
[in] | value | Value to count the leading zeros |
Definition at line 919 of file cmsis_armclang.h.
#define __CLZ (uint8_t)__builtin_clz |
Count leading zeros.
Counts the number of leading zeros of a data value.
[in] | value | Value to count the leading zeros |
Definition at line 1014 of file cmsis_gcc.h.
#define __CMSIS_GCC_OUT_REG | ( | r | ) | "=r" (r) |
Definition at line 794 of file cmsis_armclang.h.
#define __CMSIS_GCC_OUT_REG | ( | r | ) | "=r" (r) |
Definition at line 830 of file cmsis_gcc.h.
#define __CMSIS_GCC_RW_REG | ( | r | ) | "+r" (r) |
Definition at line 831 of file cmsis_gcc.h.
#define __CMSIS_GCC_USE_REG | ( | r | ) | "r" (r) |
Definition at line 795 of file cmsis_armclang.h.
#define __CMSIS_GCC_USE_REG | ( | r | ) | "r" (r) |
Definition at line 832 of file cmsis_gcc.h.
#define __DMB | ( | void | ) |
Data Memory Barrier.
Ensures the apparent order of the explicit memory operations before and after the instruction, without ensuring their completion.
Definition at line 445 of file cmsis_armcc.h.
#define __DMB | ( | void | ) | __builtin_arm_dmb(0xF); |
Data Memory Barrier.
Ensures the apparent order of the explicit memory operations before and after the instruction, without ensuring their completion.
Definition at line 847 of file cmsis_armclang.h.
#define __DSB | ( | void | ) |
Data Synchronization Barrier.
Acts as a special kind of Data Memory Barrier. It completes when all explicit memory accesses before this instruction complete.
Definition at line 434 of file cmsis_armcc.h.
#define __DSB | ( | void | ) | __builtin_arm_dsb(0xF); |
Data Synchronization Barrier.
Acts as a special kind of Data Memory Barrier. It completes when all explicit memory accesses before this instruction complete.
Definition at line 839 of file cmsis_armclang.h.
#define __ISB | ( | void | ) |
Instruction Synchronization Barrier.
Instruction Synchronization Barrier flushes the pipeline in the processor, so that all instructions following the ISB are fetched from cache or memory, after the instruction has been completed.
Definition at line 423 of file cmsis_armcc.h.
#define __ISB | ( | void | ) | __builtin_arm_isb(0xF); |
Instruction Synchronization Barrier.
Instruction Synchronization Barrier flushes the pipeline in the processor, so that all instructions following the ISB are fetched from cache or memory, after the instruction has been completed.
Definition at line 832 of file cmsis_armclang.h.
#define __NOP __nop |
No Operation.
No Operation does nothing. This instruction can be used for code alignment purposes.
Definition at line 392 of file cmsis_armcc.h.
#define __NOP __builtin_arm_nop |
No Operation.
No Operation does nothing. This instruction can be used for code alignment purposes.
Definition at line 802 of file cmsis_armclang.h.
#define __NOP | ( | ) | __ASM volatile ("nop") |
No Operation.
No Operation does nothing. This instruction can be used for code alignment purposes.
Definition at line 839 of file cmsis_gcc.h.
#define __RBIT __builtin_arm_rbit |
Reverse bit order of value.
Reverses the bit order of the given value.
[in] | value | Value to reverse |
Definition at line 911 of file cmsis_armclang.h.
#define __REV __rev |
Reverse byte order (32 bit)
Reverses the byte order in unsigned integer value. For example, 0x12345678 becomes 0x78563412.
[in] | value | Value to reverse |
Definition at line 458 of file cmsis_armcc.h.
#define __REV | ( | value | ) | __builtin_bswap32(value) |
Reverse byte order (32 bit)
Reverses the byte order in unsigned integer value. For example, 0x12345678 becomes 0x78563412.
[in] | value | Value to reverse |
Definition at line 856 of file cmsis_armclang.h.
Reverse byte order (16 bit)
Reverses the byte order within each halfword of a word. For example, 0x12345678 becomes 0x34127856.
[in] | value | Value to reverse |
Definition at line 865 of file cmsis_armclang.h.
#define __REVSH | ( | value | ) | (int16_t)__builtin_bswap16(value) |
Reverse byte order (16 bit)
Reverses the byte order in a 16-bit value and returns the signed 16-bit result. For example, 0x0080 becomes 0x8000.
[in] | value | Value to reverse |
Definition at line 874 of file cmsis_armclang.h.
#define __ROR __ror |
Rotate Right in unsigned value (32 bit)
Rotate Right (immediate) provides the value of the contents of a register rotated by a variable number of bits.
[in] | op1 | Value to rotate |
[in] | op2 | Number of Bits to rotate |
Definition at line 498 of file cmsis_armcc.h.
#define __SEV __sev |
Send Event.
Send Event is a hint instruction. It causes an event to be signaled to the CPU.
Definition at line 414 of file cmsis_armcc.h.
#define __SEV __builtin_arm_sev |
Send Event.
Send Event is a hint instruction. It causes an event to be signaled to the CPU.
Definition at line 823 of file cmsis_armclang.h.
#define __SEV | ( | ) | __ASM volatile ("sev") |
Send Event.
Send Event is a hint instruction. It causes an event to be signaled to the CPU.
Definition at line 860 of file cmsis_gcc.h.
#define __WFE __wfe |
Wait For Event.
Wait For Event is a hint instruction that permits the processor to enter a low-power state until one of a number of events occurs.
Definition at line 407 of file cmsis_armcc.h.
#define __WFE __builtin_arm_wfe |
Wait For Event.
Wait For Event is a hint instruction that permits the processor to enter a low-power state until one of a number of events occurs.
Definition at line 816 of file cmsis_armclang.h.
#define __WFE | ( | ) | __ASM volatile ("wfe") |
Wait For Event.
Wait For Event is a hint instruction that permits the processor to enter a low-power state until one of a number of events occurs.
Definition at line 853 of file cmsis_gcc.h.
#define __WFI __wfi |
Wait For Interrupt.
Wait For Interrupt is a hint instruction that suspends execution until one of a number of events occurs.
Definition at line 399 of file cmsis_armcc.h.
#define __WFI __builtin_arm_wfi |
Wait For Interrupt.
Wait For Interrupt is a hint instruction that suspends execution until one of a number of events occurs.
Definition at line 808 of file cmsis_armclang.h.
#define __WFI | ( | ) | __ASM volatile ("wfi") |
Wait For Interrupt.
Wait For Interrupt is a hint instruction that suspends execution until one of a number of events occurs.
Definition at line 845 of file cmsis_gcc.h.
__STATIC_FORCEINLINE void __DMB | ( | void | ) |
Data Memory Barrier.
Ensures the apparent order of the explicit memory operations before and after the instruction, without ensuring their completion.
Definition at line 891 of file cmsis_gcc.h.
__STATIC_FORCEINLINE void __DSB | ( | void | ) |
Data Synchronization Barrier.
Acts as a special kind of Data Memory Barrier. It completes when all explicit memory accesses before this instruction complete.
Definition at line 880 of file cmsis_gcc.h.
__STATIC_FORCEINLINE void __ISB | ( | void | ) |
Instruction Synchronization Barrier.
Instruction Synchronization Barrier flushes the pipeline in the processor, so that all instructions following the ISB are fetched from cache or memory, after the instruction has been completed.
Definition at line 869 of file cmsis_gcc.h.
__STATIC_FORCEINLINE uint32_t __RBIT | ( | uint32_t | value | ) |
Reverse bit order of value.
Reverses the bit order of the given value.
[in] | value | Value to reverse |
Definition at line 521 of file cmsis_armcc.h.
__STATIC_FORCEINLINE uint32_t __REV | ( | uint32_t | value | ) |
Reverse byte order (32 bit)
Reverses the byte order in unsigned integer value. For example, 0x12345678 becomes 0x78563412.
[in] | value | Value to reverse |
Definition at line 903 of file cmsis_gcc.h.
__STATIC_FORCEINLINE uint32_t __REV16 | ( | uint32_t | value | ) |
Reverse byte order (16 bit)
Reverses the byte order within each halfword of a word. For example, 0x12345678 becomes 0x34127856.
[in] | value | Value to reverse |
Definition at line 468 of file cmsis_armcc.h.
__STATIC_FORCEINLINE int16_t __REVSH | ( | int16_t | value | ) |
Reverse byte order (16 bit)
Reverses the byte order in a 16-bit value and returns the signed 16-bit result. For example, 0x0080 becomes 0x8000.
[in] | value | Value to reverse |
Definition at line 483 of file cmsis_armcc.h.
__STATIC_FORCEINLINE uint32_t __ROR | ( | uint32_t | op1, |
uint32_t | op2 | ||
) |
Rotate Right in unsigned value (32 bit)
Rotate Right (immediate) provides the value of the contents of a register rotated by a variable number of bits.
[in] | op1 | Value to rotate |
[in] | op2 | Number of Bits to rotate |
Definition at line 884 of file cmsis_armclang.h.
__STATIC_FORCEINLINE int32_t __SSAT | ( | int32_t | val, |
uint32_t | sat | ||
) |
Signed Saturate.
Saturates a signed value.
[in] | value | Value to be saturated |
[in] | sat | Bit position to saturate to (1..32) |
Definition at line 741 of file cmsis_armcc.h.
__STATIC_FORCEINLINE uint32_t __USAT | ( | int32_t | val, |
uint32_t | sat | ||
) |
Unsigned Saturate.
Saturates an unsigned value.
[in] | value | Value to be saturated |
[in] | sat | Bit position to saturate to (0..31) |
Definition at line 766 of file cmsis_armcc.h.