Add blink test firmware, docs and new schematic iterations

10 files changed, 155 insertions, 0 deletions

diff --git a/firmware/.gitignore b/firmware/.gitignore
new file mode 100644
index 0000000..aa42767
--- /dev/null
+++ b/firmware/.gitignore
@@ -0,0 +1 @@
+idf-tools
diff --git a/firmware/activate.sh b/firmware/activate.sh
new file mode 100755
index 0000000..4f03eda
--- /dev/null
+++ b/firmware/activate.sh
@@ -0,0 +1,5 @@
+#!/bin/sh
+
+pushd esp-idf
+. ./export.sh
+popd
diff --git a/firmware/esp-idf b/firmware/esp-idf
new file mode 160000
+Subproject e0991facf5ecb362af6aac1fae972139eb38d2e
diff --git a/firmware/setup.sh b/firmware/setup.sh
new file mode 100755
index 0000000..5b6379a
--- /dev/null
+++ b/firmware/setup.sh
@@ -0,0 +1,12 @@
+#!/bin/sh
+
+# SOURCE ME
+
+deactivate || true
+
+export IDF_TOOLS_PATH="$PWD/idf-tools"
+pushd esp-idf
+./install.sh
+. ./export.sh
+idf_tools.py install-python-env
+popd
diff --git a/firmware/src/.gitignore b/firmware/src/.gitignore
new file mode 100644
index 0000000..f8663ca
--- /dev/null
+++ b/firmware/src/.gitignore
@@ -0,0 +1,3 @@
+build
+sdkconfig*
+.cache
diff --git a/firmware/src/CMakeLists.txt b/firmware/src/CMakeLists.txt
new file mode 100644
index 0000000..0a454d0
--- /dev/null
+++ b/firmware/src/CMakeLists.txt
@@ -0,0 +1,6 @@
+# The following lines of boilerplate have to be in your project's
+# CMakeLists in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(hello_world)
diff --git a/firmware/src/README.md b/firmware/src/README.md
new file mode 100644
index 0000000..c3e1ee3
--- /dev/null
+++ b/firmware/src/README.md
@@ -0,0 +1,53 @@
+| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C5 | ESP32-C6 | ESP32-C61 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 | Linux |
+| ----------------- | ----- | -------- | -------- | -------- | -------- | --------- | -------- | -------- | -------- | -------- | ----- |
+
+# Hello World Example
+
+Starts a FreeRTOS task to print "Hello World".
+
+(See the README.md file in the upper level 'examples' directory for more information about examples.)
+
+## How to use example
+
+Follow detailed instructions provided specifically for this example.
+
+Select the instructions depending on Espressif chip installed on your development board:
+
+- [ESP32 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/index.html)
+- [ESP32-S2 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/get-started/index.html)
+
+
+## Example folder contents
+
+The project **hello_world** contains one source file in C language [hello_world_main.c](main/hello_world_main.c). The file is located in folder [main](main).
+
+ESP-IDF projects are built using CMake. The project build configuration is contained in `CMakeLists.txt` files that provide set of directives and instructions describing the project's source files and targets (executable, library, or both).
+
+Below is short explanation of remaining files in the project folder.
+
+```
+├── CMakeLists.txt
+├── pytest_hello_world.py      Python script used for automated testing
+├── main
+│   ├── CMakeLists.txt
+│   └── hello_world_main.c
+└── README.md                  This is the file you are currently reading
+```
+
+For more information on structure and contents of ESP-IDF projects, please refer to Section [Build System](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html) of the ESP-IDF Programming Guide.
+
+## Troubleshooting
+
+* Program upload failure
+
+    * Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.
+    * The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
+
+## Technical support and feedback
+
+Please use the following feedback channels:
+
+* For technical queries, go to the [esp32.com](https://esp32.com/) forum
+* For a feature request or bug report, create a [GitHub issue](https://github.com/espressif/esp-idf/issues)
+
+We will get back to you as soon as possible.
diff --git a/firmware/src/main/CMakeLists.txt b/firmware/src/main/CMakeLists.txt
new file mode 100644
index 0000000..07686dc
--- /dev/null
+++ b/firmware/src/main/CMakeLists.txt
@@ -0,0 +1,2 @@
+idf_component_register(SRCS "hello_world_main.c"
+                    INCLUDE_DIRS "")
diff --git a/firmware/src/main/hello_world_main.c b/firmware/src/main/hello_world_main.c
new file mode 100644
index 0000000..1222e05
--- /dev/null
+++ b/firmware/src/main/hello_world_main.c
@@ -0,0 +1,20 @@
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+#include "driver/gpio.h"
+#include "hal/gpio_types.h"
+
+#include <stdio.h>
+
+void app_main(void)
+{
+	gpio_reset_pin(3);
+	gpio_set_direction(3, GPIO_MODE_OUTPUT);
+	while (1) {
+		printf("Hello world!\n");
+		fflush(stdout);
+		gpio_set_level(3, 1);
+		vTaskDelay(1000 / portTICK_PERIOD_MS);
+		gpio_set_level(3, 0);
+		vTaskDelay(1000 / portTICK_PERIOD_MS);
+	}
+}
diff --git a/firmware/src/pytest_hello_world.py b/firmware/src/pytest_hello_world.py
new file mode 100644
index 0000000..caeeff1
--- /dev/null
+++ b/firmware/src/pytest_hello_world.py
@@ -0,0 +1,53 @@
+# SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
+# SPDX-License-Identifier: CC0-1.0
+
+import hashlib
+import logging
+from typing import Callable
+
+import pytest
+from pytest_embedded_idf.dut import IdfDut
+from pytest_embedded_qemu.app import QemuApp
+from pytest_embedded_qemu.dut import QemuDut
+
+
+@pytest.mark.supported_targets
+@pytest.mark.preview_targets
+@pytest.mark.generic
+def test_hello_world(
+    dut: IdfDut, log_minimum_free_heap_size: Callable[..., None]
+) -> None:
+    dut.expect('Hello world!')
+    log_minimum_free_heap_size()
+
+
+@pytest.mark.linux
+@pytest.mark.host_test
+def test_hello_world_linux(dut: IdfDut) -> None:
+    dut.expect('Hello world!')
+
+
+def verify_elf_sha256_embedding(app: QemuApp, sha256_reported: str) -> None:
+    sha256 = hashlib.sha256()
+    with open(app.elf_file, 'rb') as f:
+        sha256.update(f.read())
+    sha256_expected = sha256.hexdigest()
+
+    logging.info(f'ELF file SHA256: {sha256_expected}')
+    logging.info(f'ELF file SHA256 (reported by the app): {sha256_reported}')
+
+    # the app reports only the first several hex characters of the SHA256, check that they match
+    if not sha256_expected.startswith(sha256_reported):
+        raise ValueError('ELF file SHA256 mismatch')
+
+
+@pytest.mark.esp32  # we only support qemu on esp32 for now
+@pytest.mark.host_test
+@pytest.mark.qemu
+def test_hello_world_host(app: QemuApp, dut: QemuDut) -> None:
+    sha256_reported = (
+        dut.expect(r'ELF file SHA256:\s+([a-f0-9]+)').group(1).decode('utf-8')
+    )
+    verify_elf_sha256_embedding(app, sha256_reported)
+
+    dut.expect('Hello world!')