cipepath.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 2016, Rockwell Automation, Inc.
 * All rights reserved.
 *
 ******************************************************************************/

#ifndef SRC_CIP_CIPEPATH_H_
#define SRC_CIP_CIPEPATH_H_

#include <stdbool.h>

#include "ciptypes.h"
#include "cipelectronickey.h"

#define SEGMENT_TYPE_PORT_SEGMENT 0x00 
#define SEGMENT_TYPE_LOGICAL_SEGMENT 0x20 
#define SEGMENT_TYPE_NETWORK_SEGMENT 0x40 
#define SEGMENT_TYPE_SYMBOLIC_SEGMENT 0x60 
#define SEGMENT_TYPE_DATA_SEGMENT 0x80 
#define SEGMENT_TYPE_DATA_TYPE_CONSTRUCTED 0xA0 
#define SEGMENT_TYPE_DATA_TYPE_ELEMENTARTY 0xC0 
#define SEGMENT_TYPE_SEGMENT_RESERVED 0xE0 
#define LOGICAL_SEGMENT_TYPE_CLASS_ID 0x00 
#define LOGICAL_SEGMENT_TYPE_INSTANCE_ID 0x04 
#define LOGICAL_SEGMENT_TYPE_MEMBER_ID 0x08 
#define LOGICAL_SEGMENT_TYPE_CONNECTION_POINT 0x0C 
#define LOGICAL_SEGMENT_TYPE_ATTRIBUTE_ID 0x10 
#define LOGICAL_SEGMENT_TYPE_SPECIAL 0x14 
#define LOGICAL_SEGMENT_TYPE_SERVICE_ID 0x18 
#define LOGICAL_SEGMENT_TYPE_EXTENDED_LOGICAL 0x1C 
#define LOGICAL_SEGMENT_FORMAT_EIGHT_BIT 0x00 
#define LOGICAL_SEGMENT_FORMAT_SIXTEEN_BIT 0x01 
#define LOGICAL_SEGMENT_FORMAT_THIRTY_TWO_BIT 0x02 
#define LOGICAL_SEGMENT_EXTENDED_TYPE_RESERVED 0x00 
#define LOGICAL_SEGMENT_EXTENDED_TYPE_ARRAY_INDEX 0x01 
#define LOGICAL_SEGMENT_EXTENDED_TYPE_INDIRECT_ARRAY_INDEX 0x02 
#define LOGICAL_SEGMENT_EXTENDED_TYPE_BIT_INDEX 0x03 
#define LOGICAL_SEGMENT_EXTENDED_TYPE_INDIRECT_BIT_INDEX 0x04 
#define LOGICAL_SEGMENT_EXTENDED_TYPE_STRUCTURE_MEMBER_NUMBER 0x05 
#define LOGICAL_SEGMENT_EXTENDED_TYPE_STRUCTURE_MEMBER_HANDLE 0x06 
#define LOGICAL_SEGMENT_SPECIAL_TYPE_FORMAT_ELECTRONIC_KEY 0x00 
#define NETWORK_SEGMENT_SUBTYPE_SCHEDULE 0x01 
#define NETWORK_SEGMENT_SUBTYPE_FIXED_TAG 0x02 
#define NETWORK_SEGMENT_SUBTYPE_PRODUCTION_INHIBIT_TIME_IN_MILLISECONDS 0x03 
#define NETWORK_SEGMENT_SUBTYPE_SAFETY 0x04 
#define NETWORK_SEGMENT_SUBTYPE_PRODUCTION_INHIBIT_TIME_IN_MICROSECONDS 0x10 
#define NETWORK_SEGMENT_SUBTYPE_EXTENDED_NETWORK 0x1F 
typedef enum segment_type {
  /* Segments */
  kSegmentTypePortSegment, 
  kSegmentTypeLogicalSegment, 
  kSegmentTypeNetworkSegment, 
  kSegmentTypeSymbolicSegment, 
  kSegmentTypeDataSegment, 
  kSegmentTypeDataTypeConstructed, 
  kSegmentTypeDataTypeElementary, 
  kSegmentTypeReserved 
} SegmentType;

typedef enum port_segment_type {
  kPortSegmentFlagExtendedLinkAddressSize = 0x10 
} PortSegmentFlag;

typedef enum logical_segment_type {
  kLogicalSegmentLogicalTypeClassId, 
  kLogicalSegmentLogicalTypeInstanceId, 
  kLogicalSegmentLogicalTypeMemberId, 
  kLogicalSegmentLogicalTypeConnectionPoint, 
  kLogicalSegmentLogicalTypeAttributeId, 
  kLogicalSegmentLogicalTypeSpecial, 
  kLogicalSegmentLogicalTypeServiceId, 
  kLogicalSegmentLogicalTypeExtendedLogical 
} LogicalSegmentLogicalType;

typedef enum logical_segment_extended_logical_type {
  kLogicalSegmentExtendedLogicalTypeReserved,
  kLogicalSegmentExtendedLogicalTypeArrayIndex,
  kLogicalSegmentExtendedLogicalTypeIndirectArrayIndex,
  kLogicalSegmentExtendedLogicalTypeBitIndex,
  kLogicalSegmentExtendedLogicalTypeIndirectBitIndex,
  kLogicalSegmentExtendedLogicalTypeStructureMemberNumber,
  kLogicalSegmentExtendedLogicalTypeStructureMemberHandle
} LogicalSegmentExtendedLogicalType;

typedef enum logical_segment_logical_format {
  kLogicalSegmentLogicalFormatEightBit,
  kLogicalSegmentLogicalFormatSixteenBit,
  kLogicalSegmentLogicalFormatThirtyTwoBit
} LogicalSegmentLogicalFormat;

typedef enum logical_segment_special_type_logical_format {
  kLogicalSegmentSpecialTypeLogicalFormatReserved,
  kLogicalSegmentSpecialTypeLogicalFormatElectronicKey
} LogicalSegmentSpecialTypeLogicalFormat;

typedef enum electronic_key_segment_format {
  kElectronicKeySegmentFormatReserved, 
  kElectronicKeySegmentFormatKeyFormat4 
} ElectronicKeySegmentFormat;

typedef enum network_segment_subtype {
  kNetworkSegmentSubtypeReserved, 
  kNetworkSegmentSubtypeScheduleSegment, 
  kNetworkSegmentSubtypeFixedTagSegment, 
  kNetworkSegmentSubtypeProductionInhibitTimeInMilliseconds, 
  kNetworkSegmentSubtypeSafetySegment, 
  kNetworkSegmentSubtypeProductionInhibitTimeInMicroseconds, 
  kNetworkSegmentSubtypeExtendedNetworkSegment 
} NetworkSegmentSubtype;

typedef enum data_segment_subtype {
  kDataSegmentSubtypeReserved, 
  kDataSegmentSubtypeSimpleData, 
  kDataSegmentSubtypeANSIExtendedSymbol 
} DataSegmentSubtype;

typedef enum symbolic_segment_format {
  kSymbolicSegmentFormatASCII, 
  kSymbolicSegmentFormatExtendedString 
} SymbolicSegmentFormat;

typedef enum symbolic_segment_extended_format {
  kSymbolicSegmentExtendedFormatDoubleByteChars, 
  kSymbolicSegmentExtendedFormatTripleByteChars, 
  kSymbolicSegmentExtendedFormatNumericSymbolUSINT, 
  kSymbolicSegmentExtendedFormatNumericSymbolUINT, 
  kSymbolicSegmentExtendedFormatNumericSymbolUDINT, 
  kSymbolicSegmentExtendedFormatReserved 
} SymbolicSegmentExtendedFormat;

/* Start - Often used types of EPaths */
typedef struct connection_path_epath {
  CipDword class_id;
  CipDword instance_id;
  CipDword attribute_id_or_connection_point;
} CipConnectionPathEpath;
/* End - Often used types of EPaths */

SegmentType GetPathSegmentType(const CipOctet *const cip_path);

void SetPathSegmentType(SegmentType segment_type,
                        unsigned char *const cip_path);

/*********************************************************
* Port Segment functions
*********************************************************/

bool GetPathPortSegmentExtendedLinkAddressSizeBit(
  const unsigned char *const cip_path);

unsigned int GetPathPortSegmentPortIdentifier(
  const unsigned char *const cip_path);

void SetPathPortSegmentPortIdentifier(const unsigned int port_identifier,
                                      unsigned char *const cip_path);

unsigned int GetPathPortSegmentLinkAddressSize(
  const unsigned char *const cip_path);

unsigned int GetPathPortSegmentExtendedPortNumber(
  const unsigned char *const cip_path);

void SetPathPortSegmentExtendedPortIdentifier(
  const unsigned int extended_port_identifier,
  CipOctet *const cip_path);

LogicalSegmentLogicalType GetPathLogicalSegmentLogicalType(
  const unsigned char *const cip_path);

void SetPathLogicalSegmentLogicalType(LogicalSegmentLogicalType logical_type,
                                      CipOctet *const cip_path);

LogicalSegmentLogicalFormat GetPathLogicalSegmentLogicalFormat(
  const unsigned char *const cip_path);

void SetPathLogicalSegmentLogicalFormat(LogicalSegmentLogicalFormat format,
                                        CipOctet *const cip_path);

const CipDword CipEpathGetLogicalValue(const EipUint8 **message);

size_t CipEpathSetLogicalValue(const CipDword logical_value,
                               const LogicalSegmentLogicalFormat logical_format,
                               CipOctet **message);

LogicalSegmentExtendedLogicalType GetPathLogicalSegmentExtendedLogicalType(
  const unsigned char *const cip_path);

LogicalSegmentSpecialTypeLogicalFormat
GetPathLogicalSegmentSpecialTypeLogicalType(
  const unsigned char *const cip_path);

ElectronicKeySegmentFormat GetPathLogicalSegmentElectronicKeyFormat(
  const unsigned char *const cip_path);

void GetElectronicKeyFormat4FromMessage(
  const CipOctet **const cip_path,
  ElectronicKeyFormat4 *key);

NetworkSegmentSubtype GetPathNetworkSegmentSubtype(
  const unsigned char *const cip_path);

CipUsint GetPathNetworkSegmentProductionInhibitTimeInMilliseconds(
  const unsigned char *const cip_path);

CipUdint GetPathNetworkSegmentProductionInhibitTimeInMicroseconds(
  const unsigned char *const cip_path);

DataSegmentSubtype GetPathDataSegmentSubtype(
  const unsigned char *const cip_path);

CipUsint GetPathDataSegmentSimpleDataWordLength(
  const unsigned char *const cip_path);

SymbolicSegmentFormat GetPathSymbolicSegmentFormat(
  const unsigned char *const cip_path);

SymbolicSegmentExtendedFormat GetPathSymbolicSegmentNumericType(
  const unsigned char *const cip_path);

SymbolicSegmentExtendedFormat GetPathSymbolicSegmentExtendedFormat(
  const unsigned char *const cip_path);

/* Special purpose encoding and decoding functions */

size_t CipEpathEncodeConnectionEpath(
  const CipConnectionPathEpath *const connection_epath,
  CipOctet **encoded_path);

bool CipEpathEqual(const CipOctet *const path1,
                   const CipUint path1_length,
                   const CipOctet *const path2,
                   const CipUint path2_length);

#endif /* SRC_CIP_CIPEPATH_H_ */