runtime_probe/functions/ectool_i2cread.h

// Copyright 2018 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 RUNTIME_PROBE_FUNCTIONS_ECTOOL_I2CREAD_H_
#define RUNTIME_PROBE_FUNCTIONS_ECTOOL_I2CREAD_H_

#include <memory>
#include <string>

#include <base/values.h>

#include "runtime_probe/probe_function.h"

namespace runtime_probe {

// Execute "ectool i2cread" command.
// TODO(b/120826467) : Access /dev/cros_ec directly.
//
// This probe function takes the following arguments:
//   size: Return bits, it can be either 8 or 16.
//   port: The port of the I2C connected to EC.
//   addr: The I2C address
//   offset: The register offset.
//   key: The key of saved output. Output will be saved in string.
//
// More details can be found under command "ectool i2cread help"
class EctoolI2Cread final : public PrivilegedProbeFunction {
  using PrivilegedProbeFunction::PrivilegedProbeFunction;

 public:
  NAME_PROBE_FUNCTION("ectool_i2cread");

  // Define a parser for this function.
  //
  // @args dict_value: a JSON dictionary to parse arguments from.
  //
  // @return pointer to new `EctoolI2Cread` instance on success, nullptr
  //   otherwise.
  template <typename T>
  static auto FromKwargsValue(const base::Value& dict_value) {
    PARSE_BEGIN();
    PARSE_ARGUMENT(size);
    PARSE_ARGUMENT(port);
    PARSE_ARGUMENT(addr);
    PARSE_ARGUMENT(offset);
    PARSE_ARGUMENT(key);
    PARSE_END();
  }

 private:
  DataType EvalImpl() const override;

  int addr_;
  std::string key_;
  int offset_;
  int port_;
  int size_;

  bool GetEctoolOutput(std::string* output) const;
};

}  // namespace runtime_probe

#endif  // RUNTIME_PROBE_FUNCTIONS_ECTOOL_I2CREAD_H_