gclib.h

Go to the documentation of this file.

#ifndef I_D48432D9_1FA3_4C7D_B44C_05F8B9000ADF
#define I_D48432D9_1FA3_4C7D_B44C_05F8B9000ADF

//set library visibility for gcc and msvc
#if BUILDING_GCLIB && HAVE_VISIBILITY
#define GCLIB_DLL_EXPORTED __attribute__((__visibility__("default")))
#elif BUILDING_GCLIB && defined _MSC_VER
#define GCLIB_DLL_EXPORTED __declspec(dllexport)
#elif defined _MSC_VER
#define GCLIB_DLL_EXPORTED __declspec(dllimport)
#else
#define GCLIB_DLL_EXPORTED
#endif

#include "gclib_record.h" // Galil data record structs and unions.
#include "gclib_errors.h" // GReturn error code values and strings.

#ifdef _WIN32
#define GCALL __stdcall 
#else
#define GCALL
#endif

#ifdef __cplusplus
extern "C" {
#endif

  //Constants for function arguments
#define G_DR 1 
#define G_QR 0 
#define G_BOUNDS -1 
#define G_CR 0 
#define G_COMMA 1 

  //Constants for GUtility()
#define G_UTIL_TIMEOUT 1 
#define G_UTIL_TIMEOUT_OVERRIDE 2 
#define G_USE_INITIAL_TIMEOUT -1 
#define G_UTIL_VERSION 128 
#define G_UTIL_INFO 129 
#define G_UTIL_SLEEP 130 
#define G_UTIL_ADDRESSES 131 
#define G_UTIL_IPREQUEST 132 
#define G_UTIL_ASSIGN 133 

  //Convenience constants
#define G_HUGE_BUFFER 524288 

  typedef int GReturn; 
  typedef void* GCon; 
  typedef unsigned int GSize; 
  typedef int GOption; 
  typedef char* GCStringOut; 
  typedef const char* GCStringIn; 
  typedef char* GBufOut; 
  typedef const char* GBufIn; 
  typedef unsigned char GStatus; 
  typedef void* GMemory; 

  GCLIB_DLL_EXPORTED GReturn GCALL GOpen(GCStringIn address, GCon* g);

  GCLIB_DLL_EXPORTED GReturn GCALL GClose(GCon g);

  GCLIB_DLL_EXPORTED GReturn GCALL GRead(GCon g, GBufOut buffer, GSize buffer_len, GSize* bytes_read);

  GCLIB_DLL_EXPORTED GReturn GCALL GWrite(GCon g, GBufIn buffer, GSize buffer_len);

  GCLIB_DLL_EXPORTED GReturn GCALL GCommand(GCon g, GCStringIn command, GBufOut buffer, GSize buffer_len, GSize* bytes_returned);

  GCLIB_DLL_EXPORTED GReturn GCALL GProgramDownload(GCon g, GCStringIn program, GCStringIn preprocessor);

  GCLIB_DLL_EXPORTED GReturn GCALL GProgramUpload(GCon g, GBufOut buffer, GSize buffer_len);

  GCLIB_DLL_EXPORTED GReturn GCALL GArrayDownload(GCon g, const GCStringIn array_name, GOption first, GOption last, GCStringIn buffer);

  GCLIB_DLL_EXPORTED GReturn GCALL GArrayUpload(GCon g, const GCStringIn array_name, GOption first, GOption last, GOption delim, GBufOut buffer, GSize buffer_len);

  GCLIB_DLL_EXPORTED GReturn GCALL GRecord(GCon g, union GDataRecord* record, GOption method);

  GCLIB_DLL_EXPORTED GReturn GCALL GMessage(GCon g, GCStringOut buffer, GSize buffer_len);

  GCLIB_DLL_EXPORTED GReturn GCALL GInterrupt(GCon g, GStatus* status_byte);

  GCLIB_DLL_EXPORTED GReturn GCALL GFirmwareDownload(GCon g, GCStringIn filepath);

  GCLIB_DLL_EXPORTED GReturn GCALL GUtility(GCon g, GOption request, GMemory memory1, GMemory memory2);
#ifdef __cplusplus
} //extern "C"
#endif

#endif //I_D48432D9_1FA3_4C7D_B44C_05F8B9000ADF

---