mlpiSystemLib.h

Go to the documentation of this file.

#ifndef __MLPISYSTEMLIB_H__
#define __MLPISYSTEMLIB_H__

// -----------------------------------------------------------------------
// MLPI - <mlpiSystemLib.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
// -----------------------------------------------------------------------

static const LONG MLPI_DIAGNOSIS_STRING_LEN           = 124;

static const WCHAR16 MLPI_VERSION_FIRMWARE[]          = {'V','E','R','S','I','O','N','_','F','I','R','M','W','A','R','E','\0'};

static const WCHAR16 MLPI_VERSION_HARDWARE[]          = {'V','E','R','S','I','O','N','_','H','A','R','D','W','A','R','E','\0'};

static const WCHAR16 MLPI_VERSION_LOGIC[]             = {'V','E','R','S','I','O','N','_','L','O','G','I','C','\0'};

static const WCHAR16 MLPI_VERSION_BSP[]               = {'V','E','R','S','I','O','N','_','B','S','P','\0'};

static const WCHAR16 MLPI_VERSION_MLPI_SERVER_CORE[]  = {'V','E','R','S','I','O','N','_','M','L','P','I','_','S','E','R','V','E','R','_','C','O','R','E','\0'};

static const LONG MLPI_TRANSMISSION_URL_LEN           = 256;

static const LONG MLPI_TRANSMISSION_ERROR_LEN         = 128;


// -----------------------------------------------------------------------
// GLOBAL ENUMERATIONS
// -----------------------------------------------------------------------

typedef enum MlpiLanguage
{
  MLPI_LANGUAGE_GERMAN                  = 00,     
  MLPI_LANGUAGE_ENGLISH                 = 01,     
  MLPI_LANGUAGE_USER_DEFINED            = 99      
} MlpiLanguage;

typedef enum MlpiSystemMode
{
  MLPI_SYSTEMMODE_P0                    = 0x00,   
  MLPI_SYSTEMMODE_P1                    = 0x01,   
  MLPI_SYSTEMMODE_P2                    = 0x02,   
  MLPI_SYSTEMMODE_P3                    = 0x03,   
  MLPI_SYSTEMMODE_BB                    = 0x04,   
  MLPI_SYSTEMMODE_SWITCHING             = 0xFF    
} MlpiSystemMode;

typedef enum MlpiDiagnosisState
{
  MLPI_DIAGNOSIS_PASSIVE                = 0x00,   
  MLPI_DIAGNOSIS_ACTIVE                 = 0x01,   
  MLPI_DIAGNOSIS_RESET                  = 0x02,   
  MLPI_DIAGNOSIS_UNKNOWN                = 0x03    
} MlpiDiagnosisState;

typedef enum MlpiDiagnosisDespatcher
{
  MLPI_DESPATCHER_CONTROL               = 0x00,   
  MLPI_DESPATCHER_DRIVE                 = 0x01,   
  MLPI_DESPATCHER_LOGIC                 = 0x02,   
  MLPI_DESPATCHER_AXIS                  = 0x03,   
  MLPI_DESPATCHER_KINEMATIC             = 0x04,   
  MLPI_DESPATCHER_PCI                   = 0x05    
} MlpiDiagnosisDespatcher;

typedef enum MlpiSpecialPath
{
  MLPI_PATH_SYSTEM                            = 0x00,   
  MLPI_PATH_OEM                               = 0x01,   
  MLPI_PATH_USER                              = 0x02,   
  MLPI_PATH_PROJECTDATAPROTECTED              = 0x03,   
  MLPI_PATH_PROJECTDATA                       = 0x04,   
  MLPI_PATH_PROJECTDATA_BUNDLES               = 0x05,   
  MLPI_PATH_PROJECTDATA_PLC                   = 0x06,   
  MLPI_PATH_PROJECTDATA_TMP                   = 0x07,   
  MLPI_PATH_PROJECTDATA_JVM                   = 0x08,   
  MLPI_PATH_PROJECTDATA_JVM_BUNDLES           = 0x09,   
  MLPI_PATH_PROJECTDATA_JVM_LIC               = 0x0A,   
  MLPI_PATH_PROJECTDATA_JVM_USER              = 0x0B,   
  MLPI_PATH_PROJECTDATAPROTECTED_BUNDLES      = 0x0C,   
  MLPI_PATH_PROJECTDATAPROTECTED_JVM          = 0x0D,   
  MLPI_PATH_PROJECTDATAPROTECTED_JVM_BUNDLES  = 0x0E,   
  MLPI_PATH_PROJECTDATAPROTECTED_JVM_LIC      = 0x0F,   
  MLPI_PATH_PROJECTDATAPROTECTED_JVM_USER     = 0x10,   
  MLPI_PATH_OTHER                             = 0xFF    
} MlpiSpecialPath;

typedef enum MlpiDiagnosisCategory
{
  MLPI_DIAGNOSIS_ERROR_FATAL            = 0xF8,   
  MLPI_DIAGNOSIS_ERROR_NONFATAL_CONTROL = 0xF5,   
  MLPI_DIAGNOSIS_ERROR_NONFATAL         = 0xF0,   
  MLPI_DIAGNOSIS_WARNING                = 0xE0,   
  MLPI_DIAGNOSIS_MESSAGE                = 0xA0    
} MlpiDiagnosisCategory;

typedef enum MlpiLedPattern
{
  MLPI_LED_PATTERN_GREEN                 =  0,  
  MLPI_LED_PATTERN_GREEN_250             =  1,  
  MLPI_LED_PATTERN_GREEN_500             =  2,  
  MLPI_LED_PATTERN_GREEN_1000            =  3,  
  MLPI_LED_PATTERN_GREEN_ORANGE_250      =  4,  
  MLPI_LED_PATTERN_GREEN_ORANGE_500      =  5,  
  MLPI_LED_PATTERN_GREEN_ORANGE_1000     =  6,  
  MLPI_LED_PATTERN_GREEN_RED_250         =  7,  
  MLPI_LED_PATTERN_GREEN_RED_500         =  8,  
  MLPI_LED_PATTERN_GREEN_RED_1000        =  9,  
  MLPI_LED_PATTERN_INVALID               = -1   
} MlpiLedPattern;


typedef enum MlpiSystemLimit
{
  MLPI_SYSTEM_LIMIT_MAX_APPLICATIONS    =  0,   
  MLPI_SYSTEM_LIMIT_MAX_CONTROLS        =  1,   
  MLPI_SYSTEM_LIMIT_MAX_AXIS            =  2,   
  MLPI_SYSTEM_LIMIT_MAX_PLS             =  3,   
  MLPI_SYSTEM_LIMIT_MAX_KINEMATICS      =  4,   
  MLPI_SYSTEM_LIMIT_MAX_TOUCHPROBES     =  5,   
  MLPI_SYSTEM_LIMIT_MAX_OSCI_CHANNELS   =  6,   
  MLPI_SYSTEM_LIMIT_INVALID             = -1    
}MlpiSystemLimit;


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

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

typedef struct MlpiDiagnosis
{
  ULONG                   number;                          
  MlpiDiagnosisState      state;                           
  MlpiDateAndTime         dateTime;                        
  LONG                    logicalAddress;                  
  LONG                    physicalAddress;                 
  MlpiDiagnosisDespatcher despatcher;                      
  ULONG                   index;                           
  WCHAR16                 text[MLPI_DIAGNOSIS_STRING_LEN]; 
}MlpiDiagnosis;

typedef struct MlpiMemoryInfo
{
  ULLONG totalVolatileBytes;     
  ULLONG totalNonvolatileBytes;  
  ULLONG freeVolatileBytes;      
  ULLONG freeNonvolatileBytes;   
} MlpiMemoryInfo;

typedef struct MlpiSpecialPathInfo
{
  ULLONG totalBytes;      
  ULLONG freeBytes;       
} MlpiSpecialPathInfo;

typedef struct MlpiTransmissionStatus
{
  MLPITASKHANDLE          handle;                   
  MLPIRESULT              result;                   
  MlpiProcessState        state;                    
  ULONG                   totalBytes;               
  ULONG                   transmittedBytes;         
}MlpiTransmissionStatus;

typedef struct MlpiTransmissionInfo
{
  MlpiTransmissionStatus  status;                                         
  WCHAR16                 source[MLPI_TRANSMISSION_URL_LEN];              
  WCHAR16                 destination[MLPI_TRANSMISSION_URL_LEN];         
  WCHAR16                 errorMessage[MLPI_TRANSMISSION_ERROR_LEN];      
}MlpiTransmissionInfo;



#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 mlpiSystemGetVersionInfo(const MLPIHANDLE connection, const WCHAR16 *component, WCHAR16 *version, const ULONG numElements);


MLPI_API MLPIRESULT mlpiSystemGetLanguage(const MLPIHANDLE connection, MlpiLanguage *language);


MLPI_API MLPIRESULT mlpiSystemSetLanguage(const MLPIHANDLE connection, const MlpiLanguage language);


MLPI_API MLPIRESULT mlpiSystemGetName(const MLPIHANDLE connection, WCHAR16 *name, const ULONG numElements);


MLPI_API MLPIRESULT mlpiSystemSetName(const MLPIHANDLE connection, const WCHAR16 *name);


MLPI_API MLPIRESULT mlpiSystemGetIpAddress(const MLPIHANDLE connection, WCHAR16 *ipAddress, const ULONG numElements);


MLPI_API MLPIRESULT mlpiSystemSetIpAddress(const MLPIHANDLE connection, const WCHAR16 *ipAddress);


MLPI_API MLPIRESULT mlpiSystemGetSubnetMask(const MLPIHANDLE connection, WCHAR16 *subnet, const ULONG numElements);


MLPI_API MLPIRESULT mlpiSystemSetSubnetMask(const MLPIHANDLE connection, const WCHAR16 *subnet);


MLPI_API MLPIRESULT mlpiSystemGetGateway(const MLPIHANDLE connection, WCHAR16 *gateway, const ULONG numElements);


MLPI_API MLPIRESULT mlpiSystemSetGateway(const MLPIHANDLE connection, const WCHAR16 *gateway);


MLPI_API MLPIRESULT mlpiSystemGetCurrentMode(const MLPIHANDLE connection, MlpiSystemMode *mode);


MLPI_API MLPIRESULT mlpiSystemSetTargetMode(const MLPIHANDLE connection, const MlpiSystemMode mode);


MLPI_API MLPIRESULT mlpiSystemGetTemperature(const MLPIHANDLE connection, FLOAT *temperature);


MLPI_API MLPIRESULT mlpiSystemGetTemperatureMax(const MLPIHANDLE connection, FLOAT *temperature);


MLPI_API MLPIRESULT mlpiSystemResetTemperature(const MLPIHANDLE connection);


MLPI_API MLPIRESULT mlpiSystemGetTargetId(const MLPIHANDLE connection, LLONG* targetId);


MLPI_API MLPIRESULT mlpiSystemGetCpuLoad(const MLPIHANDLE connection, FLOAT *load);


MLPI_API MLPIRESULT mlpiSystemGetCpuLoadMax(const MLPIHANDLE connection, FLOAT *load);


MLPI_API MLPIRESULT mlpiSystemResetCpuLoad(const MLPIHANDLE connection);


MLPI_API MLPIRESULT mlpiSystemGetOperationHours(const MLPIHANDLE connection, ULONG *operatingTime);


MLPI_API MLPIRESULT mlpiSystemGetDateAndTimeUtc(const MLPIHANDLE connection, MlpiDateAndTime *dateTime);


MLPI_API MLPIRESULT mlpiSystemSetDateAndTimeUtc(const MLPIHANDLE connection, MlpiDateAndTime dateTime);


MLPI_API MLPIRESULT mlpiSystemSetDateAndTimeUtcByNtp(const MLPIHANDLE connection, const ULONG timeout, const WCHAR16* server, const USHORT port=0);


MLPI_API MLPIRESULT mlpiSystemGetSerialNumber(const MLPIHANDLE connection, WCHAR16 *serialNumber, const ULONG numElements);


MLPI_API MLPIRESULT mlpiSystemGetHardwareDetails(const MLPIHANDLE connection, WCHAR16 *hardwareDetails, const ULONG numElements);


MLPI_API MLPIRESULT mlpiSystemGetLocalBusConfiguration(const MLPIHANDLE connection, WCHAR16 *configuration, const ULONG numElements);


MLPI_API MLPIRESULT mlpiSystemGetFunctionModulBusConfiguration(const MLPIHANDLE connection, WCHAR16 *configuration, const ULONG numElements);


MLPI_API MLPIRESULT mlpiSystemGetFunctionModuleHardwareDetails(const MLPIHANDLE connection, const ULONG functionModuleNum, WCHAR16 *hardwareDetails, const ULONG numElements);


MLPI_API MLPIRESULT mlpiSystemGetMacAddress(const MLPIHANDLE connection, WCHAR16 *macAddress, const ULONG numElements);


MLPI_API MLPIRESULT mlpiSystemGetMemoryInfo(const MLPIHANDLE connection, MlpiMemoryInfo *memoryInfo);


MLPI_API MLPIRESULT mlpiSystemGetSpecialPath(const MLPIHANDLE connection, const MlpiSpecialPath pathIdentifier, WCHAR16 *path, const ULONG numElements);


MLPI_API MLPIRESULT mlpiSystemGetSpecialPathInfo(const MLPIHANDLE connection, const MlpiSpecialPath pathIdentifier, MlpiSpecialPathInfo *pathInfo);


MLPI_API MLPIRESULT mlpiSystemGetRootPaths(const MLPIHANDLE connection, WCHAR16* paths, const ULONG numElements, ULONG* numElementsRet);


MLPI_API MLPIRESULT mlpiSystemClearError(const MLPIHANDLE connection);


MLPI_API MLPIRESULT mlpiSystemReboot(const MLPIHANDLE connection);


MLPI_API MLPIRESULT mlpiSystemCleanup(const MLPIHANDLE connection);


MLPI_API MLPIRESULT mlpiSystemGetLicenseInformation(const MLPIHANDLE connection, WCHAR16 *licenses, const ULONG numElements, ULONG* numElementsRet);


MLPI_API MLPIRESULT mlpiSystemGetLimit(const MLPIHANDLE connection, MlpiSystemLimit limit, LLONG *value);


MLPI_API MLPIRESULT mlpiSystemGetDisplayedDiagnosis(const MLPIHANDLE connection, MlpiDiagnosis *diagnosis);


MLPI_API MLPIRESULT mlpiSystemSetDiagnosis(const MLPIHANDLE connection, const MlpiDiagnosisCategory category, const USHORT number, const WCHAR16 *diagnosisText=0);


MLPI_API MLPIRESULT mlpiSystemGetNewestDiagnosisIndex(const MLPIHANDLE connection, ULONG *index);


MLPI_API MLPIRESULT mlpiSystemGetOldestDiagnosisIndex(const MLPIHANDLE connection, ULONG *index);


MLPI_API MLPIRESULT mlpiSystemGetDiagnosisLog(const MLPIHANDLE connection, const ULONG index, MlpiDiagnosis *diagnosisLog, const ULONG numElements, ULONG *numElementsRet);


MLPI_API MLPIRESULT mlpiSystemConvertDiagnosisNumberToText(const MLPIHANDLE connection, const ULONG diagnosisNumber, WCHAR16 *diagnosisText, const ULONG numElements);


MLPI_API MLPIRESULT mlpiSystemSetBootLed(const MLPIHANDLE connection, const MlpiLedPattern pattern, const LONG count = -1);


MLPI_API MLPIRESULT mlpiSystemClearBootLed(const MLPIHANDLE connection);


MLPI_API MLPIRESULT mlpiSystemStartTransmission(const MLPIHANDLE connection, const WCHAR16* source, const WCHAR16* destination, MLPITASKHANDLE* handle);


MLPI_API MLPIRESULT mlpiSystemGetTransmissionStatus(const MLPIHANDLE connection, MlpiTransmissionStatus* status, ULONG numElements);


MLPI_API MLPIRESULT mlpiSystemGetTransmissionInfo(const MLPIHANDLE connection, const MLPITASKHANDLE handle, MlpiTransmissionInfo* info);


MLPI_API MLPIRESULT mlpiSystemTftpSetTimeout(const MLPIHANDLE connection, const USHORT seconds);


MLPI_API MLPIRESULT mlpiSystemTftpGetTimeout(const MLPIHANDLE connection, USHORT* seconds);


MLPI_API MLPIRESULT mlpiSystemTftpSetRetransmitCount(const MLPIHANDLE connection, const USHORT count);


MLPI_API MLPIRESULT mlpiSystemTftpGetRetransmitCount(const MLPIHANDLE connection, USHORT* count);


#ifdef __cplusplus
}
#endif



#endif // endof: #ifndef __MLPISYSTEMLIB_H__