developer.intra2net.com Git - libftdi/blob - README

   1 --------------------------------------------------------------------
   2 libftdi version 1.6rc1
   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 * New ftdi_set_module_detach_mode() API function
  24 * ftdi_eeprom / eeprom handling:
  25   * Fix checksum calculation for FT230X series
  26   * Support readout of "user_data_addr" value
  27   * Remove legacy EEPROM fields from FT4232H
  28   * Don't set EEPROM serial when it's not used
  29   * ftdi_eeprom_initdefaults() now takes const arguments
  30   * Don't spam stderr when flashing FT232H eeprom
  31   * EEPROM decoder: Show C/D channel mode for FT4232, B channel mode for FT2232C
  32 * CMake build system:
  33   * Bump minimal required version to 3.15
  34   * Fix building as a subproject
  35   * Add SHAREDLIBS option
  36   * Fix multiarch support
  37   * Rework findlibusb module
  38   * Fix static build with libusb and -latomic
  39   * Modernize Boost detection for the unit tests when using CMake 3.30+
  40 * Python wrapper:
  41   * Update for SWIG 4.3
  42   * Rework Python interpreter and development files detection
  43   * Fix race during build of python bindings causing random build failures
  44   * Move from distutils to sysconfig
  45 * C++ wrapper: Use std::unique_ptr, get rid of the Boost dependency
  46 * MSVC/Windows build fixes:
  47   * Fix building static library on Windows/MSVC
  48   * Fix shadowed variable warnings
  49   * Fix warnings by using all enum values in case statements
  50   * Quiet uninteresting warnings
  51 * Various bug fixes and code improvements:
  52   * Fix uninitialized variable warning in ftdi_read_eeprom_location()
  53   * Fix GCC fall-through warnings
  54   * Fix ftdi_readstream() timeout setting
  55   * Don't error out when optional strings are missing
  56 * Add .editorconfig file for consistent code style
  57 * Ignore various IDE temp files (JetBrains, VSCode, clangd)
  58 * License clarifications:
  59   * Fix wrong LGPL version in the "LICENSE" readme:
  60     * Clarify main libftdi library is LGPL v2.1 only
  61     * Clarify ftdi_eeprom is GPL v2 only
  62   * SPDX license tags added in 2019 were already correct
  63   * Update COPYING.LIB to LGPL v2.1 after clarifications
  64
  65 You'll find the newest version of libftdi at:
  66 https://www.intra2net.com/en/developer/libftdi
  67
  68
  69 Quick start
  70 -----------
  71 mkdir build
  72 cd build
  73
  74 cmake -DCMAKE_INSTALL_PREFIX="/usr" ../
  75 make
  76 make install
  77
  78 More verbose build instructions are in "README.build"
  79
  80 --------------------------------------------------------------------
  81 www.intra2net.com                             2003-2026 Intra2net AG
  82 --------------------------------------------------------------------