xref: /linux/scripts/dtc/dt-extract-compatibles (revision be239684b18e1cdcafcf8c7face4a2f562c745ad)
1#!/usr/bin/env python3
2# SPDX-License-Identifier: GPL-2.0-only
3
4import fnmatch
5import os
6import re
7import argparse
8
9
10def parse_of_declare_macros(data, include_driver_macros=True):
11	""" Find all compatible strings in OF_DECLARE() style macros """
12	compat_list = []
13	# CPU_METHOD_OF_DECLARE does not have a compatible string
14	if include_driver_macros:
15		re_macros = r'(?<!CPU_METHOD_)(IRQCHIP|OF)_(DECLARE|MATCH)(_DRIVER)?\(.*?\)'
16	else:
17		re_macros = r'(?<!CPU_METHOD_)(IRQCHIP|OF)_(DECLARE|MATCH)\(.*?\)'
18	for m in re.finditer(re_macros, data):
19		try:
20			compat = re.search(r'"(.*?)"', m[0])[1]
21		except:
22			# Fails on compatible strings in #define, so just skip
23			continue
24		compat_list += [compat]
25
26	return compat_list
27
28
29def parse_of_device_id(data, match_table_list=None):
30	""" Find all compatible strings in of_device_id structs """
31	compat_list = []
32	for m in re.finditer(r'of_device_id(\s+\S+)?\s+(\S+)\[\](\s+\S+)?\s*=\s*({.*?);', data):
33		if match_table_list is not None and m[2] not in match_table_list:
34			continue
35		compat_list += re.findall(r'\.compatible\s+=\s+"(\S+)"', m[4])
36
37	return compat_list
38
39
40def parse_of_match_table(data):
41	""" Find all driver's of_match_table """
42	match_table_list = []
43	for m in re.finditer(r'\.of_match_table\s+=\s+(of_match_ptr\()?([a-zA-Z0-9_-]+)', data):
44		match_table_list.append(m[2])
45
46	return match_table_list
47
48
49def parse_compatibles(file, compat_ignore_list):
50	with open(file, 'r', encoding='utf-8') as f:
51		data = f.read().replace('\n', '')
52
53	if compat_ignore_list is not None:
54		# For a compatible in the DT to be matched to a driver it needs to show
55		# up in a driver's of_match_table
56		match_table_list = parse_of_match_table(data)
57		compat_list = parse_of_device_id(data, match_table_list)
58
59		compat_list = [compat for compat in compat_list if compat not in compat_ignore_list]
60	else:
61		compat_list = parse_of_declare_macros(data)
62		compat_list += parse_of_device_id(data)
63
64	return compat_list
65
66def parse_compatibles_to_ignore(file):
67	with open(file, 'r', encoding='utf-8') as f:
68		data = f.read().replace('\n', '')
69
70	# Compatibles that show up in OF_DECLARE macros can't be expected to
71	# match a driver, except for the _DRIVER ones.
72	return parse_of_declare_macros(data, include_driver_macros=False)
73
74
75def print_compat(filename, compatibles):
76	if not compatibles:
77		return
78	if show_filename:
79		compat_str = ' '.join(compatibles)
80		print(filename + ": compatible(s): " + compat_str)
81	else:
82		print(*compatibles, sep='\n')
83
84def glob_without_symlinks(root, glob):
85	for path, dirs, files in os.walk(root):
86		# Ignore hidden directories
87		for d in dirs:
88			if fnmatch.fnmatch(d, ".*"):
89				dirs.remove(d)
90		for f in files:
91			if fnmatch.fnmatch(f, glob):
92				yield os.path.join(path, f)
93
94def files_to_parse(path_args):
95	for f in path_args:
96		if os.path.isdir(f):
97			for filename in glob_without_symlinks(f, "*.c"):
98				yield filename
99		else:
100			yield f
101
102show_filename = False
103
104if __name__ == "__main__":
105	ap = argparse.ArgumentParser()
106	ap.add_argument("cfile", type=str, nargs='*', help="C source files or directories to parse")
107	ap.add_argument('-H', '--with-filename', help="Print filename with compatibles", action="store_true")
108	ap.add_argument('-d', '--driver-match', help="Only print compatibles that should match to a driver", action="store_true")
109	args = ap.parse_args()
110
111	show_filename = args.with_filename
112	compat_ignore_list = None
113
114	if args.driver_match:
115		compat_ignore_list = []
116		for f in files_to_parse(args.cfile):
117			compat_ignore_list.extend(parse_compatibles_to_ignore(f))
118
119	for f in files_to_parse(args.cfile):
120		compat_list = parse_compatibles(f, compat_ignore_list)
121		print_compat(f, compat_list)
122