-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Patrick Williams <patrick@stwcx.xyz> Change-Id: Ia4527cf44351f3a009b2f742a619fad3e0921b06
- Loading branch information
1 parent
5203d48
commit 46a29b7
Showing
2 changed files
with
13 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |