libftdi: (tomj) Improved error handling (Evgeny Sinelnikov)
[libftdi] / ftdi / ftdi.h
... / ...
CommitLineData
1/***************************************************************************
2 ftdi.h - description
3 -------------------
4 begin : Fri Apr 4 2003
5 copyright : (C) 2003 by Intra2net AG
6 email : opensource@intra2net.com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU Lesser General Public License *
13 * version 2.1 as published by the Free Software Foundation; *
14 * *
15 ***************************************************************************/
16
17#ifndef __libftdi_h__
18#define __libftdi_h__
19
20#include <usb.h>
21
22enum ftdi_chip_type { TYPE_AM=0, TYPE_BM=1, TYPE_2232C=2 };
23
24struct ftdi_context {
25 // USB specific
26 struct usb_dev_handle *usb_dev;
27 int usb_read_timeout;
28 int usb_write_timeout;
29
30 // FTDI specific
31 enum ftdi_chip_type type;
32 int baudrate;
33 unsigned char bitbang_enabled;
34 unsigned char *readbuffer;
35 unsigned int readbuffer_offset;
36 unsigned int readbuffer_remaining;
37 unsigned int readbuffer_chunksize;
38 unsigned int writebuffer_chunksize;
39
40 // FTDI FT2232C requirecments
41 int interface; // 0 or 1
42 int index; // 1 or 2
43 // Endpoints
44 int in_ep;
45 int out_ep; // 1 or 2
46
47 /* 1: (default) Normal bitbang mode, 2: FT2232C SPI bitbang mode */
48 unsigned char bitbang_mode;
49
50 // misc
51 char *error_str;
52};
53
54struct ftdi_eeprom {
55 int vendor_id;
56 int product_id;
57
58 int self_powered;
59 int remote_wakeup;
60 int BM_type_chip;
61
62 int in_is_isochronous;
63 int out_is_isochronous;
64 int suspend_pull_downs;
65
66 int use_serial;
67 int change_usb_version;
68 int usb_version;
69 int max_power;
70
71 char *manufacturer;
72 char *product;
73 char *serial;
74};
75
76#ifdef __cplusplus
77extern "C" {
78#endif
79
80 int ftdi_init(struct ftdi_context *ftdi);
81 void ftdi_deinit(struct ftdi_context *ftdi);
82 void ftdi_set_usbdev (struct ftdi_context *ftdi, usb_dev_handle *usbdev);
83 int ftdi_usb_open(struct ftdi_context *ftdi, int vendor, int product);
84 int ftdi_usb_close(struct ftdi_context *ftdi);
85 int ftdi_usb_reset(struct ftdi_context *ftdi);
86 int ftdi_usb_purge_buffers(struct ftdi_context *ftdi);
87
88 int ftdi_set_baudrate(struct ftdi_context *ftdi, int baudrate);
89
90 int ftdi_read_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
91 int ftdi_read_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
92 int ftdi_read_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
93
94 int ftdi_write_data(struct ftdi_context *ftdi, unsigned char *buf, int size);
95 int ftdi_write_data_set_chunksize(struct ftdi_context *ftdi, unsigned int chunksize);
96 int ftdi_write_data_get_chunksize(struct ftdi_context *ftdi, unsigned int *chunksize);
97
98 int ftdi_enable_bitbang(struct ftdi_context *ftdi, unsigned char bitmask);
99 int ftdi_disable_bitbang(struct ftdi_context *ftdi);
100 int ftdi_read_pins(struct ftdi_context *ftdi, unsigned char *pins);
101
102 int ftdi_set_latency_timer(struct ftdi_context *ftdi, unsigned char latency);
103 int ftdi_get_latency_timer(struct ftdi_context *ftdi, unsigned char *latency);
104
105 // init and build eeprom from ftdi_eeprom structure
106 void ftdi_eeprom_initdefaults(struct ftdi_eeprom *eeprom);
107 int ftdi_eeprom_build(struct ftdi_eeprom *eeprom, unsigned char *output);
108
109 // "eeprom" needs to be valid 128 byte eeprom (generated by the eeprom generator)
110 // the checksum of the eeprom is valided
111 int ftdi_read_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
112 int ftdi_write_eeprom(struct ftdi_context *ftdi, unsigned char *eeprom);
113 int ftdi_erase_eeprom(struct ftdi_context *ftdi);
114
115#ifdef __cplusplus
116}
117#endif
118
119#endif /* __libftdi_h__ */