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

platform/chrome: cros_ec_proto: separate cros_ec_get_proto_info() 



Rename cros_ec_host_command_proto_query() to cros_ec_get_proto_info()
and make it responsible for setting `ec_dev` fields according to the
response protocol info.

Also make cros_ec_get_host_event_wake_mask() allocate its own message
buffer.  It was lucky that size of `struct ec_response_host_event_mask`
is less than `struct ec_response_get_protocol_info`.  Thus, the buffer
wasn't overflow.

Reviewed-by: default avatarGuenter Roeck <groeck@chromium.org>
Signed-off-by: default avatarTzung-Bi Shih <tzungbi@kernel.org>
Link: https://lore.kernel.org/r/20220609084957.3684698-8-tzungbi@kernel.org
parent 93bea2fa

drivers/platform/chrome/cros_ec_proto.c

+65 −69
Original line number Diff line number Diff line
@@ -242,47 +242,53 @@ EXPORT_SYMBOL(cros_ec_check_result); 
 * the caller has ec_dev->lock mutex, or the caller knows there is

 * no other command in progress.

 */

static int cros_ec_get_host_event_wake_mask(struct cros_ec_device *ec_dev,

					    struct cros_ec_command *msg,

					    uint32_t *mask)

static int cros_ec_get_host_event_wake_mask(struct cros_ec_device *ec_dev, uint32_t *mask)

{

	struct cros_ec_command *msg;

	struct ec_response_host_event_mask *r;

	int ret, mapped;



	msg = kzalloc(sizeof(*msg) + sizeof(*r), GFP_KERNEL);

	if (!msg)

		return -ENOMEM;



	msg->command = EC_CMD_HOST_EVENT_GET_WAKE_MASK;

	msg->version = 0;

	msg->outsize = 0;

	msg->insize = sizeof(*r);



	ret = send_command(ec_dev, msg);

	if (ret >= 0) {

		mapped = cros_ec_map_error(msg->result);

		if (mapped)

			return mapped;

		if (mapped) {

			ret = mapped;

			goto exit;

		}

	}

	if (ret > 0) {

		r = (struct ec_response_host_event_mask *)msg->data;

		*mask = r->mask;

	}



exit:

	kfree(msg);

	return ret;

}



static int cros_ec_host_command_proto_query(struct cros_ec_device *ec_dev,

					    int devidx,

					    struct cros_ec_command *msg)

static int cros_ec_get_proto_info(struct cros_ec_device *ec_dev, int devidx)

{

	/*

	 * Try using v3+ to query for supported protocols. If this

	 * command fails, fall back to v2. Returns the highest protocol

	 * supported by the EC.

	 * Also sets the max request/response/passthru size.

	 */

	int ret;

	struct cros_ec_command *msg;

	struct ec_response_get_protocol_info *info;

	int ret, mapped;



	ec_dev->proto_version = 3;

	if (devidx > 0)

		ec_dev->max_passthru = 0;



	msg = kzalloc(sizeof(*msg) + sizeof(*info), GFP_KERNEL);

	if (!msg)

		return -ENOMEM;



	memset(msg, 0, sizeof(*msg));

	msg->command = EC_CMD_PASSTHRU_OFFSET(devidx) | EC_CMD_GET_PROTOCOL_INFO;

	msg->insize = sizeof(struct ec_response_get_protocol_info);

	msg->insize = sizeof(*info);



	ret = send_command(ec_dev, msg);

	/*
@@ -299,15 +305,45 @@ static int cros_ec_host_command_proto_query(struct cros_ec_device *ec_dev, 
		dev_dbg(ec_dev->dev,

			"failed to check for EC[%d] protocol version: %d\n",

			devidx, ret);

		return ret;

		goto exit;

	}



	if (devidx > 0 && msg->result == EC_RES_INVALID_COMMAND)

		return -ENODEV;

	else if (msg->result != EC_RES_SUCCESS)

		return msg->result;

	mapped = cros_ec_map_error(msg->result);

	if (mapped) {

		ret = mapped;

		goto exit;

	}



	return 0;

	info = (struct ec_response_get_protocol_info *)msg->data;



	switch (devidx) {

	case CROS_EC_DEV_EC_INDEX:

		ec_dev->max_request = info->max_request_packet_size -

						sizeof(struct ec_host_request);

		ec_dev->max_response = info->max_response_packet_size -

						sizeof(struct ec_host_response);

		ec_dev->proto_version = min(EC_HOST_REQUEST_VERSION,

					    fls(info->protocol_versions) - 1);

		ec_dev->din_size = info->max_response_packet_size + EC_MAX_RESPONSE_OVERHEAD;

		ec_dev->dout_size = info->max_request_packet_size + EC_MAX_REQUEST_OVERHEAD;



		dev_dbg(ec_dev->dev, "using proto v%u\n", ec_dev->proto_version);

		break;

	case CROS_EC_DEV_PD_INDEX:

		ec_dev->max_passthru = info->max_request_packet_size -

						sizeof(struct ec_host_request);



		dev_dbg(ec_dev->dev, "found PD chip\n");

		break;

	default:

		dev_dbg(ec_dev->dev, "unknwon passthru index: %d\n", devidx);

		break;

	}



	ret = 0;

exit:

	kfree(msg);

	return ret;

}



static int cros_ec_host_command_proto_query_v2(struct cros_ec_device *ec_dev)
@@ -417,51 +453,13 @@ static int cros_ec_get_host_command_version_mask(struct cros_ec_device *ec_dev, 
int cros_ec_query_all(struct cros_ec_device *ec_dev)

{

	struct device *dev = ec_dev->dev;

	struct cros_ec_command *proto_msg;

	struct ec_response_get_protocol_info *proto_info;

	u32 ver_mask = 0;

	int ret;



	proto_msg = kzalloc(sizeof(*proto_msg) + sizeof(*proto_info),

			    GFP_KERNEL);

	if (!proto_msg)

		return -ENOMEM;



	/* First try sending with proto v3. */

	ec_dev->proto_version = 3;

	ret = cros_ec_host_command_proto_query(ec_dev, CROS_EC_DEV_EC_INDEX, proto_msg);



	if (ret == 0) {

		proto_info = (struct ec_response_get_protocol_info *)

			proto_msg->data;

		ec_dev->max_request = proto_info->max_request_packet_size -

			sizeof(struct ec_host_request);

		ec_dev->max_response = proto_info->max_response_packet_size -

			sizeof(struct ec_host_response);

		ec_dev->proto_version =

			min(EC_HOST_REQUEST_VERSION,

					fls(proto_info->protocol_versions) - 1);

		dev_dbg(ec_dev->dev,

			"using proto v%u\n",

			ec_dev->proto_version);



		ec_dev->din_size = proto_info->max_response_packet_size + EC_MAX_RESPONSE_OVERHEAD;

		ec_dev->dout_size = proto_info->max_request_packet_size + EC_MAX_REQUEST_OVERHEAD;



		/*

		 * Check for PD

		 */

		ret = cros_ec_host_command_proto_query(ec_dev, CROS_EC_DEV_PD_INDEX, proto_msg);



		if (ret) {

			dev_dbg(ec_dev->dev, "no PD chip found: %d\n", ret);

			ec_dev->max_passthru = 0;

		} else {

			dev_dbg(ec_dev->dev, "found PD chip\n");

			ec_dev->max_passthru =

				proto_info->max_request_packet_size -

				sizeof(struct ec_host_request);

		}

	if (!cros_ec_get_proto_info(ec_dev, CROS_EC_DEV_EC_INDEX)) {

		/* Check for PD. */

		cros_ec_get_proto_info(ec_dev, CROS_EC_DEV_PD_INDEX);

	} else {

		/* Try querying with a v2 hello message. */

		ec_dev->proto_version = 2;
@@ -524,8 +522,7 @@ int cros_ec_query_all(struct cros_ec_device *ec_dev) 
	ec_dev->host_sleep_v1 = (ret >= 0 && (ver_mask & EC_VER_MASK(1)));



	/* Get host event wake mask. */

	ret = cros_ec_get_host_event_wake_mask(ec_dev, proto_msg,

					       &ec_dev->host_event_wake_mask);

	ret = cros_ec_get_host_event_wake_mask(ec_dev, &ec_dev->host_event_wake_mask);

	if (ret < 0) {

		/*

		 * If the EC doesn't support EC_CMD_HOST_EVENT_GET_WAKE_MASK,
@@ -556,7 +553,6 @@ int cros_ec_query_all(struct cros_ec_device *ec_dev) 
	ret = 0;



exit:

	kfree(proto_msg);

	return ret;

}

EXPORT_SYMBOL(cros_ec_query_all);

drivers/platform/chrome/cros_ec_proto_test.c

+28 −28
Original line number Diff line number Diff line
@@ -195,7 +195,7 @@ static void cros_ec_proto_test_query_all_normal(struct kunit *test) 
	struct ec_xfer_mock *mock;

	int ret;



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		struct ec_response_get_protocol_info *data;
@@ -208,7 +208,7 @@ static void cros_ec_proto_test_query_all_normal(struct kunit *test) 
		data->max_response_packet_size = 0xef;

	}



	/* For cros_ec_host_command_proto_query() with passthru. */

	/* For cros_ec_get_proto_info() with passthru. */

	{

		struct ec_response_get_protocol_info *data;
@@ -256,7 +256,7 @@ static void cros_ec_proto_test_query_all_normal(struct kunit *test) 
	ret = cros_ec_query_all(ec_dev);

	KUNIT_EXPECT_EQ(test, ret, 0);



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_next();

		KUNIT_EXPECT_PTR_NE(test, mock, NULL);
@@ -274,7 +274,7 @@ static void cros_ec_proto_test_query_all_normal(struct kunit *test) 
		KUNIT_EXPECT_EQ(test, ec_dev->dout_size, 0xbe + EC_MAX_REQUEST_OVERHEAD);

	}



	/* For cros_ec_host_command_proto_query() with passthru. */

	/* For cros_ec_get_proto_info() with passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_next();

		KUNIT_EXPECT_PTR_NE(test, mock, NULL);
@@ -352,7 +352,7 @@ static void cros_ec_proto_test_query_all_no_pd_return_error(struct kunit *test) 
	/* Set some garbage bytes. */

	ec_dev->max_passthru = 0xbf;



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		struct ec_response_get_protocol_info *data;
@@ -368,7 +368,7 @@ static void cros_ec_proto_test_query_all_no_pd_return_error(struct kunit *test) 
		data->max_response_packet_size = 0xef;

	}



	/* For cros_ec_host_command_proto_query() with passthru. */

	/* For cros_ec_get_proto_info() with passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_addx(test, 0, EC_RES_INVALID_COMMAND, 0);

		KUNIT_ASSERT_PTR_NE(test, mock, NULL);
@@ -378,7 +378,7 @@ static void cros_ec_proto_test_query_all_no_pd_return_error(struct kunit *test) 
	ret = cros_ec_query_all(ec_dev);

	KUNIT_EXPECT_EQ(test, ret, 0);



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_next();

		KUNIT_EXPECT_PTR_NE(test, mock, NULL);
@@ -390,7 +390,7 @@ static void cros_ec_proto_test_query_all_no_pd_return_error(struct kunit *test) 
		KUNIT_EXPECT_EQ(test, mock->msg.outsize, 0);

	}



	/* For cros_ec_host_command_proto_query() with passthru. */

	/* For cros_ec_get_proto_info() with passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_next();

		KUNIT_EXPECT_PTR_NE(test, mock, NULL);
@@ -414,7 +414,7 @@ static void cros_ec_proto_test_query_all_legacy_normal_v3_return_error(struct ku 
	struct ec_xfer_mock *mock;

	int ret;



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_addx(test, 0, EC_RES_INVALID_COMMAND, 0);

		KUNIT_ASSERT_PTR_NE(test, mock, NULL);
@@ -435,7 +435,7 @@ static void cros_ec_proto_test_query_all_legacy_normal_v3_return_error(struct ku 
	ret = cros_ec_query_all(ec_dev);

	KUNIT_EXPECT_EQ(test, ret, 0);



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_next();

		KUNIT_EXPECT_PTR_NE(test, mock, NULL);
@@ -479,7 +479,7 @@ static void cros_ec_proto_test_query_all_legacy_xfer_error(struct kunit *test) 
	struct ec_xfer_mock *mock;

	int ret;



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_addx(test, 0, EC_RES_INVALID_COMMAND, 0);

		KUNIT_ASSERT_PTR_NE(test, mock, NULL);
@@ -496,7 +496,7 @@ static void cros_ec_proto_test_query_all_legacy_xfer_error(struct kunit *test) 
	KUNIT_EXPECT_EQ(test, ret, -EIO);

	KUNIT_EXPECT_EQ(test, ec_dev->proto_version, EC_PROTO_VERSION_UNKNOWN);



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_next();

		KUNIT_EXPECT_PTR_NE(test, mock, NULL);
@@ -527,7 +527,7 @@ static void cros_ec_proto_test_query_all_legacy_return_error(struct kunit *test) 
	struct ec_xfer_mock *mock;

	int ret;



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_addx(test, 0, EC_RES_INVALID_COMMAND, 0);

		KUNIT_ASSERT_PTR_NE(test, mock, NULL);
@@ -544,7 +544,7 @@ static void cros_ec_proto_test_query_all_legacy_return_error(struct kunit *test) 
	KUNIT_EXPECT_EQ(test, ret, EC_RES_INVALID_COMMAND);

	KUNIT_EXPECT_EQ(test, ec_dev->proto_version, EC_PROTO_VERSION_UNKNOWN);



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_next();

		KUNIT_EXPECT_PTR_NE(test, mock, NULL);
@@ -575,7 +575,7 @@ static void cros_ec_proto_test_query_all_legacy_data_error(struct kunit *test) 
	struct ec_xfer_mock *mock;

	int ret;



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_addx(test, 0, EC_RES_INVALID_COMMAND, 0);

		KUNIT_ASSERT_PTR_NE(test, mock, NULL);
@@ -597,7 +597,7 @@ static void cros_ec_proto_test_query_all_legacy_data_error(struct kunit *test) 
	KUNIT_EXPECT_EQ(test, ret, -EBADMSG);

	KUNIT_EXPECT_EQ(test, ec_dev->proto_version, EC_PROTO_VERSION_UNKNOWN);



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_next();

		KUNIT_EXPECT_PTR_NE(test, mock, NULL);
@@ -631,7 +631,7 @@ static void cros_ec_proto_test_query_all_no_mkbp(struct kunit *test) 
	/* Set some garbage bytes. */

	ec_dev->mkbp_event_supported = 0xbf;



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		struct ec_response_get_protocol_info *data;
@@ -647,7 +647,7 @@ static void cros_ec_proto_test_query_all_no_mkbp(struct kunit *test) 
		data->max_response_packet_size = 0xef;

	}



	/* For cros_ec_host_command_proto_query() with passthru. */

	/* For cros_ec_get_proto_info() with passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_addx(test, 0, EC_RES_INVALID_COMMAND, 0);

		KUNIT_ASSERT_PTR_NE(test, mock, NULL);
@@ -668,7 +668,7 @@ static void cros_ec_proto_test_query_all_no_mkbp(struct kunit *test) 
	ret = cros_ec_query_all(ec_dev);

	KUNIT_EXPECT_EQ(test, ret, 0);



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_next();

		KUNIT_EXPECT_PTR_NE(test, mock, NULL);
@@ -680,7 +680,7 @@ static void cros_ec_proto_test_query_all_no_mkbp(struct kunit *test) 
		KUNIT_EXPECT_EQ(test, mock->msg.outsize, 0);

	}



	/* For cros_ec_host_command_proto_query() with passthru. */

	/* For cros_ec_get_proto_info() with passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_next();

		KUNIT_EXPECT_PTR_NE(test, mock, NULL);
@@ -724,7 +724,7 @@ static void cros_ec_proto_test_query_all_no_host_sleep(struct kunit *test) 
	/* Set some garbage bytes. */

	ec_dev->host_sleep_v1 = true;



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		struct ec_response_get_protocol_info *data;
@@ -740,7 +740,7 @@ static void cros_ec_proto_test_query_all_no_host_sleep(struct kunit *test) 
		data->max_response_packet_size = 0xef;

	}



	/* For cros_ec_host_command_proto_query() with passthru. */

	/* For cros_ec_get_proto_info() with passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_addx(test, 0, EC_RES_INVALID_COMMAND, 0);

		KUNIT_ASSERT_PTR_NE(test, mock, NULL);
@@ -767,7 +767,7 @@ static void cros_ec_proto_test_query_all_no_host_sleep(struct kunit *test) 
	ret = cros_ec_query_all(ec_dev);

	KUNIT_EXPECT_EQ(test, ret, 0);



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_next();

		KUNIT_EXPECT_PTR_NE(test, mock, NULL);
@@ -779,7 +779,7 @@ static void cros_ec_proto_test_query_all_no_host_sleep(struct kunit *test) 
		KUNIT_EXPECT_EQ(test, mock->msg.outsize, 0);

	}



	/* For cros_ec_host_command_proto_query() with passthru. */

	/* For cros_ec_get_proto_info() with passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_next();

		KUNIT_EXPECT_PTR_NE(test, mock, NULL);
@@ -830,7 +830,7 @@ static void cros_ec_proto_test_query_all_default_wake_mask_return_error(struct k 
	/* Set some garbage bytes. */

	ec_dev->host_event_wake_mask = U32_MAX;



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		struct ec_response_get_protocol_info *data;
@@ -846,7 +846,7 @@ static void cros_ec_proto_test_query_all_default_wake_mask_return_error(struct k 
		data->max_response_packet_size = 0xef;

	}



	/* For cros_ec_host_command_proto_query() with passthru. */

	/* For cros_ec_get_proto_info() with passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_addx(test, 0, EC_RES_INVALID_COMMAND, 0);

		KUNIT_ASSERT_PTR_NE(test, mock, NULL);
@@ -874,7 +874,7 @@ static void cros_ec_proto_test_query_all_default_wake_mask_return_error(struct k 
	ret = cros_ec_query_all(ec_dev);

	KUNIT_EXPECT_EQ(test, ret, 0);



	/* For cros_ec_host_command_proto_query() without passthru. */

	/* For cros_ec_get_proto_info() without passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_next();

		KUNIT_EXPECT_PTR_NE(test, mock, NULL);
@@ -886,7 +886,7 @@ static void cros_ec_proto_test_query_all_default_wake_mask_return_error(struct k 
		KUNIT_EXPECT_EQ(test, mock->msg.outsize, 0);

	}



	/* For cros_ec_host_command_proto_query() with passthru. */

	/* For cros_ec_get_proto_info() with passthru. */

	{

		mock = cros_kunit_ec_xfer_mock_next();

		KUNIT_EXPECT_PTR_NE(test, mock, NULL);