dt: dt-extract-compatibles: Extract compatibles from function parameters
Rob Herring (Arm)
maintainerPATCH 1/1 dt: dt-extract-compatibles: Extract compatibles from function parameters
Various DT and fwnode functions take a compatible string as a parameter. These are often used in cases which don't have a driver, so they've been missed.
The additional checks add about 400 more undocumented compatible strings.
--- scripts/dtc/dt-extract-compatibles | 13 +++++++++++++ 1 file changed, 13 insertions(+)
scripts/dtc/dt-extract-compatibles +13 -0
@@ -46,6 +46,15 @@ def parse_of_match_table(data): return match_table_list +def parse_of_functions(data, func_name): + """ Find all (device|machine)_is_compatible() arguments """ + match_table_list = [] + for m in re.finditer(rf'{func_name}\(([a-zA-Z0-9_>\(\)"\-]+,\s)*"([a-zA-Z0-9_,-]+)"\)', data): + match_table_list.append(m[2]) + + return match_table_list + + def parse_compatibles(file, compat_ignore_list): with open(file, 'r', encoding='utf-8') as f: data = f.read().replace('\n', '')
@@ -60,6 +69,10 @@ def parse_compatibles(file, compat_ignore_list): else: compat_list = parse_of_declare_macros(data) compat_list += parse_of_device_id(data) + compat_list += parse_of_functions(data, "_is_compatible") + compat_list += parse_of_functions(data, "of_find_compatible_node") + compat_list += parse_of_functions(data, "for_each_compatible_node") + compat_list += parse_of_functions(data, "of_get_compatible_child") return compat_list
Signature · 1 line
2.45.2
Quoted 10 lines · Rob Herring (Arm)
Various DT and fwnode functions take a compatible string as a parameter. These are often used in cases which don't have a driver, so they've been missed.
The additional checks add about 400 more undocumented compatible strings.
Cc Nícolas F. R. A. Prado <[email protected]>Signed-off-by Rob Herring (Arm) <[email protected]>
-Saravana
Quoted 38 lines
--- scripts/dtc/dt-extract-compatibles | 13 +++++++++++++ 1 file changed, 13 insertions(+)scripts/dtc/dt-extract-compatibles +13
-1@@ -46,6 +46,15 @@ def parse_of_match_table(data): return match_table_list +def parse_of_functions(data, func_name): + """ Find all (device|machine)_is_compatible() arguments """ + match_table_list = [] + for m in re.finditer(rf'{func_name}\(([a-zA-Z0-9_>\(\)"\-]+,\s)*"([a-zA-Z0-9_,-]+)"\)', data): + match_table_list.append(m[2]) + + return match_table_list + + def parse_compatibles(file, compat_ignore_list): with open(file, 'r', encoding='utf-8') as f: data = f.read().replace('\n', '')@@ -60,6 +69,10 @@ def parse_compatibles(file, compat_ignore_list): else: compat_list = parse_of_declare_macros(data) compat_list += parse_of_device_id(data) + compat_list += parse_of_functions(data, "_is_compatible") + compat_list += parse_of_functions(data, "of_find_compatible_node") + compat_list += parse_of_functions(data, "for_each_compatible_node") + compat_list += parse_of_functions(data, "of_get_compatible_child") return compat_list --2.45.2
Quoted 18 lines · Rob Herring (Arm)
Various DT and fwnode functions take a compatible string as a parameter. These are often used in cases which don't have a driver, so they've been missed.
The additional checks add about 400 more undocumented compatible strings.
Cc Nícolas F. R. A. Prado <[email protected]>Signed-off-by Rob Herring (Arm) <[email protected]>--- scripts/dtc/dt-extract-compatibles | 13 +++++++++++++ 1 file changed, 13 insertions(+)scripts/dtc/dt-extract-compatibles +0
-0
scripts/dtc/dt-extract-compatibles def parse_of_match_table(data): · line 50
Quoted 5 lines
scripts/dtc/dt-extract-compatibles +2
-0@@ -46,6 +46,15 @@ def parse_of_match_table(data): return match_table_list +def parse_of_functions(data, func_name): + """ Find all (device|machine)_is_compatible() arguments """
This comment looks outdated.
"Find all compatibles in the last argument of a given function"?
scripts/dtc/dt-extract-compatibles def parse_of_match_table(data): · line 51
Quoted 1 line
scripts/dtc/dt-extract-compatibles +1
-0+ match_table_list = []
A better name would be compat_list like in the other functions that return lists of compatibles.
Quoted 10 lines
scripts/dtc/dt-extract-compatibles +6
-0+ for m in re.finditer(rf'{func_name}\(([a-zA-Z0-9_>\(\)"\-]+,\s)*"([a-zA-Z0-9_,-]+)"\)', data): + match_table_list.append(m[2]) + + return match_table_list + + def parse_compatibles(file, compat_ignore_list): with open(file, 'r', encoding='utf-8') as f: data = f.read().replace('\n', '')
scripts/dtc/dt-extract-compatibles def parse_compatibles(file, compat_ignore_list): · line 72
Quoted 4 lines
scripts/dtc/dt-extract-compatibles +1
-0@@ -60,6 +69,10 @@ def parse_compatibles(file, compat_ignore_list): else: compat_list = parse_of_declare_macros(data) compat_list += parse_of_device_id(data) + compat_list += parse_of_functions(data, "_is_compatible")
This pattern seems very broad and bound to generate false-positives. That said, I glanced over the results and didn't see any string clearly wrong, so I guess it's fine. There were a couple suspicious strings like "B5221" but they were indeed used in the of functions, so it's working correctly.
Quoted 9 lines
scripts/dtc/dt-extract-compatibles +3
-0+ compat_list += parse_of_functions(data, "of_find_compatible_node") + compat_list += parse_of_functions(data, "for_each_compatible_node") + compat_list += parse_of_functions(data, "of_get_compatible_child") return compat_listSignature · 1 line
2.45.2
On a related note, I'm wondering if you haven't had time to see
https://lore.kernel.org/all/20240729-dt-kselftest-parent-disabled-v2-1-d7a001c4930d@collabora.com
or if that patch didn't make it to you somehow.
Thanks,
Nícolas
Rob Herring
maintainerQuoted 23 lines · Nícolas F. R. A. Prado
Quoted 21 lines · Rob Herring (Arm)
Various DT and fwnode functions take a compatible string as a parameter. These are often used in cases which don't have a driver, so they've been missed.
The additional checks add about 400 more undocumented compatible strings.
Cc Nícolas F. R. A. Prado <[email protected]>Signed-off-by Rob Herring (Arm) <[email protected]>--- scripts/dtc/dt-extract-compatibles | 13 +++++++++++++ 1 file changed, 13 insertions(+)scripts/dtc/dt-extract-compatibles +0
-0@@ -46,6 +46,15 @@ def parse_of_match_table(data): return match_table_list
Quoted 4 lines
scripts/dtc/dt-extract-compatibles def parse_of_match_table(data): · line 50
Quoted 2 lines
scripts/dtc/dt-extract-compatibles +2
-0+def parse_of_functions(data, func_name): + """ Find all (device|machine)_is_compatible() arguments """This comment looks outdated.
Indeed...
Quoted 19 lines
"Find all compatibles in the last argument of a given function"?
scripts/dtc/dt-extract-compatibles def parse_of_match_table(data): · line 51
Quoted 1 line
scripts/dtc/dt-extract-compatibles +1
-0+ match_table_list = []A better name would be
compat_listlike in the other functions that return lists of compatibles.Quoted 11 lines
scripts/dtc/dt-extract-compatibles +6
-0+ for m in re.finditer(rf'{func_name}\(([a-zA-Z0-9_>\(\)"\-]+,\s)*"([a-zA-Z0-9_,-]+)"\)', data): + match_table_list.append(m[2]) + + return match_table_list + + def parse_compatibles(file, compat_ignore_list): with open(file, 'r', encoding='utf-8') as f: data = f.read().replace('\n', '')@@ -60,6 +69,10 @@ def parse_compatibles(file, compat_ignore_list): else:
Quoted 8 lines
scripts/dtc/dt-extract-compatibles def parse_compatibles(file, compat_ignore_list): · line 72
Quoted 3 lines
scripts/dtc/dt-extract-compatibles +1
-0compat_list = parse_of_declare_macros(data) compat_list += parse_of_device_id(data) + compat_list += parse_of_functions(data, "_is_compatible")This pattern seems very broad and bound to generate false-positives. That said, I glanced over the results and didn't see any string clearly wrong, so I guess it's fine. There were a couple suspicious strings like "B5221" but they were indeed used in the of functions, so it's working correctly.
Originally I had it more specific, but ended up here. I even found one I didn't know about. It matches of_flat_dt_is_compatible, of_machine_is_compatible, (of_)?device_is_compatible, and dt_is_compatible.
Quoted 5 lines
Quoted 5 lines
scripts/dtc/dt-extract-compatibles +3
-0+ compat_list += parse_of_functions(data, "of_find_compatible_node") + compat_list += parse_of_functions(data, "for_each_compatible_node") + compat_list += parse_of_functions(data, "of_get_compatible_child")
Quoted 7 lines
Quoted 5 lines
scripts/dtc/dt-extract-compatibles +0
-1return compat_list --2.45.2
Reviewed-by Nícolas F. R. A. Prado <[email protected]>
Thanks.
Quoted 4 lines
On a related note, I'm wondering if you haven't had time to see
https://lore.kernel.org/all/20240729-dt-kselftest-parent-disabled-v2-1-d7a001c4930d@collabora.com
or if that patch didn't make it to you somehow.
Sorry, it's outside what patchwork catches and I tend to miss those.
Rob