Skip to content
Permalink
Browse files

Platform_extender: FT4222 library refactor

Updates to make the FT4222 platform extender more usable.

Previous implementation opened libft4222.so and loaded symbols as
needed.  This implementation removes dynamic loading of libft4222 in
favor of creating a new shared libary which links against libft4222.so.
The dynamic loading is now done in mraa.c.  One C method is exposed in
libmraa-platform-ft4222.so for finding/initializing an FT4222:

mraa_platform_t mraa_usb_platform_extender(mraa_board_t* board);

Mraa.c attempts to open this platform library and calls the
mraa_usb_platform_extender method.  If an ftdi4222 is connected, the
user gets added IO from the extender.  If no FT4222 device is connected,
continue as normal.

    * Create a new platform library for the FT4222
    * Expose only 1 C method from the library -
      mraa_usb_platform_extender
    * libmraa-platform-ft4222.so contains CXX code (as well as previous
      C code).  All *allocs have been removed in favor of global
      C++ stl containers.
    * Previously, the FT4222 would only initialize correctly if 2 ftdi
      devices existed.  Now, initialize FT4222 devices based on the
      device id.
    * Many fixes for various problems with the FT4222
    * Added unit test for platform extender (minimal functionality w/o hw)
    * Updated to FindFtd4222.cmake module to handle standard arguments
    * Removed CMAKE_C_FLAGS addition of -DFTDID2XX and -DFTDI4222 since
      these are NOT used anywhere in source.
    * Building the FTDI4222 shim requires libft4222.h which requires
      ftd2xx.h.  Updated CMakeLists.txt to require both when building
      the shim.

Signed-off-by: Noel Eck <noel.eck@intel.com>
  • Loading branch information...
pylbert committed Jun 1, 2018
1 parent 47728b4 commit fc4b2a554d07e566f0b404c85c30aaa4db27d537
@@ -27,11 +27,11 @@ else (LIBFTD2XX_LIBRARIES AND LIBFTD2XX_INCLUDE_DIRS)
/usr/local/include
/opt/local/include
/sw/include
)
)

SET(FTD2XX_LIBNAME ftd2xx)
IF(WIN32)
SET(FTD2XX_LIBNAME ftd2xx.lib)
SET(FTD2XX_LIBNAME ftd2xx.lib)
ENDIF(WIN32)

find_library(LIBFTD2XX_LIBRARY
@@ -42,31 +42,34 @@ else (LIBFTD2XX_LIBRARIES AND LIBFTD2XX_INCLUDE_DIRS)
/usr/local/lib
/opt/local/lib
/sw/lib
)
)

if(LIBFTD2XX_INCLUDE_DIR)
set(LIBFTD2XX_INCLUDE_DIRS
set(LIBFTD2XX_INCLUDE_DIRS
${LIBFTD2XX_INCLUDE_DIR}
)
)
endif(LIBFTD2XX_INCLUDE_DIR)
set(LIBFTD2XX_LIBRARIES
${LIBFTD2XX_LIBRARY}
)
)

if (LIBFTD2XX_INCLUDE_DIRS AND LIBFTD2XX_LIBRARIES)
set(LIBFTD2XX_FOUND TRUE)
endif (LIBFTD2XX_INCLUDE_DIRS AND LIBFTD2XX_LIBRARIES)

if (LIBFTD2XX_FOUND)
if (NOT libftd2xx_FIND_QUIETLY)
message(STATUS "Found libftd2xx: ${LIBFTD2XX_LIBRARIES}")
message(STATUS "Found libftd2xx: ${LIBFTD2XX_LIBRARIES}")
endif (NOT libftd2xx_FIND_QUIETLY)
else (LIBFTD2XX_FOUND)
if (libftd2xx_FIND_REQUIRED)
message(FATAL_ERROR "Could not find libftd2xx")
message(FATAL_ERROR "Could not find libftd2xx")
endif (libftd2xx_FIND_REQUIRED)
endif (LIBFTD2XX_FOUND)

find_package_handle_standard_args(Ftd2xx
REQUIRED_VARS LIBFTD2XX_INCLUDE_DIRS)

# show the LIBFTD2XX_INCLUDE_DIRS and LIBFTD2XX_LIBRARIES variables only in the advanced view
mark_as_advanced(LIBFTD2XX_INCLUDE_DIRS LIBFTD2XX_LIBRARIES)

@@ -28,11 +28,11 @@ else (LIBFT4222_LIBRARIES AND LIBFT4222_INCLUDE_DIRS)
/usr/local/include
/opt/local/include
/sw/include
)
)

SET(FTD4222_LIBNAME ft4222)
IF(WIN32)
SET(FTD4222_LIBNAME LibFT4222.lib)
SET(FTD4222_LIBNAME LibFT4222.lib)
ENDIF(WIN32)

find_library(LIBFT4222_LIBRARY
@@ -43,31 +43,34 @@ else (LIBFT4222_LIBRARIES AND LIBFT4222_INCLUDE_DIRS)
/usr/local/lib
/opt/local/lib
/sw/lib
)
)

if(LIBFT4222_INCLUDE_DIR)
set(LIBFT4222_INCLUDE_DIRS
set(LIBFT4222_INCLUDE_DIRS
${LIBFT4222_INCLUDE_DIR}
)
)
endif(LIBFT4222_INCLUDE_DIR)
set(LIBFT4222_LIBRARIES
${LIBFT4222_LIBRARY}
)
)

if (LIBFT4222_INCLUDE_DIRS AND LIBFT4222_LIBRARIES)
set(LIBFT4222_FOUND TRUE)
endif (LIBFT4222_INCLUDE_DIRS AND LIBFT4222_LIBRARIES)

if (LIBFT4222_FOUND)
if (NOT LIBFT4222_FIND_QUIETLY)
message(STATUS "Found LIBFT4222: ${LIBFT4222_LIBRARIES}")
message(STATUS "Found LIBFT4222: ${LIBFT4222_LIBRARIES}")
endif (NOT LIBFT4222_FIND_QUIETLY)
else (LIBFT4222_FOUND)
if (LIBFT4222_FIND_REQUIRED)
message(FATAL_ERROR "Could not find LIBFT4222")
message(FATAL_ERROR "Could not find LIBFT4222")
endif (LIBFT4222_FIND_REQUIRED)
endif (LIBFT4222_FOUND)

find_package_handle_standard_args(Ftd4222
REQUIRED_VARS LIBFT4222_INCLUDE_DIRS LIBFT4222_LIBRARIES)

# show the LIBFT4222_INCLUDE_DIRS and LIBFT4222_LIBRARIES variables only in the advanced view
mark_as_advanced(LIBFT4222_INCLUDE_DIRS LIBFT4222_LIBRARIES)

@@ -108,6 +108,7 @@ services:
ftdi4442:
extends: all
environment:
- USBPLAT=ON
- FTDI4222=ON
command: bash -c "./scripts/run-cmake.sh && make -Cbuild"

@@ -79,13 +79,6 @@ mraa_platform_t mraa_mips_platform();
*/
mraa_platform_t mraa_mock_platform();

/**
* runtime detect running usb platform extender
*
* @return mraa_platform_t of the detected platform extender
*/
mraa_platform_t mraa_usb_platform_extender(mraa_board_t* board);

/**
* runtime detect iio subsystem
*
@@ -497,3 +497,15 @@ typedef struct {
uint8_t iio_device_count; /**< IIO device count */
} mraa_iio_info_t;
#endif

/**
* Function pointer typedef for use with platform extender libraries.
* Currently only the FT42222.
*
* @param board Pointer to valid board structure. If a mraa_board_t
* is initialized, it will be added to board->sub_platform
*
* @return MRAA_SUCCESS if a valid subplaform has been initialized,
* otherwise return MRAA_ERROR_PLATFORM_NOT_INITIALISED
*/
typedef mraa_result_t (*fptr_add_platform_extender)(mraa_board_t* board);
@@ -176,22 +176,26 @@ endif()

if (USBPLAT)
message (STATUS "INFO - Adding USB platforms")
# USBPLAT is used in mraa.c to decide whether to attempt to load sub-platforms
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DUSBPLAT=1")
# Loading an FTDI platform extender library using dlopen requires
# mraa to link against libdl. Mraa does NOT link directly to the
# FT4222 shim library.
set (mraa_LIBS ${mraa_LIBS} dl)
if (FTDID2xx)
find_package (Ftd2xx)
if (${LIBFTD2XX_FOUND})
set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DFTDID2XX=1")
set (mraa_LIBS ${mraa_LIBS} ${LIBFTD2XX_LIBRARIES})
else ()
message (SEND_ERROR "Enabled FTDID2xx support but library not found")
endif ()
endif ()
# The FTDI4222 shim includes libft4222.h (which includes ftd2xx.h), make sure
# both exist if building the FTDI4222 shim library
if (FTDI4222)
find_package (Ftd2xx REQUIRED)
find_package (Ftd4222)
if (${LIBFT4222_FOUND})
set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DFTDI4222=1")
set (mraa_LIBS ${mraa_LIBS} dl)
else ()
if (NOT ${LIBFT4222_FOUND})
message (SEND_ERROR "Enabled FTDI4222 support but library not found")
endif ()
endif ()
@@ -29,6 +29,7 @@
#endif

#include <stddef.h>
#include <dlfcn.h>
#include <stdlib.h>
#include <sched.h>
#include <string.h>
@@ -195,18 +196,21 @@ imraa_init()
}

#if defined(USBPLAT)
// Now detect sub platform, note this is not an else since we could be in
// an error case and fall through to MRAA_ERROR_PLATFORM_NOT_INITIALISED
if (plat != NULL) {
mraa_platform_t usb_platform_type = mraa_usb_platform_extender(plat);
// if we have no known platform just replace usb platform with platform
if (plat->platform_type == MRAA_UNKNOWN_PLATFORM && usb_platform_type != MRAA_UNKNOWN_PLATFORM) {
plat->platform_type = usb_platform_type;
}
}
if (plat == NULL) {
printf("mraa: FATAL error, failed to initialise platform\n");
return MRAA_ERROR_PLATFORM_NOT_INITIALISED;
syslog(LOG_NOTICE, "Searching for USB plaform extender libraries...");
/* If a usb platform lib is present, attempt to load and look for
* necessary symbols for adding extended I/O */
void* usblib = dlopen("libmraa-platform-ft4222.so", RTLD_LAZY);
if (usblib)
{
syslog(LOG_NOTICE, "Found USB platform extender library: libmraa-platform-ft4222.so");
syslog(LOG_NOTICE, "Detecting FT4222 subplatforms...");
fptr_add_platform_extender add_ft4222_platform =
(fptr_add_platform_extender)dlsym(usblib, "mraa_usb_platform_extender");

/* If this method exists, call it to add a subplatform */
syslog(LOG_NOTICE, "Detecting FT4222 subplatforms complete, found %i subplatform/s",
((add_ft4222_platform != NULL) && (add_ft4222_platform(plat) == MRAA_SUCCESS))
? 1 : 0);
}
#endif

@@ -273,7 +277,8 @@ mraa_deinit()
free(plat->adv_func);
}
mraa_board_t* sub_plat = plat->sub_platform;
if (sub_plat != NULL) {
/* No alloc's in an FTDI_FT4222 platform structure */
if ((sub_plat != NULL) && (sub_plat->platform_type != MRAA_FTDI_FT4222)) {
if (sub_plat->pins != NULL) {
free(sub_plat->pins);
}
@@ -1,12 +1 @@
set (mraa_LIB_USB_SRCS_NOAUTO ${PROJECT_SOURCE_DIR}/src/usb/usb.c)

if (FTDI4222)
message (INFO " - FTDI4222")
set (mraa_LIB_USB_SRCS_NOAUTO ${mraa_LIB_USB_SRCS_NOAUTO}
${PROJECT_SOURCE_DIR}/src/usb/ftdi_ft4222.c
)
endif ()

set (mraa_LIB_PLAT_SRCS_NOAUTO ${mraa_LIB_PLAT_SRCS_NOAUTO}
${mraa_LIB_USB_SRCS_NOAUTO} PARENT_SCOPE)

add_subdirectory(ft4222)
@@ -0,0 +1,19 @@
if (FTDI4222)
set(target_name mraa-platform-ft4222)
add_library(${target_name} SHARED ftdi_ft4222.cxx ftdi_ft4222.hpp)
target_link_libraries(${target_name} ${LIBFT4222_LIBRARIES})
install(TARGETS ${target_name} DESTINATION ${LIB_INSTALL_DIR})

set_target_properties(
${target_name}
PROPERTIES
SOVERSION ${mraa_VERSION_MAJOR}
VERSION ${mraa_VERSION_STRING}
)
if (MSYS)
# Under MSYS we have to put our generated DLL into bin, otherwise it's not picked up
install(TARGETS ${target_name} DESTINATION ${CMAKE_INSTALL_BINDIR})
else ()
install(TARGETS ${target_name} DESTINATION ${LIB_INSTALL_DIR})
endif ()
endif()
Oops, something went wrong.

0 comments on commit fc4b2a5

Please sign in to comment.
You can’t perform that action at this time.