UART driver model, no implementations yet.

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

3 files changed, 257 insertions, 0 deletions

diff --git a/os/hal/templates/halconf.h b/os/hal/templates/halconf.h
index f58ca677b..719a3cf2f 100644
--- a/os/hal/templates/halconf.h
+++ b/os/hal/templates/halconf.h
@@ -154,6 +154,17 @@
 /*#define MMC_POLLING_INTERVAL        10*/

 /*#define MMC_POLLING_DELAY           10*/

 

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

+/* UART driver related settings.                                             */

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

+

+/**

+ * @brief   Enables the UART subsystem.

+ */

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

+#define CH_HAL_USE_UART             TRUE

+#endif

+

 #endif /* _HALCONF_H_ */

 

 /** @} */

diff --git a/os/hal/templates/uart_lld.c b/os/hal/templates/uart_lld.c
new file mode 100644
index 000000000..46c04fe8c
--- /dev/null
+++ b/os/hal/templates/uart_lld.c
@@ -0,0 +1,130 @@
+/*

+    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    templates/uart_lld.c

+ * @brief   UART Driver subsystem low level driver source template.

+ *

+ * @addtogroup UART_LLD

+ * @{

+ */

+

+#include "ch.h"

+#include "hal.h"

+

+#if CH_HAL_USE_UART || defined(__DOXYGEN__)

+

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

+/* Driver exported variables.                                                */

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

+

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

+/* Driver local variables.                                                   */

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

+

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

+/* Driver local functions.                                                   */

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

+

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

+/* Driver interrupt handlers.                                                */

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

+

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

+/* Driver exported functions.                                                */

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

+

+/**

+ * @brief   Low level UART driver initialization.

+ */

+void uart_lld_init(void) {

+

+}

+

+/**

+ * @brief   Configures and activates the UART peripheral.

+ *

+ * @param[in] uartp      pointer to the @p UARTDriver object

+ */

+void uart_lld_start(UARTDriver *uartp) {

+

+  if (uartp->uart_state == UART_STOP) {

+    /* Clock activation.*/

+  }

+  /* Configuration.*/

+}

+

+/**

+ * @brief   Deactivates the UART peripheral.

+ *

+ * @param[in] uartp      pointer to the @p UARTDriver object

+ */

+void uart_lld_stop(UARTDriver *uartp) {

+

+}

+

+/**

+ * @brief   Starts a transmission on the UART peripheral.

+ * @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] uartp     pointer to the @p UARTDriver object

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

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

+ */

+void uart_lld_start_send(UARTDriver *uartp, size_t n, const void *txbuf) {

+

+}

+

+/**

+ * @brief   Stops any ongoing transmission.

+ * @note    Stopping a transmission also suppresses the transmission callbacks.

+ *

+ * @param[in] uartp      pointer to the @p UARTDriver object

+ */

+void uart_lld_stop_send(UARTDriver *uartp) {

+

+}

+

+/**

+ * @brief   Starts a receive operation on the UART peripheral.

+ * @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] uartp     pointer to the @p UARTDriver object

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

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

+ */

+void uart_lld_start_receive(UARTDriver *uartp, size_t n, void *rxbuf) {

+

+}

+

+/**

+ * @brief   Stops any ongoing receive operation.

+ * @note    Stopping a receive operation also suppresses the receive callbacks.

+ *

+ * @param[in] uartp      pointer to the @p UARTDriver object

+ */

+void uart_lld_stop_receive(UARTDriver *uartp) {

+

+}

+

+#endif /* CH_HAL_USE_UART */

+

+/** @} */

diff --git a/os/hal/templates/uart_lld.h b/os/hal/templates/uart_lld.h
new file mode 100644
index 000000000..adc824bd0
--- /dev/null
+++ b/os/hal/templates/uart_lld.h
@@ -0,0 +1,116 @@
+/*

+    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    templates/uart_lld.h

+ * @brief   UART Driver subsystem low level driver header template.

+ *

+ * @addtogroup UART_LLD

+ * @{

+ */

+

+#ifndef _UART_LLD_H_

+#define _UART_LLD_H_

+

+#if CH_HAL_USE_UART || defined(__DOXYGEN__)

+

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

+/* Driver constants.                                                         */

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

+

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

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

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

+

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

+/* Derived constants and error checks.                                       */

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

+

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

+/* Driver data structures and types.                                         */

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

+

+/**

+ * @brief   Driver configuration structure.

+ * @note    It could be empty on some architectures.

+ */

+typedef struct {

+  /** @brief End of transmission buffer callback.*/

+  uartcb_t                  uc_txend1;

+  /** @brief Physical end of transmission callback.*/

+  uartcb_t                  uc_txend2;

+  /** @brief Receive buffer filled callback.*/

+  uartcb_t                  uc_rxend;

+  /** @brief Character received while out if the @p UART_RECEIVE state.*/

+  uartcb_t                  uc_rxchar;

+  /** @brief Receive error callback.*/  

+  uartcb_t                  uc_rxerr;

+  /* End of the mandatory fields.*/

+} UARTConfig;

+

+/**

+ * @brief   Structure representing an UART driver.

+ */

+typedef struct {

+  /**

+   * @brief Driver state.

+   */

+  uartstate_t               ud_state;

+  /**

+   * @brief Transmitter state.

+   */

+  uarttxstate_t             ud_txstate;

+  /**

+   * @brief Receiver state.

+   */

+  uartrxstate_t             ud_rxstate;

+  /**

+   * @brief Current configuration data.

+   */

+  const UARTConfig          *ud_config;

+  /* End of the mandatory fields.*/

+} UARTDriver;

+

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

+/* Driver macros.                                                            */

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

+

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

+/* External declarations.                                                    */

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

+

+#ifdef __cplusplus

+extern "C" {

+#endif

+  void uart_lld_init(void);

+  void uart_lld_start(UARTDriver *uartp);

+  void uart_lld_stop(UARTDriver *uartp);

+  void uart_lld_start_send(UARTDriver *uartp, size_t n, const void *txbuf);

+  void uart_lld_stop_send(UARTDriver *uartp);

+  void uart_lld_start_receive(UARTDriver *uartp, size_t n, void *rxbuf);

+  void uart_lld_stop_receive(UARTDriver *uartp);

+#ifdef __cplusplus

+}

+#endif

+

+#endif /* CH_HAL_USE_UART */

+

+#endif /* _UART_LLD_H_ */

+

+/** @} */