common_cmd_packet.h

[詳解]

 
#ifndef COMMON_CMD_PACKET_H_
#define COMMON_CMD_PACKET_H_
 
#include "../System/TimeManager/obc_time.h"
#include <src_user/TlmCmd/command_definitions.h>
 
// ここで CCP_DEST_TYPE を定義する
// 詳細は
// - /Examples/minimum_user/src/src_user/Settings/TlmCmd/common_cmd_packet_define.h
// - https://github.com/ut-issl/c2a-core/blob/develop/Docs/Core/communication.md
// を参照
/* 例
typedef enum
{
  CCP_DEST_TYPE_TO_ME     = 0x0,
  CCP_DEST_TYPE_TO_MOBC   = 0x1,
  CCP_DEST_TYPE_TO_AOBC   = 0x2,
  CCP_DEST_TYPE_TO_TOBC   = 0x3,
  CCP_DEST_TYPE_TO_UNKOWN = 0xe,
  CCP_DEST_TYPE_TO_APID   = 0xf
} CCP_DEST_TYPE;
*/
// さらに， CCP_APID_TO_ME, CCP_MAX_LEN, CommonCmdPacket として使うパケット型を指定する
#include <src_user/Settings/TlmCmd/common_cmd_packet_define.h>
 
// ここで APID を定義する
// 詳細は common_tlm_cmd_packet.h を参照
#include <src_user/Settings/TlmCmd/Ccsds/apid_define.h>
 
// TL_MIS を有効にするかどうか
#include <src_user/Settings/Applications/timeline_command_dispatcher_define.h>
 
typedef enum
{
  CCP_EXEC_SUCCESS = 0,         
  CCP_EXEC_ILLEGAL_LENGTH,      
  CCP_EXEC_ILLEGAL_PARAMETER,   
  CCP_EXEC_ILLEGAL_CONTEXT,     
  CCP_EXEC_CMD_NOT_DEFINED,     
  CCP_EXEC_ROUTING_FAILED,      
  CCP_EXEC_PACKET_FMT_ERR,      
  CCP_EXEC_UNKNOWN              
} CCP_EXEC_STS;
 
typedef enum
{
  CCP_EXEC_TYPE_GS,              
  CCP_EXEC_TYPE_TL_FROM_GS,      
  CCP_EXEC_TYPE_BC,              
  CCP_EXEC_TYPE_RT,              
  CCP_EXEC_TYPE_UTL,             
  CCP_EXEC_TYPE_TL_DEPLOY_BC,
  CCP_EXEC_TYPE_TL_DEPLOY_TLM,
#ifdef TLCD_ENABLE_MISSION_TL
  CCP_EXEC_TYPE_TL_FOR_MISSION,  
  CCP_EXEC_TYPE_UTL_FOR_MISSION, 
#endif
  CCP_EXEC_TYPE_UNKNOWN
} CCP_EXEC_TYPE;
 
typedef struct
{
  CCP_EXEC_STS exec_sts;    
  uint32_t     err_code;    
} CCP_CmdRet;
 
 
int CCP_is_valid_packet(const CommonCmdPacket* packet);
 
cycle_t CCP_get_ti(const CommonCmdPacket* packet);
 
void CCP_set_ti(CommonCmdPacket* packet, cycle_t ti);
 
APID CCP_get_apid(const CommonCmdPacket* packet);
 
void CCP_set_apid(CommonCmdPacket* packet, APID apid);
 
CCP_EXEC_TYPE CCP_get_exec_type(const CommonCmdPacket* packet);
 
void CCP_set_exec_type(CommonCmdPacket* packet, CCP_EXEC_TYPE type);
 
CCP_DEST_TYPE CCP_get_dest_type(const CommonCmdPacket* packet);
 
void CCP_set_dest_type(CommonCmdPacket* packet, CCP_DEST_TYPE type);
 
CMD_CODE CCP_get_id(const CommonCmdPacket* packet);
 
void CCP_set_id(CommonCmdPacket* packet, CMD_CODE id);
 
uint16_t CCP_get_packet_len(const CommonCmdPacket* packet);
 
uint16_t CCP_get_param_len(const CommonCmdPacket* packet);
 
uint16_t CCP_get_max_param_len(void);
 
const uint8_t* CCP_get_param_head(const CommonCmdPacket* packet);
 
void CCP_set_param(CommonCmdPacket* packet, const uint8_t* param, uint16_t len);
 
void CCP_set_common_hdr(CommonCmdPacket* packet);
 
void CCP_copy_packet(CommonCmdPacket* dest, const CommonCmdPacket* src);
 
#endif