gobi-api: add GobiAPI_2012-09-12-0719

3 files changed, 860 insertions, 0 deletions

diff --git a/gobi-api/GobiAPI_2012-09-12-0719/Shared/GobiError.h b/gobi-api/GobiAPI_2012-09-12-0719/Shared/GobiError.h
new file mode 100755
index 0000000..53d5602
--- /dev/null
+++ b/gobi-api/GobiAPI_2012-09-12-0719/Shared/GobiError.h
@@ -0,0 +1,137 @@
+/*===========================================================================
+FILE: 
+   GobiError.h
+
+DESCRIPTION:
+   QUALCOMM Gobi Errors
+
+Copyright (c) 2012, Code Aurora Forum. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form 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.
+    * Neither the name of Code Aurora Forum nor
+      the names of its contributors may be used to endorse or promote
+      products derived from this software without specific prior written
+      permission.
+
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+==========================================================================*/
+
+/*=========================================================================*/
+// Pragmas
+/*=========================================================================*/
+#pragma once
+
+//---------------------------------------------------------------------------
+// Include Files
+//---------------------------------------------------------------------------
+#include "QMIEnum.h"
+
+//---------------------------------------------------------------------------
+// Definitions
+//---------------------------------------------------------------------------
+
+/*=========================================================================*/
+// eGobiError Enumeration
+//    Gobi API Error Enumeration
+/*=========================================================================*/
+enum eGobiError
+{
+   eGOBI_ERR_ENUM_BEGIN = -1, 
+
+   eGOBI_ERR_NONE,               // 00 Success
+   eGOBI_ERR_GENERAL,            // 01 General error
+   eGOBI_ERR_INTERNAL,           // 02 Internal error
+   eGOBI_ERR_MEMORY,             // 03 Memory error
+   eGOBI_ERR_INVALID_ARG,        // 04 Invalid argument
+   eGOBI_ERR_BUFFER_SZ,          // 05 Buffer too small
+   eGOBI_ERR_NO_DEVICE,          // 06 Unable to detect device
+   eGOBI_ERR_INVALID_DEVID,      // 07 Invalid device ID
+   eGOBI_ERR_NO_CONNECTION,      // 08 No connection to device
+   eGOBI_ERR_IFACE,              // 09 Unable to obtain required interace
+   eGOBI_ERR_CONNECT,            // 10 Unable to connect to interface
+   eGOBI_ERR_REQ_SCHEDULE,       // 11 Unable to schedule request
+   eGOBI_ERR_REQUEST,            // 12 Error sending request
+   eGOBI_ERR_RESPONSE,           // 13 Error receiving response
+   eGOBI_ERR_REQUEST_TO,         // 14 Timeout while sending request
+   eGOBI_ERR_RESPONSE_TO,        // 15 Timeout while receiving response
+   eGOBI_ERR_MALFORMED_RSP,      // 16 Malformed response received
+   eGOBI_ERR_INVALID_RSP,        // 17 Invalid/error response received
+   eGOBI_ERR_INVALID_FILE,       // 18 Invalid file path
+   eGOBI_ERR_FILE_OPEN,          // 19 Unable to open file
+   eGOBI_ERR_FILE_COPY,          // 20 Unable to copy file
+   eGOBI_ERR_QDL_SCM,            // 21 Unable to open service control mgr
+   eGOBI_ERR_NO_QDL_SVC,         // 22 Unable to detect QDL service
+   eGOBI_ERR_NO_QDL_SVC_INFO,    // 23 Unable to obtain QDL service info
+   eGOBI_ERR_NO_QDL_SVC_PATH,    // 24 Unable to locate QSL service 
+   eGOBI_ERR_QDL_SVC_CFG,        // 25 Unable to reconfigure QDL service
+   eGOBI_ERR_QDL_SVC_IFACE,      // 26 Unable to interface to QDL service
+   eGOBI_ERR_OFFLINE,            // 27 Unable to set device offline
+   eGOBI_ERR_RESET,              // 28 Unable to reset device
+   eGOBI_ERR_NO_SIGNAL,          // 29 No available signal 
+   eGOBI_ERR_MULTIPLE_DEVICES,   // 30 Multiple devices detected
+   eGOBI_ERR_DRIVER,             // 31 Error interfacing to driver
+   eGOBI_ERR_NO_CANCELABLE_OP,   // 32 No cancelable operation is pending
+   eGOBI_ERR_CANCEL_OP,          // 33 Error canceling outstanding operation
+   eGOBI_ERR_QDL_CRC,            // 34 QDL image data CRC error
+   eGOBI_ERR_QDL_PARSING,        // 35 QDL image data parsing error
+   eGOBI_ERR_QDL_AUTH,           // 36 QDL image authentication error
+   eGOBI_ERR_QDL_WRITE,          // 37 QDL image write error
+   eGOBI_ERR_QDL_OPEN_SIZE,      // 38 QDL image size error
+   eGOBI_ERR_QDL_OPEN_TYPE,      // 39 QDL image type error
+   eGOBI_ERR_QDL_OPEN_PROT,      // 40 QDL memory protection error
+   eGOBI_ERR_QDL_OPEN_SKIP,      // 41 QDL image not required
+   eGOBI_ERR_QDL_ERR_GENERAL,    // 42 QDL general error
+   eGOBI_ERR_QDL_BAR_MODE,       // 43 QDL BAR mode error
+
+   eGOBI_ERR_ENUM_END,
+
+   // Offset from which mapped QMI error codes start from (see eQMIErrorCode)
+   eGOBI_ERR_QMI_OFFSET = 1000,
+};
+
+/*===========================================================================
+METHOD:
+   IsValid (Inline Method)
+
+DESCRIPTION:
+   eGobiError validity check
+
+PARAMETERS:
+   ec          [ I ] - Enum value being verified
+
+RETURN VALUE:
+   bool
+===========================================================================*/
+inline bool IsValid( eGobiError ec )
+{
+   bool retVal = false;
+   if (ec > eGOBI_ERR_ENUM_BEGIN && ec < eGOBI_ERR_ENUM_END)
+   {
+      retVal = true;
+   }
+
+   if (ec >= eGOBI_ERR_QMI_OFFSET)
+   {
+      ULONG tmp = (ULONG)ec - (ULONG)eGOBI_ERR_QMI_OFFSET;
+      retVal = ::IsValid( (eQMIErrorCode)tmp );
+   }
+
+   return retVal;
+};
\ No newline at end of file
diff --git a/gobi-api/GobiAPI_2012-09-12-0719/Shared/GobiQMICore.cpp b/gobi-api/GobiAPI_2012-09-12-0719/Shared/GobiQMICore.cpp
new file mode 100755
index 0000000..136976f
--- /dev/null
+++ b/gobi-api/GobiAPI_2012-09-12-0719/Shared/GobiQMICore.cpp
@@ -0,0 +1,531 @@
+/*===========================================================================
+FILE: 
+   GobiQMICore.cpp
+
+DESCRIPTION:
+   QUALCOMM Gobi QMI Based API Core
+
+PUBLIC CLASSES AND FUNCTIONS:
+   cGobiQMICore
+
+Copyright (c) 2012, Code Aurora Forum. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form 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.
+    * Neither the name of Code Aurora Forum nor
+      the names of its contributors may be used to endorse or promote
+      products derived from this software without specific prior written
+      permission.
+
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+==========================================================================*/
+
+//---------------------------------------------------------------------------
+// Include Files
+//---------------------------------------------------------------------------
+#include "StdAfx.h"
+#include "GobiQMICore.h"
+
+#include "QMIBuffers.h"
+#include "ProtocolNotification.h"
+
+/*=========================================================================*/
+// cGobiQMICore Methods
+/*=========================================================================*/
+
+/*===========================================================================
+METHOD:
+   cGobiQMICore (Public Method)
+
+DESCRIPTION:
+   Constructor
+  
+RETURN VALUE:
+   None
+===========================================================================*/
+cGobiQMICore::cGobiQMICore()
+   :  mLastError( eGOBI_ERR_NONE )
+{
+   mInterface[0] = 0;
+}
+
+/*===========================================================================
+METHOD:
+   ~cGobiQMICore (Public Method)
+
+DESCRIPTION:
+   Destructor
+  
+RETURN VALUE:
+   BOOL
+===========================================================================*/
+cGobiQMICore::~cGobiQMICore()
+{
+   Cleanup();
+}
+
+/*===========================================================================
+METHOD:
+   Initialize (Public Method)
+
+DESCRIPTION:
+   Initialize the object
+  
+RETURN VALUE:
+   bool
+===========================================================================*/
+bool cGobiQMICore::Initialize()
+{
+   return true;
+}
+
+/*===========================================================================
+METHOD:
+   Cleanup (Public Method)
+
+DESCRIPTION:
+   Cleanup the object
+  
+RETURN VALUE:
+   bool
+===========================================================================*/
+bool cGobiQMICore::Cleanup()
+{
+   Disconnect();
+   return true;
+}
+
+/*===========================================================================
+METHOD:
+   Connect (Public Method)
+
+DESCRIPTION:
+   Connect to the specified Gobi device
+  
+PARAMETERS:
+   pQMIFile    [ I ] - Gobi device interface to connect to
+   services    [ I ] - QMI services to connect to
+
+RETURN VALUE:
+   std::set <eQMIService> - Services successfuly configured
+===========================================================================*/
+std::set <eQMIService> cGobiQMICore::Connect( 
+   LPCSTR                     pInterface,
+   std::set <eQMIService> &   services )
+{
+   // The services we successfully connected to
+   std::set <eQMIService> retServices;
+
+   // Clear last error recorded
+   ClearLastError();
+
+   size_t ifaceLen = strnlen( pInterface, MAX_PATH ) + 1;
+   if (ifaceLen >= (size_t)MAX_PATH)
+   {
+      mLastError = eGOBI_ERR_INVALID_ARG;
+      return retServices;
+   }
+
+   // Allocate configured QMI servers
+   std::set <eQMIService>::const_iterator pIter = services.begin();
+   while (pIter != services.end())
+   {
+      cQMIProtocolServer * pSvr = 0;
+      pSvr = new cQMIProtocolServer( *pIter, 8192, 512 );
+      if (pSvr != 0)
+      {
+         // Initialize server (we don't care about the return code
+         // since the following Connect() call will fail if we are
+         // unable to initialize the server)
+         pSvr->Initialize();
+
+         bool bRC = pSvr->Connect( pInterface );
+         if (bRC == true)
+         {
+            sServerInfo si( pSvr );
+            std::pair <eQMIService, sServerInfo> entry( *pIter, si ); 
+            mServers.insert( entry );
+
+            retServices.insert( *pIter );
+         }
+      }
+   
+      pIter++;
+   }
+
+   // All servers fail?
+   if (retServices.size() == 0)
+   {
+      // Yes, disconnect them all
+      Disconnect();
+
+      // ... and set the error code
+      mLastError = eGOBI_ERR_CONNECT;
+   }
+
+   memcpy( mInterface, pInterface, ifaceLen );
+   return retServices;
+}
+
+/*===========================================================================
+METHOD:
+   Disconnect (Public Method)
+
+DESCRIPTION:
+   Disconnect from the currently connected Gobi device
+  
+RETURN VALUE:
+   bool
+===========================================================================*/
+bool cGobiQMICore::Disconnect()
+{
+   // Clear last error recorded
+   ClearLastError();
+   
+   // Clear device interface
+   mInterface[0] = 0;
+
+   // Assume failure
+   bool bRC = false;
+   if (mServers.size() == 0)
+   {
+      mLastError = eGOBI_ERR_NO_CONNECTION;
+      return bRC;
+   }
+
+   // Disconnect/clean-up all configured QMI servers
+   std::map <eQMIService, sServerInfo>::iterator pIter;
+   pIter = mServers.begin();
+
+   while (pIter != mServers.end())
+   {
+      sServerInfo & si = pIter->second;
+      cQMIProtocolServer * pSvr = si.mpServer;
+      if (pSvr != 0)
+      {
+         pSvr->Disconnect();
+         pSvr->Exit();
+
+         delete pSvr;
+      }
+
+      si.mLogsProcessed = 0;
+      pIter++;
+   }
+
+   mServers.clear();
+
+   bRC = true;
+   return bRC;
+}
+
+/*===========================================================================
+METHOD:
+   Send (Public Method)
+
+DESCRIPTION:
+   Send a request using the specified QMI protocol server and wait for (and
+   then return) the response
+
+PARAMETERS:
+   svcID       [ I ] - QMI service type
+   msgID       [ I ] - QMI message ID
+   to          [ I ] - Timeout value (in milliseconds)
+   inLen       [ I ] - Length of input buffer
+   pIn         [ I ] - Input buffer
+   pOutLen     [I/O] - Upon input the maximum number of BYTEs pOut can
+                       contain, upon output the number of BYTEs copied
+                       to pOut
+   pOut        [ O ] - Output buffer
+
+RETURN VALUE:
+   eGobiError - The result
+===========================================================================*/
+eGobiError cGobiQMICore::Send(
+   ULONG                      svcID,
+   ULONG                      msgID,
+   ULONG                      to,
+   ULONG                      inLen,
+   const BYTE *               pIn,
+   ULONG *                    pOutLen,
+   BYTE *                     pOut )
+{
+   // Clear last error recorded
+   ClearLastError();
+
+   if (msgID > 0xffff)
+   {
+      mLastError = eGOBI_ERR_INVALID_ARG;
+      return mLastError;
+   }
+
+   sSharedBuffer * pRequest = 0;
+   pRequest = sQMIServiceBuffer::BuildBuffer( (eQMIService)svcID,
+                                              (WORD)msgID,
+                                              false,
+                                              false,
+                                              pIn,
+                                              inLen );
+
+   if (pRequest == 0)
+   {
+      mLastError = eGOBI_ERR_MEMORY;
+      return mLastError;
+   }
+
+   // We use the event based notification approach
+   cSyncQueue <sProtocolNotificationEvent> evts( 12, true );   
+   cProtocolQueueNotification pn( &evts );
+
+   // Build the request object
+   sProtocolRequest req( pRequest, 0, to, 1, 1, &pn );
+   if (to == 0)
+   {
+      mLastError = eGOBI_ERR_INTERNAL;
+      return mLastError;
+   }
+
+   // Grab the server
+   std::map <eQMIService, cGobiQMICore::sServerInfo>::iterator pSvrIter;
+   pSvrIter = mServers.find( (eQMIService)svcID );
+   if (pSvrIter == mServers.end())
+   {
+      mLastError = eGOBI_ERR_NO_CONNECTION;
+      return mLastError;
+   }
+
+   sServerInfo & si = pSvrIter->second;
+   cQMIProtocolServer * pSvr = si.mpServer;
+   if (pSvr == 0 || pSvr->IsConnected() == false)
+   {
+      mLastError = eGOBI_ERR_NO_CONNECTION;
+      return mLastError;
+   }
+
+   // Grab the log from the server
+   const cProtocolLog & protocolLog = pSvr->GetLog();
+
+   // Schedule the request
+   ULONG reqID = pSvr->AddRequest( req );
+   if (reqID == INVALID_REQUEST_ID)
+   {
+      mLastError = eGOBI_ERR_REQ_SCHEDULE;
+      return mLastError;
+   }   
+
+   // Store for external cancel
+   si.mRequestID = reqID;
+
+   bool bReq = false;
+   bool bExit = false;
+   DWORD idx;
+
+   // Returned response
+   sProtocolBuffer rsp;
+
+   // Process up to the indicated timeout
+   cEvent & sigEvt = evts.GetSignalEvent();
+   while (bExit == false)
+   {
+      int wc = sigEvt.Wait( to, idx );
+      if (wc == ETIME)
+      {
+         if (bReq == true)
+         {
+            mLastError = eGOBI_ERR_RESPONSE_TO;
+         }
+         else
+         {
+            mLastError = eGOBI_ERR_REQUEST_TO;
+         }
+         break;
+      }
+      else if (wc != 0)
+      {
+         mLastError = eGOBI_ERR_INTERNAL;
+         break;
+      }
+
+      sProtocolNotificationEvent evt;
+      bool bEvt = evts.GetElement( idx, evt );
+      if (bEvt == false)
+      {
+         mLastError = eGOBI_ERR_INTERNAL;
+         bExit = true;
+         break;
+      }
+
+      switch (evt.mEventType)
+      {
+         case ePROTOCOL_EVT_REQ_ERR:
+            mLastError = eGOBI_ERR_REQUEST;
+            bExit = true;
+            break;
+
+         case ePROTOCOL_EVT_RSP_ERR:
+            mLastError = eGOBI_ERR_RESPONSE;
+            bExit = true;
+            break;
+            
+         case ePROTOCOL_EVT_REQ_SENT:
+         {
+            // Grab the as-sent request
+            DWORD id = evt.mParam2;
+            sProtocolBuffer tmpReq = protocolLog.GetBuffer( id );
+            sSharedBuffer * pTmpRequest = tmpReq.GetSharedBuffer();
+            if (pTmpRequest != 0)
+            {
+               // Grab the transaction ID
+               sQMIServiceBuffer actualReq( pTmpRequest );
+               si.mRequestTXID = actualReq.GetTransactionID();
+            }
+
+            bReq = true;
+         }
+         break;
+
+         case ePROTOCOL_EVT_RSP_RECV:
+            // Success!
+            rsp = protocolLog.GetBuffer( evt.mParam2 );
+            bExit = true;
+            break;
+      }
+   }
+
+   if ( (mLastError == eGOBI_ERR_INTERNAL)
+   ||   (mLastError == eGOBI_ERR_REQUEST_TO)
+   ||   (mLastError == eGOBI_ERR_RESPONSE_TO) )
+   {
+      // Remove the request as our protocol notification object is
+      // about to go out of scope and hence be destroyed
+      pSvr->RemoveRequest( reqID );
+   }
+
+   if (rsp.IsValid() == false)
+   {
+      return GetCorrectedLastError();
+   }
+
+   // Did we receive a valid QMI response?
+   sQMIServiceBuffer qmiRsp( rsp.GetSharedBuffer() );
+   if (qmiRsp.IsValid() == false)
+   {
+      mLastError = eGOBI_ERR_MALFORMED_RSP;
+      return mLastError;
+   }
+   
+   // Caller might not be interested in actual output (beyond error code)
+   ULONG maxSz = 0;
+   if (pOutLen != 0)
+   {
+      maxSz = *pOutLen;
+   }
+
+   if (maxSz > 0)
+   {
+      // TLV 2 is always present
+      ULONG needSz = 0;
+      const BYTE * pData = (const BYTE *)qmiRsp.GetRawContents( needSz );
+      if (needSz == 0 || pData == 0)
+      {
+         return eGOBI_ERR_INVALID_RSP;
+      }
+
+      *pOutLen = needSz;
+      if (needSz > maxSz)
+      {
+         return eGOBI_ERR_BUFFER_SZ;
+      }
+
+      memcpy( pOut, pData, needSz );
+   }
+
+   // Check the mandatory QMI result TLV for success
+   ULONG rc = 0;
+   ULONG ec = 0;
+   bool bResult = qmiRsp.GetResult( rc, ec );
+   if (bResult == false)
+   {
+      mLastError = eGOBI_ERR_MALFORMED_RSP;
+      return mLastError;
+   }
+   else if (rc != 0)
+   {
+      return GetCorrectedQMIError( ec );
+   }
+
+   // Success!
+   return eGOBI_ERR_NONE;
+}
+
+/*===========================================================================
+METHOD:
+   CancelSend (Public Method)
+
+DESCRIPTION:
+   Cancel the most recent in-progress Send() based operation
+
+PARAMETERS:
+   svcID       [ I ] - Service whose outstanding request is to be cancelled
+   pTXID       [ O ] - QMI transaction ID of outstanding request
+
+RETURN VALUE:
+   eGobiError - The result
+===========================================================================*/
+eGobiError cGobiQMICore::CancelSend( 
+   ULONG                      svcID,
+   ULONG *                    pTXID )
+{
+   // Grab the server
+   std::map <eQMIService, cGobiQMICore::sServerInfo>::iterator pSvrIter;
+   pSvrIter = mServers.find( (eQMIService)svcID );
+   if (pSvrIter == mServers.end())
+   {
+      mLastError = eGOBI_ERR_NO_CONNECTION;
+      return mLastError;
+   }
+
+   sServerInfo & si = pSvrIter->second;
+   cQMIProtocolServer * pSvr = si.mpServer;
+   if (pSvr == 0)
+   {
+      return eGOBI_ERR_INTERNAL;
+   }
+
+   if (si.mRequestID == 0xffffffff)
+   {
+      return eGOBI_ERR_NO_CANCELABLE_OP;
+   }
+
+   bool bRemove = pSvr->RemoveRequest( si.mRequestID );
+   if (bRemove == false)
+   {
+      return eGOBI_ERR_CANCEL_OP;
+   }
+
+   if (pTXID != 0)
+   {
+      *pTXID = si.mRequestTXID;
+   }
+
+   return eGOBI_ERR_NONE;
+}
+
+
+
diff --git a/gobi-api/GobiAPI_2012-09-12-0719/Shared/GobiQMICore.h b/gobi-api/GobiAPI_2012-09-12-0719/Shared/GobiQMICore.h
new file mode 100755
index 0000000..5a20c0e
--- /dev/null
+++ b/gobi-api/GobiAPI_2012-09-12-0719/Shared/GobiQMICore.h
@@ -0,0 +1,192 @@
+/*===========================================================================
+FILE: 
+   GobiQMICore.h
+
+DESCRIPTION:
+   QUALCOMM Gobi QMI Based API Core
+
+PUBLIC CLASSES AND FUNCTIONS:
+   cGobiQMICore
+
+Copyright (c) 2012, Code Aurora Forum. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form 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.
+    * Neither the name of Code Aurora Forum nor
+      the names of its contributors may be used to endorse or promote
+      products derived from this software without specific prior written
+      permission.
+
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+==========================================================================*/
+
+/*=========================================================================*/
+// Pragmas
+/*=========================================================================*/
+#pragma once
+
+//---------------------------------------------------------------------------
+// Include Files
+//---------------------------------------------------------------------------
+#include "ProtocolBuffer.h"
+#include "QMIProtocolServer.h"
+#include "SyncQueue.h"
+#include "GobiError.h"
+
+/*=========================================================================*/
+// Class cGobiQMICore
+/*=========================================================================*/
+class cGobiQMICore
+{
+   public:
+      // Constructor
+      cGobiQMICore();
+
+      // Destructor
+      virtual ~cGobiQMICore();
+
+      // Initialize the object
+      virtual bool Initialize();
+
+      // Cleanup the object
+      virtual bool Cleanup();
+
+      // (Inline) Return the server as determined by the service type
+      cQMIProtocolServer * GetServer( eQMIService svc )
+      {
+         cQMIProtocolServer * pSvr = 0;
+
+         std::map <eQMIService, sServerInfo>::const_iterator pIter;
+         pIter = mServers.find( svc );
+
+         if (pIter != mServers.end())
+         {
+            const sServerInfo & si = pIter->second;
+            pSvr = si.mpServer;
+         }
+
+         return pSvr;
+      };
+
+      // (Inline) Clear last error recorded
+      void ClearLastError()
+      {
+         mLastError = eGOBI_ERR_NONE;
+      };
+
+      // (Inline) Get last error recorded
+      eGobiError GetLastError()
+      {
+         return mLastError;
+      };
+
+      // (Inline) Return the last recorded error (if this happens to indicate 
+      // that no error occurred then return eGOBI_ERR_INTERNAL)
+      eGobiError GetCorrectedLastError()
+      {
+         eGobiError ec = GetLastError();
+         if (ec == eGOBI_ERR_NONE)
+         {
+            ec = eGOBI_ERR_INTERNAL;
+         }
+
+         return ec;
+      };
+
+      // (Inline) Return the correct QMI error (if this happens to indicate 
+      // that no error occurred then return the mapped eQMI_ERR_INTERNAL 
+      // value)
+      eGobiError GetCorrectedQMIError( ULONG qmiErrorCode )
+      {
+         ULONG ec = (ULONG)eQMI_ERR_INTERNAL + (ULONG)eGOBI_ERR_QMI_OFFSET;
+         if (qmiErrorCode != (ULONG)eQMI_ERR_NONE)
+         {
+            ec = qmiErrorCode + (ULONG)eGOBI_ERR_QMI_OFFSET;
+         }
+
+         return (eGobiError)ec;
+      };
+
+      // Connect to the specified Gobi device interface
+      virtual std::set <eQMIService> Connect( 
+         LPCSTR                     pInterface,
+         std::set <eQMIService> &   services );
+
+      // Disconnect from the currently connected device interface
+      virtual bool Disconnect();
+
+      // Send a request using the specified QMI protocol server and wait 
+      // for (and then return) the response
+      eGobiError Send(
+         ULONG                      svcID,
+         ULONG                      msgID,
+         ULONG                      to,
+         ULONG                      inLen,
+         const BYTE *               pIn,
+         ULONG *                    pOutLen,
+         BYTE *                     pOut );
+
+      // Cancel the most recent in-progress Send() based operation
+      eGobiError CancelSend( 
+         ULONG                      svcID,
+         ULONG *                    pTXID );
+
+   protected:
+      /* Device interface */
+      CHAR mInterface[MAX_PATH];
+
+      /* QMI protocol server/protocol server log count */
+      struct sServerInfo
+      {
+         public:
+            // Constructor (default)
+            sServerInfo()
+               :  mpServer( 0 ),
+                  mLogsProcessed( 0 ),
+                  mRequestID( 0xffffffff ),
+                  mRequestTXID( 0xffffffff )
+            { };
+
+            // Constructor (parameterized)
+            sServerInfo( cQMIProtocolServer * pServer )
+               :  mpServer( pServer ),
+                  mLogsProcessed( 0 ),
+                  mRequestID( 0xffffffff ),
+                  mRequestTXID( 0xffffffff )
+            { };
+
+            /* Protocol server */
+            cQMIProtocolServer * mpServer;
+
+            /* Protocol server logs processed */
+            ULONG mLogsProcessed;
+
+            /* Last scheduled request ID */
+            ULONG mRequestID;
+
+            /* Last schedule request QMI transaction ID */
+            ULONG mRequestTXID;
+      };
+
+      /* QMI protocol servers */
+      std::map <eQMIService, sServerInfo> mServers;
+
+      /* Last error recorded */
+      eGobiError mLastError;
+};