CCP の汎用 Utility [詳解]

#include "common_cmd_packet_util.h"
#include "command_analyze.h"
#include "../Library/endian.h"
#include <stddef.h>
#include <string.h>

common_cmd_packet_util.c の依存先関係図:

データ構造
struct	CCP_ParamGenerator
	param を構築するための一時領域 [詳解]

関数
void	CCP_form_nop_rtc_ (CommonCmdPacket *packet)
	NOP cmd の RTC CCP を作る [詳解]

static void	CCP_form_rtc_ (CommonCmdPacket packet, CMD_CODE cmd_id, const uint8_t param, uint16_t len)
	RealTime Command を生成する. CCP_form_* の実体. [詳解]

static CCP_UTIL_ACK	CCP_calc_param_offset_ (CMD_CODE cmd_id, uint8_t n, uint16_t *offset)
	CCP パラメタ開始位置に対する n 番目の引数の offset を計算する [詳解]

static CCP_UTIL_ACK	CCP_raise_err_at_param_generator_ (void)
	Param Generator でエラーを発生した際に呼ぶエラー保存関数 [詳解]

static CCP_UTIL_ACK	CCP_prepare_param_for_packet_ (void *param, uint8_t byte)
	Param Generator で n byte のパラメタを登録 [詳解]

CCP_CmdRet	CCP_make_cmd_ret (CCP_EXEC_STS exec_sts, uint32_t err_code)
	コマンド返り値である CCP_CmdRet を作成 [詳解]

CCP_CmdRet	CCP_make_cmd_ret_without_err_code (CCP_EXEC_STS exec_sts)
	コマンド返り値である CCP_CmdRet を作成（エラーコード不使用版） [詳解]

void	CCP_form_app_cmd (CommonCmdPacket *packet, cycle_t ti, AR_APP_ID id)
	App 実行 TL コマンドを生成 [詳解]

CCP_UTIL_ACK	CCP_form_rtc (CommonCmdPacket packet, CMD_CODE cmd_id, const uint8_t param, uint16_t len)
	Realtime command を生成 [詳解]

CCP_UTIL_ACK	CCP_form_tlc (CommonCmdPacket packet, cycle_t ti, CMD_CODE cmd_id, const uint8_t param, uint16_t len)
	Timeline command を生成 [詳解]

CCP_UTIL_ACK	CCP_form_rtc_to_other_obc (CommonCmdPacket packet, APID apid, CMD_CODE cmd_id, const uint8_t param, uint16_t len)
	他の OBC のコマンドを RT として生成 [詳解]

CCP_UTIL_ACK	CCP_form_tlc_to_other_obc (CommonCmdPacket packet, cycle_t ti, APID apid, CMD_CODE cmd_id, const uint8_t param, uint16_t len)
	他の OBC のコマンドを TL として生成 [詳解]

CCP_UTIL_ACK	CCP_form_block_deploy_cmd (CommonCmdPacket *packet, TLCD_ID tl_no, bct_id_t block_no)
	BC展開 Realtime command を生成 [詳解]

void	CCP_convert_rtc_to_tlc (CommonCmdPacket *packet, cycle_t ti)
	Realtime Command から Timeline Command へ変換 [詳解]

PH_ACK	CCP_register_rtc (CMD_CODE cmd_id, const uint8_t *param, uint16_t len)
	Realtime command を登録 [詳解]

PH_ACK	CCP_register_tlc (cycle_t ti, TLCD_ID tlcd_id, CMD_CODE cmd_id, const uint8_t *param, uint16_t len)
	Timeline command を登録 [詳解]

PH_ACK	CCP_register_tlc_asap (cycle_t ti, TLCD_ID tlcd_id, CMD_CODE cmd_id, const uint8_t *param, uint16_t len)
	Timeline command を登録 (ASAP 版) [詳解]

CCP_CmdRet	CCP_form_and_exec_rtc (CMD_CODE cmd_id, const uint8_t *param, uint16_t len)
	Realtime command を生成し，即時実行する [詳解]

CCP_CmdRet	CCP_form_and_exec_rtc_to_other_obc (APID apid, CMD_CODE cmd_id, const uint8_t *param, uint16_t len)
	他の OBC のコマンドを RT として生成し，即時実行する [詳解]

CCP_CmdRet	CCP_form_and_exec_block_deploy_cmd (TLCD_ID tl_no, bct_id_t block_no)
	BC展開 command を生成し，即時実行する [詳解]

CCP_EXEC_TYPE	CCP_get_exec_type_from_tlcd_id (TLCD_ID tlcd_id)
	TLCD ID から CCP_EXEC_TYPE を取得する [詳解]

uint8_t *	CCP_get_1byte_param_from_packet (const CommonCmdPacket *packet, uint8_t n)
	CCP packet から，サイズが 1 byte のコマンド引数を取得する [詳解]

uint16_t *	CCP_get_2byte_param_from_packet (const CommonCmdPacket *packet, uint8_t n)
	CCP packet から，サイズが 2 byte のコマンド引数を取得する [詳解]

uint32_t *	CCP_get_4byte_param_from_packet (const CommonCmdPacket *packet, uint8_t n)
	CCP packet から，サイズが 4 byte のコマンド引数を取得する [詳解]

uint64_t *	CCP_get_8byte_param_from_packet (const CommonCmdPacket *packet, uint8_t n)
	CCP packet から，サイズが 8 byte のコマンド引数を取得する [詳解]

uint16_t	CCP_get_raw_param_from_packet (const CommonCmdPacket packet, void dest, uint16_t max_copy_len)
	CCP packet から，RAW コマンド引数を取得する [詳解]

const uint8_t *	CCP_get_raw_param_head (const CommonCmdPacket *packet)
	CCP packet から，RAW コマンド引数の先頭ポインタを取得する [詳解]

uint16_t	CCP_get_raw_param_len (const CommonCmdPacket *packet)
	CCP packet から，RAW コマンド引数の長さを返す [詳解]

void	CCP_init_param_for_packet (CMD_CODE cmd_id)
	Param Generator を初期化 [詳解]

CCP_UTIL_ACK	CCP_get_prepared_param_for_packet (const uint8_t *param_head, uint16_t len)
	Param Generator から完成した param を取得する [詳解]

CCP_UTIL_ACK	CCP_prepare_uint8_param_for_packet (uint8_t param)
	Param Generator で uint8_t のパラメタを登録 [詳解]

CCP_UTIL_ACK	CCP_prepare_int8_param_for_packet (int8_t param)
	Param Generator で int8_t のパラメタを登録 [詳解]

CCP_UTIL_ACK	CCP_prepare_uint16_param_for_packet (uint16_t param)
	Param Generator で uint16_t のパラメタを登録 [詳解]

CCP_UTIL_ACK	CCP_prepare_int16_param_for_packet (int16_t param)
	Param Generator で int16_t のパラメタを登録 [詳解]

CCP_UTIL_ACK	CCP_prepare_uint32_param_for_packet (uint32_t param)
	Param Generator で uint32_t のパラメタを登録 [詳解]

CCP_UTIL_ACK	CCP_prepare_int32_param_for_packet (int32_t param)
	Param Generator で int32_t のパラメタを登録 [詳解]

CCP_UTIL_ACK	CCP_prepare_uint64_param_for_packet (uint64_t param)
	Param Generator で uint64_t のパラメタを登録 [詳解]

CCP_UTIL_ACK	CCP_prepare_int64_param_for_packet (int64_t param)
	Param Generator で int64_t のパラメタを登録 [詳解]

CCP_UTIL_ACK	CCP_prepare_float_param_for_packet (float param)
	Param Generator で float のパラメタを登録 [詳解]

CCP_UTIL_ACK	CCP_prepare_double_param_for_packet (double param)
	Param Generator で double のパラメタを登録 [詳解]

CCP_UTIL_ACK	CCP_prepare_bct_id_param_for_packet (bct_id_t param)
	Param Generator で bct_id_t のパラメタを登録 [詳解]

CCP_UTIL_ACK	CCP_prepare_raw_param_for_packet (const uint8_t *param, uint16_t len)
	Param Generator で raw パラメタを登録 [詳解]

変数
static CommonCmdPacket	CCP_util_packet_

static CCP_ParamGenerator	CCP_param_generator_

詳解

CCP の汎用 Utility

common_cmd_packet_util.c に定義があります。

関数詳解

◆ CCP_calc_param_offset_()

static CCP_UTIL_ACK CCP_calc_param_offset_	(	CMD_CODE	cmd_id,
		uint8_t	n,
		uint16_t *	offset
	)

static

CCP パラメタ開始位置に対する n 番目の引数の offset を計算する

引数

[in]	cmd_id	CMD_CODE
[in]	n	N番目の引数（0起算）
[out]	offset	offset

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 524 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_convert_rtc_to_tlc()

void CCP_convert_rtc_to_tlc	(	CommonCmdPacket *	packet,
		cycle_t	ti
	)

Realtime Command から Timeline Command へ変換

引数

[in,out]	packet	変換する packet
[in]	ti	TI

戻り値: void

common_cmd_packet_util.c の 246 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_form_and_exec_block_deploy_cmd()

CCP_CmdRet CCP_form_and_exec_block_deploy_cmd	(	TLCD_ID	tl_no,
		bct_id_t	block_no
	)

BC展開 command を生成し，即時実行する

引数

[in]	tl_no	Timeline no
[in]	block_no	BC ID

戻り値

CCP_CmdRet{CCP_EXEC_PACKET_FMT_ERR,*}	引数が不正なとき
それ以外	PH_dispatch_command の返り値

common_cmd_packet_util.c の 360 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_form_and_exec_rtc()

CCP_CmdRet CCP_form_and_exec_rtc	(	CMD_CODE	cmd_id,
		const uint8_t *	param,
		uint16_t	len
	)

Realtime command を生成し，即時実行する

覚え書き: RTC のキューに登録する場合は CCP_register_rtc を使用; 生成される command は RTC だが，キューイングされずに即時実行されるため RTC Dispatcher にはログは残らない

引数

[in]	cmd_id	CMD_CODE
[in]	param	パラメタ
[in]	len	パラメタ長

戻り値

CCP_CmdRet{CCP_EXEC_PACKET_FMT_ERR,*}	引数が不正なとき
それ以外	PH_dispatch_command の返り値

common_cmd_packet_util.c の 336 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_form_and_exec_rtc_to_other_obc()

CCP_CmdRet CCP_form_and_exec_rtc_to_other_obc	(	APID	apid,
		CMD_CODE	cmd_id,
		const uint8_t *	param,
		uint16_t	len
	)

他の OBC のコマンドを RT として生成し，即時実行する

覚え書き: 生成される command は RTC だが，キューイングされずに即時実行されるため RTC Dispatcher にはログは残らない

引数

[in]	apid	宛先 OBC のコマンドの APID
[in]	cmd_id	宛先 OBC の CMD_CODE
[in]	param	パラメタ
[in]	len	パラメタ長

戻り値

CCP_CmdRet{CCP_EXEC_PACKET_FMT_ERR,*}	引数が不正なとき
それ以外	PH_dispatch_command の返り値

common_cmd_packet_util.c の 348 行目に定義があります。

呼び出し関係図:

◆ CCP_form_app_cmd()

void CCP_form_app_cmd	(	CommonCmdPacket *	packet,
		cycle_t	ti,
		AR_APP_ID	id
	)

App 実行 TL コマンドを生成

覚え書き: 生成した時は CCP_EXEC_TYPE_TL_FROM_GS

引数

[in,out]	packet	CCP
[in]	ti	TI
[in]	id	AR_APP_ID

戻り値: void

common_cmd_packet_util.c の 94 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_form_block_deploy_cmd()

CCP_UTIL_ACK CCP_form_block_deploy_cmd	(	CommonCmdPacket *	packet,
		TLCD_ID	tl_no,
		bct_id_t	block_no
	)

BC展開 Realtime command を生成

覚え書き: 引数が不正なとき， packet は NOP RTC を返す

引数

[in,out]	packet	CCP
[in]	tl_no	Timeline no
[in]	block_no	BC ID

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 209 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_form_nop_rtc_()

void CCP_form_nop_rtc_ ( CommonCmdPacket * packet )

NOP cmd の RTC CCP を作る

引数

[in,out] packet CCP

戻り値: void

common_cmd_packet_util.c の 88 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_form_rtc()

CCP_UTIL_ACK CCP_form_rtc	(	CommonCmdPacket *	packet,
		CMD_CODE	cmd_id,
		const uint8_t *	param,
		uint16_t	len
	)

Realtime command を生成

覚え書き: 引数が不正なとき， packet は NOP RTC を返す; RTC のキューに登録までする場合は CCP_register_rtc を使用

引数

[in,out]	packet	CCP
[in]	cmd_id	CMD_CODE
[in]	param	パラメタ
[in]	len	パラメタ長

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 110 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_form_rtc_()

static void CCP_form_rtc_	(	CommonCmdPacket *	packet,
		CMD_CODE	cmd_id,
		const uint8_t *	param,
		uint16_t	len
	)

static

RealTime Command を生成する. CCP_form_* の実体.

覚え書き: packet, param は NULL 出ないことが保証されていることを前提とする

引数

[in,out]	packet	CCP
[in]	cmd_id	CMD_CODE
[in]	param	パラメタの先頭アドレス
[in]	len	パラメタ長

戻り値: void

common_cmd_packet_util.c の 235 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_form_rtc_to_other_obc()

CCP_UTIL_ACK CCP_form_rtc_to_other_obc	(	CommonCmdPacket *	packet,
		APID	apid,
		CMD_CODE	cmd_id,
		const uint8_t *	param,
		uint16_t	len
	)

他の OBC のコマンドを RT として生成

覚え書き: 本OBC で RT として処理されたあと他の OBC に送られ RT として実行される; param チェックは未実装

引数

[in]	apid	宛先 OBC のコマンドの APID
[in]	cmd_id	宛先 OBC の CMD_CODE
[in]	param	パラメタ
[in]	len	パラメタ長

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 163 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_form_tlc()

CCP_UTIL_ACK CCP_form_tlc	(	CommonCmdPacket *	packet,
		cycle_t	ti,
		CMD_CODE	cmd_id,
		const uint8_t *	param,
		uint16_t	len
	)

Timeline command を生成

覚え書き: 引数が不正なとき， packet は NOP TLC を返す; TL に登録までする場合は CCP_register_tlc を使用

引数

[in,out]	packet	CCP
[in]	ti	TI
[in]	cmd_id	CMD_CODE
[in]	param	パラメタ
[in]	len	パラメタ長

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 135 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_form_tlc_to_other_obc()

CCP_UTIL_ACK CCP_form_tlc_to_other_obc	(	CommonCmdPacket *	packet,
		cycle_t	ti,
		APID	apid,
		CMD_CODE	cmd_id,
		const uint8_t *	param,
		uint16_t	len
	)

他の OBC のコマンドを TL として生成

覚え書き: 本OBC で TL として処理されたあと他の OBC に送られ RT として実行される; param チェックは未実装

引数

[in]	ti	TI
[in]	apid	宛先 OBC のコマンドの APID
[in]	cmd_id	宛先 OBC の CMD_CODE
[in]	param	パラメタ
[in]	len	パラメタ長

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 185 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_get_1byte_param_from_packet()

uint8_t* CCP_get_1byte_param_from_packet	(	const CommonCmdPacket *	packet,
		uint8_t	n
	)

CCP packet から，サイズが 1 byte のコマンド引数を取得する

覚え書き: セグメンテーション違反の場合は， 0 が代入されたポインタを返す; CCP_get_param_from_packet マクロで使うことを想定し，ユーザーはこの関数を直接叩くことは想定していない

引数

[in]	packet	取得する packet
[in]	n	N番目の引数（0起算）

戻り値: パラメタを保持したポインタ（型は意味をもってない）

common_cmd_packet_util.c の 396 行目に定義があります。

呼び出し関係図:

◆ CCP_get_2byte_param_from_packet()

uint16_t* CCP_get_2byte_param_from_packet	(	const CommonCmdPacket *	packet,
		uint8_t	n
	)

CCP packet から，サイズが 2 byte のコマンド引数を取得する

覚え書き: セグメンテーション違反の場合は， 0 が代入されたポインタを返す; CCP_get_param_from_packet マクロで使うことを想定し，ユーザーはこの関数を直接叩くことは想定していない

引数

[in]	packet	取得する packet
[in]	n	N番目の引数（0起算）

戻り値: パラメタを保持したポインタ（型は意味をもってない）

common_cmd_packet_util.c の 416 行目に定義があります。

呼び出し関係図:

◆ CCP_get_4byte_param_from_packet()

uint32_t* CCP_get_4byte_param_from_packet	(	const CommonCmdPacket *	packet,
		uint8_t	n
	)

CCP packet から，サイズが 4 byte のコマンド引数を取得する

覚え書き: セグメンテーション違反の場合は， 0 が代入されたポインタを返す; CCP_get_param_from_packet マクロで使うことを想定し，ユーザーはこの関数を直接叩くことは想定していない

引数

[in]	packet	取得する packet
[in]	n	N番目の引数（0起算）

戻り値: パラメタを保持したポインタ（型は意味をもってない）

common_cmd_packet_util.c の 436 行目に定義があります。

呼び出し関係図:

◆ CCP_get_8byte_param_from_packet()

uint64_t* CCP_get_8byte_param_from_packet	(	const CommonCmdPacket *	packet,
		uint8_t	n
	)

CCP packet から，サイズが 8 byte のコマンド引数を取得する

覚え書き: セグメンテーション違反の場合は， 0 が代入されたポインタを返す; CCP_get_param_from_packet マクロで使うことを想定し，ユーザーはこの関数を直接叩くことは想定していない

引数

[in]	packet	取得する packet
[in]	n	N番目の引数（0起算）

戻り値: パラメタを保持したポインタ（型は意味をもってない）

common_cmd_packet_util.c の 456 行目に定義があります。

呼び出し関係図:

◆ CCP_get_exec_type_from_tlcd_id()

CCP_EXEC_TYPE CCP_get_exec_type_from_tlcd_id ( TLCD_ID tlcd_id )

TLCD ID から CCP_EXEC_TYPE を取得する

引数

[in] tlcd_id tl id

覚え書き: 引数が不正な場合は CCP_EXEC_TYPE_UNKNOWN を返す

戻り値: CCP_EXEC_TYPE

common_cmd_packet_util.c の 372 行目に定義があります。

被呼び出し関係図:

◆ CCP_get_prepared_param_for_packet()

CCP_UTIL_ACK CCP_get_prepared_param_for_packet	(	const uint8_t **	param_head,
		uint16_t *	len
	)

Param Generator から完成した param を取得する

覚え書き: Param Generator の使い方は CCP_reset_param_for_packet の doxygen コメントを参照のこと

引数

[out]	param_head	完成した param の先頭ポインタ
[out]	len	paran の長さ

戻り値

CCP_UTIL_ACK_OK	正常終了
CCP_UTIL_ACK_PARAM_ERR	これまでの param 生成仮定で何かしらの不整合が発生

common_cmd_packet_util.c の 550 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_get_raw_param_from_packet()

uint16_t CCP_get_raw_param_from_packet	(	const CommonCmdPacket *	packet,
		void *	dest,
		uint16_t	max_copy_len
	)

CCP packet から，RAW コマンド引数を取得する

覚え書き: RAW パラメタが存在しない場合は， 0 を返す

引数

[in]	packet	取得する packet
[out]	dest	RAW パラメタコピー先
[in]	max_copy_len	: コピーする最大長． 0 の場合，無制限

戻り値: コピーした長さ

common_cmd_packet_util.c の 476 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_get_raw_param_head()

const uint8_t* CCP_get_raw_param_head ( const CommonCmdPacket * packet )

CCP packet から，RAW コマンド引数の先頭ポインタを取得する

覚え書き: RAW パラメタが存在しない場合は， NULL を返す; RAW パラメタが存在しつつ，そのサイズが 0 だった場合は， NULL ではなく最終 param の次のアドレスを返す

引数

[in] packet 取得する packet

戻り値: RAW コマンド引数の先頭ポインタ

common_cmd_packet_util.c の 500 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_get_raw_param_len()

uint16_t CCP_get_raw_param_len ( const CommonCmdPacket * packet )

CCP packet から，RAW コマンド引数の長さを返す

覚え書き: RAW パラメタが存在しない場合や，不正なパケットの場合は 0 を返す

引数

[in] packet 取得する packet

戻り値: RAW コマンド引数の長さ

common_cmd_packet_util.c の 512 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_init_param_for_packet()

void CCP_init_param_for_packet ( CMD_CODE cmd_id )

Param Generator を初期化

覚え書き

Param Generator の使い方

CCP_init_param_for_packet で初期化
CCP_prepare_hoge_param_for_packet にて，パラメタを 1 つめからセットしていく
CCP_get_prepared_param_for_packet で完成した param とその長さを取得する

引数

[in] cmd_id これから作成する param の Cmd ID

戻り値: void

common_cmd_packet_util.c の 539 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_make_cmd_ret()

CCP_CmdRet CCP_make_cmd_ret	(	CCP_EXEC_STS	exec_sts,
		uint32_t	err_code
	)

コマンド返り値である CCP_CmdRet を作成

覚え書き: err_code を使わないときはそれを明示するために CCP_make_cmd_ret_without_err_code をつかうこと

引数

[in]	exec_sts	コマンド実行結果 (CCP_EXEC_STS)
[in]	err_code	ユーザー定義エラーコード

戻り値: CCP_CmdRet

common_cmd_packet_util.c の 73 行目に定義があります。

被呼び出し関係図:

◆ CCP_make_cmd_ret_without_err_code()

CCP_CmdRet CCP_make_cmd_ret_without_err_code ( CCP_EXEC_STS exec_sts )

コマンド返り値である CCP_CmdRet を作成（エラーコード不使用版）

引数

[in] exec_sts コマンド実行結果 (CCP_EXEC_STS)

戻り値: CCP_CmdRet

common_cmd_packet_util.c の 82 行目に定義があります。

呼び出し関係図:

◆ CCP_prepare_bct_id_param_for_packet()

CCP_UTIL_ACK CCP_prepare_bct_id_param_for_packet ( bct_id_t param )

Param Generator で bct_id_t のパラメタを登録

覚え書き: Param Generator の使い方は CCP_reset_param_for_packet の doxygen コメントを参照のこと

引数

[in] param 登録するパラメタ

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 624 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_prepare_double_param_for_packet()

CCP_UTIL_ACK CCP_prepare_double_param_for_packet ( double param )

Param Generator で double のパラメタを登録

覚え書き: Param Generator の使い方は CCP_reset_param_for_packet の doxygen コメントを参照のこと

引数

[in] param 登録するパラメタ

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 618 行目に定義があります。

呼び出し関係図:

◆ CCP_prepare_float_param_for_packet()

CCP_UTIL_ACK CCP_prepare_float_param_for_packet ( float param )

Param Generator で float のパラメタを登録

覚え書き: Param Generator の使い方は CCP_reset_param_for_packet の doxygen コメントを参照のこと

引数

[in] param 登録するパラメタ

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 612 行目に定義があります。

呼び出し関係図:

◆ CCP_prepare_int16_param_for_packet()

CCP_UTIL_ACK CCP_prepare_int16_param_for_packet ( int16_t param )

Param Generator で int16_t のパラメタを登録

覚え書き: Param Generator の使い方は CCP_reset_param_for_packet の doxygen コメントを参照のこと

引数

[in] param 登録するパラメタ

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 582 行目に定義があります。

呼び出し関係図:

◆ CCP_prepare_int32_param_for_packet()

CCP_UTIL_ACK CCP_prepare_int32_param_for_packet ( int32_t param )

Param Generator で int32_t のパラメタを登録

覚え書き: Param Generator の使い方は CCP_reset_param_for_packet の doxygen コメントを参照のこと

引数

[in] param 登録するパラメタ

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 594 行目に定義があります。

呼び出し関係図:

◆ CCP_prepare_int64_param_for_packet()

CCP_UTIL_ACK CCP_prepare_int64_param_for_packet ( int64_t param )

Param Generator で int64_t のパラメタを登録

覚え書き: Param Generator の使い方は CCP_reset_param_for_packet の doxygen コメントを参照のこと

引数

[in] param 登録するパラメタ

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 606 行目に定義があります。

呼び出し関係図:

◆ CCP_prepare_int8_param_for_packet()

CCP_UTIL_ACK CCP_prepare_int8_param_for_packet ( int8_t param )

Param Generator で int8_t のパラメタを登録

覚え書き: Param Generator の使い方は CCP_reset_param_for_packet の doxygen コメントを参照のこと

引数

[in] param 登録するパラメタ

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 570 行目に定義があります。

呼び出し関係図:

◆ CCP_prepare_param_for_packet_()

static CCP_UTIL_ACK CCP_prepare_param_for_packet_	(	void *	param,
		uint8_t	byte
	)

static

Param Generator で n byte のパラメタを登録

覚え書き: Param Generator の使い方は CCP_reset_param_for_packet の doxygen コメントを参照のこと

引数

[in]	param	登録するパラメタ
[in]	byte	パラメタのサイズ

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 658 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_prepare_raw_param_for_packet()

CCP_UTIL_ACK CCP_prepare_raw_param_for_packet	(	const uint8_t *	param,
		uint16_t	len
	)

Param Generator で raw パラメタを登録

覚え書き: Param Generator の使い方は CCP_reset_param_for_packet の doxygen コメントを参照のこと

引数

[in]	param	登録するパラメタ配列
[in]	len	登録するパラメタの長さ

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 630 行目に定義があります。

呼び出し関係図:

◆ CCP_prepare_uint16_param_for_packet()

CCP_UTIL_ACK CCP_prepare_uint16_param_for_packet ( uint16_t param )

Param Generator で uint16_t のパラメタを登録

覚え書き: Param Generator の使い方は CCP_reset_param_for_packet の doxygen コメントを参照のこと

引数

[in] param 登録するパラメタ

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 576 行目に定義があります。

呼び出し関係図:

◆ CCP_prepare_uint32_param_for_packet()

CCP_UTIL_ACK CCP_prepare_uint32_param_for_packet ( uint32_t param )

Param Generator で uint32_t のパラメタを登録

覚え書き: Param Generator の使い方は CCP_reset_param_for_packet の doxygen コメントを参照のこと

引数

[in] param 登録するパラメタ

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 588 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_prepare_uint64_param_for_packet()

CCP_UTIL_ACK CCP_prepare_uint64_param_for_packet ( uint64_t param )

Param Generator で uint64_t のパラメタを登録

覚え書き: Param Generator の使い方は CCP_reset_param_for_packet の doxygen コメントを参照のこと

引数

[in] param 登録するパラメタ

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 600 行目に定義があります。

呼び出し関係図:

◆ CCP_prepare_uint8_param_for_packet()

CCP_UTIL_ACK CCP_prepare_uint8_param_for_packet ( uint8_t param )

Param Generator で uint8_t のパラメタを登録

覚え書き: Param Generator の使い方は CCP_reset_param_for_packet の doxygen コメントを参照のこと

引数

[in] param 登録するパラメタ

戻り値: CCP_UTIL_ACK

common_cmd_packet_util.c の 564 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

◆ CCP_raise_err_at_param_generator_()

static CCP_UTIL_ACK CCP_raise_err_at_param_generator_ ( void )

static

Param Generator でエラーを発生した際に呼ぶエラー保存関数

引数

void

戻り値

CCP_UTIL_ACK_PARAM_ERR

common_cmd_packet_util.c の 651 行目に定義があります。

被呼び出し関係図:

◆ CCP_register_rtc()

PH_ACK CCP_register_rtc	(	CMD_CODE	cmd_id,
		const uint8_t *	param,
		uint16_t	len
	)

Realtime command を登録

覚え書き: 不正な時は登録されない

引数

[in]	cmd_id	CMD_CODE
[in]	param	パラメタ
[in]	len	パラメタ長

戻り値: PH_ACK

common_cmd_packet_util.c の 254 行目に定義があります。

呼び出し関係図:

◆ CCP_register_tlc()

PH_ACK CCP_register_tlc	(	cycle_t	ti,
		TLCD_ID	tlcd_id,
		CMD_CODE	cmd_id,
		const uint8_t *	param,
		uint16_t	len
	)

Timeline command を登録

引数

[in]	ti	TI
[in]	tlcd_id	登録する tl id
[in]	cmd_id	CMD_CODE
[in]	param	パラメタ
[in]	len	パラメタ長

戻り値: PH_ACK

common_cmd_packet_util.c の 265 行目に定義があります。

呼び出し関係図:

◆ CCP_register_tlc_asap()

PH_ACK CCP_register_tlc_asap	(	cycle_t	ti,
		TLCD_ID	tlcd_id,
		CMD_CODE	cmd_id,
		const uint8_t *	param,
		uint16_t	len
	)

Timeline command を登録 (ASAP 版)

覚え書き: 引数が不正なときは登録されない; 既にその TI が埋まっていた場合その後で最速の TI が勝手に設定される

引数

[in]	ti	TI
[in]	tlcd_id	登録する tl id
[in]	cmd_id	CMD_CODE
[in]	param	パラメタ
[in]	len	パラメタ長

戻り値: PH_ACK

common_cmd_packet_util.c の 284 行目に定義があります。

呼び出し関係図:

被呼び出し関係図:

変数詳解

◆ CCP_param_generator_

CCP_ParamGenerator CCP_param_generator_

static

common_cmd_packet_util.c の 26 行目に定義があります。

◆ CCP_util_packet_

CommonCmdPacket CCP_util_packet_

static

common_cmd_packet_util.c の 25 行目に定義があります。

データ構造

関数

変数

詳解

関数詳解

◆ CCP_calc_param_offset_()

◆ CCP_convert_rtc_to_tlc()

◆ CCP_form_and_exec_block_deploy_cmd()

◆ CCP_form_and_exec_rtc()

◆ CCP_form_and_exec_rtc_to_other_obc()

◆ CCP_form_app_cmd()

◆ CCP_form_block_deploy_cmd()

◆ CCP_form_nop_rtc_()

◆ CCP_form_rtc()

◆ CCP_form_rtc_()

◆ CCP_form_rtc_to_other_obc()

◆ CCP_form_tlc()

◆ CCP_form_tlc_to_other_obc()

◆ CCP_get_1byte_param_from_packet()

◆ CCP_get_2byte_param_from_packet()

◆ CCP_get_4byte_param_from_packet()

◆ CCP_get_8byte_param_from_packet()

◆ CCP_get_exec_type_from_tlcd_id()

◆ CCP_get_prepared_param_for_packet()

◆ CCP_get_raw_param_from_packet()

◆ CCP_get_raw_param_head()

◆ CCP_get_raw_param_len()

◆ CCP_init_param_for_packet()

◆ CCP_make_cmd_ret()

◆ CCP_make_cmd_ret_without_err_code()

◆ CCP_prepare_bct_id_param_for_packet()

◆ CCP_prepare_double_param_for_packet()

◆ CCP_prepare_float_param_for_packet()

◆ CCP_prepare_int16_param_for_packet()

◆ CCP_prepare_int32_param_for_packet()

◆ CCP_prepare_int64_param_for_packet()

◆ CCP_prepare_int8_param_for_packet()

◆ CCP_prepare_param_for_packet_()

◆ CCP_prepare_raw_param_for_packet()

◆ CCP_prepare_uint16_param_for_packet()

◆ CCP_prepare_uint32_param_for_packet()

◆ CCP_prepare_uint64_param_for_packet()

◆ CCP_prepare_uint8_param_for_packet()

◆ CCP_raise_err_at_param_generator_()

◆ CCP_register_rtc()

◆ CCP_register_tlc()

◆ CCP_register_tlc_asap()

変数詳解

◆ CCP_param_generator_

◆ CCP_util_packet_