xref: /openbmc/openpower-occ-control/README.md (revision 32f2af0add85e2ebd4fca1606d0b6fa8afd15223)
1755af102SChris Cain# OpenPOWER OCC Control Service
2755af102SChris Cain
3755af102SChris CainThis service will handle communications to the On-Chip Controller (OCC) on Power
4755af102SChris Cainprocessors. The OCC provides processor and memory temperatures, power readings,
5755af102SChris Cainpower cap support, system power mode support, and idle power saver support. OCC
6755af102SChris CainControl will be interfacing with the OCC to collect the temperatures and power
7755af102SChris Cainreadings, updating the system power mode, setting power caps, and idle power
8755af102SChris Cainsave parameters.
9755af102SChris Cain
10755af102SChris CainThe service is started automatically when the BMC is started.
11755af102SChris Cain
12755af102SChris Cain## Build Project
13755af102SChris Cain
14755af102SChris CainThis project can be built with meson. The typical meson workflow is: meson
15755af102SChris Cainbuilddir && ninja -C builddir.
16755af102SChris Cain
17755af102SChris Cain## Server
18755af102SChris Cain
19755af102SChris CainThe server will start automatically after BMC is powered on.
20755af102SChris Cain
21755af102SChris CainServer status: `systemctl status org.open_power.OCC.Control.service`
22755af102SChris Cain
23755af102SChris CainTo restart the service: `systemctl restart org.open_power.OCC.Control.service`
24755af102SChris Cain
25755af102SChris Cain## Configuration
26755af102SChris Cain
27755af102SChris CainService files are located in service_files subdirectory.
28755af102SChris Cain
29755af102SChris Cain## References
30755af102SChris Cain
31755af102SChris Cain### Power10
32755af102SChris Cain
33755af102SChris CainIBM EnergyScale for Power10 Processor-Based Systems whitepaper:
34*32f2af0aSChris Cain<https://www.ibm.com/downloads/cas/E7RL9N4E>
35755af102SChris Cain
36755af102SChris CainOCC Firmware Interface Spec for Power10:
37*32f2af0aSChris Cain<https://github.com/open-power/docs/blob/P10/occ/OCC_P10_FW_Interfaces_v1_17.pdf>
38755af102SChris Cain
39*32f2af0aSChris CainOCC Firmware: <https://github.com/open-power/occ/tree/master-p10>
40755af102SChris Cain
41755af102SChris Cain### Power9
42755af102SChris Cain
43755af102SChris CainIBM EnergyScale for POWER9 Processor-Based Systems:
44*32f2af0aSChris Cain<https://www-01.ibm.com/common/ssi/cgi-bin/ssialias?htmlfid=49019149USEN&>
45755af102SChris Cain
46755af102SChris CainOCC Firmware Interface Spec for POWER9:
47*32f2af0aSChris Cain<https://github.com/open-power/docs/blob/P9/occ/OCC_P9_FW_Interfaces.pdf>
48