mtd_util.hpp

// Copyright 2024 Google LLC
//
// 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 "mtd_util_interface.hpp"
#include "sys_interface.hpp"

#include <string>
#include <vector>

namespace google
{
namespace hoth
{
namespace internal
{

/** @class MtdImpl
 *  @brief Mtd utility method implementation
 *  @details Methods to find and write to Memory Technology Devices
 */
class MtdImpl : public Mtd
{
  public:
    std::string findPartition(const std::string& name) override;

    /** @brief Replace the contents of an MTD device with the given data
     *
     *  This function erases the entire contents of the MTD device at
     *  path @a device and writes @a data to it.
     *
     *  @param[in] sys    - Pointer to syscall interface
     *  @param[in] data   - Buffer of data to write
     *  @param[in] device - Path to MTD device to write to
     *
     *  @throws std::system_error when a syscall fails
     *
     *  @throws std::runtime_error when some other unexpected
     *          condition occurs
     */
    void flashCopy(const Sys* sys, const std::vector<uint8_t>& data,
                   const std::string& device) override;
};

/** @brief Default instantiation of mtd */
extern MtdImpl mtdImpl;

} // namespace internal

} // namespace hoth

} // namespace google