From 500c9ded7fcd94c689e4a08bf598e2075b2c4a34 Mon Sep 17 00:00:00 2001 From: Michel-FK Date: Thu, 19 Nov 2020 17:15:25 +0100 Subject: [PATCH] FunKey-OS Release 1.00 Signed-off-by: Michel-FK --- FunKey/board/funkey/rootfs-overlay/etc/issue | 2 +- .../funkey/rootfs-overlay/etc/os-release | 6 +-- .../funkey/rootfs-overlay/etc/sw-versions | 2 +- README.md | 43 ++++++++----------- .../board/funkey/rootfs-overlay/etc/issue | 2 +- .../funkey/rootfs-overlay/etc/os-release | 6 +-- .../funkey/rootfs-overlay/etc/sw-versions | 2 +- docker/Dockerfile | 34 ++++++--------- docker/apt-sources.list | 4 -- 9 files changed, 42 insertions(+), 59 deletions(-) delete mode 100644 docker/apt-sources.list diff --git a/FunKey/board/funkey/rootfs-overlay/etc/issue b/FunKey/board/funkey/rootfs-overlay/etc/issue index c4099eb..2c0d9ed 100644 --- a/FunKey/board/funkey/rootfs-overlay/etc/issue +++ b/FunKey/board/funkey/rootfs-overlay/etc/issue @@ -5,6 +5,6 @@ |___| |_____|__|__||__|\__||_____|___ | FUN ON A KEYCHAIN |_____| ----------------------------------------------------- - Version 0.98 + Version 1.00 ----------------------------------------------------- diff --git a/FunKey/board/funkey/rootfs-overlay/etc/os-release b/FunKey/board/funkey/rootfs-overlay/etc/os-release index 2595272..1e3816a 100644 --- a/FunKey/board/funkey/rootfs-overlay/etc/os-release +++ b/FunKey/board/funkey/rootfs-overlay/etc/os-release @@ -1,9 +1,9 @@ NAME="FunKey-OS" -VERSION="0.98 (Khaki Kitten)" +VERSION="1.00 (Khaki Kitten)" ID=funkey ID_LIKE=buildroot -PRETTY_NAME="FunKey-OS 0.98" -VERSION_ID="0.98" +PRETTY_NAME="FunKey-OS 1.00" +VERSION_ID="1.00" HOME_URL="https://www.funkey-project.com/" SUPPORT_URL="https://www.funkey-project.com/" BUG_REPORT_URL="https://www.funkey-project.com/" diff --git a/FunKey/board/funkey/rootfs-overlay/etc/sw-versions b/FunKey/board/funkey/rootfs-overlay/etc/sw-versions index 7b8c28b..9841a3d 100644 --- a/FunKey/board/funkey/rootfs-overlay/etc/sw-versions +++ b/FunKey/board/funkey/rootfs-overlay/etc/sw-versions @@ -1 +1 @@ -rootfs 0.98 +rootfs 1.00 diff --git a/README.md b/README.md index c58d331..12940e9 100755 --- a/README.md +++ b/README.md @@ -107,58 +107,41 @@ After building, you should obtain the SD Card image `sdcard.img` and the firmwar When using a Docker container, all the prerequisites are automatically installed. ### How to get the sources -When using a Docker container, you must first get the FunKey-OS [Dockerfile](https://raw.githubusercontent.com/Michel-FK/FunKey-Project/master/docker/Dockerfile) and Debian [apt-sources.list](https://raw.githubusercontent.com/Michel-FK/FunKey-Project/master/docker/apt-sources.list) and put them into a separate directory: +When using a Docker container, you must first get the FunKey-OS [Dockerfile](https://raw.githubusercontent.com/Michel-FK/FunKey-Project/master/docker/Dockerfile) and put it into a separate directory: ```bash $ mkdir $ cd $ wget https://raw.githubusercontent.com/FunKey-Project/FunKey-OS/master/docker/Dockerfile -$ wget https://raw.githubusercontent.com/FunKey-Project/FunKey-OS/master/docker/apt-sources.list ``` You must then build the docker image (don't forget the final dot!): ```bash $ docker build -t funkey-project/funkey-os . ``` -You are now ready to run interactively a new container based on this docker image: -```bash -$ docker run -d -it --name funkey-os funkey-project/funkey-os -``` -You can then clone the FunKey OS repository from Github in this brand new container: - -```bash -$ git clone https://github.com/FunKey-Project/FunKey-OS.git -``` -Then enter into the created directory: - -```bash -$ cd -``` - ### Build the disk image & firmware update files You may now build your FunKey with: ```bash -$ make +$ docker run -d -name funkey-os funkey-project/funkey-os ``` This may take a while, consider getting yourself a cup or glass of your favorite beverage ;-) Note: you will need to have access to the network, since buildroot will download the package sources. ### Result of the build -After building, you can exit the container by typing Ctrl+D. - -You can copy the SD Card image `sdcard.img` and the firmware update file `FunKey-rootfs-X.Y.fwu` from the container into the host current directory: +After building, you can copy the SD Card image `sdcard.img` and the firmware update file `FunKey-rootfs-X.Y.fwu` from the container into the host current directory: ```bash -$ docker cp funkey-os:/home/funkey//images/sdcard.img ./ -$ docker cp funkey-os:/home/funkey//images/FunKey-rootfs-X.Y.fwu ./ +$ mkdir images +$ docker cp funkey-os:/home/funkey//images/sdcard.img images/ +$ docker cp funkey-os:/home/funkey//images/FunKey-rootfs-X.Y.fwu images/ ``` ## How to write to the SD card -You can copy the bootable "sdcard.img" onto an SD card using "dd": +You can copy the bootable `images/sdcard.img` onto an SD card using "dd": ```bash -$ sudo dd if=sdcard.img of=/dev/sdX +$ sudo dd if=images/sdcard.img of=/dev/sdX ``` Warning: Please make sure that */dev/sdX* device corresponds to your SD Card, otherwise you may wipe out one of your hard drive partitions! @@ -170,3 +153,13 @@ https://www.balena.io/etcher/ Once the SD card is burnt, insert it into your FunKey S console slot, and power it up. Your new system should come up now and start a console on the UART0 serial port and display the retro game launcher on the graphical screen. + +## How to update the FunKey S firmware +It is possible to update a FunKey-S over USB: + - Connect the FunKey S console to your host machine using the USB cable + - From the retro-game launcher, press the **ON/OFF** button to access the menu + - Using the **Up/Down** keys, select the "**MOUNT USB**" screen ad press the "**A**" key twice to mount the FunKey S on your machine as an USB mass storage drive + - Drag and drop the images/FunKey-rootfs-X.Y.fwu file into it + - When finished, eject the USB mass storage from your host machine + - Back on the FunKey S console, press the "**A**" key twice to eject the USB mass storage drive + - The FunKey S console will automatically detect the firmware update file and proceed with the update before returning to the retro game launcher screen once finished diff --git a/Recovery/board/funkey/rootfs-overlay/etc/issue b/Recovery/board/funkey/rootfs-overlay/etc/issue index 133bd79..631594b 100644 --- a/Recovery/board/funkey/rootfs-overlay/etc/issue +++ b/Recovery/board/funkey/rootfs-overlay/etc/issue @@ -5,6 +5,6 @@ |___| |_____|__|__||__|\__||_____|___ | FUN ON A KEYCHAIN |_____| ----------------------------------------------------- - Version 0.991 (Recovery) + Version 1.00 (Recovery) ----------------------------------------------------- diff --git a/Recovery/board/funkey/rootfs-overlay/etc/os-release b/Recovery/board/funkey/rootfs-overlay/etc/os-release index e995ef6..343e839 100644 --- a/Recovery/board/funkey/rootfs-overlay/etc/os-release +++ b/Recovery/board/funkey/rootfs-overlay/etc/os-release @@ -1,9 +1,9 @@ NAME="FunKey-OS Recovery" -VERSION="0.991 (Khaki Kitten)" +VERSION="1.00 (Khaki Kitten)" ID=funkey-recovery ID_LIKE=buildroot -PRETTY_NAME="FunKey-OS Recovery 0.991" -VERSION_ID="0.991" +PRETTY_NAME="FunKey-OS Recovery 1.00" +VERSION_ID="1.00" HOME_URL="https://www.funkey-project.com/" SUPPORT_URL="https://www.funkey-project.com/" BUG_REPORT_URL="https://www.funkey-project.com/" diff --git a/Recovery/board/funkey/rootfs-overlay/etc/sw-versions b/Recovery/board/funkey/rootfs-overlay/etc/sw-versions index 28995c1..a713adc 100644 --- a/Recovery/board/funkey/rootfs-overlay/etc/sw-versions +++ b/Recovery/board/funkey/rootfs-overlay/etc/sw-versions @@ -1 +1 @@ -Recovery 0.991 +Recovery 1.00 diff --git a/docker/Dockerfile b/docker/Dockerfile index 11a6dba..35471b7 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -8,9 +8,6 @@ LABEL \ # Setup environment ENV DEBIAN_FRONTEND noninteractive -# This repository can be a bit slow at times. Don't panic... -COPY apt-sources.list /etc/apt/sources.list - RUN \ # Install dependencies # See https://buildroot.org/downloads/manual/manual.html#requirement @@ -94,13 +91,9 @@ RUN \ usermod -a -G sudo funkey && \ echo "funkey:funkey" | chpasswd && \ # - # Create skeleton directories - # mkdir -p /home/funkey/.buildroot-ccache \ - # /home/funkey/FunKey-OS/buildroot \ - # /home/funkey/FunKey-OS/FunKey/dl \ - # /home/funkey/FunKey-OS/FunKey/output/build \ - # /home/funkey/FunKey-OS/FunKey/output/host \ - # /home/funkey/FunKey-OS/FunKey/output/target && \ + # Clone the FunKey-OS repository + git config --global url."https://91133a45ba476b7fc73c7b190dc597fa8f9c909d:@github.com/".insteadOf "https://github.com/" && \ + git clone https://github.com/Michel-FK/FunKey-OS.git /home/funkey/FunKey-OS && \ # # Set file ownership chown -R funkey:funkey /home/funkey @@ -108,22 +101,23 @@ RUN \ # Set user USER funkey +# Set working directory +WORKDIR /home/funkey/FunKey-OS + # Set environment ENV \ HOME=/home/funkey \ - LC_ALL=en_US.UTF-8 \ - BR2_EXTERNAL=../FunKey \ - O=../FunKey/output - -# Set working directory -WORKDIR /home/funkey/ -#WORKDIR /home/funkey/FunKey-OS + LC_ALL=en_US.UTF-8 # VOLUME ["/home/funkey/.buildroot-ccache", \ # "/home/funkey/FunKey-OS/buildroot", \ -# "/home/funkey/FunKey-OS/FunKey/dl", \ -# "/home/funkey/FunKey-OS/FunKey/output/build", \ +# "/home/funkey/FunKey-OS/dowload", \ +# "/home/funkey/FunKey-OS/images", \ +# "/home/funkey/FunKey-OS/Recovery/output/build", \ +# "/home/funkey/FunKey-OS/Recovery/output/host", \ +# "/home/funkey/FunKey-OS/Recovery/output/target", \ # "/home/funkey/FunKey-OS/FunKey/output/host", \ +# "/home/funkey/FunKey-OS/FunKey/output/build", \ # "/home/funkey/FunKey-OS/FunKey/output/target"] -#CMD ["/bin/bash"] +CMD ["/usr/bin/make", "-C", "/home/funkey/FunKey-OS"] diff --git a/docker/apt-sources.list b/docker/apt-sources.list deleted file mode 100644 index 0eb2269..0000000 --- a/docker/apt-sources.list +++ /dev/null @@ -1,4 +0,0 @@ -# Latest just before 20200514T000000Z: -deb [check-valid-until=no] http://snapshot.debian.org/archive/debian/20200513T204247Z/ buster main -deb [check-valid-until=no] http://snapshot.debian.org/archive/debian/20200513T204247Z/ buster-updates main -deb [check-valid-until=no] http://snapshot.debian.org/archive/debian-security/20200513T204247Z/ buster/updates main