indices.h

Go to the documentation of this file.

 
 
#pragma once
 
#include <cstdint>
#include <iostream>
#include <magic_enum.hpp>
#include <string>
#include <utility>
#include <vector>
namespace profinet
{
 
// =============================================================================
// Block Types (from Wireshark pn_io_block_type dissector)
// =============================================================================
 
enum class ControlCommand : std::uint16_t
{
  PrmEnd = 0x0001,
 
  ApplicationReady = 0x0002,
 
  Release = 0x0004,
 
  Done = 0x0008,
 
  ReadyForCompanion = 0x0010,
 
  ReadyForRtClass3 = 0x0020,
 
  PrmBegin = 0x0040
};
 
enum class BlockType : std::uint16_t
{
  // Diagnosis blocks
 
  DiagnosisData = 0x0010,
 
  ExpectedIdentificationData = 0x0012,
 
  RealIdentificationData = 0x0013,
 
  // I&M blocks
 
  IdentificationMaintenance0 = 0x0020,
 
  IdentificationMaintenance1 = 0x0021,
 
  IdentificationMaintenance2 = 0x0022,
 
  IdentificationMaintenance3 = 0x0023,
 
  IdentificationMaintenance4 = 0x0024,
 
  IdentificationMaintenance5 = 0x0025,
 
  IdentificationMaintenance6 = 0x0026,
 
  IdentificationMaintenance7 = 0x0027,
 
  IdentificationMaintenance8 = 0x0028,
 
  IdentificationMaintenance9 = 0x0029,
 
  IdentificationMaintenance10 = 0x002A,
 
  IdentificationMaintenance11 = 0x002B,
 
  IdentificationMaintenance12 = 0x002C,
 
  IdentificationMaintenance13 = 0x002D,
 
  IdentificationMaintenance14 = 0x002E,
 
  IdentificationMaintenance15 = 0x002F,
 
  // Alarm blocks
 
  AlarmNotificationHigh = 0x0001,
 
  AlarmAcknowledgementHigh = 0x8001,
 
  AlarmNotificationLow = 0x0002,
 
  AlarmAcknowledgementLow = 0x8002,
 
  // IOD Read/Write blocks
 
  IoDataWriteRequest = 0x0008,
 
  IoDataWriteResponse = 0x8008,
 
  IoDataReadRequest = 0x0009,
 
  IoDataReadResponse = 0x8009,
 
  // AR data blocks
 
  ApplicationRelationData = 0x0018,
 
  LogData = 0x0019,
 
  ApiData = 0x001A,
 
  SrlData = 0x001B,
 
  // AR/IOCR/AlarmCR connection blocks
 
  ApplicationRelationRequest = 0x0101,
 
  ApplicationRelationResponse = 0x8101,
 
  IoCrRequest = 0x0102,
 
  IoCrResponse = 0x8102,
 
  AlarmCrRequest = 0x0103,
 
  AlarmCrResponse = 0x8103,
 
  ExpectedSubmoduleRequest = 0x0104,
 
  ModuleDifference = 0x8104,
 
  // Control operation blocks
 
  ControlPrmEndRequest = 0x0110,
 
  ControlPrmEndResponse = 0x8110,
 
  ControlApplicationReadyRequest = 0x0112,
 
  ControlApplicationReadyResponse = 0x8112,
 
  ReleaseRequest = 0x0114,
 
  ReleaseResponse = 0x8114,
 
  ControlRtClass3Request = 0x0117,
 
  ControlRtClass3Response = 0x8117,
 
  ParameterizationBeginRequest = 0x0118,
 
  ParameterizationBeginResponse = 0x8118,
 
  SubmoduleList = 0x0119,
 
  // Port and interface data blocks
 
  PortDataCheck = 0x0200,
 
  PortDataAdjust = 0x0202,
 
  PortDataReal = 0x020F,
 
  InterfaceMrpDataAdjust = 0x0211,
 
  InterfaceMrpDataReal = 0x0212,
 
  PortMrpDataReal = 0x0215,
 
  MrpRingStateData = 0x0219,
 
  PortFoDataReal = 0x0220,
 
  PortFoDataCheck = 0x0221,
 
  PortFoDataAdjust = 0x0222,
 
  PortDataRealExtended = 0x022C,
 
  PortDataInterfaceDataReal = 0x0240,
 
  PortStatistics = 0x0251,
 
  // Container blocks
 
  MultipleHeader = 0x0400,
 
  ContainerContent = 0x0401,
 
  // Device-level blocks (0xF8xx)
 
  ApplicationRelationServer = 0xF820,
 
  RealProcessData = 0xF841,
 
  ExpectedProcessData = 0xF842,
 
  // API-level blocks (0xF0xx)
 
  RealIdentificationDataApi = 0xF000
};
 
[[nodiscard]] constexpr bool operator==(BlockType lhs, std::uint16_t rhs) noexcept
{
  return static_cast<std::uint16_t>(lhs) == rhs;
}
 
[[nodiscard]] constexpr bool operator==(std::uint16_t lhs, BlockType rhs) noexcept
{
  return lhs == static_cast<std::uint16_t>(rhs);
}
 
[[nodiscard]] constexpr bool operator!=(BlockType lhs, std::uint16_t rhs) noexcept
{
  return !(lhs == rhs);
}
 
[[nodiscard]] constexpr bool operator!=(std::uint16_t lhs, BlockType rhs) noexcept
{
  return !(lhs == rhs);
}
 
inline std::ostream& operator<<(std::ostream& os, BlockType type)
{
  // Prints hex format like 0x0010
  return os << "0x" << std::hex << static_cast<std::uint16_t>(type);
}
 
std::string GetBlockTypeName(BlockType blockType);
 
// =============================================================================
// Alarm Types (used in AlarmNotification blocks)
// =============================================================================
 
enum class AlarmType : std::uint16_t
{
  Diagnosis = 0x0001,
 
  Process = 0x0002,
 
  Pull = 0x0003,
 
  Plug = 0x0004,
 
  Status = 0x0005,
 
  Update = 0x0006,
 
  Redundancy = 0x0007,
 
  ControlledBySupervisor = 0x0008,
 
  Released = 0x0009,
 
  PlugWrongSubmodule = 0x000A,
 
  ReturnOfSubmodule = 0x000B,
 
  DiagnosisDisappears = 0x000C,
 
  MulticastMismatch = 0x000D,
 
  PortDataChange = 0x000E,
 
  SyncDataChanged = 0x000F,
 
  IsochronousModeProblem = 0x0010,
 
  NetworkComponentProblem = 0x0011,
 
  TimeDataChanged = 0x0012,
 
  DfpProblem = 0x0013,
 
  UploadRetrieval = 0x001E,
 
  PullModule = 0x001F
};
 
std::string GetAlarmTypeName(AlarmType alarmType);
 
// =============================================================================
// IOCR / AlarmCR / AR type constants
// =============================================================================
 
enum class IocrType : std::uint16_t
{
  Input = 0x0001,
 
  Output = 0x0002,
 
  MulticastProvider = 0x0003,
 
  MulticastConsumer = 0x0004
};
 
std::string GetIocrTypeName(IocrType iocrType);
 
enum class IocrRtClass : std::uint8_t
{
  Udp = 0x04
};
 
std::string GetIocrRtClassName(IocrRtClass rtClass);
 
// NOLINTBEGIN(readability-identifier-naming)
// inline constexpr std::uint16_t ALARM_CR_TYPE_ALARM = 0x0001;
 
inline constexpr std::uint8_t ALARM_TRANSPORT_RTA_CLASS_UDP = 0x01;
 
inline constexpr std::uint16_t AR_TYPE_IOCAR_SINGLE = 0x0001;
inline constexpr std::uint16_t AR_TYPE_IOSAR = 0x0006;
inline constexpr std::uint16_t AR_TYPE_IOCARSR = 0x0020;
// NOLINTEND(readability-identifier-naming)
//
// =============================================================================
// USI (User Structure Identifier) constants
// =============================================================================
enum class Usi : std::uint16_t
{
  NoIdentifier = 0x0000,
 
  ChannelDiagnosis = 0x8000,
 
  MultipleDiagnosis = 0x8001,
 
  ExtendedChannelDiagnosis = 0x8002,
 
  QualifiedChannelDiagnosis = 0x8003,
 
  Maintenance = 0x8100,
 
  Upload = 0x8200,
 
  IParameter = 0x8201,
 
  RsAlarmLow = 0x8300,
 
  RsAlarmHigh = 0x8301,
 
  RsAlarmSubmodule = 0x8302,
 
  PeAlarm = 0x8310,
 
  PralAlarm = 0x8320,
 
  Bit0till14OfChannelNumber = 0x7FFF,
 
  Bit15OfChannelNumber = 0x8000,
 
  Bit15AndExternalChannelDiagnosisOfChannelNumber = 0x8002,
 
  Bit15AndQualifiedChannelDiagnosisOfChannelNumber = 0x8003,
 
  Low11BitsOfRsAlarmInfo = 0x7FFF
};
[[nodiscard]] constexpr bool operator==(Usi lhs, std::uint16_t rhs) noexcept
{
  return static_cast<std::uint16_t>(lhs) == rhs;
}
 
[[nodiscard]] constexpr bool operator==(std::uint16_t lhs, Usi rhs) noexcept
{
  return lhs == static_cast<std::uint16_t>(rhs);
}
 
[[nodiscard]] constexpr bool operator!=(Usi lhs, std::uint16_t rhs) noexcept
{
  return !(lhs == rhs);
}
 
[[nodiscard]] constexpr bool operator!=(std::uint16_t lhs, Usi rhs) noexcept
{
  return !(lhs == rhs);
}
 
inline std::ostream& operator<<(std::ostream& os, Usi value)
{
  return os << "0x" << std::hex << static_cast<std::uint16_t>(value);
}
 
std::string GetUsiName(Usi usi);
 
// =============================================================================
// Module / Submodule state constants
// =============================================================================
 
// NOLINTBEGIN(readability-identifier-naming)
inline constexpr std::uint16_t MODULE_STATE_NO_MODULE = 0x0000;
inline constexpr std::uint16_t MODULE_STATE_WRONG_MODULE = 0x0001;
inline constexpr std::uint16_t MODULE_STATE_PROPER_MODULE = 0x0002;
inline constexpr std::uint16_t MODULE_STATE_SUBSTITUTE_MODULE = 0x0003;
 
inline constexpr std::uint16_t SUBMODULE_STATE_NO_SUBMODULE = 0x0000;
inline constexpr std::uint16_t SUBMODULE_STATE_WRONG_SUBMODULE = 0x0001;
inline constexpr std::uint16_t SUBMODULE_STATE_LOCKED_BY_SUPERVISOR = 0x0002;
inline constexpr std::uint16_t SUBMODULE_STATE_APPLICATION_READY_PENDING = 0x0004;
inline constexpr std::uint16_t SUBMODULE_STATE_OK = 0x0007;
// NOLINTEND(readability-identifier-naming)
 
std::string GetModuleStateName(std::uint16_t state);
 
std::string GetSubmoduleStateName(std::uint16_t state);
 
// =============================================================================
// PROFIenergy operational mode constants
// =============================================================================
 
// NOLINTBEGIN(readability-identifier-naming)
inline constexpr std::uint8_t PE_MODE_POWER_OFF = 0x00;
inline constexpr std::uint8_t PE_MODE_ENERGY_SAVING_MIN = 0x01;
inline constexpr std::uint8_t PE_MODE_ENERGY_SAVING_MAX = 0x1F;
inline constexpr std::uint8_t PE_MODE_OPERATE = 0xF0;
inline constexpr std::uint8_t PE_MODE_SLEEP_MODE_WOL = 0xFE;
inline constexpr std::uint8_t PE_MODE_READY_TO_OPERATE = 0xFF;
// NOLINTEND(readability-identifier-naming)
 
std::string GetPeModeName(std::uint8_t mode);
 
// =============================================================================
// I&M (Identification & Maintenance) Indices - 0xAFFx
// =============================================================================
 
// NOLINTBEGIN(readability-identifier-naming)
inline constexpr std::uint16_t IM0 = 0xAFF0;
inline constexpr std::uint16_t IM1 = 0xAFF1;
inline constexpr std::uint16_t IM2 = 0xAFF2;
inline constexpr std::uint16_t IM3 = 0xAFF3;
inline constexpr std::uint16_t IM4 = 0xAFF4;
inline constexpr std::uint16_t IM5 = 0xAFF5;
inline constexpr std::uint16_t IM6 = 0xAFF6;
inline constexpr std::uint16_t IM7 = 0xAFF7;
inline constexpr std::uint16_t IM8 = 0xAFF8;
inline constexpr std::uint16_t IM9 = 0xAFF9;
inline constexpr std::uint16_t IM10 = 0xAFFA;
inline constexpr std::uint16_t IM11 = 0xAFFB;
inline constexpr std::uint16_t IM12 = 0xAFFC;
inline constexpr std::uint16_t IM13 = 0xAFFD;
inline constexpr std::uint16_t IM14 = 0xAFFE;
inline constexpr std::uint16_t IM15 = 0xAFFF;
inline constexpr std::uint16_t IM0_FILTER_DATA = 0xF840;
// NOLINTEND(readability-identifier-naming)
 
// =============================================================================
// Diagnosis Indices - Pattern: 0x__0A/B/C
// =============================================================================
 
// NOLINTBEGIN(readability-identifier-naming)
inline constexpr std::uint16_t DIAG_CHANNEL_SUBSLOT = 0x800A;
inline constexpr std::uint16_t DIAG_ALL_SUBSLOT = 0x800B;
inline constexpr std::uint16_t DIAG_MAINTENANCE_SUBSLOT = 0x800C;
 
inline constexpr std::uint16_t DIAG_CHANNEL_SLOT = 0xC00A;
inline constexpr std::uint16_t DIAG_ALL_SLOT = 0xC00B;
inline constexpr std::uint16_t DIAG_MAINTENANCE_SLOT = 0xC00C;
 
inline constexpr std::uint16_t DIAG_CHANNEL_AR = 0xE00A;
inline constexpr std::uint16_t DIAG_ALL_AR = 0xE00B;
inline constexpr std::uint16_t DIAG_MAINTENANCE_AR = 0xE00C;
 
inline constexpr std::uint16_t DIAG_CHANNEL_API = 0xF00A;
inline constexpr std::uint16_t DIAG_ALL_API = 0xF00B;
inline constexpr std::uint16_t DIAG_MAINTENANCE_API = 0xF00C;
 
inline constexpr std::uint16_t DIAG_DEVICE = 0xF80C;
// NOLINTEND(readability-identifier-naming)
 
// =============================================================================
// Maintenance Indices - Pattern: 0x__10-13
// =============================================================================
 
// NOLINTBEGIN(readability-identifier-naming)
inline constexpr std::uint16_t MAINT_REQUIRED_CHANNEL_SUBSLOT = 0x8010;
inline constexpr std::uint16_t MAINT_DEMANDED_CHANNEL_SUBSLOT = 0x8011;
inline constexpr std::uint16_t MAINT_REQUIRED_ALL_SUBSLOT = 0x8012;
inline constexpr std::uint16_t MAINT_DEMANDED_ALL_SUBSLOT = 0x8013;
// NOLINTEND(readability-identifier-naming)
 
// =============================================================================
// Configuration/Identification Indices
// =============================================================================
 
// NOLINTBEGIN(readability-identifier-naming)
inline constexpr std::uint16_t EXPECTED_ID_SUBSLOT = 0x8000;
inline constexpr std::uint16_t REAL_ID_SUBSLOT = 0x8001;
 
inline constexpr std::uint16_t EXPECTED_ID_AR = 0xE000;
inline constexpr std::uint16_t REAL_ID_AR = 0xE001;
inline constexpr std::uint16_t MODULE_DIFF_BLOCK = 0xE002;
 
inline constexpr std::uint16_t REAL_ID_API = 0xF000;
 
inline constexpr std::uint16_t AR_DATA = 0xF820;
inline constexpr std::uint16_t API_DATA = 0xF821;
inline constexpr std::uint16_t PDEV_DATA = 0xF831;
inline constexpr std::uint16_t PD_REAL_DATA = 0xF841;
inline constexpr std::uint16_t PD_EXPECTED_DATA = 0xF842;
inline constexpr std::uint16_t AUTO_CONFIG = 0xF850;
inline constexpr std::uint16_t LOG_DATA = 0xF830;
// NOLINTEND(readability-identifier-naming)
 
// =============================================================================
// PDPort Indices (for port subslots 0x8001, 0x8002, etc.)
// =============================================================================
 
// NOLINTBEGIN(readability-identifier-naming)
inline constexpr std::uint16_t PD_PORT_DATA_REAL = 0x802A;
inline constexpr std::uint16_t PD_PORT_DATA_CHECK = 0x802B;
inline constexpr std::uint16_t PD_IR_DATA = 0x802C;
inline constexpr std::uint16_t PD_SYNC_DATA = 0x802D;
inline constexpr std::uint16_t PD_PORT_DATA_ADJUST = 0x802F;
inline constexpr std::uint16_t PD_PORT_STATISTIC = 0x8072;
// NOLINTEND(readability-identifier-naming)
 
// =============================================================================
// PDInterface Indices (for interface subslot 0x8000)
// =============================================================================
 
// NOLINTBEGIN(readability-identifier-naming)
inline constexpr std::uint16_t PD_NC_DATA_CHECK = 0x8070;
inline constexpr std::uint16_t PD_INTERFACE_ADJUST = 0x8071;
inline constexpr std::uint16_t PD_INTERFACE_DATA_REAL = 0x8080;
inline constexpr std::uint16_t PD_INTERFACE_FSU_ADJUST = 0x8090;
// NOLINTEND(readability-identifier-naming)
 
// =============================================================================
// Fiber Optic Indices
// =============================================================================
 
// NOLINTBEGIN(readability-identifier-naming)
inline constexpr std::uint16_t PD_PORT_FO_DATA_REAL = 0x8060;
inline constexpr std::uint16_t PD_PORT_FO_DATA_CHECK = 0x8061;
inline constexpr std::uint16_t PD_PORT_FO_DATA_ADJUST = 0x8062;
inline constexpr std::uint16_t PD_PORT_SFP_DATA_CHECK = 0x8063;
// NOLINTEND(readability-identifier-naming)
 
// =============================================================================
// MRP (Media Redundancy Protocol) Indices
// =============================================================================
 
// NOLINTBEGIN(readability-identifier-naming)
inline constexpr std::uint16_t PD_INTERFACE_MRP_DATA_REAL = 0x8050;
inline constexpr std::uint16_t PD_INTERFACE_MRP_DATA_CHECK = 0x8051;
inline constexpr std::uint16_t PD_INTERFACE_MRP_DATA_ADJUST = 0x8052;
 
inline constexpr std::uint16_t PD_PORT_MRP_DATA_ADJUST = 0x8053;
inline constexpr std::uint16_t PD_PORT_MRP_DATA_REAL = 0x8054;
inline constexpr std::uint16_t PD_PORT_MRP_IC_DATA_ADJUST = 0x8055;
inline constexpr std::uint16_t PD_PORT_MRP_IC_DATA_CHECK = 0x8056;
inline constexpr std::uint16_t PD_PORT_MRP_IC_DATA_REAL = 0x8057;
// NOLINTEND(readability-identifier-naming)
 
// =============================================================================
// Sync/PTCP Indices
// =============================================================================
 
// NOLINTBEGIN(readability-identifier-naming)
inline constexpr std::uint16_t PD_IR_SUBFRAME_DATA = 0x8020;
inline constexpr std::uint16_t ISOCHRONOUS_MODE_DATA = 0x8030;
inline constexpr std::uint16_t PD_TIME_DATA = 0x8031;
// NOLINTEND(readability-identifier-naming)
 
// =============================================================================
// I/O Data Indices
// =============================================================================
 
// NOLINTBEGIN(readability-identifier-naming)
inline constexpr std::uint16_t SUBSTITUTE_VALUES = 0x801E;
inline constexpr std::uint16_t RECORD_INPUT_DATA = 0x8028;
inline constexpr std::uint16_t RECORD_OUTPUT_DATA = 0x8029;
// NOLINTEND(readability-identifier-naming)
 
// =============================================================================
// Asset Management Indices
// =============================================================================
 
// NOLINTBEGIN(readability-identifier-naming)
inline constexpr std::uint16_t AM_DEVICE_ID = 0xF8E0;
inline constexpr std::uint16_t AM_FULL_INFO = 0xF8E1;
inline constexpr std::uint16_t AM_HW_ONLY = 0xF8E2;
inline constexpr std::uint16_t AM_FW_ONLY = 0xF8E3;
inline constexpr std::uint16_t AM_LOCATION_SLOT = 0xFBE0;
inline constexpr std::uint16_t AM_LOCATION_TREE = 0xFBE1;
inline constexpr std::uint16_t AM_DATA = 0xFBF0;
// NOLINTEND(readability-identifier-naming)
 
// =============================================================================
// PROFIsafe Indices
// =============================================================================
 
// NOLINTBEGIN(readability-identifier-naming)
inline constexpr std::uint16_t F_PARAMETER_BLOCK = 0x0100;
inline constexpr std::uint16_t F_PRM_FLAG1 = 0x0101;
inline constexpr std::uint16_t F_PRM_FLAG2 = 0x0102;
inline constexpr std::uint16_t F_PARAMETER_WRITE = 0xE000;
inline constexpr std::uint16_t F_PARAMETER_READ = 0xE001;
// NOLINTEND(readability-identifier-naming)
 
// =============================================================================
// PROFIenergy Index
// =============================================================================
 
// NOLINTBEGIN(readability-identifier-naming)
inline constexpr std::uint16_t PROFIENERGY = 0x80A0;
// NOLINTEND(readability-identifier-naming)
 
// =============================================================================
// AR-specific Indices
// =============================================================================
 
// NOLINTBEGIN(readability-identifier-naming)
inline constexpr std::uint16_t WRITE_MULTIPLE = 0xE040;
inline constexpr std::uint16_t AR_FSU_DATA_ADJUST = 0xE050;
// NOLINTEND(readability-identifier-naming)
 
// =============================================================================
// Standard DAP Subslots
// =============================================================================
 
// NOLINTBEGIN(readability-identifier-naming)
inline constexpr std::uint16_t SUBSLOT_DAP = 0x0001;
inline constexpr std::uint16_t SUBSLOT_INTERFACE = 0x8000;
inline constexpr std::uint16_t SUBSLOT_PORT1 = 0x8001;
inline constexpr std::uint16_t SUBSLOT_PORT2 = 0x8002;
// NOLINTEND(readability-identifier-naming)
 
// =============================================================================
// Index Categories for Enumeration
// =============================================================================
 
using IndexNamePairs = std::vector<std::pair<std::uint16_t, std::string>>;
 
const IndexNamePairs& CriticalIndices();
const IndexNamePairs& ImIndices();
const IndexNamePairs& DiagnosisIndices(const std::string& scope);
const IndexNamePairs& PortIndices();
const IndexNamePairs& InterfaceIndices();
const IndexNamePairs& DeviceIndices();
const IndexNamePairs& AllStandardIndices();
 
std::string GetIndexName(std::uint16_t index);
 
std::string GetScope(std::uint16_t index);
 
} // namespace profinet