IUsb Class Reference

Interface class for usb io. More...

#include <IUsb.h>

Inheritance diagram for IUsb:

Collaboration diagram for IUsb:

Public Member Functions
virtual	~IUsb ()
virtual uint16_t	ReadReg (uint16_t FpgaReg)=0
virtual void	WriteReg (uint16_t FpgaReg, const uint16_t FpgaData)=0
virtual void	GetVendorInfo (uint16_t &VendorId, uint16_t &ProductId, uint16_t &DeviceId)=0
virtual void	SetupSingleImgXfer (uint16_t Rows, uint32_t Cols)=0
virtual void	SetupSequenceImgXfer (uint16_t Rows, uint16_t Cols, uint16_t NumOfImages)=0
virtual void	CancelImgXfer ()=0
virtual void	ReadImage (uint16_t *ImageData, const uint32_t InSizeInBytes, uint32_t &OutSizeInBytes)=0
virtual void	GetStatus (uint8_t *status, uint32_t NumBytes)=0
virtual void	UsbRequestIn (uint8_t RequestCode, uint16_t Index, uint16_t Value, uint8_t *ioBuf, uint32_t BufSzInBytes)=0
virtual void	UsbRequestOut (uint8_t RequestCode, uint16_t Index, uint16_t Value, const uint8_t *ioBuf, uint32_t BufSzInBytes)=0
virtual void	GetSerialNumber (int8_t *ioBuf, uint32_t BufSzInBytes)=0
virtual void	GetUsbFirmwareVersion (int8_t *ioBuf, uint32_t BufSzInBytes)=0
virtual std::string	GetDriverVersion ()=0
virtual bool	IsError ()=0
virtual uint16_t	GetDeviceNum ()=0
virtual void	UsbReqOutWithExtendedTimeout (uint8_t RequestCode, uint16_t Index, uint16_t Value, const uint8_t *ioBuf, uint32_t BufSzInBytes)=0
virtual void	ReadSerialPort (uint16_t PortId, uint8_t *ioBuf, uint16_t BufSzInBytes)=0

Detailed Description

Interface class for usb io.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

Copyright(c) 2009 Apogee Instruments, Inc.

Constructor & Destructor Documentation

~IUsb()

IUsb::~IUsb ( )

virtual

Member Function Documentation

CancelImgXfer()

virtual void IUsb::CancelImgXfer ( )

pure virtual

Implemented in GenTwoWinUSB, and GenOneLinuxUSB.

GetDeviceNum()

virtual uint16_t IUsb::GetDeviceNum ( )

pure virtual

Implemented in GenTwoWinUSB, and GenOneLinuxUSB.

GetDriverVersion()

virtual std::string IUsb::GetDriverVersion ( )

pure virtual

Implemented in GenTwoWinUSB, and GenOneLinuxUSB.

GetSerialNumber()

virtual void IUsb::GetSerialNumber ( int8_t *  ioBuf, uint32_t  BufSzInBytes  )

pure virtual

Implemented in GenTwoWinUSB, and GenOneLinuxUSB.

GetStatus()

virtual void IUsb::GetStatus ( uint8_t *  status, uint32_t  NumBytes  )

pure virtual

Implemented in GenTwoWinUSB, and GenOneLinuxUSB.

GetUsbFirmwareVersion()

virtual void IUsb::GetUsbFirmwareVersion ( int8_t *  ioBuf, uint32_t  BufSzInBytes  )

pure virtual

Implemented in GenTwoWinUSB, and GenOneLinuxUSB.

GetVendorInfo()

virtual void IUsb::GetVendorInfo ( uint16_t &  VendorId, uint16_t &  ProductId, uint16_t &  DeviceId  )

pure virtual

Implemented in GenTwoWinUSB, and GenOneLinuxUSB.

IsError()

virtual bool IUsb::IsError ( )

pure virtual

Implemented in GenTwoWinUSB, and GenOneLinuxUSB.

ReadImage()

virtual void IUsb::ReadImage ( uint16_t *  ImageData, const uint32_t  InSizeInBytes, uint32_t &  OutSizeInBytes  )

pure virtual

Implemented in GenTwoWinUSB, and GenOneLinuxUSB.

ReadReg()

virtual uint16_t IUsb::ReadReg ( uint16_t  FpgaReg )

pure virtual

Implemented in GenTwoWinUSB, and GenOneLinuxUSB.

ReadSerialPort()

virtual void IUsb::ReadSerialPort ( uint16_t  PortId, uint8_t *  ioBuf, uint16_t  BufSzInBytes  )

pure virtual

Implemented in GenTwoWinUSB, and GenOneLinuxUSB.

SetupSequenceImgXfer()

virtual void IUsb::SetupSequenceImgXfer ( uint16_t  Rows, uint16_t  Cols, uint16_t  NumOfImages  )

pure virtual

Implemented in GenTwoWinUSB, and GenOneLinuxUSB.

SetupSingleImgXfer()

virtual void IUsb::SetupSingleImgXfer ( uint16_t  Rows, uint32_t  Cols  )

pure virtual

Implemented in GenTwoWinUSB, and GenOneLinuxUSB.

UsbReqOutWithExtendedTimeout()

virtual void IUsb::UsbReqOutWithExtendedTimeout ( uint8_t  RequestCode, uint16_t  Index, uint16_t  Value, const uint8_t *  ioBuf, uint32_t  BufSzInBytes  )

pure virtual

Implemented in GenTwoWinUSB, and GenOneLinuxUSB.

UsbRequestIn()

virtual void IUsb::UsbRequestIn ( uint8_t  RequestCode, uint16_t  Index, uint16_t  Value, uint8_t *  ioBuf, uint32_t  BufSzInBytes  )

pure virtual

Implemented in GenTwoWinUSB, and GenOneLinuxUSB.

UsbRequestOut()

virtual void IUsb::UsbRequestOut ( uint8_t  RequestCode, uint16_t  Index, uint16_t  Value, const uint8_t *  ioBuf, uint32_t  BufSzInBytes  )

pure virtual

Implemented in GenTwoWinUSB, and GenOneLinuxUSB.

WriteReg()

virtual void IUsb::WriteReg ( uint16_t  FpgaReg, const uint16_t  FpgaData  )

pure virtual

Implemented in GenTwoWinUSB, and GenOneLinuxUSB.

---

The documentation for this class was generated from the following files:

• ln/3rdparty/src/indilib/indi-1.7.4/3rdparty/libapogee/IUsb.h
• ln/3rdparty/src/indilib/indi-1.7.4/3rdparty/libapogee/IUsb.cpp