Skip to content

Pio support for SDK libs in new folder #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,12 @@ if [ "$BUILD_TYPE" = "all" ]; then
if [ $? -ne 0 ]; then exit 1; fi
fi

# Generate PlatformIO manifest file
if [ "$BUILD_TYPE" = "all" ]; then
python3 ./tools/gen_platformio_manifest.py -o "$TOOLS_JSON_OUT/"
if [ $? -ne 0 ]; then exit 1; fi
fi

# copy everything to arduino-esp32 installation
if [ $COPY_OUT -eq 1 ] && [ -d "$ESP32_ARDUINO" ]; then
./tools/copy-to-arduino.sh
Expand All @@ -212,4 +218,4 @@ fi
if [ "$BUILD_TYPE" = "all" ]; then
./tools/archive-build.sh
if [ $? -ne 0 ]; then exit 1; fi
fi
fi
1 change: 1 addition & 0 deletions components/arduino_tinyusb/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ if(CONFIG_TINYUSB_ENABLED)
"${COMPONENT_DIR}/tinyusb/src/class/msc/msc_device.c"
"${COMPONENT_DIR}/tinyusb/src/class/video/video_device.c"
"${COMPONENT_DIR}/tinyusb/src/class/dfu/dfu_rt_device.c"
"${COMPONENT_DIR}/tinyusb/src/class/dfu/dfu_device.c"
"${COMPONENT_DIR}/tinyusb/src/class/vendor/vendor_device.c"
"${COMPONENT_DIR}/tinyusb/src/common/tusb_fifo.c"
"${COMPONENT_DIR}/tinyusb/src/device/usbd_control.c"
Expand Down
25 changes: 25 additions & 0 deletions components/arduino_tinyusb/Kconfig.projbuild
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,31 @@ menu "Arduino TinyUSB"

endmenu

menu "DFU driver"
depends on TINYUSB_ENABLED

config TINYUSB_DFU_ENABLED
bool "Enable USB DFU TinyUSB driver"
default y
help
Enable USB DFU TinyUSB driver.

config TINYUSB_DESC_DFU_STRING
string "DFU Device String"
default "Espressif DFU Device"
depends on TINYUSB_DFU_ENABLED
help
Specify name of the DFU device

config TINYUSB_DFU_BUFSIZE
int "DFU buffer size"
default 4096
depends on TINYUSB_DFU_ENABLED
help
DFU buffer size

endmenu

menu "VENDOR driver"
depends on TINYUSB_ENABLED

Expand Down
8 changes: 8 additions & 0 deletions components/arduino_tinyusb/include/tusb_config.h
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,10 @@ extern "C" {
# define CONFIG_TINYUSB_DFU_RT_ENABLED 0
#endif

#ifndef CONFIG_TINYUSB_DFU_ENABLED
# define CONFIG_TINYUSB_DFU_ENABLED 0
#endif

#ifndef CONFIG_TINYUSB_VENDOR_ENABLED
# define CONFIG_TINYUSB_VENDOR_ENABLED 0
#endif
Expand Down Expand Up @@ -106,6 +110,7 @@ extern "C" {
#define CFG_TUD_VIDEO CONFIG_TINYUSB_VIDEO_ENABLED
#define CFG_TUD_CUSTOM_CLASS CONFIG_TINYUSB_CUSTOM_CLASS_ENABLED
#define CFG_TUD_DFU_RUNTIME CONFIG_TINYUSB_DFU_RT_ENABLED
#define CFG_TUD_DFU CONFIG_TINYUSB_DFU_ENABLED
#define CFG_TUD_VENDOR CONFIG_TINYUSB_VENDOR_ENABLED

// CDC FIFO size of TX and RX
Expand All @@ -126,6 +131,9 @@ extern "C" {
#define CFG_TUD_VIDEO_STREAMING CONFIG_TINYUSB_VIDEO_STREAMING_IFS
#define CFG_TUD_VIDEO_STREAMING_EP_BUFSIZE CONFIG_TINYUSB_VIDEO_STREAMING_BUFSIZE

// DFU buffer size
#define CFG_TUD_DFU_XFER_BUFSIZE CONFIG_TINYUSB_DFU_BUFSIZE

// VENDOR FIFO size of TX and RX
#define CFG_TUD_VENDOR_RX_BUFSIZE CONFIG_TINYUSB_VENDOR_RX_BUFSIZE
#define CFG_TUD_VENDOR_TX_BUFSIZE CONFIG_TINYUSB_VENDOR_TX_BUFSIZE
Expand Down
6 changes: 3 additions & 3 deletions configs/pio_end.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
"ESP32",
("F_CPU", "$BOARD_F_CPU"),
("ARDUINO", 10812),
("ARDUINO_VARIANT", '\\"%s\\"' % env.BoardConfig().get("build.variant").replace('"', "")),
("ARDUINO_BOARD", '\\"%s\\"' % env.BoardConfig().get("name").replace('"', "")),
"ARDUINO_PARTITION_%s" % basename(env.BoardConfig().get(
("ARDUINO_VARIANT", '\\"%s\\"' % board_config.get("build.variant").replace('"', "")),
("ARDUINO_BOARD", '\\"%s\\"' % board_config.get("name").replace('"', "")),
"ARDUINO_PARTITION_%s" % basename(board_config.get(
"build.partitions", "default.csv")).replace(".csv", "").replace("-", "_")
]
)
5 changes: 5 additions & 0 deletions configs/pio_start.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,10 @@ from SCons.Script import DefaultEnvironment
env = DefaultEnvironment()

FRAMEWORK_DIR = env.PioPlatform().get_package_dir("framework-arduinoespressif32")
FRAMEWORK_SDK_DIR = env.PioPlatform().get_package_dir(
"framework-arduinoespressif32-libs"
)

board_config = env.BoardConfig()

env.Append(
2 changes: 1 addition & 1 deletion tools/config.sh
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ AR_TOOLS="$AR_OUT/tools"
AR_PLATFORM_TXT="$AR_OUT/platform.txt"
AR_GEN_PART_PY="$AR_TOOLS/gen_esp32part.py"
AR_SDK="$AR_TOOLS/esp32-arduino-libs/$IDF_TARGET"
PIO_SDK="FRAMEWORK_DIR, \"tools\", \"esp32-arduino-libs\", \"$IDF_TARGET\""
PIO_SDK="FRAMEWORK_SDK_DIR, \"$IDF_TARGET\""
TOOLS_JSON_OUT="$AR_TOOLS/esp32-arduino-libs"
IDF_LIBS_DIR="$AR_ROOT/../esp32-arduino-libs"

Expand Down
6 changes: 3 additions & 3 deletions tools/copy-libs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -404,8 +404,8 @@ for item; do
done
fi
done
echo " join($PIO_SDK, env.BoardConfig().get(\"build.arduino.memory_type\", (env.BoardConfig().get(\"build.flash_mode\", \"dio\") + \"_$OCT_PSRAM\")), \"include\")," >> "$AR_PLATFORMIO_PY"
echo " join(FRAMEWORK_DIR, \"cores\", env.BoardConfig().get(\"build.core\"))" >> "$AR_PLATFORMIO_PY"
echo " join($PIO_SDK, board_config.get(\"build.arduino.memory_type\", (board_config.get(\"build.flash_mode\", \"dio\") + \"_$OCT_PSRAM\")), \"include\")," >> "$AR_PLATFORMIO_PY"
echo " join(FRAMEWORK_DIR, \"cores\", board_config.get(\"build.core\"))" >> "$AR_PLATFORMIO_PY"
echo " ]," >> "$AR_PLATFORMIO_PY"
echo "" >> "$AR_PLATFORMIO_PY"

Expand All @@ -429,7 +429,7 @@ done
echo " LIBPATH=[" >> "$AR_PLATFORMIO_PY"
echo " join($PIO_SDK, \"lib\")," >> "$AR_PLATFORMIO_PY"
echo " join($PIO_SDK, \"ld\")," >> "$AR_PLATFORMIO_PY"
echo " join($PIO_SDK, env.BoardConfig().get(\"build.arduino.memory_type\", (env.BoardConfig().get(\"build.flash_mode\", \"dio\") + \"_$OCT_PSRAM\")))" >> "$AR_PLATFORMIO_PY"
echo " join($PIO_SDK, board_config.get(\"build.arduino.memory_type\", (board_config.get(\"build.flash_mode\", \"dio\") + \"_$OCT_PSRAM\")))" >> "$AR_PLATFORMIO_PY"
echo " ]," >> "$AR_PLATFORMIO_PY"
echo "" >> "$AR_PLATFORMIO_PY"

Expand Down
95 changes: 95 additions & 0 deletions tools/gen_platformio_manifest.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
import argparse
import json
import os
import re
import sys

MANIFEST_DATA = {
"name": "framework-arduinoespressif32-libs",
"description": "Precompiled libraries for Arduino Wiring-based Framework for the Espressif ESP32 series of SoCs",
"keywords": ["framework", "arduino", "espressif", "esp32"],
"license": "LGPL-2.1-or-later",
"repository": {
"type": "git",
"url": "https://github.com/espressif/esp32-arduino-libs",
},
}


def convert_version(version_line):
"""A helper function that converts a custom IDF version string
to a suitable SemVer alternative. For example:
'release/v5.1 420ebd208a' becomes '5.1.0+sha.420ebd208a'
"""

regex_pattern = r"^esp-idf:\s*release\/v(?P<IDF_VERSION>[\d\.]{3,5})\s*(?P<COMMIT_HASH>[0-9a-f]{5,40})"
match = re.search(regex_pattern, version_line)
if not match:
sys.stderr.write(
f"Failed to find a regex match for '{regex_pattern}' in '{version_line}'\n"
)
return ""

version = match.group("IDF_VERSION")
commit = match.group("COMMIT_HASH")

assert version, f"Failed to parse version value from '{version_line}'"
assert commit, f"Failed to parse commit hash value from '{version_line}'"

if version.count(".") < 2:
# The most basic casting to a SemVer with three digits
version = version + ".0"

return f"{version}+sha.{commit}"


def main(dst_dir):
# The "version.txt" file is expected to contain IDF version in the following format
# "esp-idf: release/v$VERSION COMMIT_HASH".
version_file = os.path.join("version.txt")

if not os.path.isfile(version_file):
sys.stderr.write("Missing the 'version.txt' file.\n")
return -1

version_line = ""
with open(version_file, encoding="utf8") as fp:
for line in fp.readlines():
if not line.startswith("esp-idf"):
continue
version_line = line.strip()

if not version_line:
sys.stderr.write("Failed to find ESP-IDF version in the 'version.txt' file!\n")
return -1

converted_version = convert_version(version_line)
if not converted_version:
sys.stderr.write(
f"Failed to convert version '{version_line}' from version.txt\n"
)
return -1

manifest_file_path = os.path.join(dst_dir, "package.json")
with open(manifest_file_path, "w", encoding="utf8") as fp:
MANIFEST_DATA["version"] = converted_version
json.dump(MANIFEST_DATA, fp, indent=2)

print(
f"Generated PlatformIO manifest file '{manifest_file_path}' with '{converted_version}' version"
)
return 0


if __name__ == "__main__":
parser = argparse.ArgumentParser()
parser.add_argument(
"-o",
"--dst-dir",
dest="dst_dir",
required=True,
help="Destination folder where the 'package.json' manifest will be located",
)
args = parser.parse_args()

sys.exit(main(args.dst_dir))