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_GRACEFULL_OFF = "GracefulShutdown"
152POWER_FORCE_OFF = 'ForceOff'
153
154REDFISH_POWER_URI = 'Systems/1/Actions/ComputerSystem.Reset'
155
156# rsyslog variables.
157REMOTE_LOGGING_URI = OPENBMC_BASE_URI + 'logging/config/remote/'
158
159# Certificate variables.
160SERVER_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/server/https'
161CLIENT_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/client/ldap'
162CA_CERTIFICATE_URI = OPENBMC_BASE_URI + 'certs/authority/ldap'
163
164'''
165  QEMU HTTPS variable:
166
167  By default lib/resource.txt AUTH URI construct is as
168  ${AUTH_URI}   https://${OPENBMC_HOST}${AUTH_SUFFIX}
169  ${AUTH_SUFFIX} is populated here by default EMPTY else
170  the port from the OS environment
171'''
172
173
174def get_port_https():
175    # defaulted to empty string
176    l_suffix = ''
177    try:
178        l_https_port = os.getenv('HTTPS_PORT')
179        if l_https_port:
180            l_suffix = ':' + l_https_port
181    except BaseException:
182        print ("Environment variable HTTPS_PORT not set,\
183              using default HTTPS port")
184    return l_suffix
185
186
187AUTH_SUFFIX = {
188    "https_port": [get_port_https()],
189}
190
191# Update the ':Port number' to this variable
192AUTH_SUFFIX = AUTH_SUFFIX['https_port'][0]
193
194# Here contains a list of valid Properties bases on fru_type after a boot.
195INVENTORY_ITEMS = {
196    "CPU": [
197        "Custom Field 1",
198        "Custom Field 2",
199        "Custom Field 3",
200        "Custom Field 4",
201        "Custom Field 5",
202        "Custom Field 6",
203        "Custom Field 7",
204        "Custom Field 8",
205        "FRU File ID",
206        "Manufacturer",
207        "Name",
208        "Part Number",
209        "Serial Number",
210        "fault",
211        "fru_type",
212        "is_fru",
213        "present",
214        "version",
215    ],
216
217    "DIMM": [
218        "Asset Tag",
219        "Custom Field 1",
220        "Custom Field 2",
221        "Custom Field 3",
222        "Custom Field 4",
223        "Custom Field 5",
224        "Custom Field 6",
225        "Custom Field 7",
226        "Custom Field 8",
227        "FRU File ID",
228        "Manufacturer",
229        "Model Number",
230        "Name",
231        "Serial Number",
232        "Version",
233        "fault",
234        "fru_type",
235        "is_fru",
236        "present",
237        "version",
238    ],
239    "MEMORY_BUFFER": [
240        "Custom Field 1",
241        "Custom Field 2",
242        "Custom Field 3",
243        "Custom Field 4",
244        "Custom Field 5",
245        "Custom Field 6",
246        "Custom Field 7",
247        "Custom Field 8",
248        "FRU File ID",
249        "Manufacturer",
250        "Name",
251        "Part Number",
252        "Serial Number",
253        "fault",
254        "fru_type",
255        "is_fru",
256        "present",
257        "version",
258    ],
259    "FAN": [
260        "fault",
261        "fru_type",
262        "is_fru",
263        "present",
264        "version",
265    ],
266    "DAUGHTER_CARD": [
267        "Custom Field 1",
268        "Custom Field 2",
269        "Custom Field 3",
270        "Custom Field 4",
271        "Custom Field 5",
272        "Custom Field 6",
273        "Custom Field 7",
274        "Custom Field 8",
275        "FRU File ID",
276        "Manufacturer",
277        "Name",
278        "Part Number",
279        "Serial Number",
280        "fault",
281        "fru_type",
282        "is_fru",
283        "present",
284        "version",
285    ],
286    "BMC": [
287        "fault",
288        "fru_type",
289        "is_fru",
290        "manufacturer",
291        "present",
292        "version",
293    ],
294    "MAIN_PLANAR": [
295        "Custom Field 1",
296        "Custom Field 2",
297        "Custom Field 3",
298        "Custom Field 4",
299        "Custom Field 5",
300        "Custom Field 6",
301        "Custom Field 7",
302        "Custom Field 8",
303        "Part Number",
304        "Serial Number",
305        "Type",
306        "fault",
307        "fru_type",
308        "is_fru",
309        "present",
310        "version",
311    ],
312    "SYSTEM": [
313        "Custom Field 1",
314        "Custom Field 2",
315        "Custom Field 3",
316        "Custom Field 4",
317        "Custom Field 5",
318        "Custom Field 6",
319        "Custom Field 7",
320        "Custom Field 8",
321        "FRU File ID",
322        "Manufacturer",
323        "Model Number",
324        "Name",
325        "Serial Number",
326        "Version",
327        "fault",
328        "fru_type",
329        "is_fru",
330        "present",
331        "version",
332    ],
333    "CORE": [
334        "fault",
335        "fru_type",
336        "is_fru",
337        "present",
338        "version",
339    ],
340}
341