xref: /openbmc/google-ipmi-sys/eth.hpp (revision 40fe5222)
1 // Copyright 2021 Google LLC
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 //      http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #pragma once
16 
17 #include "handler.hpp"
18 
19 #include <ipmid/api.h>
20 
21 #include <ipmid/api-types.hpp>
22 #include <span>
23 
24 namespace google
25 {
26 namespace ipmi
27 {
28 
29 // The reply to the ethdevice command specifies the
30 // IPMI channel number and the ifName used for the
31 // ncis connection.
32 struct EthDeviceReply
33 {
34     uint8_t channel;
35     // ifNameLength doesn't include the null-terminator.
36     uint8_t ifNameLength;
37 } __attribute__((packed));
38 
39 // Handle the eth query command.
40 // Sys can query the ifName and IPMI channel of the BMC's NCSI ethernet
41 // device.
42 Resp getEthDevice(std::span<const uint8_t> data,
43                   const HandlerInterface* handler);
44 
45 } // namespace ipmi
46 } // namespace google
47