diff --git a/Applications/gs_command_dispatcher.c b/Applications/gs_command_dispatcher.c index 0561b3366..4eac7eb3e 100644 --- a/Applications/gs_command_dispatcher.c +++ b/Applications/gs_command_dispatcher.c @@ -1,16 +1,33 @@ #pragma section REPRO -// 地上局からのコマンド実行用アプリ +/** + * @file + * @brief 地上局から発行された RTC (Real Time Cmd) を実行する + */ #include "gs_command_dispatcher.h" - #include "../CmdTlm/packet_handler.h" static CommandDispatcher gs_command_dispatcher_; const CommandDispatcher* const gs_command_dispatcher = &gs_command_dispatcher_; +/** + * @brief GSCD App 初期化関数 + * @param void + * @return void + */ static void GSCD_init_(void); + +/** + * @brief GSCD App 実行関数 + * + * PH_add_gs_cmd_ にて, GS からの RTC が gs_command_dispatcher に紐付けられたコマンドキュー PH_gs_cmd_list に push back される. + * そのキューから1つコマンドを取り出し実行する + * @param void + * @return void + */ static void GSCD_dispatch_(void); + AppInfo GSCD_create_app(void) { return create_app_info("gs_command_dispatcher", @@ -25,13 +42,6 @@ static void GSCD_init_(void) static void GSCD_dispatch_(void) { - // このgs_command_dispatcher_は外部で更新されている - // 2018/06/26 の時点における処理の流れを具体的に描くと、 - // GSTOS_cmd_packet_handler_ > PH_analyze_packet > analyze_cmd_ > add_gs_cmd_ - // - // AR_DI_GSTOS_CMD_PH というIDのアプリを起点にコマンドの解析が進み、 - // 地上局からのコマンドと判定されるとadd_gs_cmd_関数内でgs_command_dispatcher_に反映される。 - CDIS_dispatch_command(&gs_command_dispatcher_); } @@ -39,8 +49,9 @@ CCP_EXEC_STS Cmd_GSCD_CLEAR_ERR_LOG(const CTCP* packet) { (void)packet; - // 記録されたエラー情報を解除。 + // 記録されたエラー情報をクリア CDIS_clear_error_status(&gs_command_dispatcher_); return CCP_EXEC_SUCCESS; } + #pragma section diff --git a/Applications/gs_command_dispatcher.h b/Applications/gs_command_dispatcher.h index 7b26eef95..7b33fa57f 100644 --- a/Applications/gs_command_dispatcher.h +++ b/Applications/gs_command_dispatcher.h @@ -1,3 +1,7 @@ +/** + * @file + * @brief 地上局から発行された RTC (Real Time Cmd) を実行する + */ #ifndef GS_COMMAND_DISPATCHER_H_ #define GS_COMMAND_DISPATCHER_H_ @@ -6,6 +10,11 @@ extern const CommandDispatcher* const gs_command_dispatcher; +/** + * @brief GSCD App 生成関数 + * @param void + * @return GSCD AppInfo + */ AppInfo GSCD_create_app(void); CCP_EXEC_STS Cmd_GSCD_CLEAR_ERR_LOG(const CTCP* packet);