third_party/iwlwifi/test/fake-ucode-test.cc

// Copyright 2021 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 "third_party/iwlwifi/test/fake-ucode-test.h"

#include <zircon/assert.h>
#include <zircon/status.h>

#include "third_party/iwlwifi/test/tlv-fw-builder.h"

extern "C" {
#include "third_party/iwlwifi/fw/img.h"
}  // extern "C"

namespace wlan::testing {

// TODO(fxb/124464): Migrate test to use dispatcher integration.
FakeUcodeTest::FakeUcodeTest(const std::vector<enum iwl_ucode_tlv_capa>& capas,
                             const std::vector<enum iwl_ucode_tlv_api>& apis)
    : sim_trans_() {
  // Add a default MVM firmware to the fake DDK.
  TlvFwBuilder fw_builder;

  const uint32_t dummy_ucode = 0;
  fw_builder.AddValue(IWL_UCODE_TLV_SEC_INIT, &dummy_ucode, sizeof(dummy_ucode));
  fw_builder.AddValue(IWL_UCODE_TLV_INST, &dummy_ucode, sizeof(dummy_ucode));
  fw_builder.AddValue(IWL_UCODE_TLV_DATA, &dummy_ucode, sizeof(dummy_ucode));
  fw_builder.AddValue(IWL_UCODE_TLV_INIT, &dummy_ucode, sizeof(dummy_ucode));
  fw_builder.AddValue(IWL_UCODE_TLV_INIT_DATA, &dummy_ucode, sizeof(dummy_ucode));

  // Capabilities and apis are stored in the _capa[] and _api[] fields of the iwl_ucode_capabilities
  // struct in iwlwifi/fw/img.h. The _capa[] and _api[] fields are really bitfields, not integer
  // arrays. The upper bits of the capability/api are used as the index into these arrays, and the
  // lower bits specify which bit in the integer at the array index represents the capability or
  // api.
  //
  // For how iwlwifi driver parses the ucode capabilities from firmware tlv binary, please refer to
  // iwl_set_ucode_capabilities() in iwlwifi/iwl-drv.c.
  for (const enum iwl_ucode_tlv_capa capa : capas) {
    auto capa_val = static_cast<uint32_t>(capa);
    const struct iwl_ucode_capa ucode_capa = {
        .api_index = cpu_to_le32(capa_val / 32),
        .api_capa = cpu_to_le32(BIT(capa_val % 32)),
    };
    fw_builder.AddValue(IWL_UCODE_TLV_ENABLED_CAPABILITIES, &ucode_capa, sizeof(ucode_capa));
  }

  for (const enum iwl_ucode_tlv_api api : apis) {
    auto api_val = static_cast<uint32_t>(api);
    const struct iwl_ucode_api ucode_api = {
        .api_index = cpu_to_le32(api_val / 32),
        .api_flags = cpu_to_le32(BIT(api_val % 32)),
    };
    fw_builder.AddValue(IWL_UCODE_TLV_API_CHANGES_SET, &ucode_api, sizeof(ucode_api));
  }

  const uint32_t ucode_phy_sku =
      cpu_to_le32((3 << FW_PHY_CFG_TX_CHAIN_POS) |  // Tx antenna 1 and 0.
                  (6 << FW_PHY_CFG_RX_CHAIN_POS));  // Rx antenna 2 and 1.
  fw_builder.AddValue(IWL_UCODE_TLV_PHY_SKU, &ucode_phy_sku, sizeof(ucode_phy_sku));

  sim_trans_.SetFirmware(fw_builder.GetBinary());

  zx_status_t status = sim_trans_.Init();
  ZX_ASSERT_MSG(ZX_OK == status, "Transportation initialization failed: %s",
                zx_status_get_string(status));
}

}  // namespace wlan::testing