EC-Master MainDevice Stack Source Code

3.10. EC-Master MainDevice Stack Source Code

In a source code delivery the MainDevice stack sources are divided into 4 parts:

  • SDK Header files

  • Real-time Ethernet Driver files (multiple Real-time Ethernet Drivers may be shipped)

  • Link OS driver files (only valid for the Real-time Ethernet Drivers)

  • MainDevice stack files (configuration, core and interface layer)

  • OS layer files (only valid for the MainDevice stack)

The MainDevice stack can be ported to several different operating systems and CPU architectures with different compilers and development environments. Typically no supported build environment files like IDE projects are shipped with the source code.

To build the MainDevice stack the appropriate build environment for the target operating system has to be used. If an integrated development environment (IDE) exists (Visual Studio, Eclipse, etc.) several projects containing all necessary files are needed to build the artefacts. If no integrated development environment is available makefiles and dependency rules may have to be created which contain the necessary MainDevice stack source and header files.

3.10.1. Components

For most platforms three separate independent binaries will have to be generated:

  1. Real-time Ethernet Driver Binary (e.g. a downloadable object module in VxWorks or a DLL in Windows). The Real-time Ethernet Driver binary will be dynamically bound to the application at runtime. (currently not for On Time RTOS-32 which uses static libraries)

  2. MainDevice Stack Library

  3. Remote API Server Library

3.10.1.1. Real-time Ethernet Driver Binaries

The following files have to be included into an IDE project or makefile:

  • Real-time Ethernet Driver files. Only one single Real-time Ethernet Driver must be selected even if multiple Real-time Ethernet Drivers are shipped. For each Real-time Ethernet Driver a separate binary has to be created.

  • Link OS layer files

  • Windows: a dynamic link library (.dll) has to be created. The name of the DLL has to be emllXxxx.dll where Xxxx shall be replaced by the Real-time Ethernet Driver type (e.g. emllI8255x.dll for the I8255x Real-time Ethernet Driver).

  • VxWorks: a downloadable kernel module (.out) has to be created. The name of the module has to be emllXxxx.out where Xxxx shall be replaced by the Real-time Ethernet Driver type (e.g. emllI8255x.out for the I8255x Real-time Ethernet Driver). sysLoSalAdd.c should be included in the BSP if needed and should not be compiled within the Real-time Ethernet Driver binary.

  • Linux/QNX: a shared object library (.so) has to be created.

  • RTX: an RTX dynamic link library (.rtdll) has to be created. The name of the DLL has to be emllXxxx.dll where Xxxx shall be replaced by the Real-time Ethernet Driver type (e.g. emllI8255x.dll for the I8255x Real-time Ethernet Driver).

  • INtime: a shared library (.rsl) has to be created. The name of the RSL has to be emllXxxx.rsl where Xxxx shall be replaced by the Real-time Ethernet Driver type (e.g. emllI8255x.rsl for the I8255x Real-time Ethernet Driver).

3.10.1.2. MainDevice Stack Binaries

The following files have to be included into an IDE project or makefile:

  • MainDevice stack files

  • OS layer files

  • For all platforms a static library has to be created. This library will have to be linked together with the application.

3.10.1.3. Remote API Server Binaries

The following files have to be included into an IDE project or makefile:

  • Remote API server files.

  • For all platforms a static library has to be created. This library will have to be linked together with the application.

See also

Platform and Operating Systems (OS) for required tool chain settings

3.10.2. Excluding features

It is possible to reduce the footprint of the MainDevice library and improve its execution performance by compiling less features.

EXCLUDE_EOE_ENDPOINT

FP-EoE-Endpoint

EXCLUDE_HOTCONNECT

FP-Hot-Connect

EXCLUDE_JUNCTION_REDUNDANCY

FP-Cable-Redundancy

EXCLUDE_MASTER_OBD

MainDevice Object Dictionary

EXCLUDE_RED_DEVICE

FP-Cable-Redundancy

EXCLUDE_SPLITTED_FRAME_PROCESSING

FP-Split-Frame-Processing

EXCLUDE_DC_SUPPORT

Class-A

The following defines and their impact are described below:

EXCLUDE_ADS_ADAPTER
emAdsAdapterStart()
emAdsAdapterStop()
EXCLUDE_AOE_SUPPORT
emAoeGetSlaveNetId()
emAoeRead()
emAoeReadReq()
emAoeWrite()
emAoeWriteReq()
emAoeReadWrite()
emAoeWriteControl()
EXCLUDE_BAD_CONNECTIONS
emBadConnectionsDetect()
EXCLUDE_CONFIG_EXTEND
EC_T_CFG_SLAVE_INFO::bExtended
emConfigExtend()
EXCLUDE_DCX
DCM DCX mode
EXCLUDE_EEPROM_SUPPORT
emReadSlaveEEPRom()
emReadSlaveEEPRomReq()
emWriteSlaveEEPRom()
emWriteSlaveEEPRomReq()
emReloadSlaveEEPRom()
emReloadSlaveEEPRomReq()
emAssignSlaveEEPRom()
emAssignSlaveEEPRomReq()
emActiveSlaveEEPRom()
emActiveSlaveEEPRomReq()
EXCLUDE_EOE_DEFFERED_SWITCHING

EC_T_USER_JOB::eUsrJob_SwitchEoeFrames

EXCLUDE_EOE_ENDPOINT

emEoeRegisterEndpoint()

EXCLUDE_EXECJOB_REENTRANCY_SUPPORT

EXCLUDE_FOE_SUPPORT
emFoeFileUpload()
emFoeUploadReq()
emFoeFileDownload()
emFoeDownloadReq()
emFoeSegmentedUploadReq()
emFoeSegmentedDownloadReq()
EXCLUDE_FORCE_PROCESSDATA
emForceProcessDataBits()
emReleaseProcessDataBits()
emReleaseAllProcessDataBits()
EXCLUDE_FRAME_LOGGING
emLogFrameEnable()
EXCLUDE_FRAME_LOSS_SIMULATION
emIoCtl - EC_IOCTL_SET_FRAME_LOSS_SIMULATION
emIoCtl - EC_IOCTL_SET_RXFRAME_LOSS_SIMULATION
emIoCtl - EC_IOCTL_SET_TXFRAME_LOSS_SIMULATION
EXCLUDE_GEN_OP_ENI
emConfigExtend()
EXCLUDE_INTERFACE_LOCK
No API protection against InitMaster/DeinitMaster
EXCLUDE_LINE_CROSSED_DETECTION
No line crossed detection
EXCLUDE_LOG_MESSAGES
No Log messages generated
EXCLUDE_MAILBOX_STATISTICS
EC_T_MASTER_INFO::MailboxStatistics
EXCLUDE_MASTER_OBD
EC_T_MASTER_INFO::BusDiagnosisInfo
EXCLUDE_MASTERSYNCUNITS
EC_T_CFG_SLAVE_INFO::awMasterSyncUnitIn
emGetMasterSyncUnitInfoNumOf()
emGetMasterSyncUnitInfo()
EXCLUDE_MEMORY_PROVIDER
emIoCtl - EC_IOCTL_REGISTER_PDMEMORYPROVIDER
EXCLUDE_MULTIPLE_CYC_ENTRIES
emIoCtl - EC_IOCTL_GET_CYCLIC_CONFIG_INFO
EC_T_USER_JOB::eUsrJob_ProcessRxFramesByTaskId
EC_T_USER_JOB::eUsrJob_SendCycFramesByTaskId
EXCLUDE_PORT_OPERATION
emBlockNode()
emOpenBlockedPorts()
emSetSlavePortState()
EXCLUDE_RAWMBX_SUPPORT
emClntSendRawMbx()
EXCLUDE_RED_DEVICE
EC_T_MASTER_INFO::RedundancyDiagnosisInfo
EXCLUDE_RESCUE_SCAN
emRescueScan()
EXCLUDE_S2SMBX_SUPPORT
EC_T_INIT_MASTER_PARMS::dwMaxS2SMbxSize
EC_T_INIT_MASTER_PARMS::dwMaxQueuedS2SMbxTfer
EXCLUDE_SLAVE_HANDLING
EC_T_CFG_SLAVE_INFO::bDisabled
EC_T_CFG_SLAVE_INFO::bDisconnected
emSetSlaveDisabled()
emSetSlavesDisabled()
emSetSlaveDisconnected()
emSetSlavesDisconnected()
EXCLUDE_SLAVE_IDENTIFICATION
/EtherCATConfig/Config/Slave/Info/Identification
EC_T_CFG_SLAVE_INFO::wIdentifyAdo
emReadSlaveIdentification()
EXCLUDE_SLAVE_STATISTICS
emGetSlaveStatistics()
emClearSlaveStatistics()
EXCLUDE_SOE_SUPPORT
emSoeRead()
emSoeReadReq()
emSoeWrite()
emSoeWriteReq()
emSoeAbortProcCmd()
EXCLUDE_SPLITTED_FRAME_PROCESSING
EC_IOCTL_SET_SPLITTED_FRAME_PROCESSING_ENABLED
EC_T_USER_JOB::eUsrJob_ProcessRxFramesByTaskId
EXCLUDE_TEXT
ecatGetText()
ecatGetNotifyText()
EXCLUDE_TRACE_DATA

EXCLUDE_TRACE_DATA_VARINFO
emTraceDataConfig()
emTraceDataGetInfo()
EXCLUDE_VARREAD
EC_T_CFG_SLAVE_INFO::wNumProcessVarsInp
EC_T_CFG_SLAVE_INFO::wNumProcessVarsOutp
emGetSlaveInpVarInfoNumOf()
emGetSlaveOutpVarInfoNumOf()
emGetSlaveInpVarInfo()
emGetSlaveInpVarInfoEx()
emGetSlaveOutpVarInfo()
emGetSlaveOutpVarInfoEx()
emGetSlaveOutpVarByObjectEx()
emGetSlaveInpVarByObjectEx()
emFindOutpVarByName()
emFindOutpVarByNameEx()
emFindInpVarByName()
emFindInpVarByNameEx()
EXCLUDE_VOE_SUPPORT
emVoeRead()
emVoeWrite()
emVoeWriteReq()
EXCLUDE_WKCSTATE
EC_T_CFG_SLAVE_INFO::wWkcStateDiagOffsIn
EC_T_CFG_SLAVE_INFO::wWkcStateDiagOffsOut
emGetDiagnosisImagePtr()