| Message ID | 1560748152-6575-1-git-send-email-bbiswas@nvidia.com |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [V7] i2c: tegra: remove BUG, BUG_ON | expand |
17.06.2019 8:09, Bitan Biswas пишет: > Remove BUG, BUG_ON as it makes system usable: > - Remove redundant BUG_ON calls or replace with WARN_ON_ONCE > as needed. > - Remove BUG() and mask Rx interrupt similar as Tx > for message fully sent case. > - Add caller error handling and WARN_ON_ONCE check for non-zero > rx_fifo_avail in tegra_i2c_empty_rx_fifo() after all processing. The commit message should describe motivation of the change and not the change itself, unless it's some additional information which is required for better understanding of the code. In yours case it could be something like that: The usage of BUG() macro is generally discouraged in kernel, unless it's a problem that results in a physical damage or loss of data. This patch removes unnecessary BUG() macros and replaces the rest with a warnings. > Signed-off-by: Bitan Biswas <bbiswas@nvidia.com> > --- > drivers/i2c/busses/i2c-tegra.c | 45 ++++++++++++++++++++++++++++++++++-------- > 1 file changed, 37 insertions(+), 8 deletions(-) > > diff --git a/drivers/i2c/busses/i2c-tegra.c b/drivers/i2c/busses/i2c-tegra.c > index 4dfb4c1..b155b61 100644 > --- a/drivers/i2c/busses/i2c-tegra.c > +++ b/drivers/i2c/busses/i2c-tegra.c > @@ -73,6 +73,7 @@ > #define I2C_ERR_NO_ACK BIT(0) > #define I2C_ERR_ARBITRATION_LOST BIT(1) > #define I2C_ERR_UNKNOWN_INTERRUPT BIT(2) > +#define I2C_ERR_RX_BUFFER_OVERFLOW BIT(3) > > #define PACKET_HEADER0_HEADER_SIZE_SHIFT 28 > #define PACKET_HEADER0_PACKET_ID_SHIFT 16 > @@ -515,7 +516,11 @@ static int tegra_i2c_empty_rx_fifo(struct tegra_i2c_dev *i2c_dev) > * prevent overwriting past the end of buf > */ > if (rx_fifo_avail > 0 && buf_remaining > 0) { > - BUG_ON(buf_remaining > 3); > + /* > + * buf_remaining > 3 check not needed as rx_fifo_avail == 0 > + * when (words_to_transfer was > rx_fifo_avail) earlier > + * in this function. > + */ > val = i2c_readl(i2c_dev, I2C_RX_FIFO); > val = cpu_to_le32(val); > memcpy(buf, &val, buf_remaining); > @@ -523,7 +528,15 @@ static int tegra_i2c_empty_rx_fifo(struct tegra_i2c_dev *i2c_dev) > rx_fifo_avail--; > } > > - BUG_ON(rx_fifo_avail > 0 && buf_remaining > 0); > + if ((!(i2c_dev->msg_buf_remaining)) && The RX FIFO shall be drained completely no matter what. Hence why the "i2c_dev->msg_buf_remaining" checking is needed here? Secondly, in the future please don't add parens where they are not needed. In this case parens around !i2c_dev->msg_buf_remaining are not needed at all. > + WARN_ON_ONCE(rx_fifo_avail)) > + return -EINVAL; > + > + /* > + * buf_remaining > 0 at this point can only have rx_fifo_avail == 0 The rx_fifo_avail is always 0 at this point, including the case of buf_remaining == 0. It will be better if you'll add a comment for the WARN_ON_ONCE(rx_fifo_avail) above, saying that RX FIFO must be fully drained, and then just drop this comment. > + * as this corresponds to (words_to_transfer was > rx_fifo_avail) > + * case earlier in this function. > + */ > i2c_dev->msg_buf_remaining = buf_remaining; > i2c_dev->msg_buf = buf; [snip]
On 6/17/19 5:13 AM, Dmitry Osipenko wrote: > 17.06.2019 8:09, Bitan Biswas пишет: >> Remove BUG, BUG_ON as it makes system usable: >> - Remove redundant BUG_ON calls or replace with WARN_ON_ONCE >> as needed. >> - Remove BUG() and mask Rx interrupt similar as Tx >> for message fully sent case. >> - Add caller error handling and WARN_ON_ONCE check for non-zero >> rx_fifo_avail in tegra_i2c_empty_rx_fifo() after all processing. > > The commit message should describe motivation of the change and not the change itself, > unless it's some additional information which is required for better understanding of > the code. > > In yours case it could be something like that: > > The usage of BUG() macro is generally discouraged in kernel, unless > it's a problem that results in a physical damage or loss of data. > This patch removes unnecessary BUG() macros and replaces the rest > with a warnings. I shall update as per above comments. > >> Signed-off-by: Bitan Biswas <bbiswas@nvidia.com> >> --- >> drivers/i2c/busses/i2c-tegra.c | 45 ++++++++++++++++++++++++++++++++++-------- >> 1 file changed, 37 insertions(+), 8 deletions(-) >> >> diff --git a/drivers/i2c/busses/i2c-tegra.c b/drivers/i2c/busses/i2c-tegra.c >> index 4dfb4c1..b155b61 100644 >> --- a/drivers/i2c/busses/i2c-tegra.c >> +++ b/drivers/i2c/busses/i2c-tegra.c >> @@ -73,6 +73,7 @@ >> #define I2C_ERR_NO_ACK BIT(0) >> #define I2C_ERR_ARBITRATION_LOST BIT(1) >> #define I2C_ERR_UNKNOWN_INTERRUPT BIT(2) >> +#define I2C_ERR_RX_BUFFER_OVERFLOW BIT(3) >> >> #define PACKET_HEADER0_HEADER_SIZE_SHIFT 28 >> #define PACKET_HEADER0_PACKET_ID_SHIFT 16 >> @@ -515,7 +516,11 @@ static int tegra_i2c_empty_rx_fifo(struct tegra_i2c_dev *i2c_dev) >> * prevent overwriting past the end of buf >> */ >> if (rx_fifo_avail > 0 && buf_remaining > 0) { >> - BUG_ON(buf_remaining > 3); >> + /* >> + * buf_remaining > 3 check not needed as rx_fifo_avail == 0 >> + * when (words_to_transfer was > rx_fifo_avail) earlier >> + * in this function. >> + */ >> val = i2c_readl(i2c_dev, I2C_RX_FIFO); >> val = cpu_to_le32(val); >> memcpy(buf, &val, buf_remaining); >> @@ -523,7 +528,15 @@ static int tegra_i2c_empty_rx_fifo(struct tegra_i2c_dev *i2c_dev) >> rx_fifo_avail--; >> } >> >> - BUG_ON(rx_fifo_avail > 0 && buf_remaining > 0); >> + if ((!(i2c_dev->msg_buf_remaining)) && > > The RX FIFO shall be drained completely no matter what. > > Hence why the "i2c_dev->msg_buf_remaining" checking is needed here? I moved the part of below condition in Patch V6 to function tegra_i2c_empty_rx_fifo: >> + err_val = tegra_i2c_empty_rx_fifo(i2c_dev); >> + if ((!(i2c_dev->msg_buf_remaining)) && > Let's move this check into tegra_i2c_empty_rx_fifo() and return -EINVAL for that case. > This will make code to look cleaner. Is above condition not needed? > > Secondly, in the future please don't add parens where they are not needed. In this > case parens around !i2c_dev->msg_buf_remaining are not needed at all. > I shall look out for similar unnecessary parentheses and update the patch. >> + WARN_ON_ONCE(rx_fifo_avail)) >> + return -EINVAL; >> + >> + /* >> + * buf_remaining > 0 at this point can only have rx_fifo_avail == 0 > > The rx_fifo_avail is always 0 at this point, including the case of buf_remaining == 0. > It will be better if you'll add a comment for the WARN_ON_ONCE(rx_fifo_avail) above, > saying that RX FIFO must be fully drained, and then just drop this comment. > OK. >> + * as this corresponds to (words_to_transfer was > rx_fifo_avail) >> + * case earlier in this function. >> + */ >> i2c_dev->msg_buf_remaining = buf_remaining; >> i2c_dev->msg_buf = buf; > > [snip] >
17.06.2019 21:41, Bitan Biswas пишет: > > > On 6/17/19 5:13 AM, Dmitry Osipenko wrote: >> 17.06.2019 8:09, Bitan Biswas пишет: >>> Remove BUG, BUG_ON as it makes system usable: >>> - Remove redundant BUG_ON calls or replace with WARN_ON_ONCE >>> as needed. >>> - Remove BUG() and mask Rx interrupt similar as Tx >>> for message fully sent case. >>> - Add caller error handling and WARN_ON_ONCE check for non-zero >>> rx_fifo_avail in tegra_i2c_empty_rx_fifo() after all processing. >> >> The commit message should describe motivation of the change and not the change itself, >> unless it's some additional information which is required for better understanding of >> the code. >> >> In yours case it could be something like that: >> >> The usage of BUG() macro is generally discouraged in kernel, unless >> it's a problem that results in a physical damage or loss of data. >> This patch removes unnecessary BUG() macros and replaces the rest >> with a warnings. > I shall update as per above comments. > >> >>> Signed-off-by: Bitan Biswas <bbiswas@nvidia.com> >>> --- >>> drivers/i2c/busses/i2c-tegra.c | 45 ++++++++++++++++++++++++++++++++++-------- >>> 1 file changed, 37 insertions(+), 8 deletions(-) >>> >>> diff --git a/drivers/i2c/busses/i2c-tegra.c b/drivers/i2c/busses/i2c-tegra.c >>> index 4dfb4c1..b155b61 100644 >>> --- a/drivers/i2c/busses/i2c-tegra.c >>> +++ b/drivers/i2c/busses/i2c-tegra.c >>> @@ -73,6 +73,7 @@ >>> #define I2C_ERR_NO_ACK BIT(0) >>> #define I2C_ERR_ARBITRATION_LOST BIT(1) >>> #define I2C_ERR_UNKNOWN_INTERRUPT BIT(2) >>> +#define I2C_ERR_RX_BUFFER_OVERFLOW BIT(3) >>> #define PACKET_HEADER0_HEADER_SIZE_SHIFT 28 >>> #define PACKET_HEADER0_PACKET_ID_SHIFT 16 >>> @@ -515,7 +516,11 @@ static int tegra_i2c_empty_rx_fifo(struct tegra_i2c_dev *i2c_dev) >>> * prevent overwriting past the end of buf >>> */ >>> if (rx_fifo_avail > 0 && buf_remaining > 0) { >>> - BUG_ON(buf_remaining > 3); >>> + /* >>> + * buf_remaining > 3 check not needed as rx_fifo_avail == 0 >>> + * when (words_to_transfer was > rx_fifo_avail) earlier >>> + * in this function. >>> + */ >>> val = i2c_readl(i2c_dev, I2C_RX_FIFO); >>> val = cpu_to_le32(val); >>> memcpy(buf, &val, buf_remaining); >>> @@ -523,7 +528,15 @@ static int tegra_i2c_empty_rx_fifo(struct tegra_i2c_dev *i2c_dev) >>> rx_fifo_avail--; >>> } >>> - BUG_ON(rx_fifo_avail > 0 && buf_remaining > 0); >>> + if ((!(i2c_dev->msg_buf_remaining)) && >> >> The RX FIFO shall be drained completely no matter what. >> >> Hence why the "i2c_dev->msg_buf_remaining" checking is needed here? > I moved the part of below condition in Patch V6 to function tegra_i2c_empty_rx_fifo: > >>> + err_val = tegra_i2c_empty_rx_fifo(i2c_dev); >>> + if ((!(i2c_dev->msg_buf_remaining)) && > >> Let's move this check into tegra_i2c_empty_rx_fifo() and return -EINVAL for that case. >> This will make code to look cleaner. > > Is above condition not needed? Let's put it at the very beginning. This may give a bit more information about the problem by knowing if the offending overflow happens after or during of the buffer's fill up. static int tegra_i2c_empty_rx_fifo(struct tegra_i2c_dev *i2c_dev) { u32 val; int rx_fifo_avail; u8 *buf = i2c_dev->msg_buf; size_t buf_remaining = i2c_dev->msg_buf_remaining; int words_to_transfer; if (WARN_ON(!i2c_dev->msg_buf_remaining)) return -EINVAL; ... In general, the original logic should be preserved during of refactoring. In this case we are keeping the original check and then also making it a bit more informative. > >> >> Secondly, in the future please don't add parens where they are not needed. In this >> case parens around !i2c_dev->msg_buf_remaining are not needed at all. >> > I shall look out for similar unnecessary parentheses and update the patch. Yes, please clean up all the occurrences in the code if there are any. And please do it in a separate patch.
On 6/17/19 12:28 PM, Dmitry Osipenko wrote: > 17.06.2019 21:41, Bitan Biswas пишет: >> >> >> On 6/17/19 5:13 AM, Dmitry Osipenko wrote: >>> 17.06.2019 8:09, Bitan Biswas пишет: >>>> Remove BUG, BUG_ON as it makes system usable: >>>> - Remove redundant BUG_ON calls or replace with WARN_ON_ONCE >>>> as needed. >>>> - Remove BUG() and mask Rx interrupt similar as Tx >>>> for message fully sent case. >>>> - Add caller error handling and WARN_ON_ONCE check for non-zero >>>> rx_fifo_avail in tegra_i2c_empty_rx_fifo() after all processing. >>> >>> The commit message should describe motivation of the change and not the change itself, >>> unless it's some additional information which is required for better understanding of >>> the code. >>> >>> In yours case it could be something like that: >>> >>> The usage of BUG() macro is generally discouraged in kernel, unless >>> it's a problem that results in a physical damage or loss of data. >>> This patch removes unnecessary BUG() macros and replaces the rest >>> with a warnings. >> I shall update as per above comments. >> >>> >>>> Signed-off-by: Bitan Biswas <bbiswas@nvidia.com> >>>> --- >>>> drivers/i2c/busses/i2c-tegra.c | 45 ++++++++++++++++++++++++++++++++++-------- >>>> 1 file changed, 37 insertions(+), 8 deletions(-) >>>> >>>> diff --git a/drivers/i2c/busses/i2c-tegra.c b/drivers/i2c/busses/i2c-tegra.c >>>> index 4dfb4c1..b155b61 100644 >>>> --- a/drivers/i2c/busses/i2c-tegra.c >>>> +++ b/drivers/i2c/busses/i2c-tegra.c >>>> @@ -73,6 +73,7 @@ >>>> #define I2C_ERR_NO_ACK BIT(0) >>>> #define I2C_ERR_ARBITRATION_LOST BIT(1) >>>> #define I2C_ERR_UNKNOWN_INTERRUPT BIT(2) >>>> +#define I2C_ERR_RX_BUFFER_OVERFLOW BIT(3) >>>> #define PACKET_HEADER0_HEADER_SIZE_SHIFT 28 >>>> #define PACKET_HEADER0_PACKET_ID_SHIFT 16 >>>> @@ -515,7 +516,11 @@ static int tegra_i2c_empty_rx_fifo(struct tegra_i2c_dev *i2c_dev) >>>> * prevent overwriting past the end of buf >>>> */ >>>> if (rx_fifo_avail > 0 && buf_remaining > 0) { >>>> - BUG_ON(buf_remaining > 3); >>>> + /* >>>> + * buf_remaining > 3 check not needed as rx_fifo_avail == 0 >>>> + * when (words_to_transfer was > rx_fifo_avail) earlier >>>> + * in this function. >>>> + */ >>>> val = i2c_readl(i2c_dev, I2C_RX_FIFO); >>>> val = cpu_to_le32(val); >>>> memcpy(buf, &val, buf_remaining); >>>> @@ -523,7 +528,15 @@ static int tegra_i2c_empty_rx_fifo(struct tegra_i2c_dev *i2c_dev) >>>> rx_fifo_avail--; >>>> } >>>> - BUG_ON(rx_fifo_avail > 0 && buf_remaining > 0); >>>> + if ((!(i2c_dev->msg_buf_remaining)) && >>> >>> The RX FIFO shall be drained completely no matter what. >>> >>> Hence why the "i2c_dev->msg_buf_remaining" checking is needed here? >> I moved the part of below condition in Patch V6 to function tegra_i2c_empty_rx_fifo: >> >>>> + err_val = tegra_i2c_empty_rx_fifo(i2c_dev); >>>> + if ((!(i2c_dev->msg_buf_remaining)) && >> >>> Let's move this check into tegra_i2c_empty_rx_fifo() and return -EINVAL for that case. >>> This will make code to look cleaner. >> >> Is above condition not needed? > > Let's put it at the very beginning. This may give a bit more information about the > problem by knowing if the offending overflow happens after or during of the buffer's > fill up. > > static int tegra_i2c_empty_rx_fifo(struct tegra_i2c_dev *i2c_dev) > { > u32 val; > int rx_fifo_avail; > u8 *buf = i2c_dev->msg_buf; > size_t buf_remaining = i2c_dev->msg_buf_remaining; > int words_to_transfer; > > if (WARN_ON(!i2c_dev->msg_buf_remaining)) > return -EINVAL; > ... > OK > In general, the original logic should be preserved during of refactoring. In this case > we are keeping the original check and then also making it a bit more informative. > I feel the msg_buf_remaining check was not there in original code. The corresponding line was probably the following checking for error when (buf_remaining > 0) after all work in the function tegra_i2c_empty_rx_fifo() https://elixir.bootlin.com/linux/v5.2-rc5/source/drivers/i2c/busses/i2c-tegra.c#L536 >> >>> >>> Secondly, in the future please don't add parens where they are not needed. In this >>> case parens around !i2c_dev->msg_buf_remaining are not needed at all. >>> >> I shall look out for similar unnecessary parentheses and update the patch. > > Yes, please clean up all the occurrences in the code if there are any. And please do > it in a separate patch. > I reviewed the source for unnecessary parentheses and do not find any. Hence not planning to push any patch. Let me know if I missed a case. -Thanks, Bitan
diff --git a/drivers/i2c/busses/i2c-tegra.c b/drivers/i2c/busses/i2c-tegra.c index 4dfb4c1..b155b61 100644 --- a/drivers/i2c/busses/i2c-tegra.c +++ b/drivers/i2c/busses/i2c-tegra.c @@ -73,6 +73,7 @@ #define I2C_ERR_NO_ACK BIT(0) #define I2C_ERR_ARBITRATION_LOST BIT(1) #define I2C_ERR_UNKNOWN_INTERRUPT BIT(2) +#define I2C_ERR_RX_BUFFER_OVERFLOW BIT(3) #define PACKET_HEADER0_HEADER_SIZE_SHIFT 28 #define PACKET_HEADER0_PACKET_ID_SHIFT 16 @@ -515,7 +516,11 @@ static int tegra_i2c_empty_rx_fifo(struct tegra_i2c_dev *i2c_dev) * prevent overwriting past the end of buf */ if (rx_fifo_avail > 0 && buf_remaining > 0) { - BUG_ON(buf_remaining > 3); + /* + * buf_remaining > 3 check not needed as rx_fifo_avail == 0 + * when (words_to_transfer was > rx_fifo_avail) earlier + * in this function. + */ val = i2c_readl(i2c_dev, I2C_RX_FIFO); val = cpu_to_le32(val); memcpy(buf, &val, buf_remaining); @@ -523,7 +528,15 @@ static int tegra_i2c_empty_rx_fifo(struct tegra_i2c_dev *i2c_dev) rx_fifo_avail--; } - BUG_ON(rx_fifo_avail > 0 && buf_remaining > 0); + if ((!(i2c_dev->msg_buf_remaining)) && + WARN_ON_ONCE(rx_fifo_avail)) + return -EINVAL; + + /* + * buf_remaining > 0 at this point can only have rx_fifo_avail == 0 + * as this corresponds to (words_to_transfer was > rx_fifo_avail) + * case earlier in this function. + */ i2c_dev->msg_buf_remaining = buf_remaining; i2c_dev->msg_buf = buf; @@ -581,7 +594,11 @@ static int tegra_i2c_fill_tx_fifo(struct tegra_i2c_dev *i2c_dev) * boundary and fault. */ if (tx_fifo_avail > 0 && buf_remaining > 0) { - BUG_ON(buf_remaining > 3); + /* + * buf_remaining > 3 check not needed as tx_fifo_avail == 0 + * when (words_to_transfer was > tx_fifo_avail) earlier + * in this function for non-zero words_to_transfer. + */ memcpy(&val, buf, buf_remaining); val = le32_to_cpu(val); @@ -847,10 +864,15 @@ static irqreturn_t tegra_i2c_isr(int irq, void *dev_id) if (!i2c_dev->is_curr_dma_xfer) { if (i2c_dev->msg_read && (status & I2C_INT_RX_FIFO_DATA_REQ)) { - if (i2c_dev->msg_buf_remaining) - tegra_i2c_empty_rx_fifo(i2c_dev); - else - BUG(); + if (tegra_i2c_empty_rx_fifo(i2c_dev)) { + /* + * Overflow error condition: message fully sent, + * with no XFER_COMPLETE interrupt but hardware + * asks to transfer more. + */ + i2c_dev->msg_err |= I2C_ERR_RX_BUFFER_OVERFLOW; + goto err; + } } if (!i2c_dev->msg_read && (status & I2C_INT_TX_FIFO_DATA_REQ)) { @@ -876,7 +898,14 @@ static irqreturn_t tegra_i2c_isr(int irq, void *dev_id) if (status & I2C_INT_PACKET_XFER_COMPLETE) { if (i2c_dev->is_curr_dma_xfer) i2c_dev->msg_buf_remaining = 0; - BUG_ON(i2c_dev->msg_buf_remaining); + /* + * Underflow error condition: XFER_COMPLETE before message + * fully sent. + */ + if (WARN_ON_ONCE(i2c_dev->msg_buf_remaining)) { + i2c_dev->msg_err |= I2C_ERR_UNKNOWN_INTERRUPT; + goto err; + } complete(&i2c_dev->msg_complete); } goto done;
Remove BUG, BUG_ON as it makes system usable: - Remove redundant BUG_ON calls or replace with WARN_ON_ONCE as needed. - Remove BUG() and mask Rx interrupt similar as Tx for message fully sent case. - Add caller error handling and WARN_ON_ONCE check for non-zero rx_fifo_avail in tegra_i2c_empty_rx_fifo() after all processing. Signed-off-by: Bitan Biswas <bbiswas@nvidia.com> --- drivers/i2c/busses/i2c-tegra.c | 45 ++++++++++++++++++++++++++++++++++-------- 1 file changed, 37 insertions(+), 8 deletions(-)