docs/designs/error-log-handling-for-phal.md

1 # Error handling for power Hardware Abstraction Layer (pHAL)
12 power Hardware Abstraction Layer(pHAL) library calls to [Platform Event Log][1]
17 OpenBmc Applications use the pHAL layer for hardware access and hardware
18 initialization, any software/hardware error returned by the pHAL layer need to
24 refers to the action of "guarding" faulty hardware from impacting future system
25 operation. Callout points to a specific hardware with in the server that relates
35 3. libekb for hardware procedure execution
36 4. libpdbg for hardware access
44 pHAL: power Hardware Abstraction Layer. pHAL is group of libraries running in
45 BMC. These libraries are used by Open Power specific application for hardware
58 HWP: Hardware procedure. A "black box" code module supplied by the hardware team
62 Device Tree: A device tree is a data structure describing the hardware
67 EKB: EKB library contains all the hardware procedures (HWP) for the specific
68 platform and corresponding error XML files for each hardware procedure.
76 EKB library contains hardware procedures for the specific platform and the
77 corresponding error xml files for each hardware procedure. Error XML specifies
80 generate a c++ header file which is used by the hardware procedure in capturing
84 parse the failure data returned by the hardware procedure methods and return
90 calls hardware procedures (HWP) of EKB library. Hardware procedure execution
92 hardware procedure execution failure.
96 libpdbg library is used for hardware access, any hardware access errors need to
106 ### Hardware procedure failure
109 parse the failure data returned by the hardware procedure methods and return
165 1. Simulate hardware procedure failure and check if PEL is created.