#ifndef COMMON_GPIO_GPIODEFINITIONS_H_ #define COMMON_GPIO_GPIODEFINITIONS_H_ #include #include #include using gpioId_t = uint16_t; namespace gpio { enum Levels { LOW = 0, HIGH = 1 }; enum Direction { IN = 0, OUT = 1 }; enum GpioOperation { READ, WRITE }; enum GpioTypes { NONE, GPIO_REGULAR_BY_CHIP, GPIO_REGULAR_BY_LABEL, CALLBACK }; static constexpr gpioId_t NO_GPIO = -1; using gpio_cb_t = void (*) (gpioId_t gpioId, gpio::GpioOperation gpioOp, int value, void* args); } /** * @brief Struct containing information about the GPIO to use. This is * required by the libgpiod to access and drive a GPIO. * @param chipname String of the chipname specifying the group which contains the GPIO to * access. E.g. gpiochip0. To detect names of GPIO groups run gpiodetect on * the linux command line. * @param lineNum The offset of the GPIO within the GPIO group. * @param consumer Name of the consumer. Simply a description of the GPIO configuration. * @param direction Specifies whether the GPIO should be used as in- or output. * @param initValue Defines the initial state of the GPIO when configured as output. * Only required for output GPIOs. * @param lineHandle The handle returned by gpiod_chip_get_line will be later written to this * pointer. */ class GpioBase { public: GpioBase() = default; GpioBase(gpio::GpioTypes gpioType, std::string consumer, gpio::Direction direction, int initValue): gpioType(gpioType), consumer(consumer),direction(direction), initValue(initValue) {} virtual~ GpioBase() {}; // Can be used to cast GpioBase to a concrete child implementation gpio::GpioTypes gpioType = gpio::GpioTypes::NONE; std::string consumer; gpio::Direction direction = gpio::Direction::IN; int initValue = 0; }; class GpiodRegularBase: public GpioBase { public: GpiodRegularBase(gpio::GpioTypes gpioType, std::string consumer, gpio::Direction direction, int initValue, int lineNum): GpioBase(gpioType, consumer, direction, initValue), lineNum(lineNum) { } int lineNum = 0; struct gpiod_line* lineHandle = nullptr; }; class GpiodRegularByChip: public GpiodRegularBase { public: GpiodRegularByChip() : GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_CHIP, std::string(), gpio::Direction::IN, gpio::LOW, 0) { } GpiodRegularByChip(std::string chipname_, int lineNum_, std::string consumer_, gpio::Direction direction_, int initValue_) : GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_CHIP, consumer_, direction_, initValue_, lineNum_), chipname(chipname_){ } GpiodRegularByChip(std::string chipname_, int lineNum_, std::string consumer_) : GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_CHIP, consumer_, gpio::Direction::IN, gpio::LOW, lineNum_), chipname(chipname_) { } std::string chipname; }; class GpiodRegularByLabel: public GpiodRegularBase { public: GpiodRegularByLabel(std::string label_, int lineNum_, std::string consumer_, gpio::Direction direction_, int initValue_) : GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_LABEL, consumer_, direction_, initValue_, lineNum_), label(label_) { } GpiodRegularByLabel(std::string label_, int lineNum_, std::string consumer_) : GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_LABEL, consumer_, gpio::Direction::IN, gpio::LOW, lineNum_), label(label_) { } std::string label; }; class GpioCallback: public GpioBase { public: GpioCallback(std::string consumer, gpio::Direction direction_, int initValue_, gpio::gpio_cb_t callback, void* callbackArgs): GpioBase(gpio::GpioTypes::CALLBACK, consumer, direction_, initValue_), callback(callback), callbackArgs(callbackArgs) {} gpio::gpio_cb_t callback = nullptr; void* callbackArgs = nullptr; }; using GpioMap = std::map; using GpioUnorderedMap = std::unordered_map; using GpioMapIter = GpioMap::iterator; using GpioUnorderedMapIter = GpioUnorderedMap::iterator; #endif /* LINUX_GPIO_GPIODEFINITIONS_H_ */