diff mbox series

[10/13] platform/chrome: cros_ec_proto: arrange get_host_command_version_mask()

Message ID 20220606141051.285823-11-tzungbi@kernel.org (mailing list archive)
State Superseded
Headers show
Series platform/chrome: Kunit tests and refactor for cros_ec_query_all() | expand

Commit Message

Tzung-Bi Shih June 6, 2022, 2:10 p.m. UTC
- cros_ec_get_host_command_version_mask() is a private (static) function.
  Rename it to get_host_command_version_mask().

- Join multiple lines into one if it can fit in 100 columns.

- Don't show MKBP support version if it doesn't support.

Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org>
---
 drivers/platform/chrome/cros_ec_proto.c      | 26 ++++++----------
 drivers/platform/chrome/cros_ec_proto_test.c | 32 ++++++++++----------
 2 files changed, 25 insertions(+), 33 deletions(-)

Comments

Guenter Roeck June 6, 2022, 4:09 p.m. UTC | #1
On Mon, Jun 6, 2022 at 7:12 AM Tzung-Bi Shih <tzungbi@kernel.org> wrote:
>
> - cros_ec_get_host_command_version_mask() is a private (static) function.
>   Rename it to get_host_command_version_mask().

Personally I prefer to still have prefixes, even for static functions.
If the idea is to have a shorter function name, maybe shorten the rest
of the function name a bit.

Guenter

>
> - Join multiple lines into one if it can fit in 100 columns.
>
> - Don't show MKBP support version if it doesn't support.
>
> Signed-off-by: Tzung-Bi Shih <tzungbi@kernel.org>
> ---
>  drivers/platform/chrome/cros_ec_proto.c      | 26 ++++++----------
>  drivers/platform/chrome/cros_ec_proto_test.c | 32 ++++++++++----------
>  2 files changed, 25 insertions(+), 33 deletions(-)
>
> diff --git a/drivers/platform/chrome/cros_ec_proto.c b/drivers/platform/chrome/cros_ec_proto.c
> index 5f4414f05d66..07b57ea105b6 100644
> --- a/drivers/platform/chrome/cros_ec_proto.c
> +++ b/drivers/platform/chrome/cros_ec_proto.c
> @@ -400,7 +400,7 @@ static int fill_protocol_info_legacy(struct cros_ec_device *ec_dev)
>  }
>
>  /*
> - * cros_ec_get_host_command_version_mask
> + * get_host_command_version_mask
>   *
>   * Get the version mask of a given command.
>   *
> @@ -415,16 +415,14 @@ static int fill_protocol_info_legacy(struct cros_ec_device *ec_dev)
>   * the caller has ec_dev->lock mutex or the caller knows there is
>   * no other command in progress.
>   */
> -static int cros_ec_get_host_command_version_mask(struct cros_ec_device *ec_dev,
> -       u16 cmd, u32 *mask)
> +static int get_host_command_version_mask(struct cros_ec_device *ec_dev, u16 cmd, u32 *mask)
>  {
>         struct ec_params_get_cmd_versions *pver;
>         struct ec_response_get_cmd_versions *rver;
>         struct cros_ec_command *msg;
>         int ret;
>
> -       msg = kmalloc(sizeof(*msg) + max(sizeof(*rver), sizeof(*pver)),
> -                     GFP_KERNEL);
> +       msg = kmalloc(sizeof(*msg) + max(sizeof(*rver), sizeof(*pver)), GFP_KERNEL);
>         if (!msg)
>                 return -ENOMEM;
>
> @@ -443,7 +441,6 @@ static int cros_ec_get_host_command_version_mask(struct cros_ec_device *ec_dev,
>         }
>
>         kfree(msg);
> -
>         return ret;
>  }
>
> @@ -488,21 +485,16 @@ int cros_ec_query_all(struct cros_ec_device *ec_dev)
>                 return -ENOMEM;
>
>         /* Probe if MKBP event is supported */
> -       ret = cros_ec_get_host_command_version_mask(ec_dev,
> -                                                   EC_CMD_GET_NEXT_EVENT,
> -                                                   &ver_mask);
> -       if (ret < 0 || ver_mask == 0)
> +       ret = get_host_command_version_mask(ec_dev, EC_CMD_GET_NEXT_EVENT, &ver_mask);
> +       if (ret < 0 || ver_mask == 0) {
>                 ec_dev->mkbp_event_supported = 0;
> -       else
> +       } else {
>                 ec_dev->mkbp_event_supported = fls(ver_mask);
> -
> -       dev_dbg(ec_dev->dev, "MKBP support version %u\n",
> -               ec_dev->mkbp_event_supported - 1);
> +               dev_dbg(ec_dev->dev, "MKBP support version %u\n", ec_dev->mkbp_event_supported - 1);
> +       }
>
>         /* Probe if host sleep v1 is supported for S0ix failure detection. */
> -       ret = cros_ec_get_host_command_version_mask(ec_dev,
> -                                                   EC_CMD_HOST_SLEEP_EVENT,
> -                                                   &ver_mask);
> +       ret = get_host_command_version_mask(ec_dev, EC_CMD_HOST_SLEEP_EVENT, &ver_mask);
>         ec_dev->host_sleep_v1 = (ret >= 0 && (ver_mask & EC_VER_MASK(1)));
>
>         /* Get host event wake mask. */
> diff --git a/drivers/platform/chrome/cros_ec_proto_test.c b/drivers/platform/chrome/cros_ec_proto_test.c
> index 22f9322787f4..e2c369765612 100644
> --- a/drivers/platform/chrome/cros_ec_proto_test.c
> +++ b/drivers/platform/chrome/cros_ec_proto_test.c
> @@ -217,7 +217,7 @@ static void cros_ec_proto_test_query_all_normal(struct kunit *test)
>                 data->max_request_packet_size = 0xbf;
>         }
>
> -       /* For cros_ec_get_host_command_version_mask() for MKBP. */
> +       /* For get_host_command_version_mask() for MKBP. */
>         {
>                 struct ec_response_get_cmd_versions *data;
>
> @@ -228,7 +228,7 @@ static void cros_ec_proto_test_query_all_normal(struct kunit *test)
>                 data->version_mask = BIT(6) | BIT(5);
>         }
>
> -       /* For cros_ec_get_host_command_version_mask() for host sleep v1. */
> +       /* For get_host_command_version_mask() for host sleep v1. */
>         {
>                 struct ec_response_get_cmd_versions *data;
>
> @@ -288,7 +288,7 @@ static void cros_ec_proto_test_query_all_normal(struct kunit *test)
>                 KUNIT_EXPECT_EQ(test, ec_dev->max_passthru, 0xbf - sizeof(struct ec_host_request));
>         }
>
> -       /* For cros_ec_get_host_command_version_mask() for MKBP. */
> +       /* For get_host_command_version_mask() for MKBP. */
>         {
>                 struct ec_params_get_cmd_versions *data;
>
> @@ -307,7 +307,7 @@ static void cros_ec_proto_test_query_all_normal(struct kunit *test)
>                 KUNIT_EXPECT_EQ(test, ec_dev->mkbp_event_supported, 7);
>         }
>
> -       /* For cros_ec_get_host_command_version_mask() for host sleep v1. */
> +       /* For get_host_command_version_mask() for host sleep v1. */
>         {
>                 struct ec_params_get_cmd_versions *data;
>
> @@ -502,7 +502,7 @@ static void cros_ec_proto_test_query_all_no_mkbp(struct kunit *test)
>                 KUNIT_ASSERT_PTR_NE(test, mock, NULL);
>         }
>
> -       /* For cros_ec_get_host_command_version_mask() for MKBP. */
> +       /* For get_host_command_version_mask() for MKBP. */
>         {
>                 struct ec_response_get_cmd_versions *data;
>
> @@ -543,7 +543,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_get_host_command_version_mask() for MKBP. */
> +       /* For get_host_command_version_mask() for MKBP. */
>         {
>                 struct ec_params_get_cmd_versions *data;
>
> @@ -596,7 +596,7 @@ static void cros_ec_proto_test_query_all_no_mkbp2(struct kunit *test)
>                 KUNIT_ASSERT_PTR_NE(test, mock, NULL);
>         }
>
> -       /* For cros_ec_get_host_command_version_mask() for MKBP. */
> +       /* For get_host_command_version_mask() for MKBP. */
>         {
>                 mock = cros_kunit_ec_xfer_mock_add(test, 0);
>                 KUNIT_ASSERT_PTR_NE(test, mock, NULL);
> @@ -632,7 +632,7 @@ static void cros_ec_proto_test_query_all_no_mkbp2(struct kunit *test)
>                 KUNIT_EXPECT_EQ(test, mock->msg.outsize, 0);
>         }
>
> -       /* For cros_ec_get_host_command_version_mask() for MKBP. */
> +       /* For get_host_command_version_mask() for MKBP. */
>         {
>                 struct ec_params_get_cmd_versions *data;
>
> @@ -685,14 +685,14 @@ static void cros_ec_proto_test_query_all_no_host_sleep(struct kunit *test)
>                 KUNIT_ASSERT_PTR_NE(test, mock, NULL);
>         }
>
> -       /* For cros_ec_get_host_command_version_mask() for MKBP. */
> +       /* For get_host_command_version_mask() for MKBP. */
>         {
>                 mock = cros_kunit_ec_xfer_mock_add(test,
>                                                    sizeof(struct ec_response_get_cmd_versions));
>                 KUNIT_ASSERT_PTR_NE(test, mock, NULL);
>         }
>
> -       /* For cros_ec_get_host_command_version_mask() for host sleep v1. */
> +       /* For get_host_command_version_mask() for host sleep v1. */
>         {
>                 struct ec_response_get_cmd_versions *data;
>
> @@ -733,7 +733,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_get_host_command_version_mask() for MKBP. */
> +       /* For get_host_command_version_mask() for MKBP. */
>         {
>                 mock = cros_kunit_ec_xfer_mock_next();
>                 KUNIT_EXPECT_PTR_NE(test, mock, NULL);
> @@ -745,7 +745,7 @@ static void cros_ec_proto_test_query_all_no_host_sleep(struct kunit *test)
>                 KUNIT_EXPECT_EQ(test, mock->msg.outsize, sizeof(struct ec_params_get_cmd_versions));
>         }
>
> -       /* For cros_ec_get_host_command_version_mask() for host sleep v1. */
> +       /* For get_host_command_version_mask() for host sleep v1. */
>         {
>                 mock = cros_kunit_ec_xfer_mock_next();
>                 KUNIT_EXPECT_PTR_NE(test, mock, NULL);
> @@ -793,14 +793,14 @@ static void cros_ec_proto_test_query_all_default_wake_mask(struct kunit *test)
>                 KUNIT_ASSERT_PTR_NE(test, mock, NULL);
>         }
>
> -       /* For cros_ec_get_host_command_version_mask() for MKBP. */
> +       /* For get_host_command_version_mask() for MKBP. */
>         {
>                 mock = cros_kunit_ec_xfer_mock_add(test,
>                                                    sizeof(struct ec_response_get_cmd_versions));
>                 KUNIT_ASSERT_PTR_NE(test, mock, NULL);
>         }
>
> -       /* For cros_ec_get_host_command_version_mask() for host sleep v1. */
> +       /* For get_host_command_version_mask() for host sleep v1. */
>         {
>                 mock = cros_kunit_ec_xfer_mock_add(test,
>                                                    sizeof(struct ec_response_get_cmd_versions));
> @@ -844,7 +844,7 @@ static void cros_ec_proto_test_query_all_default_wake_mask(struct kunit *test)
>                 KUNIT_EXPECT_EQ(test, mock->msg.outsize, 0);
>         }
>
> -       /* For cros_ec_get_host_command_version_mask() for MKBP. */
> +       /* For get_host_command_version_mask() for MKBP. */
>         {
>                 mock = cros_kunit_ec_xfer_mock_next();
>                 KUNIT_EXPECT_PTR_NE(test, mock, NULL);
> @@ -856,7 +856,7 @@ static void cros_ec_proto_test_query_all_default_wake_mask(struct kunit *test)
>                 KUNIT_EXPECT_EQ(test, mock->msg.outsize, sizeof(struct ec_params_get_cmd_versions));
>         }
>
> -       /* For cros_ec_get_host_command_version_mask() for host sleep v1. */
> +       /* For get_host_command_version_mask() for host sleep v1. */
>         {
>                 mock = cros_kunit_ec_xfer_mock_next();
>                 KUNIT_EXPECT_PTR_NE(test, mock, NULL);
> --
> 2.36.1.255.ge46751e96f-goog
>
Tzung-Bi Shih June 7, 2022, 12:55 a.m. UTC | #2
On Mon, Jun 06, 2022 at 09:09:25AM -0700, Guenter Roeck wrote:
> On Mon, Jun 6, 2022 at 7:12 AM Tzung-Bi Shih <tzungbi@kernel.org> wrote:
> >
> > - cros_ec_get_host_command_version_mask() is a private (static) function.
> >   Rename it to get_host_command_version_mask().
> 
> Personally I prefer to still have prefixes, even for static functions.
> If the idea is to have a shorter function name, maybe shorten the rest
> of the function name a bit.

Ack, will fix in next version.
diff mbox series

Patch

diff --git a/drivers/platform/chrome/cros_ec_proto.c b/drivers/platform/chrome/cros_ec_proto.c
index 5f4414f05d66..07b57ea105b6 100644
--- a/drivers/platform/chrome/cros_ec_proto.c
+++ b/drivers/platform/chrome/cros_ec_proto.c
@@ -400,7 +400,7 @@  static int fill_protocol_info_legacy(struct cros_ec_device *ec_dev)
 }
 
 /*
- * cros_ec_get_host_command_version_mask
+ * get_host_command_version_mask
  *
  * Get the version mask of a given command.
  *
@@ -415,16 +415,14 @@  static int fill_protocol_info_legacy(struct cros_ec_device *ec_dev)
  * the caller has ec_dev->lock mutex or the caller knows there is
  * no other command in progress.
  */
-static int cros_ec_get_host_command_version_mask(struct cros_ec_device *ec_dev,
-	u16 cmd, u32 *mask)
+static int get_host_command_version_mask(struct cros_ec_device *ec_dev, u16 cmd, u32 *mask)
 {
 	struct ec_params_get_cmd_versions *pver;
 	struct ec_response_get_cmd_versions *rver;
 	struct cros_ec_command *msg;
 	int ret;
 
-	msg = kmalloc(sizeof(*msg) + max(sizeof(*rver), sizeof(*pver)),
-		      GFP_KERNEL);
+	msg = kmalloc(sizeof(*msg) + max(sizeof(*rver), sizeof(*pver)), GFP_KERNEL);
 	if (!msg)
 		return -ENOMEM;
 
@@ -443,7 +441,6 @@  static int cros_ec_get_host_command_version_mask(struct cros_ec_device *ec_dev,
 	}
 
 	kfree(msg);
-
 	return ret;
 }
 
@@ -488,21 +485,16 @@  int cros_ec_query_all(struct cros_ec_device *ec_dev)
 		return -ENOMEM;
 
 	/* Probe if MKBP event is supported */
-	ret = cros_ec_get_host_command_version_mask(ec_dev,
-						    EC_CMD_GET_NEXT_EVENT,
-						    &ver_mask);
-	if (ret < 0 || ver_mask == 0)
+	ret = get_host_command_version_mask(ec_dev, EC_CMD_GET_NEXT_EVENT, &ver_mask);
+	if (ret < 0 || ver_mask == 0) {
 		ec_dev->mkbp_event_supported = 0;
-	else
+	} else {
 		ec_dev->mkbp_event_supported = fls(ver_mask);
-
-	dev_dbg(ec_dev->dev, "MKBP support version %u\n",
-		ec_dev->mkbp_event_supported - 1);
+		dev_dbg(ec_dev->dev, "MKBP support version %u\n", ec_dev->mkbp_event_supported - 1);
+	}
 
 	/* Probe if host sleep v1 is supported for S0ix failure detection. */
-	ret = cros_ec_get_host_command_version_mask(ec_dev,
-						    EC_CMD_HOST_SLEEP_EVENT,
-						    &ver_mask);
+	ret = get_host_command_version_mask(ec_dev, EC_CMD_HOST_SLEEP_EVENT, &ver_mask);
 	ec_dev->host_sleep_v1 = (ret >= 0 && (ver_mask & EC_VER_MASK(1)));
 
 	/* Get host event wake mask. */
diff --git a/drivers/platform/chrome/cros_ec_proto_test.c b/drivers/platform/chrome/cros_ec_proto_test.c
index 22f9322787f4..e2c369765612 100644
--- a/drivers/platform/chrome/cros_ec_proto_test.c
+++ b/drivers/platform/chrome/cros_ec_proto_test.c
@@ -217,7 +217,7 @@  static void cros_ec_proto_test_query_all_normal(struct kunit *test)
 		data->max_request_packet_size = 0xbf;
 	}
 
-	/* For cros_ec_get_host_command_version_mask() for MKBP. */
+	/* For get_host_command_version_mask() for MKBP. */
 	{
 		struct ec_response_get_cmd_versions *data;
 
@@ -228,7 +228,7 @@  static void cros_ec_proto_test_query_all_normal(struct kunit *test)
 		data->version_mask = BIT(6) | BIT(5);
 	}
 
-	/* For cros_ec_get_host_command_version_mask() for host sleep v1. */
+	/* For get_host_command_version_mask() for host sleep v1. */
 	{
 		struct ec_response_get_cmd_versions *data;
 
@@ -288,7 +288,7 @@  static void cros_ec_proto_test_query_all_normal(struct kunit *test)
 		KUNIT_EXPECT_EQ(test, ec_dev->max_passthru, 0xbf - sizeof(struct ec_host_request));
 	}
 
-	/* For cros_ec_get_host_command_version_mask() for MKBP. */
+	/* For get_host_command_version_mask() for MKBP. */
 	{
 		struct ec_params_get_cmd_versions *data;
 
@@ -307,7 +307,7 @@  static void cros_ec_proto_test_query_all_normal(struct kunit *test)
 		KUNIT_EXPECT_EQ(test, ec_dev->mkbp_event_supported, 7);
 	}
 
-	/* For cros_ec_get_host_command_version_mask() for host sleep v1. */
+	/* For get_host_command_version_mask() for host sleep v1. */
 	{
 		struct ec_params_get_cmd_versions *data;
 
@@ -502,7 +502,7 @@  static void cros_ec_proto_test_query_all_no_mkbp(struct kunit *test)
 		KUNIT_ASSERT_PTR_NE(test, mock, NULL);
 	}
 
-	/* For cros_ec_get_host_command_version_mask() for MKBP. */
+	/* For get_host_command_version_mask() for MKBP. */
 	{
 		struct ec_response_get_cmd_versions *data;
 
@@ -543,7 +543,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_get_host_command_version_mask() for MKBP. */
+	/* For get_host_command_version_mask() for MKBP. */
 	{
 		struct ec_params_get_cmd_versions *data;
 
@@ -596,7 +596,7 @@  static void cros_ec_proto_test_query_all_no_mkbp2(struct kunit *test)
 		KUNIT_ASSERT_PTR_NE(test, mock, NULL);
 	}
 
-	/* For cros_ec_get_host_command_version_mask() for MKBP. */
+	/* For get_host_command_version_mask() for MKBP. */
 	{
 		mock = cros_kunit_ec_xfer_mock_add(test, 0);
 		KUNIT_ASSERT_PTR_NE(test, mock, NULL);
@@ -632,7 +632,7 @@  static void cros_ec_proto_test_query_all_no_mkbp2(struct kunit *test)
 		KUNIT_EXPECT_EQ(test, mock->msg.outsize, 0);
 	}
 
-	/* For cros_ec_get_host_command_version_mask() for MKBP. */
+	/* For get_host_command_version_mask() for MKBP. */
 	{
 		struct ec_params_get_cmd_versions *data;
 
@@ -685,14 +685,14 @@  static void cros_ec_proto_test_query_all_no_host_sleep(struct kunit *test)
 		KUNIT_ASSERT_PTR_NE(test, mock, NULL);
 	}
 
-	/* For cros_ec_get_host_command_version_mask() for MKBP. */
+	/* For get_host_command_version_mask() for MKBP. */
 	{
 		mock = cros_kunit_ec_xfer_mock_add(test,
 						   sizeof(struct ec_response_get_cmd_versions));
 		KUNIT_ASSERT_PTR_NE(test, mock, NULL);
 	}
 
-	/* For cros_ec_get_host_command_version_mask() for host sleep v1. */
+	/* For get_host_command_version_mask() for host sleep v1. */
 	{
 		struct ec_response_get_cmd_versions *data;
 
@@ -733,7 +733,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_get_host_command_version_mask() for MKBP. */
+	/* For get_host_command_version_mask() for MKBP. */
 	{
 		mock = cros_kunit_ec_xfer_mock_next();
 		KUNIT_EXPECT_PTR_NE(test, mock, NULL);
@@ -745,7 +745,7 @@  static void cros_ec_proto_test_query_all_no_host_sleep(struct kunit *test)
 		KUNIT_EXPECT_EQ(test, mock->msg.outsize, sizeof(struct ec_params_get_cmd_versions));
 	}
 
-	/* For cros_ec_get_host_command_version_mask() for host sleep v1. */
+	/* For get_host_command_version_mask() for host sleep v1. */
 	{
 		mock = cros_kunit_ec_xfer_mock_next();
 		KUNIT_EXPECT_PTR_NE(test, mock, NULL);
@@ -793,14 +793,14 @@  static void cros_ec_proto_test_query_all_default_wake_mask(struct kunit *test)
 		KUNIT_ASSERT_PTR_NE(test, mock, NULL);
 	}
 
-	/* For cros_ec_get_host_command_version_mask() for MKBP. */
+	/* For get_host_command_version_mask() for MKBP. */
 	{
 		mock = cros_kunit_ec_xfer_mock_add(test,
 						   sizeof(struct ec_response_get_cmd_versions));
 		KUNIT_ASSERT_PTR_NE(test, mock, NULL);
 	}
 
-	/* For cros_ec_get_host_command_version_mask() for host sleep v1. */
+	/* For get_host_command_version_mask() for host sleep v1. */
 	{
 		mock = cros_kunit_ec_xfer_mock_add(test,
 						   sizeof(struct ec_response_get_cmd_versions));
@@ -844,7 +844,7 @@  static void cros_ec_proto_test_query_all_default_wake_mask(struct kunit *test)
 		KUNIT_EXPECT_EQ(test, mock->msg.outsize, 0);
 	}
 
-	/* For cros_ec_get_host_command_version_mask() for MKBP. */
+	/* For get_host_command_version_mask() for MKBP. */
 	{
 		mock = cros_kunit_ec_xfer_mock_next();
 		KUNIT_EXPECT_PTR_NE(test, mock, NULL);
@@ -856,7 +856,7 @@  static void cros_ec_proto_test_query_all_default_wake_mask(struct kunit *test)
 		KUNIT_EXPECT_EQ(test, mock->msg.outsize, sizeof(struct ec_params_get_cmd_versions));
 	}
 
-	/* For cros_ec_get_host_command_version_mask() for host sleep v1. */
+	/* For get_host_command_version_mask() for host sleep v1. */
 	{
 		mock = cros_kunit_ec_xfer_mock_next();
 		KUNIT_EXPECT_PTR_NE(test, mock, NULL);