From: Simon Glass <sjg@chromium.org> Add a way to set up a membuf with some pre-loaded data, so it is possible to read it out using membuf_readline(), etc. Signed-off-by: Simon Glass <sjg@chromium.org> --- include/membuf.h | 17 ++++++++++++++++- lib/membuf.c | 8 ++++++++ test/lib/membuf.c | 19 +++++++++++++++++++ 3 files changed, 43 insertions(+), 1 deletion(-) diff --git a/include/membuf.h b/include/membuf.h index b495a72652b..3352faa0606 100644 --- a/include/membuf.h +++ b/include/membuf.h @@ -222,7 +222,9 @@ int membuf_readline(struct membuf *mb, char *str, int maxlen, int minch, int membuf_extend_by(struct membuf *mb, int by, int max); /** - * membuf_init() - set up a new membuff using an existing membuff + * membuf_init() - set up a new membuff using an existing buffer + * + * The buffer is initially empty * * @mb: membuff to set up * @buff: Address of buffer @@ -230,6 +232,19 @@ int membuf_extend_by(struct membuf *mb, int by, int max); */ void membuf_init(struct membuf *mb, char *buff, int size); +/** + * membuf_init_with_data() - set up a new membuff using existing data + * + * The buffer is set up to contain the provided data. with its size set to + * @size + 1 (less MEMBUF_FULL), so that there is enough space for the head/tail + * differece. + * + * @mb: membuff to set up + * @buff: Address of buffer + * @size: Number of bytes to put into the membuf + */ +void membuf_init_with_data(struct membuf *mb, char *buff, int size); + /** * membuf_uninit() - clear a membuff so it can no longer be used * diff --git a/lib/membuf.c b/lib/membuf.c index 016430ae988..47a1b06664a 100644 --- a/lib/membuf.c +++ b/lib/membuf.c @@ -405,6 +405,14 @@ void membuf_init(struct membuf *mb, char *buff, int size) membuf_purge(mb); } +void membuf_init_with_data(struct membuf *mb, char *buff, int size) +{ + char *data; + + membuf_init(mb, buff, size + !MEMBUF_FULL); + membuf_putraw(mb, size, true, &data); +} + int membuf_new(struct membuf *mb, int size) { mb->start = malloc(size); diff --git a/test/lib/membuf.c b/test/lib/membuf.c index f36332ff7b6..2e7de9cdc57 100644 --- a/test/lib/membuf.c +++ b/test/lib/membuf.c @@ -242,3 +242,22 @@ static int lib_test_membuf_readline(struct unit_test_state *uts) return 0; } LIB_TEST(lib_test_membuf_readline, 0); + +/* test membuf_readline() with generated data */ +static int lib_test_membuf_init(struct unit_test_state *uts) +{ + struct membuf mb; + char buf[10], out[10]; + int len; + + strcpy(buf, "hello"); + len = strlen(buf); + membuf_init_with_data(&mb, buf, len); + ut_asserteq_ptr(buf, mb.start); + ut_asserteq(len, membuf_avail(&mb)); + ut_asserteq(len, membuf_readline(&mb, out, sizeof(out), 0, false)); + ut_asserteq_str("hello", out); + + return 0; +} +LIB_TEST(lib_test_membuf_init, 0); -- 2.43.0

From: Simon Glass <sjg@chromium.org> The functions which create images lack a newline at the end of the file. Add one, for consistency. Signed-off-by: Simon Glass <sjg@chromium.org> --- test/py/img/android.py | 2 +- test/py/img/armbian.py | 2 +- test/py/img/cedit.py | 2 +- test/py/img/chromeos.py | 2 +- test/py/img/common.py | 2 +- test/py/img/efi.py | 2 +- test/py/img/fedora.py | 2 +- test/py/img/localboot.py | 2 +- test/py/img/ubuntu.py | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/test/py/img/android.py b/test/py/img/android.py index 44d15fe35a7..a703a68f790 100644 --- a/test/py/img/android.py +++ b/test/py/img/android.py @@ -143,4 +143,4 @@ def setup_android_image(config, log): print(f'wrote to {fname}') - return fname \ No newline at end of file + return fname diff --git a/test/py/img/armbian.py b/test/py/img/armbian.py index 4db40fd5070..e1ae9b0aae9 100644 --- a/test/py/img/armbian.py +++ b/test/py/img/armbian.py @@ -129,4 +129,4 @@ booti ${kernel_addr_r} ${ramdisk_addr_r} ${fdt_addr_r} img = DiskHelper(config, mmc_dev, 'mmc', True) img.add_fs(fsh, DiskHelper.EXT4) img.create() - fsh.cleanup() \ No newline at end of file + fsh.cleanup() diff --git a/test/py/img/cedit.py b/test/py/img/cedit.py index dd6c5de44bb..564cb985dc1 100644 --- a/test/py/img/cedit.py +++ b/test/py/img/cedit.py @@ -22,4 +22,4 @@ def setup_cedit_file(config, log): expo_tool = os.path.join(config.source_dir, 'tools/expo.py') outfname = 'cedit.dtb' utils.run_and_log_no_ubman( - log, f'{expo_tool} -e {inhname} -l {infname} -o {outfname}') \ No newline at end of file + log, f'{expo_tool} -e {inhname} -l {infname} -o {outfname}') diff --git a/test/py/img/chromeos.py b/test/py/img/chromeos.py index 6217b5310f1..24884402c92 100644 --- a/test/py/img/chromeos.py +++ b/test/py/img/chromeos.py @@ -151,4 +151,4 @@ def setup_cros_image(config, log): with open(fname, 'wb') as outf: outf.write(disk_data) - return fname \ No newline at end of file + return fname diff --git a/test/py/img/common.py b/test/py/img/common.py index 80f9c124fc8..c9be6a22362 100644 --- a/test/py/img/common.py +++ b/test/py/img/common.py @@ -85,4 +85,4 @@ def setup_extlinux_image(config, log, devnum, basename, vmlinux, initrd, dtbdir, img.add_fs(ext4, DiskHelper.EXT4) img.create() - fsh.cleanup() \ No newline at end of file + fsh.cleanup() diff --git a/test/py/img/efi.py b/test/py/img/efi.py index fbb39c24063..8239b4c247f 100644 --- a/test/py/img/efi.py +++ b/test/py/img/efi.py @@ -34,4 +34,4 @@ def setup_efi_image(config): img = DiskHelper(config, devnum, 'flash', True) img.add_fs(fsh, DiskHelper.VFAT) img.create() - fsh.cleanup() \ No newline at end of file + fsh.cleanup() diff --git a/test/py/img/fedora.py b/test/py/img/fedora.py index ffa546d1cfe..8d3407d065e 100644 --- a/test/py/img/fedora.py +++ b/test/py/img/fedora.py @@ -32,4 +32,4 @@ label Fedora-Workstation-armhfp-31-1.9 (5.3.7-301.fc31.armv7hl) fdtdir /%s/ initrd /%s''' % (vmlinux, dtbdir, initrd) setup_extlinux_image(config, log, devnum, basename, vmlinux, - initrd, dtbdir, script) \ No newline at end of file + initrd, dtbdir, script) diff --git a/test/py/img/localboot.py b/test/py/img/localboot.py index 62a65f33cf0..e83a0cbaa82 100644 --- a/test/py/img/localboot.py +++ b/test/py/img/localboot.py @@ -24,4 +24,4 @@ LABEL local vmlinux = 'vmlinuz' initrd = 'initrd.img' setup_extlinux_image(config, log, mmc_dev, 'mmc', vmlinux, initrd, None, - script) \ No newline at end of file + script) diff --git a/test/py/img/ubuntu.py b/test/py/img/ubuntu.py index 4fe54cb679b..06e8251c05b 100644 --- a/test/py/img/ubuntu.py +++ b/test/py/img/ubuntu.py @@ -44,4 +44,4 @@ label l0r initrd /boot/%s ''' % (vmlinux, initrd, vmlinux, initrd) setup_extlinux_image(config, log, devnum, basename, vmlinux, initrd, dtbdir, - script) \ No newline at end of file + script) -- 2.43.0

From: Simon Glass <sjg@chromium.org> Allow mouse input to be reported from sandbox using SDL. Signed-off-by: Simon Glass <sjg@chromium.org> --- arch/sandbox/cpu/sdl.c | 43 ++++++++++++++++++++++++++++++++++ arch/sandbox/include/asm/sdl.h | 9 +++++++ 2 files changed, 52 insertions(+) diff --git a/arch/sandbox/cpu/sdl.c b/arch/sandbox/cpu/sdl.c index 5a323a607f1..fa431010b11 100644 --- a/arch/sandbox/cpu/sdl.c +++ b/arch/sandbox/cpu/sdl.c @@ -4,6 +4,7 @@ */ #include <errno.h> +#include <mouse.h> #include <unistd.h> #include <stdbool.h> #include <sysreset.h> @@ -67,6 +68,7 @@ static struct sdl_info { SDL_Renderer *renderer; SDL_Window *screen; int src_depth; + struct mouse_event mouse; } sdl; static void sandbox_sdl_poll_events(void) @@ -84,10 +86,50 @@ static void sandbox_sdl_poll_events(void) puts("LCD window closed - quitting\n"); sysreset_walk(SYSRESET_POWER_OFF); break; + case SDL_MOUSEMOTION: { + struct mouse_event *m = &sdl.mouse; + + m->type = MOUSE_EV_MOTION; + m->motion.state = 0; + m->motion.x = event.motion.x; + m->motion.y = event.motion.y; + m->motion.xrel = event.motion.xrel; + m->motion.yrel = event.motion.yrel; + break; + } + case SDL_MOUSEBUTTONDOWN: + case SDL_MOUSEBUTTONUP: { + struct mouse_event *m = &sdl.mouse; + + m->type = MOUSE_EV_BUTTON; + if (event.button.button == SDL_BUTTON_LEFT) + m->button.button = BUTTON_LEFT; + else if (event.button.button == SDL_BUTTON_MIDDLE) + m->button.button = BUTTON_MIDDLE; + else if (event.button.button == SDL_BUTTON_RIGHT) + m->button.button = BUTTON_RIGHT; + m->button.press_state = event.type == + SDL_MOUSEBUTTONDOWN ? + BUTTON_PRESSED : BUTTON_RELEASED; + m->button.x = event.button.x; + m->button.y = event.motion.y; + break; + } } } } +int sandbox_sdl_get_mouse_event(struct mouse_event *evt) +{ + if (sdl.mouse.type == MOUSE_EV_NULL) + return -EAGAIN; + + *evt = sdl.mouse; + sdl.mouse.type = MOUSE_EV_NULL; + + return 0; +} + static int sandbox_sdl_ensure_init(void) { if (!sdl.inited) { @@ -522,6 +564,7 @@ int sandbox_sdl_sound_init(int rate, int channels) sdl.sample_rate = wanted.freq; sdl.cur_buf = 0; sdl.running = false; + sdl.mouse.type = MOUSE_EV_NULL; return 0; diff --git a/arch/sandbox/include/asm/sdl.h b/arch/sandbox/include/asm/sdl.h index ee4991f7c24..86368c8a0a6 100644 --- a/arch/sandbox/include/asm/sdl.h +++ b/arch/sandbox/include/asm/sdl.h @@ -9,6 +9,8 @@ #include <errno.h> #include <video.h> +struct mouse_event; + #ifdef CONFIG_SANDBOX_SDL /** @@ -104,6 +106,8 @@ int sandbox_sdl_sound_init(int rate, int channels); */ int sandbox_sdl_set_bpp(struct udevice *dev, enum video_log2_bpp l2bpp); +int sandbox_sdl_get_mouse_event(struct mouse_event *evt); + #else static inline int sandbox_sdl_init_display(int width, int height, int log2_bpp, bool double_size) @@ -157,6 +161,11 @@ static inline int sandbox_sdl_set_bpp(struct udevice *dev, return -ENOSYS; } +static inline int sandbox_sdl_get_mouse_event(struct mouse_event *evt) +{ + return -ENODEV; +} + #endif #endif -- 2.43.0

From: Simon Glass <sjg@chromium.org> This reads mouse input and shows it on the terminal. It is useful for testing mice. Signed-off-by: Simon Glass <sjg@chromium.org> --- cmd/Kconfig | 9 +++++++ cmd/Makefile | 1 + cmd/mouse.c | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 79 insertions(+) create mode 100644 cmd/mouse.c diff --git a/cmd/Kconfig b/cmd/Kconfig index 8037827930b..af79770b4c6 100644 --- a/cmd/Kconfig +++ b/cmd/Kconfig @@ -2971,6 +2971,15 @@ config CMD_LOG maximum log level for emitting of records). It also provides access to a command used for testing the log system. +config CMD_MOUSE + bool "mouse - Show mouse input" + default y if MOUSE + help + This shows the data produced by a mouse. If a mouse device is + available records are printed when the mouse is moved. This can be + useful for checking that a mouse is working correctly within + U-Boot. + config CMD_TRACE bool "trace - Support tracing of function calls and timing" depends on TRACE diff --git a/cmd/Makefile b/cmd/Makefile index 75ef9fab922..1d65703b625 100644 --- a/cmd/Makefile +++ b/cmd/Makefile @@ -129,6 +129,7 @@ obj-$(CONFIG_CMD_CLONE) += clone.o ifneq ($(CONFIG_CMD_NAND)$(CONFIG_CMD_SF),) obj-y += legacy-mtd-utils.o endif +obj-$(CONFIG_CMD_MOUSE) += mouse.o obj-$(CONFIG_CMD_MUX) += mux.o obj-$(CONFIG_CMD_NAND) += nand.o ifdef CONFIG_NET diff --git a/cmd/mouse.c b/cmd/mouse.c new file mode 100644 index 00000000000..60210b9f868 --- /dev/null +++ b/cmd/mouse.c @@ -0,0 +1,69 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * Mouse testing + * + * Copyright 2020 Google LLC + * Written by Simon Glass <sjg@chromium.org> + */ + +#include <command.h> +#include <console.h> +#include <dm.h> +#include <mouse.h> +#include <u-boot/schedule.h> + +static int do_mouse_dump(struct cmd_tbl *cmdtp, int flag, int argc, + char *const argv[]) +{ + struct udevice *dev; + bool running; + int count; + int ret; + + ret = uclass_first_device_err(UCLASS_MOUSE, &dev); + if (ret) { + printf("Mouse not found (err=%d)\n", ret); + return CMD_RET_FAILURE; + } + for (running = true, count = 0; running;) { + struct mouse_event evt; + + ret = mouse_get_event(dev, &evt); + if (!ret) { + switch (evt.type) { + case MOUSE_EV_BUTTON: { + struct mouse_button *but = &evt.button; + + printf("button: button==%d, press=%d, clicks=%d, X=%d, Y=%d\n", + but->button, but->press_state, + but->clicks, but->x, but->y); + break; + } + case MOUSE_EV_MOTION: { + struct mouse_motion *motion = &evt.motion; + printf("motion: Xrel=%d, Yrel=%d, X=%d, Y=%d, but=%d\n", + motion->xrel, motion->yrel, motion->x, + motion->y, motion->state); + break; + } + case MOUSE_EV_NULL: + break; + } + count++; + } else if (ret != -EAGAIN) { + return log_msg_ret("get_event", ret); + } + schedule(); + if (ctrlc()) + running = false; + } + printf("%d events received\n", count); + + return 0; +} + +static char mouse_help_text[] = + "dump - Dump input from a mouse"; + +U_BOOT_CMD_WITH_SUBCMDS(mouse, "Mouse input", mouse_help_text, + U_BOOT_SUBCMD_MKENT(dump, 1, 1, do_mouse_dump)); -- 2.43.0

From: Simon Glass <sjg@chromium.org> Provide a few simple tests for two methods available in the mouse uclass. Signed-off-by: Simon Glass <sjg@chromium.org> --- arch/sandbox/include/asm/test.h | 17 ++++++ drivers/input/sandbox_mouse.c | 49 +++++++++++++++++ test/dm/Makefile | 1 + test/dm/mouse.c | 96 +++++++++++++++++++++++++++++++++ 4 files changed, 163 insertions(+) create mode 100644 test/dm/mouse.c diff --git a/arch/sandbox/include/asm/test.h b/arch/sandbox/include/asm/test.h index 4df39fac1da..499db42804c 100644 --- a/arch/sandbox/include/asm/test.h +++ b/arch/sandbox/include/asm/test.h @@ -11,6 +11,7 @@ #include <pci_ids.h> struct unit_test_state; +struct mouse_event; /* The sandbox driver always permits an I2C device with this address */ #define SANDBOX_I2C_TEST_ADDR 0x59 @@ -361,4 +362,20 @@ bool sandbox_sf_bootdev_enabled(void); */ void sandbox_sf_set_enable_bootdevs(bool enable); +/** + * sandbox_mouse_set_test_mode() - Enable/disable test mode for sandbox mouse + * + * @dev: Mouse device + * @test_mode: true to enable test mode, false to use SDL + */ +void sandbox_mouse_set_test_mode(struct udevice *dev, bool test_mode); + +/** + * sandbox_mouse_inject() - Inject a mouse event for testing + * + * @dev: Mouse device (must be in test mode) + * @event: Event to inject + */ +void sandbox_mouse_inject(struct udevice *dev, struct mouse_event *event); + #endif diff --git a/drivers/input/sandbox_mouse.c b/drivers/input/sandbox_mouse.c index 4aedf0fdf2d..ba271242b1a 100644 --- a/drivers/input/sandbox_mouse.c +++ b/drivers/input/sandbox_mouse.c @@ -8,11 +8,29 @@ #include <mouse.h> #include <asm/sdl.h> +struct sandbox_mouse_priv { + bool test_mode; + struct mouse_event test_event; + bool test_event_pending; +}; + static int mouse_sandbox_get_event(struct udevice *dev, struct mouse_event *event) { + struct sandbox_mouse_priv *priv = dev_get_priv(dev); int ret; + /* If in test mode, return test event if pending */ + if (priv->test_mode) { + if (priv->test_event_pending) { + *event = priv->test_event; + priv->test_event_pending = false; + return 0; + } else { + return -EAGAIN; + } + } + ret = sandbox_sdl_get_mouse_event(event); return ret; @@ -27,9 +45,40 @@ static const struct udevice_id mouse_sandbox_ids[] = { { } }; +/** + * sandbox_mouse_set_test_mode() - Enable/disable test mode + * + * @dev: Mouse device + * @test_mode: true to enable test mode, false to use SDL + */ +void sandbox_mouse_set_test_mode(struct udevice *dev, bool test_mode) +{ + struct sandbox_mouse_priv *priv = dev_get_priv(dev); + + priv->test_mode = test_mode; + priv->test_event_pending = false; +} + +/** + * sandbox_mouse_inject() - Inject a mouse event for testing + * + * @dev: Mouse device (must be in test mode) + * @event: Event to inject + */ +void sandbox_mouse_inject(struct udevice *dev, struct mouse_event *event) +{ + struct sandbox_mouse_priv *priv = dev_get_priv(dev); + + if (priv->test_mode) { + priv->test_event = *event; + priv->test_event_pending = true; + } +} + U_BOOT_DRIVER(mouse_sandbox) = { .name = "mouse_sandbox", .id = UCLASS_MOUSE, .of_match = mouse_sandbox_ids, .ops = &mouse_sandbox_ops, + .priv_auto = sizeof(struct sandbox_mouse_priv), }; diff --git a/test/dm/Makefile b/test/dm/Makefile index eab78d3ac4a..b38de3e12d0 100644 --- a/test/dm/Makefile +++ b/test/dm/Makefile @@ -68,6 +68,7 @@ obj-$(CONFIG_DM_MDIO_MUX) += mdio_mux.o obj-$(CONFIG_MEMORY) += memory.o obj-$(CONFIG_MISC) += misc.o obj-$(CONFIG_DM_MMC) += mmc.o +obj-$(CONFIG_MOUSE) += mouse.o obj-$(CONFIG_CMD_MUX) += mux-cmd.o obj-$(CONFIG_MULTIPLEXER) += mux-emul.o obj-$(CONFIG_MUX_MMIO) += mux-mmio.o diff --git a/test/dm/mouse.c b/test/dm/mouse.c new file mode 100644 index 00000000000..f9c2e88c43a --- /dev/null +++ b/test/dm/mouse.c @@ -0,0 +1,96 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * Tests for the driver model mouse API + * + * Copyright 2025 Google LLC + * Written by Simon Glass <sjg@chromium.org> + */ + +#include <dm.h> +#include <mouse.h> +#include <dm/test.h> +#include <test/test.h> +#include <test/ut.h> +#include <asm/test.h> + +static int dm_test_mouse_basic(struct unit_test_state *uts) +{ + struct udevice *dev; + + ut_assertok(uclass_first_device_err(UCLASS_MOUSE, &dev)); + + /* put mouse in test mode */ + sandbox_mouse_set_test_mode(dev, true); + + return 0; +} +DM_TEST(dm_test_mouse_basic, UTF_SCAN_PDATA | UTF_SCAN_FDT); + +static int dm_test_mouse_motion(struct unit_test_state *uts) +{ + struct udevice *dev; + struct mouse_event event, inject; + + ut_assertok(uclass_first_device_err(UCLASS_MOUSE, &dev)); + + /* put mouse in test mode */ + sandbox_mouse_set_test_mode(dev, true); + + /* inject a motion event */ + inject.type = MOUSE_EV_MOTION; + inject.motion.state = 0; + inject.motion.x = 100; + inject.motion.y = 200; + inject.motion.xrel = 10; + inject.motion.yrel = 20; + + sandbox_mouse_inject(dev, &inject); + + /* get and verify the event */ + ut_assertok(mouse_get_event(dev, &event)); + ut_asserteq(MOUSE_EV_MOTION, event.type); + ut_asserteq(0, event.motion.state); + ut_asserteq(100, event.motion.x); + ut_asserteq(200, event.motion.y); + ut_asserteq(10, event.motion.xrel); + ut_asserteq(20, event.motion.yrel); + + /* verify no more events are pending */ + ut_asserteq(-EAGAIN, mouse_get_event(dev, &event)); + + return 0; +} +DM_TEST(dm_test_mouse_motion, UTF_SCAN_PDATA | UTF_SCAN_FDT); + +static int dm_test_mouse_button(struct unit_test_state *uts) +{ + struct udevice *dev; + struct mouse_event event, inject; + + ut_assertok(uclass_first_device_err(UCLASS_MOUSE, &dev)); + + /* put mouse in test mode */ + sandbox_mouse_set_test_mode(dev, true); + + /* inject a button press event */ + inject.type = MOUSE_EV_BUTTON; + inject.button.button = BUTTON_LEFT; + inject.button.press_state = BUTTON_PRESSED; + inject.button.clicks = 1; + inject.button.x = 150; + inject.button.y = 250; + + sandbox_mouse_inject(dev, &inject); + + /* get and verify the event */ + ut_assertok(mouse_get_event(dev, &event)); + ut_asserteq(MOUSE_EV_BUTTON, event.type); + ut_asserteq(BUTTON_LEFT, event.button.button); + ut_asserteq(BUTTON_PRESSED, event.button.press_state); + ut_asserteq(1, event.button.clicks); + ut_asserteq(150, event.button.x); + ut_asserteq(250, event.button.y); + + return 0; +} +DM_TEST(dm_test_mouse_button, UTF_SCAN_PDATA | UTF_SCAN_FDT); -- 2.43.0

From: Simon Glass <sjg@chromium.org> A mouse click is defined as pressing the mouse and then releasing it over a given spot. Add a function the tracks the mouse state and returns the most recent mouse click, if any. Signed-off-by: Simon Glass <sjg@chromium.org> --- drivers/input/mouse-uclass.c | 43 +++++++++++++ include/mouse.h | 25 ++++++++ test/dm/mouse.c | 121 +++++++++++++++++++++++++++++++++++ 3 files changed, 189 insertions(+) diff --git a/drivers/input/mouse-uclass.c b/drivers/input/mouse-uclass.c index f42ef346c5c..256642ef55e 100644 --- a/drivers/input/mouse-uclass.c +++ b/drivers/input/mouse-uclass.c @@ -23,7 +23,50 @@ int mouse_get_event(struct udevice *dev, struct mouse_event *evt) return 0; } +int mouse_get_click(struct udevice *dev, int *xp, int *yp) +{ + struct mouse_uc_priv *uc_priv = dev_get_uclass_priv(dev); + struct mouse_event event; + int ret; + + /* Get one mouse event */ + ret = mouse_get_event(dev, &event); + if (ret) + return -EAGAIN; /* No event available */ + + /* Only process button events for left button */ + if (event.type == MOUSE_EV_BUTTON && + event.button.button == BUTTON_LEFT) { + enum mouse_press_state_t new_state = event.button.press_state; + bool pending = false; + + /* Detect press->release transition (click) */ + if (uc_priv->left_button_state == BUTTON_PRESSED && + new_state == BUTTON_RELEASED) { + pending = true; + uc_priv->click_x = event.button.x; + uc_priv->click_y = event.button.y; + } + + /* Update button state */ + uc_priv->left_button_state = new_state; + + /* If we just detected a click, return it */ + if (pending) { + if (xp) + *xp = uc_priv->click_x; + if (yp) + *yp = uc_priv->click_y; + + return 0; + } + } + + return -EAGAIN; +} + UCLASS_DRIVER(mouse) = { .id = UCLASS_MOUSE, .name = "mouse", + .per_device_auto = sizeof(struct mouse_uc_priv), }; diff --git a/include/mouse.h b/include/mouse.h index c96c63918ea..0d20f8ffdbc 100644 --- a/include/mouse.h +++ b/include/mouse.h @@ -8,6 +8,8 @@ #ifndef _MOUSE_H #define _MOUSE_H +#include <stdbool.h> + struct udevice; enum mouse_ev_t { @@ -29,6 +31,19 @@ enum mouse_press_state_t { BUTTON_PRESSED, }; +/** + * struct mouse_uc_priv - private data for mouse uclass + * + * @left_button_state: Current state of left button (BUTTON_PRESSED/BUTTON_RELEASED) + * @click_x: X coordinate where the click occurred + * @click_y: Y coordinate where the click occurred + */ +struct mouse_uc_priv { + enum mouse_press_state_t left_button_state; + int click_x; + int click_y; +}; + /** * struct mouse_event - information about a mouse event * @@ -77,4 +92,14 @@ struct mouse_ops { int mouse_get_event(struct udevice *dev, struct mouse_event *event); +/** + * mouse_get_click() - Check if a left mouse button click has occurred + * + * @dev: Mouse device + * @xp: Returns X coordinate of click (can be NULL) + * @yp: Returns Y coordinate of click (can be NULL) + * Returns: 0 if a click has occurred, -EAGAIN if no click pending + */ +int mouse_get_click(struct udevice *dev, int *xp, int *py); + #endif diff --git a/test/dm/mouse.c b/test/dm/mouse.c index f9c2e88c43a..1b4c2b5f60f 100644 --- a/test/dm/mouse.c +++ b/test/dm/mouse.c @@ -94,3 +94,124 @@ static int dm_test_mouse_button(struct unit_test_state *uts) return 0; } DM_TEST(dm_test_mouse_button, UTF_SCAN_PDATA | UTF_SCAN_FDT); + +static int dm_test_mouse_click(struct unit_test_state *uts) +{ + struct udevice *dev; + struct mouse_event inject; + int x, y; + + ut_assertok(uclass_first_device_err(UCLASS_MOUSE, &dev)); + + /* put mouse in test mode */ + sandbox_mouse_set_test_mode(dev, true); + + /* test that no click is detected initially */ + ut_asserteq(-EAGAIN, mouse_get_click(dev, &x, &y)); + + /* inject a left button press */ + inject.type = MOUSE_EV_BUTTON; + inject.button.button = BUTTON_LEFT; + inject.button.press_state = BUTTON_PRESSED; + inject.button.clicks = 1; + inject.button.x = 300; + inject.button.y = 400; + + sandbox_mouse_inject(dev, &inject); + + /* + * calling mouse_get_click() should not detect a click yet (press + * only) + */ + ut_asserteq(-EAGAIN, mouse_get_click(dev, &x, &y)); + + /* inject a left button release */ + inject.type = MOUSE_EV_BUTTON; + inject.button.button = BUTTON_LEFT; + inject.button.press_state = BUTTON_RELEASED; + inject.button.clicks = 1; + inject.button.x = 300; + inject.button.y = 400; + + sandbox_mouse_inject(dev, &inject); + + /* now mouse_get_click() should detect the click */ + ut_assertok(mouse_get_click(dev, &x, &y)); + ut_asserteq(300, x); + ut_asserteq(400, y); + + /* verify no more clicks are pending */ + ut_asserteq(-EAGAIN, mouse_get_click(dev, &x, &y)); + + return 0; +} +DM_TEST(dm_test_mouse_click, UTF_SCAN_PDATA | UTF_SCAN_FDT); + +static int dm_test_mouse_click_no_coordinates(struct unit_test_state *uts) +{ + struct udevice *dev; + struct mouse_event inject; + + ut_assertok(uclass_first_device_err(UCLASS_MOUSE, &dev)); + + /* put mouse in test mode */ + sandbox_mouse_set_test_mode(dev, true); + + /* inject press and release to create a click */ + inject.type = MOUSE_EV_BUTTON; + inject.button.button = BUTTON_LEFT; + inject.button.press_state = BUTTON_PRESSED; + inject.button.clicks = 1; + inject.button.x = 500; + inject.button.y = 600; + sandbox_mouse_inject(dev, &inject); + + /* process the press event */ + ut_asserteq(-EAGAIN, mouse_get_click(dev, NULL, NULL)); + + inject.button.press_state = BUTTON_RELEASED; + sandbox_mouse_inject(dev, &inject); + + /* + * now test that click is detected without coordinate return + */ + ut_assertok(mouse_get_click(dev, NULL, NULL)); + + return 0; +} +DM_TEST(dm_test_mouse_click_no_coordinates, UTF_SCAN_PDATA | UTF_SCAN_FDT); + +static int dm_test_mouse_right_button(struct unit_test_state *uts) +{ + struct udevice *dev; + struct mouse_event inject; + int x, y; + + ut_assertok(uclass_first_device_err(UCLASS_MOUSE, &dev)); + + /* put mouse in test mode */ + sandbox_mouse_set_test_mode(dev, true); + + /* + * right button events should not be detected as clicks by + * mouse_get_click() + */ + inject.type = MOUSE_EV_BUTTON; + inject.button.button = BUTTON_RIGHT; + inject.button.press_state = BUTTON_PRESSED; + inject.button.clicks = 1; + inject.button.x = 100; + inject.button.y = 200; + sandbox_mouse_inject(dev, &inject); + + ut_asserteq(-EAGAIN, mouse_get_click(dev, &x, &y)); + + inject.button.press_state = BUTTON_RELEASED; + sandbox_mouse_inject(dev, &inject); + + /* still no click detected since it was right button */ + ut_asserteq(-EAGAIN, mouse_get_click(dev, &x, &y)); + + return 0; +} +DM_TEST(dm_test_mouse_right_button, UTF_SCAN_PDATA | UTF_SCAN_FDT); -- 2.43.0

From: Simon Glass <sjg@chromium.org> In some cases the device may have a touchpad or mouse, so it is useful to be able to use this in U-Boot. Add a simple driver for a mouse that uses the EFI simple-pointer protocol. Signed-off-by: Simon Glass <sjg@chromium.org> --- drivers/input/Kconfig | 12 ++- drivers/input/Makefile | 1 + drivers/input/efi_mouse.c | 221 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 233 insertions(+), 1 deletion(-) create mode 100644 drivers/input/efi_mouse.c diff --git a/drivers/input/Kconfig b/drivers/input/Kconfig index e98471c7c2e..4bc94de0a0a 100644 --- a/drivers/input/Kconfig +++ b/drivers/input/Kconfig @@ -104,7 +104,7 @@ config TWL4030_INPUT config MOUSE bool "Support for mice and other pointing devices" depends on INPUT - default y if SANDBOX + default y if SANDBOX || EFI_APP help This allows U-Boot to access mouse input, typically needed for graphics boot menus and the like. The driver can provide mouse @@ -118,3 +118,13 @@ config USB_MOUSE typically a boot menu. The driver uses the USB boot interface of the mouse and attempts to auto-configure itself for normal operation. + +config EFI_MOUSE + bool "EFI mouse support" + depends on EFI_APP + default y if EFI_APP + help + This enables mouse support when U-Boot is running as an EFI + application. It uses the EFI Simple Pointer Protocol to access + mouse input from the underlying EFI firmware. This is useful + when U-Boot is used as an EFI boot manager or application. diff --git a/drivers/input/Makefile b/drivers/input/Makefile index 797284ad8f8..4debad9e713 100644 --- a/drivers/input/Makefile +++ b/drivers/input/Makefile @@ -21,3 +21,4 @@ ifdef CONFIG_MOUSE obj-$(CONFIG_SANDBOX) += sandbox_mouse.o endif obj-$(CONFIG_USB_MOUSE) += usb_mouse.o +obj-$(CONFIG_EFI_MOUSE) += efi_mouse.o diff --git a/drivers/input/efi_mouse.c b/drivers/input/efi_mouse.c new file mode 100644 index 00000000000..84347951f62 --- /dev/null +++ b/drivers/input/efi_mouse.c @@ -0,0 +1,221 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * EFI mouse driver using Simple Pointer Protocol + * + * Copyright 2025 Google LLC + * Written by Claude <noreply@anthropic.com> + */ + +#define LOG_CATEGORY UCLASS_MOUSE + +#include <dm.h> +#include <efi.h> +#include <efi_api.h> +#include <log.h> +#include <mouse.h> + +struct efi_mouse_priv { + struct efi_simple_pointer_protocol *pointer; + struct efi_simple_pointer_state last_state; + bool has_last_state; + int x, y; + int buttons; + int old_buttons; + struct efi_event *timer_event; +}; + +static int efi_mouse_get_event(struct udevice *dev, struct mouse_event *event) +{ + struct efi_mouse_priv *priv = dev_get_priv(dev); + struct efi_simple_pointer_state state; + efi_status_t ret; + int new_buttons; + if (!priv->pointer) + return -ENODEV; + + /* Use timer-based polling approach like EFI keyboard */ + if (priv->timer_event) { + struct efi_boot_services *boot = efi_get_boot(); + efi_uintn_t index; + struct efi_event *events[2]; + efi_uintn_t num_events = 1; + + events[0] = priv->timer_event; + if (priv->pointer->wait_for_input) { + events[1] = priv->pointer->wait_for_input; + num_events = 2; + } + + ret = boot->wait_for_event(num_events, events, &index); + if (ret != EFI_SUCCESS) + return -EAGAIN; + } + + /* Get current pointer state */ + ret = priv->pointer->get_state(priv->pointer, &state); + if (ret != EFI_SUCCESS) { + if (ret == EFI_NOT_READY) + return -EAGAIN; + printf("EFI mouse: get_state failed (ret=0x%lx)\n", ret); + return -EIO; + } + + /* Check for button changes */ + new_buttons = 0; + if (state.left_button) + new_buttons |= 1 << 0; + if (state.right_button) + new_buttons |= 1 << 1; + + if (new_buttons != priv->old_buttons) { + struct mouse_button *but = &event->button; + u8 diff = new_buttons ^ priv->old_buttons; + int i; + + event->type = MOUSE_EV_BUTTON; + /* Find first changed button */ + for (i = 0; i < 2; i++) { + u8 mask = 1 << i; + if (diff & mask) { + but->button = i; + but->press_state = (new_buttons & mask) ? 1 : 0; + but->clicks = 1; + but->x = priv->x; + but->y = priv->y; + priv->old_buttons ^= mask; + return 0; + } + } + } + + /* Check for movement */ + if (state.relative_movement_x || state.relative_movement_y) { + struct mouse_motion *motion = &event->motion; + + /* Update absolute position */ + priv->x += state.relative_movement_x; + priv->x = max(priv->x, 0); + priv->x = min(priv->x, 0xffff); + + priv->y += state.relative_movement_y; + priv->y = max(priv->y, 0); + priv->y = min(priv->y, 0xffff); + + event->type = MOUSE_EV_MOTION; + motion->state = new_buttons; + motion->x = priv->x; + motion->y = priv->y; + motion->xrel = state.relative_movement_x; + motion->yrel = state.relative_movement_y; + + priv->buttons = new_buttons; + return 0; + } + + priv->buttons = new_buttons; + + return -EAGAIN; +} + +static int efi_mouse_probe(struct udevice *dev) +{ + struct efi_mouse_priv *priv = dev_get_priv(dev); + struct efi_boot_services *boot = efi_get_boot(); + efi_status_t ret; + efi_handle_t *handles; + efi_uintn_t num_handles; + + log_debug("EFI mouse probe\n"); + + /* Find Simple Pointer Protocol handles */ + ret = boot->locate_handle_buffer(BY_PROTOCOL, &efi_guid_simple_pointer, + NULL, &num_handles, &handles); + if (ret != EFI_SUCCESS) { + printf("EFI mouse: No EFI pointer devices found (ret=0x%lx)\n", ret); + return -ENODEV; + } + + log_debug("Found %zu EFI pointer device(s)\n", num_handles); + + /* Use the first pointer device */ + ret = boot->open_protocol(handles[0], &efi_guid_simple_pointer, + (void **)&priv->pointer, efi_get_parent_image(), + NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL); + if (ret != EFI_SUCCESS) { + printf("EFI mouse: Failed to open EFI pointer protocol (ret=0x%lx)\n", ret); + efi_free_pool(handles); + return -ENODEV; + } + + efi_free_pool(handles); + + /* Reset the pointer device */ + ret = priv->pointer->reset(priv->pointer, false); + if (ret != EFI_SUCCESS) { + log_warning("Failed to reset EFI pointer device\n"); + /* Continue anyway - some devices might not support reset */ + } + + priv->x = 0; + priv->y = 0; + priv->buttons = 0; + priv->old_buttons = 0; + priv->has_last_state = false; + + /* Create a timer event for periodic checking */ + ret = boot->create_event(EVT_TIMER, TPL_NOTIFY, NULL, NULL, + &priv->timer_event); + if (ret != EFI_SUCCESS) { + printf("EFI mouse: Failed to create timer event (ret=0x%lx)\n", ret); + /* Continue without timer - fallback to direct polling */ + priv->timer_event = NULL; + } else { + /* Set timer to trigger every 10ms (100000 x 100ns = 10ms) */ + ret = boot->set_timer(priv->timer_event, EFI_TIMER_PERIODIC, 10000); + if (ret != EFI_SUCCESS) { + printf("EFI mouse: Failed to set timer (ret=0x%lx)\n", ret); + boot->close_event(priv->timer_event); + priv->timer_event = NULL; + } + } + + log_info("EFI mouse initialized\n"); + return 0; +} + +static int efi_mouse_remove(struct udevice *dev) +{ + struct efi_mouse_priv *priv = dev_get_priv(dev); + struct efi_boot_services *boot = efi_get_boot(); + + if (priv->timer_event) { + boot->close_event(priv->timer_event); + priv->timer_event = NULL; + } + + if (priv->pointer) { + /* Protocol will be automatically closed when the image is unloaded */ + priv->pointer = NULL; + } + + return 0; +} + +static const struct mouse_ops efi_mouse_ops = { + .get_event = efi_mouse_get_event, +}; + +static const struct udevice_id efi_mouse_ids[] = { + { .compatible = "efi,mouse" }, + { } +}; + +U_BOOT_DRIVER(efi_mouse) = { + .name = "efi_mouse", + .id = UCLASS_MOUSE, + .of_match = efi_mouse_ids, + .ops = &efi_mouse_ops, + .probe = efi_mouse_probe, + .remove = efi_mouse_remove, + .priv_auto = sizeof(struct efi_mouse_priv), +}; -- 2.43.0

From: Simon Glass <sjg@chromium.org> Provide arguments to QEMU to enable a mouse. Note that this does not work with EFI at present. Signed-off-by: Simon Glass <sjg@chromium.org> --- scripts/build-efi | 3 +++ scripts/build-qemu | 6 +++++- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/scripts/build-efi b/scripts/build-efi index f4c96dad7bd..131aad50897 100755 --- a/scripts/build-efi +++ b/scripts/build-efi @@ -112,6 +112,9 @@ class BuildEfi: extra += ['-device', 'qemu-xhci', '-device', 'usb-kbd', '-device', 'usb-tablet'] extra += ['-display', 'default,show-cursor=on'] + else: # x86 + extra += ['-device', 'qemu-xhci', '-device', 'usb-kbd', + '-device', 'usb-tablet'] extra += ['-serial', 'mon:stdio'] serial_msg = '' if self.args.kvm: diff --git a/scripts/build-qemu b/scripts/build-qemu index 0bc312470de..62f0bc41fad 100755 --- a/scripts/build-qemu +++ b/scripts/build-qemu @@ -274,7 +274,11 @@ class BuildQemu: elif self.args.arch == 'arm': qemu_cmd.extend(['-device', 'virtio-gpu-pci']) qemu_cmd.extend(['-device', 'qemu-xhci', '-device', 'usb-kbd', - '-device', 'usb-tablet']) + '-device', 'usb-tablet', '-device', 'usb-mouse']) + qemu_cmd.extend(['-display', 'default,show-cursor=on']) + elif self.args.arch == 'x86': + qemu_cmd.extend(['-device', 'qemu-xhci']) + qemu_cmd.extend(['-device', 'usb-kbd', '-device', 'usb-tablet']) qemu_cmd.extend(['-display', 'default,show-cursor=on']) if not any(item.startswith('-serial') for item in self.qemu_extra): qemu_cmd.extend(['-serial', 'mon:stdio']) -- 2.43.0

From: Simon Glass <sjg@chromium.org> Enable the mouse when running on QEMU, for ARM and x86. This requires 'usb start' on x86. For ARM, the mouse does not work, perhaps related to the fact that the display does not work either. Signed-off-by: Simon Glass <sjg@chromium.org> --- drivers/input/Kconfig | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/drivers/input/Kconfig b/drivers/input/Kconfig index 4bc94de0a0a..7b34902dd7c 100644 --- a/drivers/input/Kconfig +++ b/drivers/input/Kconfig @@ -104,7 +104,7 @@ config TWL4030_INPUT config MOUSE bool "Support for mice and other pointing devices" depends on INPUT - default y if SANDBOX || EFI_APP + default y if SANDBOX || EFI_APP || MACH_QEMU help This allows U-Boot to access mouse input, typically needed for graphics boot menus and the like. The driver can provide mouse @@ -113,6 +113,7 @@ config MOUSE config USB_MOUSE bool "USB mouse support" + default y if MACH_QEMU help This enables using a USB mouse to control a feature in U-Boot, typically a boot menu. The driver uses the USB boot interface of -- 2.43.0