block_command_table.h

[詳解]

 
#ifndef BLOCK_COMMAND_TABLE_H_
#define BLOCK_COMMAND_TABLE_H_
 
#include <stdint.h>
 
#define BCT_CMD_MAX_LENGTH (64)  
#define BCT_MAX_CMD_NUM    (32)  
 
#define BCT_MAX_BLOCKS    (383) 
// ここ変えたら，Cmd_RESET_(RE)STORE_BCT* も変える！
// 2019/07/19 コメント追加
// MM_NOT_DEFINEDにBCT_MAX_BLOCKS が使われているので，-1されてる．
// けど，まあ-1する必要もあまりなさそう？
 
 
// 今後，BCTのサイズ変更がしやすいように定義する
// コマンドの引数長チェックもこれを用いる
#define SIZE_OF_BCT_ID_T    (2)    
 
#include <src_user/Settings/TlmCmd/block_command_table_params.h>
 
#if SIZE_OF_BCT_ID_T == 1
typedef uint8_t bct_id_t;
#elif SIZE_OF_BCT_ID_T == 2
typedef uint16_t bct_id_t;
#elif SIZE_OF_BCT_ID_T == 4
typedef uint32_t bct_id_t;
#else
#error Illegal value for SIZE_OF_BCT_ID_T
#endif
 
#include "common_cmd_packet.h" // bct_id_t の定義よりあとにinclude
 
/*
Block Command Table は
BCT_MAX_BLOCKS x BCT_MAX_CMD_NUM
のテーブルであり，
BCT_Pos.block がブロック番号，
BCT_Pos.cmd   がそのブロック内での位置
を保持している．
コマンドの実データを保存している本体は
 
[構造体定義]                        [サイズ Byte]
BlockCommandTable                        7668               at 383
  BCT_Pos                               8 : 4 * 2
    block                                   2
    cmd                                     1
  BCT_Func[BCT_MAX_BLOCKS]           6128 : 4 * 4 * 383 at 383
  BCT_Table*[BCT_MAX_BLOCKS]         1532 : 4 * 383     at 383
 
BCT_Table                          784767               at 383
  length                                    1
  BCT_CmdData[BCT_MAX_CMD_NUM]               2048 : 64 * 32
    data[BCT_CMD_MAX_LENGTH]                        64
 
Sum                                792435 : 784767 + 7668
なお，構造体のサイズは，そのメンバのサイズの和になるとは限らないことに注意．
この値は目安である．(データの効率化のために，パディングされることがあるため.)
*/
 
typedef struct
{
  bct_id_t block; 
  uint8_t  cmd;   
} BCT_Pos;
 
typedef struct
{
  uint8_t data[BCT_CMD_MAX_LENGTH];
} BCT_CmdData;
 
typedef struct
{
  uint8_t     length;                   
  BCT_CmdData cmds[BCT_MAX_CMD_NUM];     
} BCT_Table;
 
typedef struct
{
  BCT_CmdData* (*get_bc_cmd_data_)(const BCT_Pos* pos);                           
  uint8_t      (*get_bc_length_)(const bct_id_t block);                           
  void         (*set_bc_cmd_data_)(const BCT_Pos* pos, const BCT_CmdData* value); 
  void         (*set_bc_length_)(const bct_id_t block, uint8_t length);           
} BCT_Func;
 
typedef struct
{
  BCT_Pos pos;                            
  BCT_Pos pos_stored;                     
  BCT_Table* blocks[BCT_MAX_BLOCKS];      
  BCT_Func   func[BCT_MAX_BLOCKS];        
} BlockCommandTable;
 
typedef enum
{
  BCT_SUCCESS,
  BCT_INVALID_BLOCK_NO,
  BCT_INVALID_CMD_NO,
  BCT_ISORATED_CMD,
  BCT_DEFECTIVE_BLOCK,
  BCT_CMD_TOO_LONG,
  BCT_BC_FULL,
  BCT_ZERO_PERIOD,
  BCT_UNKNOWN
} BCT_ACK;
 
extern const BlockCommandTable* const block_command_table;
 
void BCT_initialize(void);
 
const BCT_CmdData* BCT_get_bc_cmd_data(const BCT_Pos* pos);
 
uint8_t BCT_get_bc_length(const bct_id_t block);
 
BCT_ACK BCT_clear_block(const bct_id_t block);
 
void BCT_store_pos(void);
 
void BCT_restore_pos(void);
 
BCT_ACK BCT_check_position(const BCT_Pos* pos);
 
BCT_ACK BCT_make_pos(BCT_Pos* pos, const bct_id_t block, const uint8_t cmd);
 
BCT_ACK BCT_load_cmd(const BCT_Pos* pos, CommonCmdPacket* packet);
 
BCT_ACK BCT_register_cmd(const CommonCmdPacket* packet);
 
BCT_ACK BCT_overwrite_cmd(const BCT_Pos* pos, const CommonCmdPacket* packet);
 
BCT_ACK BCT_copy_bct(const bct_id_t dst_block, const bct_id_t src_block);
 
// 以下3つは BCT に登録されている Cmd からその内容を取り出すgetter
CMD_CODE BCT_get_id(const bct_id_t block, const uint8_t cmd);
 
cycle_t BCT_get_ti(const bct_id_t block, const uint8_t cmd);
 
const uint8_t* BCT_get_param_head(const bct_id_t block, const uint8_t cmd);
 
BCT_ACK BCT_swap_address(const bct_id_t block_a, const bct_id_t block_b);
 
BCT_ACK BCT_swap_contents(const bct_id_t block_a, const bct_id_t block_b);
 
CCP_CmdRet BCT_convert_bct_ack_to_ccp_cmd_ret(BCT_ACK ack);
 
CCP_CmdRet Cmd_BCT_CLEAR_BLOCK(const CommonCmdPacket* packet);
CCP_CmdRet Cmd_BCT_SET_BLOCK_POSITION(const CommonCmdPacket* packet);
CCP_CmdRet Cmd_BCT_COPY_BCT(const CommonCmdPacket* packet);
CCP_CmdRet Cmd_BCT_OVERWRITE_CMD(const CommonCmdPacket* packet);
CCP_CmdRet Cmd_BCT_FILL_NOP(const CommonCmdPacket* packet);
 
#endif