drivers: serial: Make sure we really return a serial device
PATCH v2 1/1 drivers: serial: Make sure we really return a serial device
The stdout-path property in the device tree does not necessarily point at a serial device. On machines such as the Apple M1 laptops where the serial port isn't easy to access and users expect to see console output on the integrated display stdout-path may point at the device tree node for the framebuffer for example.
If stdout-path does not point at a node for a serial device, the serial_check_stdout() will not find a bound device and will drop down into code that attempts to use lists_bind_fdt() to bind a device anyway. However, that fallback code does not check that the uclass of the device is UCLASS_SERIAL. So if stdout-path points at the framebuffer instead of the serial device it will return a UCLASS_VIDEO device. Since the code that calls this function expects the returned device to be a UCLASS_SERIAL device, U-Boot will crash as soon as it attempts to send output to the console.
Add a check here to verify that the uclass of the bound device really is UCLASS_SERIAL. If it isn't, serial_check_stdout() will return an error and serial_find_console_or_panic() will use the serial device with sequence number 0 as the console and all is fine.
---
ChangeLog:
v2: - Expand commit message
drivers/serial/serial-uclass.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
drivers/serial/serial-uclass.c +2 -1
@@ -66,7 +66,8 @@ static int serial_check_stdout(const void *blob, struct udevice **devp)*/ if (node >0 && !lists_bind_fdt (gd->dm_root,offset_to_ofnode (node), devp,NULL , false)) { -if (!device_probe (*devp)) +if (device_get_uclass_id (*devp) ==UCLASS_SERIAL && + !device_probe (*devp))return 0 ; }
Signature · 1 line
2.35.1
Quoted 25 lines · Mark Kettenis
The stdout-path property in the device tree does not necessarily point at a serial device. On machines such as the Apple M1 laptops where the serial port isn't easy to access and users expect to see console output on the integrated display stdout-path may point at the device tree node for the framebuffer for example.
If stdout-path does not point at a node for a serial device, the
serial_check_stdout()will not find a bound device and will drop down into code that attempts to uselists_bind_fdt()to bind a device anyway. However, that fallback code does not check that the uclass of the device isUCLASS_SERIAL. So if stdout-path points at the framebuffer instead of the serial device it will return aUCLASS_VIDEOdevice. Since the code that calls this function expects the returned device to be aUCLASS_SERIALdevice, U-Boot will crash as soon as it attempts to send output to the console.Add a check here to verify that the uclass of the bound device really is
UCLASS_SERIAL. If it isn't,serial_check_stdout()will return an error andserial_find_console_or_panic()will use the serial device with sequence number 0 as the console and all is fine.Signed-off-by Mark Kettenis <[email protected]>---
Quoted 8 lines
ChangeLog:
v2: - Expand commit message
drivers/serial/serial-uclass.c | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-)
Quoted 16 lines · Mark Kettenis
The stdout-path property in the device tree does not necessarily point at a serial device. On machines such as the Apple M1 laptops where the serial port isn't easy to access and users expect to see console output on the integrated display stdout-path may point at the device tree node for the framebuffer for example.
If stdout-path does not point at a node for a serial device, the
serial_check_stdout()will not find a bound device and will drop down into code that attempts to uselists_bind_fdt()to bind a device anyway. However, that fallback code does not check that the uclass of the device isUCLASS_SERIAL. So if stdout-path points at the framebuffer instead of the serial device it will return aUCLASS_VIDEOdevice. Since the code that calls this function expects the returned device to be aUCLASS_SERIALdevice, U-Boot will crash as soon as it attempts to send output to the console.
Quoted 7 lines
Add a check here to verify that the uclass of the bound device really is
UCLASS_SERIAL. If it isn't,serial_check_stdout()will return an error andserial_find_console_or_panic()will use the serial device with sequence number 0 as the console and all is fine.Signed-off-by Mark Kettenis <[email protected]>Reviewed-by Simon Glass <[email protected]>
Applied to u-boot/master, thanks!
Signature · 1 line
Tom