Works now with Windows Visual Studio C++ too
[owTools.git] / windows / owTools / tmexlnk.cpp
diff --git a/windows/owTools/tmexlnk.cpp b/windows/owTools/tmexlnk.cpp
new file mode 100644 (file)
index 0000000..47d22d1
--- /dev/null
@@ -0,0 +1,368 @@
+//---------------------------------------------------------------------------\r
+// Copyright (C) 2001 Dallas Semiconductor Corporation, All Rights Reserved.\r
+//\r
+// Permission is hereby granted, free of charge, to any person obtaining a\r
+// copy of this software and associated documentation files (the "Software"),\r
+// to deal in the Software without restriction, including without limitation\r
+// the rights to use, copy, modify, merge, publish, distribute, sublicense,\r
+// and/or sell copies of the Software, and to permit persons to whom the\r
+// Software is furnished to do so, subject to the following conditions:\r
+//\r
+// The above copyright notice and this permission notice shall be included\r
+// in all copies or substantial portions of the Software.\r
+//\r
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS\r
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\r
+// MERCHANTABILITY,  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\r
+// IN NO EVENT SHALL DALLAS SEMICONDUCTOR BE LIABLE FOR ANY CLAIM, DAMAGES\r
+// OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,\r
+// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\r
+// OTHER DEALINGS IN THE SOFTWARE.\r
+//\r
+// Except as contained in this notice, the name of Dallas Semiconductor\r
+// shall not be used except as stated in the Dallas Semiconductor\r
+// Branding Policy.\r
+//---------------------------------------------------------------------------\r
+//\r
+//  TMEXLnk.C - Link module to call on TMEX low-level functions to\r
+//              excersize the general 1-Wire Net functions.\r
+//              (Requires TMEX 3.11 or newer)\r
+//\r
+//  Version: 3.00\r
+//\r
+//  History: 1.00 -> 1.01  Return values in owLevel corrected.\r
+//                         Added function msDelay.\r
+//           1.02 -> 1.03  Add msGettick, always return owLevel success\r
+//                         to hide adapters (DS9097E) that do not have\r
+//                         power delivery capabilities.\r
+//           1.03 -> 2.00  Changed 'MLan' to 'ow'. Added support for\r
+//                         multiple ports.\r
+//           2.10 -> 3.00  Added owReadBitPower and owWriteBytePower\r
+\r
+#include "ownet.h"\r
+#include <windows.h>\r
+\r
+// external TMEX variables\r
+extern long SessionHandle[MAX_PORTNUM];\r
+extern uchar StateBuffer[MAX_PORTNUM][5120];\r
+extern "C" short far pascal TMTouchByte(long, short);\r
+extern "C" short far pascal TMTouchReset(long);\r
+extern "C" short far pascal TMTouchBit(long, short);\r
+extern "C" short far pascal TMProgramPulse(long);\r
+extern "C" short far pascal TMOneWireCom(long, short, short);\r
+extern "C" short far pascal TMOneWireLevel(long, short, short, short);\r
+\r
+// globals\r
+SMALLINT FAMILY_CODE_04_ALARM_TOUCHRESET_COMPLIANCE = FALSE; // for compatibility purposes\r
+\r
+//--------------------------------------------------------------------------\r
+// Reset all of the devices on the 1-Wire Net and return the result.\r
+//\r
+// 'portnum'     - number 0 to MAX_PORTNUM-1.  This number is provided to\r
+//                 indicate the symbolic port number.\r
+//\r
+// Returns: TRUE(1):  presense pulse(s) detected, device(s) reset\r
+//          FALSE(0): no presense pulses detected\r
+//\r
+SMALLINT owTouchReset(int portnum)\r
+{\r
+   int result;\r
+\r
+   // Assume valid Session\r
+   result = TMTouchReset(SessionHandle[portnum]);\r
+\r
+   // success if the normal or alarm presence\r
+   if ((result == 1) || (result == 2))\r
+      return TRUE;\r
+   else\r
+      return FALSE;\r
+}\r
+\r
+\r
+//--------------------------------------------------------------------------\r
+// Send 1 bit of communication to the 1-Wire Net and return the\r
+// result 1 bit read from the 1-Wire Net.  The parameter 'sendbit'\r
+// least significant bit is used and the least significant bit\r
+// of the result is the return bit.\r
+//\r
+// 'portnum'     - number 0 to MAX_PORTNUM-1.  This number is provided to\r
+//                 indicate the symbolic port number.\r
+// 'sendbit'     - the least significant bit is the bit to send\r
+//\r
+// Returns: 0:   0 bit read from sendbit\r
+//          1:   1 bit read from sendbit\r
+//\r
+SMALLINT owTouchBit(int portnum, SMALLINT sendbit)\r
+{\r
+   // Assume valid Session\r
+   return TMTouchBit(SessionHandle[portnum],(short)sendbit);\r
+}\r
+\r
+//--------------------------------------------------------------------------\r
+// Send 8 bits of communication to the 1-Wire Net and verify that the\r
+// 8 bits read from the 1-Wire Net is the same (write operation).\r
+// The parameter 'sendbyte' least significant 8 bits are used.\r
+//\r
+// 'portnum'    - number 0 to MAX_PORTNUM-1.  This number is provided to\r
+//                indicate the symbolic port number.\r
+// 'sendbyte'   - 8 bits to send (least significant byte)\r
+//\r
+// Returns:  TRUE: bytes written and echo was the same\r
+//           FALSE: echo was not the same\r
+//\r
+SMALLINT owTouchByte(int portnum, SMALLINT sendbyte)\r
+{\r
+   // Assume valid Session\r
+   return TMTouchByte(SessionHandle[portnum],(short)sendbyte);\r
+}\r
+\r
+//--------------------------------------------------------------------------\r
+// Send 8 bits of communication to the MicroLAN and verify that the\r
+// 8 bits read from the MicroLAN is the same (write operation).\r
+// The parameter 'sendbyte' least significant 8 bits are used.\r
+//\r
+// 'portnum'    - number 0 to MAX_PORTNUM-1.  This number is provided to\r
+//                indicate the symbolic port number.\r
+// 'sendbyte'   - 8 bits to send (least significant byte)\r
+//\r
+// Returns:  TRUE: bytes written and echo was the same\r
+//           FALSE: echo was not the same\r
+//\r
+SMALLINT owWriteByte(int portnum, SMALLINT sendbyte)\r
+{\r
+   return (owTouchByte(portnum,sendbyte) == sendbyte) ? TRUE : FALSE;\r
+}\r
+\r
+//--------------------------------------------------------------------------\r
+// Send 8 bits of read communication to the 1-Wire Net and and return the\r
+// result 8 bits read from the 1-Wire Net.\r
+//\r
+// 'portnum'     - number 0 to MAX_PORTNUM-1.  This number is provided to\r
+//                 indicate the symbolic port number.\r
+//\r
+// Returns:  TRUE:  8 bytes read from 1-Wire Net\r
+//           FALSE: the 8 bytes were not read\r
+//\r
+SMALLINT owReadByte(int portnum)\r
+{\r
+   return owTouchByte(portnum,0xFF);\r
+}\r
+\r
+//--------------------------------------------------------------------------\r
+// Set the 1-Wire Net communucation speed.\r
+//\r
+// 'portnum'    - number 0 to MAX_PORTNUM-1.  This number is provided to\r
+//                indicate the symbolic port number.\r
+// 'new_speed'  - new speed defined as\r
+//                MODE_NORMAL     0x00\r
+//                MODE_OVERDRIVE  0x01\r
+//\r
+// Returns:  current 1-Wire Net speed\r
+//\r
+SMALLINT owSpeed(int portnum, SMALLINT new_speed)\r
+{\r
+   return TMOneWireCom(SessionHandle[portnum],0,(short)new_speed);\r
+}\r
+\r
+//--------------------------------------------------------------------------\r
+// Set the 1-Wire Net line level.  The values for new_level are\r
+// as follows:\r
+//\r
+// 'portnum'   - number 0 to MAX_PORTNUM-1.  This number is provided to\r
+//               indicate the symbolic port number.\r
+// 'new_level' - new level defined as\r
+//                MODE_NORMAL     0x00\r
+//                MODE_STRONG5    0x02\r
+//                MODE_PROGRAM    0x04\r
+//                MODE_BREAK      0x08 (not supported)\r
+//\r
+// Returns:  current 1-Wire Net level\r
+//\r
+SMALLINT owLevel(int portnum, SMALLINT new_level)\r
+{\r
+   int rslt;\r
+   int docheck = FALSE;\r
+\r
+   // check for DS2480 bug\r
+   if (((SessionHandle[portnum] & 0x0F0) == 0x050) &&\r
+       (TMOneWireLevel(SessionHandle[portnum],1,0,0) == 1))\r
+      docheck = TRUE;\r
+\r
+   switch (new_level)\r
+   {\r
+      case MODE_NORMAL:\r
+         rslt = TMOneWireLevel(SessionHandle[portnum],0,0,0);\r
+         // test code for DS2480 bug\r
+         if (docheck)\r
+            TMTouchBit(SessionHandle[portnum],1);\r
+         break;\r
+      case MODE_STRONG5:\r
+         rslt = TMOneWireLevel(SessionHandle[portnum],0,1,0);\r
+         break;\r
+      case MODE_PROGRAM:\r
+         rslt = TMOneWireLevel(SessionHandle[portnum],0,3,0);\r
+         break;\r
+      case MODE_BREAK:\r
+         rslt = TMOneWireLevel(SessionHandle[portnum],0,2,0);\r
+         break;\r
+      default:\r
+         rslt = 0;\r
+   }\r
+\r
+   // Assume TMEX can do it so always return NewLevel\r
+   return new_level;\r
+}\r
+\r
+//--------------------------------------------------------------------------\r
+// This procedure creates a fixed 480 microseconds 12 volt pulse\r
+// on the 1-Wire Net for programming EPROM iButtons.\r
+//\r
+// 'portnum'     - number 0 to MAX_PORTNUM-1.  This number is provided to\r
+//                 indicate the symbolic port number.\r
+//\r
+// Returns:  TRUE  successful\r
+//           FALSE program voltage not available\r
+//\r
+SMALLINT owProgramPulse(int portnum)\r
+{\r
+   return TMProgramPulse(SessionHandle[portnum]);\r
+}\r
+\r
+//--------------------------------------------------------------------------\r
+//  Description:\r
+//     Delay for at least 'len' ms\r
+//\r
+void msDelay(int len)\r
+{\r
+   Sleep(len);\r
+}\r
+\r
+//--------------------------------------------------------------------------\r
+// Get the current millisecond tick count.  Does not have to represent\r
+// an actual time, it just needs to be an incrementing timer.\r
+//\r
+long msGettick(void)\r
+{\r
+   return GetTickCount();\r
+}\r
+\r
+//--------------------------------------------------------------------------\r
+// Send 8 bits of communication to the 1-Wire Net and verify that the\r
+// 8 bits read from the 1-Wire Net is the same (write operation).  \r
+// The parameter 'sendbyte' least significant 8 bits are used.  After the\r
+// 8 bits are sent change the level of the 1-Wire net.\r
+//\r
+// 'portnum'  - number 0 to MAX_PORTNUM-1.  This number was provided to\r
+//              OpenCOM to indicate the port number.\r
+// 'sendbyte' - 8 bits to send (least significant byte)\r
+//\r
+// Returns:  TRUE: bytes written and echo was the same\r
+//           FALSE: echo was not the same \r
+//\r
+SMALLINT owWriteBytePower(int portnum, SMALLINT sendbyte)\r
+{\r
+   // prime for power delivery after byte\r
+   TMOneWireLevel(SessionHandle[portnum],0,1,2);\r
+\r
+   // send the byte and start strong pullup\r
+   if(TMTouchByte(SessionHandle[portnum],(short)sendbyte) != sendbyte)\r
+   {\r
+      TMOneWireLevel(SessionHandle[portnum],0,0,0);\r
+      return FALSE;\r
+   }\r
+\r
+   return TRUE;\r
+}\r
+\r
+//--------------------------------------------------------------------------\r
+// Read 8 bits of communication to the 1-Wire Net and verify that the\r
+// 8 bits read from the 1-Wire Net is the same (write operation).  \r
+// The parameter 'sendbyte' least significant 8 bits are used.  After the\r
+// 8 bits are read change the level of the 1-Wire net.\r
+//\r
+// 'portnum'  - number 0 to MAX_PORTNUM-1.  This number was provided to\r
+//              OpenCOM to indicate the port number.\r
+// 'sendbyte' - 8 bits to send (least significant byte)\r
+//\r
+// Returns:  TRUE: bytes written and echo was the same\r
+//           FALSE: echo was not the same \r
+//\r
+SMALLINT owReadBytePower(int portnum)\r
+{\r
+   SMALLINT sendbyte = 0xFF;\r
+\r
+   // prime for power delivery after byte\r
+   TMOneWireLevel(SessionHandle[portnum],0,1,2);\r
+\r
+   // send the byte and start strong pullup\r
+   return TMTouchByte(SessionHandle[portnum],(short)sendbyte);\r
+}\r
+\r
+//--------------------------------------------------------------------------\r
+// Send 1 bit of communication to the 1-Wire Net and verify that the\r
+// response matches the 'applyPowerResponse' bit and apply power delivery\r
+// to the 1-Wire net.  Note that some implementations may apply the power\r
+// first and then turn it off if the response is incorrect.\r
+//\r
+// 'portnum'  - number 0 to MAX_PORTNUM-1.  This number was provided to\r
+//              OpenCOM to indicate the port number.\r
+// 'applyPowerResponse' - 1 bit response to check, if correct then start\r
+//                        power delivery \r
+//\r
+// Returns:  TRUE: bit written and response correct, strong pullup now on\r
+//           FALSE: response incorrect\r
+//\r
+SMALLINT owReadBitPower(int portnum, SMALLINT applyPowerResponse)\r
+{\r
+   // prime for power delivery after bit\r
+   TMOneWireLevel(SessionHandle[portnum],0,1,1);\r
+\r
+   // send the byte and start strong pullup\r
+   if(TMTouchBit(SessionHandle[portnum],0x01) != applyPowerResponse)\r
+   {\r
+      TMOneWireLevel(SessionHandle[portnum],0,0,0);\r
+      return FALSE;\r
+   }\r
+\r
+   return TRUE;\r
+}\r
+\r
+//--------------------------------------------------------------------------\r
+// This procedure indicates wether the adapter can deliver power.\r
+//\r
+// 'portnum'  - number 0 to MAX_PORTNUM-1.  This number was provided to\r
+//              OpenCOM to indicate the port number.\r
+//\r
+// Returns:  TRUE  because all userial adapters have over drive. \r
+//\r
+SMALLINT owHasPowerDelivery(int portnum)\r
+{\r
+   return TRUE;\r
+}\r
+\r
+//--------------------------------------------------------------------------\r
+// This procedure indicates wether the adapter can deliver power.\r
+//\r
+// 'portnum'  - number 0 to MAX_PORTNUM-1.  This number was provided to\r
+//              OpenCOM to indicate the port number.\r
+//\r
+// Returns:  TRUE  because all userial adapters have over drive. \r
+//\r
+SMALLINT owHasOverDrive(int portnum)\r
+{\r
+   return TRUE;\r
+}\r
+\r
+//--------------------------------------------------------------------------\r
+// This procedure creates a fixed 480 microseconds 12 volt pulse \r
+// on the 1-Wire Net for programming EPROM iButtons.\r
+//\r
+// 'portnum'  - number 0 to MAX_PORTNUM-1.  This number was provided to\r
+//              OpenCOM to indicate the port number.\r
+//\r
+// Returns:  TRUE  program volatage available\r
+//           FALSE program voltage not available  \r
+SMALLINT owHasProgramPulse(int portnum)\r
+{\r
+   return TMProgramPulse(SessionHandle[portnum]);\r
+}
\ No newline at end of file