openbmc/phosphor-gpio-monitor/README.md

1 # GPIO Monitoring
5 ### `phosphor-gpio-monitor`
7 This daemon accepts a command line parameter for monitoring single gpio line and
8 take action if requested. This implementation uses GPIO keys and only supports
9 monitoring single GPIO line, for multiple lines, user has to run this daemon
10 seperately for each gpio line.
12 ### `phosphor-multi-gpio-monitor`
14 This daemon accepts command line parameter as a well-defined GPIO configuration
15 file in json format to monitor list of gpios from config file and take action
16 defined in config based on gpio state change. It uses libgpiod library.
20 New implementation (phosphor-multi-gpio-monitor) provides multiple gpio line
21 monitoring in single instance of phosphor-multi-gpio-monitor running. It is very
22 easy to add list of gpios into JSON config file and it also supports of GPIO
27 There is a phosphor-multi-gpio-monitor.json file that defines details of GPIOs
33 1. Name: Name of gpio for reference.
34 2. LineName: this is the line name defined in device tree for specific gpio
35 3. GpioNum: GPIO offset, this field is optional if LineName is defined.
36 4. ChipId: This is device name either offset ("0") or complete gpio device
38 5. EventMon: Event of gpio to be monitored. This can be "FALLING", "RISING" OR
46 8. Continue: This is a optional flag and if it is defined as true then this gpio
47    will be monitored continously. If not defined then monitoring of this gpio
50 #### Sample config file
77 ### `phosphor-multi-gpio-presence`
79 This daemon accepts command line parameter as a well-defined GPIO configuration
80 file in json format to monitor list of gpios from config file and sets inventory
81 presence as defined in config based on gpio state change. It uses libgpiod
86 New implementation (phosphor-multi-gpio-presence) provides multiple gpio line
87 monitoring in single instance of phosphor-multi-gpio-presence running. It is
88 very easy to add list of gpios into JSON config file and it also supports of
89 GPIO line by name defined in kernel.
93 There is a phosphor-multi-gpio-presence.json file that defines details of GPIOs
100 2. LineName: this is the line name defined in device tree for specific gpio
101 3. GpioNum: GPIO offset, this field is optional if LineName is defined.
102 4. ChipId: This is device name either offset ("0") or complete gpio device
107 8. Bias: [Optional] Configure a BIAS on the GPIO line, for example PULL_UP
109 #### Sample config file