The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.
Dependents: hello SerialTestv11 SerialTestv12 Sierpinski ... more
mbed 2
This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.
TARGET_VBLUNO51/TOOLCHAIN_ARM_STD/nrf_drv_spis.h@171:3a7713b1edbc, 2018-11-08 (annotated)
- Committer:
- AnnaBridge
- Date:
- Thu Nov 08 11:45:42 2018 +0000
- Revision:
- 171:3a7713b1edbc
- Parent:
- TARGET_NRF51_DK/TARGET_NORDIC/TARGET_NRF5x/TARGET_SDK_11/drivers_nrf/spi_slave/nrf_drv_spis.h@169:a7c7b631e539
mbed library. Release version 164
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
AnnaBridge | 146:22da6e220af6 | 1 | /* |
AnnaBridge | 146:22da6e220af6 | 2 | * Copyright (c) 2015 Nordic Semiconductor ASA |
AnnaBridge | 146:22da6e220af6 | 3 | * All rights reserved. |
AnnaBridge | 146:22da6e220af6 | 4 | * |
AnnaBridge | 146:22da6e220af6 | 5 | * Redistribution and use in source and binary forms, with or without modification, |
AnnaBridge | 146:22da6e220af6 | 6 | * are permitted provided that the following conditions are met: |
AnnaBridge | 146:22da6e220af6 | 7 | * |
AnnaBridge | 146:22da6e220af6 | 8 | * 1. Redistributions of source code must retain the above copyright notice, this list |
AnnaBridge | 146:22da6e220af6 | 9 | * of conditions and the following disclaimer. |
AnnaBridge | 146:22da6e220af6 | 10 | * |
AnnaBridge | 146:22da6e220af6 | 11 | * 2. Redistributions in binary form, except as embedded into a Nordic Semiconductor ASA |
AnnaBridge | 146:22da6e220af6 | 12 | * integrated circuit in a product or a software update for such product, must reproduce |
AnnaBridge | 146:22da6e220af6 | 13 | * the above copyright notice, this list of conditions and the following disclaimer in |
AnnaBridge | 146:22da6e220af6 | 14 | * the documentation and/or other materials provided with the distribution. |
AnnaBridge | 146:22da6e220af6 | 15 | * |
AnnaBridge | 146:22da6e220af6 | 16 | * 3. Neither the name of Nordic Semiconductor ASA nor the names of its contributors may be |
AnnaBridge | 146:22da6e220af6 | 17 | * used to endorse or promote products derived from this software without specific prior |
AnnaBridge | 146:22da6e220af6 | 18 | * written permission. |
AnnaBridge | 146:22da6e220af6 | 19 | * |
AnnaBridge | 146:22da6e220af6 | 20 | * 4. This software, with or without modification, must only be used with a |
AnnaBridge | 146:22da6e220af6 | 21 | * Nordic Semiconductor ASA integrated circuit. |
AnnaBridge | 146:22da6e220af6 | 22 | * |
AnnaBridge | 146:22da6e220af6 | 23 | * 5. Any software provided in binary or object form under this license must not be reverse |
AnnaBridge | 146:22da6e220af6 | 24 | * engineered, decompiled, modified and/or disassembled. |
AnnaBridge | 146:22da6e220af6 | 25 | * |
AnnaBridge | 146:22da6e220af6 | 26 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND |
AnnaBridge | 146:22da6e220af6 | 27 | * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
AnnaBridge | 146:22da6e220af6 | 28 | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
AnnaBridge | 146:22da6e220af6 | 29 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR |
AnnaBridge | 146:22da6e220af6 | 30 | * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES |
AnnaBridge | 146:22da6e220af6 | 31 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
AnnaBridge | 146:22da6e220af6 | 32 | * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON |
AnnaBridge | 146:22da6e220af6 | 33 | * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
AnnaBridge | 146:22da6e220af6 | 34 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
AnnaBridge | 146:22da6e220af6 | 35 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
AnnaBridge | 146:22da6e220af6 | 36 | * |
AnnaBridge | 146:22da6e220af6 | 37 | */ |
AnnaBridge | 146:22da6e220af6 | 38 | |
AnnaBridge | 146:22da6e220af6 | 39 | |
AnnaBridge | 146:22da6e220af6 | 40 | /**@file |
AnnaBridge | 146:22da6e220af6 | 41 | * @defgroup nrf_spis SPI slave HAL and driver |
AnnaBridge | 146:22da6e220af6 | 42 | * @ingroup nrf_spi |
AnnaBridge | 146:22da6e220af6 | 43 | * @brief SPI slave API. |
AnnaBridge | 146:22da6e220af6 | 44 | * @details The SPIS HAL provides basic APIs for accessing the registers |
AnnaBridge | 146:22da6e220af6 | 45 | * of the SPIS. The SPIS driver provides APIs on a higher level. |
AnnaBridge | 146:22da6e220af6 | 46 | **/ |
AnnaBridge | 146:22da6e220af6 | 47 | |
AnnaBridge | 146:22da6e220af6 | 48 | #ifndef SPI_SLAVE_H__ |
AnnaBridge | 146:22da6e220af6 | 49 | #define SPI_SLAVE_H__ |
AnnaBridge | 146:22da6e220af6 | 50 | |
AnnaBridge | 146:22da6e220af6 | 51 | #include <stdint.h> |
AnnaBridge | 146:22da6e220af6 | 52 | #include "nrf.h" |
AnnaBridge | 146:22da6e220af6 | 53 | #include "nrf_error.h" |
AnnaBridge | 146:22da6e220af6 | 54 | #include "nrf_drv_config.h" |
AnnaBridge | 146:22da6e220af6 | 55 | #include "nrf_spis.h" |
AnnaBridge | 146:22da6e220af6 | 56 | #include "nrf_gpio.h" |
AnnaBridge | 146:22da6e220af6 | 57 | #include "sdk_common.h" |
AnnaBridge | 146:22da6e220af6 | 58 | #include "app_util_platform.h" |
AnnaBridge | 146:22da6e220af6 | 59 | |
AnnaBridge | 146:22da6e220af6 | 60 | #if defined(NRF52) |
AnnaBridge | 146:22da6e220af6 | 61 | #define SPIS2_IRQ SPIM2_SPIS2_SPI2_IRQn |
AnnaBridge | 146:22da6e220af6 | 62 | #define SPIS2_IRQ_HANDLER SPIM2_SPIS2_SPI2_IRQHandler |
AnnaBridge | 146:22da6e220af6 | 63 | #define SPIS0_IRQ SPIM0_SPIS0_TWIM0_TWIS0_SPI0_TWI0_IRQn |
AnnaBridge | 146:22da6e220af6 | 64 | #define SPIS0_IRQ_HANDLER SPIM0_SPIS0_TWIM0_TWIS0_SPI0_TWI0_IRQHandler |
AnnaBridge | 146:22da6e220af6 | 65 | #define SPIS1_IRQ SPIM1_SPIS1_TWIM1_TWIS1_SPI1_TWI1_IRQn |
AnnaBridge | 146:22da6e220af6 | 66 | #define SPIS1_IRQ_HANDLER SPIM1_SPIS1_TWIM1_TWIS1_SPI1_TWI1_IRQHandler |
AnnaBridge | 146:22da6e220af6 | 67 | #else |
AnnaBridge | 146:22da6e220af6 | 68 | #define SPIS0_IRQ SPI0_TWI0_IRQn |
AnnaBridge | 146:22da6e220af6 | 69 | #define SPIS0_IRQ_HANDLER SPI0_TWI0_IRQHandler |
AnnaBridge | 146:22da6e220af6 | 70 | #define SPIS1_IRQ SPI1_TWI1_IRQn |
AnnaBridge | 146:22da6e220af6 | 71 | #define SPIS1_IRQ_HANDLER SPI1_TWI1_IRQHandler |
AnnaBridge | 146:22da6e220af6 | 72 | #endif |
AnnaBridge | 146:22da6e220af6 | 73 | |
AnnaBridge | 146:22da6e220af6 | 74 | /** |
AnnaBridge | 146:22da6e220af6 | 75 | * @defgroup nrf_drv_spi_slave SPI slave driver |
AnnaBridge | 146:22da6e220af6 | 76 | * @{ |
AnnaBridge | 146:22da6e220af6 | 77 | * @ingroup nrf_spis |
AnnaBridge | 146:22da6e220af6 | 78 | * |
AnnaBridge | 146:22da6e220af6 | 79 | * @brief Multi-instance SPI slave driver. |
AnnaBridge | 146:22da6e220af6 | 80 | */ |
AnnaBridge | 146:22da6e220af6 | 81 | |
AnnaBridge | 146:22da6e220af6 | 82 | #define NRF_DRV_SPIS_DEFAULT_CSN_PULLUP NRF_GPIO_PIN_NOPULL /**< Default pull-up configuration of the SPI CS. */ |
AnnaBridge | 146:22da6e220af6 | 83 | #define NRF_DRV_SPIS_DEFAULT_MISO_DRIVE NRF_GPIO_PIN_S0S1 /**< Default drive configuration of the SPI MISO. */ |
AnnaBridge | 146:22da6e220af6 | 84 | #define NRF_DRV_SPIS_DEFAULT_DEF 0xFF /**< Default DEF character. */ |
AnnaBridge | 146:22da6e220af6 | 85 | #define NRF_DRV_SPIS_DEFAULT_ORC 0xFF /**< Default ORC character. */ |
AnnaBridge | 146:22da6e220af6 | 86 | |
AnnaBridge | 146:22da6e220af6 | 87 | /** |
AnnaBridge | 146:22da6e220af6 | 88 | * @brief This value can be provided instead of a pin number for the signals MOSI |
AnnaBridge | 146:22da6e220af6 | 89 | * and MISO to specify that the given signal is not used and therefore |
AnnaBridge | 146:22da6e220af6 | 90 | * does not need to be connected to a pin. |
AnnaBridge | 146:22da6e220af6 | 91 | */ |
AnnaBridge | 146:22da6e220af6 | 92 | #define NRF_DRV_SPIS_PIN_NOT_USED 0xFF |
AnnaBridge | 146:22da6e220af6 | 93 | |
AnnaBridge | 146:22da6e220af6 | 94 | /** @brief SPIS transaction bit order definitions. */ |
AnnaBridge | 146:22da6e220af6 | 95 | typedef enum |
AnnaBridge | 146:22da6e220af6 | 96 | { |
AnnaBridge | 146:22da6e220af6 | 97 | NRF_DRV_SPIS_BIT_ORDER_LSB_FIRST = NRF_SPIS_BIT_ORDER_LSB_FIRST, /**< Least significant bit shifted out first. */ |
AnnaBridge | 146:22da6e220af6 | 98 | NRF_DRV_SPIS_BIT_ORDER_MSB_FIRST = NRF_SPIS_BIT_ORDER_MSB_FIRST /**< Most significant bit shifted out first. */ |
AnnaBridge | 146:22da6e220af6 | 99 | } nrf_drv_spis_endian_t; |
AnnaBridge | 146:22da6e220af6 | 100 | |
AnnaBridge | 146:22da6e220af6 | 101 | /** @brief SPIS mode definitions for clock polarity and phase. */ |
AnnaBridge | 146:22da6e220af6 | 102 | typedef enum |
AnnaBridge | 146:22da6e220af6 | 103 | { |
AnnaBridge | 146:22da6e220af6 | 104 | NRF_DRV_SPIS_MODE_0 = NRF_SPIS_MODE_0, /**< (CPOL = 0, CPHA = 0). */ |
AnnaBridge | 146:22da6e220af6 | 105 | NRF_DRV_SPIS_MODE_1 = NRF_SPIS_MODE_1, /**< (CPOL = 0, CPHA = 1). */ |
AnnaBridge | 146:22da6e220af6 | 106 | NRF_DRV_SPIS_MODE_2 = NRF_SPIS_MODE_2, /**< (CPOL = 1, CPHA = 0). */ |
AnnaBridge | 146:22da6e220af6 | 107 | NRF_DRV_SPIS_MODE_3 = NRF_SPIS_MODE_3 /**< (CPOL = 1, CPHA = 1). */ |
AnnaBridge | 146:22da6e220af6 | 108 | } nrf_drv_spis_mode_t; |
AnnaBridge | 146:22da6e220af6 | 109 | |
AnnaBridge | 146:22da6e220af6 | 110 | /** @brief Event callback function event definitions. */ |
AnnaBridge | 146:22da6e220af6 | 111 | typedef enum |
AnnaBridge | 146:22da6e220af6 | 112 | { |
AnnaBridge | 146:22da6e220af6 | 113 | NRF_DRV_SPIS_BUFFERS_SET_DONE, /**< Memory buffer set event. Memory buffers have been set successfully to the SPI slave device, and SPI transactions can be done. */ |
AnnaBridge | 146:22da6e220af6 | 114 | NRF_DRV_SPIS_XFER_DONE, /**< SPI transaction event. SPI transaction has been completed. */ |
AnnaBridge | 146:22da6e220af6 | 115 | NRF_DRV_SPIS_EVT_TYPE_MAX /**< Enumeration upper bound. */ |
AnnaBridge | 146:22da6e220af6 | 116 | } nrf_drv_spis_event_type_t; |
AnnaBridge | 146:22da6e220af6 | 117 | |
AnnaBridge | 146:22da6e220af6 | 118 | /** @brief Structure containing the event context from the SPI slave driver. */ |
AnnaBridge | 146:22da6e220af6 | 119 | typedef struct |
AnnaBridge | 146:22da6e220af6 | 120 | { |
AnnaBridge | 146:22da6e220af6 | 121 | nrf_drv_spis_event_type_t evt_type; //!< Type of event. |
AnnaBridge | 146:22da6e220af6 | 122 | uint32_t rx_amount; //!< Number of bytes received in last transaction. This parameter is only valid for @ref NRF_DRV_SPIS_XFER_DONE events. |
AnnaBridge | 146:22da6e220af6 | 123 | uint32_t tx_amount; //!< Number of bytes transmitted in last transaction. This parameter is only valid for @ref NRF_DRV_SPIS_XFER_DONE events. |
AnnaBridge | 146:22da6e220af6 | 124 | } nrf_drv_spis_event_t; |
AnnaBridge | 146:22da6e220af6 | 125 | |
AnnaBridge | 146:22da6e220af6 | 126 | /** @brief SPI slave driver instance data structure. */ |
AnnaBridge | 146:22da6e220af6 | 127 | typedef struct |
AnnaBridge | 146:22da6e220af6 | 128 | { |
AnnaBridge | 146:22da6e220af6 | 129 | NRF_SPIS_Type * p_reg; //!< SPIS instance register. |
AnnaBridge | 146:22da6e220af6 | 130 | uint8_t instance_id; //!< SPIS instance ID. |
AnnaBridge | 146:22da6e220af6 | 131 | IRQn_Type irq; //!< IRQ of the specific instance. |
AnnaBridge | 146:22da6e220af6 | 132 | } nrf_drv_spis_t; |
AnnaBridge | 146:22da6e220af6 | 133 | |
AnnaBridge | 146:22da6e220af6 | 134 | /** @brief Macro for creating an SPI slave driver instance. */ |
AnnaBridge | 146:22da6e220af6 | 135 | #define NRF_DRV_SPIS_INSTANCE(id) \ |
AnnaBridge | 146:22da6e220af6 | 136 | { \ |
AnnaBridge | 146:22da6e220af6 | 137 | .p_reg = CONCAT_2(NRF_SPIS, id), \ |
AnnaBridge | 146:22da6e220af6 | 138 | .irq = CONCAT_3(SPIS, id, _IRQ), \ |
AnnaBridge | 146:22da6e220af6 | 139 | .instance_id = CONCAT_3(SPIS, id, _INSTANCE_INDEX), \ |
AnnaBridge | 146:22da6e220af6 | 140 | } |
AnnaBridge | 146:22da6e220af6 | 141 | |
AnnaBridge | 146:22da6e220af6 | 142 | /** @brief SPI slave instance default configuration. */ |
AnnaBridge | 146:22da6e220af6 | 143 | #define NRF_DRV_SPIS_DEFAULT_CONFIG(id) \ |
AnnaBridge | 146:22da6e220af6 | 144 | { \ |
AnnaBridge | 146:22da6e220af6 | 145 | .sck_pin = CONCAT_3(SPIS, id, _CONFIG_SCK_PIN), \ |
AnnaBridge | 146:22da6e220af6 | 146 | .mosi_pin = CONCAT_3(SPIS, id, _CONFIG_MOSI_PIN), \ |
AnnaBridge | 146:22da6e220af6 | 147 | .miso_pin = CONCAT_3(SPIS, id, _CONFIG_MISO_PIN), \ |
AnnaBridge | 146:22da6e220af6 | 148 | .csn_pin = NRF_DRV_SPIS_PIN_NOT_USED, \ |
AnnaBridge | 146:22da6e220af6 | 149 | .miso_drive = NRF_DRV_SPIS_DEFAULT_MISO_DRIVE, \ |
AnnaBridge | 146:22da6e220af6 | 150 | .csn_pullup = NRF_DRV_SPIS_DEFAULT_CSN_PULLUP, \ |
AnnaBridge | 146:22da6e220af6 | 151 | .orc = NRF_DRV_SPIS_DEFAULT_ORC, \ |
AnnaBridge | 146:22da6e220af6 | 152 | .def = NRF_DRV_SPIS_DEFAULT_DEF, \ |
AnnaBridge | 146:22da6e220af6 | 153 | .mode = NRF_DRV_SPIS_MODE_0, \ |
AnnaBridge | 146:22da6e220af6 | 154 | .bit_order = NRF_DRV_SPIS_BIT_ORDER_MSB_FIRST, \ |
AnnaBridge | 146:22da6e220af6 | 155 | .irq_priority = CONCAT_3(SPIS, id, _CONFIG_IRQ_PRIORITY), \ |
AnnaBridge | 146:22da6e220af6 | 156 | } |
AnnaBridge | 146:22da6e220af6 | 157 | |
AnnaBridge | 146:22da6e220af6 | 158 | /** @brief SPI peripheral device configuration data. */ |
AnnaBridge | 146:22da6e220af6 | 159 | typedef struct |
AnnaBridge | 146:22da6e220af6 | 160 | { |
AnnaBridge | 146:22da6e220af6 | 161 | uint32_t miso_pin; //!< SPI MISO pin (optional). |
AnnaBridge | 146:22da6e220af6 | 162 | /**< Set @ref NRF_DRV_SPIS_PIN_NOT_USED |
AnnaBridge | 146:22da6e220af6 | 163 | * if this signal is not needed. */ |
AnnaBridge | 146:22da6e220af6 | 164 | uint32_t mosi_pin; //!< SPI MOSI pin (optional). |
AnnaBridge | 146:22da6e220af6 | 165 | /**< Set @ref NRF_DRV_SPIS_PIN_NOT_USED |
AnnaBridge | 146:22da6e220af6 | 166 | * if this signal is not needed. */ |
AnnaBridge | 146:22da6e220af6 | 167 | uint32_t sck_pin; //!< SPI SCK pin. |
AnnaBridge | 146:22da6e220af6 | 168 | uint32_t csn_pin; //!< SPI CSN pin. |
AnnaBridge | 146:22da6e220af6 | 169 | nrf_drv_spis_mode_t mode; //!< SPI mode. |
AnnaBridge | 146:22da6e220af6 | 170 | nrf_drv_spis_endian_t bit_order; //!< SPI transaction bit order. |
AnnaBridge | 146:22da6e220af6 | 171 | nrf_gpio_pin_pull_t csn_pullup; //!< CSN pin pull-up configuration. |
AnnaBridge | 146:22da6e220af6 | 172 | nrf_gpio_pin_drive_t miso_drive; //!< MISO pin drive configuration. |
AnnaBridge | 146:22da6e220af6 | 173 | uint8_t def; //!< Character clocked out in case of an ignored transaction. |
AnnaBridge | 146:22da6e220af6 | 174 | uint8_t orc; //!< Character clocked out after an over-read of the transmit buffer. |
AnnaBridge | 146:22da6e220af6 | 175 | uint8_t irq_priority; //!< Interrupt priority. |
AnnaBridge | 146:22da6e220af6 | 176 | } nrf_drv_spis_config_t; |
AnnaBridge | 146:22da6e220af6 | 177 | |
AnnaBridge | 146:22da6e220af6 | 178 | |
AnnaBridge | 146:22da6e220af6 | 179 | /** @brief SPI slave event callback function type. |
AnnaBridge | 146:22da6e220af6 | 180 | * |
AnnaBridge | 146:22da6e220af6 | 181 | * @param[in] event SPI slave driver event. |
AnnaBridge | 146:22da6e220af6 | 182 | */ |
AnnaBridge | 146:22da6e220af6 | 183 | typedef void (*nrf_drv_spis_event_handler_t)(nrf_drv_spis_event_t event); |
AnnaBridge | 146:22da6e220af6 | 184 | |
AnnaBridge | 146:22da6e220af6 | 185 | /** @brief Function for initializing the SPI slave driver instance. |
AnnaBridge | 146:22da6e220af6 | 186 | * |
AnnaBridge | 146:22da6e220af6 | 187 | * @param[in] p_instance Pointer to the instance structure. |
AnnaBridge | 146:22da6e220af6 | 188 | * @param[in] p_config Pointer to the structure with the initial configuration. |
AnnaBridge | 146:22da6e220af6 | 189 | * If NULL, the default configuration will be used. |
AnnaBridge | 146:22da6e220af6 | 190 | * @param[in] event_handler Function to be called by the SPI slave driver upon event. |
AnnaBridge | 146:22da6e220af6 | 191 | * |
AnnaBridge | 146:22da6e220af6 | 192 | * @retval NRF_SUCCESS If the initialization was successful. |
AnnaBridge | 146:22da6e220af6 | 193 | * @retval NRF_ERROR_INVALID_PARAM If an invalid parameter is supplied. |
AnnaBridge | 146:22da6e220af6 | 194 | * @retval NRF_ERROR_BUSY If some other peripheral with the same |
AnnaBridge | 146:22da6e220af6 | 195 | * instance ID is already in use. This is |
AnnaBridge | 146:22da6e220af6 | 196 | * possible only if PERIPHERAL_RESOURCE_SHARING_ENABLED |
AnnaBridge | 146:22da6e220af6 | 197 | * is set to a value other than zero. |
AnnaBridge | 146:22da6e220af6 | 198 | */ |
AnnaBridge | 146:22da6e220af6 | 199 | ret_code_t nrf_drv_spis_init(nrf_drv_spis_t const * const p_instance, |
AnnaBridge | 146:22da6e220af6 | 200 | nrf_drv_spis_config_t const * p_config, |
AnnaBridge | 146:22da6e220af6 | 201 | nrf_drv_spis_event_handler_t event_handler); |
AnnaBridge | 146:22da6e220af6 | 202 | |
AnnaBridge | 146:22da6e220af6 | 203 | /** |
AnnaBridge | 146:22da6e220af6 | 204 | * @brief Function for uninitializing the SPI slave driver instance. |
AnnaBridge | 146:22da6e220af6 | 205 | * |
AnnaBridge | 146:22da6e220af6 | 206 | * @param[in] p_instance Pointer to the instance structure. |
AnnaBridge | 146:22da6e220af6 | 207 | */ |
AnnaBridge | 146:22da6e220af6 | 208 | void nrf_drv_spis_uninit(nrf_drv_spis_t const * const p_instance); |
AnnaBridge | 146:22da6e220af6 | 209 | |
AnnaBridge | 146:22da6e220af6 | 210 | /** @brief Function for preparing the SPI slave instance for a single SPI transaction. |
AnnaBridge | 146:22da6e220af6 | 211 | * |
AnnaBridge | 146:22da6e220af6 | 212 | * This function prepares the SPI slave device to be ready for a single SPI transaction. It configures |
AnnaBridge | 146:22da6e220af6 | 213 | * the SPI slave device to use the memory supplied with the function call in SPI transactions. |
AnnaBridge | 146:22da6e220af6 | 214 | * |
AnnaBridge | 146:22da6e220af6 | 215 | * When either the memory buffer configuration or the SPI transaction has been |
AnnaBridge | 146:22da6e220af6 | 216 | * completed, the event callback function will be called with the appropriate event |
AnnaBridge | 146:22da6e220af6 | 217 | * @ref nrf_drv_spis_event_type_t. Note that the callback function can be called before returning from |
AnnaBridge | 146:22da6e220af6 | 218 | * this function, because it is called from the SPI slave interrupt context. |
AnnaBridge | 146:22da6e220af6 | 219 | * |
AnnaBridge | 146:22da6e220af6 | 220 | * @note This function can be called from the callback function context. |
AnnaBridge | 146:22da6e220af6 | 221 | * |
AnnaBridge | 146:22da6e220af6 | 222 | * @note Client applications must call this function after every @ref NRF_DRV_SPIS_XFER_DONE event if |
AnnaBridge | 146:22da6e220af6 | 223 | * the SPI slave driver should be prepared for a possible new SPI transaction. |
AnnaBridge | 146:22da6e220af6 | 224 | * |
AnnaBridge | 146:22da6e220af6 | 225 | * @note Peripherals that are using EasyDMA (for example, SPIS) require the transfer buffers |
AnnaBridge | 146:22da6e220af6 | 226 | * to be placed in the Data RAM region. Otherwise, this function will fail |
AnnaBridge | 146:22da6e220af6 | 227 | * with the error code NRF_ERROR_INVALID_ADDR. |
AnnaBridge | 146:22da6e220af6 | 228 | * |
AnnaBridge | 146:22da6e220af6 | 229 | * @param[in] p_instance SPIS instance. |
AnnaBridge | 146:22da6e220af6 | 230 | * @param[in] p_tx_buffer Pointer to the TX buffer. |
AnnaBridge | 146:22da6e220af6 | 231 | * @param[in] p_rx_buffer Pointer to the RX buffer. |
AnnaBridge | 146:22da6e220af6 | 232 | * @param[in] tx_buffer_length Length of the TX buffer in bytes. |
AnnaBridge | 146:22da6e220af6 | 233 | * @param[in] rx_buffer_length Length of the RX buffer in bytes. |
AnnaBridge | 146:22da6e220af6 | 234 | * |
AnnaBridge | 146:22da6e220af6 | 235 | * @retval NRF_SUCCESS If the operation was successful. |
AnnaBridge | 146:22da6e220af6 | 236 | * @retval NRF_ERROR_NULL If the operation failed because a NULL pointer was supplied. |
AnnaBridge | 146:22da6e220af6 | 237 | * @retval NRF_ERROR_INVALID_STATE If the operation failed because the SPI slave device is in an incorrect state. |
AnnaBridge | 146:22da6e220af6 | 238 | * @retval NRF_ERROR_INVALID_ADDR If the provided buffers are not placed in the Data |
AnnaBridge | 146:22da6e220af6 | 239 | * RAM region. |
AnnaBridge | 146:22da6e220af6 | 240 | * @retval NRF_ERROR_INTERNAL If the operation failed because of an internal error. |
AnnaBridge | 146:22da6e220af6 | 241 | */ |
AnnaBridge | 146:22da6e220af6 | 242 | ret_code_t nrf_drv_spis_buffers_set(nrf_drv_spis_t const * const p_instance, |
AnnaBridge | 146:22da6e220af6 | 243 | const uint8_t * p_tx_buffer, |
AnnaBridge | 146:22da6e220af6 | 244 | uint8_t tx_buffer_length, |
AnnaBridge | 146:22da6e220af6 | 245 | uint8_t * p_rx_buffer, |
AnnaBridge | 146:22da6e220af6 | 246 | uint8_t rx_buffer_length); |
AnnaBridge | 146:22da6e220af6 | 247 | |
AnnaBridge | 146:22da6e220af6 | 248 | #endif // SPI_SLAVE_H__ |
AnnaBridge | 146:22da6e220af6 | 249 | |
AnnaBridge | 146:22da6e220af6 | 250 | /** @} */ |