|
NAIBRDFUNC int32_t NAIAPI | naibrd_PB_GetChannelCount (uint32_t modId) |
| Retrieves the number of channels for the specified PB Module ID.
|
|
NAIBRDFUNC int32_t NAIAPI | naibrd_PB_GetChannelCountForModule (uint32_t cardIndex, uint32_t module) |
| Returns the number of channels for the specified card and Module.
|
|
NAIBRDFUNC int32_t NAIAPI | naibrd_PB_GetMaxFIFOCount (uint32_t modId) |
| Returns the max FIFO count for the specified PB Module ID.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_BusParamReconfiguration (int32_t cardIndex, int32_t module, int32_t busParam, int32_t field1Value, int32_t field2Value) |
| Responsible for allowing for the modification of 3 bus values: Setting a new Master State, a new highest active address or new min slave interval values.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_SetAndEnableMaxCycleCounter (int32_t cardIndex, int32_t module, int32_t maxCycleCount) |
| Sets the number of data cycles that will take place prior to the bus being placed offline.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_StartReconfiguration (int32_t cardIndex, int32_t module, int32_t startReconfig) |
| Responsible for kicking off the reconfiguration process.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_SetPollCycleMode (int32_t cardIndex, int32_t module, int32_t pollCycleMode) |
| Specifies if the poll cycle is Asynchronous or Synchronous.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_SetBusParams (int32_t cardIndex, int32_t module, NAIBRD_PB_BUS_PARAMS *p_busParams) |
| Responsible for configuring the bus with new parameter values.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_SetNewIOConfig (int32_t cardIndex, int32_t module, int32_t slaveAddr, int32_t cfgDataLength, int8_t *p_cfgData) |
| Assigns a new IO configuration.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_SetDynamicBusParams (int32_t cardIndex, int32_t module, int32_t stationAddr, int32_t maxRetryLimit, int32_t tSlot, int32_t maxTsdr) |
| Responsible for performing a "bump-free" alteration of the bus parameters during operation. Thus parameters can be optimized while operation is going on. This function must be used with care since communication errors may occur if wrong bus parameters have been selected. The profibus DP application receives no feedback about successful alteration of bus parameters nor about invalid data. Any invalid bus parameters are ignored and no changes will be performed.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_SetSystemTime (int32_t cardIndex, int32_t module, uint32_t clockStatus, uint32_t sysTimeSeconds, uint32_t sysTimeNanoSeconds) |
| A new reference time is passed to the PROFIBUS-DP Master configured as the time master. This reference time is then automatically distributed in the system. If there is a time master with a lower station address on the bus, it will assume the responsibility for time synchronization, and the PROFIBUS-DP Protocol Software will change to the time slave mode. In this case, the setting of a new system time by the PROFIBUS-DP Application is ignored and the system time of the current time master is used. In case the latter should fail, the PROFIBUS-DP Protocol Software changes back to the time master mode.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_SetPowerEnableForSegments (int32_t cardIndex, int32_t module, uint32_t powerEnable) |
| Responsible for turning on the power supplies for the segments. Segments 1 - 8 share 4 power supplies. Segments 1 and 2 are powered by 1 power supply, Segments 2 and 4 by another and so on. The Aux segment is powered by its own power supply.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_SetTerminationEnableForSegments (int32_t cardIndex, int32_t module, uint32_t terminationEnable) |
| Responsible for turning on/off termination for each segment.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_SetReceiverEnableForSegments (int32_t cardIndex, int32_t module, uint32_t receiverEnable) |
| Responsible for turning on/off receiver for each segment.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_EnableSegmentForUse (int32_t cardIndex, int32_t module, int32_t segment, bool_t enable) |
| This method enables a given segment for use which encompasses making sure the power supply tied to the segment is powered and the receiver for the given segment is on. NOTE: because the normal segments (all but Aux) each share a power supply with one other segment, when disabling a segment for use the power supply will not turn off when disabling a single segment. If conservation of power is needed, extra calls can be made to naibrd_PB_SetPowerEnableForSegments where banks of segments (2 segments per bank) can be turned off. For the Aux segment, power will be disabled when disabling the segment since the Aux segment has its own power supply. Valid Segments: 1, 2, 3, 4, 5, 6, 7, 8 and 0xFF for Aux.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_ReadIOData (int32_t cardIndex, int32_t module, int32_t slaveAddr, int32_t offset, int32_t readCount, int8_t *p_outioData) |
| Responsible for reading the cyclic data.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_WriteIOData (int32_t cardIndex, int32_t module, int32_t slaveAddr, int32_t offset, int32_t numBytesToWrite, int8_t *p_bytesToWrite) |
| Responsible for writing new values for cyclic data.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_AcyclicRead (int32_t cardIndex, int32_t module, int32_t slaveAddr, int32_t slotNum, int32_t paramIndex, int32_t paramDataLength, int32_t *p_outdataCount, int8_t *p_outdata) |
| Responsible for reading acyclic data.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_AcyclicWrite (int32_t cardIndex, int32_t module, int32_t slaveAddr, int32_t slotNum, int32_t paramIndex, int32_t paramDataLength, int32_t *p_paramData) |
| Responsible for writing acyclic data.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_InitiateCommunication (int32_t cardIndex, int32_t module, int32_t slaveAddr, int32_t commRef, int32_t maxTimeoutInMS) |
| Responsible for initiating a communication request.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_AbortCommunication (int32_t cardIndex, int32_t module, int32_t slaveAddr, int32_t commRef) |
| Responsible for aborting all communication on the bus to and from specified slave address.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_SetOffline (int32_t cardIndex, int32_t module, int32_t redMode) |
| Responsible for putting the entire bus offline.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_SetStop (int32_t cardIndex, int32_t module) |
| Responsible for stopping bus communication. The master exchanges the token with other masters in the network. If there is no further master available in the PROFIBUS network the master sends the token to itself. There is no data exchange between the master and the slaves.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_SetClear (int32_t cardIndex, int32_t module, int32_t redMode) |
| When the bus is forced into "clear" mode, only input data of the connected slaves are read but no output data is passed on to the peripherals.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_SetOperate (int32_t cardIndex, int32_t module, int32_t redMode) |
| Responsible for putting the bus in operate mode. Process data is transferred between the master and the slaves. The current input data is read cyclically and new output data is written.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_GetMS0ConnectionStatus (int32_t cardIndex, int32_t module, int32_t slaveAddr, NAIBRD_PB_CONNECTION_STATUS *p_outconnectionStatus) |
| Responsible for reporting the connection status.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_ResetMS0ConnectionCounters (int32_t cardIndex, int32_t module, int32_t slaveAddr) |
| Responsible for resetting connection counters for the given slave.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_GetAlarmCounters (int32_t cardIndex, int32_t module, int32_t slaveAddr, NAIBRD_PB_ALARM_COUNTERS *p_outalarmCounters) |
| Responsible for returning alarm counter information for specified slave.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_ResetAlarmCounters (int32_t cardIndex, int32_t module, int32_t slaveAddr) |
| Responsible for resetting alarm counters for the specified slave.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_GetSlaveDiagnostics (int32_t cardIndex, int32_t module, int32_t slaveAddr, NAIBRD_PB_SLAVE_DIAGNOSTICS *p_outslaveDiagnostics) |
| Responsible for retrieving slave diagnostic information for a given slave.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_GetCPULoad (int32_t cardIndex, int32_t module, NAIBRD_PB_CPU_LOAD *p_outcpuLoad) |
| Responsible for reporting the load of the CPU.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_KickoffGetLiveList (int32_t cardIndex, int32_t module) |
| Responsible for Kicking off the probing of the entire bus for slaves. NOTE: This probing / data collection can take several minutes to complete. Caller can make repeated calls to naibrd_PB_GetLiveListResults to see if task completed. If still in progress, an error indicating so will be returned.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_GetLiveListResults (int32_t cardIndex, int32_t module, NAIBRD_PB_LIVELIST_RESULTS *p_outliveListResults) |
| Responsible for returning the results collected from making a call to naibrd_PB_KickoffGetLiveList. NOTE: The probing / data collection from the naibrd_PB_KickoffGetLiveList can take several minutes to complete. Caller can make repeated calls this function to see if task completed. If still in progress, an error indicating so will be returned. If the probing is finished, results will be returned in the NAIBRD_PB_LIVELIST_RESULTS struct.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_GetOperationMode (int32_t cardIndex, int32_t module, NAIBRD_PB_DPM_MASTER_STATE *p_outmasterState, NAIBRD_PB_DPM_OPERATION_MODE *p_outoperationMode) |
| Responsible for returning the current mode of bus operation.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_GetStatistics (int32_t cardIndex, int32_t module, NAIBRD_PB_STATISTICS *p_outstatistics) |
| Responsible for returning bus statistics.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_GetPSAKVersion (int32_t cardIndex, int32_t module, int firmwareVersionMaxLength, char *p_outfirmwareVersion, int32_t psakVersionMaxLength, char *p_outpsakVersion) |
| Responsible for returning the version of the underlying Profibus Software Access Kit (Softing).
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_GetLastAlarmData (int32_t cardIndex, int32_t module, int32_t slaveAddr, NAIBRD_PB_ALARM_DATA *p_outlastAlarmData) |
| Responsible for returning the last alarm data that was detected.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_GetPowerEnableForSegments (int32_t cardIndex, int32_t module, uint32_t *p_outpowerEnable) |
| Responsible for returning 32 bit value indicating which power supplies are currently enabled.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_GetTerminationEnableForSegments (int32_t cardIndex, int32_t module, uint32_t *p_outterminationEnable) |
| Responsible for returning 32 bit value indicating which segments have termination enabled.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_GetReceiverEnableForSegments (int32_t cardIndex, int32_t module, uint32_t *p_outreceiverEnable) |
| Responsible for returning 32 bit value indicating which segments have their receiver enabled.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_GetLockStatusForSegments (int32_t cardIndex, int32_t module, uint32_t *p_outlockStatus) |
| Responsible for returning 32 bit value indicating which segments have been "locked" (i.e. forcibly taken offline)
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_GetLastFunctionCallStatus (int32_t cardIndex, int32_t module, int32_t *p_outpbStatus) |
| Responsible for returning the the status of the last Profibus request that was made.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_GetTxFIFOCount (int32_t cardIndex, int32_t module, int32_t *p_outcount) |
| Get the number of words used in the Tx FIFO.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_GetRxFIFOCount (int32_t cardIndex, int32_t module, int32_t *p_outcount) |
| Get the number of words used in the Rx FIFO.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_ResetTxFIFO (int32_t cardIndex, int32_t module) |
| naibrd_PB_ResetTxFIFO forces the TX FIFO to be emptied without the need to force transmission to empty the FIFO.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_ResetRxFIFO (int32_t cardIndex, int32_t module) |
| naibrd_PB_ResetRxFIFO forces the RX FIFO to be emptied without the need to force receiving to empty the FIFO.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_PB_ResetTxAndRxFIFOs (int32_t cardIndex, int32_t module) |
| naibrd_PB_ResetTxAndRxFIFOs forces the TX FIFO and RX FIFO to be emptied without the need to force transmitting and receiving to empty the FIFOs.
|
|