drive.hpp

/*
// Copyright (c) 2021 Intel Corporation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
*/

#pragma once

#include "numeric_sensor.hpp"

#include <mctp_wrapper.hpp>
#include <sdbusplus/asio/object_server.hpp>
#include <string>

namespace nvmemi
{
/**
 * @brief Represents NVMe drive
 *
 */
class Drive
{
  public:
    /**
     * @brief Construct a new Drive object
     *
     * @param driveName Human readable name for the drive
     * @param eid MCTP EID of the drive
     * @param objServer Existing sdbusplus object_server
     * @param wrapper shared_ptr to MCTPWrapper
     */
    Drive(const std::string& driveName, mctpw::eid_t eid,
          sdbusplus::asio::object_server& objServer,
          std::shared_ptr<mctpw::MCTPWrapper> wrapper);
    /**
     * @brief Send MCTP request for NVM Subsystem health status poll and receive
     * response
     *
     * @param yield yield_context object to wait on mctp transfers
     */
    void pollSubsystemHealthStatus(boost::asio::yield_context yield);

  private:
    std::tuple<int, std::string>
        collectDriveLog(boost::asio::yield_context yield);

    std::string name{};
    std::shared_ptr<mctpw::MCTPWrapper> mctpWrapper{};
    NumericSensor subsystemTemp;
    mctpw::eid_t mctpEid{};
    static constexpr std::chrono::milliseconds hsPollTimeout{100};
    bool cwarnState = false;
    std::unique_ptr<sdbusplus::asio::dbus_interface> driveLogInterface{};
    static inline bool pausePollRequested = false;
    static constexpr uint8_t maxHealthStatusCount = 10;
    uint8_t curErrorCount = 0;
    void logCWarnState(bool cwarn);
    static bool validateResponse(const std::vector<uint8_t>& response);
};
} // namespace nvmemi