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
diff --git a/README.md b/README.md
index df55110..695cdf8 100644
--- a/README.md
+++ b/README.md
@@ -1,64 +1,67 @@
-# phosphor-gpio-monitor
+# GPIO Monitoring
-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.
+## Implemented Daemons
-# phosphor-multi-gpio-monitor
+### `phosphor-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.
+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.
-# 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.
+### `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.
+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".
+ ("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.
+ 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
+```json
[
- {
- "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"
- }
+ {
+ "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" }
]
+```
diff --git a/phosphor-multi-gpio-monitor.json b/phosphor-multi-gpio-monitor.json
index 3508995..6d383ce 100644
--- a/phosphor-multi-gpio-monitor.json
+++ b/phosphor-multi-gpio-monitor.json
@@ -1,14 +1,14 @@
[
- {
- "Name": "PowerButton",
- "LineName": "POWER_BUTTON",
- "EventMon": "BOTH",
- "Continue": true
- },
- {
- "Name": "PowerGood",
- "ChipId": "0",
- "GpioNum": 14,
- "Continue": true
- }
+ {
+ "Name": "PowerButton",
+ "LineName": "POWER_BUTTON",
+ "EventMon": "BOTH",
+ "Continue": true
+ },
+ {
+ "Name": "PowerGood",
+ "ChipId": "0",
+ "GpioNum": 14,
+ "Continue": true
+ }
]