Skip to content

Latest commit

 

History

History
195 lines (169 loc) · 12 KB

communication.md

File metadata and controls

195 lines (169 loc) · 12 KB

Communication

概要

通信関連，ネットワーク関連などをまとめる．
コンポーネント間通信については Driver/Communication with Components などを参照のこと．

C2A 内部を流れるパケットについて (Common Packet)

C2A 内部を流れるパケットは以下の 3 つである．

  • CommonTlmCmdPacket
    • CTCP
    • テレコマを区別しないパケット
    • CCSDS で規定される Space Packet に相当する
  • CommonTlmPacket
    • CTP
    • CTCP のうち，テレメトリパケットに限定したもの
  • CommonCmdPacket
    • CCP
    • CTCP のうち，コマンドパケットに限定したもの

これらのパケットは，抽象化された型であり，その実体はすべてユーザー定義である．
C2A 標準として， Space Packet が Core 内で定義されており，基本的にはこれを用いることを想定している． ただし，C2A 標準 Space Packet は後述する通り，Secondary Header が独自定義されている．

Common Packet の実装として，c2a-core が提供する Space Packet のデフォルト実装を用いる場合は，以下の C2A_USE_SPACE_PACKET_AS_COMMON_PACKET オプションを ON に設定すること．

c2a-core/CMakeLists.txt

Line 22 in 12c6b61

option(C2A_USE_SPACE_PACKET_AS_COMMON_PACKET "Use C2A-core Space Packet as Common Packet implementation" ON)

C2A 標準 Space Packet 定義

C2A 標準 Space Packet は，CCSDS (Consultative Committee for Space Data Systems．宇宙データシステムの標準化を進めている機関) の Space Packet に準拠したものである（参考: CCSDS SPACE PACKET PROTOCOL）． CCSDS Space Packet において， Secondary Header はユーザー定義とされており， C2A 用に Secondary Header がカスタムされたものが C2A 標準 Space Packet である．

現在，C2A 標準 Space Packet として，テレメパケット，コマンドパケットともに， Ver.1 のみ策定している．
ここでは， Ver.1 について記載する．

後方互換性を保つために，バージョン情報は， Secondary Header に埋め込まれている．

Primary Header

Primary Header はテレメパケット，コマンドパケットともに共通であり，また， CCSDS の規定する Space Packet と同一である． 本ドキュメント更新時の実装は，以下である．ヘッダ構造は以下を参照すること．

c2a-core/TlmCmd/Ccsds/space_packet.h

Lines 1 to 35 in 45d78a0

/**
* @file
* @brief CCSDS で規定される Space Packet の実装
* @note 資料: https://sma.jaxa.jp/TechDoc/Docs/JAXA-JERG-2-403.pdf
* @note C2A においては， CommonHogePacket の実体として，以下のように Space Packet を標準とする
* CommonTlmCmdPacket -> SpacePacket
* CommonTlmPacket -> TlmSpacePacket
* CommonCmdPacket -> CmdSpacePacket
* つまり， C2A Core 実装においては， Space Packet に依存したコードを書いてはならない！（これを include してはならない） FIXME: 完全にできてないので直す
* @note Packet Secondary Header は C2A 独自定義． いくつかのバージョンを用意している
* @note /Docs/Core/communication.md などを参照
* @note packet 構造
* |---------+-------+-------+------------------|
* | Pos | Pos | size | name |
* | [octet] | [bit] | [bit] | |
* |---------+-------+-------+------------------|
* | === Primary Header ======================= |
* |---------+-------+-------+------------------|
* | 0 | 0 | 3 | Version No |
* | 0 | 3 | 1 | Packet Type |
* | 0 | 4 | 1 | Sec. HDR Flag |
* | 0 | 5 | 11 | APID |
* | 2 | 0 | 2 | Sequence Flags |
* | 2 | 2 | 14 | Sequence Count |
* | 4 | 0 | 16 | Packet Data Len |
* |---------+-------+-------+------------------|
* | === Secondary Header ===================== |
* |---------+-------+-------+------------------|
* | 6 | 0 | * | User Defined |
* |---------+-------+-------+------------------|
* | === User Data Field ====================== |
* |---------+-------+-------+------------------|
* | * | 0 | * | User Defined |
* |---------+-------+-------+------------------|
*/

各フィールドの説明

  • Packet Version Number
    • 0b000 Space Packet 固定
  • Packet Identification
    • Packet Type
      • 0b0: Telemetry
      • 0b1: Command
    • Secondary Hreader Flag
      • 0b0: Secondary Header Absent
      • 0b1: Secondary Header Present
    • Application Process Identifier (APID)
      • ユーザー定義
      • 以下は CCSDS で規定
        • 0b11111111000 - 0b11111111110: CCSDS Reserved
        • 0b11111111111: Idle Packet
  • Packet Sequence Control Field
    • Sequence Flag
      • 0b00: Continuation component of higher data structure
      • 0b01: First component of higher data structure
      • 0b10: Last component of higher data structure
      • 0b11: Standalone Packet
    • Sequence Count
      • APID ごとにパケットの伝送順番を示すカウンタ
  • Packet Data Length
    • パケット全長から Primary Header 長を引き，さらに 1 を引いたもの
    • つまり，これが 0 の時， Secondary Header + User Data Field 長は 1 byte である

Secondary Header (Telemetry)

Secondary Header は CCSDS Space Packet 定義において，ユーザー定義部分であるため，ここで定義する． 本ドキュメント更新時の実装は，以下である．ヘッダ構造は以下を参照すること．

c2a-core/TlmCmd/Ccsds/tlm_space_packet.h

Lines 1 to 51 in 45d78a0

/**
* @file
* @brief CCSDS で規定される Space Packet の テレメ版の実装
* @brief C ではテンプレートが使えないため，別で定義する
* @note 詳細は space_packet.h を参照
* @note 現在は， Sec. HDR Ver.1 のみ．追加するときに拡張していく
* @note packet 構造
* |---------+-------+-------+------------------|
* | Pos | Pos | size | name |
* | [octet] | [bit] | [bit] | |
* |---------+-------+-------+------------------|
* | === Primary Header ======================= |
* |---------+-------+-------+------------------|
* | 0 | 0 | 3 | Version No |
* | 0 | 3 | 1 | Packet Type |
* | 0 | 4 | 1 | Sec. HDR Flag |
* | 0 | 5 | 11 | APID |
* | 2 | 0 | 2 | Sequence Flags |
* | 2 | 2 | 14 | Sequence Count |
* | 4 | 0 | 16 | Packet Data Len |
* |---------+-------+-------+------------------|
* | === Secondary Header ===================== |
* |---------+-------+-------+------------------|
* | 6 | 0 | 8 | Sec. HDR Ver |
* | 7 | 0 | 32 | Board Time |
* | 11 | 0 | 8 | Tlm ID |
* | 12 | 0 | 64 | Global Time |
* | 20 | 0 | 32 | On-Board |
* | | | | Subnetwork Time |
* | 24 | 0 | 8 | Dest Flags |
* | 25 | 0 | 8 | Dest Info |
* |---------+-------+-------+------------------|
* | === User Data Field ====================== |
* |---------+-------+-------+------------------|
* | 26 | 0 | * | Tlm Data #0 |
* | * | 0 | * | Tlm Data #1 |
* | * | 0 | * | Tlm Data #2 |
* | * | 0 | * | ... |
* |---------+-------+-------+------------------|
*
* 以下の 3 つの時刻情報をパケットに仕込む
* - Board Time
* - テレメパケットを生成したボードのテレメ生成時間． TI など．型は任意．
* - Global Time
* - テレメパケットを生成したボードの絶対時刻でのテレメ生成時刻． GPS Time や unixtime など．型は任意．
* - 0xFF 0xFF 0xFF 0xFF 0xFF 0xFF 0xFF 0xFF の場合， パケット中継中に MOBC で上書きされる
* - FIXME: 一旦 double で実装するが，本当は変えたほうが良いかもしれない．．．？
* - On-Board Subnetwork Time
* - オンボードサブネットワークでのテレメ生成時刻．オンボードサブネットワーク TI など．型は任意．
* - 0xFFFFFFFF の場合， パケット中継中に MOBC で上書きされる
*/

各フィールドの説明

  • Secondary Header Version
    • 0x00: バージョン不定
    • 0x01: Version 1
  • Board Time
    • テレメトリが生成されたボード (OBC など) の時刻 (TI など)
  • Telemetry ID
    • テレメトリID
    • APID 内でユニークであればいい
  • Global Time
    • テレメトリが生成された絶対時刻 (unixtime や GPS Time など)
    • APID ごとに解釈方法（ビットフィールドの使い方）を定義する
    • 0xFFFFFFFF 0xFFFFFFFF の場合， パケット中継中に MOBC (地上局とつながる OBC) で，上書き設定される
      • Global Time を取得できない機器向け
  • On-Board Subnetwork Time （将来拡張）
    • 各ボードで作られたパケットの時刻を統一的に管理するために，オンボードサブネットワークで共通の時刻体系に基づくテレメトリ生成時刻
    • 0xFFFFFFFF の場合， パケット中継中に MOBC (地上局とつながる OBC) で，上書き設定される
      • On-Board Subnetwork Time を取得できない機器向け
  • Destination Flags
    • テレメトリ配送種別
    • 同時に複数配送ができるように， flag で管理
      • ただし，地上局でのパケット保存処理をシンプルにするためなどの理由で，配送の過程でそれぞれのフラグごとにバケットをバラす．つまり，オンボードサブネットワークから地上に送信されるパケットでは， 1 つの flag のみ立っている状態を基本とする．
    • 今後拡張予定あり
    • 現時点では以下
      • 0b00000001: High Priority Realtime Telemetry (現在の C2A Core では使われてない (Realtime Telemetry として処理されている))
      • 0b00000010: Realtime Telemetry
      • 0b00000100: Stored Telemetry
      • 0b00001000: Replay Telemetry
      • 0b00010000: 将来拡張用の確保領域
      • 0b00100000: 将来拡張用の確保領域
      • 0b01000000: 将来拡張用の確保領域
      • 0b10000000: 将来拡張用の確保領域
  • Destination Info
    • 例えば，Stored Telemetry 時には Data Recorder のどのパーティションに配送されるかを規定する
    • 将来拡張の可能性あり

Secondary Header (Command)

Secondary Header は CCSDS Space Packet 定義において，ユーザー定義部分であるため，ここで定義する． 本ドキュメント更新時の実装は，以下である．ヘッダ構造は以下を参照すること．

c2a-core/TlmCmd/Ccsds/cmd_space_packet.h

Lines 1 to 38 in 45d78a0

/**
* @file
* @brief CCSDS で規定される Space Packet の コマンド版の実装
* @brief C ではテンプレートが使えないため，別で定義する
* @note 詳細は space_packet.h を参照
* @note 現在は， Sec. HDR Ver.1 のみ．追加するときに拡張していく
* @note packet 構造
* |---------+-------+-------+------------------|
* | Pos | Pos | size | name |
* | [octet] | [bit] | [bit] | |
* |---------+-------+-------+------------------|
* | === Primary Header ======================= |
* |---------+-------+-------+------------------|
* | 0 | 0 | 3 | Version No |
* | 0 | 3 | 1 | Packet Type |
* | 0 | 4 | 1 | Sec. HDR Flag |
* | 0 | 5 | 11 | APID |
* | 2 | 0 | 2 | Sequence Flags |
* | 2 | 2 | 14 | Sequence Count |
* | 4 | 0 | 16 | Packet Data Len |
* |---------+-------+-------+------------------|
* | === Secondary Header ===================== |
* |---------+-------+-------+------------------|
* | 6 | 0 | 8 | Sec. HDR Ver |
* | 7 | 0 | 8 | Command Type |
* | 8 | 0 | 16 | Command ID |
* | 10 | 0 | 4 | Dest Type |
* | 10 | 4 | 4 | Execution Type |
* | 11 | 0 | 32 | Time Indicator |
* |---------+-------+-------+------------------|
* | === User Data Field ====================== |
* |---------+-------+-------+------------------|
* | 15 | 0 | * | Cmd Param #0 |
* | * | 0 | * | Cmd Param #1 |
* | * | 0 | * | Cmd Param #2 |
* | * | 0 | * | ... |
* |---------+-------+-------+------------------|
*/

各フィールドの説明

  • Secondary Header Version
    • 0x00: バージョン不定
    • 0x01: Version 1
  • Command Type
    • 将来拡張用
    • 現時点では以下
      • 0x00: 不定
  • Command ID
    • コマンドID
    • APID 内でユニークであればいい
  • Destination Type
    • 0x0, 0xe, 0xf 以外はユーザー定義
    • 例えば次のように定義する
      • 0x0: 自分宛 (CCP_DEST_TYPE_TO_ME)
      • 0x1 - 0xd : CCP_DEST_TYPE_TO_ME, CCP_DEST_TYPE_TO_APID では表現できない宛先
      • 0xe: 不明 (CCP_DEST_TYPE_TO_UNKOWN)
      • 0xf: APID で示す宛先宛 (CCP_DEST_TYPE_TO_APID)
    • ここで言う，宛先はコマンド実行場所ではなく，キューイングされる先のことである（詳細は後述）
  • Execution Type
    • 現時点では以下（将来拡張予定あり）
      • 0x0: Ground Station Command
      • 0x1: Timeline Command (TL0)
      • 0x2: Block Command
      • 0x3: Realtime Command
      • 0x4: Unixtime Timeline Command (TL0)
      • 0x5: Timeline Command (TL1)
      • 0x6: Timeline Command (TL2)
      • 0x7: 不明
    • ルーティングについては後述
  • Time Indicator
    • TLC や BC における実行時刻を示す TI

コマンド配送におけるルーティングについて

  • コマンドの最終的な配送先，つまり実行されるボードは APID によって規定される

    • c2a-core/Examples/mobc/src/src_user/Settings/TlmCmd/Ccsds/apid_define.h

      Lines 11 to 28 in 45d78a0

      /**
      * @enum APID
      * @brief Application Process ID
      * @note 11bit
      */
      typedef enum
      {
      APID_MOBC_CMD = 0x210, //!< 01000010000b: APID for MOBC 宛の CMD
      APID_AOBC_CMD = 0x211, //!< 01000010001b: APID for AOBC 宛の CMD
      APID_TOBC_CMD = 0x212, //!< 01000010010b: APID for TOBC 宛の CMD
      APID_TCAL_TLM = 0x410, //!< 10000010000b: APID for TIME CARIBLATION TLM (FIXME: 現在まともに使ってない)
      APID_MOBC_TLM = 0x510, //!< 10100010000b: APID for MOBC で生成される TLM
      APID_AOBC_TLM = 0x511, //!< 10100010001b: APID for AOBC で生成される TLM
      APID_TOBC_TLM = 0x512, //!< 10100010002b: APID for TOBC で生成される TLM
      APID_DUMP_TLM = 0x710, //!< 11100010000b: APID for DUMP TLM (FIXME: 現在まともに使ってない)
      APID_FILL_PKT = 0x7ff, //!< 11111111111b: APID for FILL PACKET
      APID_UNKNOWN
      } APID;
  • 一方で， BC や TLC などでのキューイングは， Destination Type によって決定される

    • c2a-core/Examples/mobc/src/src_user/Settings/TlmCmd/common_cmd_packet_define.h

      Lines 20 to 34 in 45d78a0

      /**
      * @enum CCP_DEST_TYPE
      * @brief コマンドの解釈の宛先を規定
      * @note 詳細は https://github.com/ut-issl/c2a-core/blob/develop/Docs/Core/communication.md を参照
      * @note 4bit を想定
      */
      typedef enum
      {
      CCP_DEST_TYPE_TO_ME = 0x0,
      CCP_DEST_TYPE_TO_MOBC = 0x1, // CCP_DEST_TYPE_TO_APID の追加に伴い deprecated
      CCP_DEST_TYPE_TO_AOBC = 0x2, // CCP_DEST_TYPE_TO_APID の追加に伴い deprecated
      CCP_DEST_TYPE_TO_TOBC = 0x3, // CCP_DEST_TYPE_TO_APID の追加に伴い deprecated
      CCP_DEST_TYPE_TO_UNKOWN = 0xe,
      CCP_DEST_TYPE_TO_APID = 0xf
      } CCP_DEST_TYPE;
  • 具体例（GS と接続される OBC は MOBC とし，AOBC は MOBC にぶら下がってるものとする）
    • APID: MOBC, Destination Type: TO_ME or TO_APID or MOBC
      • GSC: GS から MOBC に届き， MOBC で GSC としてエンキューされる．デキューした後， MOBC 内で GSC として実行される．
      • TLC: GS から MOBC に届き， MOBC で TLC としてエンキューされる．デキューした後， MOBC 内で RTC として実行される．
      • BC: GS から MOBC に届き， MOBC で BC 登録される．BC 展開した後， TL にエンキューされ，デキューした後， MOBC 内で RTC として実行される．
    • APID: AOBC, Destination Type: TO_ME or MOBC
      • GSC: GS から MOBC に届き， MOBC で GSC としてエンキューされる．デキューした後， APID を元に， AOBC へ配送される．配送時， Destination Type は自分宛 (TO_ME) に上書きされ， AOBC で RTC としてキューイング & 実行される．
      • TLC: GS から MOBC に届き， MOBC で TLC としてエンキューされる．デキューした後， APID を元に， AOBC へ配送される．配送時， Destination Type は自分宛 (TO_ME) に上書きされ， AOBC で RTC としてキューイング & 実行される．
      • BC: GS から MOBC に届き， MOBC で BC 登録される．BC 展開した後， TL にエンキューされ，デキューした後， APID を元に， AOBC へ配送される．配送時， Destination Type は自分宛 (TO_ME) に上書きされ， AOBC で RTC としてキューイング & 実行される．
    • APID: AOBC, Destination Type: TO_APID or AOBC
      • GSC: GS から MOBC に届き， MOBC でエンキューされずに，そのまま AOBC へ配送される．配送時， Destination Type は自分宛 (TO_ME) に上書きされ， AOBC で GSC としてキューイング & 実行される．
      • TLC: GS から MOBC に届き， MOBC でエンキューされずに，そのまま AOBC へ配送される．配送時， Destination Type は自分宛 (TO_ME) に上書きされ， AOBC で TLC としてキューイング & 実行される．
      • BC: GS から MOBC に届き， MOBC で BC 登録されずに，そのまま AOBC へ配送される．配送時， Destination Type は自分宛 (TO_ME) に上書きされ， AOBC で BC として登録 & 実行される．
  • 地上局 SW での実装まとめ
    • MOBC 宛
      • APID: APID_CMD_TO_MOBC
      • CCP_DEST_TYPE: CCP_DEST_TYPE_TO_ME
    • AOBC 宛（AOBC 直送）
      • APID: APID_CMD_TO_AOBC
      • CCP_DEST_TYPE: CCP_DEST_TYPE_TO_AOBC
    • AOBC 宛（MOBC でキューに入り，実行時に AOBC に転送）
      • APID: APID_CMD_TO_AOBC
      • CCP_DEST_TYPE: CCP_DEST_TYPE_TO_ME

Common Packet の定義方法

次のように，それぞれ定義する．

C2A 間通信について

上記 #コマンド配送におけるルーティングについて や Driver/Communication with Components#c2a-間通信 などを参照すること．

CCSDS 準拠状況

TBA