iec61850_common.h

Go to the documentation of this file.

/*
 *  iec61850_common.h
 *
 *  Copyright 2013 Michael Zillgith
 *
 *  This file is part of libIEC61850.
 *
 *  libIEC61850 is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  libIEC61850 is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with libIEC61850.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  See COPYING file for the complete license text.
 */

#ifndef IEC61850_COMMON_H_
#define IEC61850_COMMON_H_

#ifdef __cplusplus
extern "C" {
#endif


#include "libiec61850_common_api.h"
#include "logging_api.h"

typedef struct {
    uint8_t vlanPriority;
    uint16_t vlanId;
    uint16_t appId;
    uint8_t dstAddress[6];
} PhyComAddress;

#define TRG_OPT_DATA_CHANGED 1

#define TRG_OPT_QUALITY_CHANGED 2

#define TRG_OPT_DATA_UPDATE 4

#define TRG_OPT_INTEGRITY 8

#define TRG_OPT_GI 16

#define RPT_OPT_SEQ_NUM 1

#define RPT_OPT_TIME_STAMP 2

#define RPT_OPT_REASON_FOR_INCLUSION 4

#define RPT_OPT_DATA_SET 8

#define RPT_OPT_DATA_REFERENCE 16

#define RPT_OPT_BUFFER_OVERFLOW 32

#define RPT_OPT_ENTRY_ID 64

#define RPT_OPT_CONF_REV 128

#define CONTROL_ORCAT_NOT_SUPPORTED 0

#define CONTROL_ORCAT_BAY_CONTROL 1

#define CONTROL_ORCAT_STATION_CONTROL 2

#define CONTROL_ORCAT_REMOTE_CONTROL 3

#define CONTROL_ORCAT_AUTOMATIC_BAY 4

#define CONTROL_ORCAT_AUTOMATIC_STATION 5

#define CONTROL_ORCAT_AUTOMATIC_REMOTE 6

#define CONTROL_ORCAT_MAINTENANCE 7

#define CONTROL_ORCAT_PROCESS 8

typedef enum {
    ADD_CAUSE_UNKNOWN = 0,
    ADD_CAUSE_NOT_SUPPORTED = 1,
    ADD_CAUSE_BLOCKED_BY_SWITCHING_HIERARCHY = 2,
    ADD_CAUSE_SELECT_FAILED = 3,
    ADD_CAUSE_INVALID_POSITION = 4,
    ADD_CAUSE_POSITION_REACHED = 5,
    ADD_CAUSE_PARAMETER_CHANGE_IN_EXECUTION = 6,
    ADD_CAUSE_STEP_LIMIT = 7,
    ADD_CAUSE_BLOCKED_BY_MODE = 8,
    ADD_CAUSE_BLOCKED_BY_PROCESS = 9,
    ADD_CAUSE_BLOCKED_BY_INTERLOCKING = 10,
    ADD_CAUSE_BLOCKED_BY_SYNCHROCHECK = 11,
    ADD_CAUSE_COMMAND_ALREADY_IN_EXECUTION = 12,
    ADD_CAUSE_BLOCKED_BY_HEALTH = 13,
    ADD_CAUSE_1_OF_N_CONTROL = 14,
    ADD_CAUSE_ABORTION_BY_CANCEL = 15,
    ADD_CAUSE_TIME_LIMIT_OVER = 16,
    ADD_CAUSE_ABORTION_BY_TRIP = 17,
    ADD_CAUSE_OBJECT_NOT_SELECTED = 18,
    ADD_CAUSE_OBJECT_ALREADY_SELECTED = 19,
    ADD_CAUSE_NO_ACCESS_AUTHORITY = 20,
    ADD_CAUSE_ENDED_WITH_OVERSHOOT = 21,
    ADD_CAUSE_ABORTION_DUE_TO_DEVIATION = 22,
    ADD_CAUSE_ABORTION_BY_COMMUNICATION_LOSS = 23,
    ADD_CAUSE_ABORTION_BY_COMMAND = 24,
    ADD_CAUSE_NONE = 25,
    ADD_CAUSE_INCONSISTENT_PARAMETERS = 26,
    ADD_CAUSE_LOCKED_BY_OTHER_CLIENT = 27
} ControlAddCause;

#if (CONFIG_PROVIDE_OLD_FC_DEFINES == 1)
#define ST IEC61850_FC_ST
#define MX IEC61850_FC_MX
#define SP IEC61850_FC_SP
#define SV IEC61850_FC_SV
#define CF IEC61850_FC_CF
#define DC IEC61850_FC_DC
#define SG IEC61850_FC_SG
#define SE IEC61850_FC_SE
#define SR IEC61850_FC_SR
#define OR IEC61850_FC_OR
#define BL IEC61850_FC_BL
#define EX IEC61850_FC_EX
#define CO IEC61850_FC_CO
#define ALL IEC61850_FC_ALL
#define NONE IEC61850_FC_NONE
#endif /* (CONFIG_PROVIDE_OLD_FC_DEFINES == 1) */


typedef enum eFunctionalConstraint {
    IEC61850_FC_ST = 0,
    IEC61850_FC_MX = 1,
    IEC61850_FC_SP = 2,
    IEC61850_FC_SV = 3,
    IEC61850_FC_CF = 4,
    IEC61850_FC_DC = 5,
    IEC61850_FC_SG = 6,
    IEC61850_FC_SE = 7,
    IEC61850_FC_SR = 8,
    IEC61850_FC_OR = 9,
    IEC61850_FC_BL = 10,
    IEC61850_FC_EX = 11,
    IEC61850_FC_CO = 12,
    IEC61850_FC_US = 13,
    IEC61850_FC_MS = 14,
    IEC61850_FC_RP = 15,
    IEC61850_FC_BR = 16,
    IEC61850_FC_LG = 17,

    IEC61850_FC_ALL = 99,
    IEC61850_FC_NONE = -1
} FunctionalConstraint;

char*
FunctionalConstraint_toString(FunctionalConstraint fc);

FunctionalConstraint
FunctionalConstraint_fromString(const char* fcString);

typedef uint16_t Quality;
typedef uint16_t Validity;

#define QUALITY_VALIDITY_GOOD 0
#define QUALITY_VALIDITY_INVALID 2
#define QUALITY_VALIDITY_RESERVED 1
#define QUALITY_VALIDITY_QUESTIONABLE 3

#define QUALITY_DETAIL_OVERFLOW 4
#define QUALITY_DETAIL_OUT_OF_RANGE 8
#define QUALITY_DETAIL_BAD_REFERENCE 16
#define QUALITY_DETAIL_OSCILLATORY 32
#define QUALITY_DETAIL_FAILURE 64
#define QUALITY_DETAIL_OLD_DATA 128
#define QUALITY_DETAIL_INCONSISTENT 256
#define QUALITY_DETAIL_INACCURATE 512

#define QUALITY_SOURCE_SUBSTITUTED 1024

#define QUALITY_TEST 2048

#define QUALITY_OPERATOR_BLOCKED  4096

Validity
Quality_getValidity(Quality* self);

void
Quality_setValidity(Quality* self, Validity validity);

void
Quality_setFlag(Quality* self, int flag);

void
Quality_unsetFlag(Quality* self, int flag);

bool
Quality_isFlagSet(Quality* self, int flag);

Quality
Quality_fromMmsValue(const MmsValue* mmsValue);

typedef enum {
    DBPOS_INTERMEDIATE_STATE = 0,
    DBPOS_OFF = 1,
    DBPOS_ON = 2,
    DBPOS_BAD_STATE = 3
} Dbpos;


Dbpos
Dbpos_fromMmsValue(const MmsValue* mmsValue);

MmsValue*
Dbpos_toMmsValue(MmsValue* mmsValue, Dbpos dbpos);

typedef union {
    uint8_t val[8];
} Timestamp;

Timestamp*
Timestamp_create(void);

Timestamp*
Timestamp_createFromByteArray(uint8_t* byteArray);

void
Timestamp_destroy(Timestamp* self);

void
Timestamp_clearFlags(Timestamp* self);

uint32_t
Timestamp_getTimeInSeconds(Timestamp* self);

uint64_t
Timestamp_getTimeInMs(Timestamp* self);

bool
Timestamp_isLeapSecondKnown(Timestamp* self);

void
Timestamp_setLeapSecondKnown(Timestamp* self, bool value);

bool
Timestamp_hasClockFailure(Timestamp* self);

void
Timestamp_setClockFailure(Timestamp* self, bool value);

bool
Timestamp_isClockNotSynchronized(Timestamp* self);

void
Timestamp_setClockNotSynchronized(Timestamp* self, bool value);

int
Timestamp_getSubsecondPrecision(Timestamp* self);

void
Timestamp_setSubsecondPrecision(Timestamp* self, int subsecondPrecision);

void
Timestamp_setTimeInSeconds(Timestamp* self, uint32_t secondsSinceEpoch);

void
Timestamp_setTimeInMilliseconds(Timestamp* self, uint64_t millisSinceEpoch);

void
Timestamp_setByMmsUtcTime(Timestamp* self, MmsValue* mmsValue);

MmsValue*
Timestamp_toMmsValue(Timestamp* self, MmsValue* mmsValue);

char*
LibIEC61850_getVersionString(void);


#ifdef __cplusplus
}
#endif

#endif /* IEC61850_COMMON_H_ */