ptxNscFactory.h File Reference

#include "ptxNSC_Interface.h"
#include "ptx_Fifo_IoRq.h"
#include "ptxNvm.h"

Include dependency graph for ptxNscFactory.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ptxNscFactoryDefaultInit
struct	ptxNscFactory
	Factory Component Structure. More...
struct	ptxNscFactoryBuild
	Stack initialization Structure. More...

Typedefs
typedef enum ptxNscFactory_P	ptxNscFactory_P_t
typedef enum ptxNscFactoryAboveNsc	ptxNscFactoryAboveNsc_t
typedef struct ptxNscFactoryDefaultInit	ptxNscFactoryDefaultInit_t
typedef struct ptxNscFactory	ptxNscFactory_t
	Factory Component Structure.
typedef struct ptxNscFactoryBuild	ptxNscFactoryBuild_t
	Stack initialization Structure.

Enumerations
enum	ptxNscFactory_P {   ptxNscFactory_P_Reserved_0 , ptxNscFactory_P_Interface , ptxNscFactory_P_SpeedInit , ptxNscFactory_P_SpeedApp ,   ptxNscFactory_P_HwFlowControl , ptxNscFactory_P_Type , ptxNscFactory_P_LogHistory , ptxNscFactory_P_BusAddress ,   ptxNscFactory_P_BufferPoolDbgLog , ptxNscFactory_P_NscBufferSize , ptxNscFactory_P_SetMaxDynLogConns , ptxNscFactory_P_SetInitialNrCredits ,   ptxNscFactory_P_SetCreditNtfTrigger , ptxNscFactory_P_NSCCommandedBy , ptxNscFactory_P_IrqGpioNum , ptxNscFactory_P_FTDITrxLog ,   ptxNscFactory_P_FTDISerialNumber , ptxNscFactory_P_Number }
enum	ptxNscFactoryAboveNsc { ptxNscFactory_Integration , ptxNscFactory_NCI }

Functions
PTX_LIBFUNC ptxStatus_t	ptxNscFactory_Init (ptxNscFactory_t *fCtx, struct ptxOsal **osAl, void *sysCtx)
	Factory Initialization.
PTX_LIBFUNC ptxStatus_t	ptxNscFactory_DeInit (ptxNscFactory_t *fCtx)
	De-Initialize the factory.
PTX_LIBFUNC ptxStatus_t	ptxNscFactory_SetParameter (ptxNscFactory_t *fCtx, ptxNscFactory_P_t parType, uint8_t *parBuf, uint32_t parLenOrValue)
	Set Factory Operating Parameter.
PTX_LIBFUNC ptxStatus_t	ptxNscFactory_BuildStack (ptxNscFactory_t *fCtx, ptxNscFactoryBuild_t *cComps)
	Build the stack, initialize and link together the components.
PTX_LIBFUNC ptxStatus_t	ptxNscFactory_DestroyStack (ptxNscFactory_t *fCtx)
	Stack De-Initialization, Step 1.
PTX_LIBFUNC ptxStatus_t	ptxNscFactory_DestroyStack_Finalize (ptxNscFactory_t *fCtx)
	Stack De-Initialization, Step 2.
PTX_LIBFUNC ptxStatus_t	ptxNscFactory_SetLogExternal (ptxNscFactory_t *fCtx)
	Set log component as built from outside.
PTX_LIBFUNC ptxStatus_t	ptxNscFactory_ClearLogExternal (ptxNscFactory_t *fCtx)
	Clear log component as built from outside.
PTX_LIBFUNC ptxFifoIoRq_t *	ptxNscFactory_GetFifo (ptxNscFactory_t *fCtx)
	Get reference to FIFO.

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:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. 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.
3. 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 : File : ptxNscFactory.h

Description :