「内部設計書に書くべきこと〜組込みソフト開発の場合〜」

システム構成図は、外部設計段階でも作成する内容になりますが、内部設計書では、システム全体のどの部分を設計の対象としているかを明確にするうえで役立ちます。ソフテックでVisioを使用して作成したシステム構成図の例を以下に示します。開発対象となる機器にどういった機器が接続され、どのようなインタフェースを持つのかが、一見してわかるように記述していきます。

図2. システム構成図の例

ソフトウェア構成図は、ソフトウェア階層を構造化してわかりやすく記載した図です。簡易的なソフトウェア構成図の例を以下に示します。下図の例では階層的な構造を示していますが、ブロック形式で示す場合もあります。組込みソフトウェア開発でも、大規模なものでは、OSやプロトコルスタックを使用すると、階層が複雑になる場合があります。OS、ミドルウェアなどは自作せずに購入する場合が多いため、開発の対象を明確にするうえでも大切な項目になります。以下の例では省略していますが、市販品を使用する場合はメーカーやバージョンも記載しておきます。

図3. ソフトウェア構成図の例

開発環境としては、コンパイラや統合開発環境にどのメーカーの、どのバージョンのものを使用するかを明確にしておきます。動作環境（運用環境）は組込みソフト開発の場合、そのシステム専用に開発した基板の場合もありますが、市販の基板を使用する場合もありますので、その場合はメーカーや型式なども明記しておきます

図4. 開発環境/動作環境の例

機能要求リストは開発するソフトウェアで実現する機能を網羅したものです。ソフテックでは内部設計書類の一部として、WORD文書にまとめる場合が多いです。機能要求は、外部設計またはその前の段階でもまとめてあると思いますが、ここではプログラミング時の注意点にフォーカスしてまとめることになります。

図5. 機能要求リストの例

非機能要求リストは、信頼性要求、保守性要求、移植性要求、セキュリティ要求などソフトウェアの非機能的な要求事項をまとめたものです。以下に、ソフテックで作成したソフトウェア起動時の初期化処理の内容をまとめたものを例として示します。非機能要求リストも、機能要求リストと同様にソフテックでは内部設計書類の一部として、WORD文書にまとめています。非機能要求は、外部設計段階では明確に規定しない場合もあるため、内部設計段階で明確にすることが重要です。

図6. 非機能要求リストの例

アドレスマップは、CPUのROM、RAM空間にどのようなセクションを設けて、どう配置するかを記載したものになります。以下に、ソフテックでExcelを使用して作成したアドレスマップの例を示します。この例では、ブートローダソフトと、アプリケーションソフトの2つを同一CPUに書き込んで使用しています。それぞれでDebugビルド/Releaseビルドの2種類が存在するため、合計4つのアドレスマップを記載しています。プログラミング段階では、この設定をリンカーのセクション定義に使用することになります。

図7. アドレスマップの例

メモリ使用量算出表は、ソフトウェアの実現に必要となるメモリ量を見積もったものになります。下図に、ソフテックでExcelを使用して作成したメモリ使用量算出表の例を示します。内部設計段階では、すでにメモリ量（内蔵CPUメモリや外付けメモリサイズ）が決まっている場合がほとんどだと思いますので、決められたメモリ量内で、要求される機能が実現可能なことを確認する目的で作成します。また、必要な変数を抽出することによって、ユニットごとのデータ管理法、データフローを明確にすることにつながります。

図8. メモリ使用量算出表の例

CPUリソース使用一覧は、CPUの周辺機能（ペリフェラル）の使用有無と、使用時の設定をまとめたものになります。以下にソフテックでExcelを使用して作成したCPUリソース使用一覧の例を示します。下記の例では、CPUのユーザーズマニュアル（データシート）などに記載されている周辺機能を章番号順に網羅し、そこに使用する機能、設定を記載しています。

図9. CPUリソース使用一覧の例

ユニット（タスク）構成図は、ソフトウェア内部のユニット構成をまとめた資料になります。OSあり構成の場合は、ユニット＝タスクごとの機能、関係性を簡潔にまとめた内容になります。以下に、ソフテックでVisioを使用して作成したユニット（タスク）構成図の例を示します。下図の例では、タスク構成のほかに、各タスクで使用するドライバ、ミドルウェアの関係性も示しています。

図10. ユニット（タスク）構成図の例

ユニット（タスク）間メッセージ仕様は、ユニット（＝タスク）間で受け渡しを行うデータ（＝メッセージ）の詳細を規定したものです。下図に、ソフテックでExcelを使用して作成したユニット（タスク）間メッセージ仕様の例を示します。下図の例は、OSのメールボックス機能を使用して、タスク間のメッセージ通知を実現したシステムでの仕様書になります。メッセージはデータ領域を16バイトの固定長とし、データ内容はメッセージIDごとに異なる内容になります。

図11. ユニット（タスク）間メッセージ仕様の例

ユニット（タスク）間シーケンス仕様は、起動/終了やシステム固有の機能を実行した場合のユニット（＝タスク）ごとの動作、振る舞いを規定したものです。下図に、ソフテックでVisioを使用して作成したユニット（タスク）間シーケンス仕様の例を示します。下図の例では、イニシャル起動時の各タスクの動作を時間の流れ（上から下）に沿って、記載しています。矢印（→）で記載された内容は、前項で記載したユニット（タスク）間メッセージを示しており、どのタイミングでどのメッセージが通知されるのかを規定しています。機能要求リストに記載した主要機能ごとに、このようなシーケンス仕様を明確にすることで、メッセージ仕様に抜けや間違いがないかを確認することができます。

図12. ユニット（タスク）シーケンス仕様の例

状態遷移表は、状態を横軸（または縦軸）、イベントを縦軸（または横軸）にとり、イベント発生時の状態遷移先を記載した資料です。ソフトウェア機能に、複数の状態管理が含まれる場合に作成すべき資料になります。下図に、ソフテックでExcelを使用して作成した状態遷移表の例を示します。状態遷移表の他の表現方法として、状態と状態を矢印（イベント）で結び、グラフィカルに表現した状態遷移図があります。

図13. 状態遷移表の例

関数仕様は、作成する関数の処理内容、引数や戻り値などを規定した資料になります。以下に、ソフテックでWORDを使用して作成した関数仕様の例を示します。

図14. 関数仕様の例