rmad/utils/vpd_utils.h

// Copyright 2021 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef RMAD_UTILS_VPD_UTILS_H_
#define RMAD_UTILS_VPD_UTILS_H_

#include <string>
#include <vector>

namespace rmad {

class VpdUtils {
 public:
  VpdUtils() = default;
  virtual ~VpdUtils() = default;

  // Get the serial number of the device from vpd.
  virtual bool GetSerialNumber(std::string* serial_number) const = 0;

  // Get the whitelabel tag of the device from vpd.
  virtual bool GetWhitelabelTag(std::string* whitelabel_tag) const = 0;

  // Get the region of the device from vpd.
  virtual bool GetRegion(std::string* region) const = 0;

  // Get values from |entries| of the device from vpd and save it to
  // |calibbias|. If there are any errors, leave |calibbias| untouched.
  // Return true if it succeeds for all entries, otherwise it returns false.
  virtual bool GetCalibbias(const std::vector<std::string>& entries,
                            std::vector<int>* calibbias) const = 0;

  // Set the serial number of the device to vpd.
  virtual bool SetSerialNumber(const std::string& serial_number) = 0;

  // Set the whitelabel tag of the device to vpd.
  virtual bool SetWhitelabelTag(const std::string& whitelabel_tag) = 0;

  // Set the region of the device to vpd.
  virtual bool SetRegion(const std::string& region) = 0;

  // Set |calibbias| to |entries| of the device in vpd.
  // Return true if it succeeds for all entries, otherwise it returns false.
  virtual bool SetCalibbias(const std::vector<std::string>& entries,
                            const std::vector<int>& calibbias) = 0;

 protected:
  // Set a (key, value) pair to RO VPD. Return true if successfully set the
  // value, false if fail to set the value.
  virtual bool SetRoVpd(const std::string& key, const std::string& value) = 0;

  // Get the value associated with key `key` in RO VPD, and store it to `value`.
  // Return true if successfully get the value, false if fail to get the value.
  virtual bool GetRoVpd(const std::string& key, std::string* value) const = 0;

  // Set a (key, value) pair to RW VPD. Return true if successfully set the
  // value, false if fail to set the value.
  virtual bool SetRwVpd(const std::string& key, const std::string& value) = 0;

  // Get the value associated with key `key` in RW VPD, and store it to `value`.
  // Return true if successfully get the value, false if fail to get the value.
  virtual bool GetRwVpd(const std::string& key, std::string* value) const = 0;
};

}  // namespace rmad

#endif  // RMAD_UTILS_VPD_UTILS_H_