Merge branch 'first_release' into main

Author: umbynos

Dockerfile

@@ -0,0 +1,86 @@
+FROM ubuntu:latest as build
+
+ENV TZ=Europe/Rome
+RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone && \
+    apt-get update && \
+    apt-get install -y \
+        build-essential \
+        # Intall clang compiler used by macos
+        clang \
+        cmake \
+        curl \
+        dh-autoreconf \
+        git \
+        gperf \
+        # various libs required to compile osxcross
+        libxml2-dev \
+        libssl-dev \
+        libz-dev \
+        # Install Windows cross-tools
+        mingw-w64 \
+        p7zip-full \
+        pkg-config \
+        tar \
+    && rm -rf /var/lib/apt/lists/*
+# Install toolchains in /opt
+RUN curl downloads.arduino.cc/tools/internal/toolchains.tar.gz | tar -xz "opt"
+    # install proper arm toolchains (already present in the toolchains.tar.gz archive)
+    # curl -L 'https://developer.arm.com/-/media/Files/downloads/gnu-a/8.3-2019.03/binrel/gcc-arm-8.3-2019.03-x86_64-arm-linux-gnueabihf.tar.xz' | tar -xJC /opt && \
+    # curl -L 'https://developer.arm.com/-/media/Files/downloads/gnu-a/8.3-2019.03/binrel/gcc-arm-8.3-2019.03-x86_64-aarch64-linux-gnu.tar.xz' | tar -xJC /opt
+
+RUN cd /opt/osxcross \
+    git pull \
+    # use a specific version of osxcross (it does not have tags)
+    git checkout da2c3d4ff604458a931b08b3af800c5a454136de \
+    UNATTENDED=1 SDK_VERSION=10.15 ./build.sh
+# Set toolchains paths
+# arm-linux-gnueabihf-gcc -> linux_arm
+# aarch64-linux-gnu-gcc -> linux_arm64
+# x86_64-ubuntu16.04-linux-gnu-gcc -> linux_amd64
+# i686-ubuntu16.04-linux-gnu-gcc -> linux_386
+# o64-clang -> darwin_amd64
+ENV PATH=/opt/gcc-arm-8.3-2019.03-x86_64-arm-linux-gnueabihf/bin/:/opt/gcc-arm-8.3-2019.03-x86_64-aarch64-linux-gnu/bin/:/opt/x86_64-ubuntu16.04-linux-gnu-gcc/bin/:/opt/i686-ubuntu16.04-linux-gnu/bin/:/opt/osxcross/target/bin/:$PATH
+
+WORKDIR /workdir
+
+# Handle libusb and libudev compilation and merging
+COPY deps/ /opt/lib/
+# compiler name is arm-linux-gnueabihf-gcc '-gcc' is added by ./configure
+RUN CROSS_COMPILE=x86_64-ubuntu16.04-linux-gnu /opt/lib/build_libs.sh && \
+    CROSS_COMPILE=arm-linux-gnueabihf /opt/lib/build_libs.sh && \
+    CROSS_COMPILE=aarch64-linux-gnu /opt/lib/build_libs.sh && \
+    CROSS_COMPILE=i686-ubuntu16.04-linux-gnu /opt/lib/build_libs.sh && \
+    CROSS_COMPILE=i686-w64-mingw32 /opt/lib/build_libs.sh && \
+    # CROSS_COMPILER is used to override the compiler 
+    CROSS_COMPILER=o64-clang CROSS_COMPILE=x86_64-apple-darwin13 /opt/lib/build_libs.sh
+
+FROM ubuntu:latest
+# Copy all the installed toolchains and compiled libs
+COPY --from=build /opt /opt
+ENV TZ=Europe/Rome
+RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone && \
+    apt-get update && \
+    apt-get install -y \
+    build-essential \
+        # Intall clang compiler used by macos
+        clang \
+        cmake \
+        dh-autoreconf \
+        git \
+        gperf \
+        # Install Windows cross-tools
+        mingw-w64 \
+        pkg-config \
+        tar \
+    && rm -rf /var/lib/apt/lists/*
+# Set toolchains paths
+# arm-linux-gnueabihf-gcc -> linux_arm
+# aarch64-linux-gnu-gcc -> linux_arm64
+# x86_64-ubuntu16.04-linux-gnu-gcc -> linux_amd64
+# i686-ubuntu16.04-linux-gnu-gcc -> linux_386
+# o64-clang -> darwin_amd64
+ENV PATH=/opt/gcc-arm-8.3-2019.03-x86_64-arm-linux-gnueabihf/bin/:/opt/gcc-arm-8.3-2019.03-x86_64-aarch64-linux-gnu/bin/:/opt/x86_64-ubuntu16.04-linux-gnu-gcc/bin/:/opt/i686-ubuntu16.04-linux-gnu/bin/:/opt/osxcross/target/bin/:$PATH
+
+WORKDIR /workdir
+
+ENTRYPOINT ["/bin/bash"]

README.md

@@ -0,0 +1,38 @@
+# Docker crossbuild
+
+This docker container has been created to allow us to easily crosscompile the c++ tools starting from this repo. The idea comes from [multiarch/crossbuild](https://github.com/multiarch/crossbuild), but this container unfortunately is outdated, the apt sources are no longer available.
+
+## Starting Image
+The starting image is [ubuntu:latest](https://hub.docker.com/_/ubuntu) (The ubuntu:latest tag points to the "latest LTS", since that's the version recommended for general use.) at the time of writing latest points to Ubuntu 20.04 focal.
+
+The starting image is only marginally important, since internally we use manually installed toolchains.
+
+## The Toolchains
+The toolchains are download from http://downloads.arduino.cc/tools/internal/toolchains.tar.gz .
+Inside that archive there are:
+- **gcc-arm-8.3-2019.03-x86_64-aarch64-linux-gnu** toolchain to crosscompile for *linux_arm64* (downloaded from [here](https://developer.arm.com/-/media/Files/downloads/gnu-a/8.3-2019.03/binrel/gcc-arm-8.3-2019.03-x86_64-aarch64-linux-gnu.tar.xz))
+- **gcc-arm-8.3-2019.03-x86_64-arm-linux-gnueabihf** toolchain used to crosscompile for *linux_arm* (downloaded from [here](https://developer.arm.com/-/media/Files/downloads/gnu-a/8.3-2019.03/binrel/gcc-arm-8.3-2019.03-x86_64-arm-linux-gnueabihf.tar.xz))
+- **i686-ubuntu16.04-linux-gnu** toolchain to crosscompile for *linux_386* (32bit)
+- **x86_64-ubuntu16.04-linux-gnu-gcc** toolchain to crosscompile for *linux_amd64*
+- [**osxcross**](https://github.com/tpoechtrager/osxcross) toolchain to crosscompile for *darwin_amd64*. Inside `osxcross/tarballs/` there is already `MacOSX10.15.sdk.tar.xz`: the SDK required by macos to crosscompile (we tried with SDK version 10.09 but it was too old)
+
+Regarding the two ubuntu toolchains: in the beginning we tried to use the ones shipped with 12.04 but they caused some build errors because they were too old, so we upgraded to 16.04 ones. They are created using [crosstool-ng](https://github.com/crosstool-ng/crosstool-ng).
+
+
+Apparently, osxcross does not have tags or version so we checkout a specific commit in order to have a pinned environment.
+
+The last toolchain required to crosscompile for windows is `mingw-w64` and it's installed through `apt` along with other useful packages.
+
+Once the toolchains are installed in `/opt` we add the binaries to the `PATH` env variable, to easily call them in the CI.
+
+## Copying and Building Libraries
+As explained in the other [`README.md`](deps/README.md) there are some libraries that needs to be compiled. This is achieved by copying `deps/` directory inside `/opt/lib/` in the container and then by using [`build_libs.sh`](deps/build_libs.sh) script [here](Dockerfile#L47-L55)
+
+## Multi-stage build
+To reduce the overall dimesion of the docker image we used the  [multi-stage build](https://learnk8s.io/blog/smaller-docker-images). 
+
+## How to build and use the container
+Usefull commands you can use:
+- `docker build -t ghcr.io/arduino/crossbuild:<version> docker/` to build the container
+- `docker push ghcr.io/arduino/crossbuild:<version>` to push the image to [github remote registry](https://docs.github.com/en/packages/guides/container-guides-for-github-packages)
+- `docker run -it --name crossbuild -v $PWD:/workdir ghcr.io/arduino/crossbuild:<version>` to get a shell inside the container and use the toolchains available inside (like the CI does).

deps/README.md

@@ -0,0 +1,47 @@
+# Dependencies
+The `deps/` folder contains the dependencies used to build and link statically `picotool` and `elf2uf2`: the libraries `libusb` and `libudev`.
+The `deps/` folder contains also a bash script used by the docker container to successfully build them with different toolchains and with different targets.
+This way they are already compiled and usable by the CI during the building/linking phase!
+
+They come respectively from [here](https://github.com/arduino/OpenOCD-build-script/tree/static/libusb-1.0.20)
+and from [here](https://github.com/gentoo/eudev)
+
+## `build_libs.sh`
+`build_libs.sh` is used by the [Dockerfile](../Dockerfile#L49-L55):
+Basically during the docker build phase the libraries are compiled with every toolchain available in the Docker container. Other libraries can be added, the [`build_libs.sh`](build_libs.sh) script needs to be adapted, but the Dockerfile should be ok.
+
+## libusbudev
+libusbudev is the result of merging the two `.a` files with a command line tool called `ar`. This is done to ease the linking phase done by the [CI](.github/workflows/release.yml#L87) passing a single static library. See `LIBUSBUDEV` env variable [here](../../.github/workflows/release.yml#L67) and [here](../../.github/workflows/release.yml#L71).
+For macos is not required to merge the two libraries because libudev is not a requirement, so macos uses `libusb.a` only: thus the distinction between the two platforms. Infact libusb for mac is the last one built in the [Dockerfile](../Dockerfile#L55).
+
+`libusbudev.a` is created by the `build_libs.sh` the directory structure created is the following:
+
+```
+/opt/lib/
+|-- aarch64-linux-gnu
+|   |-- libudev
+|   |-- libusb
+|   `-- libusbudev.a
+|-- arm-linux-gnueabihf
+|   |-- libudev
+|   |-- libusb
+|   `-- libusbudev.a
+|-- build_libs.sh
+|-- eudev-3.2.10
+|-- i686-ubuntu16.04-linux-gnu
+|   |-- libudev
+|   |-- libusb
+|   `-- libusbudev.a
+|-- i686-w64-mingw32
+|   |-- libudev
+|   |-- libusb
+|   `-- libusbudev.a
+|-- libusb-1.0.20
+`-- x86_64-ubuntu16.04-linux-gnu
+    |-- libudev
+    |-- libusb
+    `-- libusbudev.a
+```
+
+The original `libusb.a` is available in `/opt/lib/libusb-1.0.20/libusb/.libs/libusb-1.0.a`
+and `libudev.a` is available in `/opt/lib/eudev-3.2.10/src/libudev/.libs/libudev.a`

deps/build_libs.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+if [ x$CROSS_COMPILER == x ]; then
+CROSS_COMPILER=${CROSS_COMPILE}-gcc
+else
+export CC=$CROSS_COMPILER
+fi
+# udev lib not required for macos
+if [[ ${CROSS_COMPILE} != *apple* ]]; then
+cd /opt/lib/eudev-3.2.10
+export UDEV_DIR=`pwd`
+./autogen.sh
+./configure --enable-static --disable-shared --disable-blkid --disable-kmod  --disable-manpages --host=${CROSS_COMPILE}
+make clean
+make -j4
+cd ..
+export CFLAGS="-I$UDEV_DIR/src/libudev/"
+export LDFLAGS="-L$UDEV_DIR/src/libudev/.libs/"
+export LIBS="-ludev"
+fi
+cd /opt/lib/libusb-1.0.20
+export LIBUSB_DIR=`pwd`
+./configure --enable-static --disable-shared --host=${CROSS_COMPILE}
+make clean
+make
+cd ..
+# libusbudev.a merged not required for macos
+if [[ ${CROSS_COMPILE} != *apple* ]]; then
+mkdir -p ${CROSS_COMPILE}/libusb
+mkdir -p ${CROSS_COMPILE}/libudev
+cd ${CROSS_COMPILE}/libusb/
+ar -x ../../libusb-1.0.20/libusb/.libs/libusb-1.0.a
+cd ../libudev/
+ar -x ../../eudev-3.2.10/src/libudev/.libs/libudev.a
+cd ..
+ar -qc libusbudev.a libudev/* libusb/*
+fi

deps/eudev-3.2.10/.gitignore

@@ -0,0 +1,59 @@
+src/udev/udevadm
+src/udev/udevd
+
+*.[oa]
+*.l[oa]
+.libs
+.deps
+Makefile
+Makefile.in
+
+aclocal.m4
+autom4te.cache
+compile
+config.*
+configure
+libtool
+stamp-h1
+
+depcomp
+install-sh
+ltmain.sh
+missing
+
+*.pc
+
+m4/libtool.m4
+m4/ltoptions.m4
+m4/ltsugar.m4
+m4/ltversion.m4
+m4/lt~obsolete.m4
+
+rule_generator/write_net_rules
+
+rules/64-btrfs.rules
+
+src/ata_id/ata_id
+src/cdrom_id/cdrom_id
+src/collect/collect
+src/mtd_probe/mtd_probe
+src/scsi_id/scsi_id
+src/v4l_id/v4l_id
+
+src/udev/keyboard-keys-from-name.gperf
+src/udev/keyboard-keys-from-name.h
+src/udev/keyboard-keys-to-name.h
+src/udev/keyboard-keys.txt
+
+test/test-libudev
+test/test-udev
+test/test
+test-driver
+
+test/rules-test.sh.log
+test/rules-test.sh.trs
+test/test-suite.log
+test/udev-test.pl.log
+test/udev-test.pl.trs
+
+eudev-*.tar.gz

deps/eudev-3.2.10/.travis.yml

@@ -0,0 +1,14 @@
+language: c
+compiler:
+  - gcc
+  - clang
+before_install:
+ - sudo apt-get update -qq
+ - sudo apt-get install autotools-dev automake autoconf libtool gperf xsltproc docbook-xsl
+script: ./autogen.sh && ./configure && make V=1 distcheck
+notifications:
+  irc:
+    channels:
+      - "irc.freenode.org#gentoo-udev"
+    on_success: change
+    on_failure: always