xref: /openbmc/phosphor-host-ipmid/include/ipmid/sessiondef.hpp (revision a8205ff68bda219245c7079f8f27ff2299528d68)
1 /*
2  * Copyright © 2019 Intel Corporation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 #pragma once
18 
19 #include <stddef.h>
20 #include <stdint.h>
21 
22 namespace session
23 {
24 
25 static constexpr auto sessionManagerRootPath =
26     "/xyz/openbmc_project/ipmi/session";
27 static constexpr auto sessionIntf = "xyz.openbmc_project.Ipmi.SessionInfo";
28 static constexpr uint8_t ipmi20VerSession = 0x01;
29 static constexpr size_t maxSessionCountPerChannel = 15;
30 static constexpr size_t sessionZero = 0;
31 static constexpr size_t maxSessionlessCount = 1;
32 static constexpr uint8_t invalidSessionID = 0;
33 static constexpr uint8_t invalidSessionHandle = 0;
34 static constexpr uint8_t defaultSessionHandle = 0xFF;
35 static constexpr uint8_t maxNetworkInstanceSupported = 4;
36 static constexpr uint8_t ccInvalidSessionId = 0x87;
37 static constexpr uint8_t ccInvalidSessionHandle = 0x88;
38 static constexpr uint8_t searchCurrentSession = 0;
39 static constexpr uint8_t searchSessionByHandle = 0xFE;
40 static constexpr uint8_t searchSessionById = 0xFF;
41 // MSB BIT 7 BIT 6 assigned for netipmid instance in session handle.
42 static constexpr uint8_t multiIntfaceSessionHandleMask = 0x3F;
43 
44 // MSB BIT 31-BIT30 assigned for netipmid instance in session ID
45 static constexpr uint32_t multiIntfaceSessionIDMask = 0x3FFFFFFF;
46 
47 enum class State : uint8_t
48 {
49     inactive,           // Session is not in use
50     setupInProgress,    // Session Setup Sequence is progressing
51     active,             // Session is active
52     tearDownInProgress, // When Closing Session
53 };
54 
55 } // namespace session
56