62 lines
1.9 KiB
C
62 lines
1.9 KiB
C
|
#ifndef LINUX_SPI_SPICOMIF_H_
|
||
|
|
#define LINUX_SPI_SPICOMIF_H_
|
||
|
|
|
||
|
|
#include <fsfw/devicehandlers/DeviceCommunicationIF.h>
|
||
|
|
#include <fsfw/objectmanager/SystemObject.h>
|
||
|
|
#include <linux/gpio/GpioIF.h>
|
||
|
|
|
||
|
|
#include <vector>
|
||
|
|
#include <unordered_map>
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief Encapsulates access to linux SPI driver for FSFW objects
|
||
|
|
* @details
|
||
|
|
* Right now, only full-duplex SPI is supported.
|
||
|
|
* @author R. Mueller
|
||
|
|
*/
|
||
|
|
class SpiComIF: public DeviceCommunicationIF, public SystemObject {
|
||
|
|
public:
|
||
|
|
SpiComIF(object_id_t objectId, GpioIF* gpioComIF);
|
||
|
|
|
||
|
|
ReturnValue_t initializeInterface(CookieIF * cookie) override;
|
||
|
|
ReturnValue_t sendMessage(CookieIF *cookie,const uint8_t *sendData,
|
||
|
|
size_t sendLen) override;
|
||
|
|
ReturnValue_t getSendSuccess(CookieIF *cookie) override;
|
||
|
|
ReturnValue_t requestReceiveMessage(CookieIF *cookie,
|
||
|
|
size_t requestLen) override;
|
||
|
|
ReturnValue_t readReceivedMessage(CookieIF *cookie, uint8_t **buffer,
|
||
|
|
size_t *size) override;
|
||
|
|
private:
|
||
|
|
|
||
|
|
struct SpiInstance {
|
||
|
|
std::vector<uint8_t> replyBuffer;
|
||
|
|
};
|
||
|
|
|
||
|
|
GpioIF* gpioComIF = nullptr;
|
||
|
|
|
||
|
|
MutexIF* spiMutex = nullptr;
|
||
|
|
MutexIF::TimeoutType timeoutType = MutexIF::TimeoutType::WAITING;
|
||
|
|
uint32_t timeoutMs = 20;
|
||
|
|
|
||
|
|
using SpiDeviceMap = std::unordered_map<address_t, SpiInstance>;
|
||
|
|
using SpiDeviceMapIter = SpiDeviceMap::iterator;
|
||
|
|
|
||
|
|
SpiDeviceMap spiDeviceMap;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @brief This function opens an SPI device and binds the opened file
|
||
|
|
* to a specific SPI address.
|
||
|
|
* @param deviceFile The name of the device file. E.g. spi-0
|
||
|
|
* @param i2cAddress The address of the SPI slave device.
|
||
|
|
* @param fileDescriptor Pointer to device descriptor.
|
||
|
|
* @return RETURN_OK if successful, otherwise RETURN_FAILED.
|
||
|
|
*/
|
||
|
|
ReturnValue_t openDevice(std::string deviceFile, int* fileDescriptor, bool nonBlocking = false);
|
||
|
|
|
||
|
|
ReturnValue_t getReadBuffer(address_t spiAddress, uint8_t** buffer);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
#endif /* LINUX_SPI_SPICOMIF_H_ */
|