platform/chrome: get rid of BUG_ON()
Subsystems (2)
Tzung-Bi Shih
maintainerv2 cover 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(-)
Signature · 1 line
2.36.0.550.gb090851708-goog
Tzung-Bi Shih
maintainerPATCH v2 1/7 platform/chrome: cros_ec_proto: drop unneeded BUG_ON() in prepare_packet()
prepare_packet() gets called if ec_dev->proto_version > 2. For now, it must be equivalent to EC_HOST_REQUEST_VERSION.
Drop the BUG_ON().
---
Changes from v1:
- Add R-b tag.
drivers/platform/chrome/cros_ec_proto.c | 1 - 1 file changed, 1 deletion(-)
drivers/platform/chrome/cros_ec_proto.c +0 -1
@@ -60,7 +60,6 @@ static int prepare_packet(struct cros_ec_device *ec_dev,int i;u8 csum =0 ; -BUG_ON (ec_dev->proto_version !=EC_HOST_REQUEST_VERSION );BUG_ON (msg->outsize +sizeof (*request) > ec_dev->dout_size); out = ec_dev->dout;
Signature · 1 line
2.36.0.550.gb090851708-goog
Tzung-Bi Shih
maintainerPATCH v2 2/7 platform/chrome: correct cros_ec_prepare_tx() usage
In reply to Tzung-Bi Shihcros_ec_prepare_tx() returns either:
- >= 0 for number of prepared bytes.
- < 0 for -errno.
Correct the comment and make sure all callers check the return code.
---
Changes from v1:
- Add R-b tag.
drivers/platform/chrome/cros_ec_i2c.c | 2 ++ drivers/platform/chrome/cros_ec_ishtp.c | 4 +++- drivers/platform/chrome/cros_ec_lpc.c | 2 ++ drivers/platform/chrome/cros_ec_proto.c | 2 +- drivers/platform/chrome/cros_ec_rpmsg.c | 2 ++ drivers/platform/chrome/cros_ec_spi.c | 4 ++++ 6 files changed, 14 insertions(+), 2 deletions(-)
drivers/platform/chrome/cros_ec_i2c.c +2 -0
@@ -89,6 +89,8 @@ static int cros_ec_pkt_xfer_i2c(struct cros_ec_device *ec_dev, ec_dev->dout++; ret =cros_ec_prepare_tx (ec_dev, msg); +if (ret <0 ) + goto done; ec_dev->dout--;/* send command to EC and read answer */
drivers/platform/chrome/cros_ec_ishtp.c +3 -1
@@ -521,7 +521,9 @@ static int cros_ec_pkt_xfer_ish(struct cros_ec_device *ec_dev, out_msg->hdr.status =0 ; ec_dev->dout +=OUT_MSG_EC_REQUEST_PREAMBLE ; -cros_ec_prepare_tx (ec_dev, msg); + rv =cros_ec_prepare_tx (ec_dev, msg); +if (rv <0 ) + goto end_error; ec_dev->dout -=OUT_MSG_EC_REQUEST_PREAMBLE ; dev_dbg(dev,
drivers/platform/chrome/cros_ec_lpc.c +2 -0
@@ -147,6 +147,8 @@ static int cros_ec_pkt_xfer_lpc(struct cros_ec_device *ec,u8 *dout; ret =cros_ec_prepare_tx (ec, msg); +if (ret <0 ) + goto done;/* Write buffer */ cros_ec_lpc_ops.write (EC_LPC_ADDR_HOST_PACKET , ret, ec->dout);
drivers/platform/chrome/cros_ec_proto.c +1 -1
@@ -164,7 +164,7 @@ static int send_command(struct cros_ec_device *ec_dev,* only SPI uses it. Once LPC uses the same protocol it can start using it. * I2C could use it now, with a refactor of the existing code. * -* Return: 0 on success or negative error code. +* Return: number of prepared bytes on success or negative error code. */ int cros_ec_prepare_tx (struct cros_ec_device *ec_dev,struct cros_ec_command *msg)
drivers/platform/chrome/cros_ec_rpmsg.c +2 -0
@@ -89,6 +89,8 @@ static int cros_ec_pkt_xfer_rpmsg(struct cros_ec_device *ec_dev, ec_msg->result =0 ; len =cros_ec_prepare_tx (ec_dev, ec_msg); +if (len <0 ) +return len;dev_dbg (ec_dev->dev,"prepared, len=%d\n" , len);reinit_completion (&ec_rpmsg->xfer_ack);
drivers/platform/chrome/cros_ec_spi.c +4 -0
@@ -401,6 +401,8 @@ static int do_cros_ec_pkt_xfer_spi(struct cros_ec_device *ec_dev,unsigned long delay; len =cros_ec_prepare_tx (ec_dev, ec_msg); +if (len <0 ) +return len;dev_dbg (ec_dev->dev,"prepared, len=%d\n" , len);/* If it's too soon to do another transaction, wait */
@@ -544,6 +546,8 @@ static int do_cros_ec_cmd_xfer_spi(struct cros_ec_device *ec_dev,unsigned long delay; len =cros_ec_prepare_tx (ec_dev, ec_msg); +if (len <0 ) +return len;dev_dbg (ec_dev->dev,"prepared, len=%d\n" , len);/* If it's too soon to do another transaction, wait */
Signature · 1 line
2.36.0.550.gb090851708-goog
Tzung-Bi Shih
maintainerPATCH v2 3/7 platform/chrome: cros_ec_proto: drop BUG_ON() in cros_ec_prepare_tx()
In reply to Tzung-Bi ShihIt is overkill to crash the kernel if the given message is oversize.
Drop the BUG_ON() and return -EINVAL instead.
---
Changes from v1:
- Add R-b tag.
drivers/platform/chrome/cros_ec_proto.c | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-)
drivers/platform/chrome/cros_ec_proto.c +5 -2
@@ -60,7 +60,8 @@ static int prepare_packet(struct cros_ec_device *ec_dev,int i;u8 csum =0 ; -BUG_ON (msg->outsize +sizeof (*request) > ec_dev->dout_size); +if (msg->outsize +sizeof (*request) > ec_dev->dout_size) +return -EINVAL ; out = ec_dev->dout; request = (struct ec_host_request *)out;
@@ -176,7 +177,9 @@ int cros_ec_prepare_tx(struct cros_ec_device *ec_dev,if (ec_dev->proto_version >2 )return prepare_packet (ec_dev, msg); -BUG_ON (msg->outsize >EC_PROTO2_MAX_PARAM_SIZE ); +if (msg->outsize >EC_PROTO2_MAX_PARAM_SIZE ) +return -EINVAL ; + out = ec_dev->dout; out[0 ] =EC_CMD_VERSION0 + msg->version; out[1 ] = msg->command;
Signature · 1 line
2.36.0.550.gb090851708-goog
Tzung-Bi Shih
maintainerPATCH v2 4/7 platform/chrome: cros_ec_proto: drop BUG_ON() in cros_ec_get_host_event()
In reply to Tzung-Bi ShihIt is overkill to crash the kernel if the ec_dev doesn't support MKBP event but gets called into cros_ec_get_host_event().
Drop the BUG_ON() and return error (0 in the case) instead.
---
Changes from v1:
- Add R-b tag.
drivers/platform/chrome/cros_ec_proto.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/platform/chrome/cros_ec_proto.c +2 -1
@@ -817,7 +817,8 @@ u32 cros_ec_get_host_event(struct cros_ec_device *ec_dev) {u32 host_event; -BUG_ON (!ec_dev->mkbp_event_supported); +if (!ec_dev->mkbp_event_supported) +return 0 ;if (ec_dev->event_data.event_type !=EC_MKBP_EVENT_HOST_EVENT )return 0 ;
Signature · 1 line
2.36.0.550.gb090851708-goog
Tzung-Bi Shih
maintainerPATCH v2 5/7 platform/chrome: cros_ec_i2c: drop BUG_ON() in cros_ec_pkt_xfer_i2c()
In reply to Tzung-Bi ShihIt is overkill to crash the kernel if the given message is oversize.
Drop the BUG_ON() and return -EINVAL instead.
---
Changes from v1:
- Add R-b tag.
drivers/platform/chrome/cros_ec_i2c.c | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-)
drivers/platform/chrome/cros_ec_i2c.c +8 -2
@@ -72,13 +72,19 @@ static int cros_ec_pkt_xfer_i2c(struct cros_ec_device *ec_dev, i2c_msg[1 ].flags =I2C_M_RD ; packet_len = msg->insize + response_header_size; -BUG_ON (packet_len > ec_dev->din_size); +if (packet_len > ec_dev->din_size) { + ret = -EINVAL ; + goto done; + } in_buf = ec_dev->din; i2c_msg[1 ].len = packet_len; i2c_msg[1 ].buf = (char *) in_buf; packet_len = msg->outsize + request_header_size; -BUG_ON (packet_len > ec_dev->dout_size); +if (packet_len > ec_dev->dout_size) { + ret = -EINVAL ; + goto done; + } out_buf = ec_dev->dout; i2c_msg[0 ].len = packet_len; i2c_msg[0 ].buf = (char *) out_buf;
Signature · 1 line
2.36.0.550.gb090851708-goog
Tzung-Bi Shih
maintainerPATCH v2 6/7 platform/chrome: cros_ec_spi: drop unneeded BUG_ON()
In reply to Tzung-Bi ShihIn 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().
---
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(-)
drivers/platform/chrome/cros_ec_spi.c +0 -2
@@ -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;
Signature · 1 line
2.36.0.550.gb090851708-goog
Re: [PATCH v2 6/7] platform/chrome: cros_ec_spi: drop unneeded BUG_ON()
Quoted 12 lines · Tzung-Bi Shih
In the context, the following conditions are always false:
-
todo< 0
Suppose thatEC_SPI_FRAME_STARTis found at the last byte of transfer.In the case,
ptr==end- 1. As a result,todomust be 0.-
todo>ec_dev->din_size
Suppose that there is no preamble bytes.EC_SPI_FRAME_STARTis found at the first byte of transfer.
Quoted 8 lines
In the case,
end==ptr+EC_MSG_PREAMBLE_COUNT.
As a result,todo==EC_MSG_PREAMBLE_COUNT- 1.
However, it already checkedec_dev->din_size<EC_MSG_PREAMBLE_COUNTat the beginning of function.Drop the unneeded
BUG_ON().Signed-off-by Tzung-Bi Shih <[email protected]>
Quoted 31 lines
---
Changes from v1:
- Separate from the original 6th patch.
- Drop theBUG_ON()instead of returning-EINVAL.drivers/platform/chrome/cros_ec_spi.c | 2 -- 1 file changed, 2 deletions(-)drivers/platform/chrome/cros_ec_spi.c +0
-3@@ -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
Tzung-Bi Shih
maintainerPATCH v2 7/7 platform/chrome: cros_ec_spi: drop BUG_ON() if `din` isn't large enough
In reply to Tzung-Bi ShihIt is overkill to crash the kernel if the din buffer is going to full or overflow.
Drop the BUG_ON() and return -EINVAL instead.
---
Changes from v1:
- Separate from the original 6th patch.
drivers/platform/chrome/cros_ec_spi.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)
drivers/platform/chrome/cros_ec_spi.c +6 -3
@@ -160,7 +160,8 @@ static int receive_n_bytes(struct cros_ec_device *ec_dev, u8 *buf, int n)struct spi_message msg;int ret; -BUG_ON (buf - ec_dev->din + n > ec_dev->din_size); +if (buf - ec_dev->din + n > ec_dev->din_size) +return -EINVAL ;memset (&trans,0 ,sizeof (trans)); trans.cs_change =1 ;
@@ -197,7 +198,8 @@ static int cros_ec_spi_receive_packet(struct cros_ec_device *ec_dev,unsigned long deadline;int todo; -BUG_ON (ec_dev->din_size <EC_MSG_PREAMBLE_COUNT ); +if (ec_dev->din_size <EC_MSG_PREAMBLE_COUNT ) +return -EINVAL ;/* Receive data until we see the header byte */ deadline = jiffies +msecs_to_jiffies (EC_MSG_DEADLINE_MS );
@@ -304,7 +306,8 @@ static int cros_ec_spi_receive_response(struct cros_ec_device *ec_dev,unsigned long deadline;int todo; -BUG_ON (ec_dev->din_size <EC_MSG_PREAMBLE_COUNT ); +if (ec_dev->din_size <EC_MSG_PREAMBLE_COUNT ) +return -EINVAL ;/* Receive data until we see the header byte */ deadline = jiffies +msecs_to_jiffies (EC_MSG_DEADLINE_MS );
Signature · 1 line
2.36.0.550.gb090851708-goog
Re: [PATCH v2 7/7] platform/chrome: cros_ec_spi: drop BUG_ON() if `din` isn't large enough
Quoted 7 lines · Tzung-Bi Shih
It is overkill to crash the kernel if the
dinbuffer is going to full or overflow.Drop the
BUG_ON()and return-EINVALinstead.Signed-off-by Tzung-Bi Shih <[email protected]>
Quoted 44 lines
---
Changes from v1:
- Separate from the original 6th patch.drivers/platform/chrome/cros_ec_spi.c | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-)drivers/platform/chrome/cros_ec_spi.c +6
-4@@ -160,7 +160,8 @@ static int receive_n_bytes(struct cros_ec_device *ec_dev, u8 *buf, int n)struct spi_message msg;int ret; -BUG_ON (buf - ec_dev->din + n > ec_dev->din_size); +if (buf - ec_dev->din + n > ec_dev->din_size) +return -EINVAL ;memset (&trans,0 ,sizeof (trans)); trans.cs_change =1 ;@@ -197,7 +198,8 @@ static int cros_ec_spi_receive_packet(struct cros_ec_device *ec_dev,unsigned long deadline;int todo; -BUG_ON (ec_dev->din_size <EC_MSG_PREAMBLE_COUNT ); +if (ec_dev->din_size <EC_MSG_PREAMBLE_COUNT ) +return -EINVAL ;/* Receive data until we see the header byte */ deadline = jiffies +msecs_to_jiffies (EC_MSG_DEADLINE_MS );@@ -304,7 +306,8 @@ static int cros_ec_spi_receive_response(struct cros_ec_device *ec_dev,unsigned long deadline;int todo; -BUG_ON (ec_dev->din_size <EC_MSG_PREAMBLE_COUNT ); +if (ec_dev->din_size <EC_MSG_PREAMBLE_COUNT ) +return -EINVAL ;/* Receive data until we see the header byte */ deadline = jiffies +msecs_to_jiffies (EC_MSG_DEADLINE_MS ); --2.36.0.550.gb090851708-goog
This series was applied to chrome-platform/linux.git (for-kernelci) by Tzung-Bi Shih <[email protected]>:
Hello:
This series was applied to chrome-platform/linux.git (for-kernelci) by Tzung-Bi Shih <[email protected]>:
Quoted 9 lines · 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!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html
This series was applied to chrome-platform/linux.git (for-next) by Tzung-Bi Shih <[email protected]>:
Hello:
This series was applied to chrome-platform/linux.git (for-next) by Tzung-Bi Shih <[email protected]>:
Quoted 9 lines · 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!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html