Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-gpio-monitor / b5bd88532ccef5e82810a1472af3d8a9213873ae
commitb5bd88532ccef5e82810a1472af3d8a9213873ae[log] [tgz]
authorPatrick Williams <patrick@stwcx.xyz>Tue Dec 06 10:48:27 2022 -0600
committerPatrick Williams <patrick@stwcx.xyz>Tue Dec 06 10:48:30 2022 -0600
tree797160de86ed0b89c9aad3e6a227d78b1c5de319
parent98fd7642ba5d6c9d21b5e25da839875520c546a3 [diff]
reformat and fix markdownlint issues

Fix the prettier / markdownlint format issues in the repository.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: Ie00d9f902c1323ca997d82e21ae2d8f8669ba896
2 files changed
tree: 797160de86ed0b89c9aad3e6a227d78b1c5de319
  1. gpio-util/
  2. presence/
  3. test/
  4. .clang-format
  5. .gitignore
  6. 99-gpio-keys.rules
  7. argument.cpp
  8. argument.hpp
  9. evdev.cpp
  10. evdev.hpp
  11. file.hpp
  12. gpioMon.cpp
  13. gpioMon.hpp
  14. gpioMonMain.cpp
  15. LICENSE
  16. mainapp.cpp
  17. meson.build
  18. meson_options.txt
  19. monitor.cpp
  20. monitor.hpp
  21. OWNERS
  22. phosphor-gpio-monitor@.service
  23. phosphor-gpio-presence@.service
  24. phosphor-multi-gpio-monitor.json
  25. phosphor-multi-gpio-monitor.service
  26. 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. 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": "BOTH",
    "Continue": true
  },
  {
    "Name": "PowerGood",
    "LineName": "PS_PWROK",
    "EventMon": "FALLING",
    "Continue": false
  },
  { "Name": "SystemReset", "GpioNum": 46, "ChipId": "0" }
]