SerialPortImplWin32.h

Go to the documentation of this file.

/****************** <VPR heading BEGIN do not edit this line> *****************
 *
 * VR Juggler Portable Runtime
 *
 * Original Authors:
 *   Allen Bierbaum, Patrick Hartling, Kevin Meinert, Carolina Cruz-Neira
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile$
 * Date modified: $Date: 2006-02-16 11:24:44 -0600 (Thu, 16 Feb 2006) $
 * Version:       $Revision: 18429 $
 * -----------------------------------------------------------------
 *
 ****************** <VPR heading END do not edit this line> ******************/

/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * VR Juggler is (C) Copyright 1998-2005 by Iowa State University
 *
 * Original Authors:
 *   Allen Bierbaum, Christopher Just,
 *   Patrick Hartling, Kevin Meinert,
 *   Carolina Cruz-Neira, Albert Baker
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/

#ifndef _VPR_SERIAL_PORT_IMPL_WIN32_H_
#define _VPR_SERIAL_PORT_IMPL_WIN32_H_

#include <vpr/vprConfig.h>

#include <iostream>
#include <stdio.h>
#include <string>
#include <vector>

#include <vpr/IO/IOSys.h>
#include <vpr/IO/Port/SerialTypes.h>
#include <vpr/Util/ReturnStatus.h>
#include <vpr/Util/Interval.h>
#include <vpr/Util/Debug.h>


namespace vpr
{

class VPR_CLASS_API SerialPortImplWin32
{
public:
   SerialPortImplWin32(const std::string& portName);

   ~SerialPortImplWin32();

   // ========================================================================
   // vpr::BlockIO basics.
   // ========================================================================

   const std::string& getName() const
   {
      return mName;
   }

   void setOpenReadOnly()
   {
      mOpenFlag = GENERIC_READ;
   }

   void setOpenWriteOnly()
   {
      mOpenFlag = GENERIC_WRITE;
   }

   void setOpenReadWrite()
   {
      mOpenFlag = GENERIC_READ | GENERIC_WRITE;
   }

   vpr::ReturnStatus open();

   vpr::ReturnStatus close();

   vpr::ReturnStatus setBlocking(bool flag);

   bool isBlocking() const
   {
      return ! (mBlocking & FILE_FLAG_OVERLAPPED);
   }

   vpr::IOSys::Handle getHandle() const
   {
#ifdef VPR_USE_NSPR
      vprDEBUG(vprDBG_ALL, vprDBG_CRITICAL_LVL)
         << "ERROR: Cannot get handle for Win32 file descriptor with NSPR!\n";
      return vpr::IOSys::NullHandle;
#else
      return mHandle;
#endif
   }

   bool isReadOnly() const
   {
      return GENERIC_READ == mOpenFlag;
   }

   bool isWriteOnly() const
   {
      return GENERIC_WRITE == mOpenFlag;
   }

   bool isReadWrite() const
   {
      return(GENERIC_READ | GENERIC_WRITE) == mOpenFlag;
   }

   // ========================================================================
   // VPR serial port interface implementation.
   // ========================================================================

   vpr::SerialTypes::UpdateActionOption getUpdateAction() const;

   void setUpdateAction(vpr::SerialTypes::UpdateActionOption action);

   vpr::ReturnStatus clearAll();

   vpr::ReturnStatus getMinInputSize(vpr::Uint16& size) const;

   vpr::ReturnStatus setMinInputSize(const vpr::Uint8 size);

   vpr::ReturnStatus getTimeout(vpr::Uint8& timeout) const;

   vpr::ReturnStatus setTimeout(const vpr::Uint8 timeout);

   vpr::ReturnStatus getCharacterSize(vpr::SerialTypes::CharacterSizeOption& size) const;

   vpr::ReturnStatus setCharacterSize(const vpr::SerialTypes::CharacterSizeOption bpb);

   bool getReadState() const
   {
      return true;
   }

   vpr::ReturnStatus setRead(bool flag)
   {
      return vpr::ReturnStatus();
   }

   bool getLocalAttachState() const;

   vpr::ReturnStatus setLocalAttach(bool flag);

   bool getBreakByteIgnoreState() const;

   vpr::ReturnStatus setBreakByteIgnore(bool flag);

   vpr::ReturnStatus getStopBits(vpr::Uint8& numBits) const;

   vpr::ReturnStatus setStopBits(const vpr::Uint8 numBits);

   bool getCanonicalState() const;

   vpr::ReturnStatus setCanonicalInput(bool flag);

   bool getBadByteIgnoreState() const;

   vpr::ReturnStatus setBadByteIgnore(bool flag);

   bool getInputParityCheckState() const;

   vpr::ReturnStatus setInputParityCheck(bool flag);

   bool getBitStripState() const;

   vpr::ReturnStatus setBitStripping(bool flag);

   bool getStartStopInputState() const;

   vpr::ReturnStatus setStartStopInput(bool flag);

   bool getStartStopOutputState() const;

   vpr::ReturnStatus setStartStopOutput(bool flag);

   bool getParityGenerationState() const;

   vpr::ReturnStatus setParityGeneration(bool flag);

   bool getParityErrorMarkingState() const;

   vpr::ReturnStatus setParityErrorMarking(bool flag);

   SerialTypes::ParityType getParity() const;

   vpr::ReturnStatus setParity(const SerialTypes::ParityType& type);

   vpr::ReturnStatus getInputBaudRate(vpr::Uint32& rate) const;

   vpr::ReturnStatus setInputBaudRate(const vpr::Uint32& rate);

   vpr::ReturnStatus getOutputBaudRate(vpr::Uint32& rate) const;

   vpr::ReturnStatus setOutputBaudRate(const vpr::Uint32& rate);

   vpr::ReturnStatus drainOutput();

   vpr::ReturnStatus controlFlow(vpr::SerialTypes::FlowActionOption opt);

   bool getHardwareFlowControlState() const;

   vpr::ReturnStatus setHardwareFlowControl(bool flag);

   vpr::ReturnStatus flushQueue(vpr::SerialTypes::FlushQueueOption queue);

   vpr::ReturnStatus sendBreak(const vpr::Int32 duration);

   int getCarrierDetect() const
   {
      return -1;
   }

   int getDataSetReady() const
   {
      return -1;
   }

   int getClearToSend() const
   {
      return -1;
   }

   int getRingIndicator() const
   {
      return -1;
   }

   vpr::ReturnStatus setDataTerminalReady(bool val);

   vpr::ReturnStatus setRequestToSend(bool val);

   vpr::ReturnStatus read_i(void* buffer, const vpr::Uint32 length,
                            vpr::Uint32& bytesRead,
                            const vpr::Interval timeout = vpr::Interval::NoTimeout);

   vpr::ReturnStatus readn_i(void* buffer, const vpr::Uint32 length,
                             vpr::Uint32& bytesRead,
                             const vpr::Interval timeout = vpr::Interval::NoTimeout);

   vpr::ReturnStatus write_i(const void* buffer, const vpr::Uint32 length,
                             vpr::Uint32& bytesWritten,
                             const vpr::Interval timeout = vpr::Interval::NoTimeout);

protected:
   HANDLE mHandle;     
   DWORD mOpenFlag;    
   std::string mName;  
   bool mOpen;
   DWORD mBlocking;    
   bool mParityMark;   
   vpr::Uint8 mCurrentTimeout;
};

} // End of vpr namespace


#endif  /* _VPR_SERIAL_PORT_IMPL_WIN32_H_ */

---