opener_api.h

Go to the documentation of this file.

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

#include <assert.h>
#include <stdbool.h>

#include "typedefs.h"
#include "ciptypes.h"
#include "ciperror.h"
#include "opener_user_conf.h"

EipStatus
ConfigureNetworkInterface(const char *const network_interface);

void ConfigureMacAddress(const char *network_interface);

void ConfigureDomainName(void);
void ConfigureHostName(void);

void SetDeviceSerialNumber(const EipUint32 serial_number);

void SetDeviceStatus(const EipUint16 device_status);

void CipStackInit(const EipUint16 unique_connection_id);

void ShutdownCipStack(void);

CipClass *GetCipClass(const EipUint32 class_id);

CipInstance *GetCipInstance(const CipClass *RESTRICT const cip_object,
                            const EipUint32 instance_number);

CipAttributeStruct *GetCipAttribute(const CipInstance *const cip_instance,
                                    const EipUint16 attribute_number);

typedef void (*InitializeCipClass)(CipClass *); 
CipClass *CreateCipClass( const EipUint32 class_id,
                          const int number_of_class_attributes,
                          const EipUint32 highest_class_attribute_number,
                          const int number_of_class_services,
                          const int number_of_instance_attributes,
                          const EipUint32 highest_instance_attribute_number,
                          const int number_of_instance_services,
                          const int number_of_instances,
                          char *name,
                          const EipUint16 revision,
                          InitializeCipClass initializer );

CipInstance *AddCipInstances(
  CipClass *RESTRICT const cip_object_to_add_instances,
  const int number_of_instances);

CipInstance *AddCIPInstance(CipClass *RESTRICT const cip_class_to_add_instance,
                            const EipUint32 instance_id);

void InsertAttribute(CipInstance *const cip_instance,
                     const EipUint16 attribute_number,
                     const EipUint8 cip_data_type,
                     void *const cip_data,
                     const EipByte cip_flags);
void AllocateAttributeMasks(CipClass *target_class);

size_t CalculateIndex(EipUint16 attribute_number);

void InsertService(const CipClass *const cip_class_to_add_service,
                   const EipUint8 service_code,
                   const CipServiceFunction service_function,
                   char *const service_name);

int EncodeData(const EipUint8 cip_data_type,
               const void *const cip_data,
               EipUint8 **cip_message);

int DecodeData(const EipUint8 cip_data_type,
               void *const cip_data,
               const EipUint8 **const cip_message);

CipInstance *CreateAssemblyObject(const EipUint32 instance_number,
                                  EipByte *const data,
                                  const EipUint16 data_length);

typedef struct cip_connection_object CipConnectionObject;

typedef EipStatus (*OpenConnectionFunction)(
  CipConnectionObject *RESTRICT const connection_object,
  EipUint16 *const extended_error_code);

typedef void (*ConnectionCloseFunction)(CipConnectionObject *connection_object);

typedef void (*ConnectionTimeoutFunction)(
  CipConnectionObject *connection_object);

typedef EipStatus (*ConnectionSendDataFunction)(CipConnectionObject *
                                                connection_object);

typedef EipStatus (*ConnectionReceiveDataFunction)(
  CipConnectionObject *connection_object,
  const EipUint8 *data,
  const EipUint16 data_length);

EipStatus
AddConnectableObject(const EipUint32 class_id,
                     OpenConnectionFunction open_connection_function);

void ConfigureExclusiveOwnerConnectionPoint(
  const unsigned int connection_number,
  const unsigned int output_assembly_id,
  const unsigned int input_assembly_id,
  const unsigned int configuration_assembly_id);

void ConfigureInputOnlyConnectionPoint(
  const unsigned int connection_number,
  const unsigned int output_assembly_id,
  const unsigned int input_assembly_id,
  const unsigned int configuration_assembly_id);

void ConfigureListenOnlyConnectionPoint(
  const unsigned int connection_number,
  const unsigned int output_assembly_id,
  const unsigned int input_assembly_id,
  const unsigned int configuration_assembly_id);

int HandleReceivedExplictTcpData(int socket_handle,
                                 EipUint8 *buffer,
                                 size_t length,
                                 int *number_of_remaining_bytes,
                                 struct sockaddr *originator_address,
                                 ENIPMessage *const outgoing_message);

int HandleReceivedExplictUdpData(const int socket_handle,
                                 const struct sockaddr_in *from_address,
                                 const EipUint8 *buffer,
                                 const size_t buffer_length,
                                 int *number_of_remaining_bytes,
                                 bool unicast,
                                 ENIPMessage *const outgoing_message);

EipStatus
HandleReceivedConnectedData(const EipUint8 *const received_data,
                            int received_data_length,
                            struct sockaddr_in *from_address);

EipStatus
ManageConnections(MilliSeconds elapsed_time);

EipStatus
TriggerConnections(unsigned int output_assembly_id,
                   unsigned int input_assembly_id);

void CloseSession(int socket_handle);

EipStatus
ApplicationInitialization(void);

void HandleApplication(void);

void CheckIoConnectionEvent(unsigned int output_assembly_id,
                            unsigned int input_assembly_id,
                            IoConnectionEvent io_connection_event);

EipStatus
AfterAssemblyDataReceived(CipInstance *instance);

EipBool8
BeforeAssemblyDataSend(CipInstance *instance);

EipStatus
ResetDevice(void);

EipStatus
ResetDeviceToInitialConfiguration(void);

void *CipCalloc(size_t number_of_elements,
                size_t size_of_element);

void CipFree(void *data);

void RunIdleChanged(EipUint32 run_idle_value);

int CreateUdpSocket(UdpCommuncationDirection communication_direction,
                    struct sockaddr_in *socket_data,
                    CipUsint qos_for_socket);

EipStatus
SendUdpData(struct sockaddr_in *socket_data,
            int socket_handle,
            EipUint8 *data,
            EipUint16 data_length);

void CloseSocket(const int socket_handle);

#endif /*OPENER_OPENER_API_H_*/