Robin Mueller
d486c04634
All checks were successful
EIVE/eive-obsw/pipeline/pr-cfdp-source-handler This commit looks good
138 lines
4.6 KiB
C++
138 lines
4.6 KiB
C++
#ifndef LINUX_OBC_PAPBVCINTERFACE_H_
|
|
#define LINUX_OBC_PAPBVCINTERFACE_H_
|
|
|
|
#include <fsfw_hal/common/gpio/gpioDefinitions.h>
|
|
#include <fsfw_hal/linux/gpio/LinuxLibgpioIF.h>
|
|
#include <linux/ipcore/VirtualChannelIF.h>
|
|
|
|
#include <atomic>
|
|
#include <vector>
|
|
|
|
#include "OBSWConfig.h"
|
|
#include "fsfw/returnvalues/returnvalue.h"
|
|
|
|
/**
|
|
* @brief This class handles the transmission of data to a virtual channel of the PTME IP Core
|
|
* via the PAPB interface.
|
|
*
|
|
* @author J. Meier
|
|
*/
|
|
class PapbVcInterface : public VirtualChannelIF {
|
|
public:
|
|
/**
|
|
* @brief Constructor
|
|
*
|
|
* @param papbBusyId The ID of the GPIO which is connected to the PAPBBusy_N signal of the
|
|
* VcInterface IP Core. A low logic level indicates the VcInterface is not
|
|
* ready to receive more data.
|
|
* @param papbEmptyId The ID of the GPIO which is connected to the PAPBEmpty signal of the
|
|
* VcInterface IP Core. The signal is high when there are no packets in the
|
|
* external buffer memory (BRAM).
|
|
* @param uioFile UIO file providing access to the PAPB bus
|
|
* @param mapNum Map number of UIO map associated with this virtual channel
|
|
*/
|
|
PapbVcInterface(LinuxLibgpioIF* gpioComIF, gpioId_t papbEmptyId, std::string uioFile, int mapNum,
|
|
size_t maxPacketSize);
|
|
virtual ~PapbVcInterface();
|
|
|
|
// See interface function documentation for docs on these functions.
|
|
|
|
bool isBusy() const override;
|
|
|
|
ReturnValue_t write(const uint8_t* data, size_t size, size_t& writtenSize) override;
|
|
|
|
ReturnValue_t advanceWrite(size_t& remainingSize) override;
|
|
|
|
void cancelTransfer() override;
|
|
|
|
bool writeActive() const override;
|
|
|
|
ReturnValue_t initialize() override;
|
|
|
|
private:
|
|
static const uint8_t INTERFACE_ID = CLASS_ID::CCSDS_IP_CORE_BRIDGE;
|
|
|
|
static const ReturnValue_t PAPB_BUSY = MAKE_RETURN_CODE(0xA0);
|
|
|
|
enum ByteWidthCfg : uint32_t { ONE = 0b00, TWO = 0b01, THREE = 0b10, FOUR = 0b11 };
|
|
/**
|
|
* Configuration bits:
|
|
* bit[1:0]: Size of data (1,2,3 or 4 bytes). 1 Byte <=> b00
|
|
* bit[2]: Set this bit to 1 to abort a transferred packet
|
|
* bit[3]: Signals to VcInterface the start of a new telemetry packet
|
|
*/
|
|
static constexpr uint32_t CONFIG_DATA_INPUT = 0b00001000;
|
|
|
|
/**
|
|
* Abort a transferred packet.
|
|
*/
|
|
static constexpr uint32_t CONFIG_ABORT = 0b00000100;
|
|
|
|
/**
|
|
* Writing this word to the VcInterface base address signals to the virtual channel interface
|
|
* that a complete tm packet has been transferred.
|
|
*/
|
|
static constexpr uint32_t CONFIG_END = 0x0;
|
|
|
|
/**
|
|
* Writing to this offset within the memory space of a virtual channel will insert data for
|
|
* encoding to the external buffer memory of the PTME IP Core.
|
|
* The address offset is 0x400 (= 4 * 256)
|
|
*/
|
|
static const int DATA_REG_OFFSET = 256;
|
|
|
|
static constexpr long int FIRST_DELAY_PAPB_POLLING_NS = 10;
|
|
static constexpr long int MAX_DELAY_PAPB_POLLING_NS = 40;
|
|
static constexpr uint32_t MAX_BUSY_POLLS = 1000;
|
|
|
|
LinuxLibgpioIF* gpioComIF = nullptr;
|
|
/** High when external buffer memory of virtual channel is empty */
|
|
gpioId_t papbEmptyId = gpio::NO_GPIO;
|
|
|
|
std::vector<uint8_t> packetBuf;
|
|
std::string uioFile;
|
|
int mapNum = 0;
|
|
bool writeActiveStatus = false;
|
|
size_t currentPacketIndex = 0;
|
|
size_t currentPacketSize = 0;
|
|
mutable struct timespec nextDelay = {.tv_sec = 0, .tv_nsec = 0};
|
|
const struct timespec BETWEEN_POLL_DELAY = {.tv_sec = 0, .tv_nsec = 10};
|
|
|
|
volatile uint32_t* vcBaseReg = nullptr;
|
|
|
|
uint32_t vcOffset = 0;
|
|
|
|
/**
|
|
* @brief This function sends the config byte to the virtual channel of the PTME IP Core
|
|
* to initiate a packet transfer.
|
|
*/
|
|
void startPacketTransfer(ByteWidthCfg initWidth);
|
|
|
|
void abortPacketTransfer();
|
|
|
|
/**
|
|
* @brief This function sends the config byte to the virtual channel interface of the PTME
|
|
* IP Core to signal the end of a packet transfer.
|
|
*/
|
|
void completePacketTransfer();
|
|
|
|
/**
|
|
* @brief This function reads the papb busy signal indicating whether the virtual channel
|
|
* interface is ready to receive more data or not. PAPB is ready when
|
|
* PAPB_Busy_N == '1'.
|
|
*
|
|
* @return returnvalue::OK when ready to receive data else PAPB_BUSY.
|
|
*/
|
|
inline bool pollReadyForPacket() const;
|
|
|
|
inline bool pollReadyForOctet(uint32_t maxCycles) const;
|
|
|
|
/**
|
|
* @brief This function can be used for debugging to check whether there are packets in
|
|
* the packet buffer of the virtual channel or not.
|
|
*/
|
|
bool isVcInterfaceBufferEmpty();
|
|
};
|
|
|
|
#endif /* LINUX_OBC_PAPBVCINTERFACE_H_ */
|