fsfw/pus/Service2DeviceAccess.cpp

#include <framework/pus/Service2DeviceAccess.h>
#include <framework/pus/servicepackets/Service2Packets.h>

#include <framework/devicehandlers/DeviceHandlerIF.h>
#include <framework/storagemanager/StorageManagerIF.h>
#include <framework/devicehandlers/DeviceHandlerMessage.h>
#include <framework/serialize/EndianConverter.h>
#include <framework/action/ActionMessage.h>
#include <framework/serialize/SerializeAdapter.h>
#include <framework/serialize/SerialLinkedListAdapter.h>
#include <framework/serviceinterface/ServiceInterfaceStream.h>

Service2DeviceAccess::Service2DeviceAccess(object_id_t objectId,
        uint16_t apid, uint8_t serviceId, object_id_t tcSource,
        object_id_t tmDestination, uint8_t numberOfParallelCommands,
        uint16_t commandTimeoutSeconds):
        CommandingServiceBase(objectId, apid, serviceId,
	        numberOfParallelCommands, commandTimeoutSeconds,
	        tcSource, tmDestination) {}

Service2DeviceAccess::~Service2DeviceAccess() {}

ReturnValue_t Service2DeviceAccess::isValidSubservice(uint8_t subservice) {
	switch(static_cast<Subservice>(subservice)){
	case Subservice::RAW_COMMANDING:
	case Subservice::TOGGLE_WIRETAPPING:
		return HasReturnvaluesIF::RETURN_OK;
	default:
		sif::error << "Invalid Subservice" << std::endl;
		return AcceptsTelecommandsIF::INVALID_SUBSERVICE;
	}
}

ReturnValue_t Service2DeviceAccess::getMessageQueueAndObject(
		uint8_t subservice, const uint8_t* tcData, size_t tcDataLen,
		MessageQueueId_t* id, object_id_t* objectId) {
	ReturnValue_t result = checkAndAcquireTargetID(objectId,tcData,tcDataLen);
	if(result != HasReturnvaluesIF::RETURN_OK) {
		return result;
	}

	result = checkInterfaceAndAcquireMessageQueue(id,objectId);
	return result;

}

ReturnValue_t Service2DeviceAccess::checkAndAcquireTargetID(
		object_id_t* objectIdToSet, const uint8_t* tcData, size_t tcDataLen) {
	if(SerializeAdapter::deSerialize(objectIdToSet, &tcData,
	        &tcDataLen, SerializeIF::Endianness::BIG) != RETURN_OK) {
		sif::error << "Service 2: Target ID not found. ID: " <<
				std::hex << objectIdToSet ;
		return CommandingServiceBase::INVALID_TC;
	}
	else {
		return HasReturnvaluesIF::RETURN_OK;
	}
}

ReturnValue_t Service2DeviceAccess::checkInterfaceAndAcquireMessageQueue(
		MessageQueueId_t * messageQueueToSet, object_id_t *objectId) {
	DeviceHandlerIF* possibleTarget =
			objectManager->get<DeviceHandlerIF>(*objectId);
	if(possibleTarget == nullptr) {
		return CommandingServiceBase::INVALID_OBJECT;
	}
	*messageQueueToSet = possibleTarget->getCommandQueue();
	return HasReturnvaluesIF::RETURN_OK;
}

ReturnValue_t Service2DeviceAccess::prepareCommand(CommandMessage* message,
		uint8_t subservice, const uint8_t* tcData, size_t tcDataLen,
		uint32_t* state, object_id_t objectId) {
	switch(static_cast<Subservice>(subservice)){
	case Subservice::RAW_COMMANDING: {
		return prepareRawCommand(dynamic_cast<CommandMessage*>(message),
				tcData, tcDataLen);
	}
	break;
	case Subservice::TOGGLE_WIRETAPPING: {
		return prepareWiretappingCommand(dynamic_cast<CommandMessage*>(message),
				tcData, tcDataLen);
	}
	break;
	default:
		return HasReturnvaluesIF::RETURN_FAILED;
	}
}

ReturnValue_t Service2DeviceAccess::prepareRawCommand(
        CommandMessage* messageToSet, const uint8_t *tcData,size_t tcDataLen) {
	RawCommand RawCommand(tcData,tcDataLen);
	// store command into the Inter Process Communication Store
	store_address_t storeAddress;
	ReturnValue_t result = IPCStore->addData(&storeAddress,
	        RawCommand.getCommand(), RawCommand.getCommandSize());
	DeviceHandlerMessage::setDeviceHandlerRawCommandMessage(messageToSet,
	        storeAddress);
	return result;
}

ReturnValue_t Service2DeviceAccess::prepareWiretappingCommand(
		CommandMessage *messageToSet, const uint8_t *tcData,
		size_t tcDataLen) {
	if(tcDataLen != WiretappingToggle::WIRETAPPING_COMMAND_SIZE) {
		return CommandingServiceBase::INVALID_TC;
	}
	WiretappingToggle command;
	ReturnValue_t result = command.deSerialize(&tcData, &tcDataLen,
	        SerializeIF::Endianness::BIG);
	DeviceHandlerMessage::setDeviceHandlerWiretappingMessage(messageToSet,
			command.getWiretappingMode());
	return result;
}

ReturnValue_t Service2DeviceAccess::handleReply(const CommandMessage* reply,
		Command_t previousCommand, uint32_t* state,
		CommandMessage* optionalNextCommand, object_id_t objectId,
		bool* isStep) {
	switch(reply->getCommand()) {
	case CommandMessage::REPLY_COMMAND_OK:
		return HasReturnvaluesIF::RETURN_OK;
	case CommandMessage::REPLY_REJECTED:
		return reply->getReplyRejectedReason();
	default:
		return CommandingServiceBase::INVALID_REPLY;
	}
}

// All device handlers set service 2 as default raw receiver for wiretapping
// so we have to handle those unrequested messages.
void Service2DeviceAccess::handleUnrequestedReply(CommandMessage* reply) {
	switch(reply->getCommand()) {
	case DeviceHandlerMessage::REPLY_RAW_COMMAND:
		sendWiretappingTm(reply,
				static_cast<uint8_t>(Subservice::WIRETAPPING_RAW_TC));
		break;
	case DeviceHandlerMessage::REPLY_RAW_REPLY:
		sendWiretappingTm(reply,
				static_cast<uint8_t>(Subservice::RAW_REPLY));
		break;
	default:
		sif::error << "Unknown message in Service2DeviceAccess::"
				"handleUnrequestedReply with command ID " <<
				reply->getCommand() << std::endl;
		break;
	}
	//Must be reached by all cases to clear message
	reply->clear();
}

void Service2DeviceAccess::sendWiretappingTm(CommandMessage *reply,
		uint8_t subservice) {
	// Raw Wiretapping
	// Get Address of Data from Message
	store_address_t storeAddress = DeviceHandlerMessage::getStoreAddress(reply);
	const uint8_t* data = nullptr;
	size_t size = 0;
	ReturnValue_t result = IPCStore->getData(storeAddress,&data,&size);
	if(result != HasReturnvaluesIF::RETURN_OK){
		sif::error << "Service2DeviceAccess::sendWiretappingTm: Data Lost in "
		        "handleUnrequestedReply with failure ID "<< result
		        << std::endl;
		return;
	}

	// Init our dummy packet and correct endianness of object ID before
	// sending it back.
	WiretappingPacket TmPacket(DeviceHandlerMessage::getDeviceObjectId(reply),
	        data);
	TmPacket.objectId = EndianConverter::convertBigEndian(TmPacket.objectId);
	sendTmPacket(subservice,TmPacket.data,size,reinterpret_cast<uint8_t*>(
			&TmPacket.objectId),sizeof(TmPacket.objectId));
}

MessageQueueId_t Service2DeviceAccess::getDeviceQueue() {
	return commandQueue->getId();
}