Support homebrew builds better, add additional methods

JessicaMulein · JessicaMulein · commit 3ef9bad0cd24 · 2020-03-15T12:33:47.000-07:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,5 +1,11 @@
 cmake_minimum_required(VERSION 2.8.4)
+cmake_policy(SET CMP0042 NEW)
+cmake_policy(SET CMP0079 NEW)
 project(usbpp C CXX)
+set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/" ${CMAKE_MODULE_PATH})
+LINK_DIRECTORIES(/usr/local/lib /usr/local/opt)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+
 
 if (NOT BINDIR)
 	set(BINDIR  "bin")
@@ -15,18 +21,27 @@ if (NOT INSTALL_PKGCONFIG_DIR)
 endif()
 
 find_package(PkgConfig REQUIRED)
+find_package(libusb-1.0)
 pkg_check_modules(LIBUSB REQUIRED libusb-1.0>=1.0.16)
 find_package(Threads)
 
 set(CMAKE_CXX_FLAGS "-std=c++11")
 set(CMAKE_CXX_FLAGS_DEBUG "-g -Wall -Wstrict-aliasing -Wextra")
-include_directories(${LIBUSB_INCLUDE_DIRS} include)
+include_directories(SYSTEM ${LIBUSB_1_INCLUDE_DIRS})
+include_directories(include)
+
 
 set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 
 add_subdirectory(examples)
 add_subdirectory(include)
 add_subdirectory(src)
 
+include(CMakePackageConfigHelpers)
+write_basic_package_version_file(
+		"${CMAKE_CURRENT_BINARY_DIR}/usbpp-config.cmake"
+		VERSION 1.0
+		COMPATIBILITY AnyNewerVersion
+)
 configure_file( ${CMAKE_CURRENT_SOURCE_DIR}/usbpp.pc.in ${CMAKE_CURRENT_BINARY_DIR}/usbpp.pc @ONLY)
 install(FILES ${CMAKE_CURRENT_BINARY_DIR}/usbpp.pc DESTINATION "${INSTALL_PKGCONFIG_DIR}")
diff --git a/cmake/Findlibusb-1.0.cmake b/cmake/Findlibusb-1.0.cmake
@@ -0,0 +1,119 @@
+# https://github.com/myriadrf/LimeSuite/blob/master/cmake/Modules/Findlibusb-1.0.cmake
+# - Try to find libusb-1.0
+# Once done this will define
+#
+#  LIBUSB_1_FOUND - system has libusb
+#  LIBUSB_1_INCLUDE_DIRS - the libusb include directory
+#  LIBUSB_1_LIBRARIES - Link these to use libusb
+#  LIBUSB_1_DEFINITIONS - Compiler switches required for using libusb
+#
+#  Adapted from cmake-modules Google Code project
+#
+#  Copyright (c) 2006 Andreas Schneider <mail@cynapses.org>
+#
+#  (Changes for libusb) Copyright (c) 2008 Kyle Machulis <kyle@nonpolynomial.com>
+#
+# Redistribution and use is allowed according to the terms of the New BSD license.
+#
+# CMake-Modules Project New BSD License
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+#
+# * Redistributions in binary form must reproduce the above copyright notice,
+#   this list of conditions and the following disclaimer in the
+#   documentation and/or other materials provided with the distribution.
+#
+# * Neither the name of the CMake-Modules Project nor the names of its
+#   contributors may be used to endorse or promote products derived from this
+#   software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+#  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+
+if (LIBUSB_1_LIBRARIES AND LIBUSB_1_INCLUDE_DIRS)
+  # in cache already
+  set(LIBUSB_FOUND TRUE)
+else (LIBUSB_1_LIBRARIES AND LIBUSB_1_INCLUDE_DIRS)
+  find_path(LIBUSB_1_INCLUDE_DIR
+    NAMES
+	libusb.h
+    PATHS
+      /usr/include
+      /usr/local/include
+      /opt/local/include
+      /sw/include
+	PATH_SUFFIXES
+	  libusb-1.0
+  )
+
+  set(LIBUSB_1_LIBRARY_NAME usb-1.0)
+  if(${CMAKE_SYSTEM_NAME} MATCHES "FreeBSD")
+    set(LIBUSB_1_LIBRARY_NAME usb)
+  endif(${CMAKE_SYSTEM_NAME} MATCHES "FreeBSD")
+
+if(NOT bananapi-r2)
+  find_library(LIBUSB_1_LIBRARY
+    NAMES ${LIBUSB_1_LIBRARY_NAME}
+    PATHS
+      /usr/lib
+      /usr/local/lib
+      /opt/local/lib
+      /sw/lib
+  )
+endif(NOT bananapi-r2)
+
+#bananapi-r2 ubuntu 16.04 has wrong libusb-1.0.so path
+#when compiling on bananapi-r2 run cmake with -DBananapi-r2=YES argument like so:
+#  $(builddir)/cmake -Dbananapi-r2=YES ../
+if(bananapi-r2)
+    message(STATUS "DEBUG --->>>> BANANAPI")
+    find_library(LIBUSB_1_LIBRARY
+    NAMES ${LIBUSB_1_LIBRARY_NAME}
+    PATHS
+      /lib/arm-linux-gnueabihf/
+      /usr/lib/arm-linux-gnueabihf/
+    NO_DEFAULT_PATH
+  )
+endif(bananapi-r2)  
+
+  set(LIBUSB_1_INCLUDE_DIRS
+    ${LIBUSB_1_INCLUDE_DIR}
+  )
+  set(LIBUSB_1_LIBRARIES
+    ${LIBUSB_1_LIBRARY}
+)
+
+  if (LIBUSB_1_INCLUDE_DIRS AND LIBUSB_1_LIBRARIES)
+     set(LIBUSB_1_FOUND TRUE)
+  endif (LIBUSB_1_INCLUDE_DIRS AND LIBUSB_1_LIBRARIES)
+
+  if (LIBUSB_1_FOUND)
+    if (NOT libusb_1_FIND_QUIETLY)
+      message(STATUS "Found libusb-1.0:")
+	  message(STATUS " - Includes: ${LIBUSB_1_INCLUDE_DIRS}")
+	  message(STATUS " - Libraries: ${LIBUSB_1_LIBRARIES}")
+    endif (NOT libusb_1_FIND_QUIETLY)
+  else (LIBUSB_1_FOUND)
+    if (libusb_1_FIND_REQUIRED)
+      message(FATAL_ERROR "Could not find libusb")
+    endif (libusb_1_FIND_REQUIRED)
+  endif (LIBUSB_1_FOUND)
+
+  # show the LIBUSB_1_INCLUDE_DIRS and LIBUSB_1_LIBRARIES variables only in the advanced view
+  mark_as_advanced(LIBUSB_1_INCLUDE_DIRS LIBUSB_1_LIBRARIES)
+
+endif (LIBUSB_1_LIBRARIES AND LIBUSB_1_INCLUDE_DIRS)
diff --git a/include/context.h b/include/context.h
@@ -21,6 +21,7 @@
 #include <functional>
 #include <memory>
 #include <vector>
+#include <libusb.h>
 
 #include "device.h"
 #include "exception.h"
@@ -101,6 +102,9 @@ class Context {
 	 */
 	Context& operator=(Context&& other) noexcept;
 
+    template <typename ... Ts>
+    void setOption(libusb_option option, Ts ... args);
+
 	/**
 	 * Get list of currently attached USB devices.
 	 *
diff --git a/include/device.h b/include/device.h
@@ -21,6 +21,7 @@
 #include <exception>
 #include <memory>
 #include <string>
+#include <vector>
 
 #include "buffer.h"
 #include "exception.h"
@@ -157,6 +158,21 @@ class Device {
 	 */
 	libusb_device_descriptor getDescriptor();
 
+	/**
+	 *
+	 * @param desc
+	 * @param key
+	 * @return
+	 */
+	std::string* getStringDescriptor(int key);
+
+	uint8_t getBusNumber() const;
+
+	uint8_t getDeviceAddress() const;
+
+	static const int MAX_PORT_NUMBERS = 255;
+	std::vector<uint8_t> *getPortNumbers();
+
 	/**
 	 * Get the device configuration.
 	 *
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -5,6 +5,7 @@ add_library(usbpp SHARED
 	hiddevice.cpp hidreport.cpp # HID support
 	mscbw.cpp mscsw.cpp msdevice.cpp msscsiinquiry.cpp msscsiinquiryresponse.cpp # mass storage
 )
+find_package(libusb-1.0)
 target_link_libraries(usbpp ${LIBUSB_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})
 
 install(TARGETS usbpp DESTINATION ${LIBDIR})
diff --git a/src/context.cpp b/src/context.cpp
@@ -254,6 +254,11 @@ Context& Context::operator=(Context&& other) noexcept {
 	return *this;
 }
 
+template <typename ... Ts>
+void Context::setOption(libusb_option option, Ts ... args) {
+    libusb_set_option( pimpl->m_ctx, option, args...);
+}
+
 std::vector<Device> Context::getDevices() {
 	libusb_device** devices;
 	int count = libusb_get_device_list(pimpl->m_ctx, &devices);
diff --git a/src/device.cpp b/src/device.cpp
@@ -17,12 +17,14 @@
 
 #include "device.h"
 
+#include <cstring>
 #include <cassert>
 #include <libusb.h>
 #include <unistd.h>
 #include <unordered_map>
 #include <unordered_set>
 #include <sstream>
+#include <vector>
 
 #include "deviceimpl.h"
 
@@ -212,6 +214,56 @@ libusb_device_descriptor Device::getDescriptor() {
 	return desc;
 }
 
+std::string* Device::getStringDescriptor(const int key) {
+    /** Pre-allocated maximum length for getStringDescriptor calls. Calls with maxlen > n will throw */
+    const int STRING_DESCRIPTOR_MAXLEN = 1024;
+    /** Pre-allocated buffer for libusb_get_string_descriptor_ascii, using above constant */
+    unsigned char data[STRING_DESCRIPTOR_MAXLEN];
+    if (pimpl->m_handle == NULL) {
+        return nullptr;
+    }
+    // pre-zero
+    std::memset(data, 0, STRING_DESCRIPTOR_MAXLEN);
+    libusb_get_string_descriptor_ascii(pimpl->m_handle, key, data, STRING_DESCRIPTOR_MAXLEN);
+    uint16_t data_length;
+    for (data_length=0; data_length<STRING_DESCRIPTOR_MAXLEN; data_length++) {
+        if (data[data_length] == 0) break;
+    }
+    // return null when no result, don't bother allocating an empty string
+    if (data_length == 0) {
+        return nullptr;
+    }
+    return new std::string(reinterpret_cast<const char *>(data));
+}
+
+uint8_t Device::getBusNumber() const{
+    if (pimpl->m_device == NULL) {
+        return 0;
+    }
+
+    return libusb_get_bus_number(pimpl->m_device);
+}
+
+uint8_t Device::getDeviceAddress() const {
+    return libusb_get_device_address(pimpl->m_device);
+}
+
+std::vector<uint8_t> *Device::getPortNumbers() {
+    uint8_t ports[Usbpp::Device::MAX_PORT_NUMBERS]; // these are not chars, actually uints- these are port numbers (or something similar)
+    std::vector<uint8_t> *ports_vec = new std::vector<uint8_t>();
+
+    if (pimpl->m_device != NULL) {
+        int count = libusb_get_port_numbers(pimpl->m_device, ports, Usbpp::Device::MAX_PORT_NUMBERS);
+        if (count > 0) {
+            ports_vec->reserve(count);
+            for (int i = 0; i < count; i++) {
+                ports_vec->push_back(ports[i]);
+            }
+        }
+    }
+    return ports_vec;
+}
+
 int Device::getConfiguration() {
 	int config;
 	int res = libusb_get_configuration(pimpl->m_handle, &config);
diff --git a/usbpp-config.cmake b/usbpp-config.cmake
@@ -0,0 +1,37 @@
+# This is a basic version file for the Config-mode of find_package().
+# It is used by write_basic_package_version_file() as input file for configure_file()
+# to create a version-file which can be installed along a config.cmake file.
+#
+# The created file sets PACKAGE_VERSION_EXACT if the current version string and
+# the requested version string are exactly the same and it sets
+# PACKAGE_VERSION_COMPATIBLE if the current version is >= requested version.
+# The variable CVF_VERSION must be set before calling configure_file().
+
+set(PACKAGE_VERSION "1.0")
+
+if(PACKAGE_VERSION VERSION_LESS PACKAGE_FIND_VERSION)
+  set(PACKAGE_VERSION_COMPATIBLE FALSE)
+else()
+  set(PACKAGE_VERSION_COMPATIBLE TRUE)
+  if(PACKAGE_FIND_VERSION STREQUAL PACKAGE_VERSION)
+    set(PACKAGE_VERSION_EXACT TRUE)
+  endif()
+endif()
+
+
+# if the installed project requested no architecture check, don't perform the check
+if("FALSE")
+  return()
+endif()
+
+# if the installed or the using project don't have CMAKE_SIZEOF_VOID_P set, ignore it:
+if("${CMAKE_SIZEOF_VOID_P}" STREQUAL "" OR "4" STREQUAL "")
+  return()
+endif()
+
+# check that the installed version has the same 32/64bit-ness as the one which is currently searching:
+if(NOT CMAKE_SIZEOF_VOID_P STREQUAL "4")
+  math(EXPR installedBits "4 * 8")
+  set(PACKAGE_VERSION "${PACKAGE_VERSION} (${installedBits}bit)")
+  set(PACKAGE_VERSION_UNSUITABLE TRUE)
+endif()

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ add_library(usbpp SHARED`
`5`	`5`	`hiddevice.cpp hidreport.cpp # HID support`
`6`	`6`	`mscbw.cpp mscsw.cpp msdevice.cpp msscsiinquiry.cpp msscsiinquiryresponse.cpp # mass storage`
`7`	`7`	`)`
	`8`	`+find_package(libusb-1.0)`
`8`	`9`	`target_link_libraries(usbpp ${LIBUSB_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})`
`9`	`10`
`10`	`11`	`install(TARGETS usbpp DESTINATION ${LIBDIR})`