CDI Request Information Block structure. More...

#include <cdi.h>

Data Fields
int	active

int	callBackIndex

CdiDeviceInfoBlk *	pDev

void *	pInData

unsigned int	inLength

void *	pOutData

unsigned int	outLength

short	inType

short	outType

short	inFormatCode

short	outFormatCode

int	hasPatternFilter

BYTE	patternFilter [CDI_PATTERN_FILTER_SIZE]

int	hasDataMask

BYTE	mask [8]

int	maskValue

int	devParameters [NUMBER_EXEC_PARAM]

int	timeout

int	registerTime

int	requestTime

int	pollTime

int	requestCounter

short	accessFlag

short	conditionFlag

int	needsCalibration

int	requestNumber

int	reqIndex

void *	groupReq

short	NgroupsReqs

short	NgroupRets

short	NgrpErrors

short	groupSyncStart

short	dataReturnCondition

short	asynCallFlag

int	deviceError

BYTE	cpOutData [DEF_INPUT_BYTES]

short	bufLastData [4]

int *	perror

int	responseTime

short	pollFlag

short	lockRequestFlag

short	userCallDown

short	cancelFlag

sem_t	sync_SemId

sem_t	exec_SemId

int	bufIndex

void(*	callback )(int, int)

int	freeInDataMemoryOnCancel

int	freeOutDataMemoryOnCancel

int	inside

void *	pBlockBuffer

int	devReadyTime

int	nerrors

void *	ptrReserved

Detailed Description

CDI Request Information Block structure.

This is the principal structure passed to and from CDI and a bus plug

Field Documentation

◆ accessFlag

short CdiRequestInfoBlk::accessFlag

read 1, write 2, read then write 3, write then read 4

◆ active

int CdiRequestInfoBlk::active

number of request process steps

◆ asynCallFlag

short CdiRequestInfoBlk::asynCallFlag

flag to indicate whether the call is asynchronous

◆ bufIndex

int CdiRequestInfoBlk::bufIndex

a buffer index used by the bus plug

◆ bufLastData

short CdiRequestInfoBlk::bufLastData[4]

comparison buffer

◆ callback

void(* CdiRequestInfoBlk::callback) (int, int)

callback function: receivces callBackIndex, errorCode

◆ callBackIndex

int CdiRequestInfoBlk::callBackIndex

can be user assigned (< 0x1000) or requestNumber + 0x1000

◆ cancelFlag

short CdiRequestInfoBlk::cancelFlag

cancel callback

◆ conditionFlag

short CdiRequestInfoBlk::conditionFlag

for reading data (readConditionNumeraters), bit: 0x8 for mask ON flag

◆ cpOutData

BYTE CdiRequestInfoBlk::cpOutData[DEF_INPUT_BYTES]

default data to send to the bus

◆ dataReturnCondition

short CdiRequestInfoBlk::dataReturnCondition

databack: 1; conditionOK: 2

◆ deviceError

int CdiRequestInfoBlk::deviceError

0 if no bus error on the device

◆ devParameters

int CdiRequestInfoBlk::devParameters[NUMBER_EXEC_PARAM]

address parameters registered with this device

◆ devReadyTime

int CdiRequestInfoBlk::devReadyTime

polling device ready

◆ exec_SemId

sem_t CdiRequestInfoBlk::exec_SemId

bus request semaphores

◆ freeInDataMemoryOnCancel

int CdiRequestInfoBlk::freeInDataMemoryOnCancel

memory managment flag

◆ freeOutDataMemoryOnCancel

int CdiRequestInfoBlk::freeOutDataMemoryOnCancel

memory managment flag

◆ groupReq

void* CdiRequestInfoBlk::groupReq

grouped request, group true if != NULL

◆ groupSyncStart

short CdiRequestInfoBlk::groupSyncStart

synchronous flag for group start

◆ hasDataMask

int CdiRequestInfoBlk::hasDataMask

0 = FALSE (no mask); else TRUE

◆ hasPatternFilter

int CdiRequestInfoBlk::hasPatternFilter

0 = FALSE (no pattern); else TRUE

◆ inFormatCode

short CdiRequestInfoBlk::inFormatCode

original caller's format code

◆ inLength

unsigned int CdiRequestInfoBlk::inLength

size in bytes of data coming from the device

◆ inside

int CdiRequestInfoBlk::inside

synchronization flag

◆ inType

short CdiRequestInfoBlk::inType

data type (from the hardware) one of char, short, int, float or double

◆ lockRequestFlag

short CdiRequestInfoBlk::lockRequestFlag

lock this request until cancel calls

◆ mask

BYTE CdiRequestInfoBlk::mask[8]

data mask to apply

◆ maskValue

int CdiRequestInfoBlk::maskValue

??

◆ needsCalibration

int CdiRequestInfoBlk::needsCalibration

if TRUE -> needs to calibrate results

◆ nerrors

int CdiRequestInfoBlk::nerrors

number of consecutive bus errors

◆ NgroupRets

short CdiRequestInfoBlk::NgroupRets

number of data returnd or timeout...

◆ NgroupsReqs

short CdiRequestInfoBlk::NgroupsReqs

number of connected requests for mainRequest, but index number for each requested device start from 1

◆ NgrpErrors

short CdiRequestInfoBlk::NgrpErrors

number of errors of this group

◆ outFormatCode

short CdiRequestInfoBlk::outFormatCode

original caller's format code

◆ outLength

unsigned int CdiRequestInfoBlk::outLength

size in bytes of data sent to the device

◆ outType

short CdiRequestInfoBlk::outType

data type (to the hardware) one of char, short, int, float or double

◆ patternFilter

BYTE CdiRequestInfoBlk::patternFilter[CDI_PATTERN_FILTER_SIZE]

compare pattern or Filter, if string max 32 bytes, otherwise check 8 bytes(double) only

◆ pBlockBuffer

void* CdiRequestInfoBlk::pBlockBuffer

block transfer buffer pointer

◆ pDev

CdiDeviceInfoBlk* CdiRequestInfoBlk::pDev

referenced device

◆ perror

int * CdiRequestInfoBlk::perror

specific error code; table of errors

◆ pInData

void* CdiRequestInfoBlk::pInData

pointer to data coming from the device

◆ pollFlag

short CdiRequestInfoBlk::pollFlag

infinite loop for async call

◆ pollTime

int CdiRequestInfoBlk::pollTime

polling interval ?

◆ pOutData

void* CdiRequestInfoBlk::pOutData

pointer to data sent to the device

◆ ptrReserved

void* CdiRequestInfoBlk::ptrReserved

reserved for future use

◆ registerTime

int CdiRequestInfoBlk::registerTime

time when contract was registered

◆ reqIndex

int CdiRequestInfoBlk::reqIndex

own index number: 0, 1...

◆ requestCounter

int CdiRequestInfoBlk::requestCounter

number of requests

◆ requestNumber

int CdiRequestInfoBlk::requestNumber

reqIndex + (cdiLine << 16)

◆ requestTime

int CdiRequestInfoBlk::requestTime

time whem contract was last sent

◆ responseTime

int CdiRequestInfoBlk::responseTime

last response time in ms

◆ sync_SemId

sem_t CdiRequestInfoBlk::sync_SemId