#ifndef MISSION_DEVICES_DEVICEDEFINITIONS_PLOCMPSOCDEFINITIONS_H_ #define MISSION_DEVICES_DEVICEDEFINITIONS_PLOCMPSOCDEFINITIONS_H_ #include "MPSoCReturnValuesIF.h" #include "OBSWConfig.h" #include "eive/definitions.h" #include "fsfw/globalfunctions/CRC.h" #include "fsfw/serialize/SerializeAdapter.h" #include "mission/devices/devicedefinitions/SpBase.h" namespace mpsoc { static const DeviceCommandId_t NONE = 0; static const DeviceCommandId_t TC_MEM_WRITE = 1; static const DeviceCommandId_t TC_MEM_READ = 2; static const DeviceCommandId_t ACK_REPORT = 3; static const DeviceCommandId_t EXE_REPORT = 5; static const DeviceCommandId_t TM_MEMORY_READ_REPORT = 6; static const DeviceCommandId_t TC_FLASHFOPEN = 7; static const DeviceCommandId_t TC_FLASHFCLOSE = 8; static const DeviceCommandId_t TC_FLASHWRITE = 9; static const DeviceCommandId_t TC_FLASHDELETE = 10; static const DeviceCommandId_t TC_REPLAY_START = 11; static const DeviceCommandId_t TC_REPLAY_STOP = 12; static const DeviceCommandId_t TC_REPLAY_WRITE_SEQUENCE = 13; static const DeviceCommandId_t TC_DOWNLINK_PWR_ON = 14; static const DeviceCommandId_t TC_DOWNLINK_PWR_OFF = 15; static const DeviceCommandId_t TC_MODE_REPLAY = 16; static const DeviceCommandId_t TC_CAM_CMD_SEND = 17; static const DeviceCommandId_t TC_MODE_IDLE = 18; static const DeviceCommandId_t TM_CAM_CMD_RPT = 19; static const DeviceCommandId_t SET_UART_TX_TRISTATE = 20; static const DeviceCommandId_t RELEASE_UART_TX = 21; // Will reset the sequence count of the OBSW static const DeviceCommandId_t OBSW_RESET_SEQ_COUNT = 50; static const uint16_t SIZE_ACK_REPORT = 14; static const uint16_t SIZE_EXE_REPORT = 14; static const uint16_t SIZE_TM_MEM_READ_REPORT = 18; static const uint16_t SIZE_TM_CAM_CMD_RPT = 18; /** * SpacePacket apids of PLOC telecommands and telemetry. */ namespace apid { static const uint16_t TC_REPLAY_START = 0x110; static const uint16_t TC_REPLAY_STOP = 0x111; static const uint16_t TC_REPLAY_WRITE_SEQUENCE = 0x112; static const uint16_t TC_DOWNLINK_PWR_ON = 0x113; static const uint16_t TC_MEM_WRITE = 0x114; static const uint16_t TC_MEM_READ = 0x115; static const uint16_t TC_FLASHWRITE = 0x117; static const uint16_t TC_FLASHFOPEN = 0x119; static const uint16_t TC_FLASHFCLOSE = 0x11A; static const uint16_t TC_FLASHDELETE = 0x11C; static const uint16_t TC_MODE_REPLAY = 0x11F; static const uint16_t TC_MODE_IDLE = 0x11E; static const uint16_t TC_DOWNLINK_PWR_OFF = 0x124; static const uint16_t TC_CAM_CMD_SEND = 0x12C; static const uint16_t TM_MEMORY_READ_REPORT = 0x404; static const uint16_t ACK_SUCCESS = 0x400; static const uint16_t ACK_FAILURE = 0x401; static const uint16_t EXE_SUCCESS = 0x402; static const uint16_t EXE_FAILURE = 0x403; static const uint16_t TM_CAM_CMD_RPT = 0x407; } // namespace apid /** Offset from first byte in space packet to first byte of data field */ static const uint8_t DATA_FIELD_OFFSET = 6; static const size_t MEM_READ_RPT_LEN_OFFSET = 10; static const char NULL_TERMINATOR = '\0'; static const uint8_t MIN_SPACE_PACKET_LENGTH = 7; static const uint8_t SPACE_PACKET_HEADER_SIZE = 6; static constexpr size_t CRC_SIZE = 2; /** * The size of payload data which will be forwarded to the requesting object. e.g. PUS Service * 8. */ static const uint8_t SIZE_MEM_READ_RPT_FIX = 6; static const size_t MAX_FILENAME_SIZE = 256; /** * PLOC space packet length for fixed size packets. This is the size of the whole packet data * field. For the length field in the space packet this size will be substracted by one. */ static const uint16_t LENGTH_TC_MEM_WRITE = 12; static const uint16_t LENGTH_TC_MEM_READ = 8; /** * TODO: Might be a good idea to document where this is coming from */ static constexpr size_t SP_MAX_SIZE = 1024; static const size_t MAX_REPLY_SIZE = SP_MAX_SIZE * 3; static const size_t MAX_COMMAND_SIZE = SP_MAX_SIZE; static const size_t MAX_DATA_SIZE = 1016; /** * The replay write sequence command has a maximum delay for the execution report which amounts to * 30 seconds. (80 cycles * 0.5 seconds = 40 seconds). */ static const uint16_t TC_WRITE_SEQ_EXECUTION_DELAY = 80; // Requires approx. 2 seconds for execution. 8 => 4 seconds static const uint16_t TC_DOWNLINK_PWR_ON_EXECUTION_DELAY = 8; namespace status_code { static const uint16_t UNKNOWN_APID = 0x5DD; static const uint16_t INCORRECT_LENGTH = 0x5DE; static const uint16_t INCORRECT_CRC = 0x5DF; static const uint16_t INCORRECT_PKT_SEQ_CNT = 0x5E0; static const uint16_t TC_NOT_ALLOWED_IN_MODE = 0x5E1; static const uint16_t TC_EXEUTION_DISABLED = 0x5E2; static const uint16_t FLASH_MOUNT_FAILED = 0x5E3; static const uint16_t FLASH_FILE_ALREADY_CLOSED = 0x5E4; static const uint16_t FLASH_FILE_OPEN_FAILED = 0x5E5; static const uint16_t FLASH_FILE_ALREDY_OPEN = 0x5E6; static const uint16_t FLASH_FILE_NOT_OPEN = 0x5E7; static const uint16_t FLASH_UNMOUNT_FAILED = 0x5E8; static const uint16_t HEAP_ALLOCATION_FAILED = 0x5E9; static const uint16_t INVALID_PARAMETER = 0x5EA; static const uint16_t NOT_INITIALIZED = 0x5EB; static const uint16_t REBOOT_IMMINENT = 0x5EC; static const uint16_t CORRUPT_DATA = 0x5ED; static const uint16_t FLASH_CORRECTABLE_MISMATCH = 0x5EE; static const uint16_t FLASH_UNCORRECTABLE_MISMATCH = 0x5EF; static const uint16_t RESERVED_0 = 0x5F0; static const uint16_t RESERVED_1 = 0x5F1; static const uint16_t RESERVED_2 = 0x5F2; static const uint16_t RESERVED_3 = 0x5F3; static const uint16_t RESERVED_4 = 0x5F4; } // namespace status_code /** * @brief Abstract base class for TC space packet of MPSoC. */ class TcBase : public ploc::SpTcBase, public MPSoCReturnValuesIF { public: virtual ~TcBase() = default; // Initial length field of space packet. Will always be updated when packet is created. static const uint16_t INIT_LENGTH = 1; /** * @brief Constructor * * @param sequenceCount Sequence count of space packet which will be incremented with each * sent and received packets. */ TcBase(ploc::SpTcParams params, uint16_t apid, uint16_t sequenceCount) : ploc::SpTcBase(params, apid, sequenceCount) { spParams.setDataFieldLen(INIT_LENGTH); } ReturnValue_t buildPacket() { return buildPacket(nullptr, 0); } /** * @brief Function to initialize the space packet * * @param commandData Pointer to command specific data * @param commandDataLen Length of command data * * @return RETURN_OK if packet creation was successful, otherwise error return value */ ReturnValue_t buildPacket(const uint8_t* commandData, size_t commandDataLen) { payloadStart = spParams.buf + ccsds::HEADER_LEN; ReturnValue_t res; if (commandData != nullptr and commandDataLen > 0) { res = initPacket(commandData, commandDataLen); if (res != result::OK) { return res; } } updateSpFields(); res = checkSizeAndSerializeHeader(); if (res != result::OK) { return res; } return calcCrc(); } protected: /** * @brief Must be overwritten by the child class to define the command specific parameters * * @param commandData Pointer to received command data * @param commandDataLen Length of received command data */ virtual ReturnValue_t initPacket(const uint8_t* commandData, size_t commandDataLen) { return HasReturnvaluesIF::RETURN_OK; } }; /** * @brief This class helps to build the memory read command for the PLOC. */ class TcMemRead : public TcBase { public: /** * @brief Constructor */ TcMemRead(ploc::SpTcParams params, uint16_t sequenceCount) : TcBase(params, apid::TC_MEM_READ, sequenceCount) { spParams.setPayloadLen(COMMAND_LENGTH); } uint16_t getMemLen() const { return memLen; } protected: ReturnValue_t initPacket(const uint8_t* commandData, size_t commandDataLen) override { ReturnValue_t result = HasReturnvaluesIF::RETURN_OK; result = lengthCheck(commandDataLen); if (result != HasReturnvaluesIF::RETURN_OK) { return result; } std::memcpy(payloadStart, commandData, MEM_ADDRESS_SIZE); std::memcpy(payloadStart + MEM_ADDRESS_SIZE, commandData + MEM_ADDRESS_SIZE, MEM_LEN_SIZE); size_t size = sizeof(memLen); const uint8_t* memLenPtr = commandData + MEM_ADDRESS_SIZE; result = SerializeAdapter::deSerialize(&memLen, &memLenPtr, &size, SerializeIF::Endianness::BIG); if (result != HasReturnvaluesIF::RETURN_OK) { return result; } spParams.setPayloadLen(MEM_ADDRESS_SIZE + MEM_LEN_SIZE); return result; } private: static const size_t COMMAND_LENGTH = 6; static const size_t MEM_ADDRESS_SIZE = 4; static const size_t MEM_LEN_SIZE = 2; static const uint16_t PACKET_LENGTH = 7; uint16_t memLen = 0; ReturnValue_t lengthCheck(size_t commandDataLen) { if (commandDataLen != COMMAND_LENGTH) { return INVALID_LENGTH; } return HasReturnvaluesIF::RETURN_OK; } }; /** * @brief This class helps to generate the space packet to write data to a memory address within * the PLOC. */ class TcMemWrite : public TcBase { public: /** * @brief Constructor */ TcMemWrite(ploc::SpTcParams params, uint16_t sequenceCount) : TcBase(params, apid::TC_MEM_WRITE, sequenceCount) {} protected: // TODO: Confusing, recheck.. ReturnValue_t initPacket(const uint8_t* commandData, size_t commandDataLen) override { ReturnValue_t result = HasReturnvaluesIF::RETURN_OK; result = lengthCheck(commandDataLen); if (result != HasReturnvaluesIF::RETURN_OK) { return result; } std::memcpy(payloadStart, commandData, commandDataLen); uint16_t memLen = *(commandData + MEM_ADDRESS_SIZE) << 8 | *(commandData + MEM_ADDRESS_SIZE + 1); spParams.setPayloadLen(FIX_LENGTH + memLen * 4); return result; } private: // Min length consists of 4 byte address, 2 byte mem length field, 4 byte data (1 word) static const size_t MIN_COMMAND_DATA_LENGTH = 10; static const size_t MEM_ADDRESS_SIZE = 4; static const size_t FIX_LENGTH = 8; ReturnValue_t lengthCheck(size_t commandDataLen) { if (commandDataLen < MIN_COMMAND_DATA_LENGTH) { sif::warning << "TcMemWrite: Command has invalid length " << commandDataLen << std::endl; return INVALID_LENGTH; } return HasReturnvaluesIF::RETURN_OK; } }; /** * @brief Class to help creation of flash fopen command. */ class FlashFopen : public ploc::SpTcBase { public: FlashFopen(ploc::SpTcParams params, uint16_t sequenceCount) : ploc::SpTcBase(params, apid::TC_FLASHFOPEN, sequenceCount) {} static const char APPEND = 'a'; static const char WRITE = 'w'; static const char READ = 'r'; ReturnValue_t createPacket(std::string filename, char accessMode_) { accessMode = accessMode_; size_t nameSize = filename.size(); std::memcpy(payloadStart, filename.c_str(), nameSize); *(spParams.buf + nameSize) = NULL_TERMINATOR; std::memcpy(payloadStart + nameSize + sizeof(NULL_TERMINATOR), &accessMode, sizeof(accessMode)); spParams.setPayloadLen(nameSize + sizeof(NULL_TERMINATOR) + sizeof(accessMode)); updateSpFields(); return calcCrc(); } private: char accessMode = APPEND; }; /** * @brief Class to help creation of flash fclose command. */ class FlashFclose : public TcBase { public: FlashFclose(ploc::SpTcParams params, uint16_t sequenceCount) : TcBase(params, apid::TC_FLASHFCLOSE, sequenceCount) {} ReturnValue_t createPacket(std::string filename) { size_t nameSize = filename.size(); std::memcpy(payloadStart, filename.c_str(), nameSize); *(payloadStart + nameSize) = NULL_TERMINATOR; spParams.setPayloadLen(nameSize + sizeof(NULL_TERMINATOR)); return calcCrc(); } }; /** * @brief Class to build flash write space packet. */ class TcFlashWrite : public ploc::SpTcBase { public: TcFlashWrite(ploc::SpTcParams params, uint16_t sequenceCount) : ploc::SpTcBase(params, apid::TC_FLASHWRITE, sequenceCount) {} ReturnValue_t buildPacket(const uint8_t* writeData, uint32_t writeLen_) { ReturnValue_t result = HasReturnvaluesIF::RETURN_OK; writeLen = writeLen_; if (writeLen > MAX_DATA_SIZE) { sif::debug << "FlashWrite::createPacket: Command data too big" << std::endl; return HasReturnvaluesIF::RETURN_FAILED; } size_t serializedSize = 0; result = SerializeAdapter::serialize(&writeLen, payloadStart, &serializedSize, sizeof(writeLen), SerializeIF::Endianness::BIG); if (result != HasReturnvaluesIF::RETURN_OK) { return result; } std::memcpy(payloadStart + sizeof(writeLen), writeData, writeLen); spParams.setPayloadLen(static_cast(writeLen) + 4); updateSpFields(); auto res = checkSizeAndSerializeHeader(); if (res != result::OK) { return res; } return calcCrc(); } private: uint32_t writeLen = 0; }; /** * @brief Class to help creation of flash delete command. */ class TcFlashDelete : public ploc::SpTcBase { public: TcFlashDelete(ploc::SpTcParams params, uint16_t sequenceCount) : ploc::SpTcBase(params, apid::TC_FLASHDELETE, sequenceCount) {} ReturnValue_t buildPacket(std::string filename) { size_t nameSize = filename.size(); std::memcpy(payloadStart, filename.c_str(), nameSize); *(payloadStart + nameSize) = NULL_TERMINATOR; spParams.setPayloadLen(nameSize + sizeof(NULL_TERMINATOR)); updateSpFields(); auto res = checkSizeAndSerializeHeader(); if (res != result::OK) { return res; } return calcCrc(); } }; /** * @brief Class to build replay stop space packet. */ class TcReplayStop : public TcBase { public: TcReplayStop(ploc::SpTcParams params, uint16_t sequenceCount) : TcBase(params, apid::TC_REPLAY_STOP, sequenceCount) {} }; /** * @brief This class helps to build the replay start command. */ class TcReplayStart : public TcBase { public: /** * @brief Constructor */ TcReplayStart(ploc::SpTcParams params, uint16_t sequenceCount) : TcBase(params, apid::TC_REPLAY_START, sequenceCount) {} protected: ReturnValue_t initPacket(const uint8_t* commandData, size_t commandDataLen) override { ReturnValue_t result = HasReturnvaluesIF::RETURN_OK; result = lengthCheck(commandDataLen); if (result != HasReturnvaluesIF::RETURN_OK) { return result; } result = checkData(*commandData); if (result != HasReturnvaluesIF::RETURN_OK) { return result; } std::memcpy(payloadStart, commandData, commandDataLen); spParams.setPayloadLen(commandDataLen); return result; } private: static const size_t COMMAND_DATA_LENGTH = 1; static const uint8_t REPEATING = 0; static const uint8_t ONCE = 1; ReturnValue_t lengthCheck(size_t commandDataLen) { if (commandDataLen != COMMAND_DATA_LENGTH) { sif::warning << "TcReplayStart: Command has invalid length " << commandDataLen << std::endl; return INVALID_LENGTH; } return HasReturnvaluesIF::RETURN_OK; } ReturnValue_t checkData(uint8_t replay) { if (replay != REPEATING && replay != ONCE) { sif::warning << "TcReplayStart::checkData: Invalid replay value" << std::endl; return INVALID_PARAMETER; } return HasReturnvaluesIF::RETURN_OK; } }; /** * @brief This class helps to build downlink power on command. */ class TcDownlinkPwrOn : public TcBase { public: /** * @brief Constructor */ TcDownlinkPwrOn(ploc::SpTcParams params, uint16_t sequenceCount) : TcBase(params, apid::TC_DOWNLINK_PWR_ON, sequenceCount) {} protected: ReturnValue_t initPacket(const uint8_t* commandData, size_t commandDataLen) override { ReturnValue_t result = HasReturnvaluesIF::RETURN_OK; result = lengthCheck(commandDataLen); if (result != HasReturnvaluesIF::RETURN_OK) { return result; } result = modeCheck(*commandData); if (result != HasReturnvaluesIF::RETURN_OK) { return result; } result = laneRateCheck(*(commandData + 1)); if (result != HasReturnvaluesIF::RETURN_OK) { return result; } std::memcpy(payloadStart, commandData, commandDataLen); std::memcpy(payloadStart + commandDataLen, &MAX_AMPLITUDE, sizeof(MAX_AMPLITUDE)); spParams.setPayloadLen(commandDataLen + sizeof(MAX_AMPLITUDE)); return result; } private: static const uint8_t INTERFACE_ID = CLASS_ID::DWLPWRON_CMD; //! [EXPORT] : [COMMENT] Received command has invalid JESD mode (valid modes are 0 - 5) static const ReturnValue_t INVALID_MODE = MAKE_RETURN_CODE(0xE0); //! [EXPORT] : [COMMENT] Received command has invalid lane rate (valid lane rate are 0 - 9) static const ReturnValue_t INVALID_LANE_RATE = MAKE_RETURN_CODE(0xE1); static const size_t COMMAND_DATA_LENGTH = 2; static const uint8_t MAX_MODE = 5; static const uint8_t MAX_LANE_RATE = 9; static const uint16_t MAX_AMPLITUDE = 0; ReturnValue_t lengthCheck(size_t commandDataLen) { if (commandDataLen != COMMAND_DATA_LENGTH) { sif::warning << "TcDownlinkPwrOn: Command has invalid length " << commandDataLen << std::endl; return INVALID_LENGTH; } return HasReturnvaluesIF::RETURN_OK; } ReturnValue_t modeCheck(uint8_t mode) { if (mode > MAX_MODE) { sif::warning << "TcDwonlinkPwrOn::modeCheck: Invalid JESD mode" << std::endl; return INVALID_MODE; } return HasReturnvaluesIF::RETURN_OK; } ReturnValue_t laneRateCheck(uint8_t laneRate) { if (laneRate > MAX_LANE_RATE) { sif::warning << "TcReplayStart::laneRateCheck: Invalid lane rate" << std::endl; return INVALID_LANE_RATE; } return HasReturnvaluesIF::RETURN_OK; } }; /** * @brief Class to build replay stop space packet. */ class TcDownlinkPwrOff : public TcBase { public: TcDownlinkPwrOff(ploc::SpTcParams params, uint16_t sequenceCount) : TcBase(params, apid::TC_DOWNLINK_PWR_OFF, sequenceCount) {} }; /** * @brief This class helps to build the replay start command. */ class TcReplayWriteSeq : public TcBase { public: /** * @brief Constructor */ TcReplayWriteSeq(ploc::SpTcParams params, uint16_t sequenceCount) : TcBase(params, apid::TC_REPLAY_WRITE_SEQUENCE, sequenceCount) {} protected: ReturnValue_t initPacket(const uint8_t* commandData, size_t commandDataLen) override { ReturnValue_t result = HasReturnvaluesIF::RETURN_OK; result = lengthCheck(commandDataLen); if (result != HasReturnvaluesIF::RETURN_OK) { return result; } std::memcpy(payloadStart, commandData, commandDataLen); *(payloadStart + commandDataLen) = NULL_TERMINATOR; spParams.setPayloadLen(commandDataLen + sizeof(NULL_TERMINATOR)); return result; } private: static const size_t USE_DECODING_LENGTH = 1; ReturnValue_t lengthCheck(size_t commandDataLen) { if (commandDataLen > USE_DECODING_LENGTH + MAX_FILENAME_SIZE) { sif::warning << "TcReplayWriteSeq: Command has invalid length " << commandDataLen << std::endl; return INVALID_LENGTH; } return HasReturnvaluesIF::RETURN_OK; } }; /** * @brief Helps to extract the fields of the flash write command from the PUS packet. */ class FlashWritePusCmd : public MPSoCReturnValuesIF { public: FlashWritePusCmd(){}; ReturnValue_t extractFields(const uint8_t* commandData, size_t commandDataLen) { if (commandDataLen > (config::MAX_PATH_SIZE + config::MAX_FILENAME_SIZE + MAX_FILENAME_SIZE)) { return INVALID_LENGTH; } obcFile = std::string(reinterpret_cast(commandData)); if (obcFile.size() > (config::MAX_PATH_SIZE + config::MAX_FILENAME_SIZE)) { return FILENAME_TOO_LONG; } mpsocFile = std::string( reinterpret_cast(commandData + obcFile.size() + SIZE_NULL_TERMINATOR)); if (mpsocFile.size() > MAX_FILENAME_SIZE) { return MPSOC_FILENAME_TOO_LONG; } return HasReturnvaluesIF::RETURN_OK; } std::string getObcFile() { return obcFile; } std::string getMPSoCFile() { return mpsocFile; } private: static const size_t SIZE_NULL_TERMINATOR = 1; std::string obcFile = ""; std::string mpsocFile = ""; }; /** * @brief Class to build replay stop space packet. */ class TcModeReplay : public TcBase { public: TcModeReplay(ploc::SpTcParams params, uint16_t sequenceCount) : TcBase(params, apid::TC_MODE_REPLAY, sequenceCount) {} }; /** * @brief Class to build mode idle command */ class TcModeIdle : public TcBase { public: TcModeIdle(ploc::SpTcParams params, uint16_t sequenceCount) : TcBase(params, apid::TC_MODE_IDLE, sequenceCount) {} }; class TcCamcmdSend : public TcBase { public: TcCamcmdSend(ploc::SpTcParams params, uint16_t sequenceCount) : TcBase(params, apid::TC_CAM_CMD_SEND, sequenceCount) {} protected: ReturnValue_t initPacket(const uint8_t* commandData, size_t commandDataLen) override { if (commandDataLen > MAX_DATA_LENGTH) { return INVALID_LENGTH; } uint16_t dataLen = static_cast(commandDataLen + sizeof(CARRIAGE_RETURN)); size_t size = sizeof(dataLen); SerializeAdapter::serialize(&dataLen, payloadStart, &size, sizeof(dataLen), SerializeIF::Endianness::BIG); std::memcpy(payloadStart + sizeof(dataLen), commandData, commandDataLen); *(payloadStart + sizeof(dataLen) + commandDataLen) = CARRIAGE_RETURN; spParams.setPayloadLen(sizeof(dataLen) + commandDataLen + sizeof(CARRIAGE_RETURN)); return HasReturnvaluesIF::RETURN_OK; } private: static const uint8_t MAX_DATA_LENGTH = 10; static const uint8_t CARRIAGE_RETURN = 0xD; }; } // namespace mpsoc #endif /* MISSION_DEVICES_DEVICEDEFINITIONS_PLOCMPSOCDEFINITIONS_H_ */