arch/nrf5x/ids.h header reference
[nRF5X platform module]

The source code of this header can be browsed online.

Description  

nRF5x devices all look the same and regular. Device at address 0x4000000 has number 0 and interrupt 0, device at address 0x40001000 has number 1 and interrupt 1, and so on.

enum nrf5x_peripheral_id_e defines available peripheral IDs. All of them map to an address range, and an interrupt source to NVIC.

NRF_PERIPHERAL_ADDR and nrf_peripheral_addr allow to retrieve device base address, NRF_STATIC_RES_PERIPHERAL_MEM is a shortcut for declaring a DEV_STATIC_RES_MEM for a device.

Members  

Types  

Function  

Macros  

Members detail  

#define ARCH_NRF5X_IDS_H_  

This macro is declared in arch/nrf5x/ids.h source file, line 21.

#define NRF52_SAADC_PIN_CONFIG(gain_num, gain_denom, ref)  

This macro is declared in arch/nrf5x/ids.h source file, line 200.

#define NRF52_SAADC_PIN_CONFIG_EXTRACT(x)  

This macro is declared in arch/nrf5x/ids.h source file, line 205.

#define NRF52_SAADC_PIN_REF_0_6  

This macro is declared in arch/nrf5x/ids.h source file, line 197.

#define NRF52_SAADC_PIN_REF_VDD_4  

This macro is declared in arch/nrf5x/ids.h source file, line 198.

#define NRF_GPIO_RANGE_IRQ_ID  

This macro is declared in arch/nrf5x/ids.h source file, line 167.

this macro is the input range interrupt endpoint ID in GPIO driver.

#define NRF_PERIPHERAL_ADDR(no)  

This macro is declared in arch/nrf5x/ids.h source file, line 54.

this macro statically computes the device base address from its device number.

See also nrf_peripheral_addr.

#define NRF_PERIPHERAL_ID(addr)  

This macro is declared in arch/nrf5x/ids.h source file, line 60.

this macro statically retrieves device ID from its base address. Address is assumed to be existing.

#define NRF_STATIC_RES_PERIPHERAL_MEM(x)  

This macro is declared in arch/nrf5x/ids.h source file, line 66.

this macro expands to DEV_STATIC_RES_MEM for a given peripheral ID.

enum nrf5x_clock_id_e  

This enum is declared in arch/nrf5x/ids.h source file, line 180.

this enum defines identifiers for nRF51/nRF52 clocks.

IdentifierDescription
NRF_CLOCK_SRC_LFCLK
NRF_CLOCK_SRC_HFCLK
NRF_CLOCK_SRC_USB_VBUS
NRF_CLOCK_SRC_USB_REG
NRF_CLOCK_SRC_COUNT
NRF_CLOCK_OSC_LFRC
NRF_CLOCK_OSC_LFRC_ULP
NRF_CLOCK_OSC_HFRC
NRF_CLOCK_OSC_HFXO
NRF_CLOCK_OSC_LFXO
NRF_CLOCK_NODE_COUNT

enum nrf5x_peripheral_id_e  

This enum is declared in arch/nrf5x/ids.h source file, line 84.

this enum defines the list of peripheral IDs for nRF51/nRF52 chips.

IdentifierDescription
NRF5X_POWER
NRF5X_CLOCK
NRF5X_RADIO
NRF5X_UART0
NRF5X_SPI0
NRF5X_TWI0
NRF5X_SPI1
NRF5X_TWI1
NRF5X_SPIS1
NRF5X_GPIOTE
NRF5X_ADC
NRF5X_TIMER0
NRF5X_TIMER1
NRF5X_TIMER2
NRF5X_RTC0
NRF5X_TEMP
NRF5X_RNG
NRF5X_ECB
NRF5X_CCM
NRF5X_AAR
NRF5X_WDT
NRF5X_RTC1
NRF5X_QDEC
NRF5X_LPCOMP
NRF5X_NVMC
NRF5X_PPI
NRF5X_BPROT
NRF5X_UARTE0
NRF5X_SPIM0
NRF5X_TWIM0
NRF5X_TWIS0
NRF5X_SPIS0
NRF5X_SPIM1
NRF5X_TWIM1
NRF5X_TWIS1
NRF5X_NFCT
NRF5X_SAADC
NRF5X_COMP
NRF5X_EGU0
NRF5X_SWI0
NRF5X_EGU1
NRF5X_SWI1
NRF5X_EGU2
NRF5X_SWI2
NRF5X_EGU3
NRF5X_SWI3
NRF5X_EGU4
NRF5X_SWI4
NRF5X_EGU5
NRF5X_SWI5
NRF5X_TIMER3
NRF5X_TIMER4
NRF5X_PWM0
NRF5X_PDM
NRF5X_ACL
NRF5X_MWU
NRF5X_PWM1
NRF5X_PWM2
NRF5X_SPI2
NRF5X_SPIS2
NRF5X_SPIM2
NRF5X_RTC2
NRF5X_I2S
NRF5X_FPU
NRF5X_USBD
NRF5X_UARTE
NRF5X_QSPI
NRF5X_CRYPTOCELL
NRF5X_SPIM
NRF5X_PWM

enum nrf5x_radio_clock_sink_e  

This enum is declared in arch/nrf5x/ids.h source file, line 223.

this enum defines clock sinks for the nRF51/nRF52 radio driver.

IdentifierDescription
NRF5X_BLE_CLK_SLEEP
NRF5X_BLE_CLK_RADIO
NRF5X_BLE_CLK_COUNT

enum nrf5x_radio_device_mode_e  

This enum is declared in arch/nrf5x/ids.h source file, line 233.

this enum defines device modes for radio driver

IdentifierDescription
NRF5X_BLE_MODE_IDLE
NRF5X_BLE_MODE_WAIT
NRF5X_BLE_MODE_RADIO

enum nrf5x_radio_irq_source_id_e  

This enum is declared in arch/nrf5x/ids.h source file, line 212.

this enum defines IRQ sources for the nRF51/nRF52 radio driver.

IdentifierDescription
NRF5X_BLE_IRQ_RADIO
NRF5X_BLE_IRQ_TIMER
NRF5X_BLE_IRQ_RTC
NRF5X_BLE_IRQ_COUNT

enum nrf5x_usbd_device_mode_e  

This enum is declared in arch/nrf5x/ids.h source file, line 254.

this enum defines device modes for USB driver

IdentifierDescription
NRF5X_USBD_MODE_IDLE
NRF5X_USBD_MODE_RUNNING

enum nrf5x_usdb_clock_sink_e  

This enum is declared in arch/nrf5x/ids.h source file, line 243.

this enum defines clock sinks for the nRF52840 USB driver.

IdentifierDescription
NRF5X_USBD_CLK_USB_VBUS
NRF5X_USBD_CLK_USB_REG
NRF5X_USBD_CLK_HFCLK
NRF5X_USBD_CLK_COUNT

uintptr_t nrf_peripheral_addr(uint8_t no)  

This function is declared in arch/nrf5x/ids.h source file, line 76.

this function computes the device base address from its device number.

See also NRF_PERIPHERAL_ADDR.

Valid XHTML 1.0 StrictGenerated by diaxen on Wed Oct 17 21:18:37 2018 using MkDoc