123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461 |
- /*
- powerlnk.h
- (C) B&R Industrie Elektronik
- */
- #ifndef POWERLNK_H_
- #define POWERLNK_H_ 0x1109 /* Version V1.10.9 */
- #ifdef __cplusplus
- extern "C"
- {
- #endif
- #include <bur/plctypes.h>
- #ifndef _BUR_PUBLIC
- #define _BUR_PUBLIC
- #endif
- /* Constants */
- #ifdef _REPLACE_CONST
- /* Error Numbers */
- #define ERR_PLMGR_VERS_CONFLICT 20900 /* Version conflict in system structures */
- #define ERR_PLMGR_NOMEM 20901 /* Failed to allocate memory */
- #define ERR_PLMGR_WRONG_DEVICE 20903 /* wrong device description */
- #define ERR_PLMGR_CONFIG_NOT_FOUND 20904 /* configuration not found */
- #define ERR_PLMGR_ALREADY_CONFIGURATED 20905 /* configuration already done */
- #define ERR_PLMGR_NOT_IMPLEMENTED 20906 /* function is not implemented */
- #define ERR_PLMGR_ILLEGAL_PARAMETER 20908 /* Illegal parameters in function call */
- #define ERR_PLMGR_WRONG_IDENT 20911 /* Wrong ident */
- #define ERR_PLMGR_ERROR_ALLOC_STATION 20913 /* Error at allocating station */
- #define ERR_PLMGR_ERROR_ALLOC_CHANNEL 20914 /* Error at allocating channel */
- #define ERR_PLMGR_ERROR_ALLOC_BUFFER 20915 /* Error at allocating buffer */
- #define ERR_PLMGR_CHANNEL_ALREADY_OPEN 20916 /* Channel was opened by someone else */
- #define ERR_PLMGR_NO_FRAME_RECEIVED 20917 /* No frame received by now */
- #define ERR_PLMGR_FRAME_TOO_LONG 20918 /* Received frame does not fit into buffer */
- #define ERR_PLMGR_WRITE_ACTIVE 20919 /* Write is already active for this channel */
- #define ERR_PLMGR_OFFSET_TO_HIGH 20920 /* Offset for ident is too high */
- #define ERR_PLMGR_NIL_POINTER 20921 /* parameter pointed to address 0 */
- #define ERR_PLMGR_OVERFLOW 20922 /* overflow of buffer */
- #define ERR_PLMGR_UNAVAILABLE_DATAPOINT 20923 /* datapoint not available */
- #define ERR_PLMGR_WRONG_TASKCLASS 20924 /* taskklass does not exist */
- #define ERR_PLMGR_STATION_NOT_ACTIVE 20925 /* station not active */
- #define ERR_PLMGR_TOO_MANY_INTERFACES 20926 /* To many PowerLink-Interfaces configured */
- #define ERR_PLMGR_BUS_CONFIGURED_TWICE 20927 /* Same bus number declared twice */
- #define ERR_PLMGR_SYNC_BY_SYSTEM 20928 /* Syncronisation has to be configured by System */
- #define ERR_PLMGR_SYNC_FAILED 20929 /* Synchronizing System failed */
- #define ERR_PLMGR_CONFIG_CONFLICT 20930 /* Conflict with IOTIMER-Device-Configuration */
- #define ERR_PLMGR_NOT_IN_PRES 20931 /* data point not in poll response of station */
- #define ERR_PLMGR_UNKNOWN_TYPE 20932 /* datatype of data point not valid */
- #define ERR_PLMGR_NO_PDO_MAPPING_DEFINED 20933 /* no PDO mapping defined */
- #define ERR_PLMGR_ALREADY_INITIALIZED 20937 /* station already initialized */
- #define ERR_PLMGR_INIT_NOT_FINISHED 20938 /* initialization of delayed station not finished yet*/
- #define ERR_PLMGR_PARSE_ERROR 20950 /* Error at parsing datapoint description */
- #define ERR_PLMGR_PARSE_END_EXPECTED 20951 /* expected end of string earlier */
- #define ERR_PLMGR_PARSE_NO_PERCENT 20952 /* no percent % singn at start of datapoint description */
- #define ERR_PLMGR_PARSE_NOT_IN_OR_OUT 20953 /* Direction neither I nor Q */
- #define ERR_PLMGR_PARSE_INTERFACE 20954 /* incorrect interface number */
- #define ERR_PLMGR_PARSE_STATION 20955 /* incorrect station number */
- #define ERR_PLMGR_PARSE_MODUL 20956 /* incorrect modul number */
- #define ERR_PLMGR_PARSE_SUBMODUL 20957 /* incorrect sub modul number */
- #define ERR_PLMGR_PARSE_CHANNEL 20958 /* incorrect channel number */
- #define ERR_PLMGR_PARSE_BIT 20959 /* incorrect bit number */
- #define ERR_PLMGR_PARSE_TO_MANY_NUMBERS 20960 /* too many numbers in datapoint description */
- #define ERR_PLMGR_PARSE_NETTIME 20961 /* wrong datatype or length for nettime */
- #define ERR_PLMGR_PARSE_SLOT 20962 /* incorrect slot number SL */
- #define ERR_PLMGR_PARSE_SUBSLOT 20963 /* incorrect subslot number SS */
- #define ERR_PLMGR_PARSE_TRAILINGCHARS 20964 /* trailing characters after valid channel or device name*/
- #define ERR_PLMGR_PARSE_ARRAYSIZE 20965 /* arraysize not valid */
- #define ERR_PLMGR_WARNING_FW_UPDATE 20980 /* Updated firmware for station, (in error log book) */
- #define ERR_PLMGR_HW_BOOTUP_FAILED 20981 /* Error at starting PowerLink hardware (in error log book) */
- #define ERR_PLMGR_RECOMMEND_FW_UPDATE 20982 /* Firmware update for IF686 is recommended, download plfif686.br */
- #define ERR_PLMGR_INTERNAL 20997 /* Internal error in Library, this should never happen (in error log book) */
- #define ERR_PLMGR_EXCEPTION 20998 /* unexpected exception from PowerLink hardware (in error log book) */
- #define ERR_PLMGR_NO_POWERLNK_LIBRARY 20999 /* PowerLink-Library not on plc */
- /* Taskclasses for plCECreate function */
- #define plCE_CYCLIC_1 1
- #define plCE_CYCLIC_2 2
- #define plCE_CYCLIC_3 3
- #define plCE_CYCLIC_4 4
- /* plCE_CYCLIC_5 .. 8 only valid for i386-Targets */
- #define plCE_CYCLIC_5 5
- #define plCE_CYCLIC_6 6
- #define plCE_CYCLIC_7 7
- #define plCE_CYCLIC_8 8
- /* plCE_TIMER_x only valid for m68k-Targets */
- #define plCE_TIMER_1 -1
- #define plCE_TIMER_2 -2
- /* Flags for plAcycOpen function */
- #define plOPEN_MODE_READ 0 /* open channel for read*/
- #define plOPEN_MODE_WRITE 1 /* open channel for write */
- #define plOPEN_MODE_RW 2 /* open channel for read and write */
- #define plOPEN_MODE_EPLV1 0x10 /* Force to V1 format */
- #define plOPEN_MODE_EPLV2 0x20 /* Force to V2 format */
- #define plOPEN_MODE_LENGTH 0x40 /* Use length in frame even in V2 */
- #define plOPEN_PRIORITY_ENABLE 0x8000 /* enable using priority (used in V2 only) */
- /* priority for asynchrounous send, applied in EPL V2 only */
- #define plOPEN_PRIORITY_LOWEST 0x0000 /* lowest priority */
- #define plOPEN_PRIORITY_LOWER 0x0100
- #define plOPEN_PRIORITY_LOW 0x0200
- #define plOPEN_PRIORITY_GENERIC 0x0300 /* normal priority (default) */
- #define plOPEN_PRIORITY_HIGH 0x0400
- #define plOPEN_PRIORITY_HIGHER 0x0500
- #define plOPEN_PRIORITY_HIGHEST 0x0600 /* highest priority */
- #define plOPEN_PRIORITY_NMT 0x0700 /* reserved for NMT requests */
- /* States from plState Function */
- /* Error States from plState */
- #define plSTATE_WRONG_IDENT 0xffff
- /* States of Stations */
- #define plSTATE_STATION_NONEXISTANT 0x0000 /* No Access to this station has occured yet */
- #define plSTATE_STATION_WAITING 0x0001 /* The software tried to access this station, but it is not on the BUS */
- #define plSTATE_STATION_OSDL 0x0002 /* The firmware had the wrong version so a Firmwareupdate is in progress */
- #define plSTATE_STATION_CONFIG 0x0003 /* The configuration of the Station is in progress */
- #define plSTATE_STATION_ACTIVATEING 0x0004 /* The activation of the copy entries is in progress */
- #define plSTATE_STATION_ACTIVE 0x0005 /* The station is online and the copy entries are handle cyclically */
- #define plSTATE_STATION_INACTIVE 0x0006 /* The station is offline but was active before */
- #define plSTATE_STATION_CHANGED 0x0007 /* The IO configuration of the station has changed, a reboot is necessary to
- allow the changed station to get active. */
- #define plSTATE_STATION_CFGFAILED 0x0008 /* The configuration of the station failed, and the option EPL_NoResetOnConfigFail is on. */
- #define plSTATE_STATION_FAILED 0x000f /* Configuration of Station failed (out of memory or other serious problem) */
- /* States of Copy Entries */
- #define plSTATE_CE_WAITING 1 /* Station for Copy-Entry was not active since Copy-Entry was created */
- #define plSTATE_CE_ACTIVE 2 /* Station is online and Copy-Entry is active */
- #define plSTATE_CE_INACTIVE 3 /* Copy-Entry is active, but Station is not online */
- #define plSTATE_CE_ERROR 4 /* Copy-Entry is not available on its Station */
- /* States of Write Channels */
- #define plSTATE_CHANNEL_WRITE_MASK 0x0f00 /* Mask state of Read/Write-Channels with this mask to get the Write-State */
- #define plSTATE_CHANNEL_WRITE_CLOSED 0x0000 /* This Channel is not opend for Write access */
- #define plSTATE_CHANNEL_WRITE_OPEN 0x0100 /* Channel is open, no Frames are waiting to be sent */
- #define plSTATE_CHANNEL_WRITE_ACTIVE 0x0200 /* Write-Buffer is waiting to be sent */
- #define plSTATE_CHANNEL_WRITE_WRONG 0x0f00 /* Result of plSTATE_WRONG_IDENT & plSTATE_CHANNEL_WRITE_MASK */
- /* States of Read Channels */
- #define plSTATE_CHANNEL_READ_MASK 0x00f0 /* Mask state of Read/Write-Channels with this mask to get the Read-State */
- #define plSTATE_CHANNEL_READ_CLOSED 0x0000 /* This channel is not opend for Read access */
- #define plSTATE_CHANNEL_READ_EMPTY 0x0010 /* This channel is open but does not have any frames */
- #define plSTATE_CHANNEL_READ_READY 0x0020 /* This channel is open and has a ready frame to be read */
- #define plSTATE_CHANNEL_READ_WRONG 0x00f0 /* Result of plSTATE_WRONG_IDEND & plSTATE_CHANNEL_READ_MASK */
- /* actionIDs for plAction function */
- #define plACTION_GET_NET_QUALITY 1 /* read statistical info of netquality*/
- #define plACTION_GET_IDENT 2 /* get ident of a PowerLink station */
- #define plACTION_START_SYNC_STATISTICS 3 /* start collection of statistic information of synchronous task class only on SG3 */
- #define plACTION_STOP_SYNC_STATISTICS 4 /* stop collection of statistic information of synchronous task class only on SG3*/
- #define plACTION_GET_SYNC_STATISTICS 5 /* read statistic information of synchrounous task class to
- a PLACTION_SYNC_STATISTICS_typ structure only on SG3 */
- #define plACTION_GET_FIRMWARE_VERSION 6 /* read version of firmware to UDINT variable */
- #define plACTION_DEVICE_TO_BUS_NR 7 /* Convert device string to bus number */
- #define plACTION_GET_STATION_NUMBER 8 /* read node number of local station to UDINT variable */
- #define plACTION_GET_IF_PARAMETERS 9 /* get the interface parameters for a powerlink bus */
- #define plACTION_GET_LOST_INA_SOURCE 10 /* internal only! get last source station of lost ina request to a DINT (-1) if no lost */
- #define plACTION_GET_STATIONFLAG 12 /* get station flag e.g. plSYSCONF_STATIONFLAG_SLOW to UDINT variable */
- #define plACTION_GET_STATION_HWVARIANT 13 /* get hardware ident of station to UDINT variable */
- #define plACTION_GET_STATION_SHIFT 14 /* get cyclic cycle shift of multiplexed station to UDINT variable */
- #define plACTION_GET_IF_CYCLE_TIME 15 /* get powerlink cycle time to UDINT variable */
- #define plACTION_GET_IF_PRESCALE 16 /* get powerlink prescale to UDINT variable */
- #define plACTION_GET_IF_MUXPRESCALE 17 /* get multiplex prescale to UDINT variable */
- #define plACTION_GET_IF_RSQUEUELAPCNT 18 /* get rs queue lap count to UDINT variable */
- #define plACTION_GET_CROSSLINK_INFO 19 /* get crosslink infomation of input datapoint (only SG4 >= AR V2.85) */
- #define plACTION_GET_PROTOCOL_VERSION 20 /* get set protocol version to UDINT variable */
- #define plACTION_GET_DP_INFO 21 /* query the PDO information of an I/O data point (only SG4 >= AR B2.96) */
- #define plACTION_GET_PDO_INFO 22 /* query the PDO information of by Index/Subindex (only SG4 >= AR B2.96) */
- /* action 23, 24 and 25 used by ncman */
- /* action 26, 27 cycletime info for NCManager */
- #define plACTION_SET_STATION_NUMBER 28 /* set node number of delayed iCN */
- /* action 29 used by vision */
- #define plDIRECTION_IN 1 /* Direction "input" to PLC returned from plACTION_GET_PDO_INFO */
- #define plDIRECTION_OUT 2 /* Direction "output" from PLC returned from plACTION_GET_PDO_INFO */
- #define plDIRECTION_XOUT 3 /* Direction "crosslinked output" returned from plACTION_GET_PDO_INFO */
- #define plMESSAGE_TYPE_PREQ 3 /* MessageType "poll request" returned from plACTION_GET_PDO_INFO */
- #define plMESSAGE_TYPE_PRES 4 /* MessageType "poll response" returned from plACTION_GET_PDO_INFO */
- /* Flags for stations in config */
- #define plSYSCONF_STATIONFLAG_SLOW 0x20 /* Station is a slow one */
- #else
- #ifndef _GLOBAL_CONST
- #define _GLOBAL_CONST _WEAK const
- #endif
- _GLOBAL_CONST signed char plCE_CYCLIC_8;
- _GLOBAL_CONST signed char plCE_CYCLIC_7;
- _GLOBAL_CONST signed char plCE_CYCLIC_6;
- _GLOBAL_CONST signed char plCE_CYCLIC_5;
- _GLOBAL_CONST signed char plCE_CYCLIC_4;
- _GLOBAL_CONST signed char plCE_CYCLIC_3;
- _GLOBAL_CONST signed char plCE_CYCLIC_2;
- _GLOBAL_CONST signed char plCE_CYCLIC_1;
- _GLOBAL_CONST signed char plCE_TIMER_2;
- _GLOBAL_CONST signed char plCE_TIMER_1;
- _GLOBAL_CONST unsigned long plOPEN_MODE_LENGTH;
- _GLOBAL_CONST unsigned long plOPEN_MODE_EPLV2;
- _GLOBAL_CONST unsigned long plOPEN_MODE_EPLV1;
- _GLOBAL_CONST unsigned long plOPEN_MODE_RW;
- _GLOBAL_CONST unsigned long plOPEN_MODE_WRITE;
- _GLOBAL_CONST unsigned long plOPEN_MODE_READ;
- _GLOBAL_CONST unsigned char plSYSCONF_STATIONFLAG_SLOW;
- _GLOBAL_CONST unsigned short plSTATE_WRONG_IDENT;
- _GLOBAL_CONST unsigned short plSTATE_CE_ERROR;
- _GLOBAL_CONST unsigned short plSTATE_CE_INACTIVE;
- _GLOBAL_CONST unsigned short plSTATE_CE_ACTIVE;
- _GLOBAL_CONST unsigned short plSTATE_CE_WAITING;
- _GLOBAL_CONST unsigned short plSTATE_STATION_FAILED;
- _GLOBAL_CONST unsigned short plSTATE_STATION_CFGFAILED;
- _GLOBAL_CONST unsigned short plSTATE_STATION_CHANGED;
- _GLOBAL_CONST unsigned short plSTATE_STATION_INACTIVE;
- _GLOBAL_CONST unsigned short plSTATE_STATION_ACTIVE;
- _GLOBAL_CONST unsigned short plSTATE_STATION_ACTIVATEING;
- _GLOBAL_CONST unsigned short plSTATE_STATION_CONFIG;
- _GLOBAL_CONST unsigned short plSTATE_STATION_OSDL;
- _GLOBAL_CONST unsigned short plSTATE_STATION_WAITING;
- _GLOBAL_CONST unsigned short plSTATE_STATION_NONEXISTANT;
- _GLOBAL_CONST unsigned short plSTATE_CHANNEL_WRITE_WRONG;
- _GLOBAL_CONST unsigned short plSTATE_CHANNEL_WRITE_OPEN;
- _GLOBAL_CONST unsigned short plSTATE_CHANNEL_WRITE_ACTIVE;
- _GLOBAL_CONST unsigned short plSTATE_CHANNEL_WRITE_CLOSED;
- _GLOBAL_CONST unsigned short plSTATE_CHANNEL_WRITE_MASK;
- _GLOBAL_CONST unsigned short plSTATE_CHANNEL_READ_WRONG;
- _GLOBAL_CONST unsigned short plSTATE_CHANNEL_READ_READY;
- _GLOBAL_CONST unsigned short plSTATE_CHANNEL_READ_EMPTY;
- _GLOBAL_CONST unsigned short plSTATE_CHANNEL_READ_CLOSED;
- _GLOBAL_CONST unsigned short plSTATE_CHANNEL_READ_MASK;
- _GLOBAL_CONST unsigned char plMESSAGE_TYPE_PRES;
- _GLOBAL_CONST unsigned char plMESSAGE_TYPE_PREQ;
- _GLOBAL_CONST unsigned char plDIRECTION_XOUT;
- _GLOBAL_CONST unsigned char plDIRECTION_OUT;
- _GLOBAL_CONST unsigned char plDIRECTION_IN;
- _GLOBAL_CONST unsigned long plACTION_GET_PDO_INFO;
- _GLOBAL_CONST unsigned long plACTION_GET_DP_INFO;
- _GLOBAL_CONST unsigned long plACTION_GET_CROSSLINK_INFO;
- _GLOBAL_CONST unsigned long plACTION_GET_IF_RSQUEUELAPCNT;
- _GLOBAL_CONST unsigned long plACTION_GET_IF_MUXPRESCALE;
- _GLOBAL_CONST unsigned long plACTION_GET_IF_PRESCALE;
- _GLOBAL_CONST unsigned long plACTION_GET_IF_CYCLE_TIME;
- _GLOBAL_CONST unsigned long plACTION_GET_STATION_HWVARIANT;
- _GLOBAL_CONST unsigned long plACTION_GET_STATIONFLAG;
- _GLOBAL_CONST unsigned long plACTION_GET_IF_PARAMETERS;
- _GLOBAL_CONST unsigned long plACTION_GET_STATION_NUMBER;
- _GLOBAL_CONST unsigned long plACTION_DEVICE_TO_BUS_NR;
- _GLOBAL_CONST unsigned long plACTION_GET_FIRMWARE_VERSION;
- _GLOBAL_CONST unsigned long plACTION_GET_SYNC_STATISTICS;
- _GLOBAL_CONST unsigned long plACTION_STOP_SYNC_STATISTICS;
- _GLOBAL_CONST unsigned long plACTION_START_SYNC_STATISTICS;
- _GLOBAL_CONST unsigned long plACTION_GET_IDENT;
- _GLOBAL_CONST unsigned long plACTION_GET_NET_QUALITY;
- _GLOBAL_CONST unsigned long plACTION_SET_STATION_NUMBER;
- _GLOBAL_CONST unsigned short ERR_PLMGR_NO_POWERLNK_LIBRARY;
- _GLOBAL_CONST unsigned short ERR_PLMGR_EXCEPTION;
- _GLOBAL_CONST unsigned short ERR_PLMGR_INTERNAL;
- _GLOBAL_CONST unsigned short ERR_PLMGR_RECOMMEND_FW_UPDATE;
- _GLOBAL_CONST unsigned short ERR_PLMGR_HW_BOOTUP_FAILED;
- _GLOBAL_CONST unsigned short ERR_PLMGR_WARNING_FW_UPDATE;
- _GLOBAL_CONST unsigned short ERR_PLMGR_PARSE_ARRAYSIZE;
- _GLOBAL_CONST unsigned short ERR_PLMGR_PARSE_TRAILINGCHARS;
- _GLOBAL_CONST unsigned short ERR_PLMGR_PARSE_SUBSLOT;
- _GLOBAL_CONST unsigned short ERR_PLMGR_PARSE_SLOT;
- _GLOBAL_CONST unsigned short ERR_PLMGR_PARSE_NETTIME;
- _GLOBAL_CONST unsigned short ERR_PLMGR_PARSE_TO_MANY_NUMBERS;
- _GLOBAL_CONST unsigned short ERR_PLMGR_PARSE_BIT;
- _GLOBAL_CONST unsigned short ERR_PLMGR_PARSE_CHANNEL;
- _GLOBAL_CONST unsigned short ERR_PLMGR_PARSE_SUBMODUL;
- _GLOBAL_CONST unsigned short ERR_PLMGR_PARSE_MODUL;
- _GLOBAL_CONST unsigned short ERR_PLMGR_PARSE_STATION;
- _GLOBAL_CONST unsigned short ERR_PLMGR_PARSE_INTERFACE;
- _GLOBAL_CONST unsigned short ERR_PLMGR_PARSE_NOT_IN_OR_OUT;
- _GLOBAL_CONST unsigned short ERR_PLMGR_PARSE_NO_PERCENT;
- _GLOBAL_CONST unsigned short ERR_PLMGR_PARSE_END_EXPECTED;
- _GLOBAL_CONST unsigned short ERR_PLMGR_PARSE_ERROR;
- _GLOBAL_CONST unsigned short ERR_PLMGR_INIT_NOT_FINISHED;
- _GLOBAL_CONST unsigned short ERR_PLMGR_ALREADY_INITIALIZED;
- _GLOBAL_CONST unsigned short ERR_PLMGR_NO_PDO_MAPPING_DEFINED;
- _GLOBAL_CONST unsigned short ERR_PLMGR_UNKNOWN_TYPE;
- _GLOBAL_CONST unsigned short ERR_PLMGR_NOT_IN_PRES;
- _GLOBAL_CONST unsigned short ERR_PLMGR_CONFIG_CONFLICT;
- _GLOBAL_CONST unsigned short ERR_PLMGR_SYNC_FAILED;
- _GLOBAL_CONST unsigned short ERR_PLMGR_SYNC_BY_SYSTEM;
- _GLOBAL_CONST unsigned short ERR_PLMGR_BUS_CONFIGURED_TWICE;
- _GLOBAL_CONST unsigned short ERR_PLMGR_TOO_MANY_INTERFACES;
- _GLOBAL_CONST unsigned short ERR_PLMGR_STATION_NOT_ACTIVE;
- _GLOBAL_CONST unsigned short ERR_PLMGR_WRONG_TASKCLASS;
- _GLOBAL_CONST unsigned short ERR_PLMGR_UNAVAILABLE_DATAPOINT;
- _GLOBAL_CONST unsigned short ERR_PLMGR_OVERFLOW;
- _GLOBAL_CONST unsigned short ERR_PLMGR_NIL_POINTER;
- _GLOBAL_CONST unsigned short ERR_PLMGR_OFFSET_TO_HIGH;
- _GLOBAL_CONST unsigned short ERR_PLMGR_WRITE_ACTIVE;
- _GLOBAL_CONST unsigned short ERR_PLMGR_FRAME_TOO_LONG;
- _GLOBAL_CONST unsigned short ERR_PLMGR_NO_FRAME_RECEIVED;
- _GLOBAL_CONST unsigned short ERR_PLMGR_CHANNEL_ALREADY_OPEN;
- _GLOBAL_CONST unsigned short ERR_PLMGR_ERROR_ALLOC_BUFFER;
- _GLOBAL_CONST unsigned short ERR_PLMGR_ERROR_ALLOC_CHANNEL;
- _GLOBAL_CONST unsigned short ERR_PLMGR_ERROR_ALLOC_STATION;
- _GLOBAL_CONST unsigned short ERR_PLMGR_WRONG_IDENT;
- _GLOBAL_CONST unsigned short ERR_PLMGR_ILLEGAL_PARAMETER;
- _GLOBAL_CONST unsigned short ERR_PLMGR_NOT_IMPLEMENTED;
- _GLOBAL_CONST unsigned short ERR_PLMGR_ALREADY_CONFIGURATED;
- _GLOBAL_CONST unsigned short ERR_PLMGR_CONFIG_NOT_FOUND;
- _GLOBAL_CONST unsigned short ERR_PLMGR_WRONG_DEVICE;
- _GLOBAL_CONST unsigned short ERR_PLMGR_NOMEM;
- _GLOBAL_CONST unsigned short ERR_PLMGR_VERS_CONFLICT;
- #endif
- /* Datatypes and datatypes of function blocks */
- /* Konfiguration for remote stations */
- typedef struct PLSYSCONF_RS_typ
- {
- USINT size_x16; /* Size of configuration entry in blocks of 16 bytes (by now always 1) */
- /* Set size_x16 to 0 to mark the last remote station configuration entry */
- USINT bus; /* Bus number: Valid Numbers 1 .. 255 */
- USINT station; /* Station number */
- USINT flags; /* flags as OR of constants plSYSCONF_STATIONFLAG_... */
- UDINT hwVariant; /* Hardware variant: 0=any */
- INT insize; /* Size for input buffer (0xffff for automatic)*/
- INT outsize; /* Size for output buffer (0xffff for automatic)*/
- INT RespTimeout; /* response timeout in µs <= 0 -> default = 25µs */
- USINT MuxNetworkSlot; /* ignored for normal stations, for multiplexed stations 1 to MuxPrescaler */
- USINT reserve2; /* reserved set to 0 */
- }PLSYSCONF_RS_typ;
- /* Konfiguration of interfaces */
- typedef struct PLSYSCONF_IF_typ/* Configuration structure for PowerLink Interface Modules */
- {
- USINT station; /* Station number 0 for Master, 1..253 for intelligent slave */
- USINT slot; /* slot of the POWERLINK interface card */
- USINT subslot; /* subslot of the POWERLINK interface card */
- USINT interface; /* interface number */
- UDINT pl_cycle; /* cycle time of PowerLink cycle in us */
- UDINT pl_prescale; /* prescaler for synchron PowerLink timer-taskclass */
- UDINT uptimeout; /* timeout for configurated remote stations at power up in us */
- USINT bus; /* Bus number of PowerLink interface. Corresponds to
- "bus" element in the PLSYSCONF_RS_typ. Valid Number 1...255.
- If bus is set to 0, the Library countes the busses by itself. */
- USINT MuxStationsPerCycle; /* ignored since FW-Version V0.06.0: until FW-Version V0.05.9 number of handled multiplexed stations in each powerlink cycle */
- USINT MuxPrescaler; /* number of powerlink cycles for one mux cycle 1 .. 253 */
- SINT ATOCtaskclass;/* taskclass triggering the Output-DMA, 0 ..triggered by System-Tick, plCE_CYCLIC_1 to plCE_CYCLIC_8 ..triggered by cyclic taskklass */
- UDINT reservedlong; /* reserved set to 0 */
- }PLSYSCONF_IF_typ;
- typedef struct PLSYSCONF_typ /* global PowerLink configuration */
- {
- USINT noIF; /* number of interface cards (allways 1 on SG3) */
- USINT takt_master; /* Which interface is taktmaster on SG3 (allways 1), 0 for no taktmaster */
- UINT reserve1; /* reserved set to 0 */
- UDINT pRemoteCfg; /* Pointer to array of remote station configuration */
- /* end array with an entry with .size_x16=0 */
- PLSYSCONF_IF_typ interfaces[15]; /* Interface configurations */
- }PLSYSCONF_typ;
- /* Object structures for plAction function */
- typedef struct PLACTION_NET_QUALITY_typ{
- UDINT nLineQualFreezeCnt; /* out: count of started io cycles within last time */
- UDINT nLineQualFailCnt; /* out: count of failed cycles within last time */
- }PLACTION_NET_QUALITY_typ;
- typedef struct PLACTION_GET_IDENT_typ{
- char *pName; /* in: name */
- UDINT ident; /* out: ident */
- }PLACTION_GET_IDENT_typ;
- typedef struct PLACTION_DEVICE_TO_BUS_NR_typ{
- char *pDeviceString; /* in: device string */
- USINT busNumber; /* out: bus number */
- }PLACTION_DEVICE_TO_BUS_NR_typ;
- /* PLACTION_SYNC_STATISTICS_typ Supported only on SG3 */
- typedef struct PLACTION_SYNC_STATISTICS_typ{
- UINT act_usec; /* out: duration of last synchrounous taskclass */
- UINT min_usec; /* out: minimal duration of synchrounous taskclass */
- UINT max_usec; /* out: maximal duration of synchrounous taskclass */
- UINT act_cycle; /* out: exact cycletime of last synchronous taskclass */
- UINT min_cycle; /* out: minimal cycletime of synchronous taskclass */
- UINT max_cycle; /* out: maximal cycletime of synchronous taskclass */
- }PLACTION_SYNC_STATISTICS_typ;
- typedef struct PLACTION_GET_CROSSLINK_INFO_typ{
- const char *DeviceName; /* in: name of io device e.g. "SS1.IF2.ST3.SL7" */
- const char *ChannelName; /* in: name of datapoint e.g. "AnalogInput01" */
- UINT NodeId; /* out: Node number of powerlink station */
- UINT Offset; /* out: Offset in data counted in Bits */
- UINT Length; /* out: Length of data point counted in Bits */
- UINT TypeId; /* out: Type ident of datapoint EPL V2 (matches CANopen Specification) */
- }PLACTION_GET_CROSSLINK_INFO_typ;
- typedef struct PLACTION_GET_DP_INFO_typ{
- const char *DeviceName; /* in: name of io device e.g. "SS1.IF2.ST3.SL7" */
- const char *ChannelName; /* in: name of datapoint e.g. "AnalogInput01" */
- USINT DestNode; /* out: Node number of destination in network frame */
- USINT SrcNode; /* out: Node number of source in network frame */
- USINT MessageType; /* out: Message Type on Powerlink (plMESSAGE_TYPE_PREQ(=3) PReq, plMESSAGE_TYPE_PRES(=4) PRes) */
- USINT MuxSlot; /* out: multiplex slot (0 continous station) */
- UINT OffsetAbs; /* out: Offset in net data of EPL frame counted in bits */
- UINT OffsetRel; /* out: Offset relative to station net data in bits */
- UINT Length; /* out: Length of data point counted in bits */
- UINT TypeId; /* out: Type ident of datapoint EPL V2 (matches CANopen Specification) */
- UINT NodeInSize; /* out: input net size of station (PRes) */
- UINT NodeOutSize; /* out: output net size of station (size of PReq, or part of PResMN ) */
- USINT Direction; /* out: plDIRECTION_IN(=1) Input,plDIRECTION_OUT(=2) Output relative to local node */
- USINT Node; /* out: node of datapoint */
- UINT reserved; /* res: reserved word for alignment */
- UDINT ImageIndex; /* out: image index for inputs 0 for outputs */
- UDINT ImageOffset; /* out: offset of datapoint in local image buffer (bytes) */
- }PLACTION_GET_DP_INFO_typ;
- typedef struct PLACTION_GET_PDO_INFO_typ{
- const char *DeviceName; /* in: name of io device e.g. "SS1.IF2.ST3.SL7" */
- UINT ODIndex; /* in: Index of object in Powerlink object dictionary */
- USINT ODSubindex; /* in: query the PDO information of by Index/Subindex */
- USINT align; /* res: reseved for alignment */
- USINT DestNode; /* out: Node number of destination in network frame */
- USINT SrcNode; /* out: Node number of source in network frame */
- USINT MessageType; /* out: Message Type on Powerlink (plMESSAGE_TYPE_PREQ(=3) PReq, plMESSAGE_TYPE_PRES(=4) PRes) */
- USINT MuxSlot; /* out: multiplex slot (0 continous station) */
- UINT OffsetAbs; /* out: Offset in net data of EPL frame counted in bits */
- UINT OffsetRel; /* out: Offset relative to station net data in bits */
- UINT Length; /* out: Length of data point counted in bits */
- UINT TypeId; /* out: Type ident of datapoint EPL V2 (matches CANopen Specification) */
- UINT NodeInSize; /* out: input net size of station (PRes) */
- UINT NodeOutSize; /* out: output net size of station (size of PReq, or part of PResMN ) */
- USINT Direction; /* out: plDIRECTION_IN(=1) Input,plDIRECTION_OUT(=2) Output relative to local node */
- USINT Node; /* out: node of datapoint */
- UINT reserved; /* res: reserved word for alignment */
- UDINT ImageIndex; /* out: image index for inputs 0 for outputs */
- UDINT ImageOffset; /* out: offset of datapoint in local image buffer (bytes) */
- }PLACTION_GET_PDO_INFO_typ;
- /* Prototyping of functions and function blocks */
- _BUR_PUBLIC UINT plConfig(PLSYSCONF_typ *pConfigStruct);
- _BUR_PUBLIC UINT plCECreate(const char* pDatapoint, void* address, SINT taskclass, UDINT *pIdent);
- _BUR_PUBLIC UINT plCEDelete(UDINT ident);
- _BUR_PUBLIC UINT plState(UDINT ident);
- _BUR_PUBLIC UINT plAction(UDINT ident, UDINT actionID, void* pObject, UDINT objectSize);
- _BUR_PUBLIC UINT plAcycOpen(const char* pName, UDINT flags, UDINT *pIdent);
- _BUR_PUBLIC UINT plAcycClose(UDINT ident);
- _BUR_PUBLIC UINT plAcycRead(UDINT ident, void* bufferAdr, UDINT bufferLen, UDINT *pReadLen);
- _BUR_PUBLIC UINT plAcycInvite(UDINT ident);
- _BUR_PUBLIC UINT plAcycWrite(UDINT ident, void* bufferAdr, UDINT bufferLen, UDINT *pWrittenLen);
- #ifdef __cplusplus
- };
- #endif
- #endif /* POWERLNK_H_ */
|