1 /* mbed Microcontroller Library
2 *******************************************************************************
3 * Copyright (c) 2014, STMicroelectronics
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
9 * 1. Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 * 3. Neither the name of STMicroelectronics nor the names of its contributors
15 * may be used to endorse or promote products derived from this software
16 * without specific prior written permission.
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
24 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
25 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *******************************************************************************
30 #include "mbed_assert.h"
38 #include "PeripheralPins.h"
40 static SPI_HandleTypeDef SpiHandle;
42 static void init_spi(spi_t *obj)
44 SpiHandle.Instance = (SPI_TypeDef *)(obj->spi);
46 __HAL_SPI_DISABLE(&SpiHandle);
48 SpiHandle.Init.Mode = obj->mode;
49 SpiHandle.Init.BaudRatePrescaler = obj->br_presc;
50 SpiHandle.Init.Direction = SPI_DIRECTION_2LINES;
51 SpiHandle.Init.CLKPhase = obj->cpha;
52 SpiHandle.Init.CLKPolarity = obj->cpol;
53 SpiHandle.Init.CRCCalculation = SPI_CRCCALCULATION_DISABLED;
54 SpiHandle.Init.CRCPolynomial = 7;
55 SpiHandle.Init.DataSize = obj->bits;
56 SpiHandle.Init.FirstBit = SPI_FIRSTBIT_MSB;
57 SpiHandle.Init.NSS = obj->nss;
58 SpiHandle.Init.TIMode = SPI_TIMODE_DISABLED;
60 HAL_SPI_Init(&SpiHandle);
62 __HAL_SPI_ENABLE(&SpiHandle);
65 void spi_init(spi_t *obj, PinName mosi, PinName miso, PinName sclk, PinName ssel)
67 // Determine the SPI to use
68 SPIName spi_mosi = (SPIName)pinmap_peripheral(mosi, PinMap_SPI_MOSI);
69 SPIName spi_miso = (SPIName)pinmap_peripheral(miso, PinMap_SPI_MISO);
70 SPIName spi_sclk = (SPIName)pinmap_peripheral(sclk, PinMap_SPI_SCLK);
71 SPIName spi_ssel = (SPIName)pinmap_peripheral(ssel, PinMap_SPI_SSEL);
73 SPIName spi_data = (SPIName)pinmap_merge(spi_mosi, spi_miso);
74 SPIName spi_cntl = (SPIName)pinmap_merge(spi_sclk, spi_ssel);
76 obj->spi = (SPIName)pinmap_merge(spi_data, spi_cntl);
77 MBED_ASSERT(obj->spi != (SPIName)NC);
80 if (obj->spi == SPI_1) {
84 if (obj->spi == SPI_2) {
88 if (obj->spi == SPI_3) {
93 if (obj->spi == SPI_4) {
99 if (obj->spi == SPI_5) {
104 // Configure the SPI pins
105 pinmap_pinout(mosi, PinMap_SPI_MOSI);
106 pinmap_pinout(miso, PinMap_SPI_MISO);
107 pinmap_pinout(sclk, PinMap_SPI_SCLK);
110 obj->bits = SPI_DATASIZE_8BIT;
111 obj->cpol = SPI_POLARITY_LOW;
112 obj->cpha = SPI_PHASE_1EDGE;
113 obj->br_presc = SPI_BAUDRATEPRESCALER_256;
115 obj->pin_miso = miso;
116 obj->pin_mosi = mosi;
117 obj->pin_sclk = sclk;
118 obj->pin_ssel = ssel;
120 if (ssel == NC) { // SW NSS Master mode
121 obj->mode = SPI_MODE_MASTER;
122 obj->nss = SPI_NSS_SOFT;
124 pinmap_pinout(ssel, PinMap_SPI_SSEL);
125 obj->mode = SPI_MODE_SLAVE;
126 obj->nss = SPI_NSS_HARD_INPUT;
132 void spi_free(spi_t *obj)
134 // Reset SPI and disable clock
135 if (obj->spi == SPI_1) {
136 __SPI1_FORCE_RESET();
137 __SPI1_RELEASE_RESET();
138 __SPI1_CLK_DISABLE();
141 if (obj->spi == SPI_2) {
142 __SPI2_FORCE_RESET();
143 __SPI2_RELEASE_RESET();
144 __SPI2_CLK_DISABLE();
147 if (obj->spi == SPI_3) {
148 __SPI3_FORCE_RESET();
149 __SPI3_RELEASE_RESET();
150 __SPI3_CLK_DISABLE();
153 #if defined SPI4_BASE
154 if (obj->spi == SPI_4) {
155 __SPI4_FORCE_RESET();
156 __SPI4_RELEASE_RESET();
157 __SPI4_CLK_DISABLE();
161 #if defined SPI5_BASE
162 if (obj->spi == SPI_5) {
163 __SPI5_FORCE_RESET();
164 __SPI5_RELEASE_RESET();
165 __SPI5_CLK_DISABLE();
170 pin_function(obj->pin_miso, STM_PIN_DATA(STM_MODE_INPUT, GPIO_NOPULL, 0));
171 pin_function(obj->pin_mosi, STM_PIN_DATA(STM_MODE_INPUT, GPIO_NOPULL, 0));
172 pin_function(obj->pin_sclk, STM_PIN_DATA(STM_MODE_INPUT, GPIO_NOPULL, 0));
173 pin_function(obj->pin_ssel, STM_PIN_DATA(STM_MODE_INPUT, GPIO_NOPULL, 0));
176 void spi_format(spi_t *obj, int bits, int mode, int slave)
180 obj->bits = SPI_DATASIZE_16BIT;
182 obj->bits = SPI_DATASIZE_8BIT;
187 obj->cpol = SPI_POLARITY_LOW;
188 obj->cpha = SPI_PHASE_1EDGE;
191 obj->cpol = SPI_POLARITY_LOW;
192 obj->cpha = SPI_PHASE_2EDGE;
195 obj->cpol = SPI_POLARITY_HIGH;
196 obj->cpha = SPI_PHASE_1EDGE;
199 obj->cpol = SPI_POLARITY_HIGH;
200 obj->cpha = SPI_PHASE_2EDGE;
205 obj->mode = SPI_MODE_MASTER;
206 obj->nss = SPI_NSS_SOFT;
208 obj->mode = SPI_MODE_SLAVE;
209 obj->nss = SPI_NSS_HARD_INPUT;
215 void spi_frequency(spi_t *obj, int hz)
217 #if defined(TARGET_STM32F401RE) || defined(TARGET_STM32F401VC) || defined(TARGET_F407VG)
218 // Note: The frequencies are obtained with SPI1 clock = 84 MHz (APB2 clock)
220 obj->br_presc = SPI_BAUDRATEPRESCALER_256; // 330 kHz
221 } else if ((hz >= 600000) && (hz < 1000000)) {
222 obj->br_presc = SPI_BAUDRATEPRESCALER_128; // 656 kHz
223 } else if ((hz >= 1000000) && (hz < 2000000)) {
224 obj->br_presc = SPI_BAUDRATEPRESCALER_64; // 1.3 MHz
225 } else if ((hz >= 2000000) && (hz < 5000000)) {
226 obj->br_presc = SPI_BAUDRATEPRESCALER_32; // 2.6 MHz
227 } else if ((hz >= 5000000) && (hz < 10000000)) {
228 obj->br_presc = SPI_BAUDRATEPRESCALER_16; // 5.25 MHz
229 } else if ((hz >= 10000000) && (hz < 21000000)) {
230 obj->br_presc = SPI_BAUDRATEPRESCALER_8; // 10.5 MHz
231 } else if ((hz >= 21000000) && (hz < 42000000)) {
232 obj->br_presc = SPI_BAUDRATEPRESCALER_4; // 21 MHz
233 } else { // >= 42000000
234 obj->br_presc = SPI_BAUDRATEPRESCALER_2; // 42 MHz
236 #elif defined(TARGET_STM32F405RG)
237 // Note: The frequencies are obtained with SPI1 clock = 48 MHz (APB2 clock)
238 if (obj->spi == SPI_1) {
240 obj->br_presc = SPI_BAUDRATEPRESCALER_256; // 187.5 kHz
241 } else if ((hz >= 375000) && (hz < 750000)) {
242 obj->br_presc = SPI_BAUDRATEPRESCALER_128; // 375 kHz
243 } else if ((hz >= 750000) && (hz < 1500000)) {
244 obj->br_presc = SPI_BAUDRATEPRESCALER_64; // 0.75 MHz
245 } else if ((hz >= 1500000) && (hz < 3000000)) {
246 obj->br_presc = SPI_BAUDRATEPRESCALER_32; // 1.5 MHz
247 } else if ((hz >= 3000000) && (hz < 6000000)) {
248 obj->br_presc = SPI_BAUDRATEPRESCALER_16; // 3 MHz
249 } else if ((hz >= 6000000) && (hz < 12000000)) {
250 obj->br_presc = SPI_BAUDRATEPRESCALER_8; // 6 MHz
251 } else if ((hz >= 12000000) && (hz < 24000000)) {
252 obj->br_presc = SPI_BAUDRATEPRESCALER_4; // 12 MHz
253 } else { // >= 24000000
254 obj->br_presc = SPI_BAUDRATEPRESCALER_2; // 24 MHz
256 // Note: The frequencies are obtained with SPI2/3 clock = 48 MHz (APB1 clock)
257 } else if ((obj->spi == SPI_2) || (obj->spi == SPI_3)) {
259 obj->br_presc = SPI_BAUDRATEPRESCALER_256; // 187.5 kHz
260 } else if ((hz >= 375000) && (hz < 750000)) {
261 obj->br_presc = SPI_BAUDRATEPRESCALER_128; // 375 kHz
262 } else if ((hz >= 750000) && (hz < 1500000)) {
263 obj->br_presc = SPI_BAUDRATEPRESCALER_64; // 0.75 MHz
264 } else if ((hz >= 1500000) && (hz < 3000000)) {
265 obj->br_presc = SPI_BAUDRATEPRESCALER_32; // 1.5 MHz
266 } else if ((hz >= 3000000) && (hz < 6000000)) {
267 obj->br_presc = SPI_BAUDRATEPRESCALER_16; // 3 MHz
268 } else if ((hz >= 6000000) && (hz < 12000000)) {
269 obj->br_presc = SPI_BAUDRATEPRESCALER_8; // 6 MHz
270 } else if ((hz >= 12000000) && (hz < 24000000)) {
271 obj->br_presc = SPI_BAUDRATEPRESCALER_4; // 12 MHz
272 } else { // >= 24000000
273 obj->br_presc = SPI_BAUDRATEPRESCALER_2; // 24 MHz
276 #elif defined(TARGET_STM32F411RE) || defined(TARGET_STM32F429ZI)
277 // Values depend of PCLK2: 100 MHz
278 if ((obj->spi == SPI_1) || (obj->spi == SPI_4) || (obj->spi == SPI_5)) {
280 obj->br_presc = SPI_BAUDRATEPRESCALER_256; // 391 kHz
281 } else if ((hz >= 700000) && (hz < 1000000)) {
282 obj->br_presc = SPI_BAUDRATEPRESCALER_128; // 781 kHz
283 } else if ((hz >= 1000000) && (hz < 3000000)) {
284 obj->br_presc = SPI_BAUDRATEPRESCALER_64; // 1.56 MHz
285 } else if ((hz >= 3000000) && (hz < 6000000)) {
286 obj->br_presc = SPI_BAUDRATEPRESCALER_32; // 3.13 MHz
287 } else if ((hz >= 6000000) && (hz < 12000000)) {
288 obj->br_presc = SPI_BAUDRATEPRESCALER_16; // 6.25 MHz
289 } else if ((hz >= 12000000) && (hz < 25000000)) {
290 obj->br_presc = SPI_BAUDRATEPRESCALER_8; // 12.5 MHz
291 } else if ((hz >= 25000000) && (hz < 50000000)) {
292 obj->br_presc = SPI_BAUDRATEPRESCALER_4; // 25 MHz
293 } else { // >= 50000000
294 obj->br_presc = SPI_BAUDRATEPRESCALER_2; // 50 MHz
298 // Values depend of PCLK1: 50 MHz
299 if ((obj->spi == SPI_2) || (obj->spi == SPI_3)) {
301 obj->br_presc = SPI_BAUDRATEPRESCALER_256; // 195 kHz
302 } else if ((hz >= 400000) && (hz < 700000)) {
303 obj->br_presc = SPI_BAUDRATEPRESCALER_128; // 391 kHz
304 } else if ((hz >= 700000) && (hz < 1000000)) {
305 obj->br_presc = SPI_BAUDRATEPRESCALER_64; // 781 MHz
306 } else if ((hz >= 1000000) && (hz < 3000000)) {
307 obj->br_presc = SPI_BAUDRATEPRESCALER_32; // 1.56 MHz
308 } else if ((hz >= 3000000) && (hz < 6000000)) {
309 obj->br_presc = SPI_BAUDRATEPRESCALER_16; // 3.13 MHz
310 } else if ((hz >= 6000000) && (hz < 12000000)) {
311 obj->br_presc = SPI_BAUDRATEPRESCALER_8; // 6.25 MHz
312 } else if ((hz >= 12000000) && (hz < 25000000)) {
313 obj->br_presc = SPI_BAUDRATEPRESCALER_4; // 12.5 MHz
314 } else { // >= 25000000
315 obj->br_presc = SPI_BAUDRATEPRESCALER_2; // 25 MHz
322 static inline int ssp_readable(spi_t *obj)
325 SpiHandle.Instance = (SPI_TypeDef *)(obj->spi);
326 // Check if data is received
327 status = ((__HAL_SPI_GET_FLAG(&SpiHandle, SPI_FLAG_RXNE) != RESET) ? 1 : 0);
331 static inline int ssp_writeable(spi_t *obj)
334 SpiHandle.Instance = (SPI_TypeDef *)(obj->spi);
335 // Check if data is transmitted
336 status = ((__HAL_SPI_GET_FLAG(&SpiHandle, SPI_FLAG_TXE) != RESET) ? 1 : 0);
340 static inline void ssp_write(spi_t *obj, int value)
342 SPI_TypeDef *spi = (SPI_TypeDef *)(obj->spi);
343 while (!ssp_writeable(obj));
344 spi->DR = (uint16_t)value;
347 static inline int ssp_read(spi_t *obj)
349 SPI_TypeDef *spi = (SPI_TypeDef *)(obj->spi);
350 while (!ssp_readable(obj));
354 static inline int ssp_busy(spi_t *obj)
357 SpiHandle.Instance = (SPI_TypeDef *)(obj->spi);
358 status = ((__HAL_SPI_GET_FLAG(&SpiHandle, SPI_FLAG_BSY) != RESET) ? 1 : 0);
362 int spi_master_write(spi_t *obj, int value)
364 ssp_write(obj, value);
365 return ssp_read(obj);
368 int spi_slave_receive(spi_t *obj)
370 return ((ssp_readable(obj) && !ssp_busy(obj)) ? 1 : 0);
373 int spi_slave_read(spi_t *obj)
375 SPI_TypeDef *spi = (SPI_TypeDef *)(obj->spi);
376 while (!ssp_readable(obj));
380 void spi_slave_write(spi_t *obj, int value)
382 SPI_TypeDef *spi = (SPI_TypeDef *)(obj->spi);
383 while (!ssp_writeable(obj));
384 spi->DR = (uint16_t)value;
387 int spi_busy(spi_t *obj)
389 return ssp_busy(obj);