Merge branch 'prepare-release' v1.5rc1
authorThomas Jarosch <thomas.jarosch@intra2net.com>
Tue, 9 Jun 2020 21:19:34 +0000 (23:19 +0200)
committerThomas Jarosch <thomas.jarosch@intra2net.com>
Tue, 9 Jun 2020 21:19:34 +0000 (23:19 +0200)
AUTHORS
CMakeLists.txt
ChangeLog
README
doc/release-checklist.txt
ftdi_eeprom/main.c
ftdipp/ftdi.cpp
ftdipp/ftdi.hpp
src/ftdi.c
src/ftdi.h
src/ftdi_i.h

diff --git a/AUTHORS b/AUTHORS
index ed4bb84..e8f5a69 100644 (file)
--- a/AUTHORS
+++ b/AUTHORS
@@ -7,8 +7,8 @@ see Changelog for full details:
 
   Adam Malinowski <amalinowski75@gmail.com>
   Alain Abbas <aa@libertech.fr>
-  Alexander Lehmann <lehmanna@in.tum.de>
   Alex Harford <harford@gmail.com>
+  Alexander Lehmann <lehmanna@in.tum.de>
   Anders Larsen <al@alarsen.net>
   Andrei Errapart <a.errapart@trenz-electronic.de>
   Andrew John Rogers <andrew@rogerstech.co.uk>
@@ -17,19 +17,26 @@ see Changelog for full details:
   Benjamin Vanheuverzwijn <bvanheu@gmail.com>
   Chris Morgan <chmorgan@gmail.com>
   Chris Zeh <chris.w.zeh@gmail.com>
+  Claudio Lanconelli <claudiolanconelli@gmail.com>
   Clifford Wolf <clifford@clifford.at>
+  Dan Dedrick <dan.dedrick@gmail.com>
   Daniel Kirkham <dk2@kirkham.id.au>
   David Challis <dchallis@qsimaging.com>
   Davide Michelizza <dmichelizza@gmail.com>
   Denis Sirotkin <reg.libftdi@demitel.ru>
+  Diego Elio Pettenò <flameeyes@flameeyes.com>
   Emil <emil@datel.co.uk>
-  Eric Schott <eric@morningjoy.com>
+  Eneas U de Queiroz <cote2004-github@yahoo.com>
+  Eric Schott <els6@psu.edu>
   Eugene Hutorny <eugene@hutorny.in.ua>
   Evan Nemerson <evan@coeus-group.com>
   Evgeny Sinelnikov <sin@geoft.ru>
+  Fabrice Fontaine <fontaine.fabrice@gmail.com>
   Fahrzin Hemmati <fahhem@gmail.com>
   Flynn Marquardt <ftdi@flynnux.de>
   Forest Crossman <cyrozap@gmail.com>
+  Frank Dana <ferdnyc@gmail.com>
+  Holger Mößinger <h.moessinger@primes.de>
   Ian Abbott <abbotti@mev.co.uk>
   Jared Boone <jared@sharebrained.com>
   Jarkko Sonninen <kasper@iki.fi>
@@ -37,6 +44,7 @@ see Changelog for full details:
   Jochen Sprickerhof <jochen@sprickerhof.de>
   Joe Zbiciak <intvnut@gmail.com>
   Jon Beniston <jon@beniston.com>
+  Jordan Rupprecht <rupprecht@google.com>
   Juergen Beisert <juergen.beisert@weihenstephan.org>
   Lorenz Moesenlechner <lorenz@hcilab.org>
   Marek Vavruša <marek@vavrusa.com>
@@ -57,12 +65,14 @@ see Changelog for full details:
   Pawel Jewstafjew <pawel.jewstafjew@gmail.com>
   Peter Holik <peter@holik.at>
   Raphael Assenat <raph@8d.com>
+  Richard Shaw <hobbes1069@gmail.com>
   Robby McKilliam <robby.mckilliam@myriota.com>
   Robert Cox <Robert.cox@novatechweb.com>
   Robin Haberkorn <haberkorn@metratec.com>
   Rodney Sinclair <rodney@sinclairrf.com>
   Rogier Wolff <R.E.Wolff@harddisk-recovery.nl>
   Rolf Fiedler <derRolf@gmx-topmail.de>
+  Roman Lapin <lampus.lapin@gmail.com>
   Salvador Eduardo Tropea <salvador@inti.gob.ar>
   Stephan Linz <linz@li-pro.net>
   Steven Turner <steven.turner@ftdichip.com>
index 7771e80..9f209d0 100644 (file)
@@ -1,9 +1,9 @@
 # Project
 project(libftdi1 C)
 set(MAJOR_VERSION 1)
-set(MINOR_VERSION 4)
+set(MINOR_VERSION 5)
 set(PACKAGE libftdi1)
-set(VERSION_STRING ${MAJOR_VERSION}.${MINOR_VERSION})
+set(VERSION_STRING ${MAJOR_VERSION}.${MINOR_VERSION}rc1)
 set(VERSION ${VERSION_STRING})
 set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake)
 
index 4c48fea..eaf2c5a 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,6 +1,31 @@
-New in 1.x - 2018-xx-xx
+New in 1.5rc1 - 2020-06-xx
 -----------------------
-* Added ftdi_setflowctrl_xonxoff()
+* Implement tc[io]flush methods & deprecate broken purge_buffers methods
+
+  Please check your code for ftdi_usb_purge_rx_buffer(),
+  ftdi_usb_purge_tx_buffer() and ftdi_usb_purge_buffers()
+  and migrate to the new ftdi_tc[io]flush() methods.
+
+  Old code will continue to function, but you'll get
+  a deprecation warning during compilation.
+
+* Add program to test buffer flush (purge) functionality
+* Add kernel driver auto attach/detach.
+  See new AUTO_DETACH_REATACH_SIO_MODULE option
+* Add ftdi_setflowctrl_xonxoff()
+* ftdi_eeprom / eeprom handling:
+  * Unify handling of all boolean eeprom flags
+  * Add device release number support
+  * Add channel_a_driver support for type xxR chips
+  * Add support for group0 drive levels on x232H chips
+  * Fix handling of high_current_drive parameter
+  * Fix inverted handling of VCP driver field for TYPE_R chips
+  * New --verbose option for eeprom decode operation
+* Add example code for async mode
+* Add SPDX license identifiers to the core library & ftdi_eeprom
+* Various python SWIG wrapper improvements
+* Various cmake file improvements
+* Fix small bugs in error code paths
 
 New in 1.4 - 2017-08-07
 -----------------------
diff --git a/README b/README
index 072b671..aa6a974 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
 --------------------------------------------------------------------
-libftdi version 1.4
+libftdi version 1.5rc
 --------------------------------------------------------------------
 
 libftdi - A library (using libusb) to talk to FTDI's UART/FIFO chips
@@ -20,17 +20,32 @@ that made libftdi possible what it is today.
 
 Changes
 -------
-* New ftdi_usb_open_bus_addr() open function
-* Use BM/R series baud rate computation for FT230X
-* ftdi_get_error_string() now returns const char*
-* C++ API: Ability to open devices with empty descriptor strings
-* C++ API: Fix enumerations for buffer purge and modem controls
-* small build fixes and improvements in the python examples
+* Implement tc[io]flush methods & deprecate broken purge_buffers methods
+
+  Please check your code for ftdi_usb_purge_rx_buffer(),
+  ftdi_usb_purge_tx_buffer() and ftdi_usb_purge_buffers()
+  and migrate to the new ftdi_tc[io]flush() methods.
+
+  Old code will continue to function, but you'll get
+  a deprecation warning during compilation.
+
+* Add program to test buffer flush (purge) functionality
+* Add kernel driver auto attach/detach.
+  See new AUTO_DETACH_REATACH_SIO_MODULE option
+* Add ftdi_setflowctrl_xonxoff()
 * ftdi_eeprom / eeprom handling:
-  * New API function: ftdi_eeprom_get_strings()
-  * Fix USE_SERIAL handling for 230X type chips
-  * Make ftdi_read_eeprom_location() endianness independent
-  * Fix flashing of FT245R
+  * Unify handling of all boolean eeprom flags
+  * Add device release number support
+  * Add channel_a_driver support for type xxR chips
+  * Add support for group0 drive levels on x232H chips
+  * Fix handling of high_current_drive parameter
+  * Fix inverted handling of VCP driver field for TYPE_R chips
+  * New --verbose option for eeprom decode operation
+* Add example code for async mode
+* Add SPDX license identifiers to the core library & ftdi_eeprom
+* Various python SWIG wrapper improvements
+* Various cmake file improvements
+* Fix small bugs in error code paths
 
 You'll find the newest version of libftdi at:
 https://www.intra2net.com/en/developer/libftdi
@@ -48,5 +63,5 @@ make install
 More verbose build instructions are in "README.build"
 
 --------------------------------------------------------------------
-www.intra2net.com                             2003-2017 Intra2net AG
+www.intra2net.com                             2003-2020 Intra2net AG
 --------------------------------------------------------------------
index 347a5a6..f620a53 100644 (file)
@@ -1,6 +1,9 @@
 *** Checklist for a new libftdi release ***
-- Update ChangeLog and AUTHORS via git history
-  (git log --oneline latest_release..HEAD)
+- Update ChangeLog via git history:
+  git log --oneline latest_release..HEAD
+
+- Update AUTHORS via git history:
+  git log --pretty=format:"%an <%ae>" latest_release..HEAD |sort -u
 
 - Update version number in the following files:
   - CMakeLists.txt
@@ -13,7 +16,8 @@
 
 - Ensure all modifications are checked in
 
-- Sign tarball
+- Sign tarball:
+  gpg2 --default-key opensource@intra2net.com --detach-sign --sign libftdi1-1.XX.tar.bz2
 
 - Create git tag:
   - git tag -s -u 24F006F5 v1.XX
index 7ba8d89..e3a09ba 100644 (file)
@@ -2,7 +2,7 @@
                              main.c  -  description
                            -------------------
     begin                : Mon Apr  7 12:05:22 CEST 2003
-    copyright            : (C) 2003-2014 by Intra2net AG and the libftdi developers
+    copyright            : (C) 2003-2020 by Intra2net AG and the libftdi developers
     email                : opensource@intra2net.com
     SPDX-License-Identifier: GPL-2.0-only
  ***************************************************************************/
index f82b865..afb84fb 100644 (file)
@@ -2,7 +2,7 @@
                           ftdi.cpp  -  C++ wrapper for libftdi
                              -------------------
     begin                : Mon Oct 13 2008
-    copyright            : (C) 2008-2017 by Marek Vavruša / libftdi developers
+    copyright            : (C) 2008-2020 by Marek Vavruša / libftdi developers
     email                : opensource@intra2net.com and marek@vavrusa.com
  ***************************************************************************/
 /*
index a5ede3c..f569cce 100644 (file)
@@ -2,7 +2,7 @@
                           ftdi.hpp  -  C++ wrapper for libftdi
                              -------------------
     begin                : Mon Oct 13 2008
-    copyright            : (C) 2008-2017 by Marek Vavruša and libftdi developers
+    copyright            : (C) 2008-2020 by Marek Vavruša and libftdi developers
     email                : opensource@intra2net.com and marek@vavrusa.com
  ***************************************************************************/
 /*
index d527d6f..f5b7018 100644 (file)
@@ -2,7 +2,7 @@
                           ftdi.c  -  description
                              -------------------
     begin                : Fri Apr 4 2003
-    copyright            : (C) 2003-2017 by Intra2net AG and the libftdi developers
+    copyright            : (C) 2003-2020 by Intra2net AG and the libftdi developers
     email                : opensource@intra2net.com
     SPDX-License-Identifier: LGPL-2.1-only
  ***************************************************************************/
index 7addeb9..fb45008 100644 (file)
@@ -2,7 +2,7 @@
                           ftdi.h  -  description
                              -------------------
     begin                : Fri Apr 4 2003
-    copyright            : (C) 2003-2017 by Intra2net AG and the libftdi developers
+    copyright            : (C) 2003-2020 by Intra2net AG and the libftdi developers
     email                : opensource@intra2net.com
     SPDX-License-Identifier: LGPL-2.1-only
  ***************************************************************************/
index 1bc740d..5d04120 100644 (file)
@@ -2,7 +2,7 @@
                           ftdi_i.h  -  description
                              -------------------
     begin                : Don Sep 9 2011
-    copyright            : (C) 2003-2017 by Intra2net AG and the libftdi developers
+    copyright            : (C) 2003-2020 by Intra2net AG and the libftdi developers
     email                : opensource@intra2net.com
     SPDX-License-Identifier: LGPL-2.1-only
  ***************************************************************************/