0.01.00
uart.h
Go to the documentation of this file.
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 
35 #ifndef UART_H_
36 #define UART_H_
37 
38 #include <stdint.h>
39 
40 #include <openthread/types.h>
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
64 
73 
84 otError otPlatUartSend(const uint8_t *aBuf, uint16_t aBufLength);
85 
90 extern void otPlatUartSendDone(void);
91 
99 extern void otPlatUartReceived(const uint8_t *aBuf, uint16_t aBufLength);
100 
106 #ifdef __cplusplus
107 } // extern "C"
108 #endif
109 
110 #endif // UART_H_
void otPlatUartReceived(const uint8_t *aBuf, uint16_t aBufLength)
The UART driver calls this method to notify OpenThread that bytes have been received.
Definition: cli_uart.cpp:104
void otPlatUartSendDone(void)
The UART driver calls this method to notify OpenThread that the requested bytes have been sent...
Definition: cli_uart.cpp:281
This file defines the types and structures used in the OpenThread library API.
otError otPlatUartEnable(void)
Enable the UART.
otError otPlatUartSend(const uint8_t *aBuf, uint16_t aBufLength)
Send bytes over the UART.
otError otPlatUartDisable(void)
Disable the UART.
otError
This enumeration represents error codes used throughout OpenThread.
Definition: types.h:107