src/devices/board/drivers/sherlock/sherlock-buttons.cc

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

#include <ddk/binding.h>
#include <ddk/debug.h>
#include <ddk/device.h>
#include <ddk/metadata.h>
#include <ddk/metadata/buttons.h>
#include <ddk/platform-defs.h>
#include <soc/aml-t931/t931-gpio.h>
#include <soc/aml-t931/t931-hw.h>

#include "sherlock-gpios.h"
#include "sherlock.h"

namespace sherlock {

zx_status_t Sherlock::ButtonsInit() {
  static const zx_bind_inst_t root_match[] = {
      BI_MATCH(),
  };
  static const zx_bind_inst_t volume_up_match[] = {
      BI_ABORT_IF(NE, BIND_PROTOCOL, ZX_PROTOCOL_GPIO),
      BI_MATCH_IF(EQ, BIND_GPIO_PIN, GPIO_VOLUME_UP),
  };
  static const zx_bind_inst_t volume_down_match[] = {
      BI_ABORT_IF(NE, BIND_PROTOCOL, ZX_PROTOCOL_GPIO),
      BI_MATCH_IF(EQ, BIND_GPIO_PIN, GPIO_VOLUME_DOWN),
  };
  static const zx_bind_inst_t volume_both_match[] = {
      BI_ABORT_IF(NE, BIND_PROTOCOL, ZX_PROTOCOL_GPIO),
      BI_MATCH_IF(EQ, BIND_GPIO_PIN, GPIO_VOLUME_BOTH),
  };
  static const zx_bind_inst_t mic_privacy_match[] = {
      BI_ABORT_IF(NE, BIND_PROTOCOL, ZX_PROTOCOL_GPIO),
      BI_MATCH_IF(EQ, BIND_GPIO_PIN, GPIO_MIC_PRIVACY),
  };
  static const zx_bind_inst_t cam_mute_match[] = {
      BI_ABORT_IF(NE, BIND_PROTOCOL, ZX_PROTOCOL_GPIO),
      BI_MATCH_IF(EQ, BIND_GPIO_PIN, GPIO_CAM_MUTE),
  };
  static const device_fragment_part_t volume_up_fragment[] = {
      {countof(root_match), root_match},
      {countof(volume_up_match), volume_up_match},
  };
  static const device_fragment_part_t volume_down_fragment[] = {
      {countof(root_match), root_match},
      {countof(volume_down_match), volume_down_match},
  };
  static const device_fragment_part_t volume_both_fragment[] = {
      {countof(root_match), root_match},
      {countof(volume_both_match), volume_both_match},
  };
  static const device_fragment_part_t mic_privacy_fragment[] = {
      {countof(root_match), root_match},
      {countof(mic_privacy_match), mic_privacy_match},
  };
  static const device_fragment_part_t cam_mute_fragment[] = {
      {countof(root_match), root_match},
      {countof(cam_mute_match), cam_mute_match},
  };
  static const device_fragment_t fragments[] = {
      {"volume-up", countof(volume_up_fragment), volume_up_fragment},
      {"volume-down", countof(volume_down_fragment), volume_down_fragment},
      {"volume-both", countof(volume_both_fragment), volume_both_fragment},
      {"mic-privacy", countof(mic_privacy_fragment), mic_privacy_fragment},
      {"cam-mute", countof(cam_mute_fragment), cam_mute_fragment},
  };

  static constexpr buttons_button_config_t sherlock_buttons[] = {
      {BUTTONS_TYPE_DIRECT, BUTTONS_ID_VOLUME_UP, 0, 0, 0},
      {BUTTONS_TYPE_DIRECT, BUTTONS_ID_VOLUME_DOWN, 1, 0, 0},
      {BUTTONS_TYPE_DIRECT, BUTTONS_ID_FDR, 2, 0, 0},
      {BUTTONS_TYPE_DIRECT, BUTTONS_ID_MIC_AND_CAM_MUTE, 3, 0, 0},
  };
  constexpr size_t kSherlockButtonCount = 4;

  static constexpr buttons_button_config_t luis_buttons[] = {
      {BUTTONS_TYPE_DIRECT, BUTTONS_ID_VOLUME_UP, 0, 0, 0},
      {BUTTONS_TYPE_DIRECT, BUTTONS_ID_VOLUME_DOWN, 1, 0, 0},
      {BUTTONS_TYPE_DIRECT, BUTTONS_ID_FDR, 2, 0, 0},
      {BUTTONS_TYPE_DIRECT, BUTTONS_ID_MIC_MUTE, 3, 0, 0},
      {BUTTONS_TYPE_DIRECT, BUTTONS_ID_CAM_MUTE, 4, 0, 0},
  };
  // TODO(fxbug.dev/58662): Re-enable camera mute switch.
  // constexpr size_t kLuisButtonCount = 5;
  constexpr size_t kLuisButtonCount = 4;

  // No need for internal pull, external pull-ups used.
  static constexpr buttons_gpio_config_t gpios[] = {
      {BUTTONS_GPIO_TYPE_INTERRUPT, BUTTONS_GPIO_FLAG_INVERTED, {GPIO_NO_PULL}},
      {BUTTONS_GPIO_TYPE_INTERRUPT, BUTTONS_GPIO_FLAG_INVERTED, {GPIO_NO_PULL}},
      {BUTTONS_GPIO_TYPE_INTERRUPT, BUTTONS_GPIO_FLAG_INVERTED, {GPIO_NO_PULL}},
      {BUTTONS_GPIO_TYPE_INTERRUPT, 0, {GPIO_NO_PULL}},
      // CAM_MUTE high means the camera is enabled, low means the camera is disabled.
      {BUTTONS_GPIO_TYPE_INTERRUPT, BUTTONS_GPIO_FLAG_INVERTED, {GPIO_NO_PULL}},
  };

  const void* buttons = &sherlock_buttons;
  size_t button_count = kSherlockButtonCount;
  if (pid_ == PDEV_PID_LUIS) {
    buttons = &luis_buttons;
    button_count = kLuisButtonCount;
  }

  const device_metadata_t available_buttons_metadata[] = {
      {
          .type = DEVICE_METADATA_BUTTONS_BUTTONS,
          .data = buttons,
          .length = button_count * sizeof(buttons_button_config_t),
      },
      {
          .type = DEVICE_METADATA_BUTTONS_GPIOS,
          .data = &gpios,
          .length = button_count * sizeof(gpios[0]),
      },
  };

  constexpr zx_device_prop_t props[] = {
      {BIND_PLATFORM_DEV_VID, 0, PDEV_VID_GENERIC},
      {BIND_PLATFORM_DEV_PID, 0, PDEV_PID_GENERIC},
      {BIND_PLATFORM_DEV_DID, 0, PDEV_DID_HID_BUTTONS},
  };

  const composite_device_desc_t comp_desc = {
      .props = props,
      .props_count = countof(props),
      .fragments = fragments,
      .fragments_count = button_count,
      .coresident_device_index = UINT32_MAX,
      .metadata_list = available_buttons_metadata,
      .metadata_count = countof(available_buttons_metadata),
  };

  zx_status_t status = DdkAddComposite("sherlock-buttons", &comp_desc);
  if (status != ZX_OK) {
    zxlogf(ERROR, "%s: CompositeDeviceAdd failed %d", __func__, status);
    return status;
  }

  return ZX_OK;
}

}  // namespace sherlock