CMake: bump the minimal required version to 3.5
[libftdi] / README
1 --------------------------------------------------------------------
2 libftdi version 1.5
3 --------------------------------------------------------------------
4
5 libftdi - A library (using libusb) to talk to FTDI's UART/FIFO chips
6 including the popular bitbang mode.
7
8 The following chips are supported:
9 * FT230X
10 - FT4232H / FT2232H
11 - FT232R  / FT245R
12 - FT2232L / FT2232D / FT2232C
13 - FT232BM / FT245BM (and the BL/BQ variants)
14 - FT8U232AM / FT8U245AM
15
16 libftdi requires libusb 1.x.
17
18 The AUTHORS file contains a list of all the people
19 that made libftdi possible what it is today.
20
21 Changes
22 -------
23 * Implement tc[io]flush methods & deprecate broken purge_buffers methods
24
25   Please check your code for ftdi_usb_purge_rx_buffer(),
26   ftdi_usb_purge_tx_buffer() and ftdi_usb_purge_buffers()
27   and migrate to the new ftdi_tc[io]flush() methods.
28
29   Old code will continue to function, but you'll get
30   a deprecation warning during compilation.
31
32 * Add program to test buffer flush (purge) functionality
33 * Add kernel driver auto attach/detach.
34   See new AUTO_DETACH_REATACH_SIO_MODULE option
35 * Add ftdi_setflowctrl_xonxoff()
36 * ftdi_eeprom / eeprom handling:
37   * Unify handling of all boolean eeprom flags
38   * Add device release number support
39   * Add channel_a_driver support for type xxR chips
40   * Add support for group0 drive levels on x232H chips
41   * Fix handling of high_current_drive parameter
42   * Fix inverted handling of VCP driver field for TYPE_R chips
43   * New --verbose option for eeprom decode operation
44 * Add example code for async mode
45 * Add SPDX license identifiers to the core library & ftdi_eeprom
46 * Various python SWIG wrapper improvements
47 * Various cmake file improvements
48 * Fix small bugs in error code paths
49
50 You'll find the newest version of libftdi at:
51 https://www.intra2net.com/en/developer/libftdi
52
53
54 Quick start
55 -----------
56 mkdir build
57 cd build
58
59 cmake -DCMAKE_INSTALL_PREFIX="/usr" ../
60 make
61 make install
62
63 More verbose build instructions are in "README.build"
64
65 --------------------------------------------------------------------
66 www.intra2net.com                             2003-2020 Intra2net AG
67 --------------------------------------------------------------------