tool/mbed/mbed-sdk/libraries/mbed/targets/hal/TARGET_STM/TARGET_STM32F3/spi_api.c

   1 /* mbed Microcontroller Library
   2  *******************************************************************************
   3  * Copyright (c) 2014, STMicroelectronics
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are met:
   8  *
   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.
  17  *
  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  *******************************************************************************
  29  */
  30 #include "mbed_assert.h"
  31 #include "spi_api.h"
  32
  33 #if DEVICE_SPI
  34
  35 #include <math.h>
  36 #include "cmsis.h"
  37 #include "pinmap.h"
  38 #include "PeripheralPins.h"
  39
  40 static SPI_HandleTypeDef SpiHandle;
  41
  42 static void init_spi(spi_t *obj)
  43 {
  44     SpiHandle.Instance = (SPI_TypeDef *)(obj->spi);
  45
  46     __HAL_SPI_DISABLE(&SpiHandle);
  47
  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;
  59
  60     HAL_SPI_Init(&SpiHandle);
  61
  62     __HAL_SPI_ENABLE(&SpiHandle);
  63 }
  64
  65 void spi_init(spi_t *obj, PinName mosi, PinName miso, PinName sclk, PinName ssel)
  66 {
  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);
  72
  73     SPIName spi_data = (SPIName)pinmap_merge(spi_mosi, spi_miso);
  74     SPIName spi_cntl = (SPIName)pinmap_merge(spi_sclk, spi_ssel);
  75
  76     obj->spi = (SPIName)pinmap_merge(spi_data, spi_cntl);
  77     MBED_ASSERT(obj->spi != (SPIName)NC);
  78
  79     // Enable SPI clock
  80 #if defined(SPI1_BASE)
  81     if (obj->spi == SPI_1) {
  82         __SPI1_CLK_ENABLE();
  83     }
  84 #endif
  85
  86 #if defined(SPI2_BASE)
  87     if (obj->spi == SPI_2) {
  88         __SPI2_CLK_ENABLE();
  89     }
  90 #endif
  91
  92 #if defined(SPI3_BASE)
  93     if (obj->spi == SPI_3) {
  94         __SPI3_CLK_ENABLE();
  95     }
  96 #endif
  97
  98     // Configure the SPI pins
  99     pinmap_pinout(mosi, PinMap_SPI_MOSI);
 100     pinmap_pinout(miso, PinMap_SPI_MISO);
 101     pinmap_pinout(sclk, PinMap_SPI_SCLK);
 102
 103     // Save new values
 104     obj->bits = SPI_DATASIZE_8BIT;
 105     obj->cpol = SPI_POLARITY_LOW;
 106     obj->cpha = SPI_PHASE_1EDGE;
 107 #if defined(TARGET_STM32F334C8)
 108     obj->br_presc = SPI_BAUDRATEPRESCALER_256;
 109 #else
 110     obj->br_presc = SPI_BAUDRATEPRESCALER_32; // 1 MHz (HSI) or 1.13 MHz (HSE)
 111 #endif
 112
 113     obj->pin_miso = miso;
 114     obj->pin_mosi = mosi;
 115     obj->pin_sclk = sclk;
 116     obj->pin_ssel = ssel;
 117
 118     if (ssel == NC) { // SW NSS Master mode
 119         obj->mode = SPI_MODE_MASTER;
 120         obj->nss = SPI_NSS_SOFT;
 121     } else { // Slave
 122         pinmap_pinout(ssel, PinMap_SPI_SSEL);
 123         obj->mode = SPI_MODE_SLAVE;
 124         obj->nss = SPI_NSS_HARD_INPUT;
 125     }
 126
 127     init_spi(obj);
 128 }
 129
 130 void spi_free(spi_t *obj)
 131 {
 132     // Reset SPI and disable clock
 133 #if defined(SPI1_BASE)
 134     if (obj->spi == SPI_1) {
 135         __SPI1_FORCE_RESET();
 136         __SPI1_RELEASE_RESET();
 137         __SPI1_CLK_DISABLE();
 138     }
 139 #endif
 140
 141 #if defined(SPI2_BASE)
 142     if (obj->spi == SPI_2) {
 143         __SPI2_FORCE_RESET();
 144         __SPI2_RELEASE_RESET();
 145         __SPI2_CLK_DISABLE();
 146     }
 147 #endif
 148
 149 #if defined(SPI3_BASE)
 150     if (obj->spi == SPI_3) {
 151         __SPI3_FORCE_RESET();
 152         __SPI3_RELEASE_RESET();
 153         __SPI3_CLK_DISABLE();
 154     }
 155 #endif
 156
 157     // Configure GPIOs
 158     pin_function(obj->pin_miso, STM_PIN_DATA(STM_MODE_INPUT, GPIO_NOPULL, 0));
 159     pin_function(obj->pin_mosi, STM_PIN_DATA(STM_MODE_INPUT, GPIO_NOPULL, 0));
 160     pin_function(obj->pin_sclk, STM_PIN_DATA(STM_MODE_INPUT, GPIO_NOPULL, 0));
 161     pin_function(obj->pin_ssel, STM_PIN_DATA(STM_MODE_INPUT, GPIO_NOPULL, 0));
 162 }
 163
 164 void spi_format(spi_t *obj, int bits, int mode, int slave)
 165 {
 166     // Save new values
 167     if (bits == 16) {
 168         obj->bits = SPI_DATASIZE_16BIT;
 169     } else {
 170         obj->bits = SPI_DATASIZE_8BIT;
 171     }
 172
 173     switch (mode) {
 174         case 0:
 175             obj->cpol = SPI_POLARITY_LOW;
 176             obj->cpha = SPI_PHASE_1EDGE;
 177             break;
 178         case 1:
 179             obj->cpol = SPI_POLARITY_LOW;
 180             obj->cpha = SPI_PHASE_2EDGE;
 181             break;
 182         case 2:
 183             obj->cpol = SPI_POLARITY_HIGH;
 184             obj->cpha = SPI_PHASE_1EDGE;
 185             break;
 186         default:
 187             obj->cpol = SPI_POLARITY_HIGH;
 188             obj->cpha = SPI_PHASE_2EDGE;
 189             break;
 190     }
 191
 192     if (slave == 0) {
 193         obj->mode = SPI_MODE_MASTER;
 194         obj->nss = SPI_NSS_SOFT;
 195     } else {
 196         obj->mode = SPI_MODE_SLAVE;
 197         obj->nss = SPI_NSS_HARD_INPUT;
 198     }
 199
 200     init_spi(obj);
 201 }
 202
 203 void spi_frequency(spi_t *obj, int hz)
 204 {
 205 #if defined(TARGET_STM32F334C8)
 206     // Values depend of APB2CLK : 64 MHz if HSI is used, 72 MHz if HSE is used
 207     if (hz < 500000) {
 208         obj->br_presc = SPI_BAUDRATEPRESCALER_256; // 250 kHz - 281 kHz
 209     } else if ((hz >= 500000) && (hz < 1000000)) {
 210         obj->br_presc = SPI_BAUDRATEPRESCALER_128; // 500 kHz - 563 kHz
 211     } else if ((hz >= 1000000) && (hz < 2000000)) {
 212         obj->br_presc = SPI_BAUDRATEPRESCALER_64;  // 1 MHz - 1.13 MHz
 213     } else if ((hz >= 2000000) && (hz < 4000000)) {
 214         obj->br_presc = SPI_BAUDRATEPRESCALER_32;  // 2 MHz - 2.25 MHz
 215     } else if ((hz >= 4000000) && (hz < 8000000)) {
 216         obj->br_presc = SPI_BAUDRATEPRESCALER_16;  // 4 MHz - 4.5 MHz
 217     } else if ((hz >= 8000000) && (hz < 16000000)) {
 218         obj->br_presc = SPI_BAUDRATEPRESCALER_8;   // 8 MHz - 9 MHz
 219     } else if ((hz >= 16000000) && (hz < 32000000)) {
 220         obj->br_presc = SPI_BAUDRATEPRESCALER_4;   // 16 MHz - 18 MHz
 221     } else { // >= 32000000
 222         obj->br_presc = SPI_BAUDRATEPRESCALER_2;   // 32 MHz - 36 MHz
 223     }
 224 #elif defined(TARGET_STM32F302R8)
 225         if (hz < 250000) {
 226         obj->br_presc = SPI_BAUDRATEPRESCALER_256; // 125 kHz - 141 kHz
 227     } else if ((hz >= 250000) && (hz < 500000)) {
 228         obj->br_presc = SPI_BAUDRATEPRESCALER_128; // 250 kHz - 280 kHz
 229     } else if ((hz >= 500000) && (hz < 1000000)) {
 230         obj->br_presc = SPI_BAUDRATEPRESCALER_64; // 500 kHz - 560 kHz
 231     } else if ((hz >= 1000000) && (hz < 2000000)) {
 232         obj->br_presc = SPI_BAUDRATEPRESCALER_32; // 1 MHz - 1.13 MHz
 233     } else if ((hz >= 2000000) && (hz < 4000000)) {
 234         obj->br_presc = SPI_BAUDRATEPRESCALER_16; // 2 MHz - 2.25 MHz
 235     } else if ((hz >= 4000000) && (hz < 8000000)) {
 236         obj->br_presc = SPI_BAUDRATEPRESCALER_8; // 4 MHz - 4.5 MHz
 237     } else if ((hz >= 8000000) && (hz < 16000000)) {
 238         obj->br_presc = SPI_BAUDRATEPRESCALER_4; // 8 MHz - 9 MHz
 239     } else { // >= 16000000
 240         obj->br_presc = SPI_BAUDRATEPRESCALER_2; // 16 MHz - 18 MHz
 241     }
 242
 243 #else
 244     // Values depend of APB1CLK and APB2CLK : 32 MHz if HSI is used, 36 MHz if HSE is used
 245     if (obj->spi == SPI_1) {
 246         if (hz < 500000) {
 247             obj->br_presc = SPI_BAUDRATEPRESCALER_256; // 250 kHz - 280 kHz
 248         } else if ((hz >= 500000) && (hz < 1000000)) {
 249             obj->br_presc = SPI_BAUDRATEPRESCALER_128; // 500 kHz - 560 kHz
 250         } else if ((hz >= 1000000) && (hz < 2000000)) {
 251             obj->br_presc = SPI_BAUDRATEPRESCALER_64; // 1 MHz - 1.13 MHz
 252         } else if ((hz >= 2000000) && (hz < 4000000)) {
 253             obj->br_presc = SPI_BAUDRATEPRESCALER_32; // 2 MHz - 2.25 MHz
 254         } else if ((hz >= 4000000) && (hz < 8000000)) {
 255             obj->br_presc = SPI_BAUDRATEPRESCALER_16; // 4 MHz - 4.5 MHz
 256         } else if ((hz >= 8000000) && (hz < 16000000)) {
 257             obj->br_presc = SPI_BAUDRATEPRESCALER_8; // 8 MHz - 9 MHz
 258         } else if ((hz >= 16000000) && (hz < 32000000)) {
 259             obj->br_presc = SPI_BAUDRATEPRESCALER_4; // 16 MHz - 18 MHz
 260         } else { // >= 32000000
 261             obj->br_presc = SPI_BAUDRATEPRESCALER_2; // 32 MHz - 36 MHz
 262         }
 263     } else {
 264         if (hz < 250000) {
 265             obj->br_presc = SPI_BAUDRATEPRESCALER_256; // 125 kHz - 141 kHz
 266         } else if ((hz >= 250000) && (hz < 500000)) {
 267             obj->br_presc = SPI_BAUDRATEPRESCALER_128; // 250 kHz - 280 kHz
 268         } else if ((hz >= 500000) && (hz < 1000000)) {
 269             obj->br_presc = SPI_BAUDRATEPRESCALER_64; // 500 kHz - 560 kHz
 270         } else if ((hz >= 1000000) && (hz < 2000000)) {
 271             obj->br_presc = SPI_BAUDRATEPRESCALER_32; // 1 MHz - 1.13 MHz
 272         } else if ((hz >= 2000000) && (hz < 4000000)) {
 273             obj->br_presc = SPI_BAUDRATEPRESCALER_16; // 2 MHz - 2.25 MHz
 274         } else if ((hz >= 4000000) && (hz < 8000000)) {
 275             obj->br_presc = SPI_BAUDRATEPRESCALER_8; // 4 MHz - 4.5 MHz
 276         } else if ((hz >= 8000000) && (hz < 16000000)) {
 277             obj->br_presc = SPI_BAUDRATEPRESCALER_4; // 8 MHz - 9 MHz
 278         } else { // >= 16000000
 279             obj->br_presc = SPI_BAUDRATEPRESCALER_2; // 16 MHz - 18 MHz
 280         }
 281     }
 282 #endif
 283
 284     init_spi(obj);
 285 }
 286
 287 static inline int ssp_readable(spi_t *obj)
 288 {
 289     int status;
 290     SpiHandle.Instance = (SPI_TypeDef *)(obj->spi);
 291     // Check if data is received
 292     status = ((__HAL_SPI_GET_FLAG(&SpiHandle, SPI_FLAG_RXNE) != RESET) ? 1 : 0);
 293     return status;
 294 }
 295
 296 static inline int ssp_writeable(spi_t *obj)
 297 {
 298     int status;
 299     SpiHandle.Instance = (SPI_TypeDef *)(obj->spi);
 300     // Check if data is transmitted
 301     status = ((__HAL_SPI_GET_FLAG(&SpiHandle, SPI_FLAG_TXE) != RESET) ? 1 : 0);
 302     return status;
 303 }
 304
 305 static inline void ssp_write(spi_t *obj, int value)
 306 {
 307     SPI_TypeDef *spi = (SPI_TypeDef *)(obj->spi);
 308     while (!ssp_writeable(obj));
 309     if (obj->bits == SPI_DATASIZE_8BIT) {
 310         // Force 8-bit access to the data register
 311         uint8_t *p_spi_dr = 0;
 312         p_spi_dr = (uint8_t *) & (spi->DR);
 313         *p_spi_dr = (uint8_t)value;
 314     } else { // SPI_DATASIZE_16BIT
 315         spi->DR = (uint16_t)value;
 316     }
 317 }
 318
 319 static inline int ssp_read(spi_t *obj)
 320 {
 321     SPI_TypeDef *spi = (SPI_TypeDef *)(obj->spi);
 322     while (!ssp_readable(obj));
 323     if (obj->bits == SPI_DATASIZE_8BIT) {
 324         // Force 8-bit access to the data register
 325         uint8_t *p_spi_dr = 0;
 326         p_spi_dr = (uint8_t *) & (spi->DR);
 327         return (int)(*p_spi_dr);
 328     } else {
 329         return (int)spi->DR;
 330     }
 331 }
 332
 333 static inline int ssp_busy(spi_t *obj)
 334 {
 335     int status;
 336     SpiHandle.Instance = (SPI_TypeDef *)(obj->spi);
 337     status = ((__HAL_SPI_GET_FLAG(&SpiHandle, SPI_FLAG_BSY) != RESET) ? 1 : 0);
 338     return status;
 339 }
 340
 341 int spi_master_write(spi_t *obj, int value)
 342 {
 343     ssp_write(obj, value);
 344     return ssp_read(obj);
 345 }
 346
 347 int spi_slave_receive(spi_t *obj)
 348 {
 349     return ((ssp_readable(obj) && !ssp_busy(obj)) ? 1 : 0);
 350 };
 351
 352 int spi_slave_read(spi_t *obj)
 353 {
 354     SPI_TypeDef *spi = (SPI_TypeDef *)(obj->spi);
 355     while (!ssp_readable(obj));
 356     if (obj->bits == SPI_DATASIZE_8BIT) {
 357         // Force 8-bit access to the data register
 358         uint8_t *p_spi_dr = 0;
 359         p_spi_dr = (uint8_t *) & (spi->DR);
 360         return (int)(*p_spi_dr);
 361     } else {
 362         return (int)spi->DR;
 363     }
 364 }
 365
 366 void spi_slave_write(spi_t *obj, int value)
 367 {
 368     SPI_TypeDef *spi = (SPI_TypeDef *)(obj->spi);
 369     while (!ssp_writeable(obj));
 370     if (obj->bits == SPI_DATASIZE_8BIT) {
 371         // Force 8-bit access to the data register
 372         uint8_t *p_spi_dr = 0;
 373         p_spi_dr = (uint8_t *) & (spi->DR);
 374         *p_spi_dr = (uint8_t)value;
 375     } else { // SPI_DATASIZE_16BIT
 376         spi->DR = (uint16_t)value;
 377     }
 378 }
 379
 380 int spi_busy(spi_t *obj)
 381 {
 382     return ssp_busy(obj);
 383 }
 384
 385 #endif