This is the user documentation for the flink userspace library in C. It provides a device and bus independent interface to the underlying driver modules. For more information about the inner workings see flink Userspace Library on Github. The API of the library can be found under API

When flink is used on a Linux based system the flink userspace library offers an simple interface to communicate with the underlying kernel modules. The userspace library is split in two parts.

• High-Level API: Interface to predefined subdevices, such as PWM or GPIO.
• Low-Level API: Can be used to access user-defined subdevices.

The library must be built for the target platform architecture.

• Linux based operating system
• GCC 4.6 or newer
• CMake 2.8 or newer
• GNU make

1. Clone git repository:

   git clone https://github.com/flink-project/flinklib.git

2. Create a build directory:

   mkdir build-local

3. Change to the build directory and setup your build environment with CMake:

   cmake ..

   Optional: you can specify an installation prefix path with

   cmake DCMAKE_INSTALL_PREFIX:PATH=/usr/local/ ..

4. Build the source code:

   make

5. Install the library and header files on your system:

   make install

1. Clone git repository:

   git clone https://github.com/flink-project/flinklib.git

2. Create a build directory for the target platform, e.g.:

   mkdir build-powerpc

3. Create a CMake toolchain file. For more informations, please have a look at the CMake Wiki. This file has to specify which compiler has to be used and where it can be found on the system.
4. Change to the build directory and setup your build environment with CMake:

   cmake -DCMAKE_TOOLCHAIN_FILE:PATH=/path/to/your/toolchain/file.cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr/powerpc-linux-gnu/ ..

5. Build the source code:

   make

6. Install the library and header files on your system:

   make install

• Move new kernel modules into the default location to /lib/modules/version of the target plattform.
• Load each module with insmod, e.g.

  insmod flink.ko

• If dependency files were created beforehand its better to use

  modprobe flink.ko

• Some kernel module must be loaded with the appropriate arguments according to the target board specifications (see below)