src/devices/i2c/drivers/mt8167-i2c/mt8167-i2c.h

// Copyright 2018 The Fuchsia 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 SRC_DEVICES_I2C_DRIVERS_MT8167_I2C_MT8167_I2C_H_
#define SRC_DEVICES_I2C_DRIVERS_MT8167_I2C_MT8167_I2C_H_

#include <lib/device-protocol/pdev.h>
#include <lib/mmio/mmio.h>
#include <lib/zx/event.h>
#include <lib/zx/interrupt.h>
#include <lib/zx/port.h>
#include <threads.h>

#include <optional>

#include <ddktl/device.h>
#include <ddktl/protocol/gpio.h>
#include <ddktl/protocol/i2cimpl.h>
#include <fbl/array.h>
#include <fbl/vector.h>

#include "mt8167-i2c-regs.h"

namespace mt8167_i2c {

class Mt8167I2c;
using DeviceType = ddk::Device<Mt8167I2c, ddk::Unbindable>;

class Mt8167I2c : public DeviceType, public ddk::I2cImplProtocol<Mt8167I2c, ddk::base_protocol> {
 public:
  explicit Mt8167I2c(zx_device_t* parent) : DeviceType(parent) {}
  virtual ~Mt8167I2c() = default;
  zx_status_t Bind();
  zx_status_t Init();
  static zx_status_t Create(void* ctx, zx_device_t* parent);

  // Methods required by the ddk mixins.
  void DdkUnbind(ddk::UnbindTxn txn);
  void DdkRelease();
  uint32_t I2cImplGetBusCount();
  zx_status_t I2cImplGetMaxTransferSize(uint32_t bus_id, size_t* out_size);
  zx_status_t I2cImplSetBitrate(uint32_t bus_id, uint32_t bitrate);
  virtual zx_status_t I2cImplTransact(uint32_t bus_id, const i2c_impl_op_t* ops, size_t count);

  // Visible for testing.
  zx_status_t DoDummyTransactions();

 protected:
  virtual zx_status_t GetI2cGpios(fbl::Array<ddk::GpioProtocolClient>* gpios);
  virtual void Reset(uint32_t id);

  uint32_t bus_count_;

 private:
  struct Key {
    ddk::MmioBuffer mmio;
    zx::interrupt irq;
    zx::event event;
  };

  void ClockEnable(uint32_t id, bool enable);
  int IrqThread();
  int TestThread();
  zx_status_t Transact(bool is_read, uint32_t id, uint8_t addr, void* buf, size_t len, bool stop);
  void DataMove(bool is_read, uint32_t id, void* buf, size_t len);
  void ShutDown();

  std::optional<XoRegs> xo_regs_;
  fbl::Vector<Key> keys_;
  zx::port irq_port_;
  thrd_t irq_thread_;
  bool bind_finished_ = false;
};

}  // namespace mt8167_i2c

#endif  // SRC_DEVICES_I2C_DRIVERS_MT8167_I2C_MT8167_I2C_H_