Merge pull request #23 from xboxoneresearch/task/stm32_firmware

Add stm32 firmware

Author: tuxuser

.github/workflows/build_pcbs.yml

@@ -3,23 +3,23 @@ name: Build PCBs
 on:
   workflow_call:
   push:
-#    paths:
-#    - "*.kicad_sch"
-#    - "*.kicad_pcb"
-#    - "*.kicad_pro"
-#    - "kibot.yml"
+    paths:
+    - "*.kicad_sch"
+    - "*.kicad_pcb"
+    - "*.kicad_pro"
+    - "kibot.yml"
   pull_request:
-#    paths:
-#    - "*.kicad_sch"
-#    - "*.kicad_pcb"
-#    - "*.kicad_pro"
-#    - "kibot.yml"
+    paths:
+    - "*.kicad_sch"
+    - "*.kicad_pcb"
+    - "*.kicad_pro"
+    - "kibot.yml"
 
 jobs:
-  build:
+  build_pcb:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
       - uses: INTI-CMNB/KiBot@v2_k9

.github/workflows/build_stm32_fw.yml

@@ -0,0 +1,49 @@
+name: STM32 Build
+
+on:
+  workflow_call:
+  push:
+    paths:
+    - "firmware/**"
+  pull_request:
+    paths:
+    - "firmware/**"
+
+env:
+  TOOLCHAIN_URL: https://developer.arm.com/-/media/Files/downloads/gnu/14.3.rel1/binrel/arm-gnu-toolchain-14.3.rel1-x86_64-arm-none-eabi.tar.xz
+
+jobs:
+  build_stm32_fw:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v5
+
+    - name: Install ARM GCC Toolchain
+      run: |
+        cd /tmp
+        wget -q -O arm-gnu-toolchain.tar.xz ${{ env.TOOLCHAIN_URL }}
+        tar -xf arm-gnu-toolchain.tar.xz
+        sudo mv arm-gnu-toolchain-* /opt/gcc-arm-none-eabi
+        echo "/opt/gcc-arm-none-eabi/bin" >> $GITHUB_PATH
+        
+    - name: Verify ARM GCC installation
+      run: |
+        arm-none-eabi-gcc --version
+        arm-none-eabi-objcopy --version
+
+    - name: Build
+      working-directory: firmware
+      run: make
+
+    - name: Upload build artifacts
+      uses: actions/upload-artifact@v4
+      if: success()
+      with:
+        name: aspect2-stm32-firmware-${{ github.sha }}
+        path: |
+          firmware/build/*.bin
+          firmware/build/*.elf
+          firmware/build/*.hex
+        retention-days: 30

.github/workflows/release.yml

@@ -7,7 +7,7 @@ on:
       - "v*.*"
 
 permissions:
-  contents: read
+  contents: write
   pages: write
   id-token: write
 
@@ -16,22 +16,29 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  build_pcb:
+  pcb:
     uses: xboxoneresearch/ASPECT2-PCB/.github/workflows/build_pcbs.yml@main
 
+  firmware:
+    uses: xboxoneresearch/ASPECT2-PCB/.github/workflows/build_stm32_fw.yml@main
+
   release:
     runs-on: ubuntu-latest
-    needs: [build_pcb]
+    needs: [pcb,firmware]
     if: success()
     environment:
       name: github-pages
       url: ${{ steps.release.outputs.page_url }}
     steps:
       - name: Download artifacts
-        uses: actions/download-artifact@v4
-      - name: Release
+        uses: actions/download-artifact@v5
+      - name: Zip up release artifact
+        run: 7z a aspect2-pcb-${{ github.ref_name }}.7z *
+      - name: Create release
         if: startsWith(github.ref, 'refs/tags/')
         uses: softprops/action-gh-release@v2
+        with:
+          files: aspect2-pcb-*.7z
 
       - uses: actions/upload-pages-artifact@v3
         with:

README.md

@@ -1,4 +1,5 @@
 [![Build PCBs](https://github.com/xboxoneresearch/ASPECT2-PCB/actions/workflows/build_pcbs.yml/badge.svg)](https://github.com/xboxoneresearch/ASPECT2-PCB/actions/workflows/build_pcbs.yml)
+[![Build firmware](https://github.com/xboxoneresearch/ASPECT2-PCB/actions/workflows/build_stm32_fw.yml/badge.svg)](https://github.com/xboxoneresearch/ASPECT2-PCB/actions/workflows/build_stm32_fw.yml)
 
 # ASPECT2 PCB
 
@@ -10,7 +11,8 @@
 This repo contains:
 
 * KiCad files for the PCB / schematics
-* EEPROM template for FT_PROG
+* [EEPROM template](./eeprom/) for FT_PROG
+* [STM32 firmware](./firmware/)
 
 ## Directory structure
 
@@ -19,6 +21,7 @@ This repo contains:
 ├── eeprom
 │   ├── Greybull_FabD+.xml - FT Prog template (official on-board FACET)
 │   └── Facet2_fabA+.xml - FT Prog template (derived from onboard FTDI dump)
+├── firmware - STM32 firmware
 ├── lib - additional KiCad symbols / footprints
 └── references - Datasheets and original blurry PCB photos
 ```
@@ -51,8 +54,13 @@ Before being able to communicate with the device, programming eeprom or regular
 * Click Close-button, close FT Prog tool
 * Re-plug Aspect2 board
 
+## Programming the STM32 (POST Code display)
+
+See [firmware/](./firmware/) for build & flash instructions.
+
 ## References
 
 - [AssemblerGames](https://web.archive.org/web/20250327165519/https://assemblergames.org/viewtopic.php?p=870129) - first mentioning of FACET2 PCB
 - [FACET on xosft wiki](https://xboxoneresearch.github.io/wiki/hardware/facet/) - Technical documentation of FACET port
+- [POST code on xosft wiki](https://xboxoneresearch.github.io/wiki/hardware/post/) - Original MAX6958A circuit and error codes
 - [libaspect2](https://github.com/xboxoneresearch/libaspect2) - Attempt at an open source library

assets/pcb_work_in_progress.png

@@ -0,0 +1,4 @@
+build/
+.vscode/
+.stm32env
+.mxproject

firmware/.gitignore

@@ -0,0 +1,21 @@
+#ifndef __DISPLAY_H
+#define __DISPLAY_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <ssd1306.h>
+#include <ssd1306_fonts.h>
+#include "ssd1306_conf.h"
+#include "main.h"
+
+void Display_Init(void);
+void Display_Print(char *message);
+void Display_Tick(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

firmware/Core/Inc/display.h

@@ -0,0 +1,71 @@
+/* USER CODE BEGIN Header */
+/**
+  ******************************************************************************
+  * @file           : main.h
+  * @brief          : Header for main.c file.
+  *                   This file contains the common defines of the application.
+  ******************************************************************************
+  * @attention
+  *
+  * Copyright (c) 2025 STMicroelectronics.
+  * All rights reserved.
+  *
+  * This software is licensed under terms that can be found in the LICENSE file
+  * in the root directory of this software component.
+  * If no LICENSE file comes with this software, it is provided AS-IS.
+  *
+  ******************************************************************************
+  */
+/* USER CODE END Header */
+
+/* Define to prevent recursive inclusion -------------------------------------*/
+#ifndef __MAIN_H
+#define __MAIN_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* Includes ------------------------------------------------------------------*/
+#include "stm32g0xx_hal.h"
+
+/* Private includes ----------------------------------------------------------*/
+/* USER CODE BEGIN Includes */
+#include <string.h>
+#include <stdio.h>
+#include <stdint.h>
+/* USER CODE END Includes */
+
+/* Exported types ------------------------------------------------------------*/
+/* USER CODE BEGIN ET */
+
+/* USER CODE END ET */
+
+/* Exported constants --------------------------------------------------------*/
+/* USER CODE BEGIN EC */
+
+/* USER CODE END EC */
+
+/* Exported macro ------------------------------------------------------------*/
+/* USER CODE BEGIN EM */
+
+/* USER CODE END EM */
+
+/* Exported functions prototypes ---------------------------------------------*/
+void Error_Handler(void);
+
+/* USER CODE BEGIN EFP */
+
+/* USER CODE END EFP */
+
+/* Private defines -----------------------------------------------------------*/
+
+/* USER CODE BEGIN Private defines */
+
+/* USER CODE END Private defines */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __MAIN_H */

firmware/Core/Inc/main.h

@@ -0,0 +1,25 @@
+#ifndef _SLAVE_H
+#define _SLAVE_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include "main.h"
+
+#define REG_MAP_SIZE      0x25
+
+void Slave_Init(void);
+
+/* Example accessors */
+uint8_t slave_reg_read(uint8_t addr);
+void slave_reg_write(uint8_t addr, uint8_t val);
+
+uint8_t slave_is_new_segment_available(void);
+uint8_t slave_hard_error(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

firmware/Core/Inc/slave.h

@@ -0,0 +1,70 @@
+/**
+ * Private configuration file for the SSD1306 library.
+ * This example is configured for STM32F0, I2C and including all fonts.
+ */
+
+#ifndef _SSD1306_CONF_H
+#define _SSD1306_CONF_H
+
+// Choose a microcontroller family
+//#define STM32F0
+//#define STM32F1
+//#define STM32F4
+//#define STM32L0
+//#define STM32L1
+//#define STM32L4
+//#define STM32F3
+//#define STM32H7
+//#define STM32F7
+#define STM32G0
+//#define STM32C0
+//#define STM32U5
+
+// Choose a bus
+#define SSD1306_USE_I2C
+//#define SSD1306_USE_SPI
+
+// I2C Configuration
+#define SSD1306_I2C_PORT        hi2c2
+#define SSD1306_I2C_ADDR        (0x3C << 1)
+
+// SPI Configuration
+//#define SSD1306_SPI_PORT        hspi1
+//#define SSD1306_CS_Port         OLED_CS_GPIO_Port
+//#define SSD1306_CS_Pin          OLED_CS_Pin
+//#define SSD1306_DC_Port         OLED_DC_GPIO_Port
+//#define SSD1306_DC_Pin          OLED_DC_Pin
+//#define SSD1306_Reset_Port      OLED_Res_GPIO_Port
+//#define SSD1306_Reset_Pin       OLED_Res_Pin
+
+// Mirror the screen if needed
+#define SSD1306_MIRROR_VERT
+#define SSD1306_MIRROR_HORIZ
+
+// Set inverse color if needed
+// # define SSD1306_INVERSE_COLOR
+
+// Include only needed fonts
+#define SSD1306_INCLUDE_FONT_6x8
+#define SSD1306_INCLUDE_FONT_7x10
+#define SSD1306_INCLUDE_FONT_11x18
+#define SSD1306_INCLUDE_FONT_16x26
+
+#define SSD1306_INCLUDE_FONT_16x24
+
+#define SSD1306_INCLUDE_FONT_16x15
+
+// The width of the screen can be set using this
+// define. The default value is 128.
+#define SSD1306_WIDTH           128
+
+// If your screen horizontal axis does not start
+// in column 0 you can use this define to
+// adjust the horizontal offset
+// #define SSD1306_X_OFFSET
+
+// The height can be changed as well if necessary.
+// It can be 32, 64 or 128. The default value is 64.
+#define SSD1306_HEIGHT          32
+
+#endif