phosphor-host-ipmid/user_channel/channel_layer.hpp

8 //      http://www.apache.org/licenses/LICENSE-2.0
36 extern const std::array<std::string, PRIVILEGE_OEM + 1> privList;
39  * @enum Channel Protocol Type (refer spec sec 6.4)
57  * @enum Channel Medium Type (refer spec sec 6.5)
79  * @enum Channel Session Type (refer spec sec 22.24 -
85     single = 1,
91  * @enum Channel Access Mode (refer spec sec 6.6)
96     preboot = 1,
102  * @enum Authentication Types (refer spec sec 13.6 - IPMI
107     none = (1 << 0x0),
108     md2 = (1 << 0x1),
109     md5 = (1 << 0x2),
110     reserved = (1 << 0x3),
111     straightPasswd = (1 << 0x4),
112     oem = (1 << 0x5),
116 // to phosphor-ipmi-host/include
134  * @enum Access mode for channel access set/get (refer spec
135  * sec 22.22 - request byte 2[7:6])
147  * in channel access data configuration.
151     setAccessMode = (1 << 0),
152     setUserAuthEnabled = (1 << 1),
153     setMsgAuthEnabled = (1 << 2),
154     setAlertingEnabled = (1 << 3),
155     setPrivLimit = (1 << 4),
160  *  Structure to store channel access related information, defined in IPMI
161  * specification and used in Get / Set channel access (refer spec sec 22.22
175  *  Structure to store data about channel information, which identifies each
176  *  channel type and information as defined in IPMI specification. (refer spec
186     // This holds the supported AuthTypes for a given channel.
190 /** @brief determines valid channel
192  *  @param[in] chNum- channel number
198 /** @brief determines whether channel device exist
200  *  @param[in] chNum - channel number
208  *  @param[in] privLimit - Privilege limit
216  *  @param[in] accessMode - Access mode
222 /** @brief determines valid authentication type based on channel number
224  *  @param[in] chNum - channel number
225  *  @param[in] authType - authentication type
231 /** @brief determines supported session type of a channel
233  *  @param[in] chNum - channel number
235  *  @return EChannelSessSupported - supported session type
239 /** @brief determines number of active sessions on a channel
241  *  @param[in] chNum - channel number
247 /** @brief determines maximum transfer size for a channel
249  *  @param[in] chNum - channel number
251  *  @return maximum bytes that can be transferred on this channel
255 /** @brief initializes channel management
261 /** @brief provides channel info details
263  *  @param[in] chNum - channel number
264  *  @param[out] chInfo - channel info details
270 /** @brief provides channel access data
272  *  @param[in] chNum - channel number
273  *  @param[out] chAccessData -channel access data
279 /** @brief provides function to convert current channel number (0xE)
281  *  @param[in] chNum - channel number as requested in commands.
282  *  @param[in] devChannel - channel number as provided by device (not 0xE)
284  *  @return same channel number or proper channel number for current channel
297 /** @brief to set channel access data
299  *  @param[in] chNum - channel number
300  *  @param[in] chAccessData - channel access data
301  *  @param[in] setFlag - flag to indicate updatable fields
308 /** @brief to get channel access data persistent data
310  *  @param[in] chNum - channel number
311  *  @param[out] chAccessData - channel access data
318 /** @brief to set channel access data persistent data
320  *  @param[in] chNum - channel number
321  *  @param[in] chAccessData - channel access data
322  *  @param[in] setFlag - flag to indicate updatable fields
330 /** @brief provides supported authentication type for the channel
332  *  @param[in] chNum - channel number
333  *  @param[out] authTypeSupported - supported authentication type
339 /** @brief provides enabled authentication type for the channel
341  *  @param[in] chNum - channel number
342  *  @param[in] priv - privilege
343  *  @param[out] authType - enabled authentication type
350 /** @brief Retrieves the LAN channel name from the IPMI channel number
352  *  @param[in] chNum - IPMI channel number
354  *  @return the LAN channel name (i.e. eth0)
358 /** @brief Retrieves the LAN channel number from the IPMI channel name
360  *  @param[in] chName - IPMI channel name (i.e. eth0)
362  *  @return the LAN channel number
368  *	@param[in] payload type - Payload Type