Skip to content

Commit 58729b7

Browse files
committed
Add Provisioning YAML File
Signed-off-by: Isha Sahni <[email protected]>
1 parent fd382fe commit 58729b7

File tree

4 files changed

+136
-0
lines changed

4 files changed

+136
-0
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Generated file; do not modify.
2+
3+
sdbusplus_current_path = 'xyz/openbmc_project/Provisioning/Provisioning'
4+
5+
generated_sources += custom_target(
6+
'xyz/openbmc_project/Provisioning/Provisioning__cpp'.underscorify(),
7+
input: [
8+
'../../../../../yaml/xyz/openbmc_project/Provisioning/Provisioning.interface.yaml',
9+
],
10+
output: [
11+
'common.hpp',
12+
'server.hpp',
13+
'server.cpp',
14+
'aserver.hpp',
15+
'client.hpp',
16+
],
17+
depend_files: sdbusplusplus_depfiles,
18+
command: [
19+
sdbuspp_gen_meson_prog,
20+
'--command',
21+
'cpp',
22+
'--output',
23+
meson.current_build_dir(),
24+
'--tool',
25+
sdbusplusplus_prog,
26+
'--directory',
27+
meson.current_source_dir() / '../../../../../yaml',
28+
'xyz/openbmc_project/Provisioning/Provisioning',
29+
],
30+
install: should_generate_cpp,
31+
install_dir: [
32+
get_option('includedir') / sdbusplus_current_path,
33+
get_option('includedir') / sdbusplus_current_path,
34+
false,
35+
get_option('includedir') / sdbusplus_current_path,
36+
get_option('includedir') / sdbusplus_current_path,
37+
],
38+
build_by_default: should_generate_cpp,
39+
)
40+
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Generated file; do not modify.
2+
subdir('Provisioning')
3+
4+
sdbusplus_current_path = 'xyz/openbmc_project/Provisioning'
5+
6+
generated_markdown += custom_target(
7+
'xyz/openbmc_project/Provisioning/Provisioning__markdown'.underscorify(),
8+
input: [
9+
'../../../../yaml/xyz/openbmc_project/Provisioning/Provisioning.interface.yaml',
10+
],
11+
output: ['Provisioning.md'],
12+
depend_files: sdbusplusplus_depfiles,
13+
command: [
14+
sdbuspp_gen_meson_prog,
15+
'--command',
16+
'markdown',
17+
'--output',
18+
meson.current_build_dir(),
19+
'--tool',
20+
sdbusplusplus_prog,
21+
'--directory',
22+
meson.current_source_dir() / '../../../../yaml',
23+
'xyz/openbmc_project/Provisioning/Provisioning',
24+
],
25+
install: should_generate_markdown,
26+
install_dir: [inst_markdown_dir / sdbusplus_current_path],
27+
build_by_default: should_generate_markdown,
28+
)
29+

gen/xyz/openbmc_project/meson.build

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ subdir('Object')
2727
subdir('ObjectMapper')
2828
subdir('PFR')
2929
subdir('PLDM')
30+
subdir('Provisioning')
3031
subdir('ScheduledTime')
3132
subdir('Sensor')
3233
subdir('Smbios')
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
description: >
2+
Interface representing the provisioning state and peer connectivity status
3+
of the BMC. It provides properties to indicate whether the BMC has been
4+
provisioned and the current connection state with the peer BMC, along with a
5+
method to initiate peer provisioning and a signal to report its result.
6+
7+
properties:
8+
- name: Provisioned
9+
type: boolean
10+
flags:
11+
- readonly
12+
description: >
13+
True means the BMC is in a provisioned state.
14+
- name: PeerConnected
15+
type: enum[self.PeerConnectionStatus]
16+
flags:
17+
- readonly
18+
default: NotDetermined
19+
description: >
20+
Represents the connection status with the peer BMC.
21+
22+
methods:
23+
- name: ProvisionPeer
24+
description: >
25+
Starts the provisioning process on the peerBmc .
26+
parameters:
27+
- name: bmcId
28+
type: string
29+
description: >
30+
Identifier of the peer BMC to be provisioned.
31+
32+
signals:
33+
- name: PeerProvisioned
34+
description: >
35+
Emitted when the ProvisionPeer method completes. The signal carries a
36+
boolean indicating whether provisioning on the peer succeeded or
37+
failed.
38+
properties:
39+
- type: boolean
40+
description: >
41+
True if provisioning on the peer BMC succeeded, false if it
42+
failed.
43+
44+
enumerations:
45+
- name: PeerConnectionStatus
46+
description: >
47+
Enumerates the possible states of peer BMC connectivity.
48+
values:
49+
- name: NotDetermined
50+
description: >
51+
The peer connection status has not been determined yet.
52+
- name: InProgress
53+
description: >
54+
The system is currently attempting to determine the connection
55+
status with the peer BMC.
56+
- name: Connected
57+
description: >
58+
The peer BMC is detected and reachable.
59+
- name: NotConnected
60+
description: >
61+
Peer BMC connection failed.
62+
63+
paths:
64+
- instance: /xyz/openbmc_project/Provisioning
65+
description: >
66+
Expected path of the Provisioning interface instance.

0 commit comments

Comments
 (0)