xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Control/Power/Throttle.interface.yaml (revision 921791c73008a3edfc6507afb5bc15e48963d295)
147709f23SChris Caindescription: >
247709f23SChris Cain    This interface provides information related to the throttle status of a
347709f23SChris Cain    component.
447709f23SChris Cain
547709f23SChris Cainproperties:
647709f23SChris Cain    - name: ThrottleCauses
747709f23SChris Cain      type: array[enum[self.ThrottleReasons]]
847709f23SChris Cain      flags:
947709f23SChris Cain          - readonly
1047709f23SChris Cain      description: >
1147709f23SChris Cain          This property shall contain the cause(s) of the component being
1247709f23SChris Cain          throttled when the Throttled property is true or an empty array if not
1347709f23SChris Cain          being throttled.
1447709f23SChris Cain    - name: Throttled
1547709f23SChris Cain      type: boolean
1647709f23SChris Cain      flags:
1747709f23SChris Cain          - readonly
1847709f23SChris Cain      default: false
1947709f23SChris Cain      description: >
2047709f23SChris Cain          This property shall indicate whether the component is throttled.
2147709f23SChris Cain
2247709f23SChris Cainenumerations:
2347709f23SChris Cain    - name: ThrottleReasons
2447709f23SChris Cain      description: >
2547709f23SChris Cain          The possible reasons a component could be throttled
2647709f23SChris Cain      values:
2747709f23SChris Cain          - name: ClockLimit
2847709f23SChris Cain            description: >
2947709f23SChris Cain                The cause of the component being throttled is a clock limit.
3047709f23SChris Cain          - name: ManagementDetectedFault
3147709f23SChris Cain            description: >
3247709f23SChris Cain                The cause of the component being throttled is a fault detected
3347709f23SChris Cain                by management hardware or firmware
3447709f23SChris Cain          - name: PowerLimit
35*921791c7SManojkiran Eda            description: >
3647709f23SChris Cain                The cause of the component being throttled is a power limit.
3747709f23SChris Cain          - name: ThermalLimit
3847709f23SChris Cain            description: >
3947709f23SChris Cain                The cause of the component being throttled is a thermal limit.
4047709f23SChris Cain          - name: Unknown
4147709f23SChris Cain            description: >
4247709f23SChris Cain                The cause of the component being throttled is not known.
431abc0c57SGeorge Liu
441abc0c57SGeorge Liuassociations:
451abc0c57SGeorge Liu    - name: throttling
461abc0c57SGeorge Liu      description: >
471abc0c57SGeorge Liu          Objects implementing Throttle can optionally implement the
481abc0c57SGeorge Liu          'throttling' association to provide a link to an Item.
491abc0c57SGeorge Liu      reverse_name: throttled_by
501abc0c57SGeorge Liu      required_endpoint_interfaces:
511abc0c57SGeorge Liu          - xyz.openbmc_project.Inventory.Item
52