1 /*
2  * Copyright (c) 2015, Freescale Semiconductor, Inc.
3  * Copyright 2016-2017 NXP
4  * All rights reserved.
5  *
6  * SPDX-License-Identifier: BSD-3-Clause
7  */
8 
9 #include "fsl_spi_freertos.h"
10 
11 /* Component ID definition, used by tools. */
12 #ifndef FSL_COMPONENT_ID
13 #define FSL_COMPONENT_ID "platform.drivers.spi_freertos"
14 #endif
15 
SPI_RTOS_Callback(SPI_Type * base,spi_master_handle_t * drv_handle,status_t status,void * userData)16 static void SPI_RTOS_Callback(SPI_Type *base, spi_master_handle_t *drv_handle, status_t status, void *userData)
17 {
18     spi_rtos_handle_t *handle = (spi_rtos_handle_t *)userData;
19     BaseType_t reschedule = pdFALSE;
20     handle->async_status = status;
21     (void)xSemaphoreGiveFromISR(handle->event, &reschedule);
22     portYIELD_FROM_ISR(reschedule);
23 }
24 
25 /*!
26  * brief Initializes SPI.
27  *
28  * This function initializes the SPI module and related RTOS context.
29  *
30  * param handle The RTOS SPI handle, the pointer to an allocated space for RTOS context.
31  * param base The pointer base address of the SPI instance to initialize.
32  * param masterConfig Configuration structure to set-up SPI in master mode.
33  * param srcClock_Hz Frequency of input clock of the SPI module.
34  * return status of the operation.
35  */
SPI_RTOS_Init(spi_rtos_handle_t * handle,SPI_Type * base,const spi_master_config_t * masterConfig,uint32_t srcClock_Hz)36 status_t SPI_RTOS_Init(spi_rtos_handle_t *handle,
37                        SPI_Type *base,
38                        const spi_master_config_t *masterConfig,
39                        uint32_t srcClock_Hz)
40 {
41     if (handle == NULL)
42     {
43         return kStatus_InvalidArgument;
44     }
45 
46     if (base == NULL)
47     {
48         return kStatus_InvalidArgument;
49     }
50 
51     (void)memset(handle, 0, sizeof(spi_rtos_handle_t));
52 #if (configSUPPORT_STATIC_ALLOCATION == 1)
53     handle->mutex = xSemaphoreCreateMutexStatic(&handle->mutexBuffer);
54 #else
55     handle->mutex = xSemaphoreCreateMutex();
56 #endif
57     if (handle->mutex == NULL)
58     {
59         return kStatus_Fail;
60     }
61 
62 #if (configSUPPORT_STATIC_ALLOCATION == 1)
63     handle->event = xSemaphoreCreateBinaryStatic(&handle->semaphoreBuffer);
64 #else
65     handle->event = xSemaphoreCreateBinary();
66 #endif
67     if (handle->event == NULL)
68     {
69         vSemaphoreDelete(handle->mutex);
70         return kStatus_Fail;
71     }
72 
73     handle->base = base;
74 
75     SPI_MasterInit(handle->base, masterConfig, srcClock_Hz);
76     SPI_MasterTransferCreateHandle(handle->base, &handle->drv_handle, SPI_RTOS_Callback, (void *)handle);
77 
78     return kStatus_Success;
79 }
80 
81 /*!
82  * brief Deinitializes the SPI.
83  *
84  * This function deinitializes the SPI module and related RTOS context.
85  *
86  * param handle The RTOS SPI handle.
87  */
SPI_RTOS_Deinit(spi_rtos_handle_t * handle)88 status_t SPI_RTOS_Deinit(spi_rtos_handle_t *handle)
89 {
90     SPI_Deinit(handle->base);
91     vSemaphoreDelete(handle->event);
92     vSemaphoreDelete(handle->mutex);
93 
94     return kStatus_Success;
95 }
96 
97 /*!
98  * brief Performs SPI transfer.
99  *
100  * This function performs an SPI transfer according to data given in the transfer structure.
101  *
102  * param handle The RTOS SPI handle.
103  * param transfer Structure specifying the transfer parameters.
104  * return status of the operation.
105  */
SPI_RTOS_Transfer(spi_rtos_handle_t * handle,spi_transfer_t * transfer)106 status_t SPI_RTOS_Transfer(spi_rtos_handle_t *handle, spi_transfer_t *transfer)
107 {
108     status_t status;
109 
110     /* Lock resource mutex */
111     if (xSemaphoreTake(handle->mutex, portMAX_DELAY) != pdTRUE)
112     {
113         return kStatus_SPI_Busy;
114     }
115 
116     status = SPI_MasterTransferNonBlocking(handle->base, &handle->drv_handle, transfer);
117     if (status != kStatus_Success)
118     {
119         (void)xSemaphoreGive(handle->mutex);
120         return status;
121     }
122 
123     /* Wait for transfer to finish */
124     if (xSemaphoreTake(handle->event, portMAX_DELAY) != pdTRUE)
125     {
126         return kStatus_SPI_Error;
127     }
128 
129     /* Retrieve status before releasing mutex */
130     status = handle->async_status;
131 
132     /* Unlock resource mutex */
133     (void)xSemaphoreGive(handle->mutex);
134 
135     /* Translate status of underlying driver */
136     if (status == kStatus_SPI_Idle)
137     {
138         status = kStatus_Success;
139     }
140 
141     return status;
142 }
143