common_cmd_packet_util.h

[詳解]

 
#ifndef COMMON_CMD_PACKET_UTIL_H_
#define COMMON_CMD_PACKET_UTIL_H_
 
#include "common_cmd_packet.h"
#include "packet_handler.h"
#include "../Applications/timeline_command_dispatcher_id_define.h"
#include "block_command_table.h" // for bct_id
#include <src_user/Applications/app_registry.h>
 
typedef enum
{
  CCP_UTIL_ACK_OK = 0,       
  CCP_UTIL_ACK_PARAM_ERR     
} CCP_UTIL_ACK;
 
 
CCP_CmdRet CCP_make_cmd_ret(CCP_EXEC_STS exec_sts, uint32_t err_code);
 
CCP_CmdRet CCP_make_cmd_ret_without_err_code(CCP_EXEC_STS exec_sts);
 
void CCP_form_app_cmd(CommonCmdPacket* packet, cycle_t ti, AR_APP_ID id);
 
CCP_UTIL_ACK CCP_form_rtc(CommonCmdPacket* packet, CMD_CODE cmd_id, const uint8_t* param, uint16_t len);
 
CCP_UTIL_ACK CCP_form_tlc(CommonCmdPacket* packet, cycle_t ti, CMD_CODE cmd_id, const uint8_t* param, uint16_t len);
 
CCP_UTIL_ACK CCP_form_rtc_to_other_obc(CommonCmdPacket* packet, APID apid, CMD_CODE cmd_id, const uint8_t* param, uint16_t len);
 
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);
 
CCP_UTIL_ACK CCP_form_block_deploy_cmd(CommonCmdPacket* packet, TLCD_ID tl_no, bct_id_t block_no);
 
void CCP_convert_rtc_to_tlc(CommonCmdPacket* packet, cycle_t ti);
 
PH_ACK CCP_register_rtc(CMD_CODE cmd_id, const uint8_t* param, uint16_t len);
 
PH_ACK CCP_register_tlc(cycle_t ti, TLCD_ID tlcd_id, CMD_CODE cmd_id, const uint8_t* param, uint16_t len);
 
PH_ACK CCP_register_tlc_asap(cycle_t ti, TLCD_ID tlcd_id, CMD_CODE cmd_id, const uint8_t* param, uint16_t len);
 
CCP_CmdRet CCP_form_and_exec_rtc(CMD_CODE cmd_id, const uint8_t* param, uint16_t len);
 
CCP_CmdRet CCP_form_and_exec_rtc_to_other_obc(APID apid, CMD_CODE cmd_id, const uint8_t* param, uint16_t len);
 
CCP_CmdRet CCP_form_and_exec_block_deploy_cmd(TLCD_ID tl_no, bct_id_t block_no);
 
CCP_EXEC_TYPE CCP_get_exec_type_from_tlcd_id(TLCD_ID tlcd_id);
 
uint8_t* CCP_get_1byte_param_from_packet(const CommonCmdPacket* packet, uint8_t n);
 
uint16_t* CCP_get_2byte_param_from_packet(const CommonCmdPacket* packet, uint8_t n);
 
uint32_t* CCP_get_4byte_param_from_packet(const CommonCmdPacket* packet, uint8_t n);
 
uint64_t* CCP_get_8byte_param_from_packet(const CommonCmdPacket* packet, uint8_t n);
 
uint16_t CCP_get_raw_param_from_packet(const CommonCmdPacket* packet, void* dest, uint16_t max_copy_len);
 
const uint8_t* CCP_get_raw_param_head(const CommonCmdPacket* packet);
 
uint16_t CCP_get_raw_param_len(const CommonCmdPacket* packet);
 
#define CCP_get_param_from_packet(packet, n, type) \
(*((type*)( \
sizeof(type) == 1 ? \
(void*)CCP_get_1byte_param_from_packet(packet, n) : \
sizeof(type) == 2 ? \
(void*)CCP_get_2byte_param_from_packet(packet, n) : \
sizeof(type) == 4 ? \
(void*)CCP_get_4byte_param_from_packet(packet, n) : \
sizeof(type) == 8 ? \
(void*)CCP_get_8byte_param_from_packet(packet, n) : \
0)))
 
void CCP_init_param_for_packet(CMD_CODE cmd_id);
 
CCP_UTIL_ACK CCP_get_prepared_param_for_packet(const uint8_t** param_head, uint16_t* len);
 
CCP_UTIL_ACK CCP_prepare_uint8_param_for_packet(uint8_t param);
 
CCP_UTIL_ACK CCP_prepare_int8_param_for_packet(int8_t param);
 
CCP_UTIL_ACK CCP_prepare_uint16_param_for_packet(uint16_t param);
 
CCP_UTIL_ACK CCP_prepare_int16_param_for_packet(int16_t param);
 
CCP_UTIL_ACK CCP_prepare_uint32_param_for_packet(uint32_t param);
 
CCP_UTIL_ACK CCP_prepare_int32_param_for_packet(int32_t param);
 
CCP_UTIL_ACK CCP_prepare_uint64_param_for_packet(uint64_t param);
 
CCP_UTIL_ACK CCP_prepare_int64_param_for_packet(int64_t param);
 
CCP_UTIL_ACK CCP_prepare_float_param_for_packet(float param);
 
CCP_UTIL_ACK CCP_prepare_double_param_for_packet(double param);
 
CCP_UTIL_ACK CCP_prepare_bct_id_param_for_packet(bct_id_t param);
 
CCP_UTIL_ACK CCP_prepare_raw_param_for_packet(const uint8_t* param, uint16_t len);
 
#endif