summary refs log tree commit diff stats
path: root/firmware
diff options
context:
space:
mode:
authorChristian Krinitsin <code@krinitsin.xyz>2024-12-21 22:10:45 +0100
committerChristian Krinitsin <code@krinitsin.xyz>2024-12-22 19:30:47 +0100
commit48ac28d8ea1f713451af339009bb1d589dde6cc6 (patch)
treeaada7cbf4213db62326f6cb369167c943ddfd03f /firmware
downloadtetris-console-48ac28d8ea1f713451af339009bb1d589dde6cc6.tar.gz
tetris-console-48ac28d8ea1f713451af339009bb1d589dde6cc6.zip
init
Diffstat (limited to 'firmware')
-rw-r--r--firmware/.gitignore3
-rw-r--r--firmware/boards/seeed_xiao_esp32c6.json48
-rw-r--r--firmware/include/README39
-rw-r--r--firmware/lib/README46
-rw-r--r--firmware/platformio.ini4
-rw-r--r--firmware/src/main.cpp11
-rw-r--r--firmware/test/README11
7 files changed, 162 insertions, 0 deletions
diff --git a/firmware/.gitignore b/firmware/.gitignore
new file mode 100644
index 0000000..16a1db8
--- /dev/null
+++ b/firmware/.gitignore
@@ -0,0 +1,3 @@
+.pio
+compile_commands.json
+.cache
diff --git a/firmware/boards/seeed_xiao_esp32c6.json b/firmware/boards/seeed_xiao_esp32c6.json
new file mode 100644
index 0000000..224f0e2
--- /dev/null
+++ b/firmware/boards/seeed_xiao_esp32c6.json
@@ -0,0 +1,48 @@
+{
+  "build": {
+    "core": "esp32",
+    "extra_flags": [
+      "-DARDUINO_XIAO_ESP32C6",
+      "-DARDUINO_USB_MODE=1",
+      "-DARDUINO_USB_CDC_ON_BOOT=1"
+    ],
+    "f_cpu": "160000000L",
+    "f_flash": "80000000L",
+    "flash_mode": "qio",
+    "hwids": [
+      [
+        "0x2886",
+        "0x0046"
+      ],
+      [
+        "0x303a",
+        "0x1001"
+      ]
+    ],
+    "mcu": "esp32c6",
+    "variant": "XIAO_ESP32C6"
+  },
+  "connectivity": [
+    "wifi",
+    "bluetooth",
+    "zigbee",
+    "thread"
+  ],
+  "debug": {
+    "openocd_target": "esp32c6.cfg"
+  },
+  "frameworks": [
+    "arduino",
+    "espidf"
+  ],
+  "name": "Seeed Studio XIAO ESP32C6",
+  "upload": {
+    "flash_size": "4MB",
+    "maximum_ram_size": 327680,
+    "maximum_size": 4194304,
+    "require_upload_port": true,
+    "speed": 460800
+  },
+  "url": "https://wiki.seeedstudio.com/XIAO_ESP32C6_Getting_Started/",
+  "vendor": "Seeed Studio"
+}
diff --git a/firmware/include/README b/firmware/include/README
new file mode 100644
index 0000000..194dcd4
--- /dev/null
+++ b/firmware/include/README
@@ -0,0 +1,39 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html
diff --git a/firmware/lib/README b/firmware/lib/README
new file mode 100644
index 0000000..2593a33
--- /dev/null
+++ b/firmware/lib/README
@@ -0,0 +1,46 @@
+
+This directory is intended for project specific (private) libraries.
+PlatformIO will compile them to static libraries and link into executable file.
+
+The source code of each library should be placed in an own separate directory
+("lib/your_library_name/[here are source files]").
+
+For example, see a structure of the following two libraries `Foo` and `Bar`:
+
+|--lib
+|  |
+|  |--Bar
+|  |  |--docs
+|  |  |--examples
+|  |  |--src
+|  |     |- Bar.c
+|  |     |- Bar.h
+|  |  |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
+|  |
+|  |--Foo
+|  |  |- Foo.c
+|  |  |- Foo.h
+|  |
+|  |- README --> THIS FILE
+|
+|- platformio.ini
+|--src
+   |- main.c
+
+and a contents of `src/main.c`:
+```
+#include <Foo.h>
+#include <Bar.h>
+
+int main (void)
+{
+  ...
+}
+
+```
+
+PlatformIO Library Dependency Finder will find automatically dependent
+libraries scanning project source files.
+
+More information about PlatformIO Library Dependency Finder
+- https://docs.platformio.org/page/librarymanager/ldf.html
diff --git a/firmware/platformio.ini b/firmware/platformio.ini
new file mode 100644
index 0000000..f25f51e
--- /dev/null
+++ b/firmware/platformio.ini
@@ -0,0 +1,4 @@
+[env:seeed_xiao_esp32c6]
+platform = espressif32
+board = seeed_xiao_esp32c6
+framework = arduino
diff --git a/firmware/src/main.cpp b/firmware/src/main.cpp
new file mode 100644
index 0000000..a669a09
--- /dev/null
+++ b/firmware/src/main.cpp
@@ -0,0 +1,11 @@
+#include <Arduino.h>
+
+void setup()
+{
+
+}
+
+void loop()
+{
+
+}
diff --git a/firmware/test/README b/firmware/test/README
new file mode 100644
index 0000000..9b1e87b
--- /dev/null
+++ b/firmware/test/README
@@ -0,0 +1,11 @@
+
+This directory is intended for PlatformIO Test Runner and project tests.
+
+Unit Testing is a software testing method by which individual units of
+source code, sets of one or more MCU program modules together with associated
+control data, usage procedures, and operating procedures, are tested to
+determine whether they are fit for use. Unit testing finds problems early
+in the development cycle.
+
+More information about PlatformIO Unit Testing:
+- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html