ciptypes.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 2009, Rockwell Automation, Inc.
 * All rights reserved.
 *
 ******************************************************************************/
#ifndef OPENER_CIPTYPES_H_
#define OPENER_CIPTYPES_H_

#include "typedefs.h"
#include "networkhandler.h"
#include "enipmessage.h"

#include "opener_user_conf.h"

typedef enum cip_data_types {
  kCipAny = 0x00, 
  kCipBool = 0xC1, 
  kCipSint = 0xC2, 
  kCipInt = 0xC3, 
  kCipDint = 0xC4, 
  kCipLint = 0xC5, 
  kCipUsint = 0xC6, 
  kCipUint = 0xC7, 
  kCipUdint = 0xC8, 
  kCipUlint = 0xC9, 
  kCipReal = 0xCA, 
  kCipLreal = 0xCB, 
  kCipStime = 0xCC, 
  kCipDate = 0xCD, 
  kCipTimeOfDay = 0xCE, 
  kCipDateAndTime = 0xCF, 
  kCipString = 0xD0, 
  kCipByte = 0xD1, 
  kCipWord = 0xD2, 
  kCipDword = 0xD3, 
  kCipLword = 0xD4, 
  kCipString2 = 0xD5, 
  kCipFtime = 0xD6, 
  kCipLtime = 0xD7, 
  kCipItime = 0xD8, 
  kCipStringN = 0xD9, 
  kCipShortString = 0xDA, 
  kCipTime = 0xDB, 
  kCipEpath = 0xDC, 
  kCipEngUnit = 0xDD, 
  /* definition of some CIP structs */
  /* need to be validated in IEC 61131-3 subclause 2.3.3 */
  /* TODO: Check these codes */
  kCipUsintUsint = 0xA0, 
  kCipUdintUdintUdintUdintUdintString = 0xA1, 
  kCip6Usint = 0xA2, 
  kCipMemberList = 0xA3, 
  kCipByteArray = 0xA4, 
  kInternalUint6 = 0xF0 
} CipDataType;

typedef enum {
  /* Start CIP common services */
  kGetAttributeAll = 0x01,
  kSetAttributeAll = 0x02,
  kGetAttributeList = 0x03,
  kSetAttributeList = 0x04,
  kReset = 0x05,
  kStart = 0x06,
  kStop = 0x07,
  kCreate = 0x08,
  kDelete = 0x09,
  kMultipleServicePacket = 0x0A,
  kApplyAttributes = 0x0D,
  kGetAttributeSingle = 0x0E,
  kSetAttributeSingle = 0x10,
  kFindNextObjectInstance = 0x11,
  kRestore = 0x15,
  kSave = 0x16,
  kNoOperation = 0x17,
  kGetMember = 0x18,
  kSetMember = 0x19,
  kInsertMember = 0x1A,
  kRemoveMember = 0x1B,
  kGroupSync = 0x1C,
  /* End CIP common services */

  /* Start CIP object-specific services */
  kForwardOpen = 0x54,
  kForwardClose = 0x4E,
  kUnconnectedSend = 0x52,
  kGetConnectionOwner = 0x5A
/* End CIP object-specific services */
} CIPServiceCode;

typedef enum { /* TODO: Rework */
  kNotSetOrGetable = 0x00, 
  kGetableAll = 0x01, 
  kGetableSingle = 0x02, 
  kSetable = 0x04, 
  /* combined for convenience */
  kSetAndGetAble = 0x07, 
  kGetableSingleAndAll = 0x03 
} CIPAttributeFlag;

typedef enum {
  kIoConnectionEventOpened,
  kIoConnectionEventTimedOut,
  kIoConnectionEventClosed
} IoConnectionEvent;

typedef struct {
  EipUint16 length; 
  EipByte *data; 
} CipByteArray;

typedef struct {
  EipUint8 length; 
  EipByte *string; 
} CipShortString;

typedef struct {
  EipUint16 length; 
  EipByte *string; 
} CipString;

typedef struct {
  EipUint16 size;
  EipUint16 length; 
  EipByte *string; 
} CipStringN;

typedef struct {
  EipUint8 path_size; 
  EipUint16 class_id; 
  EipUint16 instance_number; 
  EipUint16 attribute_number; 
} CipEpath;

typedef enum connection_point_type {
  kConnectionPointTypeProducing = 0,
  kConnectionPointTypeConsuming,
  kConnectionPointTypeConfig,
  kConnectionPointTypeMaxValue
} ConnectionPointType;

typedef struct {
  EipUint8 path_size; 
  EipUint32 class_id; 
  EipUint32 connection_point[kConnectionPointTypeMaxValue];
  EipUint8 data_segment;
  EipUint8 *segment_data;
} CipConnectionPath;


typedef struct {
  EipUint8 major_revision;
  EipUint8 minor_revision;
} CipRevision;

typedef struct {
  CipUsint service;
  CipEpath request_path;
  EipInt16 request_path_size;
  const CipOctet *data;
} CipMessageRouterRequest;

#define MAX_SIZE_OF_ADD_STATUS 2 /* for now we support extended status codes up to 2 16bit values there is mostly only one 16bit value used */

typedef struct {
  CipUsint reply_service; 
  CipOctet reserved; 
  CipUsint general_status; 
  CipUsint size_of_additional_status; 
  EipUint16 additional_status[MAX_SIZE_OF_ADD_STATUS]; 
  EipInt16 data_length; 
  CipOctet *data; 
} CipMessageRouterResponse;

typedef struct {
  EipUint16 attribute_number;
  EipUint8 type;
  CIPAttributeFlag attribute_flags; /*< 0 => getable_all, 1 => getable_single; 2 =>
                                       setable_single; 3 => get and setable; all other
                                       values reserved */
  void *data;
} CipAttributeStruct;

/* type definition of CIP service structure */

/* instances are stored in a linked list*/
typedef struct cip_instance {
  EipUint32 instance_number; 
  CipAttributeStruct *attributes; 
  struct cip_class *cip_class; 
  struct cip_instance *next; 
} CipInstance;

typedef struct cip_class {
  CipInstance class_instance;
  /* the rest of these are specific to the Class class only. */
  EipUint32 class_id; 
  EipUint16 revision; 
  EipUint16 number_of_instances; 
  EipUint16 number_of_attributes; 
  EipUint16 highest_attribute_number; 
  uint8_t *get_single_bit_mask; 
  uint8_t *set_bit_mask; 
  uint8_t *get_all_bit_mask; 
  EipUint32 get_attribute_all_mask; 
  EipUint16 number_of_services; 
  CipInstance *instances; 
  struct cip_service_struct *services; 
  char *class_name; 
} CipClass;

typedef EipStatus (*CipServiceFunction)(
  CipInstance *const instance,
  CipMessageRouterRequest *const message_router_request,
  CipMessageRouterResponse *const message_router_response,
  struct sockaddr *originator_address,
  const int encapsulation_session);

typedef struct cip_service_struct {
  EipUint8 service_number; 
  CipServiceFunction service_function; 
  char *name; 
} CipServiceStruct;

typedef struct {
  CipUdint ip_address;
  CipUdint network_mask;
  CipUdint gateway;
  CipUdint name_server;
  CipUdint name_server_2;
  CipString domain_name;
} CipTcpIpNetworkInterfaceConfiguration;

typedef struct {
  EipUint8 path_size;
  EipUint32 port; /* support up to 32 bit path*/
  EipUint32 address;
} CipRoutePath;

typedef struct {
  EipByte priority;
  EipUint8 timeout_ticks;
  EipUint16 message_request_size;
  CipMessageRouterRequest message_request;
  CipMessageRouterResponse *message_response;
  EipUint8 reserved;
  CipRoutePath route_path;
  void *data;
} CipUnconnectedSendParameter;

typedef struct {
  CipUint num_conn_entries;
  CipBool *conn_open_bits;
} CipConnectionManagerConnectionEntryList;

/* these are used for creating the getAttributeAll masks
   TODO there might be a way simplifying this using __VARARGS__ in #define */
#define MASK1(a) ( 1 << (a) )
#define MASK2(a, b) ( 1 << (a) | 1 << (b) )
#define MASK3(a, b, c) ( 1 << (a) | 1 << (b) | 1 << (c) )
#define MASK4(a, b, c, d) ( 1 << (a) | 1 << (b) | 1 << (c) | 1 << (d) )
#define MASK5(a, b, c, d, e) \
  ( 1 << (a) | 1 << (b) | 1 << (c) | 1 << (d) | 1 << (e) )
#define MASK6(a, b, c, d, e, f) \
  ( 1 << (a) | 1 << (b) | 1 << (c) | 1 << (d) | 1 << (e) | 1 << (f) )
#define MASK7(a, b, c, d, e, f, g) \
  ( 1 << (a) | 1 << (b) | 1 << (c) | 1 << (d) | 1 << (e) | 1 << (f) | 1 << (g) )
#define MASK8(a, b, c, d, e, f, g, h)                                \
  ( 1 << (a) | 1 << (b) | 1 << (c) | 1 << (d) | 1 << (e) | 1 << (f) | \
    1 << (g) | 1 << (h) )

#endif /* OPENER_CIPTYPES_H_ */