Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-gpio-monitor / 69e9930aa2012ff5f3016fa602e3cca6978fdb02
commit69e9930aa2012ff5f3016fa602e3cca6978fdb02[log] [tgz]
authorPatrick Williams <patrick@stwcx.xyz>Wed Aug 09 14:45:28 2023 -0500
committerPatrick Williams <patrick@stwcx.xyz>Wed Aug 09 14:47:52 2023 -0500
treed471f4e54fa9c1c73a9c10cec02127128bc7799e
parent835461822bf3743321fd57751f01903734659d40 [diff]
phosphor-gpio-monitor: ignore extra args

The phosphor-gpio-monitor@.service template has an EXTRA_ARGS which
in some configs can be empty.  systemd will end up launching the
process with an extra, empty argument.  CLI11 fails on this unless
we give an explicit `allow_extra` call.

Observed in hardware testing:
```
Aug 09 19:28:46 witherspoon-Y230UF71K03T phosphor-gpio-monitor[632]: The following argument was not expected:
Aug 09 19:28:46 witherspoon-Y230UF71K03T phosphor-gpio-monitor[632]: Run with --help for more information.
```

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I42ae7e0e67f424bd1ae894a2a6a84b99ee32b723
1 file changed
tree: d471f4e54fa9c1c73a9c10cec02127128bc7799e
  1. presence/
  2. subprojects/
  3. test/
  4. .clang-format
  5. .gitignore
  6. 99-gpio-keys.rules
  7. evdev.cpp
  8. evdev.hpp
  9. file.hpp
  10. gpioMon.cpp
  11. gpioMon.hpp
  12. gpioMonMain.cpp
  13. LICENSE
  14. mainapp.cpp
  15. meson.build
  16. meson_options.txt
  17. monitor.cpp
  18. monitor.hpp
  19. OWNERS
  20. phosphor-gpio-monitor@.service
  21. phosphor-gpio-presence@.service
  22. phosphor-multi-gpio-monitor.json
  23. phosphor-multi-gpio-monitor.service
  24. README.md
README.md

GPIO Monitoring

Implemented Daemons

phosphor-gpio-monitor

This daemon accepts a command line parameter for monitoring single gpio line and take action if requested. This implementation uses GPIO keys and only supports monitoring single GPIO line, for multiple lines, user has to run this daemon seperately for each gpio line.

phosphor-multi-gpio-monitor

This daemon accepts command line parameter as a well-defined GPIO configuration file in json format to monitor list of gpios from config file and take action defined in config based on gpio state change. It uses libgpiod library.

Difference

New implementation (phosphor-multi-gpio-monitor) provides multiple gpio line monitoring in single instance of phosphor-multi-gpio-monitor running. It is very easy to add list of gpios into JSON config file and it also supports of GPIO line by name defined in kernel.

Configuration

There is a phosphor-multi-gpio-monitor.json file that defines details of GPIOs which is required to be monitored. This file can be replaced with a platform specific configuration file via bbappend.

Following are fields in json file

  1. Name: Name of gpio for reference.
  2. LineName: this is the line name defined in device tree for specific gpio
  3. GpioNum: GPIO offset, this field is optional if LineName is defined.
  4. ChipId: This is device name either offset ("0") or complete gpio device ("gpiochip0"). This field is not required if LineName is defined.
  5. EventMon: Event of gpio to be monitored. This can be "FALLING", "RISING" OR "BOTH". Default value for this is "BOTH".
  6. Target: This is an optional systemd service which will get started after triggering event. A journal entry will be added for every event occurs irrespective of this definition.
  7. Targets: This is an optional systemd service which will get started after triggering corresponding event(RASING or FALLING). A journal entry will be added for every event occurs irrespective of this definition.
  8. Continue: This is a optional flag and if it is defined as true then this gpio will be monitored continously. If not defined then monitoring of this gpio will stop after first event.

Sample config file

[
  {
    "Name": "PowerButton",
    "LineName": "POWER_BUTTON",
    "GpioNum": 34,
    "ChipId": "gpiochip0",
    "EventMon": "FALLING",
    "Target": "PowerButtonDown.service",
    "Continue": true
  },
  {
    "Name": "PowerGood",
    "LineName": "PS_PWROK",
    "EventMon": "BOTH",
    "Targets": {
      "FALLING": ["PowerGoodFalling.service", "PowerOff.service"],
      "RISING": ["PowerGoodRising.service", "PowerOn.service"]
    },
    "Continue": false
  },
  { "Name": "SystemReset", "GpioNum": 46, "ChipId": "0" }
]