summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDavid Cobbley <david.j.cobbley@linux.intel.com>2017-11-21 15:58:13 -0800
committerDavid Cobbley <david.j.cobbley@linux.intel.com>2018-01-04 15:27:45 -0800
commita1adb0777e370103ab9f3e7f8788f74975c69897 (patch)
treedca82cfd0f5fe7b06024c0b2a8fbf4bdeed8103f /docs
parent5bfbde351aabe2096de99ee959a8a2e50edcf84c (diff)
downloadphosphor-host-ipmid-a1adb0777e370103ab9f3e7f8788f74975c69897.tar.gz
phosphor-host-ipmid-a1adb0777e370103ab9f3e7f8788f74975c69897.zip
Get Device ID - JSON
This reads in all the get device ID parameters via a JSON file in the rootfs. Using a file in the rootfs will give much more flexibility to consumers of openbmc. Each ODM can simply bbappend their dev_id.json with their own specific get device ID info in. Now you can compile in the required info at build time, or modify during run time if needed. It also does not require any additional compilers/scripts to generate a yaml file. Change-Id: I44dfda54fa1762f88973ad709bf7a50bf32e492d Signed-off-by: David Cobbley <david.j.cobbley@linux.intel.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
new file mode 100644
index 0000000..61caaf1
--- /dev/null
+++ b/docs/configuration.md
@@ -0,0 +1,24 @@
+#Device ID Configuration#
+
+There is a default dev_id.json file provided by
+meta-phosphor/common/recipes-phosphor/ipmi/phosphor-ipmi-host.bb
+
+Any target can override the default json file by providing a
+phosphor-ipmi-host.bbappend with an ODM or platform customizable configuration.
+
+For a specific example, see:
+[Witherspoon](https://github.com/openbmc/openbmc/blob/master/
+meta-openbmc-machines/meta-openpower/meta-ibm/meta-witherspoon/
+recipes-phosphor/ipmi/phosphor-ipmi-host.bbappend)
+
+The JSON format for get_device_id:
+
+ {"id": 0, "revision": 0, "addn_dev_support": 0,
+ "manuf_id": 0, "prod_id": 0, "aux": 0}
+
+
+Each value in this JSON object should be an integer. The file is placed in
+/usr/share/ipmi-providers/ by Yocto, and will be parsed upon the first call to
+get_device_id. The data is then cached for future use. If you change the data
+at runtime, simply restart the service to see the new data fetched by a call to
+get_device_id.
OpenPOWER on IntegriCloud