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