eive-obsw/linux/gpio/LinuxLibgpioIF.h

78 lines
2.6 KiB
C
Raw Normal View History

2021-03-04 18:29:28 +01:00
#ifndef LINUX_GPIO_LINUXLIBGPIOIF_H_
#define LINUX_GPIO_LINUXLIBGPIOIF_H_
2021-01-23 17:22:40 +01:00
2021-02-14 12:35:08 +01:00
#include <linux/gpio/GpioIF.h>
2021-01-23 17:22:40 +01:00
#include <fsfwconfig/returnvalues/classIds.h>
#include <fsfw/objectmanager/SystemObject.h>
2021-01-23 17:22:40 +01:00
2021-03-04 18:29:28 +01:00
class GpioCookie;
2021-01-23 17:22:40 +01:00
/**
* @brief This class implements the GpioIF for a linux based system. The
* implementation is based on the libgpiod lib which requires linux 4.8
* or higher.
* @note The Petalinux SDK from Xilinx supports libgpiod since Petalinux
* 2019.1.
*/
class LinuxLibgpioIF : public GpioIF, public SystemObject {
2021-01-23 17:22:40 +01:00
public:
2021-03-04 18:29:28 +01:00
static const uint8_t gpioRetvalId = CLASS_ID::LINUX_LIBGPIO_IF;
2021-03-04 18:29:28 +01:00
static constexpr ReturnValue_t UNKNOWN_GPIO_ID =
HasReturnvaluesIF::makeReturnCode(gpioRetvalId, 1);
static constexpr ReturnValue_t DRIVE_GPIO_FAILURE =
HasReturnvaluesIF::makeReturnCode(gpioRetvalId, 2);
static constexpr ReturnValue_t GPIO_TYPE_FAILURE =
HasReturnvaluesIF::makeReturnCode(gpioRetvalId, 3);
static constexpr ReturnValue_t GPIO_INVALID_INSTANCE =
HasReturnvaluesIF::makeReturnCode(gpioRetvalId, 4);
2021-01-23 17:22:40 +01:00
LinuxLibgpioIF(object_id_t objectId);
virtual ~LinuxLibgpioIF();
2021-03-04 18:29:28 +01:00
ReturnValue_t addGpios(GpioCookie* gpioCookie) override;
2021-01-23 17:22:40 +01:00
ReturnValue_t pullHigh(gpioId_t gpioId) override;
ReturnValue_t pullLow(gpioId_t gpioId) override;
2021-02-12 21:23:35 +01:00
ReturnValue_t readGpio(gpioId_t gpioId, int* gpioState) override;
2021-01-23 17:22:40 +01:00
private:
2021-03-04 18:29:28 +01:00
/* Holds the information and configuration of all used GPIOs */
2021-01-23 17:22:40 +01:00
GpioMap gpioMap;
GpioMapIter gpioMapIter;
2021-01-23 17:22:40 +01:00
/**
* @brief This functions drives line of a GPIO specified by the GPIO ID.
*
* @param gpioId The GPIO ID of the GPIO to drive.
* @param logiclevel The logic level to set. O or 1.
*/
2021-03-04 18:29:28 +01:00
ReturnValue_t driveGpio(gpioId_t gpioId, GpiodRegular* regularGpio, unsigned int logiclevel);
ReturnValue_t configureRegularGpio(gpioId_t gpioId, GpiodRegular* regularGpio);
2021-01-23 17:22:40 +01:00
/**
* @brief This function checks if GPIOs are already registered and whether
* there exists a conflict in the GPIO configuration. E.g. the
* direction.
*
* @param mapToAdd The GPIOs which shall be added to the gpioMap.
*
* @return RETURN_OK if successful, otherwise RETURN_FAILED
*/
2021-03-04 18:29:28 +01:00
ReturnValue_t checkForConflicts(GpioMap& mapToAdd);
ReturnValue_t checkForConflictsRegularGpio(gpioId_t gpiodId, GpiodRegular* regularGpio,
GpioMap& mapToAdd);
ReturnValue_t checkForConflictsCallbackGpio(gpioId_t gpiodId, GpioCallback* regularGpio,
GpioMap& mapToAdd);
2021-02-12 21:23:35 +01:00
/**
* @brief Performs the initial configuration of all GPIOs specified in the GpioMap mapToAdd.
*/
2021-03-04 18:29:28 +01:00
ReturnValue_t configureGpios(GpioMap& mapToAdd);
2021-01-23 17:22:40 +01:00
};
2021-03-04 18:29:28 +01:00
#endif /* LINUX_GPIO_LINUXLIBGPIOIF_H_ */