SPIM HAL

group nrf_spim_hal

Hardware access layer for managing the SPIM peripheral.

Defines

NRF_SPIM_INST_GET(idx)

Macro getting pointer to the structure of registers of the SPIM peripheral.

Parameters:

idx – [in] SPIM instance index.

Returns:

Pointer to the structure of registers of the SPIM peripheral.

NRF_SPIM_HAS_16_MHZ_FREQ: Symbol indicating whether 16 MHz clock frequency is available.

NRF_SPIM_HAS_32_MHZ_FREQ: Symbol indicating whether 32 MHz clock frequency is available.

NRF_SPIM_HAS_FREQUENCY: Symbol indicating whether frequency is used.

NRF_SPIM_HAS_PRESCALER: Symbol indicating whether prescaler is used.

NRF_SPIM_HAS_ARRAY_LIST: Symbol indicating whether EasyDMA array list feature is present.

NRF_SPIM_HAS_DMA_REG: Symbol indicating whether dedicated DMA register is present.

NRF_SPIM_HAS_DMA_TASKS_EVENTS: Symbol indicating whether SPIM DMA tasks and events are present.

NRF_SPIM_HAS_HW_CSN: Macro for checking if the hardware chip select function is available.

NRF_SPIM_HAS_DCX: Macro for checking if the DCX pin control is available.

NRF_SPIM_HAS_RXDELAY: Macro for checking if the RXDELAY function is available.

NRF_SPIM_HAS_STALLSTAT: Macro for checking if the STALLSTAT feature is available.

NRF_SPIM_HAS_EXTENDED: Symbol indicating whether any of the SPIM extended features is available.

NRF_SPIM_DCX_CNT_ALL_CMD: This value specified in the DCX line configuration causes this line to be set low during whole transmission (all transmitted bytes are marked as command bytes). Any lower value causes the DCX line to be switched from low to high after this number of bytes is transmitted (all remaining bytes are marked as data bytes).

NRF_SPIM_PIN_NOT_CONNECTED: This value can be used as a parameter for the nrf_spim_pins_set function to specify that a given SPI signal (SCK, MOSI, or MISO) shall not be connected to a physical pin.

NRF_SPIM_DMA_RX_PATTERN_MAX_COUNT: Max number of RX patterns.

NRF_SPIM_DCX_DEFAULT: Symbol specifying default value of DCX pin setting.

NRF_SPIM_CSN_DEFAULT: Symbol specifying default value of CSN pin setting.

NRF_SPIM_CSNDUR_DEFAULT: Symbol specifying default value of CSN duration setting.

NRF_SPIM_CSNPOL_DEFAULT: Symbol specifying default value of CSN polarity setting.

NRF_SPIM_RXDELAY_DEFAULT: Symbol specifying default value of RX delay setting.

NRF_SPIM_MIN_FREQUENCY: Minimal SPIM frequency in Hz.

NRF_SPIM_BASE_FREQUENCY_320MHZ: Base frequency value 320 MHz for SPIM.

NRF_SPIM_BASE_FREQUENCY_192MHZ: Base frequency value 192 MHz for SPIM.

NRF_SPIM_BASE_FREQUENCY_128MHZ: Base frequency value 128 MHz for SPIM.

NRF_SPIM_BASE_FREQUENCY_64MHZ: Base frequency value 64 MHz for SPIM.

NRF_SPIM_BASE_FREQUENCY_32MHZ: Base frequency value 32 MHz for SPIM.

NRF_SPIM_BASE_FREQUENCY_16MHZ: Base frequency value 16 MHz for SPIM.

NRF_SPIM_IS_320MHZ_SPIM(p_reg): Macro for checking whether the base frequency for the specified SPIM instance is 320 MHz.

NRF_SPIM_IS_192MHZ_SPIM(p_reg): Macro for checking whether the base frequency for the specified SPIM instance is 192 MHz.

NRF_SPIM_IS_128MHZ_SPIM(p_reg): Macro for checking whether the base frequency for the specified SPIM instance is 128 MHz.

NRF_SPIM_IS_64MHZ_SPIM(p_reg): Macro for checking whether the base frequency for the specified SPIM instance is 64 MHz.

NRF_SPIM_IS_32MHZ_SPIM(p_reg): Macro for checking whether the base frequency for the specified SPIM instance is 32 MHz.

NRF_SPIM_BASE_FREQUENCY_GET(p_reg): Macro for getting base frequency value in Hz for the specified SPIM instance.

NRF_SPIM_PRESCALER_MAX_GET(p_reg)

Macro for getting the maximum value of PRESCALER register.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_SPIM_PRESCALER_MIN_GET(p_reg)

Macro for getting the minimum value of PRESCALER register.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_SPIM_PRESCALER_CALCULATE(p_reg, frequency)

Macro for computing prescaler value for a given SPIM instance and desired frequency.

Warning

Not every combination of base and desired frequency is supported. The NRF_SPIM_FREQUENCY_STATIC_CHECK macro can be used to check if the desired frequency is supported.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
frequency – [in] Desired frequency value in Hz.

NRF_SPIM_FREQUENCY_STATIC_CHECK(p_reg, frequency)

Macro for checking whether specified frequency can be achieved for a given SPIM instance.

Note

This macro uses a compile-time assertion.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
frequency – [in] Desired frequency value in Hz.

Enums

enum nrf_spim_task_t

SPIM tasks.

Values:

enumerator NRF_SPIM_TASK_START: Start SPI transaction.

enumerator NRF_SPIM_TASK_STOP: Stop SPI transaction.

enumerator NRF_SPIM_TASK_SUSPEND: Suspend SPI transaction.

enumerator NRF_SPIM_TASK_RESUME: Resume SPI transaction.

enumerator NRF_SPIM_TASK_ENABLERXMATCH0: Enable SPI pattern matching functionality for pattern 0.

enumerator NRF_SPIM_TASK_ENABLERXMATCH1: Enable SPI pattern matching functionality for pattern 1.

enumerator NRF_SPIM_TASK_ENABLERXMATCH2: Enable SPI pattern matching functionality for pattern 2.

enumerator NRF_SPIM_TASK_ENABLERXMATCH3: Enable SPI pattern matching functionality for pattern 3.

enumerator NRF_SPIM_TASK_DISABLERXMATCH0: Disable SPI pattern matching functionality for pattern 0.

enumerator NRF_SPIM_TASK_DISABLERXMATCH1: Disable SPI pattern matching functionality for pattern 1.

enumerator NRF_SPIM_TASK_DISABLERXMATCH2: Disable SPI pattern matching functionality for pattern 2.

enumerator NRF_SPIM_TASK_DISABLERXMATCH3: Disable SPI pattern matching functionality for pattern 3.

enum nrf_spim_event_t

SPIM events.

Values:

enumerator NRF_SPIM_EVENT_STARTED: SPI transaction has started.

enumerator NRF_SPIM_EVENT_STOPPED: SPI transaction has stopped.

enumerator NRF_SPIM_EVENT_RXSTARTED: Receive sequence started.

enumerator NRF_SPIM_EVENT_RXBUSERROR: Memory bus error occurred during the RX transfer.

enumerator NRF_SPIM_EVENT_RXMATCH0: Pattern match for pattern 0 detected.

enumerator NRF_SPIM_EVENT_RXMATCH1: Pattern match for pattern 1 detected.

enumerator NRF_SPIM_EVENT_RXMATCH2: Pattern match for pattern 2 detected.

enumerator NRF_SPIM_EVENT_RXMATCH3: Pattern match for pattern 3 detected.

enumerator NRF_SPIM_EVENT_TXSTARTED: Transmit sequence started.

enumerator NRF_SPIM_EVENT_TXBUSERROR: Memory bus error occurred during the TX transfer.

enumerator NRF_SPIM_EVENT_ENDRX: End of RXD buffer reached.

enumerator NRF_SPIM_EVENT_ENDTX: End of TXD buffer reached.

enumerator NRF_SPIM_EVENT_END: End of RXD buffer and TXD buffer reached.

enum nrf_spim_short_mask_t

SPIM shortcuts.

Values:

enumerator NRF_SPIM_SHORT_END_START_MASK: Shortcut between END event and START task.

enumerator NRF_SPIM_SHORT_RXMATCH0_ENABLERXMATCH1_MASK: Shortcut between DMA.RX.MATCH0 event and DMA.RX.ENABLEMATCH1 task.

enumerator NRF_SPIM_SHORT_RXMATCH1_ENABLERXMATCH2_MASK: Shortcut between DMA.RX.MATCH1 event and DMA.RX.ENABLEMATCH2 task.

enumerator NRF_SPIM_SHORT_RXMATCH2_ENABLERXMATCH3_MASK: Shortcut between DMA.RX.MATCH2 event and DMA.RX.ENABLEMATCH3 task.

enumerator NRF_SPIM_SHORT_RXMATCH3_ENABLERXMATCH0_MASK: Shortcut between DMA.RX.MATCH3 event and DMA.RX.ENABLEMATCH4 task.

enumerator NRF_SPIM_SHORT_RXMATCH0_DISABLERXMATCH0_MASK: Shortcut between DMA.RX.MATCH0 event and DMA.RX.DISABLEMATCH0 task.

enumerator NRF_SPIM_SHORT_RXMATCH1_DISABLERXMATCH1_MASK: Shortcut between DMA.RX.MATCH1 event and DMA.RX.DISABLEMATCH1 task.

enumerator NRF_SPIM_SHORT_RXMATCH2_DISABLERXMATCH2_MASK: Shortcut between DMA.RX.MATCH2 event and DMA.RX.DISABLEMATCH2 task.

enumerator NRF_SPIM_SHORT_RXMATCH3_DISABLERXMATCH3_MASK: Shortcut between DMA.RX.MATCH3 event and DMA.RX.DISABLEMATCH3 task.

enumerator NRF_SPIM_ALL_SHORTS_MASK: All SPIM shortcuts.

enum nrf_spim_int_mask_t

SPIM interrupts.

Values:

enumerator NRF_SPIM_INT_STARTED_MASK: Interrupt on STARTED event.

enumerator NRF_SPIM_INT_STOPPED_MASK: Interrupt on STOPPED event.

enumerator NRF_SPIM_INT_RXREADY_MASK: Interrupt on DMA.RX.READY event.

enumerator NRF_SPIM_INT_RXBUSERROR_MASK: Interrupt on DMA.RX.BUSERROR event.

enumerator NRF_SPIM_INT_RXMATCH0_MASK: Interrupt on DMA.RX.MATCH0 event.

enumerator NRF_SPIM_INT_RXMATCH1_MASK: Interrupt on DMA.RX.MATCH1 event.

enumerator NRF_SPIM_INT_RXMATCH2_MASK: Interrupt on DMA.RX.MATCH2 event.

enumerator NRF_SPIM_INT_RXMATCH3_MASK: Interrupt on DMA.RX.MATCH3 event.

enumerator NRF_SPIM_INT_TXREADY_MASK: Interrupt on DMA.TX.READY event.

enumerator NRF_SPIM_INT_TXBUSERROR_MASK: Interrupt on DMA.TX.BUSERROR event.

enumerator NRF_SPIM_INT_ENDRX_MASK: Interrupt on ENDRX event.

enumerator NRF_SPIM_INT_ENDTX_MASK: Interrupt on ENDTX event.

enumerator NRF_SPIM_INT_END_MASK: Interrupt on END event.

enumerator NRF_SPIM_ALL_INTS_MASK: All SPIM interrupts.

enum nrf_spim_frequency_t

SPI master data rates.

Values:

enumerator NRF_SPIM_FREQ_125K: 125 kbps.

enumerator NRF_SPIM_FREQ_250K: 250 kbps.

enumerator NRF_SPIM_FREQ_500K: 500 kbps.

enumerator NRF_SPIM_FREQ_1M: 1 Mbps.

enumerator NRF_SPIM_FREQ_2M: 2 Mbps.

enumerator NRF_SPIM_FREQ_4M: 4 Mbps.

enumerator NRF_SPIM_FREQ_8M: 8 Mbps.

enumerator NRF_SPIM_FREQ_16M: 16 Mbps.

enumerator NRF_SPIM_FREQ_32M: 32 Mbps.

enum nrf_spim_mode_t

SPI modes.

Values:

enumerator NRF_SPIM_MODE_0: SCK active high, sample on leading edge of clock.

enumerator NRF_SPIM_MODE_1: SCK active high, sample on trailing edge of clock.

enumerator NRF_SPIM_MODE_2: SCK active low, sample on leading edge of clock.

enumerator NRF_SPIM_MODE_3: SCK active low, sample on trailing edge of clock.

enum nrf_spim_bit_order_t

SPI bit orders.

Values:

enumerator NRF_SPIM_BIT_ORDER_MSB_FIRST: Most significant bit shifted out first.

enumerator NRF_SPIM_BIT_ORDER_LSB_FIRST: Least significant bit shifted out first.

enum nrf_spim_csn_pol_t

SPI CSN pin polarity.

Values:

enumerator NRF_SPIM_CSN_POL_LOW: Active low (idle state high).

enumerator NRF_SPIM_CSN_POL_HIGH: Active high (idle state low).

Functions

NRF_STATIC_INLINE void nrf_spim_task_trigger(NRF_SPIM_Type *p_reg, nrf_spim_task_t task)

Function for activating the specified SPIM task.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
task – [in] Task to be activated.

NRF_STATIC_INLINE uint32_t nrf_spim_task_address_get(NRF_SPIM_Type const *p_reg, nrf_spim_task_t task)

Function for getting the address of the specified SPIM task register.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
task – [in] The specified task.

Returns:

Address of the specified task register.

NRF_STATIC_INLINE void nrf_spim_event_clear(NRF_SPIM_Type *p_reg, nrf_spim_event_t event)

Function for clearing the specified SPIM event.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
event – [in] Event to be cleared.

NRF_STATIC_INLINE bool nrf_spim_event_check(NRF_SPIM_Type const *p_reg, nrf_spim_event_t event)

Function for retrieving the state of the SPIM event.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
event – [in] Event to be checked.

Return values:

true – The event has been generated.
false – The event has not been generated.

NRF_STATIC_INLINE uint32_t nrf_spim_event_address_get(NRF_SPIM_Type const *p_reg, nrf_spim_event_t event)

Function for getting the address of the specified SPIM event register.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
event – [in] The specified event.

Returns:

Address of the specified event register.

NRF_STATIC_INLINE void nrf_spim_shorts_enable(NRF_SPIM_Type *p_reg, uint32_t mask)

Function for enabling the specified shortcuts.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
mask – [in] Shortcuts to be enabled.

NRF_STATIC_INLINE void nrf_spim_shorts_disable(NRF_SPIM_Type *p_reg, uint32_t mask)

Function for disabling the specified shortcuts.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
mask – [in] Shortcuts to be disabled.

NRF_STATIC_INLINE uint32_t nrf_spim_shorts_get(NRF_SPIM_Type const *p_reg)

Function for getting the shortcut setting.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

Current shortcut configuration.

NRF_STATIC_INLINE void nrf_spim_int_enable(NRF_SPIM_Type *p_reg, uint32_t mask)

Function for enabling the specified interrupts.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
mask – [in] Mask of interrupts to be enabled. Use nrf_spim_int_mask_t values for bit masking.

NRF_STATIC_INLINE void nrf_spim_int_disable(NRF_SPIM_Type *p_reg, uint32_t mask)

Function for disabling the specified interrupts.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
mask – [in] Mask of interrupts to be disabled. Use nrf_spim_int_mask_t values for bit masking.

NRF_STATIC_INLINE uint32_t nrf_spim_int_enable_check(NRF_SPIM_Type const *p_reg, uint32_t mask)

Function for checking if the specified interrupts are enabled.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
mask – [in] Mask of interrupts to be checked. Use nrf_spim_int_mask_t values for bit masking.

Returns:

Mask of enabled interrupts.

NRF_STATIC_INLINE void nrf_spim_prescaler_set(NRF_SPIM_Type *p_reg, uint32_t prescaler)

Function for setting the prescaler value.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
prescaler – [in] Prescaler value.

NRF_STATIC_INLINE uint32_t nrf_spim_prescaler_get(NRF_SPIM_Type const *p_reg)

Function for getting the prescaler value.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

Prescaler value.

NRF_STATIC_INLINE void nrf_spim_subscribe_set(NRF_SPIM_Type *p_reg, nrf_spim_task_t task, uint8_t channel)

Function for setting the subscribe configuration for a given SPIM task.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
task – [in] Task for which to set the configuration.
channel – [in] Channel through which to subscribe events.

NRF_STATIC_INLINE void nrf_spim_subscribe_clear(NRF_SPIM_Type *p_reg, nrf_spim_task_t task)

Function for clearing the subscribe configuration for a given SPIM task.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
task – [in] Task for which to clear the configuration.

NRF_STATIC_INLINE void nrf_spim_publish_set(NRF_SPIM_Type *p_reg, nrf_spim_event_t event, uint8_t channel)

Function for setting the publish configuration for a given SPIM event.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
event – [in] Event for which to set the configuration.
channel – [in] Channel through which to publish the event.

NRF_STATIC_INLINE void nrf_spim_publish_clear(NRF_SPIM_Type *p_reg, nrf_spim_event_t event)

Function for clearing the publish configuration for a given SPIM event.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
event – [in] Event for which to clear the configuration.

NRF_STATIC_INLINE void nrf_spim_enable(NRF_SPIM_Type *p_reg)

Function for enabling the SPIM peripheral.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE void nrf_spim_disable(NRF_SPIM_Type *p_reg)

Function for disabling the SPIM peripheral.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE bool nrf_spim_enable_check(NRF_SPIM_Type const *p_reg)

Function for checking if the SPIM peripheral is enabled.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

Return values:

true – The SPIM is enabled.
false – The SPIM is not enabled.

NRF_STATIC_INLINE void nrf_spim_pins_set(NRF_SPIM_Type *p_reg, uint32_t sck_pin, uint32_t mosi_pin, uint32_t miso_pin)

Function for configuring SPIM pins.

If a given signal is not needed, pass the NRF_SPIM_PIN_NOT_CONNECTED value instead of its pin number.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
sck_pin – [in] SCK pin number.
mosi_pin – [in] MOSI pin number.
miso_pin – [in] MISO pin number.

NRF_STATIC_INLINE uint32_t nrf_spim_sck_pin_get(NRF_SPIM_Type const *p_reg)

Function for getting the SCK pin selection.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

SCK pin selection.

NRF_STATIC_INLINE uint32_t nrf_spim_mosi_pin_get(NRF_SPIM_Type const *p_reg)

Function for getting the MOSI pin selection.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

MOSI pin selection.

NRF_STATIC_INLINE uint32_t nrf_spim_miso_pin_get(NRF_SPIM_Type const *p_reg)

Function for getting the MISO pin selection.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

MISO pin selection.

NRF_STATIC_INLINE void nrf_spim_csn_configure(NRF_SPIM_Type *p_reg, uint32_t pin, nrf_spim_csn_pol_t polarity, uint32_t duration)

Function for configuring the SPIM hardware CSN pin.

If this signal is not needed, pass the NRF_SPIM_PIN_NOT_CONNECTED value instead of its pin number.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
pin – [in] CSN pin number.
polarity – [in] CSN pin polarity.
duration – [in] Minimum duration between the edge of CSN and the edge of SCK and minimum duration of CSN must stay unselected between transactions. The value is specified in number of 64 MHz clock cycles (15.625 ns).

NRF_STATIC_INLINE uint32_t nrf_spim_csn_pin_get(NRF_SPIM_Type const *p_reg)

Function for getting the CSN pin selection.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

CSN pin selection.

NRF_STATIC_INLINE void nrf_spim_dcx_pin_set(NRF_SPIM_Type *p_reg, uint32_t dcx_pin)

Function for configuring the SPIM DCX pin.

If this signal is not needed, pass the NRF_SPIM_PIN_NOT_CONNECTED value instead of its pin number.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
dcx_pin – [in] DCX pin number.

NRF_STATIC_INLINE uint32_t nrf_spim_dcx_pin_get(NRF_SPIM_Type const *p_reg)

Function for getting the DCX pin selection.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

DCX pin selection.

NRF_STATIC_INLINE void nrf_spim_dcx_cnt_set(NRF_SPIM_Type *p_reg, uint32_t count)

Function for configuring the number of command bytes.

Maximum value available for dividing the transmitted bytes into command bytes and data bytes is NRF_SPIM_DCX_CNT_ALL_CMD - 1. The NRF_SPIM_DCX_CNT_ALL_CMD value passed as the count parameter causes all transmitted bytes to be marked as command bytes.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
count – [in] Number of command bytes preceding the data bytes.

NRF_STATIC_INLINE void nrf_spim_iftiming_set(NRF_SPIM_Type *p_reg, uint32_t rxdelay)

Function for configuring the extended SPIM interface.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
rxdelay – [in] Sample delay for input serial data on MISO, specified in 64 MHz clock cycles (15.625 ns) from the sampling edge of SCK.

NRF_STATIC_INLINE void nrf_spim_stallstat_rx_clear(NRF_SPIM_Type *p_reg)

Function for clearing stall status for RX EasyDMA RAM accesses.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE bool nrf_spim_stallstat_rx_get(NRF_SPIM_Type const *p_reg)

Function for getting stall status for RX EasyDMA RAM accesses.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

Stall status of RX EasyDMA RAM accesses.

NRF_STATIC_INLINE void nrf_spim_stallstat_tx_clear(NRF_SPIM_Type *p_reg)

Function for clearing stall status for TX EasyDMA RAM accesses.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE bool nrf_spim_stallstat_tx_get(NRF_SPIM_Type const *p_reg)

Function for getting stall status for TX EasyDMA RAM accesses.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

Returns:

Stall status of TX EasyDMA RAM accesses.

NRF_STATIC_INLINE void nrf_spim_frequency_set(NRF_SPIM_Type *p_reg, nrf_spim_frequency_t frequency)

Function for setting the SPI master data rate.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
frequency – [in] SPI frequency.

NRF_STATIC_INLINE nrf_spim_frequency_t nrf_spim_frequency_get(NRF_SPIM_Type *p_reg)

Function for getting the SPI master data rate.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

Return values:

SPI – master frequency.

NRF_STATIC_INLINE void nrf_spim_tx_buffer_set(NRF_SPIM_Type *p_reg, uint8_t const *p_buffer, size_t length)

Function for setting the transmit buffer.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
p_buffer – [in] Pointer to the buffer with data to send.
length – [in] Maximum number of data bytes to transmit.

NRF_STATIC_INLINE uint32_t nrf_spim_tx_amount_get(NRF_SPIM_Type const *p_reg)

Function for getting number of bytes transmitted in the last transaction.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

Return values:

Amount – of bytes transmitted.

NRF_STATIC_INLINE uint32_t nrf_spim_tx_maxcnt_get(NRF_SPIM_Type const *p_reg)

Function for getting number of bytes to be transmitted in the next transaction.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

Return values:

Amount – of bytes to be transmitted.

NRF_STATIC_INLINE void nrf_spim_rx_buffer_set(NRF_SPIM_Type *p_reg, uint8_t *p_buffer, size_t length)

Function for setting the receive buffer.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
p_buffer – [in] Pointer to the buffer for received data.
length – [in] Maximum number of data bytes to receive.

NRF_STATIC_INLINE uint32_t nrf_spim_rx_amount_get(NRF_SPIM_Type const *p_reg)

Function for getting number of bytes received in the last transaction.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

Return values:

Amount – of bytes received.

NRF_STATIC_INLINE uint32_t nrf_spim_rx_maxcnt_get(NRF_SPIM_Type const *p_reg)

Function for getting number of bytes to be received in the next transaction.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

Return values:

Amount – of bytes to be received.

NRF_STATIC_INLINE void nrf_spim_configure(NRF_SPIM_Type *p_reg, nrf_spim_mode_t spi_mode, nrf_spim_bit_order_t spi_bit_order)

Function for setting the SPI configuration.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
spi_mode – [in] SPI mode.
spi_bit_order – [in] SPI bit order.

NRF_STATIC_INLINE void nrf_spim_orc_set(NRF_SPIM_Type *p_reg, uint8_t orc)

Function for setting the over-read character.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
orc – [in] Over-read character that is clocked out in case of an over-read of the TXD buffer.

NRF_STATIC_INLINE void nrf_spim_tx_list_enable(NRF_SPIM_Type *p_reg)

Function for enabling the TX list feature.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE void nrf_spim_tx_list_disable(NRF_SPIM_Type *p_reg)

Function for disabling the TX list feature.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE void nrf_spim_rx_list_enable(NRF_SPIM_Type *p_reg)

Function for enabling the RX list feature.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE void nrf_spim_rx_list_disable(NRF_SPIM_Type *p_reg)

Function for disabling the RX list feature.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE void nrf_spim_rx_pattern_match_enable_set(NRF_SPIM_Type *p_reg, uint8_t index, bool enable)

Function for enabling individual pattern match filters.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
index – [in] Index of pattern match filter.
enable – [in] True if pattern match filter is to be enabled, false otherwise.

NRF_STATIC_INLINE bool nrf_spim_rx_pattern_match_enable_check(NRF_SPIM_Type const *p_reg, uint8_t index)

Function for checking if the specified pattern match filter is enabled.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
index – [in] Index of pattern match filter.

Return values:

true – Pattern match filter is enabled.
false – Pattern match filter is disabled.

NRF_STATIC_INLINE void nrf_spim_rx_pattern_match_one_shot_enable(NRF_SPIM_Type *p_reg, uint8_t index)

Function for enabling one-shot operation for the specified match filter.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
index – [in] Index of pattern match filter.

NRF_STATIC_INLINE void nrf_spim_rx_pattern_match_one_shot_disable(NRF_SPIM_Type *p_reg, uint8_t index)

Function for disabling one-shot operation for the specified match filter.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
index – [in] Index of pattern match filter.

NRF_STATIC_INLINE bool nrf_spim_rx_pattern_match_one_shot_check(NRF_SPIM_Type const *p_reg, uint8_t index)

Function for checking if specified pattern match filter is configured as one-shot.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
index – [in] Index of pattern match filter.

Return values:

true – Pattern match filter is configured as one-shot.
false – Pattern match filter is configured as continuous.

NRF_STATIC_INLINE void nrf_spim_rx_pattern_match_candidate_set(NRF_SPIM_Type *p_reg, uint8_t index, uint32_t pattern)

Function for setting the pattern to be looked for by the specified match filter.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
index – [in] Index of pattern match filter.
pattern – [in] Pattern to be looked for. Match will trigger the corresponding event, if enabled.

NRF_STATIC_INLINE uint32_t nrf_spim_rx_pattern_match_candidate_get(NRF_SPIM_Type const *p_reg, uint8_t index)

Function for getting the pattern that the specified match filter is looking for.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.
index – [in] Index of pattern match filter.

Returns:

Pattern that the specified match filter is looking for.

NRF_STATIC_INLINE void nrf_spim_rx_terminate_on_bus_error_enable(NRF_SPIM_Type *p_reg)

Function for enabling the termination of the RX transaction after detecting the BUSERROR event.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE void nrf_spim_rx_terminate_on_bus_error_disable(NRF_SPIM_Type *p_reg)

Function for disabling the termination of the RX transaction after detecting the BUSERROR event.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE bool nrf_spim_rx_terminate_on_bus_error_check(NRF_SPIM_Type const *p_reg)

Function for checking if RX transaction termination after detecting the BUSERROR event is enabled.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

Return values:

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_spim_tx_terminate_on_bus_error_enable(NRF_SPIM_Type *p_reg)

Function for enabling the termination of the TX transaction after detecting the BUSERROR event.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE void nrf_spim_tx_terminate_on_bus_error_disable(NRF_SPIM_Type *p_reg)

Function for disabling the termination of the TX transaction after detecting the BUSERROR event.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

NRF_STATIC_INLINE bool nrf_spim_tx_terminate_on_bus_error_check(NRF_SPIM_Type const *p_reg)

Function for checking if TX transaction termination after detecting the BUSERROR event is enabled.

Parameters:

p_reg – [in] Pointer to the structure of registers of the peripheral.

Return values:

true – TX transaction termination after detecting a BUSERROR event is enabled.
false – TX transaction termination after detecting a BUSERROR event is disabled.