Renesas PTX1xxR IoT-Reader API Version 7.3.1
Renesas Software Stack for IoT-Reader Applications
Data Fields
ptxNscFactory Struct Reference

Factory Component Structure. More...

#include <ptxNscFactory.h>

Collaboration diagram for ptxNscFactory:
Collaboration graph

Data Fields

ptxStatus_Comps_t CompId
 
ptxFifoIoRq_t FifoIoRq
 
ptxIoRq_t IoRq
 
struct ptxThread * ThreadFifoId
 
struct ptxOsal * OS
 
struct ptxHalHAL
 
struct ptxNCI * NCI
 
ptxNSC_tNSC
 
struct ptxHCI * HCI
 
ptxLog_tLOG
 
ptxNvm_tNVM
 
uint8_t * DevName
 
size_t DevNameLength
 
uint32_t DevSpeedInit
 
uint32_t DevSpeedApp
 
uint8_t HwFlowControl
 
ptxHal_InterfaceType_t DevType
 
uint32_t LogHistory
 
uint16_t BusAddress
 
uint8_t BufferPoolDbgLogEn
 
size_t NscBufferSize
 
ptxNscFactoryAboveNsc_t NscCommandedBy
 
uint8_t MaxDynLogConns
 
uint8_t InitialNrCredits
 
uint8_t CreditNtfTrigger
 
uint8_t IoInterLogEn
 
uint32_t IrqGpioNum
 
uint8_t IsLogExternal
 
uint8_t * DevSerialNumber
 
size_t DevSerialNumberLength
 
uint8_t InitDefaultCount
 
uint32_t InitDefaultBits
 
uint32_t InitParamBits
 

Detailed Description

Factory Component Structure.

Holds the list of parameters required for stack build-up/initialization procedure. Initialize Factory object with ptxNscFactory_Init and set parameters with ptxNscFactory_SetParameter before calling ptxNscFactory_BuildStack.

Properly initialized instance of ptxNscFactory_t object facilitates further set-up of various stack-components parameters.

Field Documentation

◆ BufferPoolDbgLogEn

uint8_t BufferPoolDbgLogEn

Enable/disable Buffer-Pool debug logging.

◆ BusAddress

uint16_t BusAddress

Bus address used for I2C interface.

◆ CompId

Factory component ID ptxStatus_Comp_Factory. For the usage see ptxStatus_t and PTX_COMP_CHECK.

◆ CreditNtfTrigger

uint8_t CreditNtfTrigger

Define after how many received data packets a Credit-Notification shall be sent. Used by NCI.

◆ DevName

uint8_t* DevName

Name of the connected device.

◆ DevNameLength

size_t DevNameLength

Length of the DevName string.

◆ DevSerialNumber

uint8_t* DevSerialNumber

Serial Number of Ftdi device to be used.

◆ DevSerialNumberLength

size_t DevSerialNumberLength

Length of DevSerialNumber string.

◆ DevSpeedApp

uint32_t DevSpeedApp

Speed/baudrate set by the application.

◆ DevSpeedInit

uint32_t DevSpeedInit

Initial speed/baudrate for communication with NFC HW.

◆ DevType

Interface type. Supported values defined in ptxHal_InterfaceType_t.

◆ FifoIoRq

ptxFifoIoRq_t FifoIoRq

FIFO I/O Request.

◆ HAL

struct ptxHal* HAL

Pointer to main HAL component. Provided already allocated outside NscFactory. Initialized in ptxNscFactory_BuildStack.

◆ HCI

struct ptxHCI* HCI

Pointer to main HCI component. Provided already allocated outside NscFactory. Initialized in ptxNscFactory_BuildStack.

◆ HwFlowControl

uint8_t HwFlowControl

Uart interface HW flow control enable/disable.

◆ InitDefaultBits

uint32_t InitDefaultBits

Flag holder for each default parameter.

◆ InitDefaultCount

uint8_t InitDefaultCount

Total number of default initialization elements.

◆ InitialNrCredits

uint8_t InitialNrCredits

Initial number of Credits for all Data connections. Used by NCI.

◆ InitParamBits

uint32_t InitParamBits

Flag holder for each parameter set with ptxNscFactory_SetParameter.

◆ IoInterLogEn

uint8_t IoInterLogEn

Enable internal log of the specific interface. Reserved for future use.

◆ IoRq

ptxIoRq_t IoRq

I/O Request structure.

◆ IrqGpioNum

uint32_t IrqGpioNum

GPIO-Pin number for NFC-IRQ.

◆ IsLogExternal

uint8_t IsLogExternal

Define whether logger component is external (1u) or internal (0).

◆ LOG

ptxLog_t* LOG

Pointer to logger component. Provided already allocated outside NscFactory. Initialized in ptxNscFactory_BuildStack.

◆ LogHistory

uint32_t LogHistory

Number of log entries used by LOG component.

◆ MaxDynLogConns

uint8_t MaxDynLogConns

Define maximum number of dynamic connections for NCI.

◆ NCI

struct ptxNCI* NCI

Pointer to main NCI component. Provided already allocated outside NscFactory. Initialized in ptxNscFactory_BuildStack.

◆ NSC

ptxNSC_t* NSC

Pointer to main NSC component. Provided already allocated outside NscFactory. Initialized in ptxNscFactory_BuildStack.

◆ NscBufferSize

size_t NscBufferSize

The size of NSC Buffer-Pool buffer.

◆ NscCommandedBy

ptxNscFactoryAboveNsc_t NscCommandedBy

Define whether NCI is on top of NSC.

◆ NVM

ptxNvm_t* NVM

Pointer to Nvm component. Provided already allocated and initialized outside NscFactory.

◆ OS

struct ptxOsal* OS

Pointer to main OSAL component. Allocated and initialized in ptxNscFactory_Init.

◆ ThreadFifoId

struct ptxThread* ThreadFifoId

Pointer to FIFO thread structure - handles getting I/O requests from FIFO and starts completion procedure.


The documentation for this struct was generated from the following file: