1*150812a8SEvalZero /*
2*150812a8SEvalZero * Copyright (c) 2015 - 2018, Nordic Semiconductor ASA
3*150812a8SEvalZero * All rights reserved.
4*150812a8SEvalZero *
5*150812a8SEvalZero * Redistribution and use in source and binary forms, with or without
6*150812a8SEvalZero * modification, are permitted provided that the following conditions are met:
7*150812a8SEvalZero *
8*150812a8SEvalZero * 1. Redistributions of source code must retain the above copyright notice, this
9*150812a8SEvalZero * list of conditions and the following disclaimer.
10*150812a8SEvalZero *
11*150812a8SEvalZero * 2. Redistributions in binary form must reproduce the above copyright
12*150812a8SEvalZero * notice, this list of conditions and the following disclaimer in the
13*150812a8SEvalZero * documentation and/or other materials provided with the distribution.
14*150812a8SEvalZero *
15*150812a8SEvalZero * 3. Neither the name of the copyright holder nor the names of its
16*150812a8SEvalZero * contributors may be used to endorse or promote products derived from this
17*150812a8SEvalZero * software without specific prior written permission.
18*150812a8SEvalZero *
19*150812a8SEvalZero * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20*150812a8SEvalZero * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21*150812a8SEvalZero * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22*150812a8SEvalZero * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23*150812a8SEvalZero * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24*150812a8SEvalZero * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25*150812a8SEvalZero * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26*150812a8SEvalZero * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27*150812a8SEvalZero * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28*150812a8SEvalZero * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29*150812a8SEvalZero * POSSIBILITY OF SUCH DAMAGE.
30*150812a8SEvalZero */
31*150812a8SEvalZero
32*150812a8SEvalZero #ifndef NRF_SPIS_H__
33*150812a8SEvalZero #define NRF_SPIS_H__
34*150812a8SEvalZero
35*150812a8SEvalZero #include <nrfx.h>
36*150812a8SEvalZero
37*150812a8SEvalZero #ifdef __cplusplus
38*150812a8SEvalZero extern "C" {
39*150812a8SEvalZero #endif
40*150812a8SEvalZero
41*150812a8SEvalZero /**
42*150812a8SEvalZero * @defgroup nrf_spis_hal SPIS HAL
43*150812a8SEvalZero * @{
44*150812a8SEvalZero * @ingroup nrf_spis
45*150812a8SEvalZero * @brief Hardware access layer for managing the SPIS peripheral.
46*150812a8SEvalZero */
47*150812a8SEvalZero
48*150812a8SEvalZero /**
49*150812a8SEvalZero * @brief This value can be used as a parameter for the @ref nrf_spis_pins_set
50*150812a8SEvalZero * function to specify that a given SPI signal (SCK, MOSI, or MISO)
51*150812a8SEvalZero * shall not be connected to a physical pin.
52*150812a8SEvalZero */
53*150812a8SEvalZero #define NRF_SPIS_PIN_NOT_CONNECTED 0xFFFFFFFF
54*150812a8SEvalZero
55*150812a8SEvalZero
56*150812a8SEvalZero /**
57*150812a8SEvalZero * @brief SPIS tasks.
58*150812a8SEvalZero */
59*150812a8SEvalZero typedef enum
60*150812a8SEvalZero {
61*150812a8SEvalZero /*lint -save -e30*/
62*150812a8SEvalZero NRF_SPIS_TASK_ACQUIRE = offsetof(NRF_SPIS_Type, TASKS_ACQUIRE), ///< Acquire SPI semaphore.
63*150812a8SEvalZero NRF_SPIS_TASK_RELEASE = offsetof(NRF_SPIS_Type, TASKS_RELEASE), ///< Release SPI semaphore, enabling the SPI slave to acquire it.
64*150812a8SEvalZero /*lint -restore*/
65*150812a8SEvalZero } nrf_spis_task_t;
66*150812a8SEvalZero
67*150812a8SEvalZero /**
68*150812a8SEvalZero * @brief SPIS events.
69*150812a8SEvalZero */
70*150812a8SEvalZero typedef enum
71*150812a8SEvalZero {
72*150812a8SEvalZero /*lint -save -e30*/
73*150812a8SEvalZero NRF_SPIS_EVENT_END = offsetof(NRF_SPIS_Type, EVENTS_END), ///< Granted transaction completed.
74*150812a8SEvalZero NRF_SPIS_EVENT_ACQUIRED = offsetof(NRF_SPIS_Type, EVENTS_ACQUIRED) ///< Semaphore acquired.
75*150812a8SEvalZero /*lint -restore*/
76*150812a8SEvalZero } nrf_spis_event_t;
77*150812a8SEvalZero
78*150812a8SEvalZero /**
79*150812a8SEvalZero * @brief SPIS shortcuts.
80*150812a8SEvalZero */
81*150812a8SEvalZero typedef enum
82*150812a8SEvalZero {
83*150812a8SEvalZero NRF_SPIS_SHORT_END_ACQUIRE = SPIS_SHORTS_END_ACQUIRE_Msk ///< Shortcut between END event and ACQUIRE task.
84*150812a8SEvalZero } nrf_spis_short_mask_t;
85*150812a8SEvalZero
86*150812a8SEvalZero /**
87*150812a8SEvalZero * @brief SPIS interrupts.
88*150812a8SEvalZero */
89*150812a8SEvalZero typedef enum
90*150812a8SEvalZero {
91*150812a8SEvalZero NRF_SPIS_INT_END_MASK = SPIS_INTENSET_END_Msk, ///< Interrupt on END event.
92*150812a8SEvalZero NRF_SPIS_INT_ACQUIRED_MASK = SPIS_INTENSET_ACQUIRED_Msk ///< Interrupt on ACQUIRED event.
93*150812a8SEvalZero } nrf_spis_int_mask_t;
94*150812a8SEvalZero
95*150812a8SEvalZero /**
96*150812a8SEvalZero * @brief SPI modes.
97*150812a8SEvalZero */
98*150812a8SEvalZero typedef enum
99*150812a8SEvalZero {
100*150812a8SEvalZero NRF_SPIS_MODE_0, ///< SCK active high, sample on leading edge of clock.
101*150812a8SEvalZero NRF_SPIS_MODE_1, ///< SCK active high, sample on trailing edge of clock.
102*150812a8SEvalZero NRF_SPIS_MODE_2, ///< SCK active low, sample on leading edge of clock.
103*150812a8SEvalZero NRF_SPIS_MODE_3 ///< SCK active low, sample on trailing edge of clock.
104*150812a8SEvalZero } nrf_spis_mode_t;
105*150812a8SEvalZero
106*150812a8SEvalZero /**
107*150812a8SEvalZero * @brief SPI bit orders.
108*150812a8SEvalZero */
109*150812a8SEvalZero typedef enum
110*150812a8SEvalZero {
111*150812a8SEvalZero NRF_SPIS_BIT_ORDER_MSB_FIRST = SPIS_CONFIG_ORDER_MsbFirst, ///< Most significant bit shifted out first.
112*150812a8SEvalZero NRF_SPIS_BIT_ORDER_LSB_FIRST = SPIS_CONFIG_ORDER_LsbFirst ///< Least significant bit shifted out first.
113*150812a8SEvalZero } nrf_spis_bit_order_t;
114*150812a8SEvalZero
115*150812a8SEvalZero /**
116*150812a8SEvalZero * @brief SPI semaphore status.
117*150812a8SEvalZero */
118*150812a8SEvalZero typedef enum
119*150812a8SEvalZero {
120*150812a8SEvalZero NRF_SPIS_SEMSTAT_FREE = 0, ///< Semaphore is free.
121*150812a8SEvalZero NRF_SPIS_SEMSTAT_CPU = 1, ///< Semaphore is assigned to the CPU.
122*150812a8SEvalZero NRF_SPIS_SEMSTAT_SPIS = 2, ///< Semaphore is assigned to the SPI slave.
123*150812a8SEvalZero NRF_SPIS_SEMSTAT_CPUPENDING = 3 ///< Semaphore is assigned to the SPI, but a handover to the CPU is pending.
124*150812a8SEvalZero } nrf_spis_semstat_t;
125*150812a8SEvalZero
126*150812a8SEvalZero /**
127*150812a8SEvalZero * @brief SPIS status.
128*150812a8SEvalZero */
129*150812a8SEvalZero typedef enum
130*150812a8SEvalZero {
131*150812a8SEvalZero NRF_SPIS_STATUS_OVERREAD = SPIS_STATUS_OVERREAD_Msk, ///< TX buffer over-read detected and prevented.
132*150812a8SEvalZero NRF_SPIS_STATUS_OVERFLOW = SPIS_STATUS_OVERFLOW_Msk ///< RX buffer overflow detected and prevented.
133*150812a8SEvalZero } nrf_spis_status_mask_t;
134*150812a8SEvalZero
135*150812a8SEvalZero /**
136*150812a8SEvalZero * @brief Function for activating a specific SPIS task.
137*150812a8SEvalZero *
138*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
139*150812a8SEvalZero * @param[in] spis_task Task to activate.
140*150812a8SEvalZero */
141*150812a8SEvalZero __STATIC_INLINE void nrf_spis_task_trigger(NRF_SPIS_Type * p_reg,
142*150812a8SEvalZero nrf_spis_task_t spis_task);
143*150812a8SEvalZero
144*150812a8SEvalZero /**
145*150812a8SEvalZero * @brief Function for getting the address of a specific SPIS task register.
146*150812a8SEvalZero *
147*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
148*150812a8SEvalZero * @param[in] spis_task Requested task.
149*150812a8SEvalZero *
150*150812a8SEvalZero * @return Address of the specified task register.
151*150812a8SEvalZero */
152*150812a8SEvalZero __STATIC_INLINE uint32_t nrf_spis_task_address_get(NRF_SPIS_Type const * p_reg,
153*150812a8SEvalZero nrf_spis_task_t spis_task);
154*150812a8SEvalZero
155*150812a8SEvalZero /**
156*150812a8SEvalZero * @brief Function for clearing a specific SPIS event.
157*150812a8SEvalZero *
158*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
159*150812a8SEvalZero * @param[in] spis_event Event to clear.
160*150812a8SEvalZero */
161*150812a8SEvalZero __STATIC_INLINE void nrf_spis_event_clear(NRF_SPIS_Type * p_reg,
162*150812a8SEvalZero nrf_spis_event_t spis_event);
163*150812a8SEvalZero
164*150812a8SEvalZero /**
165*150812a8SEvalZero * @brief Function for checking the state of a specific SPIS event.
166*150812a8SEvalZero *
167*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
168*150812a8SEvalZero * @param[in] spis_event Event to check.
169*150812a8SEvalZero *
170*150812a8SEvalZero * @retval true If the event is set.
171*150812a8SEvalZero * @retval false If the event is not set.
172*150812a8SEvalZero */
173*150812a8SEvalZero __STATIC_INLINE bool nrf_spis_event_check(NRF_SPIS_Type const * p_reg,
174*150812a8SEvalZero nrf_spis_event_t spis_event);
175*150812a8SEvalZero
176*150812a8SEvalZero /**
177*150812a8SEvalZero * @brief Function for getting the address of a specific SPIS event register.
178*150812a8SEvalZero *
179*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
180*150812a8SEvalZero * @param[in] spis_event Requested event.
181*150812a8SEvalZero *
182*150812a8SEvalZero * @return Address of the specified event register.
183*150812a8SEvalZero */
184*150812a8SEvalZero __STATIC_INLINE uint32_t nrf_spis_event_address_get(NRF_SPIS_Type const * p_reg,
185*150812a8SEvalZero nrf_spis_event_t spis_event);
186*150812a8SEvalZero
187*150812a8SEvalZero /**
188*150812a8SEvalZero * @brief Function for enabling specified shortcuts.
189*150812a8SEvalZero *
190*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
191*150812a8SEvalZero * @param[in] spis_shorts_mask Shortcuts to enable.
192*150812a8SEvalZero */
193*150812a8SEvalZero __STATIC_INLINE void nrf_spis_shorts_enable(NRF_SPIS_Type * p_reg,
194*150812a8SEvalZero uint32_t spis_shorts_mask);
195*150812a8SEvalZero
196*150812a8SEvalZero /**
197*150812a8SEvalZero * @brief Function for disabling specified shortcuts.
198*150812a8SEvalZero *
199*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
200*150812a8SEvalZero * @param[in] spis_shorts_mask Shortcuts to disable.
201*150812a8SEvalZero */
202*150812a8SEvalZero __STATIC_INLINE void nrf_spis_shorts_disable(NRF_SPIS_Type * p_reg,
203*150812a8SEvalZero uint32_t spis_shorts_mask);
204*150812a8SEvalZero
205*150812a8SEvalZero /**
206*150812a8SEvalZero * @brief Function for enabling specified interrupts.
207*150812a8SEvalZero *
208*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
209*150812a8SEvalZero * @param[in] spis_int_mask Interrupts to enable.
210*150812a8SEvalZero */
211*150812a8SEvalZero __STATIC_INLINE void nrf_spis_int_enable(NRF_SPIS_Type * p_reg,
212*150812a8SEvalZero uint32_t spis_int_mask);
213*150812a8SEvalZero
214*150812a8SEvalZero /**
215*150812a8SEvalZero * @brief Function for disabling specified interrupts.
216*150812a8SEvalZero *
217*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
218*150812a8SEvalZero * @param[in] spis_int_mask Interrupts to disable.
219*150812a8SEvalZero */
220*150812a8SEvalZero __STATIC_INLINE void nrf_spis_int_disable(NRF_SPIS_Type * p_reg,
221*150812a8SEvalZero uint32_t spis_int_mask);
222*150812a8SEvalZero
223*150812a8SEvalZero /**
224*150812a8SEvalZero * @brief Function for retrieving the state of a given interrupt.
225*150812a8SEvalZero *
226*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
227*150812a8SEvalZero * @param[in] spis_int Interrupt to check.
228*150812a8SEvalZero *
229*150812a8SEvalZero * @retval true If the interrupt is enabled.
230*150812a8SEvalZero * @retval false If the interrupt is not enabled.
231*150812a8SEvalZero */
232*150812a8SEvalZero __STATIC_INLINE bool nrf_spis_int_enable_check(NRF_SPIS_Type const * p_reg,
233*150812a8SEvalZero nrf_spis_int_mask_t spis_int);
234*150812a8SEvalZero
235*150812a8SEvalZero #if defined(DPPI_PRESENT) || defined(__NRFX_DOXYGEN__)
236*150812a8SEvalZero /**
237*150812a8SEvalZero * @brief Function for setting the subscribe configuration for a given
238*150812a8SEvalZero * SPIS task.
239*150812a8SEvalZero *
240*150812a8SEvalZero * @param[in] p_reg Pointer to the structure of registers of the peripheral.
241*150812a8SEvalZero * @param[in] task Task for which to set the configuration.
242*150812a8SEvalZero * @param[in] channel Channel through which to subscribe events.
243*150812a8SEvalZero */
244*150812a8SEvalZero __STATIC_INLINE void nrf_spis_subscribe_set(NRF_SPIS_Type * p_reg,
245*150812a8SEvalZero nrf_spis_task_t task,
246*150812a8SEvalZero uint8_t channel);
247*150812a8SEvalZero
248*150812a8SEvalZero /**
249*150812a8SEvalZero * @brief Function for clearing the subscribe configuration for a given
250*150812a8SEvalZero * SPIS task.
251*150812a8SEvalZero *
252*150812a8SEvalZero * @param[in] p_reg Pointer to the structure of registers of the peripheral.
253*150812a8SEvalZero * @param[in] task Task for which to clear the configuration.
254*150812a8SEvalZero */
255*150812a8SEvalZero __STATIC_INLINE void nrf_spis_subscribe_clear(NRF_SPIS_Type * p_reg,
256*150812a8SEvalZero nrf_spis_task_t task);
257*150812a8SEvalZero
258*150812a8SEvalZero /**
259*150812a8SEvalZero * @brief Function for setting the publish configuration for a given
260*150812a8SEvalZero * SPIS event.
261*150812a8SEvalZero *
262*150812a8SEvalZero * @param[in] p_reg Pointer to the structure of registers of the peripheral.
263*150812a8SEvalZero * @param[in] event Event for which to set the configuration.
264*150812a8SEvalZero * @param[in] channel Channel through which to publish the event.
265*150812a8SEvalZero */
266*150812a8SEvalZero __STATIC_INLINE void nrf_spis_publish_set(NRF_SPIS_Type * p_reg,
267*150812a8SEvalZero nrf_spis_event_t event,
268*150812a8SEvalZero uint8_t channel);
269*150812a8SEvalZero
270*150812a8SEvalZero /**
271*150812a8SEvalZero * @brief Function for clearing the publish configuration for a given
272*150812a8SEvalZero * SPIS event.
273*150812a8SEvalZero *
274*150812a8SEvalZero * @param[in] p_reg Pointer to the structure of registers of the peripheral.
275*150812a8SEvalZero * @param[in] event Event for which to clear the configuration.
276*150812a8SEvalZero */
277*150812a8SEvalZero __STATIC_INLINE void nrf_spis_publish_clear(NRF_SPIS_Type * p_reg,
278*150812a8SEvalZero nrf_spis_event_t event);
279*150812a8SEvalZero #endif // defined(DPPI_PRESENT) || defined(__NRFX_DOXYGEN__)
280*150812a8SEvalZero
281*150812a8SEvalZero /**
282*150812a8SEvalZero * @brief Function for enabling the SPIS peripheral.
283*150812a8SEvalZero *
284*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
285*150812a8SEvalZero */
286*150812a8SEvalZero __STATIC_INLINE void nrf_spis_enable(NRF_SPIS_Type * p_reg);
287*150812a8SEvalZero
288*150812a8SEvalZero /**
289*150812a8SEvalZero * @brief Function for disabling the SPIS peripheral.
290*150812a8SEvalZero *
291*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
292*150812a8SEvalZero */
293*150812a8SEvalZero __STATIC_INLINE void nrf_spis_disable(NRF_SPIS_Type * p_reg);
294*150812a8SEvalZero
295*150812a8SEvalZero /**
296*150812a8SEvalZero * @brief Function for retrieving the SPIS semaphore status.
297*150812a8SEvalZero *
298*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
299*150812a8SEvalZero *
300*150812a8SEvalZero * @returns Current semaphore status.
301*150812a8SEvalZero */
302*150812a8SEvalZero __STATIC_INLINE nrf_spis_semstat_t nrf_spis_semaphore_status_get(NRF_SPIS_Type * p_reg);
303*150812a8SEvalZero
304*150812a8SEvalZero /**
305*150812a8SEvalZero * @brief Function for retrieving the SPIS status.
306*150812a8SEvalZero *
307*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
308*150812a8SEvalZero *
309*150812a8SEvalZero * @returns Current SPIS status.
310*150812a8SEvalZero */
311*150812a8SEvalZero __STATIC_INLINE nrf_spis_status_mask_t nrf_spis_status_get(NRF_SPIS_Type * p_reg);
312*150812a8SEvalZero
313*150812a8SEvalZero /**
314*150812a8SEvalZero * @brief Function for configuring SPIS pins.
315*150812a8SEvalZero *
316*150812a8SEvalZero * If a given signal is not needed, pass the @ref NRF_SPIS_PIN_NOT_CONNECTED
317*150812a8SEvalZero * value instead of its pin number.
318*150812a8SEvalZero *
319*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
320*150812a8SEvalZero * @param[in] sck_pin SCK pin number.
321*150812a8SEvalZero * @param[in] mosi_pin MOSI pin number.
322*150812a8SEvalZero * @param[in] miso_pin MISO pin number.
323*150812a8SEvalZero * @param[in] csn_pin CSN pin number.
324*150812a8SEvalZero */
325*150812a8SEvalZero __STATIC_INLINE void nrf_spis_pins_set(NRF_SPIS_Type * p_reg,
326*150812a8SEvalZero uint32_t sck_pin,
327*150812a8SEvalZero uint32_t mosi_pin,
328*150812a8SEvalZero uint32_t miso_pin,
329*150812a8SEvalZero uint32_t csn_pin);
330*150812a8SEvalZero
331*150812a8SEvalZero /**
332*150812a8SEvalZero * @brief Function for setting the transmit buffer.
333*150812a8SEvalZero *
334*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
335*150812a8SEvalZero * @param[in] p_buffer Pointer to the buffer that contains the data to send.
336*150812a8SEvalZero * @param[in] length Maximum number of data bytes to transmit.
337*150812a8SEvalZero */
338*150812a8SEvalZero __STATIC_INLINE void nrf_spis_tx_buffer_set(NRF_SPIS_Type * p_reg,
339*150812a8SEvalZero uint8_t const * p_buffer,
340*150812a8SEvalZero size_t length);
341*150812a8SEvalZero
342*150812a8SEvalZero /**
343*150812a8SEvalZero * @brief Function for setting the receive buffer.
344*150812a8SEvalZero *
345*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
346*150812a8SEvalZero * @param[in] p_buffer Pointer to the buffer for received data.
347*150812a8SEvalZero * @param[in] length Maximum number of data bytes to receive.
348*150812a8SEvalZero */
349*150812a8SEvalZero __STATIC_INLINE void nrf_spis_rx_buffer_set(NRF_SPIS_Type * p_reg,
350*150812a8SEvalZero uint8_t * p_buffer,
351*150812a8SEvalZero size_t length);
352*150812a8SEvalZero
353*150812a8SEvalZero /**
354*150812a8SEvalZero * @brief Function for getting the number of bytes transmitted
355*150812a8SEvalZero * in the last granted transaction.
356*150812a8SEvalZero *
357*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
358*150812a8SEvalZero *
359*150812a8SEvalZero * @returns Number of bytes transmitted.
360*150812a8SEvalZero */
361*150812a8SEvalZero __STATIC_INLINE size_t nrf_spis_tx_amount_get(NRF_SPIS_Type const * p_reg);
362*150812a8SEvalZero
363*150812a8SEvalZero /**
364*150812a8SEvalZero * @brief Function for getting the number of bytes received
365*150812a8SEvalZero * in the last granted transaction.
366*150812a8SEvalZero *
367*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
368*150812a8SEvalZero *
369*150812a8SEvalZero * @returns Number of bytes received.
370*150812a8SEvalZero */
371*150812a8SEvalZero __STATIC_INLINE size_t nrf_spis_rx_amount_get(NRF_SPIS_Type const * p_reg);
372*150812a8SEvalZero
373*150812a8SEvalZero /**
374*150812a8SEvalZero * @brief Function for setting the SPI configuration.
375*150812a8SEvalZero *
376*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
377*150812a8SEvalZero * @param[in] spi_mode SPI mode.
378*150812a8SEvalZero * @param[in] spi_bit_order SPI bit order.
379*150812a8SEvalZero */
380*150812a8SEvalZero __STATIC_INLINE void nrf_spis_configure(NRF_SPIS_Type * p_reg,
381*150812a8SEvalZero nrf_spis_mode_t spi_mode,
382*150812a8SEvalZero nrf_spis_bit_order_t spi_bit_order);
383*150812a8SEvalZero
384*150812a8SEvalZero /**
385*150812a8SEvalZero * @brief Function for setting the default character.
386*150812a8SEvalZero *
387*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
388*150812a8SEvalZero * @param[in] def Default character that is clocked out in case of
389*150812a8SEvalZero * an overflow of the RXD buffer.
390*150812a8SEvalZero */
391*150812a8SEvalZero __STATIC_INLINE void nrf_spis_def_set(NRF_SPIS_Type * p_reg,
392*150812a8SEvalZero uint8_t def);
393*150812a8SEvalZero
394*150812a8SEvalZero /**
395*150812a8SEvalZero * @brief Function for setting the over-read character.
396*150812a8SEvalZero *
397*150812a8SEvalZero * @param[in] p_reg Pointer to the peripheral registers structure.
398*150812a8SEvalZero * @param[in] orc Over-read character that is clocked out in case of
399*150812a8SEvalZero * an over-read of the TXD buffer.
400*150812a8SEvalZero */
401*150812a8SEvalZero __STATIC_INLINE void nrf_spis_orc_set(NRF_SPIS_Type * p_reg,
402*150812a8SEvalZero uint8_t orc);
403*150812a8SEvalZero
404*150812a8SEvalZero
405*150812a8SEvalZero #ifndef SUPPRESS_INLINE_IMPLEMENTATION
406*150812a8SEvalZero
nrf_spis_task_trigger(NRF_SPIS_Type * p_reg,nrf_spis_task_t spis_task)407*150812a8SEvalZero __STATIC_INLINE void nrf_spis_task_trigger(NRF_SPIS_Type * p_reg,
408*150812a8SEvalZero nrf_spis_task_t spis_task)
409*150812a8SEvalZero {
410*150812a8SEvalZero *((volatile uint32_t *)((uint8_t *)p_reg + (uint32_t)spis_task)) = 0x1UL;
411*150812a8SEvalZero }
412*150812a8SEvalZero
nrf_spis_task_address_get(NRF_SPIS_Type const * p_reg,nrf_spis_task_t spis_task)413*150812a8SEvalZero __STATIC_INLINE uint32_t nrf_spis_task_address_get(NRF_SPIS_Type const * p_reg,
414*150812a8SEvalZero nrf_spis_task_t spis_task)
415*150812a8SEvalZero {
416*150812a8SEvalZero return (uint32_t)p_reg + (uint32_t)spis_task;
417*150812a8SEvalZero }
418*150812a8SEvalZero
nrf_spis_event_clear(NRF_SPIS_Type * p_reg,nrf_spis_event_t spis_event)419*150812a8SEvalZero __STATIC_INLINE void nrf_spis_event_clear(NRF_SPIS_Type * p_reg,
420*150812a8SEvalZero nrf_spis_event_t spis_event)
421*150812a8SEvalZero {
422*150812a8SEvalZero *((volatile uint32_t *)((uint8_t *)p_reg + (uint32_t)spis_event)) = 0x0UL;
423*150812a8SEvalZero #if __CORTEX_M == 0x04
424*150812a8SEvalZero volatile uint32_t dummy = *((volatile uint32_t *)((uint8_t *)p_reg + (uint32_t)spis_event));
425*150812a8SEvalZero (void)dummy;
426*150812a8SEvalZero #endif
427*150812a8SEvalZero }
428*150812a8SEvalZero
nrf_spis_event_check(NRF_SPIS_Type const * p_reg,nrf_spis_event_t spis_event)429*150812a8SEvalZero __STATIC_INLINE bool nrf_spis_event_check(NRF_SPIS_Type const * p_reg,
430*150812a8SEvalZero nrf_spis_event_t spis_event)
431*150812a8SEvalZero {
432*150812a8SEvalZero return (bool)*(volatile uint32_t *)((uint8_t *)p_reg + (uint32_t)spis_event);
433*150812a8SEvalZero }
434*150812a8SEvalZero
nrf_spis_event_address_get(NRF_SPIS_Type const * p_reg,nrf_spis_event_t spis_event)435*150812a8SEvalZero __STATIC_INLINE uint32_t nrf_spis_event_address_get(NRF_SPIS_Type const * p_reg,
436*150812a8SEvalZero nrf_spis_event_t spis_event)
437*150812a8SEvalZero {
438*150812a8SEvalZero return (uint32_t)p_reg + (uint32_t)spis_event;
439*150812a8SEvalZero }
440*150812a8SEvalZero
nrf_spis_shorts_enable(NRF_SPIS_Type * p_reg,uint32_t spis_shorts_mask)441*150812a8SEvalZero __STATIC_INLINE void nrf_spis_shorts_enable(NRF_SPIS_Type * p_reg,
442*150812a8SEvalZero uint32_t spis_shorts_mask)
443*150812a8SEvalZero {
444*150812a8SEvalZero p_reg->SHORTS |= spis_shorts_mask;
445*150812a8SEvalZero }
446*150812a8SEvalZero
nrf_spis_shorts_disable(NRF_SPIS_Type * p_reg,uint32_t spis_shorts_mask)447*150812a8SEvalZero __STATIC_INLINE void nrf_spis_shorts_disable(NRF_SPIS_Type * p_reg,
448*150812a8SEvalZero uint32_t spis_shorts_mask)
449*150812a8SEvalZero {
450*150812a8SEvalZero p_reg->SHORTS &= ~(spis_shorts_mask);
451*150812a8SEvalZero }
452*150812a8SEvalZero
nrf_spis_int_enable(NRF_SPIS_Type * p_reg,uint32_t spis_int_mask)453*150812a8SEvalZero __STATIC_INLINE void nrf_spis_int_enable(NRF_SPIS_Type * p_reg,
454*150812a8SEvalZero uint32_t spis_int_mask)
455*150812a8SEvalZero {
456*150812a8SEvalZero p_reg->INTENSET = spis_int_mask;
457*150812a8SEvalZero }
458*150812a8SEvalZero
nrf_spis_int_disable(NRF_SPIS_Type * p_reg,uint32_t spis_int_mask)459*150812a8SEvalZero __STATIC_INLINE void nrf_spis_int_disable(NRF_SPIS_Type * p_reg,
460*150812a8SEvalZero uint32_t spis_int_mask)
461*150812a8SEvalZero {
462*150812a8SEvalZero p_reg->INTENCLR = spis_int_mask;
463*150812a8SEvalZero }
464*150812a8SEvalZero
nrf_spis_int_enable_check(NRF_SPIS_Type const * p_reg,nrf_spis_int_mask_t spis_int)465*150812a8SEvalZero __STATIC_INLINE bool nrf_spis_int_enable_check(NRF_SPIS_Type const * p_reg,
466*150812a8SEvalZero nrf_spis_int_mask_t spis_int)
467*150812a8SEvalZero {
468*150812a8SEvalZero return (bool)(p_reg->INTENSET & spis_int);
469*150812a8SEvalZero }
470*150812a8SEvalZero
471*150812a8SEvalZero #if defined(DPPI_PRESENT)
nrf_spis_subscribe_set(NRF_SPIS_Type * p_reg,nrf_spis_task_t task,uint8_t channel)472*150812a8SEvalZero __STATIC_INLINE void nrf_spis_subscribe_set(NRF_SPIS_Type * p_reg,
473*150812a8SEvalZero nrf_spis_task_t task,
474*150812a8SEvalZero uint8_t channel)
475*150812a8SEvalZero {
476*150812a8SEvalZero *((volatile uint32_t *) ((uint8_t *) p_reg + (uint32_t) task + 0x80uL)) =
477*150812a8SEvalZero ((uint32_t)channel | SPIS_SUBSCRIBE_ACQUIRE_EN_Msk);
478*150812a8SEvalZero }
479*150812a8SEvalZero
nrf_spis_subscribe_clear(NRF_SPIS_Type * p_reg,nrf_spis_task_t task)480*150812a8SEvalZero __STATIC_INLINE void nrf_spis_subscribe_clear(NRF_SPIS_Type * p_reg,
481*150812a8SEvalZero nrf_spis_task_t task)
482*150812a8SEvalZero {
483*150812a8SEvalZero *((volatile uint32_t *) ((uint8_t *) p_reg + (uint32_t) task + 0x80uL)) = 0;
484*150812a8SEvalZero }
485*150812a8SEvalZero
nrf_spis_publish_set(NRF_SPIS_Type * p_reg,nrf_spis_event_t event,uint8_t channel)486*150812a8SEvalZero __STATIC_INLINE void nrf_spis_publish_set(NRF_SPIS_Type * p_reg,
487*150812a8SEvalZero nrf_spis_event_t event,
488*150812a8SEvalZero uint8_t channel)
489*150812a8SEvalZero {
490*150812a8SEvalZero *((volatile uint32_t *) ((uint8_t *) p_reg + (uint32_t) event + 0x80uL)) =
491*150812a8SEvalZero ((uint32_t)channel | SPIS_PUBLISH_END_EN_Msk);
492*150812a8SEvalZero }
493*150812a8SEvalZero
nrf_spis_publish_clear(NRF_SPIS_Type * p_reg,nrf_spis_event_t event)494*150812a8SEvalZero __STATIC_INLINE void nrf_spis_publish_clear(NRF_SPIS_Type * p_reg,
495*150812a8SEvalZero nrf_spis_event_t event)
496*150812a8SEvalZero {
497*150812a8SEvalZero *((volatile uint32_t *) ((uint8_t *) p_reg + (uint32_t) event + 0x80uL)) = 0;
498*150812a8SEvalZero }
499*150812a8SEvalZero #endif // defined(DPPI_PRESENT)
500*150812a8SEvalZero
nrf_spis_enable(NRF_SPIS_Type * p_reg)501*150812a8SEvalZero __STATIC_INLINE void nrf_spis_enable(NRF_SPIS_Type * p_reg)
502*150812a8SEvalZero {
503*150812a8SEvalZero p_reg->ENABLE = (SPIS_ENABLE_ENABLE_Enabled << SPIS_ENABLE_ENABLE_Pos);
504*150812a8SEvalZero }
505*150812a8SEvalZero
nrf_spis_disable(NRF_SPIS_Type * p_reg)506*150812a8SEvalZero __STATIC_INLINE void nrf_spis_disable(NRF_SPIS_Type * p_reg)
507*150812a8SEvalZero {
508*150812a8SEvalZero p_reg->ENABLE = (SPIS_ENABLE_ENABLE_Disabled << SPIS_ENABLE_ENABLE_Pos);
509*150812a8SEvalZero }
510*150812a8SEvalZero
nrf_spis_semaphore_status_get(NRF_SPIS_Type * p_reg)511*150812a8SEvalZero __STATIC_INLINE nrf_spis_semstat_t nrf_spis_semaphore_status_get(NRF_SPIS_Type * p_reg)
512*150812a8SEvalZero {
513*150812a8SEvalZero return (nrf_spis_semstat_t) ((p_reg->SEMSTAT & SPIS_SEMSTAT_SEMSTAT_Msk)
514*150812a8SEvalZero >> SPIS_SEMSTAT_SEMSTAT_Pos);
515*150812a8SEvalZero }
516*150812a8SEvalZero
nrf_spis_status_get(NRF_SPIS_Type * p_reg)517*150812a8SEvalZero __STATIC_INLINE nrf_spis_status_mask_t nrf_spis_status_get(NRF_SPIS_Type * p_reg)
518*150812a8SEvalZero {
519*150812a8SEvalZero return (nrf_spis_status_mask_t) p_reg->STATUS;
520*150812a8SEvalZero }
521*150812a8SEvalZero
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)522*150812a8SEvalZero __STATIC_INLINE void nrf_spis_pins_set(NRF_SPIS_Type * p_reg,
523*150812a8SEvalZero uint32_t sck_pin,
524*150812a8SEvalZero uint32_t mosi_pin,
525*150812a8SEvalZero uint32_t miso_pin,
526*150812a8SEvalZero uint32_t csn_pin)
527*150812a8SEvalZero {
528*150812a8SEvalZero #if defined (NRF51)
529*150812a8SEvalZero p_reg->PSELSCK = sck_pin;
530*150812a8SEvalZero p_reg->PSELMOSI = mosi_pin;
531*150812a8SEvalZero p_reg->PSELMISO = miso_pin;
532*150812a8SEvalZero p_reg->PSELCSN = csn_pin;
533*150812a8SEvalZero #else
534*150812a8SEvalZero p_reg->PSEL.SCK = sck_pin;
535*150812a8SEvalZero p_reg->PSEL.MOSI = mosi_pin;
536*150812a8SEvalZero p_reg->PSEL.MISO = miso_pin;
537*150812a8SEvalZero p_reg->PSEL.CSN = csn_pin;
538*150812a8SEvalZero #endif
539*150812a8SEvalZero }
540*150812a8SEvalZero
nrf_spis_tx_buffer_set(NRF_SPIS_Type * p_reg,uint8_t const * p_buffer,size_t length)541*150812a8SEvalZero __STATIC_INLINE void nrf_spis_tx_buffer_set(NRF_SPIS_Type * p_reg,
542*150812a8SEvalZero uint8_t const * p_buffer,
543*150812a8SEvalZero size_t length)
544*150812a8SEvalZero {
545*150812a8SEvalZero #if defined (NRF51)
546*150812a8SEvalZero p_reg->TXDPTR = (uint32_t)p_buffer;
547*150812a8SEvalZero p_reg->MAXTX = length;
548*150812a8SEvalZero #else
549*150812a8SEvalZero p_reg->TXD.PTR = (uint32_t)p_buffer;
550*150812a8SEvalZero p_reg->TXD.MAXCNT = length;
551*150812a8SEvalZero #endif
552*150812a8SEvalZero }
553*150812a8SEvalZero
nrf_spis_rx_buffer_set(NRF_SPIS_Type * p_reg,uint8_t * p_buffer,size_t length)554*150812a8SEvalZero __STATIC_INLINE void nrf_spis_rx_buffer_set(NRF_SPIS_Type * p_reg,
555*150812a8SEvalZero uint8_t * p_buffer,
556*150812a8SEvalZero size_t length)
557*150812a8SEvalZero {
558*150812a8SEvalZero #if defined (NRF51)
559*150812a8SEvalZero p_reg->RXDPTR = (uint32_t)p_buffer;
560*150812a8SEvalZero p_reg->MAXRX = length;
561*150812a8SEvalZero #else
562*150812a8SEvalZero p_reg->RXD.PTR = (uint32_t)p_buffer;
563*150812a8SEvalZero p_reg->RXD.MAXCNT = length;
564*150812a8SEvalZero #endif
565*150812a8SEvalZero }
566*150812a8SEvalZero
nrf_spis_tx_amount_get(NRF_SPIS_Type const * p_reg)567*150812a8SEvalZero __STATIC_INLINE size_t nrf_spis_tx_amount_get(NRF_SPIS_Type const * p_reg)
568*150812a8SEvalZero {
569*150812a8SEvalZero #if defined (NRF51)
570*150812a8SEvalZero return p_reg->AMOUNTTX;
571*150812a8SEvalZero #else
572*150812a8SEvalZero return p_reg->TXD.AMOUNT;
573*150812a8SEvalZero #endif
574*150812a8SEvalZero }
575*150812a8SEvalZero
nrf_spis_rx_amount_get(NRF_SPIS_Type const * p_reg)576*150812a8SEvalZero __STATIC_INLINE size_t nrf_spis_rx_amount_get(NRF_SPIS_Type const * p_reg)
577*150812a8SEvalZero {
578*150812a8SEvalZero #if defined (NRF51)
579*150812a8SEvalZero return p_reg->AMOUNTRX;
580*150812a8SEvalZero #else
581*150812a8SEvalZero return p_reg->RXD.AMOUNT;
582*150812a8SEvalZero #endif
583*150812a8SEvalZero }
584*150812a8SEvalZero
nrf_spis_configure(NRF_SPIS_Type * p_reg,nrf_spis_mode_t spi_mode,nrf_spis_bit_order_t spi_bit_order)585*150812a8SEvalZero __STATIC_INLINE void nrf_spis_configure(NRF_SPIS_Type * p_reg,
586*150812a8SEvalZero nrf_spis_mode_t spi_mode,
587*150812a8SEvalZero nrf_spis_bit_order_t spi_bit_order)
588*150812a8SEvalZero {
589*150812a8SEvalZero uint32_t config = (spi_bit_order == NRF_SPIS_BIT_ORDER_MSB_FIRST ?
590*150812a8SEvalZero SPIS_CONFIG_ORDER_MsbFirst : SPIS_CONFIG_ORDER_LsbFirst);
591*150812a8SEvalZero
592*150812a8SEvalZero switch (spi_mode)
593*150812a8SEvalZero {
594*150812a8SEvalZero default:
595*150812a8SEvalZero case NRF_SPIS_MODE_0:
596*150812a8SEvalZero config |= (SPIS_CONFIG_CPOL_ActiveHigh << SPIS_CONFIG_CPOL_Pos) |
597*150812a8SEvalZero (SPIS_CONFIG_CPHA_Leading << SPIS_CONFIG_CPHA_Pos);
598*150812a8SEvalZero break;
599*150812a8SEvalZero
600*150812a8SEvalZero case NRF_SPIS_MODE_1:
601*150812a8SEvalZero config |= (SPIS_CONFIG_CPOL_ActiveHigh << SPIS_CONFIG_CPOL_Pos) |
602*150812a8SEvalZero (SPIS_CONFIG_CPHA_Trailing << SPIS_CONFIG_CPHA_Pos);
603*150812a8SEvalZero break;
604*150812a8SEvalZero
605*150812a8SEvalZero case NRF_SPIS_MODE_2:
606*150812a8SEvalZero config |= (SPIS_CONFIG_CPOL_ActiveLow << SPIS_CONFIG_CPOL_Pos) |
607*150812a8SEvalZero (SPIS_CONFIG_CPHA_Leading << SPIS_CONFIG_CPHA_Pos);
608*150812a8SEvalZero break;
609*150812a8SEvalZero
610*150812a8SEvalZero case NRF_SPIS_MODE_3:
611*150812a8SEvalZero config |= (SPIS_CONFIG_CPOL_ActiveLow << SPIS_CONFIG_CPOL_Pos) |
612*150812a8SEvalZero (SPIS_CONFIG_CPHA_Trailing << SPIS_CONFIG_CPHA_Pos);
613*150812a8SEvalZero break;
614*150812a8SEvalZero }
615*150812a8SEvalZero p_reg->CONFIG = config;
616*150812a8SEvalZero }
617*150812a8SEvalZero
nrf_spis_orc_set(NRF_SPIS_Type * p_reg,uint8_t orc)618*150812a8SEvalZero __STATIC_INLINE void nrf_spis_orc_set(NRF_SPIS_Type * p_reg,
619*150812a8SEvalZero uint8_t orc)
620*150812a8SEvalZero {
621*150812a8SEvalZero p_reg->ORC = orc;
622*150812a8SEvalZero }
623*150812a8SEvalZero
nrf_spis_def_set(NRF_SPIS_Type * p_reg,uint8_t def)624*150812a8SEvalZero __STATIC_INLINE void nrf_spis_def_set(NRF_SPIS_Type * p_reg,
625*150812a8SEvalZero uint8_t def)
626*150812a8SEvalZero {
627*150812a8SEvalZero p_reg->DEF = def;
628*150812a8SEvalZero }
629*150812a8SEvalZero
630*150812a8SEvalZero #endif // SUPPRESS_INLINE_IMPLEMENTATION
631*150812a8SEvalZero
632*150812a8SEvalZero /** @} */
633*150812a8SEvalZero
634*150812a8SEvalZero #ifdef __cplusplus
635*150812a8SEvalZero }
636*150812a8SEvalZero #endif
637*150812a8SEvalZero
638*150812a8SEvalZero #endif // NRF_SPIS_H__
639