Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-gpio-monitor / 2a8848c6fb8e2b98e79baa441d4381a52a1df719
commit2a8848c6fb8e2b98e79baa441d4381a52a1df719[log] [tgz]
authorGeorge Liu <liuxiwei@inspur.com>Tue Aug 01 13:49:28 2023 +0800
committerGeorge Liu <liuxiwei@inspur.com>Wed Aug 02 11:27:15 2023 +0800
tree20ee6426ea6ca3c4ef07793473225bf66ee700a4
parent7abda62ca1712083c9b2cc2e70d44c06602bd0c8 [diff]
logging: switch to lg2

After switching to C++20, it is recommended to use `phosphor::lg2`
to format log, and the correct `CODE_LINE` and `CODE_FUNC` values
can be used in log tracking.

Signed-off-by: George Liu <liuxiwei@inspur.com>
Change-Id: I4fe8f4dec90e5062096168e05947b6d9bc355bb2
9 files changed
tree: 20ee6426ea6ca3c4ef07793473225bf66ee700a4
  1. gpio-util/
  2. presence/
  3. subprojects/
  4. test/
  5. .clang-format
  6. .gitignore
  7. 99-gpio-keys.rules
  8. argument.cpp
  9. argument.hpp
  10. evdev.cpp
  11. evdev.hpp
  12. file.hpp
  13. gpioMon.cpp
  14. gpioMon.hpp
  15. gpioMonMain.cpp
  16. LICENSE
  17. mainapp.cpp
  18. meson.build
  19. meson_options.txt
  20. monitor.cpp
  21. monitor.hpp
  22. OWNERS
  23. phosphor-gpio-monitor@.service
  24. phosphor-gpio-presence@.service
  25. phosphor-multi-gpio-monitor.json
  26. phosphor-multi-gpio-monitor.service
  27. 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" }
]