AdsDef.h

Go to the documentation of this file.

#ifndef __ADSDEF_H__
#define __ADSDEF_H__

#ifdef __cplusplus
#include <cstdint>
#include <iosfwd>
#include <string>
#else
#include <stdint.h>
#endif

#define ADS_TCP_SERVER_PORT 0xBF02

// AMS Ports
#define AMSPORT_LOGGER                  100
#define AMSPORT_R0_RTIME                200
#define AMSPORT_R0_TRACE                (AMSPORT_R0_RTIME + 90)
#define AMSPORT_R0_IO                   300
#define AMSPORT_R0_SPS                  400
#define AMSPORT_R0_NC                   500
#define AMSPORT_R0_ISG                  550
#define AMSPORT_R0_PCS                  600
#define AMSPORT_R0_PLC                  801
#define AMSPORT_R0_PLC_RTS1             801
#define AMSPORT_R0_PLC_RTS2             811
#define AMSPORT_R0_PLC_RTS3             821
#define AMSPORT_R0_PLC_RTS4             831
#define AMSPORT_R0_PLC_TC3              851

// ADS Cmd Ids
#define ADSSRVID_INVALID                    0x00
#define ADSSRVID_READDEVICEINFO             0x01
#define ADSSRVID_READ                       0x02
#define ADSSRVID_WRITE                      0x03
#define ADSSRVID_READSTATE                  0x04
#define ADSSRVID_WRITECTRL                  0x05
#define ADSSRVID_ADDDEVICENOTE              0x06
#define ADSSRVID_DELDEVICENOTE              0x07
#define ADSSRVID_DEVICENOTE                 0x08
#define ADSSRVID_READWRITE                  0x09

// ADS reserved index groups
#define ADSIGRP_SYMTAB                      0xF000
#define ADSIGRP_SYMNAME                     0xF001
#define ADSIGRP_SYMVAL                      0xF002

#define ADSIGRP_SYM_HNDBYNAME               0xF003
#define ADSIGRP_SYM_VALBYNAME               0xF004
#define ADSIGRP_SYM_VALBYHND                0xF005
#define ADSIGRP_SYM_RELEASEHND              0xF006
#define ADSIGRP_SYM_INFOBYNAME              0xF007
#define ADSIGRP_SYM_VERSION                 0xF008
#define ADSIGRP_SYM_INFOBYNAMEEX            0xF009

#define ADSIGRP_SYM_DOWNLOAD                0xF00A
#define ADSIGRP_SYM_UPLOAD                  0xF00B
#define ADSIGRP_SYM_UPLOADINFO              0xF00C
#define ADSIGRP_SYM_DOWNLOAD2               0xF00D
#define ADSIGRP_SYM_DT_UPLOAD               0xF00E
#define ADSIGRP_SYM_UPLOADINFO2             0xF00F

#define ADSIGRP_SYMNOTE                     0xF010      
#define ADSIGRP_SUMUP_READ                  0xF080

#define ADSIGRP_SUMUP_WRITE                 0xF081

#define ADSIGRP_SUMUP_READWRITE             0xF082

#define ADSIGRP_SUMUP_READEX                0xF083

#define ADSIGRP_SUMUP_READEX2               0xF084

#define ADSIGRP_SUMUP_ADDDEVNOTE            0xF085

#define ADSIGRP_SUMUP_DELDEVNOTE            0xF086

#define ADSIGRP_IOIMAGE_RWIB                0xF020      
#define ADSIGRP_IOIMAGE_RWIX                0xF021      
#define ADSIGRP_IOIMAGE_RISIZE              0xF025      
#define ADSIGRP_IOIMAGE_RWOB                0xF030      
#define ADSIGRP_IOIMAGE_RWOX                0xF031      
#define ADSIGRP_IOIMAGE_ROSIZE              0xF035      
#define ADSIGRP_IOIMAGE_CLEARI              0xF040      
#define ADSIGRP_IOIMAGE_CLEARO              0xF050      
#define ADSIGRP_IOIMAGE_RWIOB               0xF060      
#define ADSIGRP_DEVICE_DATA                 0xF100      
#define ADSIOFFS_DEVDATA_ADSSTATE           0x0000      
#define ADSIOFFS_DEVDATA_DEVSTATE           0x0002      
// Global Return codes
#define ERR_GLOBAL                          0x0000

#define GLOBALERR_TARGET_PORT               (0x06 + ERR_GLOBAL) 
#define GLOBALERR_MISSING_ROUTE             (0x07 + ERR_GLOBAL) 
#define GLOBALERR_NO_MEMORY                 (0x19 + ERR_GLOBAL) 
#define GLOBALERR_TCP_SEND                  (0x1A + ERR_GLOBAL) 
// Router Return codes
#define ERR_ROUTER                          0x0500

#define ROUTERERR_NOTREGISTERED             (0x07 + ERR_ROUTER) 
#define ROUTERERR_NOMOREQUEUES              (0x08 + ERR_ROUTER) 
// ADS Return codes
#define ADSERR_NOERR                        0x00
#define ERR_ADSERRS                         0x0700

#define ADSERR_DEVICE_ERROR                 (0x00 + ERR_ADSERRS) 
#define ADSERR_DEVICE_SRVNOTSUPP            (0x01 + ERR_ADSERRS) 
#define ADSERR_DEVICE_INVALIDGRP            (0x02 + ERR_ADSERRS) 
#define ADSERR_DEVICE_INVALIDOFFSET         (0x03 + ERR_ADSERRS) 
#define ADSERR_DEVICE_INVALIDACCESS         (0x04 + ERR_ADSERRS) 
#define ADSERR_DEVICE_INVALIDSIZE           (0x05 + ERR_ADSERRS) 
#define ADSERR_DEVICE_INVALIDDATA           (0x06 + ERR_ADSERRS) 
#define ADSERR_DEVICE_NOTREADY              (0x07 + ERR_ADSERRS) 
#define ADSERR_DEVICE_BUSY                  (0x08 + ERR_ADSERRS) 
#define ADSERR_DEVICE_INVALIDCONTEXT        (0x09 + ERR_ADSERRS) 
#define ADSERR_DEVICE_NOMEMORY              (0x0A + ERR_ADSERRS) 
#define ADSERR_DEVICE_INVALIDPARM           (0x0B + ERR_ADSERRS) 
#define ADSERR_DEVICE_NOTFOUND              (0x0C + ERR_ADSERRS) 
#define ADSERR_DEVICE_SYNTAX                (0x0D + ERR_ADSERRS) 
#define ADSERR_DEVICE_INCOMPATIBLE          (0x0E + ERR_ADSERRS) 
#define ADSERR_DEVICE_EXISTS                (0x0F + ERR_ADSERRS) 
#define ADSERR_DEVICE_SYMBOLNOTFOUND        (0x10 + ERR_ADSERRS) 
#define ADSERR_DEVICE_SYMBOLVERSIONINVALID  (0x11 + ERR_ADSERRS) 
#define ADSERR_DEVICE_INVALIDSTATE          (0x12 + ERR_ADSERRS) 
#define ADSERR_DEVICE_TRANSMODENOTSUPP      (0x13 + ERR_ADSERRS) 
#define ADSERR_DEVICE_NOTIFYHNDINVALID      (0x14 + ERR_ADSERRS) 
#define ADSERR_DEVICE_CLIENTUNKNOWN         (0x15 + ERR_ADSERRS) 
#define ADSERR_DEVICE_NOMOREHDLS            (0x16 + ERR_ADSERRS) 
#define ADSERR_DEVICE_INVALIDWATCHSIZE      (0x17 + ERR_ADSERRS) 
#define ADSERR_DEVICE_NOTINIT               (0x18 + ERR_ADSERRS) 
#define ADSERR_DEVICE_TIMEOUT               (0x19 + ERR_ADSERRS) 
#define ADSERR_DEVICE_NOINTERFACE           (0x1A + ERR_ADSERRS) 
#define ADSERR_DEVICE_INVALIDINTERFACE      (0x1B + ERR_ADSERRS) 
#define ADSERR_DEVICE_INVALIDCLSID          (0x1C + ERR_ADSERRS) 
#define ADSERR_DEVICE_INVALIDOBJID          (0x1D + ERR_ADSERRS) 
#define ADSERR_DEVICE_PENDING               (0x1E + ERR_ADSERRS) 
#define ADSERR_DEVICE_ABORTED               (0x1F + ERR_ADSERRS) 
#define ADSERR_DEVICE_WARNING               (0x20 + ERR_ADSERRS) 
#define ADSERR_DEVICE_INVALIDARRAYIDX       (0x21 + ERR_ADSERRS) 
#define ADSERR_DEVICE_SYMBOLNOTACTIVE       (0x22 + ERR_ADSERRS) 
#define ADSERR_DEVICE_ACCESSDENIED          (0x23 + ERR_ADSERRS) 
#define ADSERR_DEVICE_LICENSENOTFOUND       (0x24 + ERR_ADSERRS) 
#define ADSERR_DEVICE_LICENSEEXPIRED        (0x25 + ERR_ADSERRS) 
#define ADSERR_DEVICE_LICENSEEXCEEDED       (0x26 + ERR_ADSERRS) 
#define ADSERR_DEVICE_LICENSEINVALID        (0x27 + ERR_ADSERRS) 
#define ADSERR_DEVICE_LICENSESYSTEMID       (0x28 + ERR_ADSERRS) 
#define ADSERR_DEVICE_LICENSENOTIMELIMIT    (0x29 + ERR_ADSERRS) 
#define ADSERR_DEVICE_LICENSEFUTUREISSUE    (0x2A + ERR_ADSERRS) 
#define ADSERR_DEVICE_LICENSETIMETOLONG     (0x2B + ERR_ADSERRS) 
#define ADSERR_DEVICE_EXCEPTION             (0x2C + ERR_ADSERRS) 
#define ADSERR_DEVICE_LICENSEDUPLICATED     (0x2D + ERR_ADSERRS) 
#define ADSERR_DEVICE_SIGNATUREINVALID      (0x2E + ERR_ADSERRS) 
#define ADSERR_DEVICE_CERTIFICATEINVALID    (0x2F + ERR_ADSERRS) 
#define ADSERR_CLIENT_ERROR                 (0x40 + ERR_ADSERRS) 
#define ADSERR_CLIENT_INVALIDPARM           (0x41 + ERR_ADSERRS) 
#define ADSERR_CLIENT_LISTEMPTY             (0x42 + ERR_ADSERRS) 
#define ADSERR_CLIENT_VARUSED               (0x43 + ERR_ADSERRS) 
#define ADSERR_CLIENT_DUPLINVOKEID          (0x44 + ERR_ADSERRS) 
#define ADSERR_CLIENT_SYNCTIMEOUT           (0x45 + ERR_ADSERRS) 
#define ADSERR_CLIENT_W32ERROR              (0x46 + ERR_ADSERRS) 
#define ADSERR_CLIENT_TIMEOUTINVALID        (0x47 + ERR_ADSERRS) 
#define ADSERR_CLIENT_PORTNOTOPEN           (0x48 + ERR_ADSERRS) 
#define ADSERR_CLIENT_NOAMSADDR             (0x49 + ERR_ADSERRS) 
#define ADSERR_CLIENT_SYNCINTERNAL          (0x50 + ERR_ADSERRS) 
#define ADSERR_CLIENT_ADDHASH               (0x51 + ERR_ADSERRS) 
#define ADSERR_CLIENT_REMOVEHASH            (0x52 + ERR_ADSERRS) 
#define ADSERR_CLIENT_NOMORESYM             (0x53 + ERR_ADSERRS) 
#define ADSERR_CLIENT_SYNCRESINVALID        (0x54 + ERR_ADSERRS) 
#define ADSERR_CLIENT_SYNCPORTLOCKED        (0x55 + ERR_ADSERRS) 
#pragma pack( push, 1)

struct AmsNetId {
    uint8_t b[6];

#ifdef __cplusplus
    AmsNetId(uint32_t ipv4Addr = 0);
    AmsNetId(const std::string& addr);
    AmsNetId(uint8_t, uint8_t, uint8_t, uint8_t, uint8_t, uint8_t);
    bool operator<(const AmsNetId& rhs) const;
    operator bool() const;
#endif
};

struct AmsAddr {
    AmsNetId netId;

    uint16_t port;
};

#ifdef __cplusplus
bool operator<(const AmsAddr& lhs, const AmsAddr& rhs);
std::ostream& operator<<(std::ostream& os, const AmsNetId& netId);
#endif /* #ifdef __cplusplus */

struct AdsVersion {
    uint8_t version;

    uint8_t revision;

    uint16_t build;
};

enum ADSTRANSMODE {
    ADSTRANS_NOTRANS = 0,
    ADSTRANS_CLIENTCYCLE = 1,
    ADSTRANS_CLIENTONCHA = 2,
    ADSTRANS_SERVERCYCLE = 3,
    ADSTRANS_SERVERONCHA = 4,
    ADSTRANS_SERVERCYCLE2 = 5,
    ADSTRANS_SERVERONCHA2 = 6,
    ADSTRANS_CLIENT1REQ = 10,
    ADSTRANS_MAXMODES
};

enum ADSSTATE {
    ADSSTATE_INVALID = 0,
    ADSSTATE_IDLE = 1,
    ADSSTATE_RESET = 2,
    ADSSTATE_INIT = 3,
    ADSSTATE_START = 4,
    ADSSTATE_RUN = 5,
    ADSSTATE_STOP = 6,
    ADSSTATE_SAVECFG = 7,
    ADSSTATE_LOADCFG = 8,
    ADSSTATE_POWERFAILURE = 9,
    ADSSTATE_POWERGOOD = 10,
    ADSSTATE_ERROR = 11,
    ADSSTATE_SHUTDOWN = 12,
    ADSSTATE_SUSPEND = 13,
    ADSSTATE_RESUME = 14,
    ADSSTATE_CONFIG = 15,
    ADSSTATE_RECONFIG = 16,
    ADSSTATE_STOPPING = 17,
    ADSSTATE_INCOMPATIBLE = 18,
    ADSSTATE_EXCEPTION = 19,
    ADSSTATE_MAXSTATES
};

struct AdsNotificationAttrib {
    uint32_t cbLength;

    uint32_t nTransMode;

    uint32_t nMaxDelay;

    union {
        uint32_t nCycleTime;
        uint32_t dwChangeFilter;
    };
};

struct AdsNotificationHeader {
    uint64_t nTimeStamp;

    uint32_t hNotification;

    uint32_t cbSampleSize;
};

typedef void (* PAdsNotificationFuncEx)(const AmsAddr* pAddr, const AdsNotificationHeader* pNotification,
                                        uint32_t hUser);

#pragma pack( pop )
#endif  // __ADSDEF_H__