Go to the source code of this file.
Data Structures | |
| struct | ptxHal_UartInitParam |
| Input parameters to Open Uart Port. More... | |
Typedefs | |
| typedef struct ptxHal_UART * | ptxHal_UART_t |
| UART specific data Wrapper Structure - Forward Declaration. | |
| typedef struct ptxHal_UartInitParam | ptxHal_UartInitParam_t |
| Input parameters to Open Uart Port. | |
Functions | |
| ptxStatus_t | ptxHal_UartOpen (ptxHal_UART_t *halUart, ptxHal_UartInitParam_t *initPars) |
| Open the UART device. | |
| ptxStatus_t | ptxHal_UartClose (ptxHal_UART_t *halUart) |
| Close the UART device. | |
| ptxStatus_t | ptxHal_UartDiscardData (ptxHal_UART_t halUart) |
| Discard data currently in the buffers of the UART device. | |
| ptxStatus_t | ptxHal_UartSetTimeout (ptxHal_UART_t halUart, uint32_t msTimeout) |
| Set the timeout attribute for the interface device. | |
| ptxStatus_t | ptxHal_UartSetSpeed (ptxHal_UART_t halUart, uint32_t bdSpeed) |
| Set the speed attribute for the interface device. | |
| ptxStatus_t | ptxHal_UartHandshakeManual (ptxHal_UART_t halUart, uint8_t enableHS) |
| Set the state of the handshake lines RTS and DTR. | |
| ptxStatus_t | ptxHal_UartAddSof (ptxHal_UART_t halUart, uint8_t addSof) |
| Select whether to add SOF to the frame, if NSC format requires that. | |
| ptxStatus_t | ptxHal_UartSetFc (ptxHal_UART_t halUart, uint8_t enableFc) |
| (Re-) Initialize settings and modify Flow Control for the device. | |
| ptxStatus_t | ptxHal_UartCancel (ptxHal_UART_t halUart) |
| Cancel a UART operation. | |
| ptxStatus_t | ptxHal_UartClearCancel (ptxHal_UART_t halUart) |
| Clear Cancel cancel flag for UART operation. | |
| ptxStatus_t | ptxHal_UartTRx (ptxHal_UART_t halUart, uint8_t *txBuf[], size_t txLen[], size_t numBuffers, uint8_t *rxBuf, size_t *rxLen) |
| Exchange content of multiple buffers via the UART Interface, adding SOF if required. | |
| ptxStatus_t | ptxHal_UartDTRManual (ptxHal_UART_t halUart, uint8_t enableDTR) |
| Set the state of the DTR line. | |
Detailed Description
SPDX-License-Identifier: BSD-3-Clause
Copyright (c) 2026, Renesas Electronics Corporation and/or its affiliates
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 Renesas 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 Renesas "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RENESAS 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.
Project : PTX1K Module : HAL (Hardware Abstraction Layer) File : ptxHal_UART.h
Description :
