Communitygithub.com

ALOLAN96/stm32-architecture-c

STM32組み込みCアーキテクチャガイダンス:CubeMX + HALレイヤリング、BSP/Driver/Module/App境界、RTOS/OSAL設計、Bootloader/IAP、Gitワークフロー、Cスタイルを提供するCodexスキルです。

stm32-architecture-c とは?

このスキルは、STM32マイコン向けの組み込みCプロジェクトにおいて、アーキテクチャ設計とコードレビューを支援するCodexスキルです。Claude Code、Cursor、またはCodexなどのAIエージェント上で動作し、アーキテクチャメンターのように振る舞い、実装前に設計上の判断を優先します。主な機能として、CubeMX + HALレイヤリングに基づいたBSP/Driver/Module/Appの境界定義、FreeRTOSやCMSIS-RTOSを用いたRTOS/OSAL設計、ブートローダー/IAPのパーティション設計とイメージ検証、命名規則とCスタイルの遵守、Gitワークフローの統一をガイドします。また、抽象化の判断基準を明確に示し、ハードウェア依存性の分離とユニットテスト容易性を高めます。対応プラットフォームはKeil MDK、VS Code + EIDE、FreeRTOS、将来的なZephyr移行を視野に入れており、アーキテクチャ決定からバリデーションまでの一貫したアプローチを提供します。

対応✓Claude Code✓Codex CLI~Cursor
npx skills add ALOLAN96/stm32-architecture-c

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

STM32 Architecture C

動作スタイル

組み込みアーキテクチャのメンター兼デバッグ同僚のように振る舞います。コードの前に理由を説明し、アーキテクチャに実質的な影響を与える不足している制約のみを質問し、それ以外はCubeMX + HAL、Keil MDK、VS Code + EIDE、FreeRTOS、および将来のZephyr移行に基づいて保守的な仮定を行います。

実装よりもアーキテクチャ決定を優先します:

  1. 製品の動作、ハードウェアリソース、タイミング、通信経路、アップグレード要件、障害処理を明確にします。
  2. モジュール境界とデータフローを提案します。
  3. ISR、DMA、ポーリング、メインループ、タスク、キュー、イベントフラグ、ミューテックス、タイマーの使用を決定します。
  4. ファイルを適切なレイヤーに配置します。
  5. プロジェクトの命名規則とCスタイルを使用してコードを生成またはレビューします。
  6. 検証手順と推定されるデバッグポイントをリストアップします。

リファレンスの読み込み

必要なリファレンスファイルのみを読み込みます:

  • references/stm32-architecture.md:ディレクトリレイアウト、依存関係ルール、BSP/App/Driver/Module/Services/Config/Utilsの責務、MDKグループ、トレース、診断、設定、タスク設計。
  • references/naming-and-c-style.md:プロジェクト命名ポリシー、大文字の技術略語、Cスタイル、マクロ、変数、安全ルール。
  • references/rtos-zephyr.md:FreeRTOS/CMSIS-RTOS/OSALの選択とZephyr移行に適した設計。
  • references/bootloader-iap.md:ブートローダー/IAPのパーティション分割、イメージ検証、ロールバック、バージョニング、アプリジャンプに関する考慮事項。
  • references/git-workflow.md:ブランチの選択、リポジトリファイルポリシー、.gitignore、リリースアーティファクトのルール。
  • references/architecture-handoff-artifacts.md:Guidelines/ 下にある、Claude生成の要件、システム設計、モジュール仕様、Codexプロンプト、レビューレポート、ADRなどの上流アーキテクチャハンドオフアーティファクトの意味と使用方法。

アーキテクチャルール

CubeMX生成コードは、主に Core、Drivers、Middlewares、および CubeMX 生成ミドルウェアディレクトリに保持します。手書きのプロジェクトコードは User の下に配置します。

既存のプロジェクトに互換性のある構造がない限り、以下の手書きレイヤーを使用します:

User/App
User/BSP
User/Device または User/Driver
User/Module
User/OS
User/Services
User/Config
User/Utils
User/ThirdParty

依存関係の方向性を尊重します:

  • App はタスク、イベント、ステートマシン、コマンド処理、製品フローを調整します。
  • BSP はボードレベルのハードウェア機能をラップし、HAL/レジスタの詳細を隠蔽します。
  • Device または Driver は外部チップ、センサー、ディスプレイ、メモリ、通信モジュールをラップします。
  • Module は HAL、UART、GPIO、DMA、RTOS API を直接呼び出さない再利用可能なロジックを含みます。
  • OS または OSAL は、CMSIS-RTOS が十分でない場合に OS の動作をラップします。
  • Services はトレース、診断、イベント、パラメータ管理、バージョン、ヘルスモニタリングを提供します。
  • Config は機能スイッチ、サイズ、優先順位、タイムアウト、アドレス、モジュールパラメータを一元管理します。
  • Utils はリングバッファ、CRC、ステータスコード、バイトオーダー、リスト、数学ヘルパーなどのハードウェア非依存のヘルパーを含みます。

複雑なビジネスロジックを割り込み、CubeMX 初期化ファイル、または BSP コールバックに配置しないでください。ISR および DMA コールバックは、フラグをクリアし、最小限のデータを移動し、イベント、キュー、または同期オブジェクトを通じて App に通知する必要があります。

抽象化の判断

実際の変更点、所有権境界、リスク境界を分離するために抽象化を作成します。HAL API の名前を変更したり、コードをより階層的に見せたりするためだけに抽象化を作成しないでください。

抽象化する場合:

  • 上位レイヤーが基礎となる HAL、LL、RTOS、DMA、GPIO、UART、バッファ実装を知るべきでない場合
  • 同じ機能が複数のボード、チップ、RTOS、テスト、シミュレーターで実装される可能性がある場合
  • モジュールをユニットテスト、モック、またはターゲットハードウェアなしで実行する必要がある場合
  • 複数の呼び出し元が1つのハードウェアリソースを競合し、単一の所有者がアクセスを直列化する必要がある場合
  • プロトコル、ポリシー、設定、またはリカバリルールを集中化する必要がある場合
  • 複数のモジュールに重複したハードウェアアクセスパターンが現れる場合
  • 将来別のボード、RTOS、またはドライバモデルへの移行が妥当であり、境界がすでに明確である場合

抽象化を避ける場合:

  • 実装が1つだけで、明確なバリエーションポイントがない場合
  • ラッパーが単に HAL 関数名や引数リストをミラーリングしているだけの場合
  • 抽象化が重要なタイミング、ISR、DMA、所有権の動作を隠蔽する場合
  • 関数ポインタ、グローバルレジストリ、動的割り当て、またはライフサイクルの複雑さを早期に導入する場合
  • 結合、重複、リスクを減らすことなく、呼び出しパスが長くなる場合

最低限で十分な抽象化メカニズムを使用します。まず通常の .h/.c モジュールインターフェースを優先し、必要に応じてコンパイル時の選択やコールバックを使用します。ランタイムポリモーフィズム、複数インスタンス、シミュレーション、またはプラットフォーム非依存のコアロジックが真に必要な場合にのみ、関数ポインタ操作テーブルを使用します。

CubeMX、HAL、BSP の範囲

CubeMX 生成の MX_xxx_Init() 関数は、静的ペリフェラル設定(クロック、GPIO 代替機能、DMA リンケージ、NVIC 設定、HAL ハンドル初期化)として扱います。生成コードは主に CubeMX が所有するファイルに保持し、手書きのランタイム動作は User の下に配置します。

BSP は手書きコードで使用されるボードレベルの機能をラップします。すべての HAL API を機械的にラップするわけではありません。プロジェクトが真に汎用的な UART、SPI、I2C、GPIO レイヤーを必要としない限り、BSP_MODEM_UART_Start、BSP_DEBUG_UART_Write、BSP_EEPROM_I2C_Read などの機能名を優先します。

BSP には以下を含めることができます:

  • ペリフェラルの起動、オープン、停止、再起動、エラーリカバリロジック
  • DMA 受信/送信の起動と再起動
  • ドライバローカルバッファの初期化、リングバッファの移動、ビジーフラグ、エラーフラグ、オーバーフローカウンタ
  • HAL ISR コールバックからモジュールまたはタスク通知へのルーティング
  • EXTI タイムスタンプキャプチャと最小限の ISR 側イベント記録
  • デフォルトのボードピン状態とボード固有のハードウェアイネーブルシーケンス

BSP に含めてはならないもの:

  • 外部デバイスのプロトコル解析、フレームチェックサム、オペコード、パケットセマンティクス
  • 保存、リセット、オンライン移行、キャリブレーション、アドミッションフローなどのコマンドシーケンス
  • ビジネスペイロードの解釈や製品状態遷移
  • ネットワークポリシー、パラメータ自己修復ルール、外部デバイスのリカバリステートマシン

外部チップの場合、次の依存関係の方向性を優先します:App -> Device/Driver -> port -> BSP -> HAL。port レイヤーはボードの機能を外部デバイスに適応させ、BSP はボードレベルでプロトコルに依存しないままです。

ボード初期化の境界

ボード初期化は、別のハードウェア機能レイヤーとしてではなく、オーケストレーションとして保持します。

CubeMX の MX_xxx_Init() 関数を静的ハードウェア設定に使用します。これらの生成された初期化関数を呼び出し、次に BSP ソフトウェア状態を初期化する、単一のボードレベル初期化子を優先します:

main/App
  -> BSP_BoardInit() または BOARD_InitHardware()
      -> MX_GPIO_Init()
      -> MX_DMA_Init()
      -> MX_USARTx_UART_Init()
      -> BSP_xxx_InitState()

小規模プロジェクトでは、このオーケストレーションを User/BSP/bsp_board.c に配置します。大規模またはマルチボードプロジェクトでは、別の User/Board レイヤーが許容されます。どちらの場合も、ボード初期化子はボードを組み立てるだけであり、UART 送信、GPIO 書き込み、デバイスリセット、センサー読み取り、外部チップコマンドなどのランタイム機能は提供しません。

各 BSP モジュールが MX_GPIO_Init() や MX_DMA_Init() などのグローバルな CubeMX 初期化関数を呼び出さないようにします。これらはボード全体の静的設定エントリポイントであり、単一モジュールが所有するものではありません。個々の BSP モジュールは、自身のソフトウェア状態とランタイム機能のみを初期化する必要があります:

BSP_xxx_InitState()
  -> バッファ、フラグ、カウンタ、デフォルト出力状態
BSP_xxx_Start/Open()
  -> DMA 受信開始、ペリフェラルランタイム有効化、タスク通知
BSP_xxx_Stop/Restart()
  -> ランタイムシャットダウンまたはエラーリカバリ

ライフサイクルと状態の所有権

静的初期化とランタイム起動を分離します。

  • CubeMX MX_xxx_Init() はペリフェラルハードウェアを設定します。
  • BSP InitState 関数は BSP が所有するソフトウェア状態を初期化します。
  • BSP Start または Open 関数はペリフェラルをアプリケーションコードが使用できるようにします。
  • BSP Stop または Restart 関数はランタイム無効化、エラーリカバリ、DMA/UART 再起動を処理します。
  • デバイスドライバは外部デバイスのプロトコル状態を所有します。
  • App タスクは製品の動作とオーケストレーションを所有します。

ランタイム状態の所有権を分散させないでください。各状態変数には1つの所有者がいる必要があります。UART RX バッファは BSP またはデバイスポートに属し、プロトコルパーサーの状態はプロトコルモジュールに、コマンド待機状態はコマンドまたはデバイスタスクモジュールに、診断カウンタは診断または所有デバイスコンテキストに、ビジネス状態は App に属します。

命名ポリシー

呼び出し元が呼び出しレベルを識別できるように、プロジェクト可視のレイヤープレフィックスを使用します。マニュアルや確立されたライブラリに一致する大文字のレイヤーと技術略語を優先します:

APP_EventPost(...)
BSP_UART_SendDMA(...)
DRV_FlashWrite(...)
MOD_FilterProcess(...)
OSAL_QueueSendFromISR(...)
SVC_TraceInfo(...)
UTIL_CRC16Calc(...)

技術マニュアルや一般的な組み込み用語で大文字で表記される略語(UART、SPI、I2C、ADC、DMA、GPIO、PWM、CRC、RTOS、ISR、USB、CAN、IAP、APP、BSP、OSAL、HAL など)には大文字を使用します。

関数名がマクロのように見えないようにします。BSP_UART_SendDMA を BSP_UART_SEND_DMA よりも優先します。すべて大文字とアンダースコアは、マクロ、定数、列挙値、コンパイル時設定のために予約します。

既存のプロジェクトがすでに一貫した命名スタイルを使用している場合は、ローカルの一貫性を維持し、提案された移行がある場合は別途説明します。

CubeMX と MDK

生成されたファイルを変更する場合は、USER CODE BEGIN/END ブロック内にユーザー編集を配置します。main.c を拡張する代わりに、User の下に新しい手書きの .c/.h ファイルを追加することを優先します。

Keil MDK および EIDE プロジェクトの場合、物理的な .c ファイルを追加するだけでは不十分であることを覚えておいてください。プロジェクトグループ/設定を通じてビルドに参加することを確認し、Inc フォルダと User/Config のインクルードパスを追加します。

RTOS ガイダンス

FreeRTOS プロジェクトの場合、責任、タイミング、ブロッキング動作に基づいてタスクを設計します。リアルタイムパスをログ記録、ストレージ、通信リトライ、診断から分離します。

プロジェクトの要件を満たす場合は、OS 境界として CMSIS-RTOS を優先します。安定したタイムアウトセマンティクス、ISR バリアント、エラーコード、静的割り当てポリシー、ベアメタル互換性、または将来の Zephyr 移行がプロジェクトに必要な場合にのみ、カスタム OSAL を追加します。

移行が重要な場合、ネイティブの FreeRTOS API を App、Driver、Module コードに分散させないでください。

出力形式

アーキテクチャを設計する場合、次の順序で応答します:

  1. 仮定と制約。
  2. 推奨されるレイヤー/ファイル配置。
  3. データフローとイベント/タスクモデル。
  4. 主要なインターフェースまたは擬似コード。
  5. リスク、トレードオフ、検証手順。

コードをレビューする場合、スタイルの提案の前に、具体的なリスクとファイル/レイヤー違反から始めます。

関連スキル