2022-05-14 02:37:31

by Tzung-Bi Shih

[permalink] [raw]
Subject: [PATCH v2 0/7] platform/chrome: get rid of BUG_ON()

The series gets rid of BUG_ON()s in drivers/platform/chrome/. Most of them
can be replaced by returning proper return code.

The 2nd patch makes callers of cros_ec_prepare_tx() to take care of the
return code.

The 3rd patch turns cros_ec_prepare_tx() to return error code if any.

Changes from v1:
(https://patchwork.kernel.org/project/chrome-platform/cover/[email protected]/)
- Split the original 6th patch into 2 smaller patches.

Tzung-Bi Shih (7):
platform/chrome: cros_ec_proto: drop unneeded BUG_ON() in
prepare_packet()
platform/chrome: correct cros_ec_prepare_tx() usage
platform/chrome: cros_ec_proto: drop BUG_ON() in cros_ec_prepare_tx()
platform/chrome: cros_ec_proto: drop BUG_ON() in
cros_ec_get_host_event()
platform/chrome: cros_ec_i2c: drop BUG_ON() in cros_ec_pkt_xfer_i2c()
platform/chrome: cros_ec_spi: drop unneeded BUG_ON()
platform/chrome: cros_ec_spi: drop BUG_ON() if `din` isn't large
enough

drivers/platform/chrome/cros_ec_i2c.c | 12 ++++++++++--
drivers/platform/chrome/cros_ec_ishtp.c | 4 +++-
drivers/platform/chrome/cros_ec_lpc.c | 2 ++
drivers/platform/chrome/cros_ec_proto.c | 13 ++++++++-----
drivers/platform/chrome/cros_ec_rpmsg.c | 2 ++
drivers/platform/chrome/cros_ec_spi.c | 15 ++++++++++-----
6 files changed, 35 insertions(+), 13 deletions(-)

--
2.36.0.550.gb090851708-goog



2022-05-14 03:55:25

by Tzung-Bi Shih

[permalink] [raw]
Subject: [PATCH v2 6/7] platform/chrome: cros_ec_spi: drop unneeded BUG_ON()

In the context, the following conditions are always false:

- `todo` < 0
Suppose that EC_SPI_FRAME_START is found at the last byte of transfer.

In the case, `ptr` == `end` - 1. As a result, `todo` must be 0.

- `todo` > `ec_dev->din_size`
Suppose that there is no preamble bytes. EC_SPI_FRAME_START is found at
the first byte of transfer.

In the case, `end` == `ptr` + EC_MSG_PREAMBLE_COUNT.
As a result, `todo` == EC_MSG_PREAMBLE_COUNT - 1.
However, it already checked `ec_dev->din_size` < EC_MSG_PREAMBLE_COUNT at
the beginning of function.

Drop the unneeded BUG_ON().

Signed-off-by: Tzung-Bi Shih <[email protected]>
---
Changes from v1:
- Separate from the original 6th patch.
- Drop the BUG_ON() instead of returning -EINVAL.

drivers/platform/chrome/cros_ec_spi.c | 2 --
1 file changed, 2 deletions(-)

diff --git a/drivers/platform/chrome/cros_ec_spi.c b/drivers/platform/chrome/cros_ec_spi.c
index 589f18e9537d..5264615f46af 100644
--- a/drivers/platform/chrome/cros_ec_spi.c
+++ b/drivers/platform/chrome/cros_ec_spi.c
@@ -237,7 +237,6 @@ static int cros_ec_spi_receive_packet(struct cros_ec_device *ec_dev,
* start of our buffer
*/
todo = end - ++ptr;
- BUG_ON(todo < 0 || todo > ec_dev->din_size);
todo = min(todo, need_len);
memmove(ec_dev->din, ptr, todo);
ptr = ec_dev->din + todo;
@@ -345,7 +344,6 @@ static int cros_ec_spi_receive_response(struct cros_ec_device *ec_dev,
* start of our buffer
*/
todo = end - ++ptr;
- BUG_ON(todo < 0 || todo > ec_dev->din_size);
todo = min(todo, need_len);
memmove(ec_dev->din, ptr, todo);
ptr = ec_dev->din + todo;
--
2.36.0.550.gb090851708-goog


Subject: Re: [PATCH v2 0/7] platform/chrome: get rid of BUG_ON()

Hello:

This series was applied to chrome-platform/linux.git (for-kernelci)
by Tzung-Bi Shih <[email protected]>:

On Fri, 13 May 2022 12:41:36 +0800 you wrote:
> The series gets rid of BUG_ON()s in drivers/platform/chrome/. Most of them
> can be replaced by returning proper return code.
>
> The 2nd patch makes callers of cros_ec_prepare_tx() to take care of the
> return code.
>
> The 3rd patch turns cros_ec_prepare_tx() to return error code if any.
>
> [...]

Here is the summary with links:
- [v2,1/7] platform/chrome: cros_ec_proto: drop unneeded BUG_ON() in prepare_packet()
https://git.kernel.org/chrome-platform/c/42701e7c0cd2
- [v2,2/7] platform/chrome: correct cros_ec_prepare_tx() usage
https://git.kernel.org/chrome-platform/c/71d3ae7fb640
- [v2,3/7] platform/chrome: cros_ec_proto: drop BUG_ON() in cros_ec_prepare_tx()
https://git.kernel.org/chrome-platform/c/c2dcb1b06053
- [v2,4/7] platform/chrome: cros_ec_proto: drop BUG_ON() in cros_ec_get_host_event()
https://git.kernel.org/chrome-platform/c/20a264c97bc8
- [v2,5/7] platform/chrome: cros_ec_i2c: drop BUG_ON() in cros_ec_pkt_xfer_i2c()
https://git.kernel.org/chrome-platform/c/8bff946c4199
- [v2,6/7] platform/chrome: cros_ec_spi: drop unneeded BUG_ON()
https://git.kernel.org/chrome-platform/c/ddec8e9e90ce
- [v2,7/7] platform/chrome: cros_ec_spi: drop BUG_ON() if `din` isn't large enough
https://git.kernel.org/chrome-platform/c/bbd43a37ec7a

You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html



Subject: Re: [PATCH v2 0/7] platform/chrome: get rid of BUG_ON()

Hello:

This series was applied to chrome-platform/linux.git (for-next)
by Tzung-Bi Shih <[email protected]>:

On Fri, 13 May 2022 12:41:36 +0800 you wrote:
> The series gets rid of BUG_ON()s in drivers/platform/chrome/. Most of them
> can be replaced by returning proper return code.
>
> The 2nd patch makes callers of cros_ec_prepare_tx() to take care of the
> return code.
>
> The 3rd patch turns cros_ec_prepare_tx() to return error code if any.
>
> [...]

Here is the summary with links:
- [v2,1/7] platform/chrome: cros_ec_proto: drop unneeded BUG_ON() in prepare_packet()
https://git.kernel.org/chrome-platform/c/42701e7c0cd2
- [v2,2/7] platform/chrome: correct cros_ec_prepare_tx() usage
https://git.kernel.org/chrome-platform/c/71d3ae7fb640
- [v2,3/7] platform/chrome: cros_ec_proto: drop BUG_ON() in cros_ec_prepare_tx()
https://git.kernel.org/chrome-platform/c/c2dcb1b06053
- [v2,4/7] platform/chrome: cros_ec_proto: drop BUG_ON() in cros_ec_get_host_event()
https://git.kernel.org/chrome-platform/c/20a264c97bc8
- [v2,5/7] platform/chrome: cros_ec_i2c: drop BUG_ON() in cros_ec_pkt_xfer_i2c()
https://git.kernel.org/chrome-platform/c/8bff946c4199
- [v2,6/7] platform/chrome: cros_ec_spi: drop unneeded BUG_ON()
https://git.kernel.org/chrome-platform/c/ddec8e9e90ce
- [v2,7/7] platform/chrome: cros_ec_spi: drop BUG_ON() if `din` isn't large enough
https://git.kernel.org/chrome-platform/c/bbd43a37ec7a

You are awesome, thank you!
--
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html