platform/chrome: cros_ec_proto: add Kunit tests for getting proto info
authorTzung-Bi Shih <tzungbi@kernel.org>
Thu, 9 Jun 2022 08:49:44 +0000 (08:49 +0000)
committerTzung-Bi Shih <tzungbi@kernel.org>
Fri, 10 Jun 2022 02:31:43 +0000 (02:31 +0000)
cros_ec_get_proto_info() expects to receive
sizeof(struct ec_response_get_protocol_info) from send_command().  The
payload is valid only if the return value is positive.

Add Kunit tests for returning 0 from send_command() in
cros_ec_get_proto_info().

Reviewed-by: Guenter Roeck <groeck@chromium.org>
Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org>
Link: https://lore.kernel.org/r/20220609084957.3684698-9-tzungbi@kernel.org
drivers/platform/chrome/cros_ec_proto_test.c

index 8b16666c1657e860b1e9bedd92e08056e588c4f5..1378ac90e1cbee20814a9ef9777fec8b42c51170 100644 (file)
@@ -407,6 +407,71 @@ static void cros_ec_proto_test_query_all_no_pd_return_error(struct kunit *test)
        }
 }
 
+static void cros_ec_proto_test_query_all_no_pd_return0(struct kunit *test)
+{
+       struct cros_ec_proto_test_priv *priv = test->priv;
+       struct cros_ec_device *ec_dev = &priv->ec_dev;
+       struct ec_xfer_mock *mock;
+       int ret;
+
+       /* Set some garbage bytes. */
+       ec_dev->max_passthru = 0xbf;
+
+       /* For cros_ec_get_proto_info() without passthru. */
+       {
+               struct ec_response_get_protocol_info *data;
+
+               mock = cros_kunit_ec_xfer_mock_add(test, sizeof(*data));
+               KUNIT_ASSERT_PTR_NE(test, mock, NULL);
+
+               /*
+                * Although it doesn't check the value, provides valid sizes so that
+                * cros_ec_query_all() allocates din and dout correctly.
+                */
+               data = (struct ec_response_get_protocol_info *)mock->o_data;
+               data->max_request_packet_size = 0xbe;
+               data->max_response_packet_size = 0xef;
+       }
+
+       /* For cros_ec_get_proto_info() with passthru. */
+       {
+               mock = cros_kunit_ec_xfer_mock_add(test, 0);
+               KUNIT_ASSERT_PTR_NE(test, mock, NULL);
+       }
+
+       cros_ec_proto_test_query_all_pretest(test);
+       ret = cros_ec_query_all(ec_dev);
+       KUNIT_EXPECT_EQ(test, ret, 0);
+
+       /* For cros_ec_get_proto_info() without passthru. */
+       {
+               mock = cros_kunit_ec_xfer_mock_next();
+               KUNIT_EXPECT_PTR_NE(test, mock, NULL);
+
+               KUNIT_EXPECT_EQ(test, mock->msg.version, 0);
+               KUNIT_EXPECT_EQ(test, mock->msg.command, EC_CMD_GET_PROTOCOL_INFO);
+               KUNIT_EXPECT_EQ(test, mock->msg.insize,
+                               sizeof(struct ec_response_get_protocol_info));
+               KUNIT_EXPECT_EQ(test, mock->msg.outsize, 0);
+       }
+
+       /* For cros_ec_get_proto_info() with passthru. */
+       {
+               mock = cros_kunit_ec_xfer_mock_next();
+               KUNIT_EXPECT_PTR_NE(test, mock, NULL);
+
+               KUNIT_EXPECT_EQ(test, mock->msg.version, 0);
+               KUNIT_EXPECT_EQ(test, mock->msg.command,
+                               EC_CMD_PASSTHRU_OFFSET(CROS_EC_DEV_PD_INDEX) |
+                               EC_CMD_GET_PROTOCOL_INFO);
+               KUNIT_EXPECT_EQ(test, mock->msg.insize,
+                               sizeof(struct ec_response_get_protocol_info));
+               KUNIT_EXPECT_EQ(test, mock->msg.outsize, 0);
+
+               KUNIT_EXPECT_EQ(test, ec_dev->max_passthru, 0);
+       }
+}
+
 static void cros_ec_proto_test_query_all_legacy_normal_v3_return_error(struct kunit *test)
 {
        struct cros_ec_proto_test_priv *priv = test->priv;
@@ -472,6 +537,71 @@ static void cros_ec_proto_test_query_all_legacy_normal_v3_return_error(struct ku
        }
 }
 
+static void cros_ec_proto_test_query_all_legacy_normal_v3_return0(struct kunit *test)
+{
+       struct cros_ec_proto_test_priv *priv = test->priv;
+       struct cros_ec_device *ec_dev = &priv->ec_dev;
+       struct ec_xfer_mock *mock;
+       int ret;
+
+       /* For cros_ec_get_proto_info() without passthru. */
+       {
+               mock = cros_kunit_ec_xfer_mock_add(test, 0);
+               KUNIT_ASSERT_PTR_NE(test, mock, NULL);
+       }
+
+       /* For cros_ec_host_command_proto_query_v2(). */
+       {
+               struct ec_response_hello *data;
+
+               mock = cros_kunit_ec_xfer_mock_add(test, sizeof(*data));
+               KUNIT_ASSERT_PTR_NE(test, mock, NULL);
+
+               data = (struct ec_response_hello *)mock->o_data;
+               data->out_data = 0xa1b2c3d4;
+       }
+
+       cros_ec_proto_test_query_all_pretest(test);
+       ret = cros_ec_query_all(ec_dev);
+       KUNIT_EXPECT_EQ(test, ret, 0);
+
+       /* For cros_ec_get_proto_info() without passthru. */
+       {
+               mock = cros_kunit_ec_xfer_mock_next();
+               KUNIT_EXPECT_PTR_NE(test, mock, NULL);
+
+               KUNIT_EXPECT_EQ(test, mock->msg.version, 0);
+               KUNIT_EXPECT_EQ(test, mock->msg.command, EC_CMD_GET_PROTOCOL_INFO);
+               KUNIT_EXPECT_EQ(test, mock->msg.insize,
+                               sizeof(struct ec_response_get_protocol_info));
+               KUNIT_EXPECT_EQ(test, mock->msg.outsize, 0);
+       }
+
+       /* For cros_ec_host_command_proto_query_v2(). */
+       {
+               struct ec_params_hello *data;
+
+               mock = cros_kunit_ec_xfer_mock_next();
+               KUNIT_EXPECT_PTR_NE(test, mock, NULL);
+
+               KUNIT_EXPECT_EQ(test, mock->msg.version, 0);
+               KUNIT_EXPECT_EQ(test, mock->msg.command, EC_CMD_HELLO);
+               KUNIT_EXPECT_EQ(test, mock->msg.insize, sizeof(struct ec_response_hello));
+               KUNIT_EXPECT_EQ(test, mock->msg.outsize, sizeof(*data));
+
+               data = (struct ec_params_hello *)mock->i_data;
+               KUNIT_EXPECT_EQ(test, data->in_data, 0xa0b0c0d0);
+
+               KUNIT_EXPECT_EQ(test, ec_dev->proto_version, 2);
+               KUNIT_EXPECT_EQ(test, ec_dev->max_request, EC_PROTO2_MAX_PARAM_SIZE);
+               KUNIT_EXPECT_EQ(test, ec_dev->max_response, EC_PROTO2_MAX_PARAM_SIZE);
+               KUNIT_EXPECT_EQ(test, ec_dev->max_passthru, 0);
+               KUNIT_EXPECT_PTR_EQ(test, ec_dev->pkt_xfer, NULL);
+               KUNIT_EXPECT_EQ(test, ec_dev->din_size, EC_PROTO2_MSG_BYTES);
+               KUNIT_EXPECT_EQ(test, ec_dev->dout_size, EC_PROTO2_MSG_BYTES);
+       }
+}
+
 static void cros_ec_proto_test_query_all_legacy_xfer_error(struct kunit *test)
 {
        struct cros_ec_proto_test_priv *priv = test->priv;
@@ -999,7 +1129,9 @@ static struct kunit_case cros_ec_proto_test_cases[] = {
        KUNIT_CASE(cros_ec_proto_test_check_result),
        KUNIT_CASE(cros_ec_proto_test_query_all_normal),
        KUNIT_CASE(cros_ec_proto_test_query_all_no_pd_return_error),
+       KUNIT_CASE(cros_ec_proto_test_query_all_no_pd_return0),
        KUNIT_CASE(cros_ec_proto_test_query_all_legacy_normal_v3_return_error),
+       KUNIT_CASE(cros_ec_proto_test_query_all_legacy_normal_v3_return0),
        KUNIT_CASE(cros_ec_proto_test_query_all_legacy_xfer_error),
        KUNIT_CASE(cros_ec_proto_test_query_all_legacy_return_error),
        KUNIT_CASE(cros_ec_proto_test_query_all_legacy_data_error),