Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / entity-manager / 7ee0961d8ae15b504771f8f021937e4477de618c / . / schemas / ibm.json
blob: dd3ec89b9de2a4553408d7a2f2ad260b742b59d1 [file] [log] [blame]
Brad Bishop4afe7082020-10-01 09:59:26 -0400[diff] [blame]1{
2 "$schema": "http://json-schema.org/draft-07/schema#",
Patrick Williams7d6080d2024-09-04 12:54:45 -0400[diff] [blame]3 "$defs": {
Brad Bishop4afe7082020-10-01 09:59:26 -0400[diff] [blame]4 "IBMCFFPSConnector": {
5 "title": "IBM Common Form Factor (CFF) Power Supply connectors",
Andrew Jefferybb8aa372024-03-20 11:24:32 +1030[diff] [blame]6 "description": "A schema associating an I2C endpoint and a GPIO for IBM CFF power supplies. In the entity-manager detector-configuration-reactor architecture, the daemon that supports IBM CFFPS is both a detector and reactor. It probes the endpoints described by this schema (reactor) and publishes the CFFPS FRU information (detector).",
Brad Bishop4afe7082020-10-01 09:59:26 -0400[diff] [blame]7 "type": "object",
8 "properties": {
9 "Name": {
10 "type": "string"
11 },
12 "Type": {
Patrick Williamsfa8ee872022-12-07 07:00:42 -0600[diff] [blame]13 "enum": ["IBMCFFPSConnector"]
Brad Bishop4afe7082020-10-01 09:59:26 -0400[diff] [blame]14 },
15 "I2CBus": {
Andrew Jefferybb8aa372024-03-20 11:24:32 +1030[diff] [blame]16 "description": "The I2C address on which to probe for a CFFPS.",
Brad Bishop4afe7082020-10-01 09:59:26 -0400[diff] [blame]17 "type": "number"
18 },
19 "I2CAddress": {
Andrew Jefferybb8aa372024-03-20 11:24:32 +1030[diff] [blame]20 "description": "The I2C bus number on which to probe for a CFFPS.",
Brad Bishop4afe7082020-10-01 09:59:26 -0400[diff] [blame]21 "type": "number"
22 },
23 "NamedPresenceGpio": {
Andrew Jefferybb8aa372024-03-20 11:24:32 +1030[diff] [blame]24 "description": "The name of the GPIO to monitor that indicates CFFPS plug state.",
Brad Bishop4afe7082020-10-01 09:59:26 -0400[diff] [blame]25 "type": "string"
26 }
27 },
28 "required": [
29 "Name",
30 "Type",
31 "I2CBus",
32 "I2CAddress",
33 "NamedPresenceGpio"
34 ]
Brad Bishop648ae632020-10-09 08:20:12 -0400[diff] [blame]35 },
36 "IBMCompatibleSystem": {
37 "title": "System compatibility",
Andrew Jefferybb8aa372024-03-20 11:24:32 +1030[diff] [blame]38 "description": "Devicetree-like compatibility strings for systems, where a 'system' is roughly defined as the combination of a chassis and a mainboard. The strings should be used by applications to match the entity with entries or configuration in a hardware database. Strings appear in the list from most specific to most general. This allows an entity to express compatibility with a family of similar systems, in turn allowing an application to match a variety of systems with a single IBMCompatibleSystem entry. The recommended entry format is 'manufacturer,model' where the manufacturer is a string describing the name of the manufacturer and model specifies the model number.",
Brad Bishop648ae632020-10-09 08:20:12 -0400[diff] [blame]39 "type": "object",
40 "properties": {
41 "Name": {
42 "type": "string"
43 },
44 "Type": {
Patrick Williamsfa8ee872022-12-07 07:00:42 -0600[diff] [blame]45 "enum": ["IBMCompatibleSystem"]
Brad Bishop648ae632020-10-09 08:20:12 -0400[diff] [blame]46 },
47 "Names": {
48 "type": "array",
49 "items": {
50 "enum": [
Matt Spinler513976b2024-05-13 11:24:03 -0500[diff] [blame]51 "ibm,blueridge",
52 "ibm,blueridge-1s4u",
53 "ibm,blueridge-2u",
54 "ibm,blueridge-4u",
Adriana Kobylak0b5b1222023-01-31 14:15:27 -0600[diff] [blame]55 "ibm,bonnell",
Andrew Geisslerc7c5de72020-12-16 09:47:21 -0600[diff] [blame]56 "ibm,everest",
Matt Spinler6ef5f712024-05-13 11:19:40 -0500[diff] [blame]57 "ibm,fuji",
Brad Bishop5f4a0262020-10-09 08:30:19 -0400[diff] [blame]58 "ibm,rainier-2u",
Andrew Geissler3e55ec42021-03-11 14:04:27 -0600[diff] [blame]59 "ibm,rainier-1s4u",
Brad Bishop5f4a0262020-10-09 08:30:19 -0400[diff] [blame]60 "ibm,rainier-4u",
61 "ibm,rainier"
Brad Bishop648ae632020-10-09 08:20:12 -0400[diff] [blame]62 ]
63 }
64 }
65 },
Patrick Williamsfa8ee872022-12-07 07:00:42 -0600[diff] [blame]66 "required": ["Name", "Type", "Names"]
Chris Cain04b0b012021-12-14 16:19:05 -0600[diff] [blame]67 },
68 "PowerModeProperties": {
69 "title": "PowerMode Properties",
Andrew Jefferybb8aa372024-03-20 11:24:32 +1030[diff] [blame]70 "description": "The default PowerMode properties for the system",
Chris Cain04b0b012021-12-14 16:19:05 -0600[diff] [blame]71 "type": "object",
72 "properties": {
73 "PowerMode": {
Andrew Jefferybb8aa372024-03-20 11:24:32 +1030[diff] [blame]74 "description": "The default PowerMode to use prior to being set by a user.",
Chris Cain04b0b012021-12-14 16:19:05 -0600[diff] [blame]75 "enum": ["Static", "PowerSaving", "MaximumPerformance"]
76 },
77 "IdlePowerSaverEnabled": {
Andrew Jefferybb8aa372024-03-20 11:24:32 +1030[diff] [blame]78 "description": "Default state of idle power saver mode. Setting to true will enable idle power saver.",
Chris Cain04b0b012021-12-14 16:19:05 -0600[diff] [blame]79 "type": "boolean"
80 },
81 "EnterUtilizationPercent": {
Andrew Jefferybb8aa372024-03-20 11:24:32 +1030[diff] [blame]82 "description": "The default percentage of utilization that the system shall be lower than to enter idle power save. The value is in integer percentage values (10 = 10%). EnterUtilizationPercent must be <= ExitUtilizationPercent",
Chris Cain04b0b012021-12-14 16:19:05 -0600[diff] [blame]83 "type": "number",
84 "minimum": 1,
85 "maximum": 95
86 },
87 "EnterUtilizationDwellTime": {
Andrew Jefferybb8aa372024-03-20 11:24:32 +1030[diff] [blame]88 "description": "The default duration in seconds that the system is below the EnterUtilizationPercent before idle power save is activated.",
Chris Cain04b0b012021-12-14 16:19:05 -0600[diff] [blame]89 "type": "number",
90 "minimum": 10,
91 "maximum": 600
92 },
93 "ExitUtilizationPercent": {
Andrew Jefferybb8aa372024-03-20 11:24:32 +1030[diff] [blame]94 "description": "The default percentage of utilization that the system shall be above in order to exit idle power save. The value is in integer percentage values (10 = 10%). ExitUtilizationPercent must be >= EnterUtilizationPercent",
Chris Cain04b0b012021-12-14 16:19:05 -0600[diff] [blame]95 "type": "number",
96 "minimum": 5,
97 "maximum": 95
98 },
99 "ExitUtilizationDwellTime": {
Andrew Jefferybb8aa372024-03-20 11:24:32 +1030[diff] [blame]100 "description": "The default duration in seconds that the system is above the ExitUtilizationPercent before idle power save is deactivated.",
Chris Cain04b0b012021-12-14 16:19:05 -0600[diff] [blame]101 "type": "number",
102 "minimum": 10,
103 "maximum": 600
104 }
105 },
106 "required": ["PowerMode", "IdlePowerSaverEnabled"]
Brad Bishop4afe7082020-10-01 09:59:26 -0400[diff] [blame]107 }
108 }
109}