#include "ptxOsal.h"
Go to the source code of this file.
Data Structures | |
| struct | ptxHal_InitParam |
| Initialization Parameters Structure. More... | |
Macros | |
| #define | PTX_HAL_MAX_TX_LEN 256 |
| #define | PTX_HAL_READ_TIMEOUT 500 |
| #define | PTX_HAL_WRITE_TIMEOUT 500 |
Bit-coded values, interface specific. | |
Put the values (using logical OR for more than one value to be set) into the CommParam member of ptxHal_InitParam_t. Serial: Bit(s) 7 6 5 4 3 2 1 0 Meaning |STOPBIT| | |
| #define | PTX_HAL_COMMPARAM_SERIAL_STOPBIT_MASK 3 /* */ |
| #define | PTX_HAL_COMMPARAM_SERIAL_ONESTOPBIT 0 /* */ |
| #define | PTX_HAL_COMMPARAM_SERIAL_ONE5STOPBITS 1 /* */ |
| #define | PTX_HAL_COMMPARAM_SERIAL_TWOSTOPBITS 2 /* */ |
| #define | PTX_HAL_COMMPARAM_SERIAL_INIT_SPEED (115200UL) /* */ |
Typedefs | |
| typedef enum ptxHal_InterfaceType | ptxHal_InterfaceType_t |
| typedef struct ptxHal_InitParam | ptxHal_InitParam_t |
| Initialization Parameters Structure. | |
| typedef struct ptxHal * | pptxHal_t |
| Pointer to main HAL component. | |
| typedef ptxStatus_t(* | pptxHal_Cancel_t) (pptxHal_t halCtx) |
| Cancel any operation on the HAL. | |
| typedef ptxStatus_t(* | pptxHal_TRx_t) (pptxHal_t halCtx, uint8_t *txBuf[], size_t txLen[], size_t numBuffers, uint8_t *rxBuf, size_t *rxLen) |
| Send content of multiple buffers via the Interface, adding SOF if required, receive response. | |
Enumerations | |
| enum | ptxHal_InterfaceType { ptxHal_InterfaceType_None , ptxHal_InterfaceType_I2C , ptxHal_InterfaceType_SPI , ptxHal_InterfaceType_UART , ptxHal_InterfaceType_AAR_I2C , ptxHal_InterfaceType_AAR_SPI , ptxHal_InterfaceType_LPC , ptxHal_InterfaceType_USB , ptxHal_InterfaceType_FTDI_SPI , ptxHal_InterfaceType_FTDI_I2C , ptxHal_InterfaceType_FTDI_UART , ptxHal_InterfaceType_MAX } |
Functions | |
| ptxStatus_t | ptxHal_AllocOpen (struct ptxHal *halCtx, struct ptxHal_InitParam *initParam) |
| Initialize the HAL. | |
| ptxStatus_t | ptxHal_CloseDeAlloc (struct ptxHal *halCtx) |
| Close the HAL. | |
| ptxHal_InterfaceType_t | ptxHal_GetActiveIfType (struct ptxHal *halCtx) |
| Get the active HAL interface type. | |
| ptxStatus_t | ptxHal_Cancel (struct ptxHal *halCtx) |
| Cancel any operation on the HAL. | |
| ptxStatus_t | ptxHal_ClearCancel (struct ptxHal *halCtx) |
| Clear Cancel Flag . | |
| ptxStatus_t | ptxHal_SetTimeout (struct ptxHal *halCtx, uint32_t msTimeout) |
| Set the timeout attribute for the interface device. | |
| ptxStatus_t | ptxHal_SetSpeed (struct ptxHal *halCtx, uint32_t bdSpeed) |
| Set the communication interface speed. | |
| ptxStatus_t | ptxHal_SetBusAddress (struct ptxHal *halCtx, uint16_t busAddress) |
| Set the bus address attribute for the I2C interface device. | |
| ptxStatus_t | ptxHal_HandshakeManual (struct ptxHal *halCtx, uint8_t enableHS) |
| Set the state of handshake lines, if available. | |
| ptxStatus_t | ptxHal_SetFlowCtrlState (struct ptxHal *halCtx, uint8_t enableFc) |
| Enable/disable flow control mode for the Uart interface device. | |
| ptxStatus_t | ptxHal_SetI2C_NoStopFlag (struct ptxHal *halCtx) |
| Set I2C Not Stop Condition flag. | |
| ptxStatus_t | ptxHal_ClearI2C_NoStopFlag (struct ptxHal *halCtx) |
| Clear I2C Not Stop Condition flag. | |
| ptxStatus_t | ptxHal_TRx (struct ptxHal *halCtx, uint8_t *txBuf[], size_t txLen[], size_t numBuffers, uint8_t *rxBuf, size_t *rxLen) |
| Send content of multiple buffers via the Interface, adding SOF if required, receive response. | |
| ptxStatus_t | ptxHal_WaitForInterrupt (struct ptxHal *halCtx) |
| Wait for Interrupt. | |
| ptxStatus_t | ptxHal_SetKeepNssActive (struct ptxHal *halCtx) |
| Keeps NSS Active after a Trx Operation (SPI specific). | |
| ptxStatus_t | ptxHal_ClearKeepNssActive (struct ptxHal *halCtx) |
| Clear Keeps NSS Active after a Trx Operation (SPI specific). | |
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.h
Description : Header file gathering forward declarations and function prototypes
