Commit 2b7ed927 authored by Tzung-Bi Shih's avatar Tzung-Bi Shih
Browse files

platform/chrome: cros_ec_proto: add Kunit tests for get_next_event 



cros_ec_get_next_event() gets events from EC.  It consists of 3
versions of event retrieval:

1. No MKBP event.
2. MKBP event version 0.
3. MKBP event version >0.

Add Kunit tests for cros_ec_get_next_event().

Signed-off-by: default avatarTzung-Bi Shih <tzungbi@kernel.org>
Reviewed-by: default avatarGuenter Roeck <groeck@chromium.org>
Link: https://lore.kernel.org/r/20220622041040.202737-4-tzungbi@kernel.org
parent 1242688f

drivers/platform/chrome/cros_ec_proto_test.c

+266 −0
Original line number Diff line number Diff line
@@ -5,6 +5,7 @@ 


#include <kunit/test.h>



#include <asm-generic/unaligned.h>

#include <linux/platform_data/cros_ec_commands.h>

#include <linux/platform_data/cros_ec_proto.h>
@@ -2052,6 +2053,265 @@ static void cros_ec_proto_test_cmd_xfer_status_return_error(struct kunit *test) 
	}

}



static void cros_ec_proto_test_get_next_event_no_mkbp_event(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;

	bool wake_event, more_events;



	ec_dev->max_request = 0xff;

	ec_dev->max_response = 0xee;

	ec_dev->mkbp_event_supported = 0;



	/* Set some garbage bytes. */

	wake_event = false;

	more_events = true;



	/* For get_keyboard_state_event(). */

	{

		union ec_response_get_next_data_v1 *data;



		mock = cros_kunit_ec_xfer_mock_add(test, sizeof(*data));

		KUNIT_ASSERT_PTR_NE(test, mock, NULL);



		data = (union ec_response_get_next_data_v1 *)mock->o_data;

		data->host_event = 0xbeef;

	}



	ret = cros_ec_get_next_event(ec_dev, &wake_event, &more_events);

	KUNIT_EXPECT_EQ(test, ret, sizeof(union ec_response_get_next_data_v1));



	KUNIT_EXPECT_EQ(test, ec_dev->event_data.event_type, EC_MKBP_EVENT_KEY_MATRIX);

	KUNIT_EXPECT_EQ(test, ec_dev->event_data.data.host_event, 0xbeef);



	KUNIT_EXPECT_TRUE(test, wake_event);

	KUNIT_EXPECT_FALSE(test, more_events);



	/* For get_keyboard_state_event(). */

	{

		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_MKBP_STATE);

		KUNIT_EXPECT_EQ(test, mock->msg.insize, sizeof(union ec_response_get_next_data_v1));

		KUNIT_EXPECT_EQ(test, mock->msg.outsize, 0);

	}

}



static void cros_ec_proto_test_get_next_event_mkbp_event_ec_suspended(struct kunit *test)

{

	struct cros_ec_proto_test_priv *priv = test->priv;

	struct cros_ec_device *ec_dev = &priv->ec_dev;

	int ret;



	ec_dev->mkbp_event_supported = 1;

	ec_dev->suspended = true;



	ret = cros_ec_get_next_event(ec_dev, NULL, NULL);

	KUNIT_EXPECT_EQ(test, ret, -EHOSTDOWN);

}



static void cros_ec_proto_test_get_next_event_mkbp_event_version0(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;

	bool wake_event, more_events;



	ec_dev->max_request = 0xff;

	ec_dev->max_response = 0xee;

	ec_dev->mkbp_event_supported = 1;



	/* Set some garbage bytes. */

	wake_event = true;

	more_events = false;



	/* For get_next_event_xfer(). */

	{

		struct ec_response_get_next_event *data;



		mock = cros_kunit_ec_xfer_mock_add(test, sizeof(*data));

		KUNIT_ASSERT_PTR_NE(test, mock, NULL);



		data = (struct ec_response_get_next_event *)mock->o_data;

		data->event_type = EC_MKBP_EVENT_SENSOR_FIFO | EC_MKBP_HAS_MORE_EVENTS;

		data->data.sysrq = 0xbeef;

	}



	ret = cros_ec_get_next_event(ec_dev, &wake_event, &more_events);

	KUNIT_EXPECT_EQ(test, ret, sizeof(struct ec_response_get_next_event));



	KUNIT_EXPECT_EQ(test, ec_dev->event_data.event_type, EC_MKBP_EVENT_SENSOR_FIFO);

	KUNIT_EXPECT_EQ(test, ec_dev->event_data.data.sysrq, 0xbeef);



	KUNIT_EXPECT_FALSE(test, wake_event);

	KUNIT_EXPECT_TRUE(test, more_events);



	/* For get_next_event_xfer(). */

	{

		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_NEXT_EVENT);

		KUNIT_EXPECT_EQ(test, mock->msg.insize, sizeof(struct ec_response_get_next_event));

		KUNIT_EXPECT_EQ(test, mock->msg.outsize, 0);

	}

}



static void cros_ec_proto_test_get_next_event_mkbp_event_version2(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;

	bool wake_event, more_events;



	ec_dev->max_request = 0xff;

	ec_dev->max_response = 0xee;

	ec_dev->mkbp_event_supported = 3;



	/* Set some garbage bytes. */

	wake_event = false;

	more_events = true;



	/* For get_next_event_xfer(). */

	{

		struct ec_response_get_next_event_v1 *data;



		mock = cros_kunit_ec_xfer_mock_add(test, sizeof(*data));

		KUNIT_ASSERT_PTR_NE(test, mock, NULL);



		data = (struct ec_response_get_next_event_v1 *)mock->o_data;

		data->event_type = EC_MKBP_EVENT_FINGERPRINT;

		data->data.sysrq = 0xbeef;

	}



	ret = cros_ec_get_next_event(ec_dev, &wake_event, &more_events);

	KUNIT_EXPECT_EQ(test, ret, sizeof(struct ec_response_get_next_event_v1));



	KUNIT_EXPECT_EQ(test, ec_dev->event_data.event_type, EC_MKBP_EVENT_FINGERPRINT);

	KUNIT_EXPECT_EQ(test, ec_dev->event_data.data.sysrq, 0xbeef);



	KUNIT_EXPECT_TRUE(test, wake_event);

	KUNIT_EXPECT_FALSE(test, more_events);



	/* For get_next_event_xfer(). */

	{

		mock = cros_kunit_ec_xfer_mock_next();

		KUNIT_EXPECT_PTR_NE(test, mock, NULL);



		KUNIT_EXPECT_EQ(test, mock->msg.version, 2);

		KUNIT_EXPECT_EQ(test, mock->msg.command, EC_CMD_GET_NEXT_EVENT);

		KUNIT_EXPECT_EQ(test, mock->msg.insize,

				sizeof(struct ec_response_get_next_event_v1));

		KUNIT_EXPECT_EQ(test, mock->msg.outsize, 0);

	}

}



static void cros_ec_proto_test_get_next_event_mkbp_event_host_event_rtc(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;

	bool wake_event;

	struct ec_response_get_next_event_v1 *data;



	ec_dev->max_request = 0xff;

	ec_dev->max_response = 0xee;

	ec_dev->mkbp_event_supported = 3;

	ec_dev->host_event_wake_mask = U32_MAX;



	/* Set some garbage bytes. */

	wake_event = true;



	/* For get_next_event_xfer(). */

	{

		mock = cros_kunit_ec_xfer_mock_add(test,

						   sizeof(data->event_type) +

						   sizeof(data->data.host_event));

		KUNIT_ASSERT_PTR_NE(test, mock, NULL);



		data = (struct ec_response_get_next_event_v1 *)mock->o_data;

		data->event_type = EC_MKBP_EVENT_HOST_EVENT;

		put_unaligned_le32(EC_HOST_EVENT_MASK(EC_HOST_EVENT_RTC), &data->data.host_event);

	}



	ret = cros_ec_get_next_event(ec_dev, &wake_event, NULL);

	KUNIT_EXPECT_EQ(test, ret, sizeof(data->event_type) + sizeof(data->data.host_event));



	KUNIT_EXPECT_EQ(test, ec_dev->event_data.event_type, EC_MKBP_EVENT_HOST_EVENT);



	KUNIT_EXPECT_FALSE(test, wake_event);



	/* For get_next_event_xfer(). */

	{

		mock = cros_kunit_ec_xfer_mock_next();

		KUNIT_EXPECT_PTR_NE(test, mock, NULL);



		KUNIT_EXPECT_EQ(test, mock->msg.version, 2);

		KUNIT_EXPECT_EQ(test, mock->msg.command, EC_CMD_GET_NEXT_EVENT);

		KUNIT_EXPECT_EQ(test, mock->msg.insize,

				sizeof(struct ec_response_get_next_event_v1));

		KUNIT_EXPECT_EQ(test, mock->msg.outsize, 0);

	}

}



static void cros_ec_proto_test_get_next_event_mkbp_event_host_event_masked(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;

	bool wake_event;

	struct ec_response_get_next_event_v1 *data;



	ec_dev->max_request = 0xff;

	ec_dev->max_response = 0xee;

	ec_dev->mkbp_event_supported = 3;

	ec_dev->host_event_wake_mask = U32_MAX & ~EC_HOST_EVENT_MASK(EC_HOST_EVENT_AC_DISCONNECTED);



	/* Set some garbage bytes. */

	wake_event = true;



	/* For get_next_event_xfer(). */

	{

		mock = cros_kunit_ec_xfer_mock_add(test,

						   sizeof(data->event_type) +

						   sizeof(data->data.host_event));

		KUNIT_ASSERT_PTR_NE(test, mock, NULL);



		data = (struct ec_response_get_next_event_v1 *)mock->o_data;

		data->event_type = EC_MKBP_EVENT_HOST_EVENT;

		put_unaligned_le32(EC_HOST_EVENT_MASK(EC_HOST_EVENT_AC_DISCONNECTED),

				   &data->data.host_event);

	}



	ret = cros_ec_get_next_event(ec_dev, &wake_event, NULL);

	KUNIT_EXPECT_EQ(test, ret, sizeof(data->event_type) + sizeof(data->data.host_event));



	KUNIT_EXPECT_EQ(test, ec_dev->event_data.event_type, EC_MKBP_EVENT_HOST_EVENT);



	KUNIT_EXPECT_FALSE(test, wake_event);



	/* For get_next_event_xfer(). */

	{

		mock = cros_kunit_ec_xfer_mock_next();

		KUNIT_EXPECT_PTR_NE(test, mock, NULL);



		KUNIT_EXPECT_EQ(test, mock->msg.version, 2);

		KUNIT_EXPECT_EQ(test, mock->msg.command, EC_CMD_GET_NEXT_EVENT);

		KUNIT_EXPECT_EQ(test, mock->msg.insize,

				sizeof(struct ec_response_get_next_event_v1));

		KUNIT_EXPECT_EQ(test, mock->msg.outsize, 0);

	}

}



static void cros_ec_proto_test_release(struct device *dev)

{

}
@@ -2135,6 +2395,12 @@ static struct kunit_case cros_ec_proto_test_cases[] = { 
	KUNIT_CASE(cros_ec_proto_test_cmd_xfer_status_normal),

	KUNIT_CASE(cros_ec_proto_test_cmd_xfer_status_xfer_error),

	KUNIT_CASE(cros_ec_proto_test_cmd_xfer_status_return_error),

	KUNIT_CASE(cros_ec_proto_test_get_next_event_no_mkbp_event),

	KUNIT_CASE(cros_ec_proto_test_get_next_event_mkbp_event_ec_suspended),

	KUNIT_CASE(cros_ec_proto_test_get_next_event_mkbp_event_version0),

	KUNIT_CASE(cros_ec_proto_test_get_next_event_mkbp_event_version2),

	KUNIT_CASE(cros_ec_proto_test_get_next_event_mkbp_event_host_event_rtc),

	KUNIT_CASE(cros_ec_proto_test_get_next_event_mkbp_event_host_event_masked),

	{}

};