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