Merge pull request #9 from hpsaturn/fix_issue6_sync_scripts

Fix issue6 sync scripts

Author: hpsaturn

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "esp32-linux-build"]
+	path = esp32-linux-build
+	url = https://github.com/jcmvbkbc/esp32-linux-build.git

Dockerfile

@@ -5,7 +5,7 @@
 FROM ubuntu:22.04
 
 RUN apt-get update
-RUN apt-get -y install gperf bison flex texinfo help2man gawk libtool-bin git unzip ncurses-dev rsync zlib1g zlib1g-dev xz-utils cmake wget bzip2 g++ python3 python3-dev python3-pip cpio bc virtualenv libusb-1.0 && \
+RUN apt-get -y install gperf bison flex texinfo help2man gawk libtool-bin git unzip ncurses-dev rsync zlib1g zlib1g-dev xz-utils cmake wget bzip2 g++ python3 python3-dev python3-pip python3.10-venv cpio bc virtualenv libusb-1.0 && \
     ln -s /usr/bin/python3 /usr/bin/python
 
 WORKDIR /app
@@ -19,62 +19,18 @@ RUN wget https://ftp.gnu.org/gnu/autoconf/autoconf-2.71.tar.xz && \
     make install
 ENV PATH="$PATH:/app/autoconf-2.71/root/bin"
 
-# dynconfig
-RUN git clone https://github.com/jcmvbkbc/xtensa-dynconfig -b original --depth=1 && \
-    git clone https://github.com/jcmvbkbc/config-esp32s3 esp32s3 --depth=1 && \
-    make -C xtensa-dynconfig ORIG=1 CONF_DIR=`pwd` esp32s3.so
-ENV XTENSA_GNU_CONFIG="/app/xtensa-dynconfig/esp32s3.so"
+#COPY esp32-linux-build/* /app/
+RUN chmod a+rwx /app
 
+ARG DOCKER_USER=default_user
+ARG DOCKER_USERID=default_userid
 # ct-ng cannot run as root, we'll just do everything else as a user
-RUN useradd -d /app/build -u 3232 esp32 && mkdir build && chown esp32:esp32 build
-USER esp32
-
-# toolchain
-RUN cd build && \
-    git clone https://github.com/jcmvbkbc/crosstool-NG.git -b xtensa-fdpic --depth=1 && \
-    cd crosstool-NG && \
-    ./bootstrap && \
-    ./configure --enable-local && \
-    make && \
-    ./ct-ng xtensa-esp32s3-linux-uclibcfdpic && \
-    CT_PREFIX=`pwd`/builds ./ct-ng build || echo "Completed"  # the complete ct-ng build fails but we still get what we wanted!
-RUN [ -e build/crosstool-NG/builds/xtensa-esp32s3-linux-uclibcfdpic/bin/xtensa-esp32s3-linux-uclibcfdpic-gcc ] || exit 1
-
-# kernel and rootfs
-RUN cd build && \
-    git clone https://github.com/jcmvbkbc/buildroot -b xtensa-2023.02-fdpic --depth=1 && \
-    make -C buildroot O=`pwd`/build-xtensa-2023.02-fdpic-esp32s3 esp32s3wifi_defconfig && \
-    buildroot/utils/config --file build-xtensa-2023.02-fdpic-esp32s3/.config --set-str TOOLCHAIN_EXTERNAL_PATH `pwd`/crosstool-NG/builds/xtensa-esp32s3-linux-uclibcfdpic && \
-    buildroot/utils/config --file build-xtensa-2023.02-fdpic-esp32s3/.config --set-str TOOLCHAIN_EXTERNAL_PREFIX '$(ARCH)-esp32s3-linux-uclibcfdpic' && \
-    buildroot/utils/config --file build-xtensa-2023.02-fdpic-esp32s3/.config --set-str TOOLCHAIN_EXTERNAL_CUSTOM_PREFIX '$(ARCH)-esp32s3-linux-uclibcfdpic' && \
-    make -C buildroot O=`pwd`/build-xtensa-2023.02-fdpic-esp32s3
-RUN [ -f build/build-xtensa-2023.02-fdpic-esp32s3/images/xipImage -a -f build/build-xtensa-2023.02-fdpic-esp32s3/images/rootfs.cramfs ] || exit 1
-
-
-# bootloader
-ENV IDF_PATH="/app/build/esp-hosted/esp_hosted_ng/esp/esp_driver/esp-idf"
-RUN cd build && \
-    git clone https://github.com/jcmvbkbc/esp-hosted -b shmem --depth=1 && \
-    cd esp-hosted/esp_hosted_ng/esp/esp_driver && cmake . && \
-    cd esp-idf && . ./export.sh && \
-    cd ../network_adapter && idf.py set-target esp32s3 && \
-    cp sdkconfig.defaults.esp32s3 sdkconfig && idf.py build
-
-
-# move files over
-RUN cd build && mkdir release && \
-    cp esp-hosted/esp_hosted_ng/esp/esp_driver/network_adapter/build/bootloader/bootloader.bin release && \
-    cp esp-hosted/esp_hosted_ng/esp/esp_driver/network_adapter/build/partition_table/partition-table.bin release && \
-    cp esp-hosted/esp_hosted_ng/esp/esp_driver/network_adapter/build/network_adapter.bin release && \
-    cp build-xtensa-2023.02-fdpic-esp32s3/images/xipImage release && \
-    cp build-xtensa-2023.02-fdpic-esp32s3/images/rootfs.cramfs release
-
-# keep docker running so we can debug/rebuild :)
-USER root
-ENTRYPOINT ["tail", "-f", "/dev/null"]
+RUN useradd -d /app/build -u $DOCKER_USERID $DOCKER_USER && mkdir build && chown $DOCKER_USER:$DOCKER_USER build
+RUN usermod -a -G dialout $DOCKER_USER
 
+USER $DOCKER_USER
 
-# grab the files with `docker cp CONTAINER_NAME:/app/build/release/\* .`
+# final files: /app/build/release/
 # now you can burn the files from the 'release' folder with: 
 # python esptool.py --chip esp32s3 -p /dev/ttyUSB0 -b 921600 --before=default_reset --after=hard_reset write_flash 0x0 bootloader.bin 0x10000 network_adapter.bin 0x8000 partition-table.bin
 # next we can burn in the kernel and filesys with parttool, which is part of esp-idf

README.md

@@ -7,58 +7,73 @@ Dockerfile ported by Adafruit from the work of [@jcmvbkbc](https://gist.github.c
 
 Please follow the next steps:
 
-1. Download or clone this repo, and then build the docker image:
+1. Download or clone this repo
 
 ```bash
-git clone https://github.com/hpsaturn/esp32s3-linux.git && cd esp32s3-linux
-docker build -t esp32-s3_linux .
+git clone --recursive https://github.com/hpsaturn/esp32s3-linux.git && cd esp32s3-linux
 ```
 
-This step takes around ~35 minutes and needs ~20Gb:
-
-![ESP32S3 Linux image build](screenshots/docker_build.jpg)
-
-2. Run a container in a terminal
+2. Then build the docker image:
 
 ```bash
-docker run --name esp32s3build -it esp32-s3_linux
+docker build --build-arg DOCKER_USER=$USER --build-arg DOCKER_USERID=$UID -t esp32linuxbase .
 ```
 
-3. In a second termintal, copy the binaries
+3. Copy settings sample and configure it:
 
 ```bash
-docker cp esp32s3build:/app/build/release/ bin_files
+cp settings.cfg.default settings.cfg
 ```
 
-4. Stop the container
+Possible settings:
 
 ```bash
-docker stop esp32s3build 
-```
+keep_toolchain=
+keep_rootfs=
+keep_buildroot=
+keep_bootloader=
+keep_etc=
+``` 
 
-# Upload
-
-You must have two tools installed in your system, [ESPTool](https://docs.espressif.com/projects/esptool/en/latest/esp32/installation.html) and [Espressif IDF](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/#installation). After that please upload the binaries using:
+put `y` to enable some one like yes:
 
 ```bash
-python esptool.py --chip esp32s3 -p YOUR-PORT-HERE -b 921600 --before=default_reset --after=hard_reset write_flash 0x0 bootloader.bin 0x10000 network_adapter.bin 0x8000 partition-table.bin
-```
+# keep_toolchain=y	-- don't rebuild the toolchain, but rebuild everything else
+# keep_rootfs=y		-- don't reconfigure or rebuild rootfs from scratch. Would still apply overlay changes
+# keep_buildroot=y	-- don't redownload the buildroot, only git pull any updates into it
+# keep_bootloader=y	-- don't redownload the bootloader, only rebuild it
+# keep_etc=y		-- don't overwrite the /etc partition
+``` 
+
+4. Run the build script of your preference, for example:
 
 ```bash
-parttool.py write_partition --partition-name linux --input xipImage
+docker run --rm -it --name esp32s3linux --user="$(id -u):$(id -g)" -v ./esp32-linux-build:/app --env-file settings.cfg --device-cgroup-rule='c 166:* rmw' --device=/dev/ttyACM0 esp32linuxbase ./rebuild-esp32s3-linux-wifi.sh
 ```
 
+Keep in mind that you should change the --device to your USB device where is connected the ESP32S3.For a different script please check the directory `esp32-linux-build`.This step takes around ~35 minutes and needs ~20Gb:
+
+![ESP32S3 Linux image build](screenshots/docker_build.jpg)
+
+After that you should have this message:
+
+![ESP32S3 Linux finish build](screenshots/docker_build_before_flash.jpg)
+
+5. Open a different terminal and enter to the running container: 
+
 ```bash
-parttool.py write_partition --partition-name rootfs --input rootfs.cramfs
+docker exec -it -u root esp32s3linux bash
 ```
 
-And the etc partition:¨ (skip it if you preserver your settings)
+and change the docker USB device permissions:
 
 ```bash
-parttool.py write_partition --partition-name etc --input build-buildroot-esp32s3/images/etc.jffs2
+chmod 666 /dev/ttyACM0 
 ```
 
-Alternative following this [Adafruit guide](https://learn.adafruit.com/docker-esp32-s3-linux/docker-esp32-s3-linux-image).
+6. Return to the main terminal and perform the flashing. And that's it!
+
+![ESP32S3 Linux final flashing](screenshots/docker_flashing.jpg)
 
 # Linux boot
 
@@ -124,9 +139,9 @@ keep_toolchain=y keep_rootfs=y keep_buildroot=y keep_bootloader=y keep_etc=y ./r
 
 # TODO
 
-- [ ] Migrate to the last script version with build parameters
-- [ ] Freezing repositories to specific commit
-- [ ] Add provisioning stuff
+- [x] Migrate to the last script version with build parameters
+- [x] Freezing repositories to specific commit
+- [x] Add provisioning stuff (etc partition)
 
 # Credits
 

esp32-linux-build

@@ -0,0 +1,5 @@
+keep_toolchain=
+keep_rootfs=
+keep_buildroot=
+keep_bootloader=
+keep_etc=