blob: 046ac7730ba41a725be479e56c7204b317431371 [file] [log] [blame]
Willy Tua2056e92021-10-10 13:36:16 -07001// 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
Patrick Venture4d49ae62018-09-17 11:35:32 -070015#pragma once
16
Patrick Venturef085d912019-03-15 08:50:00 -070017#include "handler.hpp"
18
William A. Kennington III2c9e1622019-02-07 15:45:19 -080019#include <ipmid/api.h>
Patrick Venture4d49ae62018-09-17 11:35:32 -070020
21namespace google
22{
23namespace ipmi
24{
25
Patrick Venture5d26d832019-03-13 16:31:09 -070026// The reply to the ethdevice command specifies the
Patrick Venture45fad1b2019-03-18 16:52:14 -070027// IPMI channel number and the ifName used for the
Patrick Venture5d26d832019-03-13 16:31:09 -070028// ncis connection.
29struct EthDeviceReply
30{
31 uint8_t subcommand;
32 uint8_t channel;
Patrick Venture45fad1b2019-03-18 16:52:14 -070033 // ifNameLength doesn't include the null-terminator.
34 uint8_t ifNameLength;
Patrick Venture5d26d832019-03-13 16:31:09 -070035} __attribute__((packed));
36
Patrick Venture4d49ae62018-09-17 11:35:32 -070037// Handle the eth query command.
Patrick Venture45fad1b2019-03-18 16:52:14 -070038// Sys can query the ifName and IPMI channel of the BMC's NCSI ethernet
Patrick Venture4d49ae62018-09-17 11:35:32 -070039// device.
Patrick Venture45fad1b2019-03-18 16:52:14 -070040ipmi_ret_t getEthDevice(const uint8_t* reqBuf, uint8_t* replyBuf,
Patrick Venturec87de552020-05-20 20:25:39 -070041 size_t* dataLen, const HandlerInterface* handler);
Patrick Venture4d49ae62018-09-17 11:35:32 -070042
43} // namespace ipmi
44} // namespace google