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 + 'OperatingSystem.Status.OSStatus.BootComplete'
107OS_BOOT_CDROM =  STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.CDROMBoot'
108OS_BOOT_ROM = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.ROMBoot'
109OS_BOOT_PXE = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.PXEBoot'
110OS_BOOT_CBoot = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.CBoot'
111OS_BOOT_DiagBoot = STATE_DBUS_BASE + 'OperatingSystem.Status.OSStatus.DiagBoot'
112
113# Boot variables.
114BOOT_SOURCE_DEFAULT = 'xyz.openbmc_project.Control.Boot.Source.Sources.Default'
115BOOT_SOURCE_NETWORK = 'xyz.openbmc_project.Control.Boot.Source.Sources.Network'
116BOOT_SOURCE_DISK = 'xyz.openbmc_project.Control.Boot.Source.Sources.Disk'
117BOOT_SOURCE_CDROM = 'xyz.openbmc_project.Control.Boot.Source.Sources.ExternalMedia'
118BOOT_MODE_SAFE = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Safe'
119BOOT_MODE_SETUP = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Setup'
120BOOT_MODE_REGULAR = 'xyz.openbmc_project.Control.Boot.Mode.Modes.Regular'
121
122# Time variables.
123TIME_DBUS_BASE = 'xyz.openbmc_project.Time.'
124BMC_OWNER = TIME_DBUS_BASE + 'Owner.Owners.BMC'
125HOST_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Host'
126SPLIT_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Split'
127BOTH_OWNER = TIME_DBUS_BASE + 'Owner.Owners.Both'
128NTP_MODE = TIME_DBUS_BASE + 'Synchronization.Method.NTP'
129MANUAL_MODE = TIME_DBUS_BASE + 'Synchronization.Method.Manual'
130
131# User manager variable.
132BMC_USER_URI = OPENBMC_BASE_URI + 'user/'
133
134'''
135  QEMU HTTPS variable:
136
137  By default lib/resource.txt AUTH URI construct is as
138  ${AUTH_URI}   https://${OPENBMC_HOST}${AUTH_SUFFIX}
139  ${AUTH_SUFFIX} is populated here by default EMPTY else
140  the port from the OS environment
141'''
142
143
144def get_port_https():
145    # defaulted to empty string
146    l_suffix = ''
147    try:
148        l_https_port = os.getenv('HTTPS_PORT')
149        if l_https_port:
150            l_suffix = ':' + l_https_port
151    except:
152        print "Environment variable HTTPS_PORT not set,\
153              using default HTTPS port"
154    return l_suffix
155
156AUTH_SUFFIX = {
157    "https_port": [get_port_https()],
158}
159
160# Update the ':Port number' to this variable
161AUTH_SUFFIX = AUTH_SUFFIX['https_port'][0]
162
163# Here contains a list of valid Properties bases on fru_type after a boot.
164INVENTORY_ITEMS = {
165    "CPU": [
166        "Custom Field 1",
167        "Custom Field 2",
168        "Custom Field 3",
169        "Custom Field 4",
170        "Custom Field 5",
171        "Custom Field 6",
172        "Custom Field 7",
173        "Custom Field 8",
174        "FRU File ID",
175        "Manufacturer",
176        "Name",
177        "Part Number",
178        "Serial Number",
179        "fault",
180        "fru_type",
181        "is_fru",
182        "present",
183        "version",
184        ],
185
186    "DIMM": [
187        "Asset Tag",
188        "Custom Field 1",
189        "Custom Field 2",
190        "Custom Field 3",
191        "Custom Field 4",
192        "Custom Field 5",
193        "Custom Field 6",
194        "Custom Field 7",
195        "Custom Field 8",
196        "FRU File ID",
197        "Manufacturer",
198        "Model Number",
199        "Name",
200        "Serial Number",
201        "Version",
202        "fault",
203        "fru_type",
204        "is_fru",
205        "present",
206        "version",
207        ],
208    "MEMORY_BUFFER": [
209        "Custom Field 1",
210        "Custom Field 2",
211        "Custom Field 3",
212        "Custom Field 4",
213        "Custom Field 5",
214        "Custom Field 6",
215        "Custom Field 7",
216        "Custom Field 8",
217        "FRU File ID",
218        "Manufacturer",
219        "Name",
220        "Part Number",
221        "Serial Number",
222        "fault",
223        "fru_type",
224        "is_fru",
225        "present",
226        "version",
227        ],
228    "FAN": [
229        "fault",
230        "fru_type",
231        "is_fru",
232        "present",
233        "version",
234        ],
235    "DAUGHTER_CARD": [
236        "Custom Field 1",
237        "Custom Field 2",
238        "Custom Field 3",
239        "Custom Field 4",
240        "Custom Field 5",
241        "Custom Field 6",
242        "Custom Field 7",
243        "Custom Field 8",
244        "FRU File ID",
245        "Manufacturer",
246        "Name",
247        "Part Number",
248        "Serial Number",
249        "fault",
250        "fru_type",
251        "is_fru",
252        "present",
253        "version",
254        ],
255    "BMC": [
256        "fault",
257        "fru_type",
258        "is_fru",
259        "manufacturer",
260        "present",
261        "version",
262        ],
263    "MAIN_PLANAR": [
264        "Custom Field 1",
265        "Custom Field 2",
266        "Custom Field 3",
267        "Custom Field 4",
268        "Custom Field 5",
269        "Custom Field 6",
270        "Custom Field 7",
271        "Custom Field 8",
272        "Part Number",
273        "Serial Number",
274        "Type",
275        "fault",
276        "fru_type",
277        "is_fru",
278        "present",
279        "version",
280        ],
281    "SYSTEM": [
282        "Custom Field 1",
283        "Custom Field 2",
284        "Custom Field 3",
285        "Custom Field 4",
286        "Custom Field 5",
287        "Custom Field 6",
288        "Custom Field 7",
289        "Custom Field 8",
290        "FRU File ID",
291        "Manufacturer",
292        "Model Number",
293        "Name",
294        "Serial Number",
295        "Version",
296        "fault",
297        "fru_type",
298        "is_fru",
299        "present",
300        "version",
301        ],
302    "CORE": [
303        "fault",
304        "fru_type",
305        "is_fru",
306        "present",
307        "version",
308        ],
309}
310