Ftdi::Context Class Reference

FTDI device context. Represents single FTDI device context. More...

#include <ftdi.hpp>

List of all members.

Public Types

enum  Direction { Input, Output }
 Direction flags for flush(). More...
enum  ModemCtl { Dtr, Rts }
 Modem control flags. More...

Public Member Functions

 Context ()
 Constructor.
 ~Context ()
 Destructor.
Eepromeeprom ()
const std::string & vendor ()
const std::string & description ()
const std::string & serial ()
bool is_open ()
int open (struct usb_device *dev=0)
int open (int vendor, int product, const std::string &description=std::string(), const std::string &serial=std::string())
int close ()
int reset ()
int flush (int mask=Input|Output)
int set_interface (enum ftdi_interface interface)
void set_usb_device (struct usb_dev_handle *dev)
int set_baud_rate (int baudrate)
int set_line_property (enum ftdi_bits_type bits, enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity)
int set_line_property (enum ftdi_bits_type bits, enum ftdi_stopbits_type sbit, enum ftdi_parity_type parity, enum ftdi_break_type break_type)
int read (unsigned char *buf, int size)
int write (unsigned char *buf, int size)
int set_read_chunk_size (unsigned int chunksize)
int set_write_chunk_size (unsigned int chunksize)
int read_chunk_size ()
int write_chunk_size ()
int set_event_char (unsigned char eventch, unsigned char enable)
int set_error_char (unsigned char errorch, unsigned char enable)
int set_flow_control (int flowctrl)
int set_modem_control (int mask=Dtr|Rts)
int set_latency (unsigned char latency)
int set_dtr (bool state)
int set_rts (bool state)
unsigned short poll_modem_status ()
unsigned latency ()
int set_bitmode (unsigned char bitmask, unsigned char mode)
int bitbang_enable (unsigned char bitmask)
int bitbang_disable ()
int read_pins (unsigned char *pins)
char * error_string ()

Protected Member Functions

int get_strings ()
struct ftdi_contextcontext ()
void set_context (struct ftdi_context *context)
void set_usb_device (struct usb_device *dev)

Friends

class Eeprom
class List

Classes

class  Private


Detailed Description

FTDI device context. Represents single FTDI device context.

Definition at line 47 of file ftdi.hpp.


Member Enumeration Documentation

Direction flags for flush().

Enumerator:
Input 
Output 

Definition at line 56 of file ftdi.hpp.

Modem control flags.

Enumerator:
Dtr 
Rts 

Definition at line 64 of file ftdi.hpp.


Constructor & Destructor Documentation

Ftdi::Context::Context (  ) 

Constructor.

Definition at line 64 of file ftdi.cpp.

Ftdi::Context::~Context (  ) 

Destructor.

Definition at line 71 of file ftdi.cpp.


Member Function Documentation

Eeprom* Ftdi::Context::eeprom (  ) 

const std::string & Ftdi::Context::vendor (  ) 

Definition at line 311 of file ftdi.cpp.

Referenced by get_strings().

const std::string & Ftdi::Context::description (  ) 

Definition at line 316 of file ftdi.cpp.

const std::string & Ftdi::Context::serial (  ) 

Definition at line 321 of file ftdi.cpp.

Referenced by get_strings().

bool Ftdi::Context::is_open (  ) 

Definition at line 75 of file ftdi.cpp.

int Ftdi::Context::open ( struct usb_device *  dev = 0  ) 

Definition at line 103 of file ftdi.cpp.

References ftdi_usb_open_dev(), and get_strings().

int Ftdi::Context::open ( int  vendor,
int  product,
const std::string &  description = std::string(),
const std::string &  serial = std::string() 
)

Definition at line 80 of file ftdi.cpp.

References ftdi_usb_open(), ftdi_usb_open_desc(), ftdi_usb_open_dev(), and get_strings().

int Ftdi::Context::close (  ) 

Definition at line 121 of file ftdi.cpp.

References ftdi_usb_close().

int Ftdi::Context::reset (  ) 

Definition at line 127 of file ftdi.cpp.

References ftdi_usb_reset().

int Ftdi::Context::flush ( int  mask = Input|Output  ) 

Definition at line 132 of file ftdi.cpp.

References ftdi_usb_purge_rx_buffer(), ftdi_usb_purge_tx_buffer(), Input, and Output.

int Ftdi::Context::set_interface ( enum ftdi_interface  interface  ) 

Definition at line 144 of file ftdi.cpp.

References ftdi_set_interface().

void Ftdi::Context::set_usb_device ( struct usb_dev_handle dev  ) 

Definition at line 149 of file ftdi.cpp.

References ftdi_set_usbdev().

Referenced by Ftdi::List::List().

int Ftdi::Context::set_baud_rate ( int  baudrate  ) 

Definition at line 155 of file ftdi.cpp.

References ftdi_set_baudrate().

int Ftdi::Context::set_line_property ( enum ftdi_bits_type  bits,
enum ftdi_stopbits_type  sbit,
enum ftdi_parity_type  parity 
)

Definition at line 160 of file ftdi.cpp.

References ftdi_set_line_property().

int Ftdi::Context::set_line_property ( enum ftdi_bits_type  bits,
enum ftdi_stopbits_type  sbit,
enum ftdi_parity_type  parity,
enum ftdi_break_type  break_type 
)

Definition at line 165 of file ftdi.cpp.

References ftdi_set_line_property2().

int Ftdi::Context::read ( unsigned char *  buf,
int  size 
)

Definition at line 170 of file ftdi.cpp.

References ftdi_read_data().

int Ftdi::Context::write ( unsigned char *  buf,
int  size 
)

Definition at line 189 of file ftdi.cpp.

References ftdi_write_data().

int Ftdi::Context::set_read_chunk_size ( unsigned int  chunksize  ) 

Definition at line 175 of file ftdi.cpp.

References ftdi_read_data_set_chunksize().

int Ftdi::Context::set_write_chunk_size ( unsigned int  chunksize  ) 

Definition at line 194 of file ftdi.cpp.

References ftdi_write_data_set_chunksize().

int Ftdi::Context::read_chunk_size (  ) 

Definition at line 180 of file ftdi.cpp.

References ftdi_read_data_get_chunksize().

int Ftdi::Context::write_chunk_size (  ) 

Definition at line 199 of file ftdi.cpp.

References ftdi_write_data_get_chunksize().

int Ftdi::Context::set_event_char ( unsigned char  eventch,
unsigned char  enable 
)

Definition at line 254 of file ftdi.cpp.

References ftdi_set_event_char().

int Ftdi::Context::set_error_char ( unsigned char  errorch,
unsigned char  enable 
)

Definition at line 259 of file ftdi.cpp.

References ftdi_set_error_char().

int Ftdi::Context::set_flow_control ( int  flowctrl  ) 

Definition at line 208 of file ftdi.cpp.

References ftdi_setflowctrl().

int Ftdi::Context::set_modem_control ( int  mask = Dtr|Rts  ) 

Definition at line 213 of file ftdi.cpp.

References Dtr, ftdi_setdtr_rts(), and Rts.

int Ftdi::Context::set_latency ( unsigned char  latency  ) 

Definition at line 235 of file ftdi.cpp.

References ftdi_set_latency_timer().

int Ftdi::Context::set_dtr ( bool  state  ) 

Definition at line 225 of file ftdi.cpp.

References ftdi_setdtr().

int Ftdi::Context::set_rts ( bool  state  ) 

Definition at line 230 of file ftdi.cpp.

References ftdi_setrts().

unsigned short Ftdi::Context::poll_modem_status (  ) 

Definition at line 247 of file ftdi.cpp.

References ftdi_poll_modem_status().

unsigned Ftdi::Context::latency (  ) 

Definition at line 240 of file ftdi.cpp.

References ftdi_get_latency_timer().

int Ftdi::Context::set_bitmode ( unsigned char  bitmask,
unsigned char  mode 
)

Definition at line 274 of file ftdi.cpp.

References ftdi_set_bitmode().

int Ftdi::Context::bitbang_enable ( unsigned char  bitmask  ) 

Definition at line 264 of file ftdi.cpp.

References ftdi_enable_bitbang().

int Ftdi::Context::bitbang_disable (  ) 

Definition at line 269 of file ftdi.cpp.

References ftdi_disable_bitbang().

int Ftdi::Context::read_pins ( unsigned char *  pins  ) 

Definition at line 279 of file ftdi.cpp.

References ftdi_read_pins().

char * Ftdi::Context::error_string (  ) 

Definition at line 284 of file ftdi.cpp.

References ftdi_get_error_string().

int Ftdi::Context::get_strings (  )  [protected]

Definition at line 289 of file ftdi.cpp.

References ftdi_usb_get_strings(), serial(), and vendor().

Referenced by Ftdi::List::List(), and open().

struct ftdi_context * Ftdi::Context::context (  )  [read, protected]

Definition at line 337 of file ftdi.cpp.

Referenced by Ftdi::Eeprom::Eeprom().

void Ftdi::Context::set_context ( struct ftdi_context context  )  [protected]

Definition at line 326 of file ftdi.cpp.

References ftdi_free().

void Ftdi::Context::set_usb_device ( struct usb_device *  dev  )  [protected]

Definition at line 332 of file ftdi.cpp.


Friends And Related Function Documentation

friend class Eeprom [friend]

Definition at line 50 of file ftdi.hpp.

friend class List [friend]

Definition at line 51 of file ftdi.hpp.


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

Generated on Mon Nov 1 20:35:38 2010 for libftdi by  doxygen 1.5.6