cmd: dm: allow for selecting uclass and device

The output from "dm tree" or "dm uclass" is a bit annoying
if the number of devices available on the system is huge.
(This is especially true on sandbox when I debug some DM code.)

With this patch, we can specify the uclass name or the device
name that we are interested in in order to limit the output.

For instance,

=> dm uclass usb
uclass 121: usb
0     usb@1 @ 0bcff8b0, seq 1

uclass 124: usb

=> dm tree usb:usb@1
 Class     Index  Probed  Driver                Name
-----------------------------------------------------------
 usb           0  [   ]   usb_sandbox           usb@1
 usb_hub       0  [   ]   usb_hub               `-- hub
 usb_emul      0  [   ]   usb_sandbox_hub           `-- hub-emul
 usb_emul      1  [   ]   usb_sandbox_flash             |-- flash-stick@0
 usb_emul      2  [   ]   usb_sandbox_flash             |-- flash-stick@1
 usb_emul      3  [   ]   usb_sandbox_flash             |-- flash-stick@2
 usb_emul      4  [   ]   usb_sandbox_keyb              `-- keyb@3

If you want forward-matching against a uclass or udevice name,
you can specify "-e" option.

=> dm uclass -e usb
uclass 15: usb_emul
0     hub-emul @ 0bcffb00, seq 0
1     flash-stick@0 @ 0bcffc30, seq 1
2     flash-stick@1 @ 0bcffdc0, seq 2
3     flash-stick@2 @ 0bcfff50, seq 3
4     keyb@3 @ 0bd000e0, seq 4

uclass 64: usb_mass_storage

uclass 121: usb
0     usb@1 @ 0bcff8b0, seq 1

uclass 122: usb_dev_generic

uclass 123: usb_hub
0     hub @ 0bcff9b0, seq 0

uclass 124: usb

=> dm tree -e usb
 Class     Index  Probed  Driver                Name
-----------------------------------------------------------
 usb           0  [   ]   usb_sandbox           usb@1
 usb_hub       0  [   ]   usb_hub               `-- hub
 usb_emul      0  [   ]   usb_sandbox_hub           `-- hub-emul
 usb_emul      1  [   ]   usb_sandbox_flash             |-- flash-stick@0
 usb_emul      2  [   ]   usb_sandbox_flash             |-- flash-stick@1
 usb_emul      3  [   ]   usb_sandbox_flash             |-- flash-stick@2
 usb_emul      4  [   ]   usb_sandbox_keyb              `-- keyb@3

Signed-off-by: AKASHI Takahiro <takahiro.akashi@linaro.org>
Reviewed-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
AKASHI Takahiro 2023-08-23 10:49:47 +09:00 committed by Simon Glass
parent 9e644284ab
commit 36e45f69c4
4 changed files with 162 additions and 41 deletions

View file

@ -59,11 +59,26 @@ static int do_dm_dump_static_driver_info(struct cmd_tbl *cmdtp, int flag,
static int do_dm_dump_tree(struct cmd_tbl *cmdtp, int flag, int argc,
char *const argv[])
{
bool sort;
bool extended = false, sort = false;
char *device = NULL;
sort = argc > 1 && !strcmp(argv[1], "-s");
for (; argc > 1; argc--, argv++) {
if (argv[1][0] != '-')
break;
dm_dump_tree(sort);
if (!strcmp(argv[1], "-e")) {
extended = true;
} else if (!strcmp(argv[1], "-s")) {
sort = true;
} else {
printf("Unknown parameter: %s\n", argv[1]);
return 0;
}
}
if (argc > 1)
device = argv[1];
dm_dump_tree(device, extended, sort);
return 0;
}
@ -71,7 +86,20 @@ static int do_dm_dump_tree(struct cmd_tbl *cmdtp, int flag, int argc,
static int do_dm_dump_uclass(struct cmd_tbl *cmdtp, int flag, int argc,
char *const argv[])
{
dm_dump_uclass();
bool extended = false;
char *uclass = NULL;
if (argc > 1) {
if (!strcmp(argv[1], "-e")) {
extended = true;
argc--;
argv++;
}
if (argc > 1)
uclass = argv[1];
}
dm_dump_uclass(uclass, extended);
return 0;
}
@ -91,8 +119,8 @@ static char dm_help_text[] =
"dm drivers Dump list of drivers with uclass and instances\n"
DM_MEM_HELP
"dm static Dump list of drivers with static platform data\n"
"dm tree [-s] Dump tree of driver model devices (-s=sort)\n"
"dm uclass Dump list of instances for each uclass"
"dm tree [-s][-e][name] Dump tree of driver model devices (-s=sort)\n"
"dm uclass [-e][name] Dump list of instances for each uclass"
;
#endif
@ -102,5 +130,5 @@ U_BOOT_CMD_WITH_SUBCMDS(dm, "Driver model low level access", dm_help_text,
U_BOOT_SUBCMD_MKENT(drivers, 1, 1, do_dm_dump_drivers),
DM_MEM
U_BOOT_SUBCMD_MKENT(static, 1, 1, do_dm_dump_static_driver_info),
U_BOOT_SUBCMD_MKENT(tree, 2, 1, do_dm_dump_tree),
U_BOOT_SUBCMD_MKENT(uclass, 1, 1, do_dm_dump_uclass));
U_BOOT_SUBCMD_MKENT(tree, 4, 1, do_dm_dump_tree),
U_BOOT_SUBCMD_MKENT(uclass, 3, 1, do_dm_dump_uclass));

View file

@ -12,8 +12,8 @@ Synopis
dm devres
dm drivers
dm static
dm tree [-s]
dm uclass
dm tree [-s][-e] [uclass name]
dm uclass [-e] [udevice name]
Description
-----------
@ -127,6 +127,12 @@ If -s is given, the top-level devices (those which are children of the root
device) are shown sorted in order of uclass ID, so it is easier to find a
particular device type.
If -e is given, forward-matching against existing devices is
made and only the matched devices are shown.
If a device name is given, forward-matching against existing devices is
made and only the matched devices are shown.
dm uclass
~~~~~~~~~
@ -140,6 +146,11 @@ For each device, the format is::
where `n` is the index within the uclass, `a` is the address of the device in
memory and `s` is the sequence number of the device.
If -e is given, forward-matching against existing uclasses is
made and only the matched uclasses are shown.
If no uclass name is given, all the uclasses are shown.
Examples
--------
@ -409,6 +420,15 @@ This example shows the abridged sandbox output::
nop 8 [ ] scmi_voltage_domain `-- regulators
regulator 5 [ ] scmi_regulator |-- reg@0
regulator 6 [ ] scmi_regulator `-- reg@1
=> dm tree pinc
pinctrl 0 [ + ] sandbox_pinctrl_gpio pinctrl-gpio
gpio 1 [ + ] sandbox_gpio |-- base-gpios
nop 0 [ + ] gpio_hog | |-- hog_input_active_low
nop 1 [ + ] gpio_hog | |-- hog_input_active_high
nop 2 [ + ] gpio_hog | |-- hog_output_low
nop 3 [ + ] gpio_hog | `-- hog_output_high
gpio 2 [ ] sandbox_gpio |-- extra-gpios
gpio 3 [ ] sandbox_gpio `-- pinmux-gpios
=>
@ -487,4 +507,10 @@ This example shows the abridged sandbox output::
0 * gpio-wdt @ 0301c070, seq 0
1 * wdt@0 @ 03021710, seq 1
=> dm uclass blk
uclass 22: blk
0 mmc2.blk @ 0301ca00, seq 0
1 mmc1.blk @ 0301cee0, seq 1
2 mmc0.blk @ 0301d380, seq 2
=>

View file

@ -85,19 +85,13 @@ static void show_devices(struct udevice *dev, int depth, int last_flag,
}
}
void dm_dump_tree(bool sort)
static void dm_dump_tree_single(struct udevice *dev, bool sort)
{
struct udevice *root;
root = dm_root();
if (root) {
int dev_count, uclasses;
struct udevice **devs = NULL;
dm_get_stats(&dev_count, &uclasses);
printf(" Class Index Probed Driver Name\n");
printf("-----------------------------------------------------------\n");
if (sort) {
devs = calloc(dev_count, sizeof(struct udevice *));
if (!devs) {
@ -105,9 +99,51 @@ void dm_dump_tree(bool sort)
return;
}
}
show_devices(root, -1, 0, devs);
show_devices(dev, -1, 0, devs);
free(devs);
}
static void dm_dump_tree_recursive(struct udevice *dev, char *dev_name,
bool extended, bool sort)
{
struct udevice *child;
size_t len;
len = strlen(dev_name);
device_foreach_child(child, dev) {
if (extended) {
if (!strncmp(child->name, dev_name, len)) {
dm_dump_tree_single(child, sort);
continue;
}
} else {
if (!strcmp(child->name, dev_name)) {
dm_dump_tree_single(child, sort);
continue;
}
}
dm_dump_tree_recursive(child, dev_name, extended, sort);
}
}
void dm_dump_tree(char *dev_name, bool extended, bool sort)
{
struct udevice *root;
printf(" Class Index Probed Driver Name\n");
printf("-----------------------------------------------------------\n");
root = dm_root();
if (!root)
return;
if (!dev_name || !strcmp(dev_name, "root")) {
dm_dump_tree_single(root, sort);
return;
}
dm_dump_tree_recursive(root, dev_name, extended, sort);
}
/**
@ -127,19 +163,15 @@ static void dm_display_line(struct udevice *dev, int index)
puts("\n");
}
void dm_dump_uclass(void)
static void dm_dump_uclass_single(enum uclass_id id)
{
struct uclass *uc;
int ret;
int id;
for (id = 0; id < UCLASS_COUNT; id++) {
struct udevice *dev;
int i = 0;
int i = 0, ret;
ret = uclass_get(id, &uc);
if (ret)
continue;
return;
printf("uclass %d: %s\n", id, uc->uc_drv->name);
uclass_foreach_dev(dev, uc) {
@ -147,6 +179,34 @@ void dm_dump_uclass(void)
i++;
}
puts("\n");
}
void dm_dump_uclass(char *uclass, bool extended)
{
struct uclass *uc;
enum uclass_id id;
bool matching;
int ret;
matching = !!(uclass && strcmp(uclass, "root"));
for (id = 0; id < UCLASS_COUNT; id++) {
ret = uclass_get(id, &uc);
if (ret)
continue;
if (matching) {
if (extended) {
if (!strncmp(uc->uc_drv->name, uclass,
strlen(uclass)))
dm_dump_uclass_single(id);
} else {
if (!strcmp(uc->uc_drv->name, uclass))
dm_dump_uclass_single(id);
}
} else {
dm_dump_uclass_single(id);
}
}
}

View file

@ -27,14 +27,21 @@ struct list_head;
int list_count_items(struct list_head *head);
/**
* Dump out a tree of all devices
* Dump out a tree of all devices starting @uclass
*
* @dev_name: udevice name
* @extended: true if forword-matching expected
* @sort: Sort by uclass name
*/
void dm_dump_tree(bool sort);
void dm_dump_tree(char *dev_name, bool extended, bool sort);
/* Dump out a list of uclasses and their devices */
void dm_dump_uclass(void);
/*
* Dump out a list of uclasses and their devices
*
* @uclass: uclass name
* @extended: true if forword-matching expected
*/
void dm_dump_uclass(char *uclass, bool extended);
#ifdef CONFIG_DEBUG_DEVRES
/* Dump out a list of device resources */