Common/Callout/README.md

5 A callout is typically an indication of a faulty hardware component in a system.
6 In OpenBMC, a callout is defined as any other error, via a YAML file. An example
7 would be `xyz.openbmc_project.Error.Callout.IIC`, to indicate an IIC callout.
11 the OpenBMC error handling component to map such a callout to actual field
16 An OpenBMC error has associated metadata, the same is true for a callout. Such
17 metadata would be defined in the callout YAML interface. Here is an example (for
29 An application wanting to add an IIC callout will have to provide values for the
31 figure out that this is in fact an IIC callout.
33 A callout is typically associated with an error log. For eg,
34 `xyz.openbmc_project.Error.Foo` may want to add an IIC callout. This is
45 include Callout.IIC's as well, so an application wanting to add an IIC callout
48 figure out that the error Foo includes an IIC callout.
50 Currently, defined callout interfaces in turn inherit
63 This way, say an application wants to express an IIC callout in terms of a
64 device path, for lack of IIC information. The application can add the callout
67 this as an IIC callout.
69 ## Creation of a callout
71 This section talks about creation of a callout, once callout related metadata is
74 Taking an example of a generic device callout here, but this would be the flow
77 - An application commits an error that has associated callout metadata. This
80 - The error-log server will detect that callout metadata is present, will
81   extract the same and hand it over to a sub-module which will map callout
83   between the error object and the inventory object(s). The mapping from callout
87 - Generated code : consider a case where an application wants to callout an