cpf.h

Go to the documentation of this file.

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

#include "typedefs.h"
#include "ciptypes.h"
#include "encap.h"

typedef enum {
  kCipItemIdNullAddress = 0x0000, 
  kCipItemIdListIdentityResponse = 0x000C,
  kCipItemIdConnectionAddress = 0x00A1, 
  kCipItemIdConnectedDataItem = 0x00B1, 
  kCipItemIdUnconnectedDataItem = 0x00B2, 
  kCipItemIdListServiceResponse = 0x0100,
  kCipItemIdSocketAddressInfoOriginatorToTarget = 0x8000, 
  kCipItemIdSocketAddressInfoTargetToOriginator = 0x8001, 
  kCipItemIdSequencedAddressItem = 0x8002 
} CipItemId;

typedef struct {
  EipUint32 connection_identifier;
  EipUint32 sequence_number;
} AddressData;

typedef struct {
  CipUint type_id;
  CipUint length;
  AddressData data;
} AddressItem;

typedef struct {
  EipUint16 type_id;
  EipUint16 length;
  EipUint8 *data;
} DataItem;

typedef struct {
  CipUint type_id; 
  CipUint length; 
  CipInt sin_family; 
  CipUint sin_port; 
  CipUdint sin_addr; 
  CipUsint nasin_zero[8]; 
} SocketAddressInfoItem;

/* this one case of a CPF packet is supported:*/
typedef struct {
  EipUint16 item_count; 
  AddressItem address_item;
  DataItem data_item;
  SocketAddressInfoItem address_info_item[2];
} CipCommonPacketFormatData;

int NotifyCommonPacketFormat(EncapsulationData *const received_data,
                             const struct sockaddr *const originator_address,
                             ENIPMessage *const outgoing_message);

int NotifyConnectedCommonPacketFormat(
  const EncapsulationData *const received_data,
  const struct sockaddr *const originator_address,
  ENIPMessage *const outgoing_message);

EipStatus CreateCommonPacketFormatStructure(
  const EipUint8 *data,
  size_t data_length,
  CipCommonPacketFormatData *common_packet_format_data);

int AssembleIOMessage(
  const CipCommonPacketFormatData *const common_packet_format_data_item,
  ENIPMessage *const message);


int AssembleLinearMessage(
  const CipMessageRouterResponse *const message_router_response,
  const CipCommonPacketFormatData *const common_packet_format_data_item,
  ENIPMessage *const outgoing_message);

extern CipCommonPacketFormatData g_common_packet_format_data_item;

#endif /* OPENER_CPF_H_ */