Lines Matching +full:channel +full:-
8 // http://www.apache.org/licenses/LICENSE-2.0
19 #include "ipmid/api-types.hpp"
45 * Structure to store both non-volatile and volatile channel access information
56 * Structure for channel information - base structure to get all information
57 * about the channel.(refer spec sec 22.22 to 22.24)
86 /** @brief determines valid channel
88 * @param[in] chNum - channel number
96 * @param[in] chNum - channel number
97 * @param[in] authType - authentication type
103 /** @brief function to get channel name from channel number
105 * @param[in] chNum - channel number index
107 * @return network channel interface name
111 /** @brief function to get channel number from channel name
113 * @param[in] chName - channel name
115 * @return network channel interface number
123 /** @brief determines supported session type of a channel
125 * @param[in] chNum - channel number
127 * @return EChannelSessSupported - supported session type
131 /** @brief determines number of active sessions on a channel
133 * @param[in] chNum - channel number
139 /** @brief determines maximum transfer size for a channel
141 * @param[in] chNum - channel number
143 * @return maximum bytes that can be transferred on this channel
147 /** @brief provides channel info details
149 * @param[in] chNum - channel number
150 * @param[out] chInfo - channel info details
156 /** @brief provides channel access data
158 * @param[in] chNum - channel number
159 * @param[out] chAccessData - channel access data
165 /** @brief to set channel access data
167 * @param[in] chNum - channel number
168 * @param[in] chAccessData - channel access data
169 * @param[in] setFlag - flag to indicate updatable fields
177 /** @brief to get channel access data persistent data
179 * @param[in] chNum - channel number
180 * @param[out] chAccessData - channel access data
187 /** @brief to set channel access data persistent data
189 * @param[in] chNum - channel number
190 * @param[in] chAccessData - channel access data
191 * @param[in] setFlag - flag to indicate updatable fields
199 /** @brief provides supported authentication type for the channel
201 * @param[in] chNum - channel number
202 * @param[out] authTypeSupported - supported authentication type
209 /** @brief provides enabled authentication type for the channel
211 * @param[in] chNum - channel number
212 * @param[in] priv - privilege
213 * @param[out] authType - enabled authentication type
220 /** @brief conver to channel privilege from system privilege
222 * @param[in] value - privilege value
224 * @return Channel privilege
228 /** @brief function to write persistent channel configuration to config file
230 * @return 0 for success, -errno for failure.
234 /** @brief function to write volatile channel configuration to config file
236 * @return 0 for success, -errno for failure.
240 /** @brief Returns the IPMI channel ID authorized to push IPMI privilege
241 * changes to phosphor-user-manager. Any channel access changes made on
242 * any other channel are ignored.
244 * @return IPMI channel ID as defined in channel_config.json
260 /** @brief function to initialize persistent channel configuration
265 /** @brief function to set default channel configuration based on channel
268 * @param[in] chNum - channel number
269 * @param[in] chName - channel name
274 /** @brief function to load all channel configuration
276 * @return 0 for success, -errno for failure.
280 /** @brief function to read persistent channel data
282 * @return 0 for success, -errno for failure.
286 /** @brief function to read volatile channel data
288 * @return 0 for success, -errno for failure.
292 /** @brief function to check and reload persistent channel data
294 * @return 0 for success, -errno for failure.
298 /** @brief function to check and reload volatile channel data
300 * @return 0 for success, -errno for failure.
304 /** @brief function to sync channel privilege with system network channel
307 * @return 0 for success, -errno for failure.
311 /** @brief function to set D-Bus property value
313 * @param[in] service - service name
314 * @param[in] objPath - object path
315 * @param[in] interface - interface
316 * @param[in] property - property name
317 * @param[in] value - property value
319 * @return 0 for success, -errno for failure.
327 * @param[in] configFile - configuration file name
335 * @param[in] configFile - configuration file name
336 * @param[in] jsonData - json object
338 * @return 0 for success, -errno for failure.
342 /** @brief function to convert system access mode to Channel access mode
345 * @param[in] mode - access mode in string
347 * @return Channel access mode.
353 * @param[in] value - acess mode value
361 * @param[in] value - privilege value
369 * @param[in] value - session support type in string
378 * @param[in] value - medium type in string
380 * @return channel medium type
386 * @param[in] value - protocol type in string
388 * @return channel protocol type
392 /** @brief function to convert channel name to the IPMI channel number.
394 * @param[in] chName - the channel name defined in the JSON input file
397 * @return IPMI channel number
401 /** @brief function to handle Channel access property update through the
402 * D-Bus handler.
404 * @param[in] path - D-Bus path to the network element (i.e. eth0)
405 * @param[in] chProperties - D-Bus channel properties
412 * @param[in] fileName - the name of the file for which to acquire
419 /** @brief function to convert the DBus path to a network channel name
421 * @param[in] path - The DBus path to the device
423 * @return network channel name (i.e. eth0)