encap.h

Go to the documentation of this file.

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

#include "typedefs.h"
#include "cipconnectionobject.h"

/*** defines ***/

#define ENCAPSULATION_HEADER_LENGTH     24

static const int kOpenerEthernetPort = 0xAF12;

typedef enum {
  kEncapsulationProtocolSuccess = 0x0000,
  kEncapsulationProtocolInvalidCommand = 0x0001,
  kEncapsulationProtocolInsufficientMemory = 0x0002,
  kEncapsulationProtocolIncorrectData = 0x0003,
  kEncapsulationProtocolInvalidSessionHandle = 0x0064,
  kEncapsulationProtocolInvalidLength = 0x0065,
  kEncapsulationProtocolUnsupportedProtocol = 0x0069
} EncapsulationProtocolErrorCode;

/*** structs ***/
typedef struct encapsulation_data {
  CipUint command_code;
  CipUint data_length;
  CipUdint session_handle;
  CipUdint status;
  CipOctet sender_context[8]; 
  CipUdint options;
  const EipUint8 *communication_buffer_start; 
  const EipUint8 *current_communication_buffer_position; 
} EncapsulationData;

typedef struct encapsulation_interface_information {
  EipUint16 type_code;
  EipUint16 length;
  EipUint16 encapsulation_protocol_version;
  EipUint16 capability_flags;
  EipInt8 name_of_service[16];
} EncapsulationInterfaceInformation;

/*** global variables (public) ***/

/*** public functions ***/
void EncapsulationInit(void);

void EncapsulationShutDown(void);

void ManageEncapsulationMessages(const MilliSeconds elapsed_time);

size_t GetSessionFromSocket(const int socket_handle);

void RemoveSession(const int socket);

void CloseSessionBySessionHandle(
  const CipConnectionObject *const connection_object);

void CloseEncapsulationSessionBySockAddr(
  const CipConnectionObject *const connection_object);

void CloseClass3ConnectionBasedOnSession(size_t encapsulation_session_handle);

/* No reason to use this functions outside the encapsulation layer, they are here for testing */
typedef struct enip_message ENIPMessage;

void EncapsulateListIdentityResponseMessage(
  const EncapsulationData *const receive_data,
  ENIPMessage *const outgoing_message);

EipInt16 CreateEncapsulationStructure(const EipUint8 *receive_buffer,
                                      int receive_buffer_length,
                                      EncapsulationData *const encapsulation_data);

void SkipEncapsulationHeader(ENIPMessage *const outgoing_message);

void GenerateEncapsulationHeader(const EncapsulationData *const receive_data,
                                 const size_t command_specific_data_length,
                                 const size_t session_handle,
                                 const EncapsulationProtocolErrorCode encapsulation_protocol_status,
                                 ENIPMessage *const outgoing_message);

void HandleReceivedListServicesCommand(
  const EncapsulationData *const receive_data,
  ENIPMessage *const outgoing_message);

void HandleReceivedListInterfacesCommand(
  const EncapsulationData *const receive_data,
  ENIPMessage *const outgoing_message);

void HandleReceivedRegisterSessionCommand(int socket,
                                          const EncapsulationData *const receive_data,
                                          ENIPMessage *const outgoing_message);

EipStatus HandleReceivedSendRequestResponseDataCommand(
  const EncapsulationData *const receive_data,
  const struct sockaddr *const originator_address,
  ENIPMessage *const outgoing_message);

#endif /* OPENER_ENCAP_H_ */