#include "ptxStatus.h"
#include <stddef.h>

Include dependency graph for ptxPLAT.h:

Data Structures
struct	ptxPLAT_ConfigPars
	Platform-specific parameter initializers. More...

Macros
#define	PTX_PLAT_TRX_FLAGS_I2C_RESTART_CONDITION 0x01
	Platform-specific flags parameter initializers.

#define	PTX_PLAT_HOST_SPEED_I2C_100000 (100000UL)
	Platform-dependent I2C speeds/bitrates (Attention: Bitrates highly dependent on the target system and might require adaption!)

#define	PTX_PLAT_HOST_SPEED_I2C_400000 (400000UL)

#define	PTX_PLAT_HOST_SPEED_I2C_1000000 (1000000UL)

#define	PTX_PLAT_HOST_SPEED_I2C_3400000 (3400000UL)

#define	PTX_PLAT_HOST_SPEED_I2C_MAX PTX_PLAT_HOST_SPEED_I2C_3400000

#define	PTX_PLAT_HOST_SPEED_UART_9600 (9600UL)
	Platform-dependent UART speeds/bitrates (Attention: Bitrates highly dependent on the target system and might require adaption!)

#define	PTX_PLAT_HOST_SPEED_UART_14400 (14400UL)

#define	PTX_PLAT_HOST_SPEED_UART_19200 (19200UL)

#define	PTX_PLAT_HOST_SPEED_UART_28800 (28800UL)

#define	PTX_PLAT_HOST_SPEED_UART_38400 (38400UL)

#define	PTX_PLAT_HOST_SPEED_UART_57600 (57600UL)

#define	PTX_PLAT_HOST_SPEED_UART_115200 (115200UL)

#define	PTX_PLAT_HOST_SPEED_UART_230400 (230400UL)

#define	PTX_PLAT_HOST_SPEED_UART_460800 (460800UL)

#define	PTX_PLAT_HOST_SPEED_UART_921600 (921600UL)

#define	PTX_PLAT_HOST_SPEED_UART_1843200 (1843200UL)

#define	PTX_PLAT_HOST_SPEED_UART_3000000 (3000000UL)

#define	PTX_PLAT_HOST_SPEED_UART_MAX PTX_PLAT_HOST_SPEED_UART_3000000

#define	PTX_PLAT_HOST_DEFAULT_UART_SPEED PTX_PLAT_HOST_SPEED_UART_115200

#define	PTX_PLAT_HOST_SPEED_SPI_1M (1000000UL)
	Platform-dependent SPI speeds/bitrates (Attention: Bitrates highly dependent on the target system and might require adaption!)

#define	PTX_PLAT_HOST_SPEED_SPI_5M (5000000UL)

#define	PTX_PLAT_HOST_SPEED_SPI_10M (10000000UL)

#define	PTX_PLAT_HOST_SPEED_SPI_MAX PTX_PLAT_HOST_SPEED_SPI_10M

Typedefs
typedef void(*	pptxPlat_RxCallBack_t) (void *ctx)
	Callback function for IRQ triggered (asynchronously).

typedef void(*	pptxPlat_TimerCallBack_t) (void *ctx)
	Callback function for Timer Interrupt.

typedef struct ptxPLAT_ConfigPars	ptxPLAT_ConfigPars_t
	Platform-specific parameter initializers.

Functions
ptxStatus_t	ptxPLAT_AllocAndInit (struct ptxPlat *plat, struct ptxPLAT_ConfigPars initParams)
	Allocate and initialize the PLAT context.

ptxStatus_t	ptxPLAT_Deinit (struct ptxPlat *plat)
	De-initialize the PLAT context.

ptxStatus_t	ptxPLAT_TRx (struct ptxPlat plat, uint8_t txBuf[], size_t txLen[], size_t numTxBuffers, uint8_t rxBuf[], size_t rxLen[], size_t numRxBuffers, uint8_t flags)
	Send and receive content of multiple buffers through the physical interface to the PTX1K.

ptxStatus_t	ptxPLAT_WaitForInterrupt (struct ptxPlat *plat)
	Wait for any kind of interrupt to be triggered on the CPU. (Blocking)

ptxStatus_t	ptxPLAT_StartWaitForRx (struct ptxPlat plat, pptxPlat_RxCallBack_t irqCb, void ctxIrqCb)
	Start waiting for IRQ to be triggered.(Not-blocking)

ptxStatus_t	ptxPLAT_StopWaitForRx (struct ptxPlat *plat)
	Stop the waiting for IRQ.

ptxStatus_t	ptxPLAT_Sleep (struct ptxPlat *plat, uint32_t sleep_ms)
	Sleep software execution.

void	ptxPLAT_DisableInterrupts (struct ptxPlat *plat)
	Disable Interrupts.

void	ptxPLAT_EnableInterrupts (struct ptxPlat *plat)
	Enable Interrupts.

ptxStatus_t	ptxPLAT_ResetChip (struct ptxPlat *plat)
	Resets PTX1K.

ptxStatus_t	ptxPLAT_GetInitializedTimer (struct ptxPlat plat, struct ptxPlatTimer *timer)
	Get an initialized timer.

ptxStatus_t	ptxPLAT_TimerStart (struct ptxPlat plat, struct ptxPlatTimer timer, uint32_t ms, uint8_t isBlock, pptxPlat_TimerCallBack_t fnISRCb, void *ISRCxt)
	Start timer for some milliseconds.

ptxStatus_t	ptxPLAT_TimerIsElapsed (struct ptxPlat plat, struct ptxPlatTimer timer, uint8_t *isElapsed)
	Get Elapse state of the timer.

ptxStatus_t	ptxPLAT_TimerDeinit (struct ptxPlat plat, struct ptxPlatTimer timer)
	De initialize the timer.

ptxStatus_t	ptxPLAT_IsRxPending (struct ptxPlat plat, uint8_t isRxPending)
	It checks if Rx Operation is pending from PTX100X.

ptxStatus_t	ptxPLAT_TriggerRx (struct ptxPlat *plat)
	It triggers Rx Operation from PTX100X (If rx operation pending)

uint8_t	ptxPLAT_CheckRxActive (struct ptxPlat *plat)
	Check if PLAT interface reception is taking place at the moment.

Detailed Description

SPDX-License-Identifier: BSD-3-Clause

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 : PLAT File : ptxPLAT.h

Description :

Data Structures

Macros

Typedefs

Functions

Detailed Description

OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.