hps/dev.cc

// 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.

/*
 * Device access interface common functions.
 */

#include "hps/dev.h"

#include "base/logging.h"
#include "hps/hps_reg.h"
#include "hps/utils.h"

namespace hps {

/*
 * TODO(amcrae): It is questionable whether this layer should be using
 * retries, since a retry shim layer can be added separately.
 */
static const int kIoRetries = 5;

bool DevInterface::Read(uint8_t cmd, uint8_t* data, size_t len) {
  if (this->ReadDevice(cmd, data, len)) {
    VLOG(2) << "Read: " << cmd << " " << len << " OK";
    return true;
  }
  VLOG(2) << "Read: " << cmd << " " << len << " FAILED";
  return false;
}

bool DevInterface::Write(uint8_t cmd, const uint8_t* data, size_t len) {
  if (this->WriteDevice(cmd, data, len)) {
    VLOG(2) << "Write: " << cmd << " " << len << " OK";
    return true;
  }
  VLOG(2) << "Write: " << cmd << " " << len << " FAILED";
  return false;
}

/*
 * Read 1 register.
 * Returns value read, or -1 for error.
 */
int DevInterface::ReadReg(HpsReg r) {
  uint8_t res[2];

  for (int i = 0; i < kIoRetries; i++) {
    if (this->ReadDevice(I2cReg(r), res, sizeof(res))) {
      int ret = (static_cast<int>(res[0]) << 8) | static_cast<int>(res[1]);
      VLOG(2) << "ReadReg: " << HpsRegToString(r) << " " << ret << " OK";
      return ret;
    }
  }
  VLOG(2) << "ReadReg: " << HpsRegToString(r) << " FAILED";
  return -1;
}

/*
 * Write 1 register.
 * Returns false on failure.
 */
bool DevInterface::WriteReg(HpsReg r, uint16_t data) {
  uint8_t buf[2];
  buf[0] = data >> 8;
  buf[1] = data & 0xFF;
  for (int i = 0; i < kIoRetries; i++) {
    if (this->WriteDevice(I2cReg(r), buf, sizeof(buf))) {
      VLOG(2) << "WriteReg: " << HpsRegToString(r) << " " << data << " OK";
      return true;
    }
  }
  VLOG(2) << "WriteReg: " << HpsRegToString(r) << " " << data << " FAILED";
  return false;
}
/*
 * Return the maximum download block size (in bytes).
 * Default is 256 bytes.
 */
size_t DevInterface::BlockSizeBytes() {
  return 256;
}

}  // namespace hps