mlpiWatchdogLib.h

Go to the documentation of this file.

#ifndef __MLPIWATCHDOGLIB_H__
#define __MLPIWATCHDOGLIB_H__

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

typedef enum MlpiWatchdogAction
{
  MLPI_WATCHDOG_REBOOT   = 0x00,  
  MLPI_WATCHDOG_PLCSTOPP = 0x01,  
  MLPI_WATCHDOG_ERROR    = 0x02,  
  MLPI_WATCHDOG_WARNING  = 0x03   
} MlpiWatchdogAction;


typedef enum MlpiWatchdogState
{
  MLPI_WATCHDOG_DISABLED = 0x00,  
  MLPI_WATCHDOG_ENABLED  = 0x01,  
  MLPI_WATCHDOG_TIMEOUT  = 0x02   
} MlpiWatchdogState;

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

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


#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 mlpiWatchdogSetup(const MLPIHANDLE connection, ULONG timeout, MlpiWatchdogAction action);


MLPI_API MLPIRESULT mlpiWatchdogStart(const MLPIHANDLE connection);


MLPI_API MLPIRESULT mlpiWatchdogStop(const MLPIHANDLE connection);


MLPI_API MLPIRESULT mlpiWatchdogReset(const MLPIHANDLE connection);


MLPI_API MLPIRESULT mlpiWatchdogGetState(const MLPIHANDLE connection, MlpiWatchdogState *state);



#ifdef __cplusplus
}
#endif



#endif // endof: #ifndef __MLPIWATCHDOGLIB_H__