![]() |
nrfx 4.5.0
|
Hardware access layer for managing the SPIS peripheral. More...
Macros | |
| #define | NRF_SPIS_HAS_DMA_REG 1 |
| Symbol indicating whether dedicated DMA register is present. | |
| #define | NRF_SPIS_HAS_TX_LIST 1 |
| Symbol indicating whether TX list is present. | |
| #define | NRF_SPIS_HAS_RX_LIST 1 |
| Symbol indicating whether RX list is present. | |
| #define | NRF_SPIS_HAS_DMA_TASKS_EVENTS 1 |
| Symbol indicating whether SPIS DMA tasks and events are present. | |
| #define | NRF_SPIS_DMA_RX_PATTERN_MAX_COUNT SPIS_DMA_RX_MATCH_CANDIDATE_MaxCount |
| Maximum number of RX patterns. | |
| #define | NRF_SPIS_INST_GET(idx) |
| Macro getting pointer to the structure of registers of the SPIS peripheral. | |
| #define | NRF_SPIS_PIN_NOT_CONNECTED UINT32_MAX |
| This value can be used as a parameter for the nrf_spis_pins_set function to specify that a given SPI signal (SCK, MOSI, or MISO) shall not be connected to a physical pin. | |
Enumerations | |
| enum | nrf_spis_task_t { NRF_SPIS_TASK_ACQUIRE = offsetof(NRF_SPIS_Type, TASKS_ACQUIRE) , NRF_SPIS_TASK_RELEASE = offsetof(NRF_SPIS_Type, TASKS_RELEASE) , NRF_SPIS_TASK_ENABLERXMATCH0 = offsetof(NRF_SPIS_Type, TASKS_DMA.RX.ENABLEMATCH[0]) , NRF_SPIS_TASK_ENABLERXMATCH1 = offsetof(NRF_SPIS_Type, TASKS_DMA.RX.ENABLEMATCH[1]) , NRF_SPIS_TASK_ENABLERXMATCH2 = offsetof(NRF_SPIS_Type, TASKS_DMA.RX.ENABLEMATCH[2]) , NRF_SPIS_TASK_ENABLERXMATCH3 = offsetof(NRF_SPIS_Type, TASKS_DMA.RX.ENABLEMATCH[3]) , NRF_SPIS_TASK_DISABLERXMATCH0 = offsetof(NRF_SPIS_Type, TASKS_DMA.RX.DISABLEMATCH[0]) , NRF_SPIS_TASK_DISABLERXMATCH1 = offsetof(NRF_SPIS_Type, TASKS_DMA.RX.DISABLEMATCH[1]) , NRF_SPIS_TASK_DISABLERXMATCH2 = offsetof(NRF_SPIS_Type, TASKS_DMA.RX.DISABLEMATCH[2]) , NRF_SPIS_TASK_DISABLERXMATCH3 = offsetof(NRF_SPIS_Type, TASKS_DMA.RX.DISABLEMATCH[3]) } |
| SPIS tasks. More... | |
| enum | nrf_spis_event_t { NRF_SPIS_EVENT_RXSTARTED = offsetof(NRF_SPIS_Type, EVENTS_DMA.RX.READY) , NRF_SPIS_EVENT_RXBUSERROR = offsetof(NRF_SPIS_Type, EVENTS_DMA.RX.BUSERROR) , NRF_SPIS_EVENT_RXMATCH0 = offsetof(NRF_SPIS_Type, EVENTS_DMA.RX.MATCH[0]) , NRF_SPIS_EVENT_RXMATCH1 = offsetof(NRF_SPIS_Type, EVENTS_DMA.RX.MATCH[1]) , NRF_SPIS_EVENT_RXMATCH2 = offsetof(NRF_SPIS_Type, EVENTS_DMA.RX.MATCH[2]) , NRF_SPIS_EVENT_RXMATCH3 = offsetof(NRF_SPIS_Type, EVENTS_DMA.RX.MATCH[3]) , NRF_SPIS_EVENT_TXSTARTED = offsetof(NRF_SPIS_Type, EVENTS_DMA.TX.READY) , NRF_SPIS_EVENT_TXBUSERROR = offsetof(NRF_SPIS_Type, EVENTS_DMA.TX.BUSERROR) , NRF_SPIS_EVENT_ENDRX = offsetof(NRF_SPIS_Type, EVENTS_DMA.RX.END) , NRF_SPIS_EVENT_ENDTX = offsetof(NRF_SPIS_Type, EVENTS_DMA.TX.END) , NRF_SPIS_EVENT_END = offsetof(NRF_SPIS_Type, EVENTS_END) , NRF_SPIS_EVENT_ACQUIRED = offsetof(NRF_SPIS_Type, EVENTS_ACQUIRED) } |
| SPIS events. More... | |
| enum | nrf_spis_short_mask_t { NRF_SPIS_SHORT_END_ACQUIRE = SPIS_SHORTS_END_ACQUIRE_Msk , NRF_SPIS_SHORT_RXMATCH0_ENABLERXMATCH1_MASK = SPIS_SHORTS_DMA_RX_MATCH0_DMA_RX_ENABLEMATCH1_Msk , NRF_SPIS_SHORT_RXMATCH1_ENABLERXMATCH2_MASK = SPIS_SHORTS_DMA_RX_MATCH1_DMA_RX_ENABLEMATCH2_Msk , NRF_SPIS_SHORT_RXMATCH2_ENABLERXMATCH3_MASK = SPIS_SHORTS_DMA_RX_MATCH2_DMA_RX_ENABLEMATCH3_Msk , NRF_SPIS_SHORT_RXMATCH3_ENABLERXMATCH0_MASK = SPIS_SHORTS_DMA_RX_MATCH3_DMA_RX_ENABLEMATCH0_Msk , NRF_SPIS_SHORT_RXMATCH0_DISABLERXMATCH0_MASK = SPIS_SHORTS_DMA_RX_MATCH0_DMA_RX_DISABLEMATCH0_Msk , NRF_SPIS_SHORT_RXMATCH1_DISABLERXMATCH1_MASK = SPIS_SHORTS_DMA_RX_MATCH1_DMA_RX_DISABLEMATCH1_Msk , NRF_SPIS_SHORT_RXMATCH2_DISABLERXMATCH2_MASK = SPIS_SHORTS_DMA_RX_MATCH2_DMA_RX_DISABLEMATCH2_Msk , NRF_SPIS_SHORT_RXMATCH3_DISABLERXMATCH3_MASK = SPIS_SHORTS_DMA_RX_MATCH3_DMA_RX_DISABLEMATCH3_Msk , NRF_SPIS_ALL_SHORTS_MASK } |
| SPIS shortcuts. More... | |
| enum | nrf_spis_int_mask_t { NRF_SPIS_INT_END_MASK = SPIS_INTENSET_END_Msk , NRF_SPIS_INT_ACQUIRED_MASK = SPIS_INTENSET_ACQUIRED_Msk , NRF_SPIS_INT_RXREADY_MASK = SPIS_INTENSET_DMARXREADY_Msk , NRF_SPIS_INT_RXBUSERROR_MASK = SPIS_INTENSET_DMARXBUSERROR_Msk , NRF_SPIS_INT_RXMATCH0_MASK = SPIS_INTENSET_DMARXMATCH0_Msk , NRF_SPIS_INT_RXMATCH1_MASK = SPIS_INTENSET_DMARXMATCH1_Msk , NRF_SPIS_INT_RXMATCH2_MASK = SPIS_INTENSET_DMARXMATCH2_Msk , NRF_SPIS_INT_RXMATCH3_MASK = SPIS_INTENSET_DMARXMATCH3_Msk , NRF_SPIS_INT_TXREADY_MASK = SPIS_INTENSET_DMATXREADY_Msk , NRF_SPIS_INT_TXBUSERROR_MASK = SPIS_INTENSET_DMATXBUSERROR_Msk , NRF_SPIS_INT_ENDRX_MASK = SPIS_INTENSET_DMARXEND_Msk , NRF_SPIS_INT_ENDTX_MASK = SPIS_INTENSET_DMATXEND_Msk , NRF_SPIS_ALL_INTS_MASK } |
| SPIS interrupts. More... | |
| enum | nrf_spis_mode_t { NRF_SPIS_MODE_0 , NRF_SPIS_MODE_1 , NRF_SPIS_MODE_2 , NRF_SPIS_MODE_3 } |
| SPI modes. More... | |
| enum | nrf_spis_bit_order_t { NRF_SPIS_BIT_ORDER_MSB_FIRST = SPIS_CONFIG_ORDER_MsbFirst , NRF_SPIS_BIT_ORDER_LSB_FIRST = SPIS_CONFIG_ORDER_LsbFirst } |
| SPI bit orders. More... | |
| enum | nrf_spis_semstat_t { NRF_SPIS_SEMSTAT_FREE = 0 , NRF_SPIS_SEMSTAT_CPU = 1 , NRF_SPIS_SEMSTAT_SPIS = 2 , NRF_SPIS_SEMSTAT_CPUPENDING = 3 } |
| SPI semaphore status. More... | |
| enum | nrf_spis_status_mask_t { NRF_SPIS_STATUS_OVERREAD = SPIS_STATUS_OVERREAD_Msk , NRF_SPIS_STATUS_OVERFLOW = SPIS_STATUS_OVERFLOW_Msk } |
| SPIS status. More... | |
Functions | |
| NRF_STATIC_INLINE void | nrf_spis_task_trigger (NRF_SPIS_Type *p_reg, nrf_spis_task_t task) |
| Function for activating the specified SPIS task. | |
| NRF_STATIC_INLINE uint32_t | nrf_spis_task_address_get (NRF_SPIS_Type const *p_reg, nrf_spis_task_t task) |
| Function for getting the address of the specified SPIS task register. | |
| NRF_STATIC_INLINE void | nrf_spis_event_clear (NRF_SPIS_Type *p_reg, nrf_spis_event_t event) |
| Function for clearing the specified SPIS event. | |
| NRF_STATIC_INLINE bool | nrf_spis_event_check (NRF_SPIS_Type const *p_reg, nrf_spis_event_t event) |
| Function for retrieving the state of the SPIS event. | |
| NRF_STATIC_INLINE uint32_t | nrf_spis_event_address_get (NRF_SPIS_Type const *p_reg, nrf_spis_event_t event) |
| Function for getting the address of the specified SPIS event register. | |
| NRF_STATIC_INLINE void | nrf_spis_shorts_enable (NRF_SPIS_Type *p_reg, uint32_t mask) |
| Function for enabling the specified shortcuts. | |
| NRF_STATIC_INLINE void | nrf_spis_shorts_disable (NRF_SPIS_Type *p_reg, uint32_t mask) |
| Function for disabling the specified shortcuts. | |
| NRF_STATIC_INLINE void | nrf_spis_int_enable (NRF_SPIS_Type *p_reg, uint32_t mask) |
| Function for enabling the specified interrupts. | |
| NRF_STATIC_INLINE void | nrf_spis_int_disable (NRF_SPIS_Type *p_reg, uint32_t mask) |
| Function for disabling the specified interrupts. | |
| NRF_STATIC_INLINE uint32_t | nrf_spis_int_enable_check (NRF_SPIS_Type const *p_reg, uint32_t mask) |
| Function for checking if the specified interrupts are enabled. | |
| NRF_STATIC_INLINE void | nrf_spis_subscribe_set (NRF_SPIS_Type *p_reg, nrf_spis_task_t task, uint8_t channel) |
| Function for setting the subscribe configuration for a given SPIS task. | |
| NRF_STATIC_INLINE void | nrf_spis_subscribe_clear (NRF_SPIS_Type *p_reg, nrf_spis_task_t task) |
| Function for clearing the subscribe configuration for a given SPIS task. | |
| NRF_STATIC_INLINE uint32_t | nrf_spis_subscribe_get (NRF_SPIS_Type const *p_reg, nrf_spis_task_t task) |
| Function for getting the subscribe configuration for a given SPIS task. | |
| NRF_STATIC_INLINE void | nrf_spis_publish_set (NRF_SPIS_Type *p_reg, nrf_spis_event_t event, uint8_t channel) |
| Function for setting the publish configuration for a given SPIS event. | |
| NRF_STATIC_INLINE void | nrf_spis_publish_clear (NRF_SPIS_Type *p_reg, nrf_spis_event_t event) |
| Function for clearing the publish configuration for a given SPIS event. | |
| NRF_STATIC_INLINE uint32_t | nrf_spis_publish_get (NRF_SPIS_Type const *p_reg, nrf_spis_event_t event) |
| Function for getting the publish configuration for a given SPIS event. | |
| NRF_STATIC_INLINE void | nrf_spis_enable (NRF_SPIS_Type *p_reg) |
| Function for enabling the SPIS peripheral. | |
| NRF_STATIC_INLINE void | nrf_spis_disable (NRF_SPIS_Type *p_reg) |
| Function for disabling the SPIS peripheral. | |
| NRF_STATIC_INLINE bool | nrf_spis_enable_check (NRF_SPIS_Type const *p_reg) |
| Function for checking if the SPIS peripheral is enabled. | |
| NRF_STATIC_INLINE nrf_spis_semstat_t | nrf_spis_semaphore_status_get (NRF_SPIS_Type const *p_reg) |
| Function for retrieving the SPIS semaphore status. | |
| NRF_STATIC_INLINE nrf_spis_status_mask_t | nrf_spis_status_get (NRF_SPIS_Type const *p_reg) |
| Function for retrieving the SPIS status. | |
| NRF_STATIC_INLINE void | nrf_spis_pins_set (NRF_SPIS_Type *p_reg, uint32_t sck_pin, uint32_t mosi_pin, uint32_t miso_pin, uint32_t csn_pin) |
| Function for configuring SPIS pins. | |
| NRF_STATIC_INLINE void | nrf_spis_sck_pin_set (NRF_SPIS_Type *p_reg, uint32_t pin) |
| Function for setting the SCK pin. | |
| NRF_STATIC_INLINE void | nrf_spis_mosi_pin_set (NRF_SPIS_Type *p_reg, uint32_t pin) |
| Function for setting the MOSI pin. | |
| NRF_STATIC_INLINE void | nrf_spis_miso_pin_set (NRF_SPIS_Type *p_reg, uint32_t pin) |
| Function for setting the MISO pin. | |
| NRF_STATIC_INLINE void | nrf_spis_csn_pin_set (NRF_SPIS_Type *p_reg, uint32_t pin) |
| Function for setting the CSN pin. | |
| NRF_STATIC_INLINE uint32_t | nrf_spis_sck_pin_get (NRF_SPIS_Type const *p_reg) |
| Function for getting the SCK pin selection. | |
| NRF_STATIC_INLINE uint32_t | nrf_spis_mosi_pin_get (NRF_SPIS_Type const *p_reg) |
| Function for getting the MOSI pin selection. | |
| NRF_STATIC_INLINE uint32_t | nrf_spis_miso_pin_get (NRF_SPIS_Type const *p_reg) |
| Function for getting the MISO pin selection. | |
| NRF_STATIC_INLINE uint32_t | nrf_spis_csn_pin_get (NRF_SPIS_Type const *p_reg) |
| Function for getting the CSN pin selection. | |
| NRF_STATIC_INLINE void | nrf_spis_tx_buffer_set (NRF_SPIS_Type *p_reg, uint8_t const *p_buffer, size_t length) |
| Function for setting the transmit buffer. | |
| NRF_STATIC_INLINE void | nrf_spis_rx_buffer_set (NRF_SPIS_Type *p_reg, uint8_t *p_buffer, size_t length) |
| Function for setting the receive buffer. | |
| NRF_STATIC_INLINE uint8_t * | nrf_spis_tx_buffer_get (NRF_SPIS_Type *p_reg) |
| Function for getting the transmit buffer. | |
| NRF_STATIC_INLINE uint8_t * | nrf_spis_rx_buffer_get (NRF_SPIS_Type *p_reg) |
| Function for getting the receive buffer. | |
| NRF_STATIC_INLINE size_t | nrf_spis_tx_maxcnt_get (NRF_SPIS_Type *p_reg) |
| Function for getting the transmit buffer size. | |
| NRF_STATIC_INLINE size_t | nrf_spis_rx_maxcnt_get (NRF_SPIS_Type *p_reg) |
| Function for getting the receive buffer size. | |
| NRF_STATIC_INLINE size_t | nrf_spis_tx_amount_get (NRF_SPIS_Type const *p_reg) |
| Function for getting the number of bytes transmitted in the last granted transaction. | |
| NRF_STATIC_INLINE size_t | nrf_spis_rx_amount_get (NRF_SPIS_Type const *p_reg) |
| Function for getting the number of bytes received in the last granted transaction. | |
| NRF_STATIC_INLINE void | nrf_spis_configure (NRF_SPIS_Type *p_reg, nrf_spis_mode_t spi_mode, nrf_spis_bit_order_t spi_bit_order) |
| Function for setting the SPI configuration. | |
| NRF_STATIC_INLINE void | nrf_spis_def_set (NRF_SPIS_Type *p_reg, uint8_t def) |
| Function for setting the default character. | |
| NRF_STATIC_INLINE void | nrf_spis_orc_set (NRF_SPIS_Type *p_reg, uint8_t orc) |
| Function for setting the over-read character. | |
| NRF_STATIC_INLINE void | nrf_spis_tx_list_enable (NRF_SPIS_Type *p_reg) |
| Function for enabling the TX list feature. | |
| NRF_STATIC_INLINE void | nrf_spis_tx_list_disable (NRF_SPIS_Type *p_reg) |
| Function for disabling the TX list feature. | |
| NRF_STATIC_INLINE void | nrf_spis_rx_list_enable (NRF_SPIS_Type *p_reg) |
| Function for enabling the RX list feature. | |
| NRF_STATIC_INLINE void | nrf_spis_rx_list_disable (NRF_SPIS_Type *p_reg) |
| Function for disabling the RX list feature. | |
| NRF_STATIC_INLINE void | nrf_spis_rx_pattern_match_enable_set (NRF_SPIS_Type *p_reg, uint8_t index, bool enable) |
| Function for enabling individual pattern match filters. | |
| NRF_STATIC_INLINE bool | nrf_spis_rx_pattern_match_enable_check (NRF_SPIS_Type const *p_reg, uint8_t index) |
| Function for checking if the specified pattern match filter is enabled. | |
| NRF_STATIC_INLINE void | nrf_spis_rx_pattern_match_one_shot_enable (NRF_SPIS_Type *p_reg, uint8_t index) |
| Function for enabling one-shot operation for the specified match filter. | |
| NRF_STATIC_INLINE void | nrf_spis_rx_pattern_match_one_shot_disable (NRF_SPIS_Type *p_reg, uint8_t index) |
| Function for disabling one-shot operation for the specified match filter. | |
| NRF_STATIC_INLINE bool | nrf_spis_rx_pattern_match_one_shot_check (NRF_SPIS_Type const *p_reg, uint8_t index) |
| Function for checking if specified pattern match filter is configured as one-shot. | |
| NRF_STATIC_INLINE void | nrf_spis_rx_pattern_match_candidate_set (NRF_SPIS_Type *p_reg, uint8_t index, uint32_t pattern) |
| Function for setting the pattern to be looked for by the specified match filter. | |
| NRF_STATIC_INLINE uint32_t | nrf_spis_rx_pattern_match_candidate_get (NRF_SPIS_Type const *p_reg, uint8_t index) |
| Function for getting the pattern that the specified match filter is looking for. | |
| NRF_STATIC_INLINE void | nrf_spis_rx_terminate_on_bus_error_enable (NRF_SPIS_Type *p_reg) |
| Function for enabling the termination of the RX transaction after detecting the BUSERROR event. | |
| NRF_STATIC_INLINE void | nrf_spis_rx_terminate_on_bus_error_disable (NRF_SPIS_Type *p_reg) |
| Function for disabling the termination of the RX transaction after detecting the BUSERROR event. | |
| NRF_STATIC_INLINE bool | nrf_spis_rx_terminate_on_bus_error_check (NRF_SPIS_Type const *p_reg) |
| Function for checking if RX transaction termination after detecting the BUSERROR event is enabled. | |
| NRF_STATIC_INLINE void | nrf_spis_tx_terminate_on_bus_error_enable (NRF_SPIS_Type *p_reg) |
| Function for enabling the termination of the TX transaction after detecting the BUSERROR event. | |
| NRF_STATIC_INLINE void | nrf_spis_tx_terminate_on_bus_error_disable (NRF_SPIS_Type *p_reg) |
| Function for disabling the termination of the TX transaction after detecting the BUSERROR event. | |
| NRF_STATIC_INLINE bool | nrf_spis_tx_terminate_on_bus_error_check (NRF_SPIS_Type const *p_reg) |
| Function for checking if TX transaction termination after detecting the BUSERROR event is enabled. | |
Hardware access layer for managing the SPIS peripheral.
| #define NRF_SPIS_INST_GET | ( | idx | ) |
Macro getting pointer to the structure of registers of the SPIS peripheral.
| [in] | idx | SPIS instance index. |
| enum nrf_spis_bit_order_t |
| enum nrf_spis_event_t |
SPIS events.
| enum nrf_spis_int_mask_t |
SPIS interrupts.
| enum nrf_spis_mode_t |
| enum nrf_spis_semstat_t |
SPIS shortcuts.
| enum nrf_spis_task_t |
SPIS tasks.
| NRF_STATIC_INLINE void nrf_spis_configure | ( | NRF_SPIS_Type * | p_reg, |
| nrf_spis_mode_t | spi_mode, | ||
| nrf_spis_bit_order_t | spi_bit_order ) |
Function for setting the SPI configuration.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | spi_mode | SPI mode. |
| [in] | spi_bit_order | SPI bit order. |
| NRF_STATIC_INLINE uint32_t nrf_spis_csn_pin_get | ( | NRF_SPIS_Type const * | p_reg | ) |
Function for getting the CSN pin selection.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_spis_csn_pin_set | ( | NRF_SPIS_Type * | p_reg, |
| uint32_t | pin ) |
Function for setting the CSN pin.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | pin | CSN pin number. |
| NRF_STATIC_INLINE void nrf_spis_def_set | ( | NRF_SPIS_Type * | p_reg, |
| uint8_t | def ) |
Function for setting the default character.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | def | Default character that is clocked out in case of an overflow of the RXD buffer. |
| NRF_STATIC_INLINE void nrf_spis_disable | ( | NRF_SPIS_Type * | p_reg | ) |
Function for disabling the SPIS peripheral.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_spis_enable | ( | NRF_SPIS_Type * | p_reg | ) |
Function for enabling the SPIS peripheral.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE bool nrf_spis_enable_check | ( | NRF_SPIS_Type const * | p_reg | ) |
Function for checking if the SPIS peripheral is enabled.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| true | The SPIS is enabled. |
| false | The SPIS is not enabled. |
| NRF_STATIC_INLINE uint32_t nrf_spis_event_address_get | ( | NRF_SPIS_Type const * | p_reg, |
| nrf_spis_event_t | event ) |
Function for getting the address of the specified SPIS event register.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | event | The specified event. |
| NRF_STATIC_INLINE bool nrf_spis_event_check | ( | NRF_SPIS_Type const * | p_reg, |
| nrf_spis_event_t | event ) |
Function for retrieving the state of the SPIS event.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | event | Event to be checked. |
| true | The event has been generated. |
| false | The event has not been generated. |
| NRF_STATIC_INLINE void nrf_spis_event_clear | ( | NRF_SPIS_Type * | p_reg, |
| nrf_spis_event_t | event ) |
Function for clearing the specified SPIS event.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | event | Event to be cleared. |
| NRF_STATIC_INLINE void nrf_spis_int_disable | ( | NRF_SPIS_Type * | p_reg, |
| uint32_t | mask ) |
Function for disabling the specified interrupts.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | mask | Mask of interrupts to be disabled. Use nrf_spis_int_mask_t values for bit masking. |
| NRF_STATIC_INLINE void nrf_spis_int_enable | ( | NRF_SPIS_Type * | p_reg, |
| uint32_t | mask ) |
Function for enabling the specified interrupts.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | mask | Mask of interrupts to be enabled. Use nrf_spis_int_mask_t values for bit masking. |
| NRF_STATIC_INLINE uint32_t nrf_spis_int_enable_check | ( | NRF_SPIS_Type const * | p_reg, |
| uint32_t | mask ) |
Function for checking if the specified interrupts are enabled.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | mask | Mask of interrupts to be checked. Use nrf_spis_int_mask_t values for bit masking. |
| NRF_STATIC_INLINE uint32_t nrf_spis_miso_pin_get | ( | NRF_SPIS_Type const * | p_reg | ) |
Function for getting the MISO pin selection.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_spis_miso_pin_set | ( | NRF_SPIS_Type * | p_reg, |
| uint32_t | pin ) |
Function for setting the MISO pin.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | pin | MISO pin number. |
| NRF_STATIC_INLINE uint32_t nrf_spis_mosi_pin_get | ( | NRF_SPIS_Type const * | p_reg | ) |
Function for getting the MOSI pin selection.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_spis_mosi_pin_set | ( | NRF_SPIS_Type * | p_reg, |
| uint32_t | pin ) |
Function for setting the MOSI pin.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | pin | MOSI pin number. |
| NRF_STATIC_INLINE void nrf_spis_orc_set | ( | NRF_SPIS_Type * | p_reg, |
| uint8_t | orc ) |
Function for setting the over-read character.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | orc | Over-read character that is clocked out in case of an over-read of the TXD buffer. |
| NRF_STATIC_INLINE void nrf_spis_pins_set | ( | NRF_SPIS_Type * | p_reg, |
| uint32_t | sck_pin, | ||
| uint32_t | mosi_pin, | ||
| uint32_t | miso_pin, | ||
| uint32_t | csn_pin ) |
Function for configuring SPIS pins.
If a given signal is not needed, pass the NRF_SPIS_PIN_NOT_CONNECTED value instead of its pin number.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | sck_pin | SCK pin number. |
| [in] | mosi_pin | MOSI pin number. |
| [in] | miso_pin | MISO pin number. |
| [in] | csn_pin | CSN pin number. |
| NRF_STATIC_INLINE void nrf_spis_publish_clear | ( | NRF_SPIS_Type * | p_reg, |
| nrf_spis_event_t | event ) |
Function for clearing the publish configuration for a given SPIS event.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | event | Event for which to clear the configuration. |
| NRF_STATIC_INLINE uint32_t nrf_spis_publish_get | ( | NRF_SPIS_Type const * | p_reg, |
| nrf_spis_event_t | event ) |
Function for getting the publish configuration for a given SPIS event.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | event | Event for which to read the configuration. |
| NRF_STATIC_INLINE void nrf_spis_publish_set | ( | NRF_SPIS_Type * | p_reg, |
| nrf_spis_event_t | event, | ||
| uint8_t | channel ) |
Function for setting the publish configuration for a given SPIS event.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | event | Event for which to set the configuration. |
| [in] | channel | Channel through which to publish the event. |
| NRF_STATIC_INLINE size_t nrf_spis_rx_amount_get | ( | NRF_SPIS_Type const * | p_reg | ) |
Function for getting the number of bytes received in the last granted transaction.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE uint8_t * nrf_spis_rx_buffer_get | ( | NRF_SPIS_Type * | p_reg | ) |
Function for getting the receive buffer.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_spis_rx_buffer_set | ( | NRF_SPIS_Type * | p_reg, |
| uint8_t * | p_buffer, | ||
| size_t | length ) |
Function for setting the receive buffer.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | p_buffer | Pointer to the buffer for received data. |
| [in] | length | Maximum number of data bytes to receive. |
| NRF_STATIC_INLINE void nrf_spis_rx_list_disable | ( | NRF_SPIS_Type * | p_reg | ) |
Function for disabling the RX list feature.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_spis_rx_list_enable | ( | NRF_SPIS_Type * | p_reg | ) |
Function for enabling the RX list feature.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE size_t nrf_spis_rx_maxcnt_get | ( | NRF_SPIS_Type * | p_reg | ) |
Function for getting the receive buffer size.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE uint32_t nrf_spis_rx_pattern_match_candidate_get | ( | NRF_SPIS_Type const * | p_reg, |
| uint8_t | index ) |
Function for getting the pattern that the specified match filter is looking for.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | index | Index of pattern match filter. |
| NRF_STATIC_INLINE void nrf_spis_rx_pattern_match_candidate_set | ( | NRF_SPIS_Type * | p_reg, |
| uint8_t | index, | ||
| uint32_t | pattern ) |
Function for setting the pattern to be looked for by the specified match filter.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | index | Index of pattern match filter. |
| [in] | pattern | Pattern to be looked for. Match will trigger the corresponding event, if enabled. |
| NRF_STATIC_INLINE bool nrf_spis_rx_pattern_match_enable_check | ( | NRF_SPIS_Type const * | p_reg, |
| uint8_t | index ) |
Function for checking if the specified pattern match filter is enabled.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | index | Index of pattern match filter. |
| true | Pattern match filter is enabled. |
| false | Pattern match filter is disabled. |
| NRF_STATIC_INLINE void nrf_spis_rx_pattern_match_enable_set | ( | NRF_SPIS_Type * | p_reg, |
| uint8_t | index, | ||
| bool | enable ) |
Function for enabling individual pattern match filters.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | index | Index of pattern match filter. |
| [in] | enable | True if pattern match filter is to be enabled, false otherwise. |
| NRF_STATIC_INLINE bool nrf_spis_rx_pattern_match_one_shot_check | ( | NRF_SPIS_Type const * | p_reg, |
| uint8_t | index ) |
Function for checking if specified pattern match filter is configured as one-shot.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | index | Index of pattern match filter. |
| true | Pattern match filter is configured as one-shot. |
| false | Pattern match filter is configured as continuous. |
| NRF_STATIC_INLINE void nrf_spis_rx_pattern_match_one_shot_disable | ( | NRF_SPIS_Type * | p_reg, |
| uint8_t | index ) |
Function for disabling one-shot operation for the specified match filter.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | index | Index of pattern match filter. |
| NRF_STATIC_INLINE void nrf_spis_rx_pattern_match_one_shot_enable | ( | NRF_SPIS_Type * | p_reg, |
| uint8_t | index ) |
Function for enabling one-shot operation for the specified match filter.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | index | Index of pattern match filter. |
| NRF_STATIC_INLINE bool nrf_spis_rx_terminate_on_bus_error_check | ( | NRF_SPIS_Type const * | p_reg | ) |
Function for checking if RX transaction termination after detecting the BUSERROR event is enabled.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| true | RX transaction termination after detecting a BUSERROR event is enabled. |
| false | RX transaction termination after detecting a BUSERROR event is disabled. |
| NRF_STATIC_INLINE void nrf_spis_rx_terminate_on_bus_error_disable | ( | NRF_SPIS_Type * | p_reg | ) |
Function for disabling the termination of the RX transaction after detecting the BUSERROR event.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_spis_rx_terminate_on_bus_error_enable | ( | NRF_SPIS_Type * | p_reg | ) |
Function for enabling the termination of the RX transaction after detecting the BUSERROR event.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE uint32_t nrf_spis_sck_pin_get | ( | NRF_SPIS_Type const * | p_reg | ) |
Function for getting the SCK pin selection.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_spis_sck_pin_set | ( | NRF_SPIS_Type * | p_reg, |
| uint32_t | pin ) |
Function for setting the SCK pin.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | pin | SCK pin number. |
| NRF_STATIC_INLINE nrf_spis_semstat_t nrf_spis_semaphore_status_get | ( | NRF_SPIS_Type const * | p_reg | ) |
Function for retrieving the SPIS semaphore status.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_spis_shorts_disable | ( | NRF_SPIS_Type * | p_reg, |
| uint32_t | mask ) |
Function for disabling the specified shortcuts.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | mask | Shortcuts to be disabled. |
| NRF_STATIC_INLINE void nrf_spis_shorts_enable | ( | NRF_SPIS_Type * | p_reg, |
| uint32_t | mask ) |
Function for enabling the specified shortcuts.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | mask | Shortcuts to be enabled. |
| NRF_STATIC_INLINE nrf_spis_status_mask_t nrf_spis_status_get | ( | NRF_SPIS_Type const * | p_reg | ) |
Function for retrieving the SPIS status.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_spis_subscribe_clear | ( | NRF_SPIS_Type * | p_reg, |
| nrf_spis_task_t | task ) |
Function for clearing the subscribe configuration for a given SPIS task.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | task | Task for which to clear the configuration. |
| NRF_STATIC_INLINE uint32_t nrf_spis_subscribe_get | ( | NRF_SPIS_Type const * | p_reg, |
| nrf_spis_task_t | task ) |
Function for getting the subscribe configuration for a given SPIS task.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | task | Task for which to read the configuration. |
| NRF_STATIC_INLINE void nrf_spis_subscribe_set | ( | NRF_SPIS_Type * | p_reg, |
| nrf_spis_task_t | task, | ||
| uint8_t | channel ) |
Function for setting the subscribe configuration for a given SPIS task.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | task | Task for which to set the configuration. |
| [in] | channel | Channel through which to subscribe events. |
| NRF_STATIC_INLINE uint32_t nrf_spis_task_address_get | ( | NRF_SPIS_Type const * | p_reg, |
| nrf_spis_task_t | task ) |
Function for getting the address of the specified SPIS task register.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | task | The specified task. |
| NRF_STATIC_INLINE void nrf_spis_task_trigger | ( | NRF_SPIS_Type * | p_reg, |
| nrf_spis_task_t | task ) |
Function for activating the specified SPIS task.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | task | Task to be activated. |
| NRF_STATIC_INLINE size_t nrf_spis_tx_amount_get | ( | NRF_SPIS_Type const * | p_reg | ) |
Function for getting the number of bytes transmitted in the last granted transaction.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE uint8_t * nrf_spis_tx_buffer_get | ( | NRF_SPIS_Type * | p_reg | ) |
Function for getting the transmit buffer.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_spis_tx_buffer_set | ( | NRF_SPIS_Type * | p_reg, |
| uint8_t const * | p_buffer, | ||
| size_t | length ) |
Function for setting the transmit buffer.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| [in] | p_buffer | Pointer to the buffer that contains the data to send. |
| [in] | length | Maximum number of data bytes to transmit. |
| NRF_STATIC_INLINE void nrf_spis_tx_list_disable | ( | NRF_SPIS_Type * | p_reg | ) |
Function for disabling the TX list feature.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_spis_tx_list_enable | ( | NRF_SPIS_Type * | p_reg | ) |
Function for enabling the TX list feature.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE size_t nrf_spis_tx_maxcnt_get | ( | NRF_SPIS_Type * | p_reg | ) |
Function for getting the transmit buffer size.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE bool nrf_spis_tx_terminate_on_bus_error_check | ( | NRF_SPIS_Type const * | p_reg | ) |
Function for checking if TX transaction termination after detecting the BUSERROR event is enabled.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| true | TX transaction termination after detecting a BUSERROR event is enabled. |
| false | TX transaction termination after detecting a BUSERROR event is disabled. |
| NRF_STATIC_INLINE void nrf_spis_tx_terminate_on_bus_error_disable | ( | NRF_SPIS_Type * | p_reg | ) |
Function for disabling the termination of the TX transaction after detecting the BUSERROR event.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |
| NRF_STATIC_INLINE void nrf_spis_tx_terminate_on_bus_error_enable | ( | NRF_SPIS_Type * | p_reg | ) |
Function for enabling the termination of the TX transaction after detecting the BUSERROR event.
| [in] | p_reg | Pointer to the structure of registers of the peripheral. |