2016-03-16 00:54:13 +01:00
|
|
|
/* -*- c++ -*- */
|
|
|
|
/*
|
|
|
|
* gr-satnogs: SatNOGS GNU Radio Out-Of-Tree Module
|
|
|
|
*
|
|
|
|
* Copyright (C) 2016, Libre Space Foundation <http://librespacefoundation.org/>
|
|
|
|
*
|
|
|
|
* This program is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef INCLUDED_SATNOGS_TC_TM_H
|
|
|
|
#define INCLUDED_SATNOGS_TC_TM_H
|
|
|
|
|
|
|
|
#include <satnogs/api.h>
|
|
|
|
#include <stdint.h>
|
|
|
|
|
|
|
|
/* TM TC services*/
|
|
|
|
#define ECSS_VER_NUMBER 0
|
|
|
|
#define ECSS_DATA_FIELD_HDR_FLG 1
|
|
|
|
#define TC_TM_SER_TC_VER 1
|
|
|
|
|
|
|
|
#define ECSS_PUS_VER 1
|
|
|
|
#define ECSS_SEC_HDR_FIELD_FLG 0
|
|
|
|
/* Minimal */
|
|
|
|
#define TC_TM_SER_TC_VER_ACC_SUCC 1
|
|
|
|
#define TC_TM_SER_TC_VER_ACC_FAIL 2
|
|
|
|
/* Additional */
|
|
|
|
#define TC_TM_SER_TC_VER_EXEC_START_SUCC 3
|
|
|
|
#define TC_TM_SER_TC_VER_EXEC_START_FAIL 4
|
|
|
|
#define TC_TM_SER_TC_VER_EXEC_PROG_SUCC 5
|
|
|
|
#define TC_TM_SER_TC_VER_EXEC_PROG_FAIL 6
|
|
|
|
#define TC_TM_SER_TC_VER_EXEC_COMP_SUCC 7
|
|
|
|
#define TC_TM_SER_TC_VER_EXEC_COMP_FAIL 8
|
|
|
|
|
|
|
|
#define TC_TM_SER_DIST 2
|
|
|
|
#define TC_TM_SER_HK 3
|
|
|
|
|
|
|
|
/* Minimal */
|
|
|
|
#define TC_TM_SER_HK_PAR 25
|
|
|
|
/* Additional */
|
|
|
|
|
|
|
|
#define TC_TM_SER_STAT 4
|
|
|
|
#define TC_TM_SER_EVENT 5
|
|
|
|
#define TC_TM_SER_MEM 6
|
|
|
|
#define TC_TM_SER_NC1 7
|
|
|
|
#define TC_TM_SER_FMAG 8
|
|
|
|
#define TC_TM_SER_TMAG 9
|
|
|
|
#define TC_TM_SER_NC2 10
|
|
|
|
|
|
|
|
#define TC_TM_SER_SCH 11
|
|
|
|
#define TC_TM_SER_MON 12
|
|
|
|
#define TC_TM_SER_LDATA 13
|
|
|
|
#define TC_TM_SER_PCKT_FWD 14
|
|
|
|
#define TC_TM_SER_STORAGE 15
|
|
|
|
#define TC_TM_SER_NC3 16
|
|
|
|
#define TC_TM_SER_TEST 17
|
|
|
|
#define TC_TM_SER_PROC 18
|
|
|
|
#define TC_TM_SER_EV_ACT 19
|
|
|
|
|
|
|
|
/*sequence definitions*/
|
|
|
|
#define TC_TM_SEQ_FPACKET 0x01
|
|
|
|
#define TC_TM_SEQ_CPACKET 0x00
|
|
|
|
#define TC_TM_SEQ_LPACKET 0x02
|
|
|
|
#define TC_TM_SEQ_SPACKET 0x03
|
|
|
|
|
|
|
|
/*services ack req*/
|
|
|
|
/*should confirm endianess*/
|
|
|
|
#define TC_ACK_NO 0x00
|
|
|
|
#define TC_ACK_ACC 0x01
|
|
|
|
#define TC_ACK_EXE_START 0x02
|
|
|
|
#define TC_ACK_EXE_PROG 0x04
|
|
|
|
#define TC_ACK_EXE_COMP 0x08
|
|
|
|
#define TC_ACK_ALL 0x0F
|
|
|
|
|
|
|
|
#define TC_TM_SER_LDATA_MAX_DATA_PKT 512
|
|
|
|
|
|
|
|
#define VER_NUMBER
|
|
|
|
#define TC_TM_TYPE
|
|
|
|
#define DATA_FIELD_HDR_FLG
|
|
|
|
#define APP_ID
|
|
|
|
#define SEQ_FLG
|
|
|
|
|
|
|
|
#define MAX_PKT_DATA 20
|
|
|
|
#define MAX_EX_PKT_DATA 512
|
|
|
|
#define MAX_APP_ID 20
|
|
|
|
#define MAX_SERVICES 20
|
|
|
|
#define MAX_SUBTYPES 26
|
|
|
|
|
|
|
|
#define TC 1
|
|
|
|
#define TM 0
|
|
|
|
|
|
|
|
#define TC_VERIFICATION_SERVICE 1
|
|
|
|
#define TC_HOUSEKEEPING_SERVICE 3
|
|
|
|
#define TC_FUNCTION_MANAGEMENT_SERVICE 8
|
|
|
|
#define TC_LARGE_DATA_SERVICE 13
|
|
|
|
#define TC_MASS_STORAGE_SERVICE 15
|
|
|
|
#define TC_TEST_SERVICE 17
|
|
|
|
|
|
|
|
#define OBC 1
|
|
|
|
#define EPS 2
|
|
|
|
#define ADCS 3
|
|
|
|
#define COMMS 4
|
|
|
|
#define IAC 5
|
|
|
|
#define GND 6
|
|
|
|
|
|
|
|
#define SD1 1
|
|
|
|
|
|
|
|
#define TURN_OFF 0
|
|
|
|
#define TURN_ON 1
|
|
|
|
#define RESET 2
|
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
namespace gr {
|
|
|
|
namespace satnogs {
|
|
|
|
/*!
|
|
|
|
* \brief Telemetry and telecommands packet methods
|
|
|
|
* \ingroup satnogs
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*!
|
|
|
|
* Return status codes
|
|
|
|
*/
|
|
|
|
typedef enum {
|
|
|
|
R_OBC_PKT_ILLEGAL_APPID = 0, //!< R_OBC_PKT_ILLEGAL_APPID illegal application ID
|
|
|
|
R_OBC_PKT_INV_LEN = 1, //!< R_OBC_PKT_INV_LEN invalid length
|
|
|
|
R_OBC_PKT_INC_CRC = 2, //!< R_OBC_PKT_INC_CRC incorrect CRC
|
|
|
|
R_OBC_PKT_ILLEGAL_PKT_TP = 3, //!< R_OBC_PKT_ILLEGAL_PKT_TP
|
|
|
|
R_OBC_PKT_ILLEGAL_PKT_STP = 4, //!< R_OBC_PKT_ILLEGAL_PKT_STP
|
|
|
|
R_OBC_PKT_ILLEGAL_APP_DATA = 5, //!< R_OBC_PKT_ILLEGAL_APP_DATA
|
|
|
|
R_OBC_OK = 6, //!< R_OBC_OK All ok
|
|
|
|
R_OBC_ERROR = 7, //!< R_OBC_ERROR an error occured
|
|
|
|
R_OBC_EOT = 8, //!< R_OBC_EOT End-of-transfer
|
|
|
|
} OBC_ret_state_t;
|
|
|
|
|
|
|
|
union _cnv {
|
|
|
|
uint32_t cnv32;
|
|
|
|
uint16_t cnv16[2];
|
|
|
|
uint8_t cnv8[4];
|
|
|
|
};
|
|
|
|
|
|
|
|
typedef struct {
|
|
|
|
/* packet id */
|
|
|
|
uint8_t ver; /* 3 bits, should be equal to 0 */
|
|
|
|
uint8_t data_field_hdr; /* 1 bit, data_field_hdr exists in data = 1 */
|
|
|
|
uint16_t app_id; /* TM: app id = 0 for time packets, = 0xff for idle packets. */
|
|
|
|
uint8_t type; /* 1 bit, tm = 0, tc = 1 */
|
|
|
|
|
|
|
|
/* packet sequence control */
|
|
|
|
uint8_t seq_flags; /* 3 bits, definition in TC_SEQ_xPACKET */
|
|
|
|
uint16_t seq_count; /* 14 bits, packet counter, should be unique for each app id */
|
|
|
|
|
|
|
|
uint16_t len; /* 16 bits, C = (Number of octets in packet data field) - 1 */
|
|
|
|
|
|
|
|
uint8_t ack; /* 4 bits, definition in TC_ACK_xxxx 0 if its a TM */
|
|
|
|
uint8_t ser_type; /* 8 bit, service type */
|
|
|
|
uint8_t ser_subtype; /* 8 bit, service subtype */
|
|
|
|
|
|
|
|
/*optional*/
|
|
|
|
uint8_t pckt_sub_cnt; /* 8 bits*/
|
|
|
|
uint16_t dest_id;
|
|
|
|
|
|
|
|
uint8_t *data; /* variable data, this should be fixed array */
|
|
|
|
uint8_t padding; /* x bits, padding for word alligment */
|
|
|
|
|
|
|
|
uint16_t crc; /* CRC or checksum, mission specific*/
|
|
|
|
} tc_tm_pkt;
|
|
|
|
|
|
|
|
|
|
|
|
const uint8_t services_verification_TC_TM[MAX_SERVICES][MAX_SUBTYPES][2];
|
|
|
|
const uint8_t app_id_verification[MAX_APP_ID];
|
|
|
|
const uint8_t services_verification_OBC_TC[MAX_SERVICES][MAX_SUBTYPES];
|
|
|
|
|
|
|
|
extern OBC_ret_state_t
|
|
|
|
verification_pack_pkt_api(uint8_t *buf, tc_tm_pkt *pkt,
|
|
|
|
uint16_t *buf_pointer);
|
|
|
|
extern OBC_ret_state_t
|
|
|
|
hk_pack_pkt_api(uint8_t *buf, tc_tm_pkt *pkt, uint16_t *buf_pointer);
|
|
|
|
|
|
|
|
|
|
|
|
static inline uint8_t
|
|
|
|
ecss_tm_checksum(const uint8_t *data, uint16_t size)
|
2016-03-16 00:54:13 +01:00
|
|
|
{
|
2019-09-12 15:25:10 +02:00
|
|
|
uint8_t CRC = 0;
|
|
|
|
for (int i = 0; i <= size; i++) {
|
|
|
|
CRC = CRC ^ data[i];
|
|
|
|
}
|
|
|
|
return CRC;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*Must check for endianess*/
|
|
|
|
static inline OBC_ret_state_t
|
|
|
|
ecss_tm_unpack_pkt(const uint8_t *buf, tc_tm_pkt *pkt, const uint16_t size)
|
|
|
|
{
|
|
|
|
union _cnv cnv;
|
|
|
|
uint8_t tmp_crc[2];
|
|
|
|
|
|
|
|
uint8_t ver, dfield_hdr, ccsds_sec_hdr, tc_pus;
|
|
|
|
|
|
|
|
tmp_crc[0] = buf[size - 1];
|
|
|
|
tmp_crc[1] = ecss_tm_checksum(buf, size - 2);
|
|
|
|
|
|
|
|
ver = buf[0] >> 5;
|
|
|
|
|
|
|
|
pkt->type = (buf[0] >> 4) & 0x01;
|
|
|
|
dfield_hdr = (buf[0] >> 3) & 0x01;
|
|
|
|
|
|
|
|
cnv.cnv8[0] = buf[1];
|
|
|
|
cnv.cnv8[1] = 0x07 & buf[0];
|
|
|
|
pkt->app_id = cnv.cnv16[0];
|
|
|
|
|
|
|
|
pkt->seq_flags = buf[2] >> 6;
|
|
|
|
|
|
|
|
cnv.cnv8[0] = buf[3];
|
|
|
|
cnv.cnv8[1] = buf[2] & 0x3F;
|
|
|
|
pkt->seq_count = cnv.cnv16[0];
|
|
|
|
|
|
|
|
cnv.cnv8[0] = buf[4];
|
|
|
|
cnv.cnv8[1] = buf[5];
|
|
|
|
pkt->len = cnv.cnv16[0];
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
ccsds_sec_hdr = buf[6] >> 7;
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
tc_pus = buf[6] >> 4;
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
pkt->ack = 0x04 & buf[6];
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
pkt->ser_type = buf[7];
|
|
|
|
pkt->ser_subtype = buf[8];
|
|
|
|
pkt->dest_id = buf[9];
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
if (app_id_verification[pkt->app_id] != 1) {
|
|
|
|
return R_OBC_PKT_ILLEGAL_APPID;
|
|
|
|
}
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
if (pkt->len != size - 7) {
|
|
|
|
return R_OBC_PKT_INV_LEN;
|
|
|
|
}
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
if (tmp_crc[0] != tmp_crc[1]) {
|
|
|
|
return R_OBC_PKT_INC_CRC;
|
|
|
|
}
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
if (services_verification_TC_TM[pkt->ser_type][pkt->ser_subtype][pkt->type]
|
|
|
|
!= 1) {
|
|
|
|
return R_OBC_PKT_ILLEGAL_PKT_TP;
|
|
|
|
}
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
if (ver != 0) {
|
|
|
|
return R_OBC_ERROR;
|
|
|
|
}
|
2016-03-16 00:54:13 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
if (tc_pus != 1) {
|
|
|
|
return R_OBC_ERROR;
|
|
|
|
}
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
if (ccsds_sec_hdr != 0) {
|
|
|
|
return R_OBC_ERROR;
|
|
|
|
}
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
if (pkt->type != TC && pkt->type != TM) {
|
|
|
|
return R_OBC_ERROR;
|
|
|
|
}
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
if (dfield_hdr != 1) {
|
|
|
|
return R_OBC_ERROR;
|
|
|
|
}
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
if (pkt->ack != TC_ACK_NO || pkt->ack != TC_ACK_ACC
|
|
|
|
|| pkt->ack != TC_ACK_EXE_COMP) {
|
|
|
|
return R_OBC_ERROR;
|
|
|
|
}
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
for (int i = 0; i < pkt->len - 4; i++) {
|
|
|
|
pkt->data[i] = buf[10 + i];
|
|
|
|
}
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
return R_OBC_OK;
|
|
|
|
}
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
/**
|
|
|
|
* Packs a TC packet into a byte buffer
|
|
|
|
* @param buf buffer to store the data to be sent
|
|
|
|
* @param pkt the data to be stored in the buffer
|
|
|
|
* @param size size of the array
|
|
|
|
* @return appropriate error code or R_OBC_OK if all operation succeed
|
|
|
|
*/
|
|
|
|
static inline OBC_ret_state_t
|
|
|
|
ecss_tm_pack_pkt(uint8_t *buf, tc_tm_pkt *pkt, uint16_t *size)
|
|
|
|
{
|
|
|
|
|
|
|
|
union _cnv cnv;
|
|
|
|
uint8_t buf_pointer;
|
|
|
|
|
|
|
|
cnv.cnv16[0] = pkt->app_id;
|
|
|
|
|
|
|
|
buf[0] = (ECSS_VER_NUMBER << 5 | pkt->type << 4
|
|
|
|
| ECSS_DATA_FIELD_HDR_FLG << 3 | cnv.cnv8[1]);
|
|
|
|
buf[1] = cnv.cnv8[0];
|
|
|
|
|
|
|
|
cnv.cnv16[0] = pkt->seq_count;
|
|
|
|
buf[2] = (pkt->seq_flags << 6 | cnv.cnv8[1]);
|
|
|
|
buf[3] = cnv.cnv8[0];
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
/* TYPE = 0 TM, TYPE = 1 TC*/
|
|
|
|
if (pkt->type == TM) {
|
|
|
|
buf[6] = ECSS_PUS_VER << 4;
|
|
|
|
}
|
|
|
|
else if (pkt->type == TC) {
|
|
|
|
buf[6] = (ECSS_SEC_HDR_FIELD_FLG << 7 | ECSS_PUS_VER << 4 | pkt->ack);
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
return R_OBC_ERROR;
|
|
|
|
}
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
buf[7] = pkt->ser_type;
|
|
|
|
buf[8] = pkt->ser_subtype;
|
|
|
|
buf[9] = pkt->dest_id; /*source or destination*/
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
buf_pointer = 10;
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
if (pkt->ser_type == TC_VERIFICATION_SERVICE) {
|
|
|
|
//cnv.cnv16[0] = tc_pkt_id;
|
|
|
|
//cnv.cnv16[1] = tc_pkt_seq_ctrl;
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
/*verification_pack_pkt_api (buf, pkt, &buf_pointer);*/
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
}
|
|
|
|
else if (pkt->ser_type == TC_HOUSEKEEPING_SERVICE) {
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
/*hk_pack_pkt_api (buf, pkt, &buf_pointer);*/
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
}
|
|
|
|
else if (pkt->ser_type == TC_FUNCTION_MANAGEMENT_SERVICE
|
|
|
|
&& pkt->ser_subtype == 1) {
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
buf[10] = pkt->data[0];
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
buf[11] = pkt->data[1];
|
|
|
|
buf[12] = pkt->data[2];
|
|
|
|
buf[13] = pkt->data[3];
|
|
|
|
buf[14] = pkt->data[4];
|
|
|
|
|
|
|
|
buf_pointer += 5;
|
|
|
|
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
return R_OBC_ERROR;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*check if this is correct*/
|
|
|
|
cnv.cnv16[0] = buf_pointer - 6;
|
|
|
|
buf[4] = cnv.cnv8[0];
|
|
|
|
buf[5] = cnv.cnv8[1];
|
|
|
|
|
|
|
|
buf[buf_pointer] = ecss_tm_checksum(buf, buf_pointer - 1);
|
|
|
|
*size = buf_pointer;
|
|
|
|
return R_OBC_OK;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline OBC_ret_state_t
|
|
|
|
ecss_tm_crt_pkt(tc_tm_pkt *pkt, uint16_t app_id, uint8_t type, uint8_t ack,
|
|
|
|
uint8_t ser_type, uint8_t ser_subtype, uint16_t dest_id)
|
|
|
|
{
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
pkt->type = type;
|
|
|
|
pkt->app_id = app_id;
|
|
|
|
pkt->dest_id = dest_id;
|
2016-03-21 01:23:28 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
pkt->ser_type = ser_type;
|
|
|
|
pkt->ser_subtype = ser_subtype;
|
2016-03-16 00:54:13 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
return R_OBC_OK;
|
|
|
|
}
|
2016-03-16 00:54:13 +01:00
|
|
|
|
2019-09-12 15:25:10 +02:00
|
|
|
} // namespace satnogs
|
2016-03-16 00:54:13 +01:00
|
|
|
} // namespace gr
|
|
|
|
|
|
|
|
#endif /* INCLUDED_SATNOGS_TC_TM_H */
|
|
|
|
|