xref: /openbmc/google-ipmi-sys/eth.hpp (revision 444b5ea4)
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 
23 #include <span>
24 
25 namespace google
26 {
27 namespace ipmi
28 {
29 
30 // The reply to the ethdevice command specifies the
31 // IPMI channel number and the ifName used for the
32 // ncis connection.
33 struct EthDeviceReply
34 {
35     uint8_t channel;
36     // ifNameLength doesn't include the null-terminator.
37     uint8_t ifNameLength;
38 } __attribute__((packed));
39 
40 // Handle the eth query command.
41 // Sys can query the ifName and IPMI channel of the BMC's NCSI ethernet
42 // device.
43 Resp getEthDevice(std::span<const uint8_t> data,
44                   const HandlerInterface* handler);
45 
46 } // namespace ipmi
47 } // namespace google
48