mlpiIoLib.h

Go to the documentation of this file.

#ifndef __MLPIIOLIB_H__
#define __MLPIIOLIB_H__

// -----------------------------------------------------------------------
// MLPI - <mlpiIoLib.h>
// -----------------------------------------------------------------------
// Copyright (c) 2013 Bosch Rexroth. All rights reserved.
// Redistribution and use in source and binary forms of this MLPI software
// (SW) provided to you, with or without modification, are permitted
// without prior approval provided that the following conditions are met:
//
// 1. Redistributions of source code of SW must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form of SW must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. User recognizes and acknowledges that it acquires no right,
// title or interest in or to any of the names or trademarks used in
// connection with the SW ("names") by virtue of this License and waives
// any right to or interest in the names. User recognizes and acknowledges
// that names of companies or names or products of companies displayed
// in the documentation of SW to indicate the interoperability of products
// with the SW are the names of their respective owners. The use of such
// names in the documentation of SW does not imply any sponsorship,
// approval, or endorsement by such companies of this product.
//
// 4. Modified code versions, i.e. any addition to or deletion from
// the substance or structure of the original code of the SW running
// the MLPI must be plainly marked as such and must not be misrepresented
// as being original SW.
//
// 5. The SW may only be used in connection with a Bosch Rexroth product.
//
// THIS INFORMATION IS PROVIDED BY BOSCH REXROTH CORPORATION "AS IS"
// AND WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING
// (BUT NOTLIMITED TO) ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR ANY PARTICULAR PURPOSE, OR NON-INFRINGEMENT. WHILE THE
// INFORMATION PROVIDED IS BELIEVED TO BE ACCURATE, IT MAY INCLUDE
// ERRORS OR INACCURACIES.
// SUBJECT TO COMPULSORY STATUTORY PROVISIONS OF THE GERMAN LAW AS
// THE APPLICABLE LAW FOR THIS LICENSE BOSCH REXROTH CORPORATION WILL
// NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND ARISING FROM THE USE OF
// THE  SOFTWARE  DISTRIBUTED HEREUNDER, INCLUDING BUT NOT LIMITED TO
// DIRECT, INDIRECT, INCIDENTAL, PUNITIVE, AND CONSEQUENTIAL DAMAGES.
// -----------------------------------------------------------------------
//
//
// -----------------------------------------------------------------------










// -----------------------------------------------------------------------
// GLOBAL INCLUDES
// -----------------------------------------------------------------------
#include "mlpiGlobal.h"

// -----------------------------------------------------------------------
// GLOBAL CONSTANTS
// -----------------------------------------------------------------------
#define MLPI_IO_FIELDBUS_SLAVE_ADDRESS_LEN                          ( 64 )    
#define MLPI_IO_FIELDBUS_DEVICE_NAME_LEN                            ( 81 )    

#define MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_ENABLE                      (0x0001)  
#define MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DRIVER_AVAILABLE            (0x0010)  
#define MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DEVICE_FOUND                (0x0020)  
#define MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DEVICE_CONFIGURED           (0x0040)  
#define MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DEVICE_ACTIVE               (0x0080)  
#define MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DEVICE_BUS_ERROR            (0x0100)  
#define MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DEVICE_ERROR                (0x0200)  
#define MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DEVICE_DIAGNOSTIC_AVAILABLE (0x0400)  
#define MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DEVICE_PASSIVE              (0x0800)  

#define MLPI_IO_FIELDBUS_DIAGNOSIS_OKAY(flags)   ( flags == (                                                                     \
                                                                MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_ENABLE                            \
                                                              | MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DRIVER_AVAILABLE                  \
                                                              | MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DEVICE_FOUND                      \
                                                              | MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DEVICE_CONFIGURED                 \
                                                              | MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DEVICE_ACTIVE                     \
                                                             )                                                                    \
                                                  )

#define MLPI_IO_FIELDBUS_DIAGNOSIS_DIAG(flags)   ( flags == (                                                                     \
                                                                MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_ENABLE                            \
                                                              | MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DRIVER_AVAILABLE                  \
                                                              | MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DEVICE_FOUND                      \
                                                              | MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DEVICE_CONFIGURED                 \
                                                              | MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DEVICE_ACTIVE                     \
                                                              | MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DEVICE_DIAGNOSTIC_AVAILABLE       \
                                                             )                                                                    \
                                                  )

#define MLPI_IO_FIELDBUS_DIAGNOSIS_ERROR(flags)  (    ( !MLPI_IO_FIELDBUS_DIAGNOSIS_OKAY(flags) )                                 \
                                                   || ( 0 != (   (   MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DEVICE_BUS_ERROR             \
                                                                   | MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DEVICE_ERROR                 \
                                                                   | MLPI_IO_FIELDBUS_DIAGNOSIS_FLAG_DEVICE_DIAGNOSTIC_AVAILABLE  \
                                                                  )                                                               \
                                                               & flags                                                            \
                                                              )                                                                   \
                                                       )                                                                          \
                                                  )

// -----------------------------------------------------------------------
// GLOBAL TYPEDEFS
// -----------------------------------------------------------------------

typedef enum MlpiIoFieldbusMasterType
{
  MLPI_FIELDBUS_MASTER_GENERIC         = 0,        
  MLPI_FIELDBUS_MASTER_ONBOARD_IO      = 1,        
  MLPI_FIELDBUS_MASTER_INLINE_IO       = 2,        
  MLPI_FIELDBUS_MASTER_PROFIBUS_DP     = 3,        
  MLPI_FIELDBUS_MASTER_SERCOS_III      = 4,        
  MLPI_FIELDBUS_MASTER_FAST_IO         = 5,        
  MLPI_FIELDBUS_MASTER_PROFINET        = 6,        
  MLPI_FIELDBUS_MASTER_DEVICENET       = 7,        
  MLPI_FIELDBUS_MASTER_ETHERNET_IP     = 8,        
  MLPI_FIELDBUS_MASTER_ETHERNET_NETX   = 9         
}MlpiIoFieldbusMasterType;

typedef enum MlpiIoFieldbusArea
{
  MLPI_IO_AREA_INPUT  = 0,           
  MLPI_IO_AREA_OUTPUT = 1            
}MlpiIoFieldbusArea;

// message packing follows 8 byte natural alignment
#if !defined(TARGET_OS_VXWORKS)
#pragma pack(push,8)
#endif

typedef struct MlpiIoDiagnosis
{
  ULONG flags;        
} MlpiIoDiagnosis;

typedef struct MlpiIoHandle
{
  ULONG ident;      
  ULONG hash;       
} MlpiIoHandle;

typedef struct MlpiIoFieldbusSlaveInfo
{
  MlpiIoHandle      handle;                                         
  WCHAR16           name[MLPI_IO_FIELDBUS_DEVICE_NAME_LEN];         
  MlpiIoDiagnosis   diagnosis;                                      
  WCHAR16           address[MLPI_IO_FIELDBUS_SLAVE_ADDRESS_LEN];    
  ULONG             numberOfInputs;                                 
  ULONG             numberOfOutputs;                                
}MlpiIoFieldbusSlaveInfo;

typedef struct MlpiIoFieldbusMasterInfo
{
  MlpiIoHandle              handle;                                 
  WCHAR16                   name[MLPI_IO_FIELDBUS_DEVICE_NAME_LEN]; 
  MlpiIoDiagnosis           diagnosis;                              
  MlpiIoFieldbusMasterType  type;                                   
  ULONG                     numberOfSlaves;                         
}MlpiIoFieldbusMasterInfo;


#if !defined(TARGET_OS_VXWORKS)
#pragma pack(pop)
#endif





// -----------------------------------------------------------------------
// GLOBAL EXPORTS
// -----------------------------------------------------------------------
#ifdef MLPI_API
  #undef MLPI_API
#endif

#if defined(TARGET_OS_WINNT)
  #if defined(MLPI_EXPORTS)
    #define MLPI_API __declspec(dllexport)
  #elif defined(MLPI_IMPORTS)
    #define MLPI_API __declspec(dllimport)
  #else
    #define MLPI_API
  #endif
#else
  #if defined(MLPI_EXPORTS)
    #define MLPI_API __attribute__ ((visibility("default")))
  #elif defined(MLPI_IMPORTS)
    #define MLPI_API
  #else
    #define MLPI_API
  #endif
#endif


#ifdef __cplusplus
extern "C" {
#endif

MLPI_API MLPIRESULT mlpiIoReadFieldbusMasterList(const MLPIHANDLE connection, WCHAR16* masterList, const ULONG numElements, ULONG* countOfMaster);


MLPI_API MLPIRESULT mlpiIoReadFieldbusMasterInfo(const MLPIHANDLE connection, const WCHAR16* masterName, MlpiIoFieldbusMasterInfo* masterInfo);


MLPI_API MLPIRESULT mlpiIoReadFieldbusSlaveList(const MLPIHANDLE connection, const WCHAR16* masterName, WCHAR16* slaveList, const ULONG numElements, ULONG* countOfSlave);


MLPI_API MLPIRESULT mlpiIoReadFieldbusSlaveInfo(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, MlpiIoFieldbusSlaveInfo* slaveInfo);


MLPI_API MLPIRESULT mlpiIoReadFieldbusSlaveInfos(const MLPIHANDLE connection, const WCHAR16* masterName, MlpiIoFieldbusSlaveInfo* slaveInfo, const ULONG numElements, ULONG* numElementsRet);


MLPI_API MLPIRESULT mlpiIoUpdateFieldbusIo(const MLPIHANDLE connection, const WCHAR16* masterName);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoBool8(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG bitOffset, BOOL8* data);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoChar(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, CHAR* data);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoUchar(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, UCHAR* data);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoShort(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, SHORT* data);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoUshort(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, USHORT* data);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoLong(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, LONG* data);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoUlong(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, ULONG* data);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoLlong(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, LLONG* data);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoUllong(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, ULLONG* data);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoFloat(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, FLOAT* data);



MLPI_API MLPIRESULT mlpiIoReadFieldbusIoDouble(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, DOUBLE* data);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoArrayChar(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, CHAR* data, const ULONG numElements, ULONG *numElementsRet);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoArrayUchar(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, UCHAR* data, const ULONG numElements, ULONG *numElementsRet);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoArrayShort(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, SHORT* data, const ULONG numElements, ULONG *numElementsRet);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoArrayUshort(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, USHORT* data, const ULONG numElements, ULONG *numElementsRet);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoArrayLong(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, LONG* data, const ULONG numElements, ULONG *numElementsRet);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoArrayUlong(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, ULONG* data, const ULONG numElements, ULONG *numElementsRet);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoArrayLlong(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, LLONG* data, const ULONG numElements, ULONG *numElementsRet);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoArrayUllong(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, ULLONG* data, const ULONG numElements, ULONG *numElementsRet);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoArrayFloat(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, FLOAT* data, const ULONG numElements, ULONG *numElementsRet);


MLPI_API MLPIRESULT mlpiIoReadFieldbusIoArrayDouble(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, DOUBLE* data, const ULONG numElements, ULONG *numElementsRet);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoBool8(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG bitOffset, const BOOL8 data);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoChar(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const CHAR data);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoUchar(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const UCHAR data);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoShort(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const SHORT data);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoUshort(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const USHORT data);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoLong(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const LONG data);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoUlong(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const ULONG data);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoLlong(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const LLONG data);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoUllong(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const ULLONG data);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoFloat(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const FLOAT data);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoDouble(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const DOUBLE data);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoArrayChar(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const CHAR* data, const ULONG numElements);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoArrayUchar(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const UCHAR* data, const ULONG numElements);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoArrayShort(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const SHORT* data, const ULONG numElements);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoArrayUshort(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const USHORT* data, const ULONG numElements);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoArrayLong(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const LONG* data, const ULONG numElements);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoArrayUlong(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const ULONG* data, const ULONG numElements);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoArrayLlong(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const LLONG* data, const ULONG numElements);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoArrayUllong(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const ULLONG* data, const ULONG numElements);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoArrayFloat(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const FLOAT* data, const ULONG numElements);


MLPI_API MLPIRESULT mlpiIoWriteFieldbusIoArrayDouble(const MLPIHANDLE connection, const WCHAR16* masterName, const WCHAR16* slaveAddress, const MlpiIoFieldbusArea area, const ULONG byteOffset, const DOUBLE* data, const ULONG numElements);



#ifdef __cplusplus
}
#endif



#endif // endof: #ifndef __MLPIIOLIB_H__