| Message ID | 20220225102602.3829106-1-anssi.hannula@bitwise.fi (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 3105bc977d7cbf2edc35e24cc7e009686f6e4a56 |
| Headers | show |
| Series | [1/2,v2] xhci: fix garbage USBSTS being logged in some cases | expand |
On 25.2.2022 12.26, Anssi Hannula wrote: > xhci_decode_usbsts() is expected to return a zero-terminated string by > its only caller, xhci_stop_endpoint_command_watchdog(), which directly > logs the return value: > > xhci_warn(xhci, "USBSTS:%s\n", xhci_decode_usbsts(str, usbsts)); > > However, if no recognized bits are set in usbsts, the function will > return without having called any sprintf() and therefore return an > untouched non-zero-terminated caller-provided buffer, causing garbage > to be output to log. > > Fix that by always including the raw value in the output. > > Note that before 4843b4b5ec64 ("xhci: fix even more unsafe memory usage > in xhci tracing") the result effect in the failure case was different as > a static buffer was used here, but the code still worked incorrectly. > > Fixes: 9c1aa36efdae ("xhci: Show host status when watchdog triggers and host is assumed dead.") > Signed-off-by: Anssi Hannula <anssi.hannula@bitwise.fi> > --- Thanks. Adding both 1/2 v2 and 2/2 -Mathias
diff --git a/drivers/usb/host/xhci.h b/drivers/usb/host/xhci.h index 8a0026ee9524..dd24c09927bd 100644 --- a/drivers/usb/host/xhci.h +++ b/drivers/usb/host/xhci.h @@ -2622,8 +2622,11 @@ static inline const char *xhci_decode_usbsts(char *str, u32 usbsts) { int ret = 0; + ret = sprintf(str, " 0x%08x", usbsts); + if (usbsts == ~(u32)0) - return " 0xffffffff"; + return str; + if (usbsts & STS_HALT) ret += sprintf(str + ret, " HCHalted"); if (usbsts & STS_FATAL)
xhci_decode_usbsts() is expected to return a zero-terminated string by its only caller, xhci_stop_endpoint_command_watchdog(), which directly logs the return value: xhci_warn(xhci, "USBSTS:%s\n", xhci_decode_usbsts(str, usbsts)); However, if no recognized bits are set in usbsts, the function will return without having called any sprintf() and therefore return an untouched non-zero-terminated caller-provided buffer, causing garbage to be output to log. Fix that by always including the raw value in the output. Note that before 4843b4b5ec64 ("xhci: fix even more unsafe memory usage in xhci tracing") the result effect in the failure case was different as a static buffer was used here, but the code still worked incorrectly. Fixes: 9c1aa36efdae ("xhci: Show host status when watchdog triggers and host is assumed dead.") Signed-off-by: Anssi Hannula <anssi.hannula@bitwise.fi> --- Mathias Nyman wrote: > Maybe this could be the first thing printed out, something like (untested): [...] Heh, that's actually pretty close to what I had at one point, not sure why I didn't go with it. I agree it looks better. Changed and tested on real HW: [ 11.998832] xhci-hcd xhci-hcd.1.auto: xHCI host not responding to stop endpoint command. [ 12.006925] xhci-hcd xhci-hcd.1.auto: USBSTS: 0x00000000 v2: Improve print format on Mathias Nyman's suggestion. drivers/usb/host/xhci.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)