Fall back SW I2C driver template.

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

2 files changed, 403 insertions, 0 deletions

diff --git a/os/hal/lib/fallback/I2C/hal_i2c_lld.c b/os/hal/lib/fallback/I2C/hal_i2c_lld.c
new file mode 100644
index 000000000..6fbdfdd6d
--- /dev/null
+++ b/os/hal/lib/fallback/I2C/hal_i2c_lld.c
@@ -0,0 +1,209 @@
+/*

+    ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio

+

+    Licensed under the Apache License, Version 2.0 (the "License");

+    you may not use this file except in compliance with the License.

+    You may obtain a copy of the License at

+

+        http://www.apache.org/licenses/LICENSE-2.0

+

+    Unless required by applicable law or agreed to in writing, software

+    distributed under the License is distributed on an "AS IS" BASIS,

+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

+    See the License for the specific language governing permissions and

+    limitations under the License.

+*/

+

+/**

+ * @file    common/I2C/hal_i2c_lld.c

+ * @brief   SW I2C subsystem low level driver source.

+ *

+ * @addtogroup I2C

+ * @{

+ */

+

+#include "hal.h"

+

+#if HAL_USE_I2C || defined(__DOXYGEN__)

+

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

+/* Driver local definitions.                                                 */

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

+

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

+/* Driver constants.                                                         */

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

+

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

+/* Driver exported variables.                                                */

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

+

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

+#if SW_I2C_USE_I2C1 || defined(__DOXYGEN__)

+I2CDriver I2CD1;

+#endif

+

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

+#if SW_I2C_USE_I2C2 || defined(__DOXYGEN__)

+I2CDriver I2CD2;

+#endif

+

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

+#if SW_I2C_USE_I2C3 || defined(__DOXYGEN__)

+I2CDriver I2CD3;

+#endif

+

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

+#if SW_I2C_USE_I2C4 || defined(__DOXYGEN__)

+I2CDriver I2CD4;

+#endif

+

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

+/* Driver local variables and types.                                         */

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

+

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

+/* Driver local functions.                                                   */

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

+

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

+/* Driver interrupt handlers.                                                */

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

+

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

+/* Driver exported functions.                                                */

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

+

+/**

+ * @brief   Low level I2C driver initialization.

+ *

+ * @notapi

+ */

+void i2c_lld_init(void) {

+

+#if SW_I2C_USE_I2C1

+  i2cObjectInit(&I2CD1);

+#endif /* SW_I2C_USE_I2C1 */

+}

+

+/**

+ * @brief   Configures and activates the I2C peripheral.

+ *

+ * @param[in] i2cp      pointer to the @p I2CDriver object

+ *

+ * @notapi

+ */

+void i2c_lld_start(I2CDriver *i2cp) {

+

+  /* If in stopped state then enables the I2C and DMA clocks.*/

+  if (i2cp->state == I2C_STOP) {

+

+#if SW_I2C_USE_I2C1

+    if (&I2CD1 == i2cp) {

+    }

+#endif /* SW_I2C_USE_I2C1 */

+  }

+}

+

+/**

+ * @brief   Deactivates the I2C peripheral.

+ *

+ * @param[in] i2cp      pointer to the @p I2CDriver object

+ *

+ * @notapi

+ */

+void i2c_lld_stop(I2CDriver *i2cp) {

+

+  /* If not in stopped state then disables the I2C clock.*/

+  if (i2cp->state != I2C_STOP) {

+

+    /* I2C disable.*/

+    //i2c_lld_abort_operation(i2cp);

+

+#if SW_I2C_USE_I2C1

+    if (&I2CD1 == i2cp) {

+    }

+#endif

+  }

+}

+

+/**

+ * @brief   Receives data via the I2C bus as master.

+ *

+ * @param[in] i2cp      pointer to the @p I2CDriver object

+ * @param[in] addr      slave device address

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

+ * @param[in] rxbytes   number of bytes to be received

+ * @param[in] timeout   the number of ticks before the operation timeouts,

+ *                      the following special values are allowed:

+ *                      - @a TIME_INFINITE no timeout.

+ *                      .

+ * @return              The operation status.

+ * @retval MSG_OK       if the function succeeded.

+ * @retval MSG_RESET    if one or more I2C errors occurred, the errors can

+ *                      be retrieved using @p i2cGetErrors().

+ * @retval MSG_TIMEOUT  if a timeout occurred before operation end. <b>After a

+ *                      timeout the driver must be stopped and restarted

+ *                      because the bus is in an uncertain state</b>.

+ *

+ * @notapi

+ */

+msg_t i2c_lld_master_receive_timeout(I2CDriver *i2cp, i2caddr_t addr,

+                                     uint8_t *rxbuf, size_t rxbytes,

+                                     systime_t timeout) {

+  msg_t msg = MSG_OK;

+

+  (void)i2cp;

+  (void)addr;

+  (void)rxbuf;

+  (void)rxbytes;

+  (void)timeout;

+

+  return msg;

+}

+

+/**

+ * @brief   Transmits data via the I2C bus as master.

+ * @details Number of receiving bytes must be 0 or more than 1 on STM32F1x.

+ *          This is hardware restriction.

+ *

+ * @param[in] i2cp      pointer to the @p I2CDriver object

+ * @param[in] addr      slave device address

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

+ * @param[in] txbytes   number of bytes to be transmitted

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

+ * @param[in] rxbytes   number of bytes to be received

+ * @param[in] timeout   the number of ticks before the operation timeouts,

+ *                      the following special values are allowed:

+ *                      - @a TIME_INFINITE no timeout.

+ *                      .

+ * @return              The operation status.

+ * @retval MSG_OK       if the function succeeded.

+ * @retval MSG_RESET    if one or more I2C errors occurred, the errors can

+ *                      be retrieved using @p i2cGetErrors().

+ * @retval MSG_TIMEOUT  if a timeout occurred before operation end. <b>After a

+ *                      timeout the driver must be stopped and restarted

+ *                      because the bus is in an uncertain state</b>.

+ *

+ * @notapi

+ */

+msg_t i2c_lld_master_transmit_timeout(I2CDriver *i2cp, i2caddr_t addr,

+                                      const uint8_t *txbuf, size_t txbytes,

+                                      uint8_t *rxbuf, size_t rxbytes,

+                                      systime_t timeout) {

+  msg_t msg = MSG_OK;

+

+  (void)i2cp;

+  (void)addr;

+  (void)txbuf;

+  (void)txbytes;

+  (void)rxbuf;

+  (void)rxbytes;

+  (void)timeout;

+

+  return msg;

+}

+

+#endif /* HAL_USE_I2C */

+

+/** @} */

diff --git a/os/hal/lib/fallback/I2C/hal_i2c_lld.h b/os/hal/lib/fallback/I2C/hal_i2c_lld.h
new file mode 100644
index 000000000..0bcb3dfbe
--- /dev/null
+++ b/os/hal/lib/fallback/I2C/hal_i2c_lld.h
@@ -0,0 +1,194 @@
+/*

+    ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio

+

+    Licensed under the Apache License, Version 2.0 (the "License");

+    you may not use this file except in compliance with the License.

+    You may obtain a copy of the License at

+

+        http://www.apache.org/licenses/LICENSE-2.0

+

+    Unless required by applicable law or agreed to in writing, software

+    distributed under the License is distributed on an "AS IS" BASIS,

+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

+    See the License for the specific language governing permissions and

+    limitations under the License.

+*/

+

+/**

+ * @file    common/I2C/hal_i2c_lld.h

+ * @brief   SW I2C subsystem low level driver header.

+ *

+ * @addtogroup I2C

+ * @{

+ */

+

+#ifndef HAL_I2C_LLD_H

+#define HAL_I2C_LLD_H

+

+#if HAL_USE_I2C || defined(__DOXYGEN__)

+

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

+/* Driver constants.                                                         */

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

+

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

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

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

+

+/**

+ * @name    Configuration options

+ * @{

+ */

+/**

+ * @brief   I2C1 driver enable switch.

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

+ * @note    The default is @p FALSE.

+ */

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

+#define SW_I2C_USE_I2C1                     FALSE

+#endif

+

+/**

+ * @brief   I2C2 driver enable switch.

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

+ * @note    The default is @p FALSE.

+ */

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

+#define SW_I2C_USE_I2C2                     FALSE

+#endif

+

+/**

+ * @brief   I2C3 driver enable switch.

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

+ * @note    The default is @p FALSE.

+ */

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

+#define SW_I2C_USE_I2C3                     FALSE

+#endif

+

+/**

+ * @brief   I2C4 driver enable switch.

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

+ * @note    The default is @p FALSE.

+ */

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

+#define SW_I2C_USE_I2C4                     FALSE

+#endif

+/** @} */

+

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

+/* Derived constants and error checks.                                       */

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

+

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

+/* Driver data structures and types.                                         */

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

+

+/**

+ * @brief   Type representing an I2C address.

+ */

+typedef uint16_t i2caddr_t;

+

+/**

+ * @brief   Type of I2C driver condition flags.

+ */

+typedef uint8_t i2cflags_t;

+

+/**

+ * @brief   Type of I2C driver configuration structure.

+ */

+typedef struct {

+} I2CConfig;

+

+/**

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

+ */

+typedef struct I2CDriver I2CDriver;

+

+/**

+ * @brief   Structure representing an I2C driver.

+ */

+struct I2CDriver {

+  /**

+   * @brief   Driver state.

+   */

+  i2cstate_t                state;

+  /**

+   * @brief   Current configuration data.

+   */

+  const I2CConfig           *config;

+  /**

+   * @brief   Error flags.

+   */

+  i2cflags_t                errors;

+#if I2C_USE_MUTUAL_EXCLUSION || defined(__DOXYGEN__)

+  mutex_t                   mutex;

+#endif /* I2C_USE_MUTUAL_EXCLUSION */

+#if defined(I2C_DRIVER_EXT_FIELDS)

+  I2C_DRIVER_EXT_FIELDS

+#endif

+  /* End of the mandatory fields.*/

+  /**

+   * @brief   I2C clock line.

+   */

+  ioline_t                  clk;

+  /**

+   * @brief   I2C data line.

+   */

+  ioline_t                  data;

+};

+

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

+/* Driver macros.                                                            */

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

+

+/**

+ * @brief   Get errors from I2C driver.

+ *

+ * @param[in] i2cp      pointer to the @p I2CDriver object

+ *

+ * @notapi

+ */

+#define i2c_lld_get_errors(i2cp) ((i2cp)->errors)

+

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

+/* External declarations.                                                    */

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

+

+#if !defined(__DOXYGEN__)

+#if SW_I2C_USE_I2C1

+extern I2CDriver I2CD1;

+#endif

+#if SW_I2C_USE_I2C2

+extern I2CDriver I2CD2;

+#endif

+#if SW_I2C_USE_I2C3

+extern I2CDriver I2CD3;

+#endif

+#if SW_I2C_USE_I2C4

+extern I2CDriver I2CD4;

+#endif

+#endif /* !defined(__DOXYGEN__) */

+

+#ifdef __cplusplus

+extern "C" {

+#endif

+  void i2c_lld_init(void);

+  void i2c_lld_start(I2CDriver *i2cp);

+  void i2c_lld_stop(I2CDriver *i2cp);

+  msg_t i2c_lld_master_transmit_timeout(I2CDriver *i2cp, i2caddr_t addr,

+                                        const uint8_t *txbuf, size_t txbytes,

+                                        uint8_t *rxbuf, size_t rxbytes,

+                                        systime_t timeout);

+  msg_t i2c_lld_master_receive_timeout(I2CDriver *i2cp, i2caddr_t addr,

+                                       uint8_t *rxbuf, size_t rxbytes,

+                                       systime_t timeout);

+#ifdef __cplusplus

+}

+#endif

+

+#endif /* HAL_USE_I2C  */

+

+#endif /* HAL_I2C_LLD_H */

+

+/** @} */