Big PR on keeping libmpsse alive

.gitignore

@@ -0,0 +1,47 @@
+*.sw?
+*.o
+*.a
+*.so
+*.lo
+*.la
+src/Makefile
+src/autom4te.cache
+src/config.h
+src/config.log
+src/config.status
+src/configure
+src/mpsse_wrap.c
+src/pylibmpsse.py
+
+src/examples/bitbang
+src/examples/ds1305
+src/examples/gpio
+src/examples/i2ceeprom
+src/examples/spiflash
+src/examples/spiflashfast
+
+.deps*
+.libs*
+Makefile
+Makefile.in
+aclocal.m4
+ar-lib
+autoscan.log
+build
+build/*
+compile
+config.guess
+config.sub
+configure.scan
+depcomp
+install-sh
+libtool
+ltmain.sh
+m4
+m4/*
+missing
+mpsse_wrap_python.c
+py-compile
+pyswig_*.c
+config.h.in
+stamp-h1

.travis.yml

@@ -0,0 +1,9 @@
+language: c
+compiler:
+  - gcc
+  - clang
+before_install:
+  - sudo apt-get update -qq
+  - sudo apt-get install -qq libftdi-dev swig
+script:
+  - cd src && autoreconf --install && ./configure && scan-build make

README.md

@@ -1,4 +1,86 @@
-libmpsse
-========
+# ABOUT
+
+[![Build Status](https://travis-ci.org/l29ah/libmpsse.svg?branch=master)](https://travis-ci.org/l29ah/libmpsse)
+
+Libmpsse is a library for interfacing with SPI/I2C devices via FTDI's FT-2232 family of USB to serial
+chips. Additionally, it provides control over the GPIO pins on the FTDI chips and supports a raw
+bitbang mode as well. Based around the libftdi library, it is written in C and includes a Python wrapper 
+courtesy of swig.
+
+See [INSTALL](docs/INSTALL) for the installation instructions.
+
+# LIBRARY API
+
+In version 1.0 libmpsse was modified to support multiple simultaneous FTDI chips inside a single process,
+which required a change to the API. Thus, the API for libmpsse versions prior to 1.0 are not compatible with 
+the API for versions 1.0 and later.
+
+The C and Python APIs are very similar, although the Python API has been made more "pythonic". Specifically,
+in Python:
+
+1. MPSSE is the name of the Python class, not of a method or function as it is in C. The class 
+   constructor takes the same arguments as the MPSSE function in C. If you wish to instead use 
+   the Open method to open a given device, simply do not specify these arguments when calling 
+   the class constructor.
+
+2. Due to its object-oriented nature, each class instance in Python internally handles the MPSSE
+   context pointer; thus, none of the Python methods in the MPSSE class require this argument.
+
+3. Size parameters required by the C functions are not used by the corresponding Python methods.
+
+4. Besides the above described differences, all Python methods have a 1:1 compatibility with their
+   respective C functions. However, in Python the class constructor (MPSSE) and Open method have 
+   sensible defaults for several of their arguments so not all arguments are required. 
+
+See the [README.C](docs/README.C) and [README.PYTHON.html](docs/README.PYTHON.html) files for more details.
+
+# CODE EXAMPLES
+
+There are SPI and I2C code examples for both C and Python in the `src/examples` directory. After installing
+libmpsse, the C examples can be built by running:
+
+    $ make example-code
+
+There are more detailed descriptions of the SPI and I2C APIs in [README.SPI](docs/README.SPI) and [README.I2C](docs/README.I2C) files.
+
+# BUILDING APPLICATIONS
+
+To build applications in Python, you must import the `mpsse` module:
+
+    from mpsse import *
+
+To build applications in C, you must include the `mpsse.h` header file:
+
+    #include <mpsse.h>
+
+...and also link your program against the *libmpsse* library:
+
+    $ gcc test.c -o test -lmpsse
+
+# PHYSICAL CONNECTIONS
+
+In order to speak to SPI or I2C devices, you must establish the proper physical connections between the target
+device and your FTDI chip. The exact pin out of your target device and FTDI chip will differ based on the chips
+in question, and the appropriate data sheets for each device should be referenced for this information.
+
+Included in the docs directory is the FTDI MPSSE Basics application note (AN 135). Section 2 of this document
+covers all of the pin configurations for each FTDI chip, as well as example diagrams regarding the physical
+connections between the FTDI chip and your target device.
+
+# KNOWN BUGS
+
+The following are known bugs in libmpsse:
+
+-   In SPI, the Transfer method fails if transfering large data chunks. Use the Read/Write functions 
+    for transferring large chunks of data (~1MB or more).
+
+# KNOWN LIMITATIONS
+
+Libmpsse supports all four SPI modes as well as I2C. However, due to the design of the FTDI MPSSE implementation,
+there are some limitations:
+
+- All protocols support master mode only.
+- SPI modes 1 and 3 are only partially supported; see the README.SPI for more information.
+- In I2C, the SCL and SDA pins are open drain, but the MPSSE implementation explicitly drives these lines high.
+  Although this is usually fine, it means that some I2C features, such as clock stretching, are not supported.
 
-Open source library for SPI/I2C control via FTDI chips

docs/INSTALL

@@ -3,17 +3,17 @@ PREREQUISITES
 	Libmpsse is currently supported on the Linux and OSX platforms.
 
 	Libmpsse requires swig as well as the libftdi and python development packages. 
-	These can typically be installed by your Linux distro's package manager, such as:
+	These can typically be installed by your Linux distro's package manager, for Debian:
 
-		# apt-get install swig libftdi-dev python-dev
+		# apt-get install swig libftdi-dev python-dev autoconf automake libtool
 
-	For OSX, you will likely need to at least install libftdi from source. Note that
-	libftdi also requires the libusb-0.1 (not libusb-1.0) library.
+	For OSX, you will likely need to at least install libftdi from source.
 
 INSTALLATION
 
 	With the required prerequisites installed, libmpsse can be built and installed:
 
+		$ autoreconf --install
 		$ ./configure
 		$ make
 		# make install
@@ -23,12 +23,11 @@ INSTALLATION
 	may set the following environment variables:
 
 		SWIG   - Path to the swig binary
-		PYDEV  - Path to the python include directory where the python header files are located
-		PYLIB  - Path to the python library directory where python modules should be installed
+		PYTHON - Path to the python binary
 
 	Example:
 
-		$ PYDEV=/usr/local/include/python2.6/ ./configure
+		$ PYTHON=/usr/bin/python3 ./configure
 		$ make
 		# make install
 

src/Makefile.am

@@ -0,0 +1,47 @@
+SUBDIRS = . examples
+
+AM_CFLAGS = -Wall -Wextra -fPIC -fno-strict-aliasing -g -O2 $(CFLAGS)
+AM_CPPFLAGS = $(PYTHON_INCLUDE) $(CPPFLAGS)
+
+ACLOCAL_AMFLAGS = -I m4
+
+if BUILD_PYTHON_WRAPPERS
+PYTHON_MPSSE_LA = libMpssePython.la
+PYLIBMPSSE = pylibmpsse.py
+CREATE_LINK = $(LN_S) ${prefix}/lib/libMpssePython.so.0.0.0 ${pythondir}/_pylibmpsse.so
+else !BUILD_PYTHON_WRAPPERS
+PYTHON_MPSSE_LA =
+PYLIBMPSSE =
+CREATE_LINK = true
+endif !BUILD_PYTHON_WRAPPERS
+
+lib_LTLIBRARIES = libmpsse.la $(PYTHON_MPSSE_LA)
+libmpsse_la_SOURCES = mpsse.c support.c fast.c
+
+include_HEADERS = mpsse.h
+
+EXTRA_DIST = mpsse.i
+python_PYTHON = mpsse.py $(PYLIBMPSSE)
+
+libMpssePython_la_SOURCES = mpsse_wrap_python.c pyswig_mpsse.c pyswig_support.c
+BUILT_SOURCES = pyswig_support.c pyswig_mpsse.c
+CLEANFILES = pyswig_mpsse.c pyswig_support.c mpsse_wrap_python.c
+libMpssePython_la_CPPFLAGS = -DSWIGPYTHON $(AM_CPPFLAGS)
+
+mpsse_wrap_python.c: mpsse.i
+	$(SWIG) -python -o $@ $<
+
+pyswig_mpsse.c: mpsse.c
+	cp -f $< $@
+
+pyswig_support.c: support.c
+	cp -f $< $@
+
+if BUILD_PYTHON_WRAPPERS
+install-exec-hook:
+	-rm ${pythondir}/_pylibmpsse.so
+	$(CREATE_LINK)
+
+uninstall-hook:
+	-rm ${pythondir}/_pylibmpsse.so
+endif BUILD_PYTHON_WRAPPERS