src/connectivity/wlan/drivers/third_party/broadcom/brcmfmac/sim/test/iovar_test.cc

// Copyright 2020 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 <zircon/errors.h>

#include <ddk/hw/wlan/wlaninfo/c/banjo.h>

#include "src/connectivity/wlan/drivers/third_party/broadcom/brcmfmac/bcdc.h"
#include "src/connectivity/wlan/drivers/third_party/broadcom/brcmfmac/fwil.h"
#include "src/connectivity/wlan/drivers/third_party/broadcom/brcmfmac/sim/sim.h"
#include "src/connectivity/wlan/drivers/third_party/broadcom/brcmfmac/sim/test/sim_test.h"

namespace wlan::brcmfmac {

class IovarTest : public SimTest {
 public:
  IovarTest() = default;
  // This is the interface we will use for our single client interface
  SimInterface client_ifc_;
  SimFirmware* sim_fw_;

  void Init();

  uint32_t DeviceCount();

  zx_status_t IovarGet(char* buf, uint32_t buf_len);
  zx_status_t IovarSet(char* buf, uint32_t buf_len);
};

uint32_t IovarTest::DeviceCount() { return (dev_mgr_->DeviceCount()); }

// Create our device instance and hook up the callbacks
void IovarTest::Init() { ASSERT_EQ(SimTest::Init(), ZX_OK); }

zx_status_t IovarTest::IovarGet(char* buf, uint32_t buf_len) {
  brcmf_simdev* sim = device_->GetSim();
  return brcmf_send_cmd_to_firmware(sim->drvr, client_ifc_.iface_id_, BRCMF_C_GET_VAR, buf, buf_len,
                                    false);
}

zx_status_t IovarTest::IovarSet(char* buf, uint32_t buf_len) {
  brcmf_simdev* sim = device_->GetSim();
  return brcmf_send_cmd_to_firmware(sim->drvr, client_ifc_.iface_id_, BRCMF_C_SET_VAR, buf, buf_len,
                                    true);
}

TEST_F(IovarTest, CheckIovarGet) {
  Init();
  ASSERT_EQ(StartInterface(WLAN_INFO_MAC_ROLE_CLIENT, &client_ifc_), ZX_OK);
  EXPECT_EQ(DeviceCount(), static_cast<size_t>(2));
  char buf[32];
  strcpy(buf, "mpc");
  // Get the value through the factory iovar interface
  zx_status_t status = IovarGet(buf, strlen(buf) + 1 + sizeof(uint32_t));
  EXPECT_EQ(status, ZX_OK);
  uint32_t read_val = *(reinterpret_cast<uint32_t*>(buf));
  // Get the value through the public iovar interface and compare
  brcmf_simdev* sim = device_->GetSim();
  uint32_t cur_val;
  bcme_status_t fw_err;
  sim->sim_fw->IovarsGet(client_ifc_.iface_id_, "mpc", &cur_val, sizeof(cur_val), &fw_err);
  EXPECT_EQ(cur_val, read_val);
}

TEST_F(IovarTest, CheckIovarSet) {
  Init();
  ASSERT_EQ(StartInterface(WLAN_INFO_MAC_ROLE_CLIENT, &client_ifc_), ZX_OK);
  EXPECT_EQ(DeviceCount(), 2u);
  brcmf_simdev* sim = device_->GetSim();
  // Get the current value of mpc through the public interface
  uint32_t cur_val;
  bcme_status_t fw_err;
  sim->sim_fw->IovarsGet(client_ifc_.iface_id_, "mpc", &cur_val, sizeof(cur_val), &fw_err);
  // Change the value and set it through the factory iovar interface
  uint32_t new_val = cur_val ? 0 : 1;
  char buf[32];
  strcpy(buf, "mpc");
  uint32_t* buf_val = reinterpret_cast<uint32_t*>(buf + strlen(buf) + 1);
  *buf_val = new_val;
  // Set the value through the factory iovar interface
  zx_status_t status = IovarSet(buf, strlen(buf) + 1 + sizeof(uint32_t));
  EXPECT_EQ(status, ZX_OK);
  // Get the value again through the public iovar interface and compare
  sim->sim_fw->IovarsGet(client_ifc_.iface_id_, "mpc", &cur_val, sizeof(cur_val), &fw_err);
  printf("new value of mpc is: %d\n", cur_val);
  EXPECT_EQ(cur_val, new_val);
}

TEST_F(IovarTest, CheckIovarWrongBufLen) {
  Init();
  ASSERT_EQ(StartInterface(WLAN_INFO_MAC_ROLE_CLIENT, &client_ifc_), ZX_OK);
  EXPECT_EQ(DeviceCount(), 2u);
  char buf[32];
  strcpy(buf, "wsec_key");
  // Get the value through the factory iovar interface with insufficient buflen.
  zx_status_t status = IovarGet(buf, strlen(buf) + 1 + sizeof(uint32_t));
  EXPECT_NE(status, ZX_OK);
  // Set the value through the factory iovar interface with insufficient buflen.
  strcpy(buf, "wsec_key");
  status = IovarSet(buf, strlen(buf) + 1 + sizeof(uint32_t));
  EXPECT_NE(status, ZX_OK);
}

TEST_F(IovarTest, CheckIovarBufLenTooShort) {
  Init();
  ASSERT_EQ(StartInterface(WLAN_INFO_MAC_ROLE_CLIENT, &client_ifc_), ZX_OK);
  EXPECT_EQ(DeviceCount(), 2u);
  brcmf_simdev* sim = device_->GetSim();
  struct brcmf_if* ifp = brcmf_get_ifp(sim->drvr, client_ifc_.iface_id_);
  zx_status_t status;
  char caps[25] = "originalbuffer";
  bcme_status_t fw_err;
  status = brcmf_fil_iovar_data_get(ifp, "cap", caps, sizeof(caps), &fw_err);

  // We expect ZX_ERR_IO_REFUSED and BCMF_BUFTOOSHORT to be returned when
  // the buffer provided for an iovar value is too small. The buffer should
  // also remain untouched.
  EXPECT_EQ(status, ZX_ERR_IO_REFUSED);
  EXPECT_EQ(fw_err, BCME_BUFTOOSHORT);
  EXPECT_TRUE(0 == strncmp("originalbuffer", caps, 25));
}

TEST_F(IovarTest, CheckFilIovarFuncs) {
  Init();
  ASSERT_EQ(StartInterface(WLAN_INFO_MAC_ROLE_CLIENT, &client_ifc_), ZX_OK);
  EXPECT_EQ(DeviceCount(), 2u);
  brcmf_simdev* sim = device_->GetSim();
  struct brcmf_if* ifp = brcmf_get_ifp(sim->drvr, client_ifc_.iface_id_);
  zx_status_t status;
  char caps[500];
  status = brcmf_fil_iovar_data_get(ifp, "cap", caps, sizeof(caps), nullptr);
  EXPECT_EQ(status, ZX_OK);
}

TEST_F(IovarTest, CheckIovarBufLenTooLong) {
  Init();
  ASSERT_EQ(StartInterface(WLAN_INFO_MAC_ROLE_CLIENT, &client_ifc_), ZX_OK);
  EXPECT_EQ(DeviceCount(), 2u);
  char buf[BRCMF_DCMD_MAXLEN + 1];
  strcpy(buf, "anything");
  zx_status_t status = IovarGet(buf, BRCMF_DCMD_MAXLEN + 1);
  EXPECT_NE(status, ZX_OK);
}
}  // namespace wlan::brcmfmac