Implementation of the UART Interface. More...
#include <inttypes.h>#include "no_os_uart.h"#include <stdlib.h>#include "no_os_error.h"#include "no_os_mutex.h"#include "no_os_util.h"
Functions | |
| int32_t | no_os_uart_init (struct no_os_uart_desc **desc, struct no_os_uart_init_param *param) |
| Initialize the UART communication peripheral. More... | |
| int32_t | no_os_uart_remove (struct no_os_uart_desc *desc) |
| Free the resources allocated by no_os_uart_init(). More... | |
| uint32_t | no_os_uart_get_errors (struct no_os_uart_desc *desc) |
| Check if errors occurred on UART. More... | |
| int32_t | no_os_uart_read (struct no_os_uart_desc *desc, uint8_t *data, uint32_t bytes_number) |
| Read data from UART. More... | |
| int32_t | no_os_uart_write (struct no_os_uart_desc *desc, const uint8_t *data, uint32_t bytes_number) |
| Write to UART. More... | |
| int32_t | no_os_uart_read_nonblocking (struct no_os_uart_desc *desc, uint8_t *data, uint32_t bytes_number) |
| Read data from UART non-blocking. More... | |
| int32_t | no_os_uart_write_nonblocking (struct no_os_uart_desc *desc, const uint8_t *data, uint32_t bytes_number) |
| Write to UART non-blocking. More... | |
| void | no_os_uart_stdio (struct no_os_uart_desc *desc) |
Detailed Description
Implementation of the UART Interface.
Copyright 2022(c) Analog Devices, 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:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- 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.
- Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
- The use of this software may or may not infringe the patent rights of one or more patent holders. This license does not release you from the requirement that you obtain separate licenses from these patent holders to use this software.
- Use of the software either in source or binary form, must be run on or directly connected to an Analog Devices Inc. component.
THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, 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.
Function Documentation
◆ no_os_uart_get_errors()
| uint32_t no_os_uart_get_errors | ( | struct no_os_uart_desc * | desc | ) |
Check if errors occurred on UART.
- Parameters
-
desc - The UART descriptor.
- Returns
- number of errors in case of success, error code otherwise.
◆ no_os_uart_init()
| int32_t no_os_uart_init | ( | struct no_os_uart_desc ** | desc, |
| struct no_os_uart_init_param * | param | ||
| ) |
Initialize the UART communication peripheral.
- Parameters
-
desc - The UART descriptor. param - The structure that contains the UART parameters.
- Returns
- 0 in case of success, error code otherwise.
◆ no_os_uart_read()
| int32_t no_os_uart_read | ( | struct no_os_uart_desc * | desc, |
| uint8_t * | data, | ||
| uint32_t | bytes_number | ||
| ) |
Read data from UART.
- Parameters
-
desc - The UART descriptor. data - The buffer with the received data. bytes_number - Number of bytes to read.
- Returns
- 0 in case of success, error code otherwise.
◆ no_os_uart_read_nonblocking()
| int32_t no_os_uart_read_nonblocking | ( | struct no_os_uart_desc * | desc, |
| uint8_t * | data, | ||
| uint32_t | bytes_number | ||
| ) |
Read data from UART non-blocking.
- Parameters
-
desc - The UART descriptor. data - The buffer with the received data. bytes_number - Number of bytes to read.
- Returns
- 0 in case of success, error code otherwise.
◆ no_os_uart_remove()
| int32_t no_os_uart_remove | ( | struct no_os_uart_desc * | desc | ) |
Free the resources allocated by no_os_uart_init().
- Parameters
-
desc - The UART descriptor.
- Returns
- 0 in case of success, error code otherwise.
◆ no_os_uart_stdio()
| void no_os_uart_stdio | ( | struct no_os_uart_desc * | desc | ) |
◆ no_os_uart_write()
| int32_t no_os_uart_write | ( | struct no_os_uart_desc * | desc, |
| const uint8_t * | data, | ||
| uint32_t | bytes_number | ||
| ) |
Write to UART.
- Parameters
-
desc - The UART descriptor. data - The buffer with the transmitted data. bytes_number - Number of bytes to write.
- Returns
- 0 in case of success, error code otherwise.
◆ no_os_uart_write_nonblocking()
| int32_t no_os_uart_write_nonblocking | ( | struct no_os_uart_desc * | desc, |
| const uint8_t * | data, | ||
| uint32_t | bytes_number | ||
| ) |
Write to UART non-blocking.
- Parameters
-
desc - The UART descriptor. data - The buffer with the transmitted data. bytes_number - Number of bytes to write.
- Returns
- 0 in case of success, error code otherwise.
