1 /* 2 * Copyright (c) 2016, The OpenThread Authors. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. Neither the name of the copyright holder nor the 13 * names of its contributors may be used to endorse or promote products 14 * derived from this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26 * POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29 /** 30 * @file 31 * @brief 32 * This file includes the platform abstraction for UART communication. 33 */ 34 35 #ifndef OPENTHREAD_PLATFORM_UART_H_ 36 #define OPENTHREAD_PLATFORM_UART_H_ 37 38 #include <stdint.h> 39 40 #include <openthread/error.h> 41 42 #ifdef __cplusplus 43 extern "C" { 44 #endif 45 46 /** 47 * @addtogroup plat-uart 48 * 49 * @brief 50 * This module includes the platform abstraction for UART communication. 51 * 52 * @{ 53 * 54 */ 55 56 /** 57 * Enable the UART. 58 * 59 * @retval OT_ERROR_NONE Successfully enabled the UART. 60 * @retval OT_ERROR_FAILED Failed to enabled the UART. 61 * 62 */ 63 otError otPlatUartEnable(void); 64 65 /** 66 * Disable the UART. 67 * 68 * @retval OT_ERROR_NONE Successfully disabled the UART. 69 * @retval OT_ERROR_FAILED Failed to disable the UART. 70 * 71 */ 72 otError otPlatUartDisable(void); 73 74 /** 75 * Send bytes over the UART. 76 * 77 * @param[in] aBuf A pointer to the data buffer. 78 * @param[in] aBufLength Number of bytes to transmit. 79 * 80 * @retval OT_ERROR_NONE Successfully started transmission. 81 * @retval OT_ERROR_FAILED Failed to start the transmission. 82 * 83 */ 84 otError otPlatUartSend(const uint8_t *aBuf, uint16_t aBufLength); 85 86 /** 87 * Flush the outgoing transmit buffer and wait for the data to be sent. 88 * This is called when the CLI UART interface has a full buffer but still 89 * wishes to send more data. 90 * 91 * @retval OT_ERROR_NONE Flush succeeded, we can proceed to write more 92 * data to the buffer. 93 * 94 * @retval OT_ERROR_NOT_IMPLEMENTED Driver does not support synchronous flush. 95 * @retval OT_ERROR_INVALID_STATE Driver has no data to flush. 96 */ 97 otError otPlatUartFlush(void); 98 99 /** 100 * The UART driver calls this method to notify OpenThread that the requested bytes have been sent. 101 * 102 */ 103 extern void otPlatUartSendDone(void); 104 105 /** 106 * The UART driver calls this method to notify OpenThread that bytes have been received. 107 * 108 * @param[in] aBuf A pointer to the received bytes. 109 * @param[in] aBufLength The number of bytes received. 110 * 111 */ 112 extern void otPlatUartReceived(const uint8_t *aBuf, uint16_t aBufLength); 113 114 /** 115 * @} 116 * 117 */ 118 119 #ifdef __cplusplus 120 } // extern "C" 121 #endif 122 123 #endif // OPENTHREAD_PLATFORM_UART_H_ 124
