python: update for SWIG 4.3

SWIG 4.3 comes with an API change to the SWIG_Python_AppendOutput()
function, so switch to the recommended SWIG_AppendOutput() instead.
Because the new function is a macro in fact also switch to the  {..}
delimiters as the code needs to be preprocessed. The change is
compatible with the previous SWIG releases 4.2 and 4.1 at least.

Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=2319133
Related: https://github.com/swig/swig/pull/2907

CMakeLists.txt: remove obsolete policies

Both CMP0011 and CMP0057 are covered by setting the CMake minimum
version to 3.5.

CMake: bump the minimal required version to 3.5

Older CMake versions are treated as deprecated.

python: move from distutils to sysconfig

The distutils module was deprecated in Python 3.10, and will be removed
in 3.12 [1], thus switch to the sysconfig module instead.

[1] https://peps.python.org/pep-0632/

CMake: use ${PC_LIBUSB_LIBRARIES} instead of a library name

Patch taken from the Debian package:
https://sources.debian.org/src/libftdi1/1.5-6/debian/patches/02-kfreebsd.diff/

CMake: fix multiarch support

Let CMake determine the exact library destination path.

Patch taken from the Debian package:
https://sources.debian.org/src/libftdi1/1.5-6/debian/patches/01-cmake-multiarch.diff/

CMake: make the project compatible with building as a subproject

Use CMAKE_CURRENT_*_DIR in the main CMakeLists.txt and PROJECT_*_DIR
in the subdirectories.

ftdipp/CMakeLists.txt: remove VIM modline settings

Indentation settings will be handled via the EditorConfig project.

CMake: rework subdirectory handling

Move all mandatory subdirs to the top and also make if clauses more
readable.

CMake: rework findlibusb module

Rename the module to FindLibUSB.cmake and use it as the only way
of finding libusb.

Bonus: perform CMake linting of the module.

CMake: report CMake version

CMake: use dedicated recipe for documentation generation

Use PROJECT_SOURCE_DIR and PROJECT_BINARY_DIR to refer to the top
source directory.

CMake: disable deprecated behavior

Set policies CMP0011, CMP0057, CMP0099 to the new behavior. Since
version 3.27.4 if the policy is not set to the new behavior, CMake
will generate a warning.

Doxygen: resolve warnings

Remove obsolete values like MSCGEN_PATH, TCL_SUBST, etc. from the
configuration file. All these options used the default values, hence
it is safe to remove them.

Paper type a4wide doesn't exist, so use a4.

CMake: rework documentation creation section

Add comments and also make the if ( DOCUMENTATION ) section more
readable.

CMake: require 2.8.12 for cmake_example

Make CMake minimal version requirement consistent for the entire
project.

examples/eeprom.c: use AUTO_DETACH_REATACH_SIO_MODULE

This way, the device's state remains unchanged after the
eeprom invocation.

Bonus: remove trailing white spaces.

CMake: fix indentation and normalize braces

ftdi_readstream: fix timeout setting

Divide the whole seconds into tv_sec, and the remaining microseconds into tv_usec.

Signed-off-by: Matthias Klein <matthias@extraklein.de>

Introduce ftdi_set_module_detach_mode()

Added a public setter to allow the usage of the
AUTO_DETACH_REATACH_SIO_MODULE feature added in
5bf1c1e3ff1616fda20c26cc3e3df7b807744c99.

EEPROM: make user_data_addr value readable

Before this change, the user_data_addr could be only written
but not read.

FT2232C: show mode for B channel

Idea by Yegor Yefremov. Thanks!

FT4232: show mode for both C and D channels

Align is_not_pnp property

As seen when written with FTD2XX.

examples: eeprom: add the missing newlines

EEPROM: mention FT230X in the dynamic content calculation

EEPROM: fix checksum for FT230X series

ftdi_eeprom_build() computes the checksum via reading the "Factory
Configuration Data" region. ftdi_eeprom_decode() computes the checksum
only on the EEPROM buffer. Hence, both checksums differ.

Add the info from "Factory Configuration Data" to the EEPROM buffer.

Add .editorconfig for C and CMake files

Fix typos and harmonize spaces

CMake: bump the minimal required version to 2.8.12

The older CMake versions are deprecated.

Remove support for CMake code compatible with CMake older than 2.8.8.

Also move cmake_minimum_required() command before the project()
command invocation.

Fix race during build of python bindings

The CMake documentation says about add_custom_command that the output must
not be used as dependency in more than one target, but this was the case
here: Both the doc_i target and the SWIG target depended on ftdi1_doc.i.
Make the SWIG target depend on doc_i instead.

This fixes that ftdi1_doc.i was built twice with parallel builds, leading
to random errors.

Signed-off-by: Fabian Vogt <fvogt@suse.de>

CMakeLists.txt: fix static build with libusb and -latomic

Use pkg-config to retrieve libusb dependencies such as -latomic and
avoid the following static build failure:

/nvmedata/autobuild/instance-29/output-1/per-package/libftdi1/host/bin/../lib/gcc/sparc-buildroot-linux-uclibc/10.3.0/../../../../sparc-buildroot-linux-uclibc/bin/ld: /nvmedata/autobuild/instance-29/output-1/per-package/libftdi1/host/sparc-buildroot-linux-uclibc/sysroot/lib/libusb-1.0.a(core.o): in function `libusb_unref_device':
/nvmedata/autobuild/instance-29/output-1/build/libusb-1.0.25/libusb/core.c:1186: undefined reference to `__atomic_fetch_add_4'

Fixes:
 - http://autobuild.buildroot.org/results/1ca7cd85ae60ad4797a6d8a83b2fb51d7eab96d9

Signed-off-by: Fabrice Fontaine <fontaine.fabrice@gmail.com>

Fix indentation

Add Tomasz Wasilczyk to AUTHORS

Don't set EEPROM serial when it's not used.

This makes a difference in USB enumeration -- if serial is missing,
its string is not present in string descriptor list.

Remove legacy EEPROM fields from FT4232H.

These are not present when flashed with FT_Prog tool.

Don't fail reading missing strings.

This happens i.e. when serial number is not set -- in such case the
string is missing from string descriptor list.

ftdi_eeprom_initdefaults const arguments

This function don't need to modify its arguments.

Don't spam stderr when flashing FT232H eeprom

examples/bitbang_cbus.c: Check return value of fgets()

Fix building unit tests without FTDIPP

Needed to run the baudrate unit tests.

Probably another fallout from:

****************************
commit 0209a3633dc877a577af07d883eb5059e22f6a91

cmake: do not check for g++ when FTDIPP is disabled
****************************

Fix GCC fall-through warnings.

When compiling ftdi.c in the context of blackmagic debug, more enabled
warnings and -Werror made me to add appended fixes.

Fixing the signedness of baudrate would probably be more logically by
making all baudrate and clk unsigned, but would need more code changes.
I decided to make clk signed as a fix with minimal
impact. The FTDI chips are far away from 2 GHz clock rate...

Ignore purge_test example build for MinGW

termios.h is not available on MinGW.

CMakeLists.txt: fix paths when FTDIPP is set

Use the same project name (i.e. libftdi1 and not libftdipp1) when FTDIPP
is enabled as suggested by Aurelien Jarno in
http://developer.intra2net.com/mailarchive/html/libftdi/2020/msg00044.html

Without this change, the libftdi1.pc config file defines the include
path as /usr/local/include/libftdipp1 while the ftdi.h file is actually
installed in /usr/local/include/libftdi1

This is an issue for example for libsigrok which will fail on:

In file included from src/hardware/asix-sigma/protocol.c:27:
src/hardware/asix-sigma/protocol.h:28:10: fatal error: ftdi.h: No such file or directory
   28 | #include <ftdi.h>
      |          ^~~~~~~~

Fixes:
 - http://autobuild.buildroot.org/results/1427f44e36752c337791597fab47a1889552a2fe

Signed-off-by: Fabrice Fontaine <fontaine.fabrice@gmail.com>

Release libftdi 1.5 final

Merge branch 'prepare-release'

Set version number to 1.5rc1

Prepare changelog for 1.5rc1

Increase copyright year to 2020

Update AUTHORS file

Update release checklist

Remove outdated rpm .spec file template

The distro source packages are much more useful than this.

Grepped source tree for ".spec" and "rpm",
hopefully I caught all occurrences.

Update Autotools Mythbuster link to avoid multiple redirects.

While I'm hoping to maintain the chain of redirects for the foreseeable
future, it makes sense to point at the final URL now that Autotools
Mythuster has had its domain for a long while.

Signed-off-by: Diego Elio Pettenò <flameeyes@flameeyes.com>

ftdi_eeprom_build(): Fix inverted handling of VCP driver field for TYPE_R chips

From doc/EEPROM-structure:

    On TYPE_R 00.3 set means D2XX, on other devices VCP

-> invert the field for TYPE_R so "eeprom->channel_a_driver"
   set to 1 always means VCP driver for all chips.

eeprom handling: Unify handling of boolean bit flags

Boolean bit flags should be zero or one in memory,
not the actual eeprom value FTDI assigned to them.

Example of the code change in ftdi_eeprom_build():

ftdi_eeprom_build():
-            if (eeprom->suspend_dbus7 == SUSPEND_DBUS7_BIT)
+            if (eeprom->suspend_dbus7)

The changes should not break any backward compatibility
in ftdi_build_eeprom().

The function ftdi_decode_eeprom() will return slightly different values
for boolean fields, but callers should test using "if (flag_enabled)"
instead of "if (flag_enabled == specific_value)" anyway.

Test done: Decoded eeprom of a FT232 serial cable stayed the same.
$ diff -u dump-old.txt dump-new.txt
-> no change

ftdi_eeprom: Add device release number support

In process of firmware repairing of some FTDI-chip based device I have
found that I can't get binary identical EEPROM dumps from properly
working device and ftdi_eeprom --build_eeprom command because of
ftdi_eeprom does not support changing of device release number (byte
with addr 0x06).

[TJ: Keep old behavior if release_number is not set in the config file]

Ignore patch files

ftdi_eeprom: Minor cosmetic fix on usage screen

ftdi_eeprom: Add more detailed example.conf file

eeprom: Fix handling of high_current_drive parameter

Additionally fix it up for type R chips.

eeprom: Add channel_a_driver support for type xxR chips

Make ftdi_eeprom more verbose by adding verbose option

[TJ: Replaced tabs with spaces]

Ignore tags file

Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com>

cmake: do not check for g++ when FTDIPP is disabled

Signed-off-by: Samuel Martin <s.martin49@gmail.com>
[Retrieved (and slightly updated) from:
https://git.buildroot.net/buildroot/tree/package/libftdi1/0003-cmake-do-not-check-for-g-when-FTDIPP-is-disabled.patch]
Signed-off-by: Fabrice Fontaine <fontaine.fabrice@gmail.com>

Fix typos

Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com>

libftdi: pass eeprom strings as const

These strings are not modified and it doesn't make sense that they ever
would be. Setting these as const ensures that they will not be modified
and allows const strings to be passed in without special manipulation.

Specifically a call like the following failed to compile:
ftdi_eeprom_set_strings(&ftdi, "foo", "bar", "abc123");

The error will look something like this:
error: ISO C++ forbids converting a string constant to ‘char*’
[-Werror=write-strings]

CMake: reorder Python detection

PythonInterp should be detected before PythonLibs otherwise
CMake exits with the following message:

Could NOT find PythonLibs (missing: PYTHON_LIBRARIES PYTHON_INCLUDE_DIRS)

Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com>

Fix build dependency if swig wrapper and documentation is both switched on

Seems to affect new cmake / swig versions only.

Reported by Richard Shaw <hobbes1069@gmail.com> during Fedora Rawhide build:

Ok, so far looks like I was right, you have to set the dependency on
ftdi1_doc.i before calling swig_add_library or it doesn't get it right:

[ 11%] Swig compile ftdi1.i for python
/usr/bin/doxygen /builddir/build/BUILD/libftdi-f49ee0d/build-py2/Doxyfile
cd /builddir/build/BUILD/libftdi-f49ee0d/build-py2/python && /usr/bin/cmake
-E make_directory /builddir/build/BUILD/libftdi-f49ee0d/build-py2/python
/builddir/build/BUILD/libftdi-f49ee0d/build-py2/python/CMakeFiles/_ftdi1.dir
/usr/bin/doxygen
/builddir/build/BUILD/libftdi-f49ee0d/build-py2/Doxyfile.xml
cd /builddir/build/BUILD/libftdi-f49ee0d/build-py2/python && /usr/bin/cmake
-E touch
/builddir/build/BUILD/libftdi-f49ee0d/build-py2/python/CMakeFiles/_ftdi1.dir/ftdi1PYTHON.stamp
cd /builddir/build/BUILD/libftdi-f49ee0d/build-py2/python && /usr/bin/cmake
-E env SWIG_LIB=/usr/share/swig/3.0.12 /usr/bin/swig -python -DDOXYGEN=YES
-outdir /builddir/build/BUILD/libftdi-f49ee0d/build-py2/python
-I/builddir/build/BUILD/libftdi-f49ee0d/src -I/usr/include/libusb-1.0
-I/usr/include/python2.7 -o
/builddir/build/BUILD/libftdi-f49ee0d/build-py2/python/CMakeFiles/_ftdi1.dir/ftdi1PYTHON_wrap.c
/builddir/build/BUILD/libftdi-f49ee0d/python/ftdi1.i
/builddir/build/BUILD/libftdi-f49ee0d/python/ftdi1.i:7: Error: Unable to
find 'ftdi1_doc.i'
make[2]: *** [python/CMakeFiles/ftdi1_swig_compilation.dir/build.make:67:
python/CMakeFiles/_ftdi1.dir/ftdi1PYTHON.stamp] Error 1

Simplify CMake policy guard

Signed-off-by: FeRD (Frank Dana) <ferdnyc@gmail.com>

CMake/Swig updates for python wrapper

libftdi was FTBFS[1] in Fedora Rawhide after a GCC 9.0.X mass rebuild but
the problem turned out to be behavior changes[2] in CMake with regards to
SWIG[3].

The UseSWIG module in cmake 3.13+ will now use standard target names and not
generate the SWIG_MODULE_<target>_REAL_NAME variable.

Replace the deprecated swig_add_module with swig_add_library.

[Refinements from Intra2net:
- Use swig_add_library for cmake 3.8+ only
- Add cmake version guard for the new CMP0078 policy
- Use "NOT CMAKE_VERSION VERSION_LESS" construct to
  support cmake versions below 3.7.0]

[1] https://bugzilla.redhat.com/show_bug.cgi?id=1675275
[2] https://cmake.org/cmake/help/latest/policy/CMP0078.html?highlight=cmp0078
[3] https://cmake.org/cmake/help/latest/module/UseSWIG.html

Add SPDX identifiers to the core library and ftdi_eeprom tool

Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com>

swig: improve indentation

Fixes -Wmisleading-indentation warnings.

ftdi_eeprom: Add support for group0 drive levels on x232H chips

swig: python: fix unresolved symbol issue

GCC later than 5.x produce _fdti1.so file with an undefined
symbol str2charp_size due to C99 inline semantics change. So
remove this keyword.

Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com>

python/CMakeLists.txt: fix build with cmake < 3.7

VERSION_GREATER_EQUAL has been added only in cmake 3.7:
https://cmake.org/cmake/help/v3.7/release/3.7.html

So replace this statement by NOT CMAKE_VERSION VERSION_LESS

Fixes:
 - http://autobuild.buildroot.org/results/1091872e2b77d789e361d1ddefd235c738933c55

Signed-off-by: Fabrice Fontaine <fontaine.fabrice@gmail.com>

Remove more example programs during rpm build

Add program to test flush (purge) functionality.

Improve Doxygen output for #defines in header files.

Implement tc[io]flush methods & deprecate broken purge_buffers methods.

The definitions for the SIO_RESET_PURGE_RX or SIO_RESET_PURGE_TX values are
with respect to the FTDI chip, not the CPU.  That is, when the FTDI chip
receives a USB control transfer request with the command SIO_RESET_PURGE_RX,
the FTDI chip empties the FIFO containing data received from the CPU awaiting
transfer out the serial port to the connected serial device (e.g., a modem).
Likewise, upon reception of the SIO_RESET_PURGE_TX command, the FTDI chip
empties the FIFO of data received from the attached serial device destined to
be transmitted to the CPU.

Unfortunately the coding of the previous releases of libfti assumed these
commands had the opposite effect. This resulted in the function
ftdi_usb_purge_tx_buffer clearing data received from the attached serial
device.  Similarly, the function ftdi_usb_purge_rx_buffer cleared the FTDI
FIFO containing data to be transmitted to the attached serial device.  More
seriously, this latter function clear the libftid's internal buffer of data
received from the serial device, destined to the application program.

This patch adds the ftdi_tciflush, ftdi_tcoflush, and ftdi_tcioflush functions
which emulate the Linux serial port tcflush(3) function.

Use a separate Py_ssize_t var instead of casting an int pointer as a Py_ssize_t pointer.

Casting is fine if Py_ssize_t == int, but not when Py_ssize_t == long.

Signed-off-by: Jordan Rupprecht <rupprecht@google.com>

CMake: use find_package (SWIG) for cmake >= 3.0.0

There's a workaround for a bug (fixed in cmake 3.0.0) that does not
work in CMake 3.12.  Only use the workaround with cmake < 3.0.0.

Signed-off-by: Eneas U de Queiroz <cote2004-github@yahoo.com>

Improve new async read/write example

examples/async.c : Short example using async read/write

Bring back ftdi_eeprom by default

CMake: move options to a dedicated file

Also disable all options having extra dependencies.

If an option is selected makes its dependencies as REQUIRED.

Signed-off-by: Yegor Yefremov <yegorslists@googlemail.com>

Add Robby McKilliam to AUTHORS

Add kernel driver auto attach/detach

Introduce new detach mode:
AUTO_DETACH_REATACH_SIO_MODULE

Tested on linux (Ubuntu 16.04 and Raspbian Stretch) with an FT230.

Access ftdi->max_packet_size after checking ftdi context != NULL

Reported via email by Mr. Alex Tvema.

Start ChangeLog for next version

Add Pawel Jewstafjew to AUTHORS

fix support for XON/XOFF flow control

Fix ftdi_stream.c compilation on WIN32

Fix small memleak when ftdi_init() fails

If libusb open fails (e.g. permission problem),
then ftdi_init() leaks the memory for the eeprom data.

Increase version to 1.4 final

follow-up on c++ open() fix. fixes logic in open() with long argument list.

Sync README with ChangeLog

Increase version to 1.4rc2

C++ API: Increase .so library version

We have an ABI break in this release (get_strings_and_reopen() changes),
so programs using the C++ wrapper need to be recompiled.

Add Eric Schott to AUTHORS, update ChangeLog

C++ API: Correct the purge Direction and ModemCtl enumerations definitions

Do not use value of zero for bitmasks. The new enumeration values
are defined so programs compiled with the old ftdi.hpp include
would work as previously (doing nothing when the enumeration
with the zero value was bit-or'ed into the argument).