Ftdi_Context

Langue: en

Autres versions - même langue

Version: 158090 (fedora - 05/07/09)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

Ftdi::Context - FTDI device context. Represents single FTDI device context.

SYNOPSIS


#include <ftdi.hpp>

Data Structures


class Private

Public Types


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

Public Member Functions


Context ()
Constructor.
~Context ()
Destructor.
Eeprom * eeprom ()

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_context * context ()

void set_context (struct ftdi_context *context)

void set_usb_device (struct usb_device *dev)

Friends


class Eeprom

class List

Detailed Description

FTDI device context. Represents single FTDI device context.

Member Enumeration Documentation

enum Ftdi::Context::Direction

Direction flags for flush().

Enumerator:

Input
Output

enum Ftdi::Context::ModemCtl

Modem control flags.

Enumerator:

Dtr
Rts

Constructor & Destructor Documentation

Ftdi::Context::Context ()

Constructor.

Ftdi::Context::~Context ()

Destructor.

Member Function Documentation

Eeprom* Ftdi::Context::eeprom ()

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

Referenced by get_strings().

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

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

Referenced by get_strings().

bool Ftdi::Context::is_open ()

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

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())

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

int Ftdi::Context::close ()

References ftdi_usb_close().

int Ftdi::Context::reset ()

References ftdi_usb_reset().

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

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

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

References ftdi_set_interface().

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

References ftdi_set_usbdev().

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

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

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)

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)

References ftdi_set_line_property2().

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

References ftdi_read_data().

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

References ftdi_write_data().

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

References ftdi_read_data_set_chunksize().

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

References ftdi_write_data_set_chunksize().

int Ftdi::Context::read_chunk_size ()

References ftdi_read_data_get_chunksize().

int Ftdi::Context::write_chunk_size ()

References ftdi_write_data_get_chunksize().

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

References ftdi_set_event_char().

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

References ftdi_set_error_char().

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

References ftdi_setflowctrl().

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

References Dtr, ftdi_setdtr_rts(), and Rts.

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

References ftdi_set_latency_timer().

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

References ftdi_setdtr().

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

References ftdi_setrts().

unsigned short Ftdi::Context::poll_modem_status ()

References ftdi_poll_modem_status().

unsigned Ftdi::Context::latency ()

References ftdi_get_latency_timer().

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

References ftdi_set_bitmode().

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

References ftdi_enable_bitbang().

int Ftdi::Context::bitbang_disable ()

References ftdi_disable_bitbang().

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

References ftdi_read_pins().

char * Ftdi::Context::error_string ()

References ftdi_get_error_string().

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

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

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

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

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

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

References ftdi_free().

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

friend class Eeprom [friend]

friend class List [friend]

Author

Generated automatically by Doxygen for libftdi from the source code.