STM8 SPI driver (untested).

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2316 35acf78f-673a-0410-8e92-d51de3d6d3f4

2 files changed, 489 insertions, 0 deletions

diff --git a/os/hal/platforms/STM8/spi_lld.c b/os/hal/platforms/STM8/spi_lld.c
new file mode 100644
index 000000000..37b66fc28
--- /dev/null
+++ b/os/hal/platforms/STM8/spi_lld.c
@@ -0,0 +1,296 @@
+/*

+    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.

+

+    This file is part of ChibiOS/RT.

+

+    ChibiOS/RT is free software; you can redistribute it and/or modify

+    it under the terms of the GNU General Public License as published by

+    the Free Software Foundation; either version 3 of the License, or

+    (at your option) any later version.

+

+    ChibiOS/RT is distributed in the hope that it will be useful,

+    but WITHOUT ANY WARRANTY; without even the implied warranty of

+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+    GNU General Public License for more details.

+

+    You should have received a copy of the GNU General Public License

+    along with this program.  If not, see <http://www.gnu.org/licenses/>.

+*/

+

+/**

+ * @file    STM8/spi_lld.c

+ * @brief   STM8 low level SPI driver code.

+ *

+ * @addtogroup SPI

+ * @{

+ */

+

+#include "ch.h"

+#include "hal.h"

+

+#if CH_HAL_USE_SPI || defined(__DOXYGEN__)

+

+/*===========================================================================*/

+/* Driver exported variables.                                                */

+/*===========================================================================*/

+

+#if STM8_SPI_USE_SPI || defined(__DOXYGEN__)

+/** @brief SPI1 driver identifier.*/

+SPIDriver SPID1;

+#endif

+

+/*===========================================================================*/

+/* Driver local variables.                                                   */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver local functions.                                                   */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver interrupt handlers.                                                */

+/*===========================================================================*/

+

+#if STM8_SPI_USE_SPI || defined(__DOXYGEN__)

+/**

+ * @brief   IRQ 10 service routine.

+ *

+ * @isr

+ */

+CH_IRQ_HANDLER(10) {

+

+  CH_IRQ_PROLOGUE();

+

+  if ((SPI->SR & SPI_SR_OVR) != 0) {

+    /* The overflow condition should never happen because priority is given

+       to receive but a hook macro is provided anyway...*/

+    STM8_SPI_SPI_ERROR_HOOK(&SPID1);

+  }

+  /* Handling the DR register like it is a FIFO with depth>1 in order to

+     handle the case where a frame arrives immediately after reading the

+     DR register.*/

+  while ((SPI->SR & SPI_SR_RXNE) != 0) {

+    if (SPID1.spd_rxptr != NULL)

+       *SPID1.spd_rxptr++ = SPI->DR;

+    else

+      (void)SPI->DR;

+    if (--SPID1.spd_rxcnt == 0) {

+      chDbgAssert(SPID1.spd_txcnt == 0,

+                  "IRQ10, #1", "counter out of synch");

+      /* Stops all the IRQ sources.*/

+      SPI->ICR = 0;

+      /* Portable SPI ISR code defined in the high level driver, note, it

+         is a macro.*/

+      _spi_isr_code(&SPID1);

+      /* Goto because it is mandatory to go through the epilogue, cannot

+         just return.*/

+      goto exit_isr;

+    }

+  }

+  /* Loading the DR register like it is a FIFO with depth>1 in order to

+     handle the case where the shift register is empty too.*/

+  while ((SPI->SR & SPI_SR_TXE) != 0) {

+    if (SPID1.spd_txptr != NULL)

+      SPI->DR = *SPID1.spd_txptr++;

+    else

+      SPI->DR = 0xFF;

+    if (--SPID1.spd_txcnt == 0) {

+      /* Stops just the TX interrupt source.*/

+      SPI->ICR &= ~SPI_ICR_TXEI;

+      break;

+    }

+  }

+

+exit_isr:

+  CH_IRQ_EPILOGUE();

+}

+#endif

+

+/*===========================================================================*/

+/* Driver exported functions.                                                */

+/*===========================================================================*/

+

+/**

+ * @brief   Low level SPI driver initialization.

+ *

+ * @notapi

+ */

+void spi_lld_init(void) {

+

+#if STM8_SPI_USE_SPI

+  spiObjectInit(&SPID1);

+#endif /* STM8_SPI_USE_SPI */

+}

+

+/**

+ * @brief   Configures and activates the SPI peripheral.

+ *

+ * @param[in] spip      pointer to the @p SPIDriver object

+ *

+ * @notapi

+ */

+void spi_lld_start(SPIDriver *spip) {

+

+  /* Clock activation.*/

+  CLK->PCKENR1 |= CLK_PCKENR1_SPI;              /* PCKEN11, clock source.       */

+

+  /* Configuration.*/

+  SPI->CR2 = SPI_CR2_SSI;

+  SPI->CR1 = spip->spd_config->spc_cr1 | SPI_CR1_SPE;

+}

+

+/**

+ * @brief   Deactivates the SPI peripheral.

+ *

+ * @param[in] spip      pointer to the @p SPIDriver object

+ *

+ * @notapi

+ */

+void spi_lld_stop(SPIDriver *spip) {

+

+  (void)spip;

+

+  /* Reset state.*/

+  SPI->CR1 = 0;

+  SPI->CR2 = 0;

+  SPI->ICR = 0;

+

+  /* Clock de-activation.*/

+  CLK->PCKENR1 &= ~CLK_PCKENR1_SPI;             /* PCKEN11, clock source.       */

+}

+

+/**

+ * @brief   Asserts the slave select signal and prepares for transfers.

+ *

+ * @param[in] spip      pointer to the @p SPIDriver object

+ *

+ * @notapi

+ */

+void spi_lld_select(SPIDriver *spip) {

+

+  palClearPad(spip->spd_config->spc_ssport, spip->spd_config->spc_sspad);

+}

+

+/**

+ * @brief   Deasserts the slave select signal.

+ * @details The previously selected peripheral is unselected.

+ *

+ * @param[in] spip      pointer to the @p SPIDriver object

+ *

+ * @notapi

+ */

+void spi_lld_unselect(SPIDriver *spip) {

+

+  palSetPad(spip->spd_config->spc_ssport, spip->spd_config->spc_sspad);

+}

+

+/**

+ * @brief   Ignores data on the SPI bus.

+ * @details This function transmits a series of idle words on the SPI bus and

+ *          ignores the received data. This function can be invoked even

+ *          when a slave select signal has not been yet asserted.

+ *

+ * @param[in] spip      pointer to the @p SPIDriver object

+ * @param[in] n         number of words to be ignored

+ *

+ * @notapi

+ */

+void spi_lld_ignore(SPIDriver *spip, size_t n) {

+

+  spip->spd_rxptr = NULL;

+  spip->spd_txptr = NULL;

+  spip->spd_rxcnt = spip->spd_txcnt = n;

+  SPI->ICR = SPI_ICR_TXEI | SPI_ICR_RXEI | SPI_ICR_ERRIE;

+}

+

+/**

+ * @brief   Exchanges data on the SPI bus.

+ * @details This asynchronous function starts a simultaneous transmit/receive

+ *          operation.

+ * @post    At the end of the operation the configured callback is invoked.

+ * @note    The buffers are organized as uint8_t arrays for data sizes below or

+ *          equal to 8 bits else it is organized as uint16_t arrays.

+ *

+ * @param[in] spip      pointer to the @p SPIDriver object

+ * @param[in] n         number of words to be exchanged

+ * @param[in] txbuf     the pointer to the transmit buffer

+ * @param[out] rxbuf    the pointer to the receive buffer

+ *

+ * @notapi

+ */

+void spi_lld_exchange(SPIDriver *spip, size_t n,

+                      const void *txbuf, void *rxbuf) {

+

+  spip->spd_rxptr = rxbuf;

+  spip->spd_txptr = txbuf;

+  spip->spd_rxcnt = spip->spd_txcnt = n;

+  SPI->ICR = SPI_ICR_TXEI | SPI_ICR_RXEI | SPI_ICR_ERRIE;

+}

+

+/**

+ * @brief   Sends data over the SPI bus.

+ * @details This asynchronous function starts a transmit operation.

+ * @post    At the end of the operation the configured callback is invoked.

+ * @note    The buffers are organized as uint8_t arrays for data sizes below or

+ *          equal to 8 bits else it is organized as uint16_t arrays.

+ *

+ * @param[in] spip      pointer to the @p SPIDriver object

+ * @param[in] n         number of words to send

+ * @param[in] txbuf     the pointer to the transmit buffer

+ *

+ * @notapi

+ */

+void spi_lld_send(SPIDriver *spip, size_t n, const void *txbuf) {

+

+  spip->spd_rxptr = NULL;

+  spip->spd_txptr = txbuf;

+  spip->spd_rxcnt = spip->spd_txcnt = n;

+  SPI->ICR = SPI_ICR_TXEI | SPI_ICR_RXEI | SPI_ICR_ERRIE;

+}

+

+/**

+ * @brief   Receives data from the SPI bus.

+ * @details This asynchronous function starts a receive operation.

+ * @post    At the end of the operation the configured callback is invoked.

+ * @note    The buffers are organized as uint8_t arrays for data sizes below or

+ *          equal to 8 bits else it is organized as uint16_t arrays.

+ *

+ * @param[in] spip      pointer to the @p SPIDriver object

+ * @param[in] n         number of words to receive

+ * @param[out] rxbuf    the pointer to the receive buffer

+ *

+ * @notapi

+ */

+void spi_lld_receive(SPIDriver *spip, size_t n, void *rxbuf) {

+

+  spip->spd_rxptr = rxbuf;

+  spip->spd_txptr = NULL;

+  spip->spd_rxcnt = spip->spd_txcnt = n;

+  SPI->ICR = SPI_ICR_TXEI | SPI_ICR_RXEI | SPI_ICR_ERRIE;

+}

+

+/**

+ * @brief   Exchanges one frame using a polled wait.

+ * @details This synchronous function exchanges one frame using a polled

+ *          synchronization method. This function is useful when exchanging

+ *          small amount of data on high speed channels, usually in this

+ *          situation is much more efficient just wait for completion using

+ *          polling than suspending the thread waiting for an interrupt.

+ *

+ * @param[in] spip      pointer to the @p SPIDriver object

+ * @param[in] frame     the data frame to send over the SPI bus

+ * @return              The received data frame from the SPI bus.

+ */

+uint8_t spi_lld_polled_exchange(SPIDriver *spip, uint8_t frame) {

+

+  (void)spip;

+

+  SPI->DR = (uint32_t)frame;

+  while ((SPI->SR & SPI_SR_RXNE) == 0)

+    ;

+  return (uint16_t)SPI->DR;

+}

+

+#endif /* CH_HAL_USE_SPI */

+

+/** @} */

diff --git a/os/hal/platforms/STM8/spi_lld.h b/os/hal/platforms/STM8/spi_lld.h
new file mode 100644
index 000000000..a66f83ad7
--- /dev/null
+++ b/os/hal/platforms/STM8/spi_lld.h
@@ -0,0 +1,193 @@
+/*

+    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.

+

+    This file is part of ChibiOS/RT.

+

+    ChibiOS/RT is free software; you can redistribute it and/or modify

+    it under the terms of the GNU General Public License as published by

+    the Free Software Foundation; either version 3 of the License, or

+    (at your option) any later version.

+

+    ChibiOS/RT is distributed in the hope that it will be useful,

+    but WITHOUT ANY WARRANTY; without even the implied warranty of

+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+    GNU General Public License for more details.

+

+    You should have received a copy of the GNU General Public License

+    along with this program.  If not, see <http://www.gnu.org/licenses/>.

+*/

+

+/**

+ * @file    LPC13xx/spi_lld.h

+ * @brief   LPC13xx low level SPI driver header.

+ *

+ * @addtogroup SPI

+ * @{

+ */

+

+#ifndef _SPI_LLD_H_

+#define _SPI_LLD_H_

+

+#if CH_HAL_USE_SPI || defined(__DOXYGEN__)

+

+/*===========================================================================*/

+/* Driver constants.                                                         */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver pre-compile time settings.                                         */

+/*===========================================================================*/

+

+/**

+ * @brief   SPI1 driver enable switch.

+ * @details If set to @p TRUE the support for device SSP0 is included.

+ * @note    The default is @p TRUE.

+ */

+#if !defined(STM8_SPI_USE_SPI) || defined(__DOXYGEN__)

+#define STM8_SPI_USE_SPI                TRUE

+#endif

+

+/**

+ * @brief   Overflow error hook.

+ * @details The default action is to stop the system.

+ */

+#if !defined(STM8_SPI_SPI_ERROR_HOOK) || defined(__DOXYGEN__)

+#define STM8_SPI_SPI_ERROR_HOOK(spip)   chSysHalt()

+#endif

+

+/*===========================================================================*/

+/* Derived constants and error checks.                                       */

+/*===========================================================================*/

+

+#if !STM8_SPI_USE_SPI

+#error "SPI driver activated but no SPI peripheral assigned"

+#endif

+

+/*===========================================================================*/

+/* Driver data structures and types.                                         */

+/*===========================================================================*/

+

+/**

+ * @brief   Type of a structure representing an SPI driver.

+ */

+typedef struct SPIDriver SPIDriver;

+

+/**

+ * @brief   SPI notification callback type.

+ *

+ * @param[in] spip      pointer to the @p SPIDriver object triggering the

+ *                      callback

+ */

+typedef void (*spicallback_t)(SPIDriver *spip);

+

+/**

+ * @brief   Driver configuration structure.

+ */

+typedef struct {

+  /**

+   * @brief Operation complete callback or @p NULL.

+   * @note  In order to use synchronous functions this field must be set to

+   *        @p NULL, callbacks and synchronous operations are mutually

+   *        exclusive.

+   */

+  spicallback_t         spc_endcb;

+  /* End of the mandatory fields.*/

+  /**

+   * @brief The chip select line port.

+   */

+  ioportid_t            spc_ssport;

+  /**

+   * @brief The chip select line pad number.

+   */

+  uint16_t              spc_sspad;

+  /**

+   * @brief SPI initialization data.

+   */

+  uint8_t               spc_cr1;

+} SPIConfig;

+

+/**

+ * @brief   Structure representing a SPI driver.

+ */

+struct SPIDriver {

+  /**

+   * @brief Driver state.

+   */

+  spistate_t            spd_state;

+  /**

+   * @brief Current configuration data.

+   */

+  const SPIConfig       *spd_config;

+#if SPI_USE_WAIT || defined(__DOXYGEN__)

+  /**

+   * @brief Waiting thread.

+   */

+  Thread                *spd_thread;

+#endif /* SPI_USE_WAIT */

+#if SPI_USE_MUTUAL_EXCLUSION || defined(__DOXYGEN__)

+#if CH_USE_MUTEXES || defined(__DOXYGEN__)

+  /**

+   * @brief Mutex protecting the bus.

+   */

+  Mutex                 spd_mutex;

+#elif CH_USE_SEMAPHORES

+  Semaphore             spd_semaphore;

+#endif

+#endif /* SPI_USE_MUTUAL_EXCLUSION */

+#if defined(SPI_DRIVER_EXT_FIELDS)

+  SPI_DRIVER_EXT_FIELDS

+#endif

+  /* End of the mandatory fields.*/

+  /**

+   * @brief Number of bytes yet to be received.
+   */

+  uint16_t              spd_rxcnt;

+  /**

+   * @brief Receive pointer or @p NULL.

+   */

+  uint8_t               *spd_rxptr;

+  /**

+   * @brief Number of bytes yet to be transmitted.

+   */

+  uint16_t              spd_txcnt;

+  /**

+   * @brief Transmit pointer or @p NULL.

+   */

+  const uint8_t         *spd_txptr;

+};

+

+/*===========================================================================*/

+/* Driver macros.                                                            */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* External declarations.                                                    */

+/*===========================================================================*/

+

+#if STM8_SPI_USE_SPI && !defined(__DOXYGEN__)

+extern SPIDriver SPID1;

+#endif

+

+#ifdef __cplusplus

+extern "C" {

+#endif

+  void spi_lld_init(void);

+  void spi_lld_start(SPIDriver *spip);

+  void spi_lld_stop(SPIDriver *spip);

+  void spi_lld_select(SPIDriver *spip);

+  void spi_lld_unselect(SPIDriver *spip);

+  void spi_lld_ignore(SPIDriver *spip, size_t n);

+  void spi_lld_exchange(SPIDriver *spip, size_t n,

+                        const void *txbuf, void *rxbuf);

+  void spi_lld_send(SPIDriver *spip, size_t n, const void *txbuf);

+  void spi_lld_receive(SPIDriver *spip, size_t n, void *rxbuf);

+  uint8_t spi_lld_polled_exchange(SPIDriver *spip, uint8_t frame);

+#ifdef __cplusplus

+}

+#endif

+

+#endif /* CH_HAL_USE_SPI */

+

+#endif /* _SPI_LLD_H_ */

+

+/** @} */