#include "GomspaceDeviceHandler.h" #include #include #include #include #include "devicedefinitions/GomSpacePackets.h" #include "devicedefinitions/powerDefinitions.h" using namespace GOMSPACE; GomspaceDeviceHandler::GomspaceDeviceHandler(object_id_t objectId, object_id_t comIF, CookieIF* comCookie, TableConfig& tableConfig, FailureIsolationBase* customFdir) : DeviceHandlerBase(objectId, comIF, comCookie, customFdir), tableCfg(tableConfig) { if (comCookie == nullptr) { sif::error << "GomspaceDeviceHandler::GomspaceDeviceHandler: Invalid com cookie" << std::endl; } } void GomspaceDeviceHandler::initPduConfigTable() { tableCfg.maxConfigTableAddress = PDU::MAX_CONFIGTABLE_ADDRESS; tableCfg.maxHkTableAddress = PDU::MAX_HKTABLE_ADDRESS; tableCfg.hkTableSize = PDU::HK_TABLE_SIZE; tableCfg.cfgTableSize = PDU::CONFIG_TABLE_SIZE; } GomspaceDeviceHandler::~GomspaceDeviceHandler() {} void GomspaceDeviceHandler::doStartUp() {} void GomspaceDeviceHandler::doShutDown() {} ReturnValue_t GomspaceDeviceHandler::buildNormalDeviceCommand(DeviceCommandId_t* id) { return returnvalue::OK; } ReturnValue_t GomspaceDeviceHandler::buildTransitionDeviceCommand(DeviceCommandId_t* id) { return returnvalue::OK; } ReturnValue_t GomspaceDeviceHandler::buildCommandFromCommand(DeviceCommandId_t deviceCommand, const uint8_t* commandData, size_t commandDataLen) { ReturnValue_t result = childCommandHook(deviceCommand, commandData, commandDataLen); switch (deviceCommand) { case (GOMSPACE::PING): { result = generatePingCommand(commandData, commandDataLen); if (result != returnvalue::OK) { return result; } break; } case (GOMSPACE::REBOOT): { generateRebootCommand(); break; } case (GOMSPACE::PARAM_SET): { result = generateSetParamCommand(commandData, commandDataLen); if (result != returnvalue::OK) { return result; } break; } case (GOMSPACE::PARAM_GET): { result = generateGetParamCommand(commandData, commandDataLen); if (result != returnvalue::OK) { return result; } break; } case (GOMSPACE::GNDWDT_RESET): { result = generateResetWatchdogCmd(); if (result != returnvalue::OK) { return result; } break; } case (GOMSPACE::PRINT_SWITCH_V_I): case (GOMSPACE::PRINT_LATCHUPS): { result = printStatus(deviceCommand); break; } case (GOMSPACE::REQUEST_HK_TABLE): { auto reqType = SpecialRequestTypes::DEFAULT_COM_IF; if (getObjectId() == objects::PDU1_HANDLER or getObjectId() == objects::PDU2_HANDLER) { reqType = SpecialRequestTypes::GET_PDU_HK; } else if (getObjectId() == objects::ACU_HANDLER) { reqType = SpecialRequestTypes::GET_ACU_HK; } else if (getObjectId() == objects::P60DOCK_HANDLER) { reqType = SpecialRequestTypes::GET_P60DOCK_HK; } result = generateRequestFullTableCmd(reqType, GOMSPACE::TableIds::HK, tableCfg.hkTableSize, deviceCommand); if (result != returnvalue::OK) { return result; } break; } case (GOMSPACE::REQUEST_CONFIG_TABLE): { auto reqType = SpecialRequestTypes::DEFAULT_COM_IF; if (getObjectId() == objects::PDU1_HANDLER or getObjectId() == objects::PDU2_HANDLER) { reqType = SpecialRequestTypes::GET_PDU_CONFIG; } else if (getObjectId() == objects::ACU_HANDLER) { reqType = SpecialRequestTypes::GET_ACU_CONFIG; } else if (getObjectId() == objects::P60DOCK_HANDLER) { reqType = SpecialRequestTypes::GET_P60DOCK_CONFIG; } result = generateRequestFullTableCmd(reqType, GOMSPACE::TableIds::CONFIG, tableCfg.cfgTableSize, deviceCommand); if (result != returnvalue::OK) { return result; } break; } default: return DeviceHandlerIF::COMMAND_NOT_IMPLEMENTED; } return returnvalue::OK; } void GomspaceDeviceHandler::fillCommandAndReplyMap() { this->insertInCommandAndReplyMap(GOMSPACE::PING, 3); this->insertInCommandMap(GOMSPACE::REBOOT); this->insertInCommandAndReplyMap(GOMSPACE::PARAM_SET, 3); this->insertInCommandAndReplyMap(GOMSPACE::PARAM_GET, 3); this->insertInCommandAndReplyMap(GOMSPACE::REQUEST_HK_TABLE, 3); this->insertInCommandAndReplyMap(GOMSPACE::REQUEST_CONFIG_TABLE, 3); this->insertInCommandMap(GOMSPACE::GNDWDT_RESET); this->insertInCommandMap(GOMSPACE::PRINT_SWITCH_V_I); this->insertInCommandMap(GOMSPACE::PRINT_LATCHUPS); } ReturnValue_t GomspaceDeviceHandler::scanForReply(const uint8_t* start, size_t remainingSize, DeviceCommandId_t* foundId, size_t* foundLen) { switch (rememberCommandId) { case (GOMSPACE::PING): *foundId = GOMSPACE::PING; *foundLen = PING_REPLY_SIZE; rememberCommandId = GOMSPACE::NONE; break; case (GOMSPACE::PARAM_GET): { *foundId = GOMSPACE::PARAM_GET; *foundLen = rememberRequestedSize + GOMSPACE::GS_HDR_LENGTH; rememberCommandId = GOMSPACE::NONE; break; } case (GOMSPACE::PARAM_SET): { *foundId = GOMSPACE::PARAM_SET; *foundLen = rememberRequestedSize; rememberCommandId = GOMSPACE::NONE; break; } case (GOMSPACE::REQUEST_HK_TABLE): case (GOMSPACE::REQUEST_CONFIG_TABLE): { if (remainingSize < rememberRequestedSize) { sif::error << "GomspaceDeviceHandler::scanForReply: Table reply, received data smaller " "than expected " << rememberRequestedSize << std::endl; return returnvalue::FAILED; } *foundId = rememberCommandId; *foundLen = rememberRequestedSize; rememberCommandId = GOMSPACE::NONE; break; } default: return IGNORE_REPLY_DATA; } return returnvalue::OK; } ReturnValue_t GomspaceDeviceHandler::interpretDeviceReply(DeviceCommandId_t id, const uint8_t* packet) { switch (id) { case (GOMSPACE::PING): { SerializeElement replyTime = *packet; handleDeviceTM(&replyTime, id, true); break; } case (GOMSPACE::PARAM_GET): { // -2 to subtract address size from gomspace parameter reply packet uint16_t payloadLength = (*(packet + 2) << 8 | *(packet + 3)) - 2; if (payloadLength > sizeof(uint32_t)) { sif::error << "GomspaceDeviceHandler: PARAM_GET: Invalid payload " << "size in reply" << std::endl; return INVALID_PAYLOAD_SIZE; } uint8_t tempPayloadBuffer[payloadLength]; /* Extract information from received data */ CspGetParamReply cspGetParamReply(tempPayloadBuffer, payloadLength); size_t size = GOMSPACE::GS_HDR_LENGTH + payloadLength; ReturnValue_t result = cspGetParamReply.deSerialize(&packet, &size, SerializeIF::Endianness::BIG); if (result != returnvalue::OK) { sif::error << "GomspaceDeviceHandler: Failed to deserialize get parameter" << "reply" << std::endl; return result; } uint8_t action = cspGetParamReply.getAction(); uint8_t tableId = cspGetParamReply.getTableId(); uint16_t address = cspGetParamReply.getAddress(); /* Pack relevant information into a tm packet */ ParamReply paramReply(action, tableId, address, payloadLength, tempPayloadBuffer); handleDeviceTM(¶mReply, id, true); break; } case (GOMSPACE::PARAM_SET): { /* When setting a parameter, the p60dock sends back the state of the * operation */ if (*packet != PARAM_SET_OK) { return returnvalue::FAILED; } setParamCallback(setParamCacher, true); break; } case (GOMSPACE::REQUEST_HK_TABLE): { letChildHandleHkReply(id, packet); break; } case (GOMSPACE::REQUEST_CONFIG_TABLE): { letChildHandleConfigReply(id, packet); break; } default: break; } return returnvalue::OK; } void GomspaceDeviceHandler::setNormalDatapoolEntriesInvalid() {} ReturnValue_t GomspaceDeviceHandler::generateSetParamCommand(const uint8_t* commandData, size_t commandDataLen) { ReturnValue_t result = setParamCacher.deSerialize(&commandData, &commandDataLen, SerializeIF::Endianness::BIG); // This breaks layering but I really don't want to accept this command.. if (setParamCacher.getAddress() == PDU2::CONFIG_ADDRESS_OUT_EN_Q7S and this->getObjectId() == objects::PDU2_HANDLER) { triggerEvent(power::SWITCHING_Q7S_DENIED, 0, 0); return returnvalue::FAILED; } if (result != returnvalue::OK) { sif::error << "GomspaceDeviceHandler: Failed to deserialize set parameter " "message" << std::endl; return result; } result = setParamCallback(setParamCacher, false); if (result != returnvalue::OK) { return result; } /* Get and check address */ uint16_t address = setParamCacher.getAddress(); if (address > tableCfg.maxConfigTableAddress) { sif::error << "GomspaceDeviceHandler: Invalid address for set parameter " << "action" << std::endl; return INVALID_ADDRESS; } /* CSP reply only contains the transaction state */ uint16_t querySize = 1; const uint8_t* parameterPtr = setParamCacher.getParameter(); uint8_t parameterSize = setParamCacher.getParameterSize(); uint16_t payloadlength = sizeof(address) + parameterSize; /* Generate command for CspComIF */ CspSetParamCommand setParamCmd(querySize, payloadlength, address, parameterPtr, parameterSize); size_t cspPacketLen = 0; uint8_t* buffer = cspPacket; result = setParamCmd.serialize(&buffer, &cspPacketLen, sizeof(cspPacket), SerializeIF::Endianness::BIG); if (result != returnvalue::OK) { sif::error << "GomspaceDeviceHandler: Failed to serialize command for " << "CspComIF" << std::endl; return result; } if (cspPacketLen > MAX_PACKET_LEN) { sif::error << "GomspaceDeviceHandler: Invalid length of set parameter " "command" << std::endl; return PACKET_TOO_LONG; } rawPacket = cspPacket; rawPacketLen = cspPacketLen; rememberRequestedSize = querySize; rememberCommandId = GOMSPACE::PARAM_SET; return returnvalue::OK; } ReturnValue_t GomspaceDeviceHandler::generateGetParamCommand(const uint8_t* commandData, size_t commandDataLen) { ReturnValue_t result; /* Unpack the received action message */ GetParamMessageUnpacker getParamMessage; result = getParamMessage.deSerialize(&commandData, &commandDataLen, SerializeIF::Endianness::BIG); if (result != returnvalue::OK) { sif::error << "Failed to deserialize message to extract information " "from get parameter message" << std::endl; return result; } /* Get an check table id to read from */ uint8_t tableId = getParamMessage.getTableId(); if (not validTableId(tableId)) { sif::error << "GomspaceDeviceHandler: Invalid table id in get parameter" " message" << std::endl; return INVALID_TABLE_ID; } /* Get and check address */ uint16_t address = getParamMessage.getAddress(); if (address > tableCfg.maxHkTableAddress and tableId == TableIds::HK) { sif::error << "GomspaceDeviceHandler: Invalid address to get parameter from " << "housekeeping table" << std::endl; return INVALID_ADDRESS; } if (address > tableCfg.maxConfigTableAddress and tableId == TableIds::CONFIG) { sif::error << "GomspaceDeviceHandler: Invalid address to get parameter from " << "configuration table" << std::endl; return INVALID_ADDRESS; } uint16_t length = sizeof(address); uint8_t parameterSize = getParamMessage.getParameterSize(); if (parameterSize > sizeof(uint32_t)) { sif::error << "GomspaceDeviceHandler: GET_PARAM: Invalid parameter " << "size" << std::endl; return INVALID_PARAM_SIZE; } uint16_t querySize = parameterSize + GOMSPACE::GS_HDR_LENGTH; /* Generate the CSP command to send to the P60 Dock */ CspGetParamCommand getParamCmd(querySize, tableId, length, address); size_t cspPacketLen = 0; uint8_t* buffer = cspPacket; result = getParamCmd.serialize(&buffer, &cspPacketLen, sizeof(cspPacket), SerializeIF::Endianness::BIG); if (result != returnvalue::OK) { sif::error << "GomspaceDeviceHandler: Failed to serialize command to " << "get parameter" << std::endl; } if (cspPacketLen > MAX_PACKET_LEN) { sif::error << "GomspaceDeviceHandler: Received invalid get parameter " "command" << std::endl; return PACKET_TOO_LONG; } rawPacket = cspPacket; rawPacketLen = cspPacketLen; rememberRequestedSize = querySize; rememberCommandId = GOMSPACE::PARAM_GET; return returnvalue::OK; } ReturnValue_t GomspaceDeviceHandler::generatePingCommand(const uint8_t* commandData, size_t commandDataLen) { CspPingCommand cspPingCommand(commandData, commandDataLen); size_t cspPacketLen = 0; uint8_t* buffer = cspPacket; ReturnValue_t result = cspPingCommand.serialize(&buffer, &cspPacketLen, sizeof(cspPacket), SerializeIF::Endianness::BIG); if (result != returnvalue::OK) { sif::error << "GomspaceDeviceHandler: Failed to serialize ping command" << std::endl; return result; } if (cspPacketLen > MAX_PACKET_LEN) { sif::error << "GomspaceDeviceHandler: Received invalid ping message" << std::endl; return PACKET_TOO_LONG; } rawPacket = cspPacket; rawPacketLen = cspPacketLen; rememberCommandId = GOMSPACE::PING; return returnvalue::OK; } void GomspaceDeviceHandler::generateRebootCommand() { uint8_t cspPort = GOMSPACE::REBOOT_PORT; uint16_t querySize = 0; *cspPacket = GOMSPACE::REBOOT_PORT; *(cspPacket + 1) = querySize; size_t cspPacketLen = sizeof(cspPort) + sizeof(cspPacketLen); rawPacket = cspPacket; rawPacketLen = cspPacketLen; } ReturnValue_t GomspaceDeviceHandler::childCommandHook(DeviceCommandId_t cmd, const uint8_t* commandData, size_t commandDataLen) { return DeviceHandlerIF::COMMAND_NOT_IMPLEMENTED; } ReturnValue_t GomspaceDeviceHandler::setParamCallback(SetParamMessageUnpacker& unpacker, bool afterExecution) { return returnvalue::OK; } ReturnValue_t GomspaceDeviceHandler::initializePduPool( localpool::DataPool& localDataPoolMap, LocalDataPoolManager& poolManager, std::array initOutEnb) { using namespace PDU; localDataPoolMap.emplace(pool::PDU_CURRENTS, new PoolEntry(9)); localDataPoolMap.emplace(pool::PDU_VOLTAGES, new PoolEntry(9)); localDataPoolMap.emplace(pool::PDU_VCC, new PoolEntry({0})); localDataPoolMap.emplace(pool::PDU_VBAT, new PoolEntry({0})); localDataPoolMap.emplace(pool::PDU_TEMPERATURE, new PoolEntry({0})); localDataPoolMap.emplace(pool::PDU_CONV_EN, new PoolEntry(3)); localDataPoolMap.emplace(pool::PDU_OUT_ENABLE, new PoolEntry(initOutEnb.data(), initOutEnb.size())); localDataPoolMap.emplace(pool::PDU_BOOTCAUSE, new PoolEntry({0})); localDataPoolMap.emplace(pool::PDU_BOOTCNT, new PoolEntry({0})); localDataPoolMap.emplace(pool::PDU_UPTIME, new PoolEntry({0})); localDataPoolMap.emplace(pool::PDU_RESETCAUSE, new PoolEntry({0})); localDataPoolMap.emplace(pool::PDU_BATT_MODE, new PoolEntry({0})); localDataPoolMap.emplace(pool::PDU_LATCHUPS, new PoolEntry(9)); localDataPoolMap.emplace(pool::PDU_DEVICES, new PoolEntry(8)); localDataPoolMap.emplace(pool::PDU_STATUSES, new PoolEntry(8)); localDataPoolMap.emplace(pool::PDU_WDT_CNT_GND, new PoolEntry({0})); localDataPoolMap.emplace(pool::PDU_WDT_CNT_I2C, new PoolEntry({0})); localDataPoolMap.emplace(pool::PDU_WDT_CNT_CAN, new PoolEntry({0})); localDataPoolMap.emplace(pool::PDU_WDT_CNT_CSP1, new PoolEntry({0})); localDataPoolMap.emplace(pool::PDU_WDT_CNT_CSP2, new PoolEntry({0})); localDataPoolMap.emplace(pool::PDU_WDT_GND_LEFT, new PoolEntry({0})); localDataPoolMap.emplace(pool::PDU_WDT_I2C_LEFT, new PoolEntry({0})); localDataPoolMap.emplace(pool::PDU_WDT_CAN_LEFT, new PoolEntry({0})); localDataPoolMap.emplace(pool::PDU_WDT_CSP_LEFT1, new PoolEntry({0})); localDataPoolMap.emplace(pool::PDU_WDT_CSP_LEFT2, new PoolEntry({0})); return returnvalue::OK; } bool GomspaceDeviceHandler::validTableId(uint8_t id) { if (id == TableIds::CONFIG or id == TableIds::BOARD_PARAMS or id == TableIds::CALIBRATION or id == TableIds::HK) { return true; } return false; } ReturnValue_t GomspaceDeviceHandler::generateResetWatchdogCmd() { WatchdogResetCommand watchdogResetCommand; size_t cspPacketLen = 0; uint8_t* buffer = cspPacket; ReturnValue_t result = watchdogResetCommand.serialize(&buffer, &cspPacketLen, sizeof(cspPacket), SerializeIF::Endianness::BIG); if (result != returnvalue::OK) { sif::error << "GomspaceDeviceHandler: Failed to serialize watchdog reset " << "command" << std::endl; return result; } rawPacket = cspPacket; rawPacketLen = cspPacketLen; rememberRequestedSize = 0; // No bytes will be queried with the ground // watchdog command. rememberCommandId = GOMSPACE::GNDWDT_RESET; return returnvalue::OK; } ReturnValue_t GomspaceDeviceHandler::generateRequestFullTableCmd(SpecialRequestTypes reqType, uint8_t tableId, uint16_t tableReplySize, DeviceCommandId_t id) { uint16_t querySize = tableReplySize; if (reqType == SpecialRequestTypes::DEFAULT_COM_IF) { sif::warning << "Default communication for table requests not implemented anymore" << std::endl; return returnvalue::FAILED; } auto* cspCookie = dynamic_cast(comCookie); cspCookie->setRequest(reqType, tableReplySize); cspCookie->setCspPort(CspPorts::P60_PORT_RPARAM_ENUM); rememberRequestedSize = querySize; rememberCommandId = id; return returnvalue::OK; } uint32_t GomspaceDeviceHandler::getTransitionDelayMs(Mode_t modeFrom, Mode_t modeTo) { return 0; } void GomspaceDeviceHandler::setModeNormal() { mode = MODE_NORMAL; } ReturnValue_t GomspaceDeviceHandler::printStatus(DeviceCommandId_t cmd) { sif::info << "No printHkTable implementation given.." << std::endl; return returnvalue::OK; } ReturnValue_t GomspaceDeviceHandler::parsePduHkTable(PDU::PduCoreHk& coreHk, PDU::PduAuxHk& auxHk, const uint8_t* packet) { PoolReadGuard pg0(&coreHk); PoolReadGuard pg1(&auxHk); if (pg0.getReadResult() != returnvalue::OK or pg1.getReadResult() != returnvalue::OK) { sif::warning << "Reading PDU1 datasets failed!" << std::endl; return returnvalue::FAILED; } /* Fist 10 bytes contain the gomspace header. Each variable is preceded by the 16-bit table * address. */ // dataOffset += 12; for (uint8_t idx = 0; idx < PDU::CHANNELS_LEN; idx++) { coreHk.currents[idx] = as(packet + (idx * 2)); } for (uint8_t idx = 0; idx < PDU::CHANNELS_LEN; idx++) { coreHk.voltages[idx] = as(packet + 0x12 + (idx * 2)); } auxHk.vcc.value = as(packet + 0x24); auxHk.vbat.value = as(packet + 0x26); coreHk.temperature = as(packet + 0x28) * 0.1; for (uint8_t idx = 0; idx < 3; idx++) { auxHk.converterEnable[idx] = packet[0x2a + idx]; } for (uint8_t idx = 0; idx < PDU::CHANNELS_LEN; idx++) { coreHk.outputEnables[idx] = packet[0x2e + idx]; } auxHk.bootcause = as(packet + 0x38); coreHk.bootcount = as(packet + 0x3c); auxHk.uptime = as(packet + 0x40); auxHk.resetcause = as(packet + 0x44); coreHk.battMode = *(packet + 0x46); for (uint8_t idx = 0; idx < PDU::CHANNELS_LEN; idx++) { auxHk.latchups[idx] = as(packet + 0x48 + (idx * 2)); } for (uint8_t idx = 0; idx < PDU::DEVICES_NUM; idx++) { auxHk.deviceTypes[idx] = *(packet + 0x5a + idx); } for (uint8_t idx = 0; idx < PDU::DEVICES_NUM; idx++) { auxHk.devicesStatus[idx] = *(packet + 0x62 + idx); } auxHk.gndWdtReboots = as(packet + 0x6c); auxHk.i2cWdtReboots = as(packet + 0x70); auxHk.canWdtReboots = as(packet + 0x74); auxHk.csp1WdtReboots = as(packet + 0x78); auxHk.csp2WdtReboots = as(packet + 0x78 + 4); auxHk.groundWatchdogSecondsLeft = as(packet + 0x80); auxHk.i2cWatchdogSecondsLeft = as(packet + 0x84); auxHk.canWatchdogSecondsLeft = as(packet + 0x88); auxHk.csp1WatchdogPingsLeft = *(packet + 0x8c); auxHk.csp2WatchdogPingsLeft = *(packet + 0x8c + 1); coreHk.setChanged(true); if (not coreHk.isValid()) { coreHk.setValidity(true, true); } if (not auxHk.isValid()) { auxHk.setValidity(true, true); } return returnvalue::OK; }