From ac1f65e8f8a10bd41d8c46b8427d676bd3385551 Mon Sep 17 00:00:00 2001
From: gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>
Date: Sat, 24 Jul 2010 09:03:11 +0000
Subject: UART driver model, no implementations yet.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2087 35acf78f-673a-0410-8e92-d51de3d6d3f4
---
 os/hal/include/uart.h | 126 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 126 insertions(+)
 create mode 100644 os/hal/include/uart.h

(limited to 'os/hal/include')

diff --git a/os/hal/include/uart.h b/os/hal/include/uart.h
new file mode 100644
index 000000000..72273b2a7
--- /dev/null
+++ b/os/hal/include/uart.h
@@ -0,0 +1,126 @@
+/*
+    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    uart.h
+ * @brief   UART Driver macros and structures.
+ *
+ * @addtogroup UART
+ * @{
+ */
+
+#ifndef _UART_H_
+#define _UART_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   Generic UART notification callback type.
+ */
+typedef void (*uartcb_t)(void);
+
+/**
+ * @brief   Character received UART notification callback type.
+ *
+ * @param[in] c         received character
+ */
+typedef void (*uartccb_t)(uint16_t c);
+
+/**
+ * @brief   Receive error UART notification callback type.
+ *
+ * @param[in] e         receive error mask
+ */
+typedef void (*uartecb_t)(uint16_t e);
+
+/**
+ * @brief   Driver state machine possible states.
+ */
+typedef enum {
+  UART_UNINIT = 0,                  /**< @brief Not initialized.            */
+  UART_STOP = 1,                    /**< @brief Stopped.                    */
+  UART_READY = 2                    /**< @brief Ready.                      */
+} uartstate_t;
+
+/**
+ * @brief   Transmitter state machine states.
+ */
+typedef enum {
+  UART_TX_IDLE = 0,                 /**< @brief Not transmitting.           */
+  UART_TX_ACTIVE = 1,               /**< @brief Transmitting.               */
+  UART_TX_COMPLETE = 2              /**< @brief Buffer complete.            */
+} uarttxstate_t;
+
+/**
+ * @brief   Receiver state machine states.
+ */
+typedef enum {
+  UART_RX_IDLE = 0,                 /**< @brief Not receiving.              */
+  UART_RX_ACTIVE = 1,               /**< @brief Receiving.                  */
+  UART_TX_ERROR = 2,                /**< @brief Receive error.              */
+  UART_TX_COMPLETE = 3              /**< @brief Buffer complete.            */
+} uartrxstate_t;
+
+#include "uart_lld.h"
+
+/*===========================================================================*/
+/* Driver macros.                                                            */
+/*===========================================================================*/
+
+/*===========================================================================*/
+/* External declarations.                                                    */
+/*===========================================================================*/
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+  void uartInit(void);
+  void uartObjectInit(UARTDriver *uartp);
+  void uartStart(UARTDriver *uartp, const UARTConfig *config);
+  void uartStop(UARTDriver *uartp);
+  void uartStartSend(UARTDriver *uartp, size_t n, const void *txbuf);
+  void uartStartSendI(UARTDriver *uartp, size_t n, const void *txbuf);
+  void uartStopSend(UARTDriver *uartp);
+  void uartStartReceive(UARTDriver *uartp, size_t n, void *rxbuf);
+  void uartStopReceive(UARTDriver *uartp);
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* CH_HAL_USE_UART */
+
+#endif /* _UART_H_ */
+
+/** @} */
-- 
cgit v1.2.3