Rename otPlatSerial* to otPlatUart*. (#253)

2026-09-16 14:10:09 +00:00 · 2016-07-07 12:18:58 -07:00
parent e59f66b4d0
commit 9baa18e6e6
20 changed files with 97 additions and 97 deletions
@@ -0,0 +1,108 @@
+/*
+ *  Copyright (c) 2016, Nest Labs, Inc.
+ *  All rights reserved.
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions are met:
+ *  1. Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *  2. Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution.
+ *  3. Neither the name of the copyright holder nor the
+ *     names of its contributors may be used to endorse or promote products
+ *     derived from this software without specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+ *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ *  POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * @file
+ * @brief
+ *   This file includes the platform abstraction for UART communication.
+ */
+
+#ifndef UART_H_
+#define UART_H_
+
+#include <stdint.h>
+
+#include <openthread-types.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @defgroup uart UART
+ * @ingroup platform
+ *
+ * @brief
+ *   This module includes the platform abstraction for UART communication.
+ *
+ * @{
+ *
+ */
+
+/**
+ * Enable the UART.
+ *
+ * @retval ::kThreadError_None    Successfully enabled the UART.
+ * @retval ::kThreadError_Failed  Failed to enabled the UART.
+ */
+ThreadError otPlatUartEnable(void);
+
+/**
+ * Disable the UART.
+ *
+ * @retval ::kThreadError_None    Successfully disabled the UART.
+ * @retval ::kThreadError_Failed  Failed to disable the UART.
+ */
+ThreadError otPlatUartDisable(void);
+
+/**
+ * Send bytes over the UART.
+ *
+ * @param[in] aBuf        A pointer to the data buffer.
+ * @param[in] aBufLength  Number of bytes to transmit.
+ *
+ * @retval ::kThreadError_None    Successfully started transmission.
+ * @retval ::kThreadError_Failed  Failed to start the transmission.
+ */
+ThreadError otPlatUartSend(const uint8_t *aBuf, uint16_t aBufLength);
+
+/**
+ * The UART driver calls this method to notify OpenThread that the requested bytes have been sent.
+ *
+ */
+extern void otPlatUartSendDone(void);
+
+/**
+ * The UART driver calls this method to notify OpenThread that bytes have been received.
+ *
+ * @param[in]  aBuf        A pointer to the received bytes.
+ * @param[in]  aBufLength  The number of bytes received.
+ *
+ */
+extern void otPlatUartReceived(const uint8_t *aBuf, uint16_t aBufLength);
+
+/**
+ * @}
+ *
+ */
+
+#ifdef __cplusplus
+}  // extern "C"
+#endif
+
+#endif  // UART_H_