Skip to content

Commit

Permalink
markdownlint: fix all warnings
Browse files Browse the repository at this point in the history
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: Ia4527cf44351f3a009b2f742a619fad3e0921b06
  • Loading branch information
williamspatrick committed Dec 8, 2022
1 parent 5203d48 commit 46a29b7
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 15 deletions.
2 changes: 1 addition & 1 deletion README.iio.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Phosphor OpenBMC and IIO devices
# Phosphor OpenBMC and IIO devices

Phosphor OpenBMC currently does not provide an IIO device to DBUS bridge in the
same way that hwmon devices are bridged by the phosphor-hwmon-readd application.
Expand Down
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,27 @@
# phosphor-hwmon

Exposes generic hwmon entries as DBus objects. More information can be found at
[Sensor Architecture](https://github.com/openbmc/docs/blob/master/architecture/sensor-architecture.md)

## To Build

```
To build this package, do the following steps:

1. meson build
2. ninja -C build
1. meson setup build
2. ninja -C build

To clean the repository run `rm -rf build`.
```

## D-Bus bus names

```
To enable the use of Linux features like cgroups prioritization and
udev/systemd control, one instance of phosphor-hwmon is intended to
be run per hwmon sysfs class instance.
To enable the use of Linux features like cgroups prioritization and udev/systemd
control, one instance of phosphor-hwmon is intended to be run per hwmon sysfs
class instance.

This requires an algorithm for selecting a stable, well-known D-Bus busname.

The algorithm is <PREFIX>-<ID>.Hwmon<N> where PREFIX is an autoconf
configurable prefix (BUSNAME_PREFIX, xyz.openbmc_project by default),
ID is either a std::hash of the /sys/devices path backing the hwmon class
instance or provided suffix value from the command line, and N is
the implemented phosphor-hwmon D-Bus API version.
```
The algorithm is `<PREFIX>-<ID>.Hwmon<N>` where PREFIX is a meson configurable
prefix (`BUSNAME_PREFIX=xyz.openbmc_project` by default), ID is either a
`std::hash` of the `/sys/devices` path backing the hwmon class instance or
provided suffix value from the command line, and N is the implemented
phosphor-hwmon D-Bus API version.

0 comments on commit 46a29b7

Please sign in to comment.