1import os
2
3OPENBMC_BASE_URI = '/xyz/openbmc_project/'
4OPENBMC_BASE_DBUS = 'xyz.openbmc_project.'
5
6# org open power base URI.
7OPENPOWER_BASE_URI = '/org/open_power/'
8OPENPOWER_CONTROL = OPENPOWER_BASE_URI + 'control/'
9OPENPOWER_SENSORS = OPENPOWER_BASE_URI + 'sensors/'
10
11# REST URI base endpoint paths.
12CONTROL_URI = OPENBMC_BASE_URI + 'control/'
13# old vs new code dependencies in many places.
14# TODO: remove when ready.
15SETTINGS_URI = '/org/openbmc/settings/'
16WATCHDOG_URI = OPENBMC_BASE_URI + 'watchdog/'
17TIME_MANAGER_URI = OPENBMC_BASE_URI + 'time/'
18NETWORK_MANAGER = OPENBMC_BASE_URI + 'network/'
19
20# Sensors base variables.
21SENSORS_URI = OPENBMC_BASE_URI + 'sensors/'
22
23# State Manager base variables
24BMC_REBOOT_TRANS = 'xyz.openbmc_project.State.BMC.Transition.Reboot'
25
26HOST_POWEROFF_TRANS = 'xyz.openbmc_project.State.Host.Transition.Off'
27HOST_POWERON_TRANS = 'xyz.openbmc_project.State.Host.Transition.On'
28HOST_REBOOT_TRANS = 'xyz.openbmc_project.State.Host.Transition.Reboot'
29HOST_POWEROFF_STATE = 'xyz.openbmc_project.State.Host.HostState.Off'
30HOST_POWERON_STATE = 'xyz.openbmc_project.State.Host.HostState.Running'
31
32CHASSIS_POWEROFF_TRANS = 'xyz.openbmc_project.State.Chassis.Transition.Off'
33CHASSIS_POWERON_TRANS = 'xyz.openbmc_project.State.Chassis.Transition.On'
34CHASSIS_POWEROFF_STATE = 'xyz.openbmc_project.State.Chassis.PowerState.Off'
35CHASSIS_POWERON_STATE = 'xyz.openbmc_project.State.Chassis.PowerState.On'
36
37# State Manager URI variables.
38SYSTEM_STATE_URI = OPENBMC_BASE_URI + 'state/'
39BMC_STATE_URI = OPENBMC_BASE_URI + 'state/bmc0/'
40HOST_STATE_URI = OPENBMC_BASE_URI + 'state/host0/'
41CHASSIS_STATE_URI = OPENBMC_BASE_URI + 'state/chassis0/'
42HOST_WATCHDOG_URI = OPENBMC_BASE_URI + 'watchdog/host0/'
43
44# Logging URI variables
45BMC_LOGGING_URI = OPENBMC_BASE_URI + 'logging/'
46BMC_LOGGING_ENTRY = BMC_LOGGING_URI + 'entry/'
47
48# Software manager version
49SOFTWARE_VERSION_URI = OPENBMC_BASE_URI + 'software/'
50ACTIVE = 'xyz.openbmc_project.Software.Activation.Activations.Active'
51READY = 'xyz.openbmc_project.Software.Activation.Activations.Ready'
52INVALID = 'xyz.openbmc_project.Software.Activation.Activations.Invalid'
53ACTIVATING = 'xyz.openbmc_project.Software.Activation.Activations.Activating'
54NOTREADY = 'xyz.openbmc_project.Software.Activation.Activations.NotReady'
55FAILED = 'xyz.openbmc_project.Software.Activation.Activations.Failed'
56
57SOFTWARE_ACTIVATION = 'xyz.openbmc_project.Software.Activation'
58REQUESTED_ACTIVATION = SOFTWARE_ACTIVATION + '.RequestedActivations'
59REQUESTED_ACTIVE = REQUESTED_ACTIVATION + '.Active'
60REQUESTED_NONE = REQUESTED_ACTIVATION + '.None'
61
62SOFTWARE_PURPOSE = 'xyz.openbmc_project.Software.Version.VersionPurpose'
63VERSION_PURPOSE_HOST = SOFTWARE_PURPOSE + '.Host'
64VERSION_PURPOSE_BMC = SOFTWARE_PURPOSE + '.BMC'
65VERSION_PURPOSE_SYSTEM = SOFTWARE_PURPOSE + '.System'
66
67# Image Upload Directory Path
68IMAGE_UPLOAD_DIR_PATH = '/tmp/images/'
69
70# Inventory URI
71HOST_INVENTORY_URI = OPENBMC_BASE_URI + 'inventory/'
72
73# Led URI variable
74LED_GROUPS_URI = OPENBMC_BASE_URI + 'led/groups/'
75LED_PHYSICAL_URI = OPENBMC_BASE_URI + 'led/physical/'
76
77# Host control URI variables.
78CONTROL_HOST_URI = OPENBMC_BASE_URI + 'control/host0/'
79
80# Power restore variables.
81POWER_RESTORE_URI = CONTROL_HOST_URI + 'power_restore_policy'
82CONTROL_DBUS_BASE = 'xyz.openbmc_project.Control.'
83
84RESTORE_LAST_STATE = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.Restore'
85ALWAYS_POWER_ON = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.AlwaysOn'
86ALWAYS_POWER_OFF = CONTROL_DBUS_BASE + 'Power.RestorePolicy.Policy.AlwaysOff'
87
88# Dump URI variables.
89DUMP_URI = OPENBMC_BASE_URI + '/dump/'
90DUMP_ENTRY_URI = DUMP_URI + 'entry/'
91# The path on the BMC where dumps are stored.
92DUMP_DIR_PATH = "/var/lib/phosphor-debug-collector/dumps/"
93
94# Boot progress variables.
95STATE_DBUS_BASE = 'xyz.openbmc_project.State.'
96OS_BOOT_START = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.OSStart'
97OS_BOOT_OFF = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.Unspecified'
98OS_BOOT_PCI = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.PCIInit'
99OS_BOOT_SECPCI = STATE_DBUS_BASE + \
100    'Boot.Progress.ProgressStages.SecondaryProcInit'
101OS_BOOT_MEM = STATE_DBUS_BASE + 'Boot.Progress.ProgressStages.MemoryInit'
102OS_BOOT_MOTHERBOARD = STATE_DBUS_BASE + \
103    'Boot.Progress.ProgressStages.MotherboardInit'
104
105# OperatingSystem status variables.
106OS_BOOT_COMPLETE = STATE_DBUS_BASE + \
107    'OperatingSystem.Status.OSStatus.BootComplete'
108OS_BOOT_CDROM = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.CDROMBoot'
109OS_BOOT_ROM = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.ROMBoot'
110OS_BOOT_PXE = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.PXEBoot'
111OS_BOOT_CBoot = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.CBoot'
112OS_BOOT_DiagBoot = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.DiagBoot'
113
114# Boot variables.
115BOOT_SOURCE_DEFAULT = 'xyz.openbmc_project.Control.Boot.Source.Sources.Default'
116BOOT_SOURCE_NETWORK = 'xyz.openbmc_project.Control.Boot.Source.Sources.Network'
117BOOT_SOURCE_DISK = 'xyz.openbmc_project.Control.Boot.Source.Sources.Disk'
118BOOT_SOURCE_CDROM = 'xyz.openbmc_project.Control.Boot.Source.Sources.ExternalMedia'
119BOOT_MODE_SAFE = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Safe'
120BOOT_MODE_SETUP = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Setup'
121BOOT_MODE_REGULAR = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Regular'
122
123# Time variables.
124TIME_DBUS_BASE = 'xyz.openbmc_project.Time.'
125BMC_OWNER = TIME_DBUS_BASE + 'Owner.Owners.BMC'
126HOST_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Host'
127SPLIT_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Split'
128BOTH_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Both'
129NTP_MODE = TIME_DBUS_BASE + 'Synchronization.Method.NTP'
130MANUAL_MODE = TIME_DBUS_BASE + 'Synchronization.Method.Manual'
131
132# User manager variable.
133BMC_USER_URI = OPENBMC_BASE_URI + 'user/'
134
135# The path on the BMC where signed keys are stored.
136ACTIVATION_DIR_PATH = "/etc/activationdata/"
137
138'''
139  QEMU HTTPS variable:
140
141  By default lib/resource.txt AUTH URI construct is as
142  ${AUTH_URI}   https://${OPENBMC_HOST}${AUTH_SUFFIX}
143  ${AUTH_SUFFIX} is populated here by default EMPTY else
144  the port from the OS environment
145'''
146
147
148def get_port_https():
149    # defaulted to empty string
150    l_suffix = ''
151    try:
152        l_https_port = os.getenv('HTTPS_PORT')
153        if l_https_port:
154            l_suffix = ':' + l_https_port
155    except BaseException:
156        print "Environment variable HTTPS_PORT not set,\
157              using default HTTPS port"
158    return l_suffix
159
160
161AUTH_SUFFIX = {
162    "https_port": [get_port_https()],
163}
164
165# Update the ':Port number' to this variable
166AUTH_SUFFIX = AUTH_SUFFIX['https_port'][0]
167
168# Here contains a list of valid Properties bases on fru_type after a boot.
169INVENTORY_ITEMS = {
170    "CPU": [
171        "Custom Field 1",
172        "Custom Field 2",
173        "Custom Field 3",
174        "Custom Field 4",
175        "Custom Field 5",
176        "Custom Field 6",
177        "Custom Field 7",
178        "Custom Field 8",
179        "FRU File ID",
180        "Manufacturer",
181        "Name",
182        "Part Number",
183        "Serial Number",
184        "fault",
185        "fru_type",
186        "is_fru",
187        "present",
188        "version",
189    ],
190
191    "DIMM": [
192        "Asset Tag",
193        "Custom Field 1",
194        "Custom Field 2",
195        "Custom Field 3",
196        "Custom Field 4",
197        "Custom Field 5",
198        "Custom Field 6",
199        "Custom Field 7",
200        "Custom Field 8",
201        "FRU File ID",
202        "Manufacturer",
203        "Model Number",
204        "Name",
205        "Serial Number",
206        "Version",
207        "fault",
208        "fru_type",
209        "is_fru",
210        "present",
211        "version",
212    ],
213    "MEMORY_BUFFER": [
214        "Custom Field 1",
215        "Custom Field 2",
216        "Custom Field 3",
217        "Custom Field 4",
218        "Custom Field 5",
219        "Custom Field 6",
220        "Custom Field 7",
221        "Custom Field 8",
222        "FRU File ID",
223        "Manufacturer",
224        "Name",
225        "Part Number",
226        "Serial Number",
227        "fault",
228        "fru_type",
229        "is_fru",
230        "present",
231        "version",
232    ],
233    "FAN": [
234        "fault",
235        "fru_type",
236        "is_fru",
237        "present",
238        "version",
239    ],
240    "DAUGHTER_CARD": [
241        "Custom Field 1",
242        "Custom Field 2",
243        "Custom Field 3",
244        "Custom Field 4",
245        "Custom Field 5",
246        "Custom Field 6",
247        "Custom Field 7",
248        "Custom Field 8",
249        "FRU File ID",
250        "Manufacturer",
251        "Name",
252        "Part Number",
253        "Serial Number",
254        "fault",
255        "fru_type",
256        "is_fru",
257        "present",
258        "version",
259    ],
260    "BMC": [
261        "fault",
262        "fru_type",
263        "is_fru",
264        "manufacturer",
265        "present",
266        "version",
267    ],
268    "MAIN_PLANAR": [
269        "Custom Field 1",
270        "Custom Field 2",
271        "Custom Field 3",
272        "Custom Field 4",
273        "Custom Field 5",
274        "Custom Field 6",
275        "Custom Field 7",
276        "Custom Field 8",
277        "Part Number",
278        "Serial Number",
279        "Type",
280        "fault",
281        "fru_type",
282        "is_fru",
283        "present",
284        "version",
285    ],
286    "SYSTEM": [
287        "Custom Field 1",
288        "Custom Field 2",
289        "Custom Field 3",
290        "Custom Field 4",
291        "Custom Field 5",
292        "Custom Field 6",
293        "Custom Field 7",
294        "Custom Field 8",
295        "FRU File ID",
296        "Manufacturer",
297        "Model Number",
298        "Name",
299        "Serial Number",
300        "Version",
301        "fault",
302        "fru_type",
303        "is_fru",
304        "present",
305        "version",
306    ],
307    "CORE": [
308        "fault",
309        "fru_type",
310        "is_fru",
311        "present",
312        "version",
313    ],
314}
315