summaryrefslogtreecommitdiff
path: root/meta-openbmc-mods/meta-common/recipes-phosphor/dbus/phosphor-dbus-interfaces/0019-Creating-the-Session-interface-for-Host-and-LAN.patch
blob: 47fab819b98d7048b446a30957cf28de538af80e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
From 28fac58dc6ef975e1e9283163d9f1e4c7764c3cc Mon Sep 17 00:00:00 2001
From: Suryakanth Sekar <suryakanth.sekar@linux.intel.com>
Date: Sat, 2 Mar 2019 03:31:09 +0530
Subject: [PATCH] Creating the Session interface- for Host and LAN

Defined all needed session properites to manage the session in
host and also in LAN

Change-Id: Ic7cccfc3333a602ee07fcd60077ec58fd8f06304
Signed-off-by: Suryakanth Sekar <suryakanth.sekar@linux.intel.com>

%% original patch: 0019-Creating-the-Session-interface-for-Host-and-LAN.patch
---
 xyz/openbmc_project/Ipmi/SESSION_README.md         | 25 ++++++++++
 .../Ipmi/SessionInfo.interface.yaml                | 57 ++++++++++++++++++++++
 2 files changed, 82 insertions(+)
 create mode 100644 xyz/openbmc_project/Ipmi/SESSION_README.md
 create mode 100644 xyz/openbmc_project/Ipmi/SessionInfo.interface.yaml

diff --git a/xyz/openbmc_project/Ipmi/SESSION_README.md b/xyz/openbmc_project/Ipmi/SESSION_README.md
new file mode 100644
index 0000000..c59b251
--- /dev/null
+++ b/xyz/openbmc_project/Ipmi/SESSION_README.md
@@ -0,0 +1,25 @@
+# Session Management
+
+## Overview
+IPMI RMCP+ sessions are created and maintained by phosphor-ipmi-net daemon,
+whereas we need to provide details about the same using phosphor-ipmi-host.
+Hence IPMI RMCP+ session details has to be exposed through D-Bus interface,
+so that both phosphor-ipmi-host & phosphr-ipmi-net will be in sync.
+
+
+#### xyz.openbmc_project.Ipmi.SessionInfo interface
+##### properties
+* SessionHandle - SessionHandle,unique one-byte number to locate the session.
+* Channel   -  Session created channel.
+* SessionPrivilege - Privilege of the session.
+* RemoteIPAddr  – Remote IP address.
+* RemotePort   - Remote port address.
+* RemoteMACAddress -Remote MAC Address.
+* UserID  - Session created by given user id.
+
+
+
+#### xyz.openbmc_project.Object.Delete
+#### methods
+* Delete - To delete the session object in the system.
+
diff --git a/xyz/openbmc_project/Ipmi/SessionInfo.interface.yaml b/xyz/openbmc_project/Ipmi/SessionInfo.interface.yaml
new file mode 100644
index 0000000..d461628
--- /dev/null
+++ b/xyz/openbmc_project/Ipmi/SessionInfo.interface.yaml
@@ -0,0 +1,57 @@
+description: >
+    Provides properties for IPMI RMCP+ session objects.
+    Provides RMCP+ session information as session objects
+    with Session ID (unique identifier) as path suffix.
+
+properties:
+    - name: SessionHandle
+      type: byte
+      description: >
+          Session Handle,unique number to locate the session.
+      errors:
+          - xyz.openbmc_project.Common.Error.InternalFailure
+    - name: ChannelNum
+      type: byte
+      description: >
+          channelnumber which session is created.
+      errors:
+          - xyz.openbmc_project.Common.Error.InternalFailure
+    - name: CurrentPrivilege
+      type: byte
+      description: >
+          Privilege of the session.
+      errors:
+          - xyz.openbmc_project.Common.Error.InternalFailure
+    - name: RemoteIPAddr
+      type: uint32
+      description: >
+          Remote IP address.
+      errors:
+          - xyz.openbmc_project.Common.Error.InternalFailure
+    - name: RemotePort
+      type: uint16
+      description: >
+          Remote IP Port.
+      errors:
+          - xyz.openbmc_project.Common.Error.InternalFailure
+    - name: RemoteMACAddress
+      type: array[byte]
+      description: >
+          Remote MAC address.
+      errors:
+          - xyz.openbmc_project.Common.Error.InternalFailure
+    - name: UserID
+      type: byte
+      description: >
+           Session created by given user ID.
+      errors:
+          - xyz.openbmc_project.Common.Error.InternalFailure
+    - name: State
+      type: byte
+      default: 0
+      description: >
+          Session state.
+      errors:
+          - xyz.openbmc_project.Common.Error.InternalFailure
+
+# vim: tabstop=8 expandtab shiftwidth=4 softtabstop=4
-- 
2.7.4