How openbmc/phosphor-gpio-monitor works
Project Type and Purpose
• This is a set of Linux system daemons (C++ services) for monitoring GPIO lines, triggering systemd services, or updating inventory presence over D-Bus.
• Key deliverables:
• phosphor-gpio-monitor (single line)
• phosphor-multi-gpio-monitor (multi-line, JSON-driven)
• phosphor-multi-gpio-presence (multi-line, JSON-driven presence via D-Bus)
Main Components
A. Systemd & Service Units
• phosphor-gpio-monitor@.service
• phosphor-multi-gpio-monitor.service / JSON config
• phosphor-multi-gpio-presence.service / JSON config
B. Daemon Executables
• Single‐line monitor (gpioMonMain.cpp, monitor.cpp, evdev.cpp)
• Multi‐line monitor (multi-presence/main.cpp, gpio_presence.cpp)
• Multi‐line presence (presence/main.cpp, gpio_presence.cpp)
C. Configuration Files
• phosphor-multi-gpio-monitor.json
• phosphor-multi-gpio-presence.json
D. Libraries & Frameworks
• libgpiod (GPIO kernel interface)
• CLI11 (command-line parsing)
• nlohmann_json (JSON parsing)
• sdbusplus / phosphor-logging (D-Bus & logging)
E. Kernel & D-Bus Subsystems
• GPIO character devices (e.g. /dev/gpiochipN)
• systemd (service management, journal)
• OpenBMC inventory D-Bus interfaces
Relationships & Data Flows
1. systemd service unit starts the daemon, passing either GPIO line parameters or JSON config path.
2. Daemon uses CLI11 to parse arguments.
3. Daemon loads JSON via nlohmann_json (if multi-line).
4. Daemon opens GPIO lines through libgpiod → kernel.
5. On GPIO events (FALLING/RISING):
• Log event to systemd journal via phosphor-logging.
• For monitor daemons: optionally invoke other systemd units (Targets).
• For presence daemon: call sdbusplus APIs to set inventory presence on D-Bus.
6. Daemon either continues monitoring (Continue=true) or exits after first event.
Architectural Patterns & Principles
• Configuration-driven architecture (JSON describes all monitored lines).
• Event‐driven design (callback on GPIO edge events).
• Separation of concerns: CLI, JSON parsing, GPIO access, business logic, logging, D-Bus.
• Reuse through shared code modules (gpioMon.hpp/.cpp, monitor.hpp/.cpp, evdev.hpp/.cpp).