Merge branch 'master' into gaisser_small_map_issues
This commit is contained in:
commit
b681a76f29
@ -1,96 +1,113 @@
|
|||||||
#ifndef FRAMEWORK_CONTAINER_RINGBUFFERBASE_H_
|
#ifndef FSFW_CONTAINER_RINGBUFFERBASE_H_
|
||||||
#define FRAMEWORK_CONTAINER_RINGBUFFERBASE_H_
|
#define FSFW_CONTAINER_RINGBUFFERBASE_H_
|
||||||
|
|
||||||
#include "../returnvalues/HasReturnvaluesIF.h"
|
#include "../returnvalues/HasReturnvaluesIF.h"
|
||||||
|
#include <cstddef>
|
||||||
|
|
||||||
template<uint8_t N_READ_PTRS = 1>
|
template<uint8_t N_READ_PTRS = 1>
|
||||||
class RingBufferBase {
|
class RingBufferBase {
|
||||||
public:
|
public:
|
||||||
RingBufferBase(uint32_t startAddress, uint32_t size, bool overwriteOld) :
|
RingBufferBase(size_t startAddress, const size_t size, bool overwriteOld) :
|
||||||
start(startAddress), write(startAddress), size(size), overwriteOld(overwriteOld) {
|
start(startAddress), write(startAddress), size(size),
|
||||||
|
overwriteOld(overwriteOld) {
|
||||||
for (uint8_t count = 0; count < N_READ_PTRS; count++) {
|
for (uint8_t count = 0; count < N_READ_PTRS; count++) {
|
||||||
read[count] = startAddress;
|
read[count] = startAddress;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
ReturnValue_t readData(uint32_t amount, uint8_t n = 0) {
|
|
||||||
if (availableReadData(n) >= amount) {
|
virtual ~RingBufferBase() {}
|
||||||
incrementRead(amount, n);
|
|
||||||
return HasReturnvaluesIF::RETURN_OK;
|
|
||||||
} else {
|
|
||||||
return HasReturnvaluesIF::RETURN_FAILED;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
ReturnValue_t writeData(uint32_t amount) {
|
|
||||||
if (availableWriteSpace() >= amount || overwriteOld) {
|
|
||||||
incrementWrite(amount);
|
|
||||||
return HasReturnvaluesIF::RETURN_OK;
|
|
||||||
} else {
|
|
||||||
return HasReturnvaluesIF::RETURN_FAILED;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
uint32_t availableReadData(uint8_t n = 0) const {
|
|
||||||
return ((write + size) - read[n]) % size;
|
|
||||||
}
|
|
||||||
uint32_t availableWriteSpace(uint8_t n = 0) const {
|
|
||||||
//One less to avoid ambiguous full/empty problem.
|
|
||||||
return (((read[n] + size) - write - 1) % size);
|
|
||||||
}
|
|
||||||
bool isFull(uint8_t n = 0) {
|
bool isFull(uint8_t n = 0) {
|
||||||
return (availableWriteSpace(n) == 0);
|
return (availableWriteSpace(n) == 0);
|
||||||
}
|
}
|
||||||
bool isEmpty(uint8_t n = 0) {
|
bool isEmpty(uint8_t n = 0) {
|
||||||
return (availableReadData(n) == 0);
|
return (getAvailableReadData(n) == 0);
|
||||||
}
|
}
|
||||||
virtual ~RingBufferBase() {
|
|
||||||
|
|
||||||
|
size_t getAvailableReadData(uint8_t n = 0) const {
|
||||||
|
return ((write + size) - read[n]) % size;
|
||||||
}
|
}
|
||||||
uint32_t getRead(uint8_t n = 0) const {
|
size_t availableWriteSpace(uint8_t n = 0) const {
|
||||||
return read[n];
|
//One less to avoid ambiguous full/empty problem.
|
||||||
|
return (((read[n] + size) - write - 1) % size);
|
||||||
}
|
}
|
||||||
void setRead(uint32_t read, uint8_t n = 0) {
|
|
||||||
if (read >= start && read < (start+size)) {
|
bool overwritesOld() const {
|
||||||
this->read[n] = read;
|
return overwriteOld;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
size_t getMaxSize() const {
|
||||||
|
return size - 1;
|
||||||
}
|
}
|
||||||
uint32_t getWrite() const {
|
|
||||||
return write;
|
|
||||||
}
|
|
||||||
void setWrite(uint32_t write) {
|
|
||||||
this->write = write;
|
|
||||||
}
|
|
||||||
void clear() {
|
void clear() {
|
||||||
write = start;
|
write = start;
|
||||||
for (uint8_t count = 0; count < N_READ_PTRS; count++) {
|
for (uint8_t count = 0; count < N_READ_PTRS; count++) {
|
||||||
read[count] = start;
|
read[count] = start;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
uint32_t writeTillWrap() {
|
|
||||||
|
size_t writeTillWrap() {
|
||||||
return (start + size) - write;
|
return (start + size) - write;
|
||||||
}
|
}
|
||||||
uint32_t readTillWrap(uint8_t n = 0) {
|
|
||||||
|
size_t readTillWrap(uint8_t n = 0) {
|
||||||
return (start + size) - read[n];
|
return (start + size) - read[n];
|
||||||
}
|
}
|
||||||
uint32_t getStart() const {
|
|
||||||
|
size_t getStart() const {
|
||||||
return start;
|
return start;
|
||||||
}
|
}
|
||||||
bool overwritesOld() const {
|
|
||||||
return overwriteOld;
|
|
||||||
}
|
|
||||||
uint32_t maxSize() const {
|
|
||||||
return size - 1;
|
|
||||||
}
|
|
||||||
protected:
|
protected:
|
||||||
const uint32_t start;
|
const size_t start;
|
||||||
uint32_t write;
|
size_t write;
|
||||||
uint32_t read[N_READ_PTRS];
|
size_t read[N_READ_PTRS];
|
||||||
const uint32_t size;
|
const size_t size;
|
||||||
const bool overwriteOld;
|
const bool overwriteOld;
|
||||||
|
|
||||||
void incrementWrite(uint32_t amount) {
|
void incrementWrite(uint32_t amount) {
|
||||||
write = ((write + amount - start) % size) + start;
|
write = ((write + amount - start) % size) + start;
|
||||||
}
|
}
|
||||||
void incrementRead(uint32_t amount, uint8_t n = 0) {
|
void incrementRead(uint32_t amount, uint8_t n = 0) {
|
||||||
read[n] = ((read[n] + amount - start) % size) + start;
|
read[n] = ((read[n] + amount - start) % size) + start;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
ReturnValue_t readData(uint32_t amount, uint8_t n = 0) {
|
||||||
|
if (getAvailableReadData(n) >= amount) {
|
||||||
|
incrementRead(amount, n);
|
||||||
|
return HasReturnvaluesIF::RETURN_OK;
|
||||||
|
} else {
|
||||||
|
return HasReturnvaluesIF::RETURN_FAILED;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
ReturnValue_t writeData(uint32_t amount) {
|
||||||
|
if (availableWriteSpace() >= amount or overwriteOld) {
|
||||||
|
incrementWrite(amount);
|
||||||
|
return HasReturnvaluesIF::RETURN_OK;
|
||||||
|
} else {
|
||||||
|
return HasReturnvaluesIF::RETURN_FAILED;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t getRead(uint8_t n = 0) const {
|
||||||
|
return read[n];
|
||||||
|
}
|
||||||
|
|
||||||
|
void setRead(uint32_t read, uint8_t n = 0) {
|
||||||
|
if (read >= start && read < (start+size)) {
|
||||||
|
this->read[n] = read;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
uint32_t getWrite() const {
|
||||||
|
return write;
|
||||||
|
}
|
||||||
|
|
||||||
|
void setWrite(uint32_t write) {
|
||||||
|
this->write = write;
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
#endif /* FRAMEWORK_CONTAINER_RINGBUFFERBASE_H_ */
|
#endif /* FSFW_CONTAINER_RINGBUFFERBASE_H_ */
|
||||||
|
30
container/SharedRingBuffer.cpp
Normal file
30
container/SharedRingBuffer.cpp
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
#include "SharedRingBuffer.h"
|
||||||
|
#include "../ipc/MutexFactory.h"
|
||||||
|
#include "../ipc/MutexHelper.h"
|
||||||
|
|
||||||
|
SharedRingBuffer::SharedRingBuffer(object_id_t objectId, const size_t size,
|
||||||
|
bool overwriteOld, size_t maxExcessBytes):
|
||||||
|
SystemObject(objectId), SimpleRingBuffer(size, overwriteOld,
|
||||||
|
maxExcessBytes) {
|
||||||
|
mutex = MutexFactory::instance()->createMutex();
|
||||||
|
}
|
||||||
|
|
||||||
|
SharedRingBuffer::SharedRingBuffer(object_id_t objectId, uint8_t *buffer,
|
||||||
|
const size_t size, bool overwriteOld, size_t maxExcessBytes):
|
||||||
|
SystemObject(objectId), SimpleRingBuffer(buffer, size, overwriteOld,
|
||||||
|
maxExcessBytes) {
|
||||||
|
mutex = MutexFactory::instance()->createMutex();
|
||||||
|
}
|
||||||
|
|
||||||
|
ReturnValue_t SharedRingBuffer::lockRingBufferMutex(
|
||||||
|
MutexIF::TimeoutType timeoutType, dur_millis_t timeout) {
|
||||||
|
return mutex->lockMutex(timeoutType, timeout);
|
||||||
|
}
|
||||||
|
|
||||||
|
ReturnValue_t SharedRingBuffer::unlockRingBufferMutex() {
|
||||||
|
return mutex->unlockMutex();
|
||||||
|
}
|
||||||
|
|
||||||
|
MutexIF* SharedRingBuffer::getMutexHandle() const {
|
||||||
|
return mutex;
|
||||||
|
}
|
68
container/SharedRingBuffer.h
Normal file
68
container/SharedRingBuffer.h
Normal file
@ -0,0 +1,68 @@
|
|||||||
|
#ifndef FSFW_CONTAINER_SHAREDRINGBUFFER_H_
|
||||||
|
#define FSFW_CONTAINER_SHAREDRINGBUFFER_H_
|
||||||
|
|
||||||
|
#include "SimpleRingBuffer.h"
|
||||||
|
#include "../ipc/MutexIF.h"
|
||||||
|
#include "../objectmanager/SystemObject.h"
|
||||||
|
#include "../timemanager/Clock.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Ring buffer which can be shared among multiple objects
|
||||||
|
* @details
|
||||||
|
* This class offers a mutex to perform thread-safe operation on the ring
|
||||||
|
* buffer. It is still up to the developer to actually perform the lock
|
||||||
|
* and unlock operations.
|
||||||
|
*/
|
||||||
|
class SharedRingBuffer: public SystemObject,
|
||||||
|
public SimpleRingBuffer {
|
||||||
|
public:
|
||||||
|
/**
|
||||||
|
* This constructor allocates a new internal buffer with the supplied size.
|
||||||
|
* @param size
|
||||||
|
* @param overwriteOld
|
||||||
|
* If the ring buffer is overflowing at a write operartion, the oldest data
|
||||||
|
* will be overwritten.
|
||||||
|
*/
|
||||||
|
SharedRingBuffer(object_id_t objectId, const size_t size,
|
||||||
|
bool overwriteOld, size_t maxExcessBytes);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This constructor takes an external buffer with the specified size.
|
||||||
|
* @param buffer
|
||||||
|
* @param size
|
||||||
|
* @param overwriteOld
|
||||||
|
* If the ring buffer is overflowing at a write operartion, the oldest data
|
||||||
|
* will be overwritten.
|
||||||
|
*/
|
||||||
|
SharedRingBuffer(object_id_t objectId, uint8_t* buffer, const size_t size,
|
||||||
|
bool overwriteOld, size_t maxExcessBytes);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unless a read-only constant value is read, all operations on the
|
||||||
|
* shared ring buffer should be protected by calling this function.
|
||||||
|
* @param timeoutType
|
||||||
|
* @param timeout
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
virtual ReturnValue_t lockRingBufferMutex(MutexIF::TimeoutType timeoutType,
|
||||||
|
dur_millis_t timeout);
|
||||||
|
/**
|
||||||
|
* Any locked mutex also has to be unlocked, otherwise, access to the
|
||||||
|
* shared ring buffer will be blocked.
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
virtual ReturnValue_t unlockRingBufferMutex();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The mutex handle can be accessed directly, for example to perform
|
||||||
|
* the lock with the #MutexHelper for a RAII compliant lock operation.
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
MutexIF* getMutexHandle() const;
|
||||||
|
private:
|
||||||
|
MutexIF* mutex = nullptr;
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#endif /* FSFW_CONTAINER_SHAREDRINGBUFFER_H_ */
|
@ -1,27 +1,69 @@
|
|||||||
#include "SimpleRingBuffer.h"
|
#include "SimpleRingBuffer.h"
|
||||||
#include <string.h>
|
#include <cstring>
|
||||||
|
|
||||||
SimpleRingBuffer::SimpleRingBuffer(const size_t size, bool overwriteOld) :
|
SimpleRingBuffer::SimpleRingBuffer(const size_t size, bool overwriteOld,
|
||||||
RingBufferBase<>(0, size, overwriteOld) {
|
size_t maxExcessBytes) :
|
||||||
buffer = new uint8_t[size];
|
RingBufferBase<>(0, size, overwriteOld),
|
||||||
|
maxExcessBytes(maxExcessBytes) {
|
||||||
|
if(maxExcessBytes > size) {
|
||||||
|
this->maxExcessBytes = size;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
this->maxExcessBytes = maxExcessBytes;
|
||||||
|
}
|
||||||
|
buffer = new uint8_t[size + maxExcessBytes];
|
||||||
}
|
}
|
||||||
|
|
||||||
SimpleRingBuffer::SimpleRingBuffer(uint8_t *buffer, const size_t size,
|
SimpleRingBuffer::SimpleRingBuffer(uint8_t *buffer, const size_t size,
|
||||||
bool overwriteOld):
|
bool overwriteOld, size_t maxExcessBytes):
|
||||||
RingBufferBase<>(0, size, overwriteOld), buffer(buffer) {}
|
RingBufferBase<>(0, size, overwriteOld), buffer(buffer) {
|
||||||
|
if(maxExcessBytes > size) {
|
||||||
|
this->maxExcessBytes = size;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
this->maxExcessBytes = maxExcessBytes;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
SimpleRingBuffer::~SimpleRingBuffer() {
|
SimpleRingBuffer::~SimpleRingBuffer() {
|
||||||
delete[] buffer;
|
delete[] buffer;
|
||||||
}
|
}
|
||||||
|
|
||||||
ReturnValue_t SimpleRingBuffer::writeData(const uint8_t* data,
|
ReturnValue_t SimpleRingBuffer::getFreeElement(uint8_t **writePointer,
|
||||||
uint32_t amount) {
|
size_t amount) {
|
||||||
if (availableWriteSpace() >= amount or overwriteOld) {
|
if (availableWriteSpace() >= amount or overwriteOld) {
|
||||||
uint32_t amountTillWrap = writeTillWrap();
|
size_t amountTillWrap = writeTillWrap();
|
||||||
|
if (amountTillWrap < amount) {
|
||||||
|
if((amount - amountTillWrap + excessBytes) > maxExcessBytes) {
|
||||||
|
return HasReturnvaluesIF::RETURN_FAILED;
|
||||||
|
}
|
||||||
|
excessBytes = amount - amountTillWrap;
|
||||||
|
}
|
||||||
|
*writePointer = &buffer[write];
|
||||||
|
return HasReturnvaluesIF::RETURN_OK;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
return HasReturnvaluesIF::RETURN_FAILED;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void SimpleRingBuffer::confirmBytesWritten(size_t amount) {
|
||||||
|
if(getExcessBytes() > 0) {
|
||||||
|
moveExcessBytesToStart();
|
||||||
|
}
|
||||||
|
incrementWrite(amount);
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
ReturnValue_t SimpleRingBuffer::writeData(const uint8_t* data,
|
||||||
|
size_t amount) {
|
||||||
|
if (availableWriteSpace() >= amount or overwriteOld) {
|
||||||
|
size_t amountTillWrap = writeTillWrap();
|
||||||
if (amountTillWrap >= amount) {
|
if (amountTillWrap >= amount) {
|
||||||
|
// remaining size in buffer is sufficient to fit full amount.
|
||||||
memcpy(&buffer[write], data, amount);
|
memcpy(&buffer[write], data, amount);
|
||||||
} else {
|
}
|
||||||
|
else {
|
||||||
memcpy(&buffer[write], data, amountTillWrap);
|
memcpy(&buffer[write], data, amountTillWrap);
|
||||||
memcpy(buffer, data + amountTillWrap, amount - amountTillWrap);
|
memcpy(buffer, data + amountTillWrap, amount - amountTillWrap);
|
||||||
}
|
}
|
||||||
@ -32,12 +74,13 @@ ReturnValue_t SimpleRingBuffer::writeData(const uint8_t* data,
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
ReturnValue_t SimpleRingBuffer::readData(uint8_t* data, uint32_t amount,
|
ReturnValue_t SimpleRingBuffer::readData(uint8_t* data, size_t amount,
|
||||||
bool readRemaining, uint32_t* trueAmount) {
|
bool incrementReadPtr, bool readRemaining, size_t* trueAmount) {
|
||||||
uint32_t availableData = availableReadData(READ_PTR);
|
size_t availableData = getAvailableReadData(READ_PTR);
|
||||||
uint32_t amountTillWrap = readTillWrap(READ_PTR);
|
size_t amountTillWrap = readTillWrap(READ_PTR);
|
||||||
if (availableData < amount) {
|
if (availableData < amount) {
|
||||||
if (readRemaining) {
|
if (readRemaining) {
|
||||||
|
// more data available than amount specified.
|
||||||
amount = availableData;
|
amount = availableData;
|
||||||
} else {
|
} else {
|
||||||
return HasReturnvaluesIF::RETURN_FAILED;
|
return HasReturnvaluesIF::RETURN_FAILED;
|
||||||
@ -52,12 +95,27 @@ ReturnValue_t SimpleRingBuffer::readData(uint8_t* data, uint32_t amount,
|
|||||||
memcpy(data, &buffer[read[READ_PTR]], amountTillWrap);
|
memcpy(data, &buffer[read[READ_PTR]], amountTillWrap);
|
||||||
memcpy(data + amountTillWrap, buffer, amount - amountTillWrap);
|
memcpy(data + amountTillWrap, buffer, amount - amountTillWrap);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if(incrementReadPtr) {
|
||||||
|
deleteData(amount, readRemaining);
|
||||||
|
}
|
||||||
return HasReturnvaluesIF::RETURN_OK;
|
return HasReturnvaluesIF::RETURN_OK;
|
||||||
}
|
}
|
||||||
|
|
||||||
ReturnValue_t SimpleRingBuffer::deleteData(uint32_t amount,
|
size_t SimpleRingBuffer::getExcessBytes() const {
|
||||||
bool deleteRemaining, uint32_t* trueAmount) {
|
return excessBytes;
|
||||||
uint32_t availableData = availableReadData(READ_PTR);
|
}
|
||||||
|
|
||||||
|
void SimpleRingBuffer::moveExcessBytesToStart() {
|
||||||
|
if(excessBytes > 0) {
|
||||||
|
std::memcpy(buffer, &buffer[size], excessBytes);
|
||||||
|
excessBytes = 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
ReturnValue_t SimpleRingBuffer::deleteData(size_t amount,
|
||||||
|
bool deleteRemaining, size_t* trueAmount) {
|
||||||
|
size_t availableData = getAvailableReadData(READ_PTR);
|
||||||
if (availableData < amount) {
|
if (availableData < amount) {
|
||||||
if (deleteRemaining) {
|
if (deleteRemaining) {
|
||||||
amount = availableData;
|
amount = availableData;
|
||||||
@ -71,4 +129,3 @@ ReturnValue_t SimpleRingBuffer::deleteData(uint32_t amount,
|
|||||||
incrementRead(amount, READ_PTR);
|
incrementRead(amount, READ_PTR);
|
||||||
return HasReturnvaluesIF::RETURN_OK;
|
return HasReturnvaluesIF::RETURN_OK;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
#ifndef FRAMEWORK_CONTAINER_SIMPLERINGBUFFER_H_
|
#ifndef FSFW_CONTAINER_SIMPLERINGBUFFER_H_
|
||||||
#define FRAMEWORK_CONTAINER_SIMPLERINGBUFFER_H_
|
#define FSFW_CONTAINER_SIMPLERINGBUFFER_H_
|
||||||
|
|
||||||
#include "RingBufferBase.h"
|
#include "RingBufferBase.h"
|
||||||
#include <stddef.h>
|
#include <cstddef>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief Circular buffer implementation, useful for buffering
|
* @brief Circular buffer implementation, useful for buffering
|
||||||
@ -16,53 +16,114 @@ class SimpleRingBuffer: public RingBufferBase<> {
|
|||||||
public:
|
public:
|
||||||
/**
|
/**
|
||||||
* This constructor allocates a new internal buffer with the supplied size.
|
* This constructor allocates a new internal buffer with the supplied size.
|
||||||
|
*
|
||||||
* @param size
|
* @param size
|
||||||
* @param overwriteOld
|
* @param overwriteOld If the ring buffer is overflowing at a write
|
||||||
|
* operation, the oldest data will be overwritten.
|
||||||
|
* @param maxExcessBytes These additional bytes will be allocated in addtion
|
||||||
|
* to the specified size to accomodate contiguous write operations
|
||||||
|
* with getFreeElement.
|
||||||
|
*
|
||||||
*/
|
*/
|
||||||
SimpleRingBuffer(const size_t size, bool overwriteOld);
|
SimpleRingBuffer(const size_t size, bool overwriteOld,
|
||||||
|
size_t maxExcessBytes = 0);
|
||||||
/**
|
/**
|
||||||
* This constructor takes an external buffer with the specified size.
|
* This constructor takes an external buffer with the specified size.
|
||||||
* @param buffer
|
* @param buffer
|
||||||
* @param size
|
* @param size
|
||||||
* @param overwriteOld
|
* @param overwriteOld
|
||||||
|
* If the ring buffer is overflowing at a write operartion, the oldest data
|
||||||
|
* will be overwritten.
|
||||||
|
* @param maxExcessBytes
|
||||||
|
* If the buffer can accomodate additional bytes for contigous write
|
||||||
|
* operations with getFreeElement, this is the maximum allowed additional
|
||||||
|
* size
|
||||||
*/
|
*/
|
||||||
SimpleRingBuffer(uint8_t* buffer, const size_t size, bool overwriteOld);
|
SimpleRingBuffer(uint8_t* buffer, const size_t size, bool overwriteOld,
|
||||||
|
size_t maxExcessBytes = 0);
|
||||||
|
|
||||||
virtual ~SimpleRingBuffer();
|
virtual ~SimpleRingBuffer();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Write to circular buffer and increment write pointer by amount
|
* Write to circular buffer and increment write pointer by amount.
|
||||||
* @param data
|
* @param data
|
||||||
* @param amount
|
* @param amount
|
||||||
|
* @return -@c RETURN_OK if write operation was successfull
|
||||||
|
* -@c RETURN_FAILED if
|
||||||
|
*/
|
||||||
|
ReturnValue_t writeData(const uint8_t* data, size_t amount);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a pointer to a free element. If the remaining buffer is
|
||||||
|
* not large enough, the data will be written past the actual size
|
||||||
|
* and the amount of excess bytes will be cached. This function
|
||||||
|
* does not increment the write pointer!
|
||||||
|
* @param writePointer Pointer to a pointer which can be used to write
|
||||||
|
* contiguous blocks into the ring buffer
|
||||||
|
* @param amount
|
||||||
* @return
|
* @return
|
||||||
*/
|
*/
|
||||||
ReturnValue_t writeData(const uint8_t* data, uint32_t amount);
|
ReturnValue_t getFreeElement(uint8_t** writePointer, size_t amount);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Read from circular buffer at read pointer
|
* This increments the write pointer and also copies the excess bytes
|
||||||
|
* to the beginning. It should be called if the write operation
|
||||||
|
* conducted after calling getFreeElement() was performed.
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
void confirmBytesWritten(size_t amount);
|
||||||
|
|
||||||
|
virtual size_t getExcessBytes() const;
|
||||||
|
/**
|
||||||
|
* Helper functions which moves any excess bytes to the start
|
||||||
|
* of the ring buffer.
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
virtual void moveExcessBytesToStart();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read from circular buffer at read pointer.
|
||||||
* @param data
|
* @param data
|
||||||
* @param amount
|
* @param amount
|
||||||
|
* @param incrementReadPtr
|
||||||
|
* If this is set to true, the read pointer will be incremented.
|
||||||
|
* If readRemaining is set to true, the read pointer will be incremented
|
||||||
|
* accordingly.
|
||||||
* @param readRemaining
|
* @param readRemaining
|
||||||
* @param trueAmount
|
* If this is set to true, the data will be read even if the amount
|
||||||
|
* specified exceeds the read data available.
|
||||||
|
* @param trueAmount [out]
|
||||||
|
* If readRemaining was set to true, the true amount read will be assigned
|
||||||
|
* to the passed value.
|
||||||
* @return
|
* @return
|
||||||
|
* - @c RETURN_OK if data was read successfully
|
||||||
|
* - @c RETURN_FAILED if not enough data was available and readRemaining
|
||||||
|
* was set to false.
|
||||||
*/
|
*/
|
||||||
ReturnValue_t readData(uint8_t* data, uint32_t amount,
|
ReturnValue_t readData(uint8_t* data, size_t amount,
|
||||||
bool readRemaining = false, uint32_t* trueAmount = nullptr);
|
bool incrementReadPtr = false, bool readRemaining = false,
|
||||||
|
size_t* trueAmount = nullptr);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Delete data starting by incrementing read pointer
|
* Delete data by incrementing read pointer.
|
||||||
* @param amount
|
* @param amount
|
||||||
* @param deleteRemaining
|
* @param deleteRemaining
|
||||||
* @param trueAmount
|
* If the amount specified is larger than the remaing size to read and this
|
||||||
|
* is set to true, the remaining amount will be deleted as well
|
||||||
|
* @param trueAmount [out]
|
||||||
|
* If deleteRemaining was set to true, the amount deleted will be assigned
|
||||||
|
* to the passed value.
|
||||||
* @return
|
* @return
|
||||||
*/
|
*/
|
||||||
ReturnValue_t deleteData(uint32_t amount, bool deleteRemaining = false,
|
ReturnValue_t deleteData(size_t amount, bool deleteRemaining = false,
|
||||||
uint32_t* trueAmount = nullptr);
|
size_t* trueAmount = nullptr);
|
||||||
|
|
||||||
private:
|
private:
|
||||||
// static const uint8_t TEMP_READ_PTR = 1;
|
|
||||||
static const uint8_t READ_PTR = 0;
|
static const uint8_t READ_PTR = 0;
|
||||||
uint8_t* buffer = nullptr;
|
uint8_t* buffer = nullptr;
|
||||||
|
size_t maxExcessBytes;
|
||||||
|
size_t excessBytes = 0;
|
||||||
};
|
};
|
||||||
|
|
||||||
#endif /* FRAMEWORK_CONTAINER_SIMPLERINGBUFFER_H_ */
|
#endif /* FSFW_CONTAINER_SIMPLERINGBUFFER_H_ */
|
||||||
|
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
#ifndef FRAMEWORK_EVENTS_FWSUBSYSTEMIDRANGES_H_
|
#ifndef FSFW_EVENTS_FWSUBSYSTEMIDRANGES_H_
|
||||||
#define FRAMEWORK_EVENTS_FWSUBSYSTEMIDRANGES_H_
|
#define FSFW_EVENTS_FWSUBSYSTEMIDRANGES_H_
|
||||||
|
|
||||||
namespace SUBSYSTEM_ID {
|
namespace SUBSYSTEM_ID {
|
||||||
enum {
|
enum {
|
||||||
@ -19,10 +19,11 @@ enum {
|
|||||||
SYSTEM_MANAGER_1 = 75,
|
SYSTEM_MANAGER_1 = 75,
|
||||||
SYSTEM_1 = 79,
|
SYSTEM_1 = 79,
|
||||||
PUS_SERVICE_1 = 80,
|
PUS_SERVICE_1 = 80,
|
||||||
|
PUS_SERVICE_17 = 97,
|
||||||
FW_SUBSYSTEM_ID_RANGE
|
FW_SUBSYSTEM_ID_RANGE
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#endif /* FRAMEWORK_EVENTS_FWSUBSYSTEMIDRANGES_H_ */
|
#endif /* FSFW_EVENTS_FWSUBSYSTEMIDRANGES_H_ */
|
||||||
|
@ -1,9 +1,8 @@
|
|||||||
#include "HealthHelper.h"
|
#include "HealthHelper.h"
|
||||||
#include "../ipc/MessageQueueSenderIF.h"
|
|
||||||
#include "../serviceinterface/ServiceInterfaceStream.h"
|
#include "../serviceinterface/ServiceInterfaceStream.h"
|
||||||
|
|
||||||
HealthHelper::HealthHelper(HasHealthIF* owner, object_id_t objectId) :
|
HealthHelper::HealthHelper(HasHealthIF* owner, object_id_t objectId) :
|
||||||
healthTable(NULL), eventSender(NULL), objectId(objectId), parentQueue(
|
objectId(objectId), owner(owner) {
|
||||||
0), owner(owner) {
|
|
||||||
}
|
}
|
||||||
|
|
||||||
HealthHelper::~HealthHelper() {
|
HealthHelper::~HealthHelper() {
|
||||||
@ -40,9 +39,19 @@ void HealthHelper::setParentQueue(MessageQueueId_t parentQueue) {
|
|||||||
ReturnValue_t HealthHelper::initialize() {
|
ReturnValue_t HealthHelper::initialize() {
|
||||||
healthTable = objectManager->get<HealthTableIF>(objects::HEALTH_TABLE);
|
healthTable = objectManager->get<HealthTableIF>(objects::HEALTH_TABLE);
|
||||||
eventSender = objectManager->get<EventReportingProxyIF>(objectId);
|
eventSender = objectManager->get<EventReportingProxyIF>(objectId);
|
||||||
if ((healthTable == NULL) || eventSender == NULL) {
|
|
||||||
return HasReturnvaluesIF::RETURN_FAILED;
|
if (healthTable == nullptr) {
|
||||||
|
sif::error << "HealthHelper::initialize: Health table object needs"
|
||||||
|
"to be created in factory." << std::endl;
|
||||||
|
return ObjectManagerIF::CHILD_INIT_FAILED;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if(eventSender == nullptr) {
|
||||||
|
sif::error << "HealthHelper::initialize: Owner has to implement "
|
||||||
|
"ReportingProxyIF." << std::endl;
|
||||||
|
return ObjectManagerIF::CHILD_INIT_FAILED;
|
||||||
|
}
|
||||||
|
|
||||||
ReturnValue_t result = healthTable->registerObject(objectId,
|
ReturnValue_t result = healthTable->registerObject(objectId,
|
||||||
HasHealthIF::HEALTHY);
|
HasHealthIF::HEALTHY);
|
||||||
if (result != HasReturnvaluesIF::RETURN_OK) {
|
if (result != HasReturnvaluesIF::RETURN_OK) {
|
||||||
@ -62,22 +71,22 @@ void HealthHelper::setHealth(HasHealthIF::HealthState health) {
|
|||||||
|
|
||||||
void HealthHelper::informParent(HasHealthIF::HealthState health,
|
void HealthHelper::informParent(HasHealthIF::HealthState health,
|
||||||
HasHealthIF::HealthState oldHealth) {
|
HasHealthIF::HealthState oldHealth) {
|
||||||
if (parentQueue == 0) {
|
if (parentQueue == MessageQueueIF::NO_QUEUE) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
CommandMessage message;
|
CommandMessage information;
|
||||||
HealthMessage::setHealthMessage(&message, HealthMessage::HEALTH_INFO,
|
HealthMessage::setHealthMessage(&information, HealthMessage::HEALTH_INFO,
|
||||||
health, oldHealth);
|
health, oldHealth);
|
||||||
if (MessageQueueSenderIF::sendMessage(parentQueue, &message,
|
if (MessageQueueSenderIF::sendMessage(parentQueue, &information,
|
||||||
owner->getCommandQueue()) != HasReturnvaluesIF::RETURN_OK) {
|
owner->getCommandQueue()) != HasReturnvaluesIF::RETURN_OK) {
|
||||||
sif::debug << "HealthHelper::informParent: sending health reply failed."
|
sif::debug << "HealthHelper::informParent: sending health reply failed."
|
||||||
<< std::endl;
|
<< std::endl;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
void HealthHelper::handleSetHealthCommand(CommandMessage* message) {
|
void HealthHelper::handleSetHealthCommand(CommandMessage* command) {
|
||||||
ReturnValue_t result = owner->setHealth(HealthMessage::getHealth(message));
|
ReturnValue_t result = owner->setHealth(HealthMessage::getHealth(command));
|
||||||
if (message->getSender() == 0) {
|
if (command->getSender() == MessageQueueIF::NO_QUEUE) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
CommandMessage reply;
|
CommandMessage reply;
|
||||||
@ -85,12 +94,12 @@ void HealthHelper::handleSetHealthCommand(CommandMessage* message) {
|
|||||||
HealthMessage::setHealthMessage(&reply,
|
HealthMessage::setHealthMessage(&reply,
|
||||||
HealthMessage::REPLY_HEALTH_SET);
|
HealthMessage::REPLY_HEALTH_SET);
|
||||||
} else {
|
} else {
|
||||||
reply.setReplyRejected(result, message->getCommand());
|
reply.setReplyRejected(result, command->getCommand());
|
||||||
}
|
}
|
||||||
if (MessageQueueSenderIF::sendMessage(message->getSender(), &reply,
|
if (MessageQueueSenderIF::sendMessage(command->getSender(), &reply,
|
||||||
owner->getCommandQueue()) != HasReturnvaluesIF::RETURN_OK) {
|
owner->getCommandQueue()) != HasReturnvaluesIF::RETURN_OK) {
|
||||||
sif::debug
|
sif::debug << "HealthHelper::handleHealthCommand: sending health "
|
||||||
<< "HealthHelper::handleHealthCommand: sending health reply failed."
|
"reply failed." << std::endl;
|
||||||
<< std::endl;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,11 +1,13 @@
|
|||||||
#ifndef HEALTHHELPER_H_
|
#ifndef FSFW_HEALTH_HEALTHHELPER_H_
|
||||||
#define HEALTHHELPER_H_
|
#define FSFW_HEALTH_HEALTHHELPER_H_
|
||||||
|
|
||||||
#include "../events/EventManagerIF.h"
|
|
||||||
#include "../events/EventReportingProxyIF.h"
|
|
||||||
#include "HasHealthIF.h"
|
#include "HasHealthIF.h"
|
||||||
#include "HealthMessage.h"
|
#include "HealthMessage.h"
|
||||||
#include "HealthTableIF.h"
|
#include "HealthTableIF.h"
|
||||||
|
|
||||||
|
#include "../events/EventManagerIF.h"
|
||||||
|
#include "../events/EventReportingProxyIF.h"
|
||||||
|
#include "../ipc/MessageQueueIF.h"
|
||||||
#include "../objectmanager/ObjectManagerIF.h"
|
#include "../objectmanager/ObjectManagerIF.h"
|
||||||
#include "../returnvalues/HasReturnvaluesIF.h"
|
#include "../returnvalues/HasReturnvaluesIF.h"
|
||||||
|
|
||||||
@ -27,8 +29,8 @@ public:
|
|||||||
/**
|
/**
|
||||||
* ctor
|
* ctor
|
||||||
*
|
*
|
||||||
|
* @param owner
|
||||||
* @param objectId the object Id to use when communication with the HealthTable
|
* @param objectId the object Id to use when communication with the HealthTable
|
||||||
* @param useAsFrom id to use as from id when sending replies, can be set to 0
|
|
||||||
*/
|
*/
|
||||||
HealthHelper(HasHealthIF* owner, object_id_t objectId);
|
HealthHelper(HasHealthIF* owner, object_id_t objectId);
|
||||||
|
|
||||||
@ -39,12 +41,12 @@ public:
|
|||||||
*
|
*
|
||||||
* only valid after initialize() has been called
|
* only valid after initialize() has been called
|
||||||
*/
|
*/
|
||||||
HealthTableIF *healthTable;
|
HealthTableIF *healthTable = nullptr;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Proxy to forward events.
|
* Proxy to forward events.
|
||||||
*/
|
*/
|
||||||
EventReportingProxyIF* eventSender;
|
EventReportingProxyIF* eventSender = nullptr;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Try to handle the message.
|
* Try to handle the message.
|
||||||
@ -100,7 +102,7 @@ private:
|
|||||||
/**
|
/**
|
||||||
* The Queue of the parent
|
* The Queue of the parent
|
||||||
*/
|
*/
|
||||||
MessageQueueId_t parentQueue;
|
MessageQueueId_t parentQueue = MessageQueueIF::NO_QUEUE;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The one using the healthHelper.
|
* The one using the healthHelper.
|
||||||
@ -117,4 +119,4 @@ private:
|
|||||||
void handleSetHealthCommand(CommandMessage *message);
|
void handleSetHealthCommand(CommandMessage *message);
|
||||||
};
|
};
|
||||||
|
|
||||||
#endif /* HEALTHHELPER_H_ */
|
#endif /* FSFW_HEALTH_HEALTHHELPER_H_ */
|
||||||
|
@ -1,12 +1,5 @@
|
|||||||
/**
|
#ifndef FSFW_OBJECTMANAGER_OBJECTMANAGER_H_
|
||||||
* @file ObjectManager.h
|
#define FSFW_OBJECTMANAGER_OBJECTMANAGER_H_
|
||||||
* @brief This file contains the implementation of the ObjectManager class
|
|
||||||
* @date 18.09.2012
|
|
||||||
* @author Bastian Baetz
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef OBJECTMANAGER_H_
|
|
||||||
#define OBJECTMANAGER_H_
|
|
||||||
|
|
||||||
#include "ObjectManagerIF.h"
|
#include "ObjectManagerIF.h"
|
||||||
#include "SystemObjectIF.h"
|
#include "SystemObjectIF.h"
|
||||||
@ -22,14 +15,15 @@
|
|||||||
* most of the system initialization.
|
* most of the system initialization.
|
||||||
* As the system is static after initialization, no new objects are
|
* As the system is static after initialization, no new objects are
|
||||||
* created or inserted into the list after startup.
|
* created or inserted into the list after startup.
|
||||||
* \ingroup system_objects
|
* @ingroup system_objects
|
||||||
|
* @author Bastian Baetz
|
||||||
*/
|
*/
|
||||||
class ObjectManager : public ObjectManagerIF {
|
class ObjectManager : public ObjectManagerIF {
|
||||||
private:
|
private:
|
||||||
//comparison?
|
//comparison?
|
||||||
/**
|
/**
|
||||||
* \brief This is the map of all initialized objects in the manager.
|
* @brief This is the map of all initialized objects in the manager.
|
||||||
* \details Objects in the List must inherit the SystemObjectIF.
|
* @details Objects in the List must inherit the SystemObjectIF.
|
||||||
*/
|
*/
|
||||||
std::map<object_id_t, SystemObjectIF*> objectList;
|
std::map<object_id_t, SystemObjectIF*> objectList;
|
||||||
protected:
|
protected:
|
||||||
@ -54,7 +48,8 @@ public:
|
|||||||
/**
|
/**
|
||||||
* @brief In the class's destructor, all objects in the list are deleted.
|
* @brief In the class's destructor, all objects in the list are deleted.
|
||||||
*/
|
*/
|
||||||
//SHOULDDO: If, for some reason, deleting an ObjectManager instance is required, check if this works.
|
// SHOULDDO: If, for some reason, deleting an ObjectManager instance is
|
||||||
|
// required, check if this works.
|
||||||
virtual ~ObjectManager( void );
|
virtual ~ObjectManager( void );
|
||||||
ReturnValue_t insert( object_id_t id, SystemObjectIF* object );
|
ReturnValue_t insert( object_id_t id, SystemObjectIF* object );
|
||||||
ReturnValue_t remove( object_id_t id );
|
ReturnValue_t remove( object_id_t id );
|
||||||
@ -64,4 +59,4 @@ public:
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
#endif /* OBJECTMANAGER_H_ */
|
#endif /* FSFW_OBJECTMANAGER_OBJECTMANAGER_H_ */
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
#ifndef FRAMEWORK_OBJECTMANAGER_OBJECTMANAGERIF_H_
|
#ifndef FSFW_OBJECTMANAGER_OBJECTMANAGERIF_H_
|
||||||
#define FRAMEWORK_OBJECTMANAGER_OBJECTMANAGERIF_H_
|
#define FSFW_OBJECTMANAGER_OBJECTMANAGERIF_H_
|
||||||
|
|
||||||
#include "frameworkObjects.h"
|
#include "frameworkObjects.h"
|
||||||
#include "SystemObjectIF.h"
|
#include "SystemObjectIF.h"
|
||||||
@ -21,7 +21,6 @@ public:
|
|||||||
static constexpr uint8_t INTERFACE_ID = CLASS_ID::OBJECT_MANAGER_IF;
|
static constexpr uint8_t INTERFACE_ID = CLASS_ID::OBJECT_MANAGER_IF;
|
||||||
static constexpr ReturnValue_t INSERTION_FAILED = MAKE_RETURN_CODE( 1 );
|
static constexpr ReturnValue_t INSERTION_FAILED = MAKE_RETURN_CODE( 1 );
|
||||||
static constexpr ReturnValue_t NOT_FOUND = MAKE_RETURN_CODE( 2 );
|
static constexpr ReturnValue_t NOT_FOUND = MAKE_RETURN_CODE( 2 );
|
||||||
|
|
||||||
static constexpr ReturnValue_t CHILD_INIT_FAILED = MAKE_RETURN_CODE( 3 ); //!< Can be used if the initialization of a SystemObject failed.
|
static constexpr ReturnValue_t CHILD_INIT_FAILED = MAKE_RETURN_CODE( 3 ); //!< Can be used if the initialization of a SystemObject failed.
|
||||||
static constexpr ReturnValue_t INTERNAL_ERR_REPORTER_UNINIT = MAKE_RETURN_CODE( 4 );
|
static constexpr ReturnValue_t INTERNAL_ERR_REPORTER_UNINIT = MAKE_RETURN_CODE( 4 );
|
||||||
|
|
||||||
@ -80,6 +79,7 @@ public:
|
|||||||
/**
|
/**
|
||||||
* @brief This is the forward declaration of the global objectManager instance.
|
* @brief This is the forward declaration of the global objectManager instance.
|
||||||
*/
|
*/
|
||||||
|
// SHOULDDO: maybe put this in the glob namespace to explicitely mark it global?
|
||||||
extern ObjectManagerIF *objectManager;
|
extern ObjectManagerIF *objectManager;
|
||||||
|
|
||||||
/*Documentation can be found in the class method declaration above.*/
|
/*Documentation can be found in the class method declaration above.*/
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
#include "../events/EventManagerIF.h"
|
|
||||||
#include "ObjectManager.h"
|
#include "ObjectManager.h"
|
||||||
#include "SystemObject.h"
|
#include "SystemObject.h"
|
||||||
|
#include "../events/EventManagerIF.h"
|
||||||
|
|
||||||
SystemObject::SystemObject(object_id_t setObjectId, bool doRegister) :
|
SystemObject::SystemObject(object_id_t setObjectId, bool doRegister) :
|
||||||
objectId(setObjectId), registered(doRegister) {
|
objectId(setObjectId), registered(doRegister) {
|
||||||
|
@ -1,16 +1,9 @@
|
|||||||
/**
|
#ifndef FSFW_OBJECTMANAGER_SYSTEMOBJECT_H_
|
||||||
* @file SystemObject.h
|
#define FSFW_OBJECTMANAGER_SYSTEMOBJECT_H_
|
||||||
* @brief This file contains the definition of the SystemObject class.
|
|
||||||
* @date 07.11.2012
|
|
||||||
* @author Ulrich Mohr
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SYSTEMOBJECT_H_
|
|
||||||
#define SYSTEMOBJECT_H_
|
|
||||||
|
|
||||||
|
#include "SystemObjectIF.h"
|
||||||
#include "../events/Event.h"
|
#include "../events/Event.h"
|
||||||
#include "../events/EventReportingProxyIF.h"
|
#include "../events/EventReportingProxyIF.h"
|
||||||
#include "SystemObjectIF.h"
|
|
||||||
#include "../timemanager/Clock.h"
|
#include "../timemanager/Clock.h"
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -20,7 +13,8 @@
|
|||||||
* class that is announced to ObjectManager. It automatically includes
|
* class that is announced to ObjectManager. It automatically includes
|
||||||
* itself (and therefore the inheriting class) in the object manager's
|
* itself (and therefore the inheriting class) in the object manager's
|
||||||
* list.
|
* list.
|
||||||
* \ingroup system_objects
|
* @author Ulrich Mohr
|
||||||
|
* @ingroup system_objects
|
||||||
*/
|
*/
|
||||||
class SystemObject: public SystemObjectIF {
|
class SystemObject: public SystemObjectIF {
|
||||||
private:
|
private:
|
||||||
@ -37,25 +31,28 @@ public:
|
|||||||
* @param parameter1
|
* @param parameter1
|
||||||
* @param parameter2
|
* @param parameter2
|
||||||
*/
|
*/
|
||||||
virtual void triggerEvent(Event event, uint32_t parameter1 = 0, uint32_t parameter2 = 0);
|
virtual void triggerEvent(Event event, uint32_t parameter1 = 0,
|
||||||
|
uint32_t parameter2 = 0);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief The class's constructor.
|
* @brief The class's constructor.
|
||||||
* @details In the constructor, the object id is set and the class is
|
* @details In the constructor, the object id is set and the class is
|
||||||
* inserted in the object manager.
|
* inserted in the object manager.
|
||||||
* @param setObjectId The id the object shall have.
|
* @param setObjectId The id the object shall have.
|
||||||
* @param doRegister Determines if the object is registered in the global object manager.
|
* @param doRegister Determines if the object is registered in
|
||||||
|
* the global object manager.
|
||||||
*/
|
*/
|
||||||
SystemObject(object_id_t setObjectId, bool doRegister = true);
|
SystemObject(object_id_t setObjectId, bool doRegister = true);
|
||||||
/**
|
/**
|
||||||
* @brief On destruction, the object removes itself from the list.
|
* @brief On destruction, the object removes itself from the list.
|
||||||
*/
|
*/
|
||||||
virtual ~SystemObject();
|
virtual ~SystemObject();
|
||||||
object_id_t getObjectId() const;
|
object_id_t getObjectId() const override;
|
||||||
virtual ReturnValue_t initialize();
|
virtual ReturnValue_t initialize() override;
|
||||||
virtual ReturnValue_t checkObjectConnections();
|
virtual ReturnValue_t checkObjectConnections();
|
||||||
|
|
||||||
virtual void forwardEvent(Event event, uint32_t parameter1 = 0, uint32_t parameter2 = 0) const;
|
virtual void forwardEvent(Event event, uint32_t parameter1 = 0,
|
||||||
|
uint32_t parameter2 = 0) const;
|
||||||
};
|
};
|
||||||
|
|
||||||
#endif /* SYSTEMOBJECT_H_ */
|
#endif /* FSFW_OBJECTMANAGER_SYSTEMOBJECT_H_ */
|
||||||
|
@ -1,26 +1,19 @@
|
|||||||
/**
|
#ifndef FSFW_OBJECTMANAGER_SYSTEMOBJECTIF_H_
|
||||||
* @file SystemObjectIF.h
|
#define FSFW_OBJECTMANAGER_SYSTEMOBJECTIF_H_
|
||||||
* @brief This file contains the definition of the SystemObjectIF interface.
|
|
||||||
* @date 18.09.2012
|
|
||||||
* @author Bastian Baetz
|
|
||||||
*/
|
|
||||||
|
|
||||||
#ifndef SYSTEMOBJECTIF_H_
|
|
||||||
#define SYSTEMOBJECTIF_H_
|
|
||||||
|
|
||||||
#include "../events/EventReportingProxyIF.h"
|
#include "../events/EventReportingProxyIF.h"
|
||||||
#include "../returnvalues/HasReturnvaluesIF.h"
|
#include "../returnvalues/HasReturnvaluesIF.h"
|
||||||
#include <stdint.h>
|
#include <cstdint>
|
||||||
/**
|
/**
|
||||||
* \defgroup system_objects Software System Object Management
|
* @defgroup system_objects Software System Object Management
|
||||||
* The classes to create System Objects and classes to manage these are contained in this group.
|
* The classes to create System Objects and classes to manage these are
|
||||||
* System Objects are software elements that can be controlled externally. They all have a unique
|
* contained in this group. System Objects are software elements that can be
|
||||||
* object identifier.
|
* controlled externally. They all have a unique object identifier.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This is the typedef for object identifiers.
|
* This is the typedef for object identifiers.
|
||||||
* \ingroup system_objects
|
* @ingroup system_objects
|
||||||
*/
|
*/
|
||||||
typedef uint32_t object_id_t;
|
typedef uint32_t object_id_t;
|
||||||
|
|
||||||
@ -29,7 +22,8 @@ typedef uint32_t object_id_t;
|
|||||||
* list.
|
* list.
|
||||||
* It does not provide any method definitions, still it is required to
|
* It does not provide any method definitions, still it is required to
|
||||||
* perform a type check with dynamic_cast.
|
* perform a type check with dynamic_cast.
|
||||||
* \ingroup system_objects
|
* @author Bastian Baetz
|
||||||
|
* @ingroup system_objects
|
||||||
*/
|
*/
|
||||||
class SystemObjectIF : public EventReportingProxyIF {
|
class SystemObjectIF : public EventReportingProxyIF {
|
||||||
public:
|
public:
|
||||||
@ -41,24 +35,28 @@ public:
|
|||||||
/**
|
/**
|
||||||
* The empty virtual destructor as required for C++ interfaces.
|
* The empty virtual destructor as required for C++ interfaces.
|
||||||
*/
|
*/
|
||||||
virtual ~SystemObjectIF() {
|
virtual ~SystemObjectIF() {}
|
||||||
}
|
|
||||||
/**
|
/**
|
||||||
* Initializes all inter-object dependencies.
|
* @brief Initializes the object.
|
||||||
* This is necessary to avoid circular dependencies of not-fully
|
* There are initialization steps which can also be done in the constructor.
|
||||||
* initialized objects on start up.
|
* However, there is no clean way to get a returnvalue from a constructor.
|
||||||
* @return - \c RETURN_OK in case the initialization was successful
|
* Furthermore some components require other system object to be created
|
||||||
* - \c RETURN_FAILED otherwise
|
* which might not have been built yet.
|
||||||
|
* Therefore, a two-step initialization resolves this problem and prevents
|
||||||
|
* circular dependencies of not-fully initialized objects on start up.
|
||||||
|
* @return - @c RETURN_OK in case the initialization was successful
|
||||||
|
* - @c RETURN_FAILED otherwise
|
||||||
*/
|
*/
|
||||||
virtual ReturnValue_t initialize() = 0;
|
virtual ReturnValue_t initialize() = 0;
|
||||||
/**
|
/**
|
||||||
* Checks, if all object-object interconnections are satisfying for operation.
|
* @brief Checks if all object-object interconnections are satisfying
|
||||||
* Some objects need certain other objects (or a certain number), to be registered as children.
|
* for operation.
|
||||||
* These checks can be done in this method.
|
* Some objects need certain other objects (or a certain number), to be
|
||||||
* @return - \c RETURN_OK in case the check was successful
|
* registered as children. These checks can be done in this method.
|
||||||
* - \c any other code otherwise
|
* @return - @c RETURN_OK in case the check was successful
|
||||||
|
* - @c any other code otherwise
|
||||||
*/
|
*/
|
||||||
virtual ReturnValue_t checkObjectConnections() = 0;
|
virtual ReturnValue_t checkObjectConnections() = 0;
|
||||||
};
|
};
|
||||||
|
|
||||||
#endif /* SYSTEMOBJECTIF_H_ */
|
#endif /* #ifndef FSFW_OBJECTMANAGER_SYSTEMOBJECTIF_H_ */
|
||||||
|
@ -1,8 +1,17 @@
|
|||||||
#ifndef FRAMEWORK_OBJECTMANAGER_FRAMEWORKOBJECTS_H_
|
#ifndef FSFW_OBJECTMANAGER_FRAMEWORKOBJECTS_H_
|
||||||
#define FRAMEWORK_OBJECTMANAGER_FRAMEWORKOBJECTS_H_
|
#define FSFW_OBJECTMANAGER_FRAMEWORKOBJECTS_H_
|
||||||
|
|
||||||
namespace objects {
|
namespace objects {
|
||||||
enum framework_objects {
|
enum framework_objects {
|
||||||
|
// Default verification reporter.
|
||||||
|
PUS_SERVICE_1 = 0x53000001,
|
||||||
|
PUS_SERVICE_2 = 0x53000002,
|
||||||
|
PUS_SERVICE_5 = 0x53000005,
|
||||||
|
PUS_SERVICE_8 = 0x53000008,
|
||||||
|
PUS_SERVICE_9 = 0x53000009,
|
||||||
|
PUS_SERVICE_17 = 0x53000017,
|
||||||
|
PUS_SERVICE_200 = 0x53000200,
|
||||||
|
|
||||||
//Generic IDs for IPC, modes, health, events
|
//Generic IDs for IPC, modes, health, events
|
||||||
HEALTH_TABLE = 0x53010000,
|
HEALTH_TABLE = 0x53010000,
|
||||||
// MODE_STORE = 0x53010100,
|
// MODE_STORE = 0x53010100,
|
||||||
@ -12,10 +21,11 @@ enum framework_objects {
|
|||||||
//IDs for PUS Packet Communication
|
//IDs for PUS Packet Communication
|
||||||
TC_STORE = 0x534f0100,
|
TC_STORE = 0x534f0100,
|
||||||
TM_STORE = 0x534f0200,
|
TM_STORE = 0x534f0200,
|
||||||
|
|
||||||
NO_OBJECT = 0xFFFFFFFF
|
NO_OBJECT = 0xFFFFFFFF
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#endif /* FRAMEWORK_OBJECTMANAGER_FRAMEWORKOBJECTS_H_ */
|
#endif /* FSFW_OBJECTMANAGER_FRAMEWORKOBJECTS_H_ */
|
||||||
|
@ -6,8 +6,8 @@
|
|||||||
#include <linux/sysinfo.h>
|
#include <linux/sysinfo.h>
|
||||||
#include <time.h>
|
#include <time.h>
|
||||||
#include <unistd.h>
|
#include <unistd.h>
|
||||||
|
#include <fstream>
|
||||||
|
|
||||||
//#include <fstream>
|
|
||||||
uint16_t Clock::leapSeconds = 0;
|
uint16_t Clock::leapSeconds = 0;
|
||||||
MutexIF* Clock::timeMutex = NULL;
|
MutexIF* Clock::timeMutex = NULL;
|
||||||
|
|
||||||
@ -76,22 +76,23 @@ timeval Clock::getUptime() {
|
|||||||
|
|
||||||
ReturnValue_t Clock::getUptime(timeval* uptime) {
|
ReturnValue_t Clock::getUptime(timeval* uptime) {
|
||||||
//TODO This is not posix compatible and delivers only seconds precision
|
//TODO This is not posix compatible and delivers only seconds precision
|
||||||
struct sysinfo sysInfo;
|
// is the OS not called Linux?
|
||||||
int result = sysinfo(&sysInfo);
|
|
||||||
if(result != 0){
|
|
||||||
return HasReturnvaluesIF::RETURN_FAILED;
|
|
||||||
}
|
|
||||||
uptime->tv_sec = sysInfo.uptime;
|
|
||||||
uptime->tv_usec = 0;
|
|
||||||
|
|
||||||
|
|
||||||
//Linux specific file read but more precise
|
//Linux specific file read but more precise
|
||||||
// double uptimeSeconds;
|
double uptimeSeconds;
|
||||||
// if(std::ifstream("/proc/uptime",std::ios::in) >> uptimeSeconds){
|
if(std::ifstream("/proc/uptime",std::ios::in) >> uptimeSeconds){
|
||||||
// uptime->tv_sec = uptimeSeconds;
|
uptime->tv_sec = uptimeSeconds;
|
||||||
// uptime->tv_usec = uptimeSeconds *(double) 1e6 - (uptime->tv_sec *1e6);
|
uptime->tv_usec = uptimeSeconds *(double) 1e6 - (uptime->tv_sec *1e6);
|
||||||
// }
|
}
|
||||||
|
|
||||||
|
//TODO This is not posix compatible and delivers only seconds precision
|
||||||
|
// I suggest this is moved into another clock function which will
|
||||||
|
// deliver second precision later.
|
||||||
|
// struct sysinfo sysInfo;
|
||||||
|
// int result = sysinfo(&sysInfo);
|
||||||
|
// if(result != 0){
|
||||||
|
// return HasReturnvaluesIF::RETURN_FAILED;
|
||||||
|
// }
|
||||||
|
// return sysInfo.uptime;
|
||||||
return HasReturnvaluesIF::RETURN_OK;
|
return HasReturnvaluesIF::RETURN_OK;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
41
pus/Service17Test.cpp
Normal file
41
pus/Service17Test.cpp
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
#include "Service17Test.h"
|
||||||
|
|
||||||
|
#include "../serviceinterface/ServiceInterfaceStream.h"
|
||||||
|
#include "../objectmanager/SystemObject.h"
|
||||||
|
#include "../tmtcpacket/pus/TmPacketStored.h"
|
||||||
|
|
||||||
|
|
||||||
|
Service17Test::Service17Test(object_id_t objectId,
|
||||||
|
uint16_t apid, uint8_t serviceId):
|
||||||
|
PusServiceBase(objectId, apid, serviceId),
|
||||||
|
packetSubCounter(0) {
|
||||||
|
}
|
||||||
|
|
||||||
|
Service17Test::~Service17Test() {
|
||||||
|
}
|
||||||
|
|
||||||
|
ReturnValue_t Service17Test::handleRequest(uint8_t subservice) {
|
||||||
|
switch(subservice){
|
||||||
|
case Subservice::CONNECTION_TEST: {
|
||||||
|
TmPacketStored connectionPacket(apid, serviceId,
|
||||||
|
Subservice::CONNECTION_TEST_REPORT, packetSubCounter++);
|
||||||
|
connectionPacket.sendPacket(requestQueue->getDefaultDestination(),
|
||||||
|
requestQueue->getId());
|
||||||
|
return HasReturnvaluesIF::RETURN_OK;
|
||||||
|
}
|
||||||
|
case Subservice::EVENT_TRIGGER_TEST: {
|
||||||
|
TmPacketStored connectionPacket(apid, serviceId,
|
||||||
|
Subservice::CONNECTION_TEST_REPORT, packetSubCounter++);
|
||||||
|
connectionPacket.sendPacket(requestQueue->getDefaultDestination(),
|
||||||
|
requestQueue->getId());
|
||||||
|
triggerEvent(TEST, 1234, 5678);
|
||||||
|
return RETURN_OK;
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
return AcceptsTelecommandsIF::INVALID_SUBSERVICE;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
ReturnValue_t Service17Test::performService() {
|
||||||
|
return HasReturnvaluesIF::RETURN_OK;
|
||||||
|
}
|
44
pus/Service17Test.h
Normal file
44
pus/Service17Test.h
Normal file
@ -0,0 +1,44 @@
|
|||||||
|
#ifndef FSFW_PUS_SERVICE17TEST_H_
|
||||||
|
#define FSFW_PUS_SERVICE17TEST_H_
|
||||||
|
|
||||||
|
#include "../tmtcservices/PusServiceBase.h"
|
||||||
|
#include "../objectmanager/SystemObject.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Test Service
|
||||||
|
* Full Documentation: ECSS-E70-41A p.167
|
||||||
|
*
|
||||||
|
* The test service provides the capability to activate test functions
|
||||||
|
* implemented on-board and to report the results of such tests.
|
||||||
|
* Service capability:
|
||||||
|
* - TC[17,1]: Perform connection test
|
||||||
|
* - TM[17,2]: Send Connection Test Report
|
||||||
|
* - TC[17,128]: Perform connection test and trigger event
|
||||||
|
*
|
||||||
|
* @ingroup pus_services
|
||||||
|
*/
|
||||||
|
class Service17Test: public PusServiceBase {
|
||||||
|
public:
|
||||||
|
// Custom events which can be triggered
|
||||||
|
static constexpr uint8_t SUBSYSTEM_ID = SUBSYSTEM_ID::PUS_SERVICE_17;
|
||||||
|
static constexpr Event TEST = MAKE_EVENT(0, SEVERITY::INFO);
|
||||||
|
|
||||||
|
enum Subservice: uint8_t {
|
||||||
|
//! [EXPORT] : [COMMAND] Perform connection test
|
||||||
|
CONNECTION_TEST = 1,
|
||||||
|
//! [EXPORT] : [REPLY] Connection test reply
|
||||||
|
CONNECTION_TEST_REPORT = 2,
|
||||||
|
//! [EXPORT] : [COMMAND] Trigger test reply and test event
|
||||||
|
EVENT_TRIGGER_TEST = 128,
|
||||||
|
};
|
||||||
|
|
||||||
|
Service17Test(object_id_t objectId, uint16_t apid, uint8_t serviceId);
|
||||||
|
virtual ~Service17Test();
|
||||||
|
virtual ReturnValue_t handleRequest(uint8_t subservice) override;
|
||||||
|
virtual ReturnValue_t performService() override;
|
||||||
|
|
||||||
|
protected:
|
||||||
|
uint16_t packetSubCounter = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif /* FSFW_PUS_SERVICE17TEST_H_ */
|
58
pus/Service9TimeManagement.cpp
Normal file
58
pus/Service9TimeManagement.cpp
Normal file
@ -0,0 +1,58 @@
|
|||||||
|
#include "Service9TimeManagement.h"
|
||||||
|
#include "servicepackets/Service9Packets.h"
|
||||||
|
|
||||||
|
#include "../timemanager/CCSDSTime.h"
|
||||||
|
#include "../events/EventManagerIF.h"
|
||||||
|
#include "../serviceinterface/ServiceInterfaceStream.h"
|
||||||
|
|
||||||
|
|
||||||
|
Service9TimeManagement::Service9TimeManagement(object_id_t objectId,
|
||||||
|
uint16_t apid, uint8_t serviceId) :
|
||||||
|
PusServiceBase(objectId, apid , serviceId) {
|
||||||
|
}
|
||||||
|
|
||||||
|
Service9TimeManagement::~Service9TimeManagement() {}
|
||||||
|
|
||||||
|
ReturnValue_t Service9TimeManagement::performService() {
|
||||||
|
return RETURN_OK;
|
||||||
|
}
|
||||||
|
|
||||||
|
ReturnValue_t Service9TimeManagement::handleRequest(uint8_t subservice) {
|
||||||
|
switch(subservice){
|
||||||
|
case SUBSERVICE::SET_TIME:{
|
||||||
|
return setTime();
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
return AcceptsTelecommandsIF::INVALID_SUBSERVICE;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
ReturnValue_t Service9TimeManagement::setTime() {
|
||||||
|
Clock::TimeOfDay_t timeToSet;
|
||||||
|
TimePacket timePacket(currentPacket.getApplicationData(),
|
||||||
|
currentPacket.getApplicationDataSize());
|
||||||
|
ReturnValue_t result = CCSDSTime::convertFromCcsds(&timeToSet,
|
||||||
|
timePacket.getTime(), timePacket.getTimeSize());
|
||||||
|
if(result != RETURN_OK) {
|
||||||
|
triggerEvent(CLOCK_SET_FAILURE, result, 0);
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
uint32_t formerUptime;
|
||||||
|
Clock::getUptime(&formerUptime);
|
||||||
|
result = Clock::setClock(&timeToSet);
|
||||||
|
|
||||||
|
if(result == RETURN_OK) {
|
||||||
|
uint32_t newUptime;
|
||||||
|
Clock::getUptime(&newUptime);
|
||||||
|
triggerEvent(CLOCK_SET,newUptime,formerUptime);
|
||||||
|
return RETURN_OK;
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
triggerEvent(CLOCK_SET_FAILURE, result, 0);
|
||||||
|
return RETURN_FAILED;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
41
pus/Service9TimeManagement.h
Normal file
41
pus/Service9TimeManagement.h
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
#ifndef FSFW_PUS_SERVICE9TIMEMANAGEMENT_H_
|
||||||
|
#define FSFW_PUS_SERVICE9TIMEMANAGEMENT_H_
|
||||||
|
|
||||||
|
#include "../tmtcservices/PusServiceBase.h"
|
||||||
|
|
||||||
|
class Service9TimeManagement: public PusServiceBase {
|
||||||
|
public:
|
||||||
|
|
||||||
|
static constexpr uint8_t SUBSYSTEM_ID = SUBSYSTEM_ID::PUS_SERVICE_9;
|
||||||
|
static constexpr Event CLOCK_SET = MAKE_EVENT(0, SEVERITY::INFO); //!< Clock has been set. P1: New Uptime. P2: Old Uptime
|
||||||
|
static constexpr Event CLOCK_SET_FAILURE = MAKE_EVENT(1, SEVERITY::LOW); //!< Clock could not be set. P1: Returncode.
|
||||||
|
|
||||||
|
static constexpr uint8_t CLASS_ID = CLASS_ID::PUS_SERVICE_9;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief This service provides the capability to set the on-board time.
|
||||||
|
*/
|
||||||
|
Service9TimeManagement(object_id_t objectId, uint16_t apid,
|
||||||
|
uint8_t serviceId);
|
||||||
|
|
||||||
|
virtual ~Service9TimeManagement();
|
||||||
|
|
||||||
|
virtual ReturnValue_t performService() override;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Sets the onboard-time by retrieving the time to set from TC[9,128].
|
||||||
|
*/
|
||||||
|
virtual ReturnValue_t handleRequest(uint8_t subservice) override;
|
||||||
|
|
||||||
|
virtual ReturnValue_t setTime();
|
||||||
|
private:
|
||||||
|
|
||||||
|
enum SUBSERVICE {
|
||||||
|
SET_TIME = 128 //!< [EXPORT] : [COMMAND] Time command in ASCII, CUC or CDS format
|
||||||
|
};
|
||||||
|
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#endif /* FSFW_PUS_SERVICE9TIMEMANAGEMENT_H_ */
|
32
pus/servicepackets/Service9Packets.h
Normal file
32
pus/servicepackets/Service9Packets.h
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
#ifndef FSFW_PUS_SERVICEPACKETS_SERVICE9PACKETS_H_
|
||||||
|
#define FSFW_PUS_SERVICEPACKETS_SERVICE9PACKETS_H_
|
||||||
|
|
||||||
|
#include "../../serialize/SerialLinkedListAdapter.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Subservice 128
|
||||||
|
* @details
|
||||||
|
* It only contains the time encoded as ASCII, CRC, CUC or CDS
|
||||||
|
* @ingroup spacepackets
|
||||||
|
*/
|
||||||
|
class TimePacket : SerialLinkedListAdapter<SerializeIF> { //!< [EXPORT] : [SUBSERVICE] 128
|
||||||
|
public:
|
||||||
|
TimePacket(const uint8_t * timeBuffer_, uint32_t timeSize_) {
|
||||||
|
timeBuffer = timeBuffer_;
|
||||||
|
timeSize = timeSize_;
|
||||||
|
}
|
||||||
|
const uint8_t* getTime() {
|
||||||
|
return timeBuffer;
|
||||||
|
}
|
||||||
|
|
||||||
|
uint32_t getTimeSize() const {
|
||||||
|
return timeSize;
|
||||||
|
}
|
||||||
|
|
||||||
|
private:
|
||||||
|
TimePacket(const TimePacket &command);
|
||||||
|
const uint8_t * timeBuffer;
|
||||||
|
uint32_t timeSize; //!< [EXPORT] : [IGNORE]
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif /* FSFW_PUS_SERVICEPACKETS_SERVICE9PACKETS_H_ */
|
@ -1,5 +1,5 @@
|
|||||||
#ifndef FRAMEWORK_RETURNVALUES_FWCLASSIDS_H_
|
#ifndef FSFW_RETURNVALUES_FWCLASSIDS_H_
|
||||||
#define FRAMEWORK_RETURNVALUES_FWCLASSIDS_H_
|
#define FSFW_RETURNVALUES_FWCLASSIDS_H_
|
||||||
|
|
||||||
namespace CLASS_ID {
|
namespace CLASS_ID {
|
||||||
enum {
|
enum {
|
||||||
@ -65,9 +65,10 @@ enum {
|
|||||||
POOL_VARIABLE_IF, //PVA 59
|
POOL_VARIABLE_IF, //PVA 59
|
||||||
HOUSEKEEPING_MANAGER, //HKM 60
|
HOUSEKEEPING_MANAGER, //HKM 60
|
||||||
DLE_ENCODER, //DLEE 61
|
DLE_ENCODER, //DLEE 61
|
||||||
|
PUS_SERVICE_9, //PUS9 62
|
||||||
FW_CLASS_ID_COUNT //is actually count + 1 !
|
FW_CLASS_ID_COUNT //is actually count + 1 !
|
||||||
|
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
#endif /* FRAMEWORK_RETURNVALUES_FWCLASSIDS_H_ */
|
#endif /* FSFW_RETURNVALUES_FWCLASSIDS_H_ */
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
#ifndef ENDIANSWAPPER_H_
|
#ifndef FSFW_SERIALIZE_ENDIANCONVERTER_H_
|
||||||
#define ENDIANSWAPPER_H_
|
#define FSFW_SERIALIZE_ENDIANCONVERTER_H_
|
||||||
|
|
||||||
#include "../osal/Endiness.h"
|
#include "../osal/Endiness.h"
|
||||||
#include <cstring>
|
#include <cstring>
|
||||||
@ -35,9 +35,7 @@
|
|||||||
*/
|
*/
|
||||||
class EndianConverter {
|
class EndianConverter {
|
||||||
private:
|
private:
|
||||||
EndianConverter() {
|
EndianConverter() {};
|
||||||
}
|
|
||||||
;
|
|
||||||
public:
|
public:
|
||||||
/**
|
/**
|
||||||
* Convert a typed variable between big endian and machine endian.
|
* Convert a typed variable between big endian and machine endian.
|
||||||
@ -123,4 +121,4 @@ public:
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
#endif /* ENDIANSWAPPER_H_ */
|
#endif /* FSFW_SERIALIZE_ENDIANCONVERTER_H_ */
|
||||||
|
@ -1,13 +1,14 @@
|
|||||||
#ifndef FRAMEWORK_SERIALIZE_SERIALARRAYLISTADAPTER_H_
|
#ifndef FSFW_SERIALIZE_SERIALARRAYLISTADAPTER_H_
|
||||||
#define FRAMEWORK_SERIALIZE_SERIALARRAYLISTADAPTER_H_
|
#define FSFW_SERIALIZE_SERIALARRAYLISTADAPTER_H_
|
||||||
|
|
||||||
#include "../container/ArrayList.h"
|
|
||||||
#include "SerializeIF.h"
|
#include "SerializeIF.h"
|
||||||
|
#include "../container/ArrayList.h"
|
||||||
#include <utility>
|
#include <utility>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @ingroup serialize
|
* Also serializes length field !
|
||||||
* @author baetz
|
* @author baetz
|
||||||
|
* @ingroup serialize
|
||||||
*/
|
*/
|
||||||
template<typename T, typename count_t = uint8_t>
|
template<typename T, typename count_t = uint8_t>
|
||||||
class SerialArrayListAdapter : public SerializeIF {
|
class SerialArrayListAdapter : public SerializeIF {
|
||||||
@ -27,8 +28,8 @@ public:
|
|||||||
buffer, size, maxSize, streamEndianness);
|
buffer, size, maxSize, streamEndianness);
|
||||||
count_t i = 0;
|
count_t i = 0;
|
||||||
while ((result == HasReturnvaluesIF::RETURN_OK) && (i < list->size)) {
|
while ((result == HasReturnvaluesIF::RETURN_OK) && (i < list->size)) {
|
||||||
result = SerializeAdapter::serialize(&list->entries[i], buffer,
|
result = SerializeAdapter::serialize(&list->entries[i], buffer, size,
|
||||||
size, maxSize, streamEndianness);
|
maxSize, streamEndianness);
|
||||||
++i;
|
++i;
|
||||||
}
|
}
|
||||||
return result;
|
return result;
|
||||||
@ -66,6 +67,7 @@ public:
|
|||||||
if (tempSize > list->maxSize()) {
|
if (tempSize > list->maxSize()) {
|
||||||
return SerializeIF::TOO_MANY_ELEMENTS;
|
return SerializeIF::TOO_MANY_ELEMENTS;
|
||||||
}
|
}
|
||||||
|
|
||||||
list->size = tempSize;
|
list->size = tempSize;
|
||||||
count_t i = 0;
|
count_t i = 0;
|
||||||
while ((result == HasReturnvaluesIF::RETURN_OK) && (i < list->size)) {
|
while ((result == HasReturnvaluesIF::RETURN_OK) && (i < list->size)) {
|
||||||
@ -76,10 +78,9 @@ public:
|
|||||||
}
|
}
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
private:
|
private:
|
||||||
ArrayList<T, count_t> *adaptee;
|
ArrayList<T, count_t> *adaptee;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
#endif /* FSFW_SERIALIZE_SERIALARRAYLISTADAPTER_H_ */
|
||||||
|
|
||||||
#endif /* FRAMEWORK_SERIALIZE_SERIALARRAYLISTADAPTER_H_ */
|
|
||||||
|
@ -1,31 +1,57 @@
|
|||||||
#ifndef SERIALFIXEDARRAYLISTADAPTER_H_
|
#ifndef FSFW_SERIALIZE_SERIALFIXEDARRAYLISTADAPTER_H_
|
||||||
#define SERIALFIXEDARRAYLISTADAPTER_H_
|
#define FSFW_SERIALIZE_SERIALFIXEDARRAYLISTADAPTER_H_
|
||||||
|
|
||||||
#include "../container/FixedArrayList.h"
|
|
||||||
#include "SerialArrayListAdapter.h"
|
#include "SerialArrayListAdapter.h"
|
||||||
|
#include "../container/FixedArrayList.h"
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \ingroup serialize
|
* @brief This adapter provides an interface for SerializeIF to serialize and
|
||||||
|
* deserialize buffers with a header containing the buffer length.
|
||||||
|
* @details
|
||||||
|
* Can be used by SerialLinkedListAdapter by declaring
|
||||||
|
* as a linked element with SerializeElement<SerialFixedArrayListAdapter<...>>.
|
||||||
|
* The sequence of objects is defined in the constructor by
|
||||||
|
* using the setStart and setNext functions.
|
||||||
|
*
|
||||||
|
* @tparam BUFFER_TYPE: Specifies the data type of the buffer
|
||||||
|
* @tparam MAX_SIZE: Specifies the maximum allowed number of elements
|
||||||
|
* (not bytes!)
|
||||||
|
* @tparam count_t: specifies the type/size of the length field which defaults
|
||||||
|
* to one byte.
|
||||||
|
* @ingroup serialize
|
||||||
*/
|
*/
|
||||||
template<typename T, uint32_t MAX_SIZE, typename count_t = uint8_t>
|
template<typename BUFFER_TYPE, uint32_t MAX_SIZE, typename count_t = uint8_t>
|
||||||
class SerialFixedArrayListAdapter : public FixedArrayList<T, MAX_SIZE, count_t>, public SerializeIF {
|
class SerialFixedArrayListAdapter :
|
||||||
|
public FixedArrayList<BUFFER_TYPE, MAX_SIZE, count_t>,
|
||||||
|
public SerializeIF {
|
||||||
public:
|
public:
|
||||||
|
/**
|
||||||
|
* Constructor arguments are forwarded to FixedArrayList constructor.
|
||||||
|
* Refer to the fixed array list constructors for different options.
|
||||||
|
* @param args
|
||||||
|
*/
|
||||||
template<typename... Args>
|
template<typename... Args>
|
||||||
SerialFixedArrayListAdapter(Args... args) : FixedArrayList<T, MAX_SIZE, count_t>(std::forward<Args>(args)...) {
|
SerialFixedArrayListAdapter(Args... args) :
|
||||||
}
|
FixedArrayList<BUFFER_TYPE, MAX_SIZE, count_t>(
|
||||||
|
std::forward<Args>(args)...){}
|
||||||
|
|
||||||
ReturnValue_t serialize(uint8_t** buffer, size_t* size,
|
ReturnValue_t serialize(uint8_t** buffer, size_t* size,
|
||||||
size_t maxSize, Endianness streamEndianness) const {
|
size_t maxSize, Endianness streamEndianness) const {
|
||||||
return SerialArrayListAdapter<T, count_t>::serialize(this, buffer, size, maxSize, streamEndianness);
|
return SerialArrayListAdapter<BUFFER_TYPE, count_t>::serialize(this,
|
||||||
|
buffer, size, maxSize, streamEndianness);
|
||||||
}
|
}
|
||||||
|
|
||||||
size_t getSerializedSize() const {
|
size_t getSerializedSize() const {
|
||||||
return SerialArrayListAdapter<T, count_t>::getSerializedSize(this);
|
return SerialArrayListAdapter<BUFFER_TYPE, count_t>::
|
||||||
|
getSerializedSize(this);
|
||||||
}
|
}
|
||||||
|
|
||||||
ReturnValue_t deSerialize(const uint8_t** buffer, size_t* size,
|
ReturnValue_t deSerialize(const uint8_t** buffer, size_t* size,
|
||||||
Endianness streamEndianness) {
|
Endianness streamEndianness) {
|
||||||
return SerialArrayListAdapter<T, count_t>::deSerialize(this, buffer, size, streamEndianness);
|
return SerialArrayListAdapter<BUFFER_TYPE, count_t>::deSerialize(this,
|
||||||
|
buffer, size, streamEndianness);
|
||||||
}
|
}
|
||||||
|
|
||||||
};
|
};
|
||||||
|
|
||||||
|
#endif /* FSFW_SERIALIZE_SERIALFIXEDARRAYLISTADAPTER_H_ */
|
||||||
|
|
||||||
#endif /* SERIALFIXEDARRAYLISTADAPTER_H_ */
|
|
||||||
|
@ -1,32 +1,52 @@
|
|||||||
/**
|
#ifndef FSFW_SERIALIZE_SERIALLINKEDLISTADAPTER_H_
|
||||||
* @file SerialLinkedListAdapter.h
|
#define FSFW_SERIALIZE_SERIALLINKEDLISTADAPTER_H_
|
||||||
* @brief This file defines the SerialLinkedListAdapter class.
|
|
||||||
* @date 22.07.2014
|
|
||||||
* @author baetz
|
|
||||||
*/
|
|
||||||
#ifndef SERIALLINKEDLISTADAPTER_H_
|
|
||||||
#define SERIALLINKEDLISTADAPTER_H_
|
|
||||||
|
|
||||||
#include "../container/SinglyLinkedList.h"
|
#include "../container/SinglyLinkedList.h"
|
||||||
#include "SerializeAdapter.h"
|
#include "SerializeAdapter.h"
|
||||||
#include "SerializeElement.h"
|
#include "SerializeElement.h"
|
||||||
#include "SerializeIF.h"
|
#include "SerializeIF.h"
|
||||||
//This is where we need the SerializeAdapter!
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \ingroup serialize
|
* @brief Implement the conversion of object data to data streams
|
||||||
|
* or vice-versa, using linked lists.
|
||||||
|
* @details
|
||||||
|
* An alternative to the AutoSerializeAdapter functions
|
||||||
|
* - All object members with a datatype are declared as
|
||||||
|
* SerializeElement<element_type> members inside the class
|
||||||
|
* implementing this adapter.
|
||||||
|
* - The element type can also be a SerialBufferAdapter to
|
||||||
|
* de-/serialize buffers.
|
||||||
|
* - The element type can also be a SerialFixedArrayListAdapter to
|
||||||
|
* de-/serialize buffers with a size header, which is scanned automatically.
|
||||||
|
*
|
||||||
|
* The sequence of objects is defined in the constructor by using
|
||||||
|
* the setStart and setNext functions.
|
||||||
|
*
|
||||||
|
* 1. The serialization process is done by instantiating the class and
|
||||||
|
* calling serialize after all SerializeElement entries have been set by
|
||||||
|
* using the constructor or setter functions. An additional size variable
|
||||||
|
* can be supplied which is calculated/incremented automatically.
|
||||||
|
* 2. The deserialization process is done by instantiating the class and
|
||||||
|
* supplying a buffer with the data which is converted into an object.
|
||||||
|
* The size of data to serialize can be supplied and is
|
||||||
|
* decremented in the function. Range checking is done internally.
|
||||||
|
* @author baetz
|
||||||
|
* @ingroup serialize
|
||||||
*/
|
*/
|
||||||
template<typename T, typename count_t = uint8_t>
|
template<typename T, typename count_t = uint8_t>
|
||||||
class SerialLinkedListAdapter: public SinglyLinkedList<T>, public SerializeIF {
|
class SerialLinkedListAdapter: public SinglyLinkedList<T>, public SerializeIF {
|
||||||
public:
|
public:
|
||||||
|
|
||||||
SerialLinkedListAdapter(typename LinkedElement<T>::Iterator start,
|
SerialLinkedListAdapter(typename LinkedElement<T>::Iterator start,
|
||||||
bool printCount = false) :
|
bool printCount = false) :
|
||||||
SinglyLinkedList<T>(start), printCount(printCount) {
|
SinglyLinkedList<T>(start), printCount(printCount) {
|
||||||
}
|
}
|
||||||
|
|
||||||
SerialLinkedListAdapter(LinkedElement<T>* first, bool printCount = false) :
|
SerialLinkedListAdapter(LinkedElement<T>* first, bool printCount = false) :
|
||||||
SinglyLinkedList<T>(first), printCount(printCount) {
|
SinglyLinkedList<T>(first), printCount(printCount) {
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
SerialLinkedListAdapter(bool printCount = false) :
|
SerialLinkedListAdapter(bool printCount = false) :
|
||||||
SinglyLinkedList<T>(), printCount(printCount) {
|
SinglyLinkedList<T>(), printCount(printCount) {
|
||||||
}
|
}
|
||||||
@ -49,13 +69,14 @@ public:
|
|||||||
uint8_t** buffer, size_t* size, size_t maxSize,
|
uint8_t** buffer, size_t* size, size_t maxSize,
|
||||||
Endianness streamEndianness) {
|
Endianness streamEndianness) {
|
||||||
ReturnValue_t result = HasReturnvaluesIF::RETURN_OK;
|
ReturnValue_t result = HasReturnvaluesIF::RETURN_OK;
|
||||||
while ((result == HasReturnvaluesIF::RETURN_OK) && (element != NULL)) {
|
while ((result == HasReturnvaluesIF::RETURN_OK) and (element != nullptr)) {
|
||||||
result = element->value->serialize(buffer, size, maxSize,
|
result = element->value->serialize(buffer, size, maxSize,
|
||||||
streamEndianness);
|
streamEndianness);
|
||||||
element = element->getNext();
|
element = element->getNext();
|
||||||
}
|
}
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
virtual size_t getSerializedSize() const override {
|
virtual size_t getSerializedSize() const override {
|
||||||
if (printCount) {
|
if (printCount) {
|
||||||
return SerialLinkedListAdapter<T>::getSerializedSize()
|
return SerialLinkedListAdapter<T>::getSerializedSize()
|
||||||
@ -64,32 +85,44 @@ public:
|
|||||||
return getSerializedSize(SinglyLinkedList<T>::start);
|
return getSerializedSize(SinglyLinkedList<T>::start);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
static size_t getSerializedSize(const LinkedElement<T> *element) {
|
static size_t getSerializedSize(const LinkedElement<T> *element) {
|
||||||
size_t size = 0;
|
size_t size = 0;
|
||||||
while (element != NULL) {
|
while (element != nullptr) {
|
||||||
size += element->value->getSerializedSize();
|
size += element->value->getSerializedSize();
|
||||||
element = element->getNext();
|
element = element->getNext();
|
||||||
}
|
}
|
||||||
return size;
|
return size;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
virtual ReturnValue_t deSerialize(const uint8_t** buffer, size_t* size,
|
virtual ReturnValue_t deSerialize(const uint8_t** buffer, size_t* size,
|
||||||
Endianness streamEndianness) override {
|
Endianness streamEndianness) override {
|
||||||
return deSerialize(SinglyLinkedList<T>::start, buffer, size, streamEndianness);
|
return deSerialize(SinglyLinkedList<T>::start, buffer, size,
|
||||||
|
streamEndianness);
|
||||||
}
|
}
|
||||||
|
|
||||||
static ReturnValue_t deSerialize(LinkedElement<T>* element,
|
static ReturnValue_t deSerialize(LinkedElement<T>* element,
|
||||||
const uint8_t** buffer, size_t* size, Endianness streamEndianness) {
|
const uint8_t** buffer, size_t* size, Endianness streamEndianness) {
|
||||||
ReturnValue_t result = HasReturnvaluesIF::RETURN_OK;
|
ReturnValue_t result = HasReturnvaluesIF::RETURN_OK;
|
||||||
while ((result == HasReturnvaluesIF::RETURN_OK) && (element != NULL)) {
|
while ((result == HasReturnvaluesIF::RETURN_OK) and (element != nullptr)) {
|
||||||
result = element->value->deSerialize(buffer, size, streamEndianness);
|
result = element->value->deSerialize(buffer, size, streamEndianness);
|
||||||
element = element->getNext();
|
element = element->getNext();
|
||||||
}
|
}
|
||||||
return result;
|
return result;
|
||||||
}
|
}
|
||||||
|
|
||||||
bool printCount;
|
/**
|
||||||
|
* Copying is forbidden by deleting the copy constructor and the copy
|
||||||
|
* assignment operator because of the pointers to the linked list members.
|
||||||
|
* Unless the child class implements an own copy constructor or
|
||||||
|
* copy assignment operator, these operation will throw a compiler error.
|
||||||
|
* @param
|
||||||
|
*/
|
||||||
|
SerialLinkedListAdapter(const SerialLinkedListAdapter &) = delete;
|
||||||
|
SerialLinkedListAdapter& operator=(const SerialLinkedListAdapter&) = delete;
|
||||||
|
|
||||||
|
bool printCount;
|
||||||
};
|
};
|
||||||
|
|
||||||
#endif /* SERIALLINKEDLISTADAPTER_H_ */
|
#endif /* FSFW_SERIALIZE_SERIALLINKEDLISTADAPTER_H_ */
|
||||||
|
@ -8,16 +8,25 @@
|
|||||||
#include <type_traits>
|
#include <type_traits>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \ingroup serialize
|
* @brief These adapters provides an interface to use the SerializeIF functions
|
||||||
|
* with arbitrary template objects to facilitate and simplify the
|
||||||
|
* serialization of classes with different multiple different data types
|
||||||
|
* into buffers and vice-versa.
|
||||||
|
* @details
|
||||||
|
* The correct serialization or deserialization function is chosen at
|
||||||
|
* compile time with template type deduction.
|
||||||
|
*
|
||||||
|
* @ingroup serialize
|
||||||
*/
|
*/
|
||||||
|
|
||||||
class SerializeAdapter {
|
class SerializeAdapter {
|
||||||
public:
|
public:
|
||||||
/***
|
/***
|
||||||
* This function can be used to serialize a trivial copy-able type or a child of SerializeIF.
|
* This function can be used to serialize a trivial copy-able type or a
|
||||||
|
* child of SerializeIF.
|
||||||
* The right template to be called is determined in the function itself.
|
* The right template to be called is determined in the function itself.
|
||||||
* For objects of non trivial copy-able type this function is almost never called by the user directly.
|
* For objects of non trivial copy-able type this function is almost never
|
||||||
* Instead helpers for specific types like SerialArrayListAdapter or SerialLinkedListAdapter is the right choice here.
|
* called by the user directly. Instead helpers for specific types like
|
||||||
|
* SerialArrayListAdapter or SerialLinkedListAdapter is the right choice here.
|
||||||
*
|
*
|
||||||
* @param[in] object Object to serialize, the used type is deduced from this pointer
|
* @param[in] object Object to serialize, the used type is deduced from this pointer
|
||||||
* @param[in/out] buffer Buffer to serialize into. Will be moved by the function.
|
* @param[in/out] buffer Buffer to serialize into. Will be moved by the function.
|
||||||
@ -86,7 +95,8 @@ private:
|
|||||||
template<typename T>
|
template<typename T>
|
||||||
class InternalSerializeAdapter<T, false> {
|
class InternalSerializeAdapter<T, false> {
|
||||||
static_assert (std::is_trivially_copyable<T>::value,
|
static_assert (std::is_trivially_copyable<T>::value,
|
||||||
"If a type needs to be serialized it must be a child of SerializeIF or trivially copy-able");
|
"If a type needs to be serialized it must be a child of "
|
||||||
|
"SerializeIF or trivially copy-able");
|
||||||
public:
|
public:
|
||||||
static ReturnValue_t serialize(const T *object, uint8_t **buffer,
|
static ReturnValue_t serialize(const T *object, uint8_t **buffer,
|
||||||
size_t *size, size_t max_size,
|
size_t *size, size_t max_size,
|
||||||
@ -95,7 +105,8 @@ private:
|
|||||||
if (size == nullptr) {
|
if (size == nullptr) {
|
||||||
size = &ignoredSize;
|
size = &ignoredSize;
|
||||||
}
|
}
|
||||||
//Check remaining size is large enough and check integer overflow of *size
|
// Check remaining size is large enough and check integer
|
||||||
|
// overflow of *size
|
||||||
size_t newSize = sizeof(T) + *size;
|
size_t newSize = sizeof(T) + *size;
|
||||||
if ((newSize <= max_size) and (newSize > *size)) {
|
if ((newSize <= max_size) and (newSize > *size)) {
|
||||||
T tmp;
|
T tmp;
|
||||||
@ -111,7 +122,7 @@ private:
|
|||||||
tmp = *object;
|
tmp = *object;
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
memcpy(*buffer, &tmp, sizeof(T));
|
std::memcpy(*buffer, &tmp, sizeof(T));
|
||||||
*size += sizeof(T);
|
*size += sizeof(T);
|
||||||
(*buffer) += sizeof(T);
|
(*buffer) += sizeof(T);
|
||||||
return HasReturnvaluesIF::RETURN_OK;
|
return HasReturnvaluesIF::RETURN_OK;
|
||||||
@ -125,7 +136,7 @@ private:
|
|||||||
T tmp;
|
T tmp;
|
||||||
if (*size >= sizeof(T)) {
|
if (*size >= sizeof(T)) {
|
||||||
*size -= sizeof(T);
|
*size -= sizeof(T);
|
||||||
memcpy(&tmp, *buffer, sizeof(T));
|
std::memcpy(&tmp, *buffer, sizeof(T));
|
||||||
switch (streamEndianness) {
|
switch (streamEndianness) {
|
||||||
case SerializeIF::Endianness::BIG:
|
case SerializeIF::Endianness::BIG:
|
||||||
*object = EndianConverter::convertBigEndian<T>(tmp);
|
*object = EndianConverter::convertBigEndian<T>(tmp);
|
||||||
|
@ -1,12 +1,20 @@
|
|||||||
#ifndef SERIALIZEELEMENT_H_
|
#ifndef FSFW_SERIALIZE_SERIALIZEELEMENT_H_
|
||||||
#define SERIALIZEELEMENT_H_
|
#define FSFW_SERIALIZE_SERIALIZEELEMENT_H_
|
||||||
|
|
||||||
#include "../container/SinglyLinkedList.h"
|
|
||||||
#include "SerializeAdapter.h"
|
#include "SerializeAdapter.h"
|
||||||
|
#include "../container/SinglyLinkedList.h"
|
||||||
#include <utility>
|
#include <utility>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \ingroup serialize
|
* @brief This class is used to mark datatypes for serialization with the
|
||||||
|
* SerialLinkedListAdapter
|
||||||
|
* @details
|
||||||
|
* Used by declaring any arbitrary datatype with SerializeElement<T> myVariable,
|
||||||
|
* inside a SerialLinkedListAdapter implementation and setting the sequence
|
||||||
|
* of objects with setNext() and setStart().
|
||||||
|
* Serialization and Deserialization is then performed automatically in
|
||||||
|
* specified sequence order.
|
||||||
|
* @ingroup serialize
|
||||||
*/
|
*/
|
||||||
template<typename T>
|
template<typename T>
|
||||||
class SerializeElement: public SerializeIF, public LinkedElement<SerializeIF> {
|
class SerializeElement: public SerializeIF, public LinkedElement<SerializeIF> {
|
||||||
@ -19,7 +27,7 @@ public:
|
|||||||
SerializeElement() :
|
SerializeElement() :
|
||||||
LinkedElement<SerializeIF>(this) {
|
LinkedElement<SerializeIF>(this) {
|
||||||
}
|
}
|
||||||
T entry;
|
|
||||||
ReturnValue_t serialize(uint8_t **buffer, size_t *size, size_t maxSize,
|
ReturnValue_t serialize(uint8_t **buffer, size_t *size, size_t maxSize,
|
||||||
Endianness streamEndianness) const override {
|
Endianness streamEndianness) const override {
|
||||||
return SerializeAdapter::serialize(&entry, buffer, size, maxSize,
|
return SerializeAdapter::serialize(&entry, buffer, size, maxSize,
|
||||||
@ -35,6 +43,7 @@ public:
|
|||||||
return SerializeAdapter::deSerialize(&entry, buffer, size,
|
return SerializeAdapter::deSerialize(&entry, buffer, size,
|
||||||
streamEndianness);
|
streamEndianness);
|
||||||
}
|
}
|
||||||
|
|
||||||
operator T() {
|
operator T() {
|
||||||
return entry;
|
return entry;
|
||||||
}
|
}
|
||||||
@ -43,9 +52,12 @@ public:
|
|||||||
entry = newValue;
|
entry = newValue;
|
||||||
return *this;
|
return *this;
|
||||||
}
|
}
|
||||||
|
|
||||||
T* operator->() {
|
T* operator->() {
|
||||||
return &entry;
|
return &entry;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
T entry;
|
||||||
};
|
};
|
||||||
|
|
||||||
#endif /* SERIALIZEELEMENT_H_ */
|
#endif /* FSFW_SERIALIZE_SERIALIZEELEMENT_H_ */
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
#define FSFW_SERIALIZE_SERIALIZEIF_H_
|
#define FSFW_SERIALIZE_SERIALIZEIF_H_
|
||||||
|
|
||||||
#include "../returnvalues/HasReturnvaluesIF.h"
|
#include "../returnvalues/HasReturnvaluesIF.h"
|
||||||
#include <stddef.h>
|
#include <cstddef>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @defgroup serialize Serialization
|
* @defgroup serialize Serialization
|
||||||
@ -10,7 +10,10 @@
|
|||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Translation of objects into data streams and from data streams.
|
* @brief Translation of objects into data streams and from data streams.
|
||||||
|
* @details
|
||||||
|
* Also provides options to convert from/to data with different endianness.
|
||||||
|
* variables.
|
||||||
* @ingroup serialize
|
* @ingroup serialize
|
||||||
*/
|
*/
|
||||||
class SerializeIF {
|
class SerializeIF {
|
||||||
|
@ -9,8 +9,7 @@
|
|||||||
#include <sys/time.h>
|
#include <sys/time.h>
|
||||||
|
|
||||||
//! Don't use these for time points, type is not large enough for UNIX epoch.
|
//! Don't use these for time points, type is not large enough for UNIX epoch.
|
||||||
typedef uint32_t dur_millis_t;
|
using dur_millis_t = uint32_t;
|
||||||
typedef double dur_seconds_t;
|
|
||||||
|
|
||||||
class Clock {
|
class Clock {
|
||||||
public:
|
public:
|
||||||
|
@ -6,19 +6,22 @@ Stopwatch::Stopwatch(bool displayOnDestruction,
|
|||||||
StopwatchDisplayMode displayMode): displayOnDestruction(
|
StopwatchDisplayMode displayMode): displayOnDestruction(
|
||||||
displayOnDestruction), displayMode(displayMode) {
|
displayOnDestruction), displayMode(displayMode) {
|
||||||
// Measures start time on initialization.
|
// Measures start time on initialization.
|
||||||
Clock::getClock_timeval(&startTime);
|
Clock::getUptime(&startTime);
|
||||||
}
|
}
|
||||||
|
|
||||||
void Stopwatch::start() {
|
void Stopwatch::start() {
|
||||||
Clock::getClock_timeval(&startTime);
|
Clock::getUptime(&startTime);
|
||||||
}
|
}
|
||||||
|
|
||||||
dur_millis_t Stopwatch::stop() {
|
dur_millis_t Stopwatch::stop(bool display) {
|
||||||
stopInternal();
|
stopInternal();
|
||||||
|
if(display) {
|
||||||
|
this->display();
|
||||||
|
}
|
||||||
return elapsedTime.tv_sec * 1000 + elapsedTime.tv_usec / 1000;
|
return elapsedTime.tv_sec * 1000 + elapsedTime.tv_usec / 1000;
|
||||||
}
|
}
|
||||||
|
|
||||||
dur_seconds_t Stopwatch::stopSeconds() {
|
double Stopwatch::stopSeconds() {
|
||||||
stopInternal();
|
stopInternal();
|
||||||
return timevalOperations::toDouble(elapsedTime);
|
return timevalOperations::toDouble(elapsedTime);
|
||||||
}
|
}
|
||||||
@ -52,6 +55,6 @@ StopwatchDisplayMode Stopwatch::getDisplayMode() const {
|
|||||||
|
|
||||||
void Stopwatch::stopInternal() {
|
void Stopwatch::stopInternal() {
|
||||||
timeval endTime;
|
timeval endTime;
|
||||||
Clock::getClock_timeval(&endTime);
|
Clock::getUptime(&endTime);
|
||||||
elapsedTime = endTime - startTime;
|
elapsedTime = endTime - startTime;
|
||||||
}
|
}
|
||||||
|
@ -1,5 +1,6 @@
|
|||||||
#ifndef FRAMEWORK_TIMEMANAGER_STOPWATCH_H_
|
#ifndef FSFW_TIMEMANAGER_STOPWATCH_H_
|
||||||
#define FRAMEWORK_TIMEMANAGER_STOPWATCH_H_
|
#define FSFW_TIMEMANAGER_STOPWATCH_H_
|
||||||
|
|
||||||
#include "Clock.h"
|
#include "Clock.h"
|
||||||
|
|
||||||
enum class StopwatchDisplayMode {
|
enum class StopwatchDisplayMode {
|
||||||
@ -40,12 +41,12 @@ public:
|
|||||||
* Calculates the elapsed time since start and returns it
|
* Calculates the elapsed time since start and returns it
|
||||||
* @return elapsed time in milliseconds (rounded)
|
* @return elapsed time in milliseconds (rounded)
|
||||||
*/
|
*/
|
||||||
dur_millis_t stop();
|
dur_millis_t stop(bool display = false);
|
||||||
/**
|
/**
|
||||||
* Calculates the elapsed time since start and returns it
|
* Calculates the elapsed time since start and returns it
|
||||||
* @return elapsed time in seconds (double precision)
|
* @return elapsed time in seconds (double precision)
|
||||||
*/
|
*/
|
||||||
dur_seconds_t stopSeconds();
|
double stopSeconds();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Displays the elapsed times on the osstream, depending on internal display
|
* Displays the elapsed times on the osstream, depending on internal display
|
||||||
@ -66,6 +67,4 @@ private:
|
|||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
|
#endif /* FSFW_TIMEMANAGER_STOPWATCH_H_ */
|
||||||
|
|
||||||
#endif /* FRAMEWORK_TIMEMANAGER_STOPWATCH_H_ */
|
|
||||||
|
23
timemanager/TimeStamper.cpp
Normal file
23
timemanager/TimeStamper.cpp
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
#include "TimeStamper.h"
|
||||||
|
#include "Clock.h"
|
||||||
|
#include <cstring>
|
||||||
|
|
||||||
|
TimeStamper::TimeStamper(object_id_t objectId): SystemObject(objectId) {}
|
||||||
|
|
||||||
|
|
||||||
|
ReturnValue_t TimeStamper::addTimeStamp(uint8_t* buffer,
|
||||||
|
const uint8_t maxSize) {
|
||||||
|
if(maxSize < TimeStamperIF::MISSION_TIMESTAMP_SIZE){
|
||||||
|
return HasReturnvaluesIF::RETURN_FAILED;
|
||||||
|
}
|
||||||
|
|
||||||
|
timeval now;
|
||||||
|
Clock::getClock_timeval(&now);
|
||||||
|
CCSDSTime::CDS_short cds;
|
||||||
|
ReturnValue_t result = CCSDSTime::convertToCcsds(&cds,&now);
|
||||||
|
if(result != HasReturnvaluesIF::RETURN_OK){
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
std::memcpy(buffer,&cds,sizeof(cds));
|
||||||
|
return result;
|
||||||
|
}
|
36
timemanager/TimeStamper.h
Normal file
36
timemanager/TimeStamper.h
Normal file
@ -0,0 +1,36 @@
|
|||||||
|
#ifndef FSFW_TIMEMANAGER_TIMESTAMPER_H_
|
||||||
|
#define FSFW_TIMEMANAGER_TIMESTAMPER_H_
|
||||||
|
|
||||||
|
#include "TimeStamperIF.h"
|
||||||
|
#include "CCSDSTime.h"
|
||||||
|
#include "../objectmanager/SystemObject.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief Time stamper which can be used to add any timestamp to a
|
||||||
|
* given buffer.
|
||||||
|
* @details
|
||||||
|
* This time stamper uses the CCSDS CDC short timestamp as a fault timestamp.
|
||||||
|
* This timestamp has a size of 8 bytes. A custom timestamp can be used by
|
||||||
|
* overriding the #addTimeStamp function.
|
||||||
|
* @ingroup utility
|
||||||
|
*/
|
||||||
|
class TimeStamper: public TimeStamperIF, public SystemObject {
|
||||||
|
public:
|
||||||
|
/**
|
||||||
|
* @brief Default constructor which also registers the time stamper as a
|
||||||
|
* system object so it can be found with the #objectManager.
|
||||||
|
* @param objectId
|
||||||
|
*/
|
||||||
|
TimeStamper(object_id_t objectId);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds a CCSDS CDC short 8 byte timestamp to the given buffer.
|
||||||
|
* This function can be overriden to use a custom timestamp.
|
||||||
|
* @param buffer
|
||||||
|
* @param maxSize
|
||||||
|
* @return
|
||||||
|
*/
|
||||||
|
virtual ReturnValue_t addTimeStamp(uint8_t* buffer, const uint8_t maxSize);
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif /* FSFW_TIMEMANAGER_TIMESTAMPER_H_ */
|
@ -384,7 +384,7 @@ void CommandingServiceBase::acceptPacket(uint8_t reportId,
|
|||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
void CommandingServiceBase::checkAndExecuteFifo(CommandMapIter iter) {
|
void CommandingServiceBase::checkAndExecuteFifo(CommandMapIter& iter) {
|
||||||
store_address_t address;
|
store_address_t address;
|
||||||
if (iter->second.fifo.retrieve(&address) != RETURN_OK) {
|
if (iter->second.fifo.retrieve(&address) != RETURN_OK) {
|
||||||
commandMap.erase(&iter);
|
commandMap.erase(&iter);
|
||||||
|
@ -39,7 +39,11 @@ class CommandingServiceBase: public SystemObject,
|
|||||||
public HasReturnvaluesIF {
|
public HasReturnvaluesIF {
|
||||||
friend void (Factory::setStaticFrameworkObjectIds)();
|
friend void (Factory::setStaticFrameworkObjectIds)();
|
||||||
public:
|
public:
|
||||||
|
// We could make this configurable via preprocessor and the FSFWConfig file.
|
||||||
|
static constexpr uint8_t COMMAND_INFO_FIFO_DEPTH = 3;
|
||||||
|
|
||||||
static const uint8_t INTERFACE_ID = CLASS_ID::COMMAND_SERVICE_BASE;
|
static const uint8_t INTERFACE_ID = CLASS_ID::COMMAND_SERVICE_BASE;
|
||||||
|
|
||||||
static const ReturnValue_t EXECUTION_COMPLETE = MAKE_RETURN_CODE(1);
|
static const ReturnValue_t EXECUTION_COMPLETE = MAKE_RETURN_CODE(1);
|
||||||
static const ReturnValue_t NO_STEP_MESSAGE = MAKE_RETURN_CODE(2);
|
static const ReturnValue_t NO_STEP_MESSAGE = MAKE_RETURN_CODE(2);
|
||||||
static const ReturnValue_t OBJECT_BUSY = MAKE_RETURN_CODE(3);
|
static const ReturnValue_t OBJECT_BUSY = MAKE_RETURN_CODE(3);
|
||||||
@ -223,7 +227,7 @@ protected:
|
|||||||
uint32_t state;
|
uint32_t state;
|
||||||
Command_t command;
|
Command_t command;
|
||||||
object_id_t objectId;
|
object_id_t objectId;
|
||||||
FIFO<store_address_t, 3> fifo;
|
FIFO<store_address_t, COMMAND_INFO_FIFO_DEPTH> fifo;
|
||||||
|
|
||||||
virtual ReturnValue_t serialize(uint8_t **buffer, size_t *size,
|
virtual ReturnValue_t serialize(uint8_t **buffer, size_t *size,
|
||||||
size_t maxSize, Endianness streamEndianness) const override{
|
size_t maxSize, Endianness streamEndianness) const override{
|
||||||
@ -312,7 +316,7 @@ protected:
|
|||||||
ReturnValue_t sendTmPacket(uint8_t subservice, SerializeIF* content,
|
ReturnValue_t sendTmPacket(uint8_t subservice, SerializeIF* content,
|
||||||
SerializeIF* header = nullptr);
|
SerializeIF* header = nullptr);
|
||||||
|
|
||||||
void checkAndExecuteFifo(CommandMapIter iter);
|
void checkAndExecuteFifo(CommandMapIter& iter);
|
||||||
|
|
||||||
private:
|
private:
|
||||||
/**
|
/**
|
||||||
|
Loading…
Reference in New Issue
Block a user