Kumar Gala | 87915cd | 2018-11-15 11:51:50 -0600 | [diff] [blame] | 1 | # Copyright (c) 2018-2019 Linaro |
Carles Cufi | fa26ef0 | 2019-01-30 17:54:21 +0100 | [diff] [blame] | 2 | # Copyright (c) 2019 Nordic Semiconductor ASA |
Kumar Gala | 87915cd | 2018-11-15 11:51:50 -0600 | [diff] [blame] | 3 | # |
| 4 | # SPDX-License-Identifier: Apache-2.0 |
| 5 | |
Keith Short | df0942f | 2023-03-24 15:22:42 -0600 | [diff] [blame] | 6 | import inspect |
Kumar Gala | 87915cd | 2018-11-15 11:51:50 -0600 | [diff] [blame] | 7 | import os |
Martí Bolívar | 269f350 | 2020-07-01 12:17:02 -0700 | [diff] [blame] | 8 | import pickle |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 9 | import sys |
Henrik Brix Andersen | c6b3094 | 2022-05-18 17:35:23 +0200 | [diff] [blame] | 10 | from pathlib import Path |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 11 | |
Henrik Brix Andersen | c6b3094 | 2022-05-18 17:35:23 +0200 | [diff] [blame] | 12 | ZEPHYR_BASE = str(Path(__file__).resolve().parents[2]) |
Martí Bolívar | 5332847 | 2021-03-26 16:18:58 -0700 | [diff] [blame] | 13 | sys.path.insert(0, os.path.join(ZEPHYR_BASE, "scripts", "dts", |
| 14 | "python-devicetree", "src")) |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 15 | |
Kumar Gala | 87915cd | 2018-11-15 11:51:50 -0600 | [diff] [blame] | 16 | # Types we support |
| 17 | # 'string', 'int', 'hex', 'bool' |
| 18 | |
Carles Cufi | fa26ef0 | 2019-01-30 17:54:21 +0100 | [diff] [blame] | 19 | doc_mode = os.environ.get('KCONFIG_DOC_MODE') == "1" |
Sebastian Bøe | cd43543 | 2019-02-11 15:57:34 +0100 | [diff] [blame] | 20 | |
Ulf Magnusson | ba312fe | 2019-03-20 19:30:29 +0100 | [diff] [blame] | 21 | if not doc_mode: |
Martí Bolívar | 269f350 | 2020-07-01 12:17:02 -0700 | [diff] [blame] | 22 | EDT_PICKLE = os.environ.get("EDT_PICKLE") |
Kumar Gala | 9aefdaf | 2020-04-15 10:32:41 -0500 | [diff] [blame] | 23 | |
Martí Bolívar | 269f350 | 2020-07-01 12:17:02 -0700 | [diff] [blame] | 24 | # The "if" handles a missing dts. |
| 25 | if EDT_PICKLE is not None and os.path.isfile(EDT_PICKLE): |
| 26 | with open(EDT_PICKLE, 'rb') as f: |
| 27 | edt = pickle.load(f) |
Keith Short | df0942f | 2023-03-24 15:22:42 -0600 | [diff] [blame] | 28 | edtlib = inspect.getmodule(edt) |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 29 | else: |
| 30 | edt = None |
| 31 | |
Kumar Gala | 1baf2f3 | 2019-09-04 14:14:26 -0500 | [diff] [blame] | 32 | |
| 33 | def _warn(kconf, msg): |
| 34 | print("{}:{}: WARNING: {}".format(kconf.filename, kconf.linenr, msg)) |
| 35 | |
| 36 | |
Kumar Gala | 87915cd | 2018-11-15 11:51:50 -0600 | [diff] [blame] | 37 | def _dt_units_to_scale(unit): |
| 38 | if not unit: |
| 39 | return 0 |
| 40 | if unit in {'k', 'K'}: |
| 41 | return 10 |
| 42 | if unit in {'m', 'M'}: |
| 43 | return 20 |
| 44 | if unit in {'g', 'G'}: |
| 45 | return 30 |
Daniel DeGrasse | 6064da8 | 2022-05-25 17:38:59 -0500 | [diff] [blame] | 46 | if unit in {'kb', 'Kb'}: |
| 47 | return 13 |
| 48 | if unit in {'mb', 'Mb'}: |
| 49 | return 23 |
| 50 | if unit in {'gb', 'Gb'}: |
| 51 | return 33 |
Kumar Gala | 87915cd | 2018-11-15 11:51:50 -0600 | [diff] [blame] | 52 | |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 53 | |
| 54 | def dt_chosen_label(kconf, _, chosen): |
| 55 | """ |
| 56 | This function takes a 'chosen' property and treats that property as a path |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 57 | to an EDT node. If it finds an EDT node, it will look to see if that node |
Martí Bolívar | b3151bc | 2022-08-18 16:13:50 -0700 | [diff] [blame] | 58 | has a "label" property and return the value of that "label". If not, we |
| 59 | return the node's name in the devicetree. |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 60 | """ |
| 61 | if doc_mode or edt is None: |
| 62 | return "" |
| 63 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 64 | node = edt.chosen_node(chosen) |
| 65 | if not node: |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 66 | return "" |
| 67 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 68 | if "label" not in node.props: |
Kumar Gala | 5753826 | 2022-08-04 11:23:13 -0500 | [diff] [blame] | 69 | return node.name |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 70 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 71 | return node.props["label"].val |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 72 | |
| 73 | |
Kumar Gala | 07e5d89 | 2019-11-04 10:20:59 -0600 | [diff] [blame] | 74 | def dt_chosen_enabled(kconf, _, chosen): |
| 75 | """ |
| 76 | This function returns "y" if /chosen contains a property named 'chosen' |
| 77 | that points to an enabled node, and "n" otherwise |
| 78 | """ |
| 79 | if doc_mode or edt is None: |
| 80 | return "n" |
| 81 | |
| 82 | node = edt.chosen_node(chosen) |
Martí Bolívar | 8165008 | 2020-10-05 20:02:13 -0700 | [diff] [blame] | 83 | return "y" if node and node.status == "okay" else "n" |
Kumar Gala | 07e5d89 | 2019-11-04 10:20:59 -0600 | [diff] [blame] | 84 | |
Kumar Gala | 0353d22 | 2020-02-13 23:43:42 -0600 | [diff] [blame] | 85 | |
Martí Bolívar | 7ff3ebc | 2020-04-23 12:28:06 -0700 | [diff] [blame] | 86 | def dt_chosen_path(kconf, _, chosen): |
| 87 | """ |
| 88 | This function takes a /chosen node property and returns the path |
| 89 | to the node in the property value, or the empty string. |
| 90 | """ |
| 91 | if doc_mode or edt is None: |
| 92 | return "n" |
| 93 | |
| 94 | node = edt.chosen_node(chosen) |
| 95 | |
| 96 | return node.path if node else "" |
| 97 | |
Daniel DeGrasse | fbefc50 | 2022-04-11 11:53:03 -0500 | [diff] [blame] | 98 | def dt_chosen_has_compat(kconf, _, chosen, compat): |
| 99 | """ |
| 100 | This function takes a /chosen node property and returns 'y' if the |
| 101 | chosen node has the provided compatible string 'compat' |
| 102 | """ |
| 103 | if doc_mode or edt is None: |
| 104 | return "n" |
| 105 | |
| 106 | node = edt.chosen_node(chosen) |
| 107 | |
| 108 | if node is None: |
| 109 | return "n" |
| 110 | |
| 111 | if compat in node.compats: |
| 112 | return "y" |
| 113 | |
| 114 | return "n" |
Martí Bolívar | 7ff3ebc | 2020-04-23 12:28:06 -0700 | [diff] [blame] | 115 | |
Martí Bolívar | 24677f9 | 2020-04-28 16:52:35 -0700 | [diff] [blame] | 116 | def dt_node_enabled(kconf, name, node): |
| 117 | """ |
| 118 | This function is used to test if a node is enabled (has status |
| 119 | 'okay') or not. |
| 120 | |
| 121 | The 'node' argument is a string which is either a path or an |
| 122 | alias, or both, depending on 'name'. |
| 123 | |
| 124 | If 'name' is 'dt_path_enabled', 'node' is an alias or a path. If |
| 125 | 'name' is 'dt_alias_enabled, 'node' is an alias. |
| 126 | """ |
| 127 | |
| 128 | if doc_mode or edt is None: |
| 129 | return "n" |
| 130 | |
| 131 | if name == "dt_alias_enabled": |
| 132 | if node.startswith("/"): |
| 133 | # EDT.get_node() works with either aliases or paths. If we |
| 134 | # are specifically being asked about an alias, reject paths. |
| 135 | return "n" |
| 136 | else: |
| 137 | # Make sure this is being called appropriately. |
| 138 | assert name == "dt_path_enabled" |
| 139 | |
| 140 | try: |
| 141 | node = edt.get_node(node) |
| 142 | except edtlib.EDTError: |
| 143 | return "n" |
| 144 | |
Martí Bolívar | 8165008 | 2020-10-05 20:02:13 -0700 | [diff] [blame] | 145 | return "y" if node and node.status == "okay" else "n" |
Martí Bolívar | 24677f9 | 2020-04-28 16:52:35 -0700 | [diff] [blame] | 146 | |
| 147 | |
Kumar Gala | 0353d22 | 2020-02-13 23:43:42 -0600 | [diff] [blame] | 148 | def dt_nodelabel_enabled(kconf, _, label): |
| 149 | """ |
Martí Bolívar | 24677f9 | 2020-04-28 16:52:35 -0700 | [diff] [blame] | 150 | This function is like dt_node_enabled(), but the 'label' argument |
| 151 | should be a node label, like "foo" is here: |
| 152 | |
| 153 | foo: some-node { ... }; |
Kumar Gala | 0353d22 | 2020-02-13 23:43:42 -0600 | [diff] [blame] | 154 | """ |
| 155 | if doc_mode or edt is None: |
| 156 | return "n" |
| 157 | |
Martí Bolívar | 0682c46 | 2020-04-22 17:59:23 -0700 | [diff] [blame] | 158 | node = edt.label2node.get(label) |
Kumar Gala | 0353d22 | 2020-02-13 23:43:42 -0600 | [diff] [blame] | 159 | |
Martí Bolívar | 8165008 | 2020-10-05 20:02:13 -0700 | [diff] [blame] | 160 | return "y" if node and node.status == "okay" else "n" |
Kumar Gala | 0353d22 | 2020-02-13 23:43:42 -0600 | [diff] [blame] | 161 | |
| 162 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 163 | def _node_reg_addr(node, index, unit): |
| 164 | if not node: |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 165 | return 0 |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 166 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 167 | if not node.regs: |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 168 | return 0 |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 169 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 170 | if int(index) >= len(node.regs): |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 171 | return 0 |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 172 | |
Kumar Gala | 8af311a | 2020-03-13 12:43:56 -0500 | [diff] [blame] | 173 | if node.regs[int(index)].addr is None: |
| 174 | return 0 |
| 175 | |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 176 | return node.regs[int(index)].addr >> _dt_units_to_scale(unit) |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 177 | |
| 178 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 179 | def _node_reg_size(node, index, unit): |
| 180 | if not node: |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 181 | return 0 |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 182 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 183 | if not node.regs: |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 184 | return 0 |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 185 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 186 | if int(index) >= len(node.regs): |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 187 | return 0 |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 188 | |
Kumar Gala | 8af311a | 2020-03-13 12:43:56 -0500 | [diff] [blame] | 189 | if node.regs[int(index)].size is None: |
| 190 | return 0 |
| 191 | |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 192 | return node.regs[int(index)].size >> _dt_units_to_scale(unit) |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 193 | |
| 194 | |
David Leach | 1e5a830 | 2021-11-08 23:24:22 -0600 | [diff] [blame] | 195 | def _node_int_prop(node, prop, unit=None): |
| 196 | """ |
| 197 | This function takes a 'node' and will look to see if that 'node' has a |
| 198 | property called 'prop' and if that 'prop' is an integer type will return |
| 199 | the value of the property 'prop' as either a string int or string hex |
| 200 | value, if not we return 0. |
| 201 | |
| 202 | The function will divide the value based on 'unit': |
| 203 | None No division |
| 204 | 'k' or 'K' divide by 1024 (1 << 10) |
| 205 | 'm' or 'M' divide by 1,048,576 (1 << 20) |
| 206 | 'g' or 'G' divide by 1,073,741,824 (1 << 30) |
Daniel DeGrasse | 6064da8 | 2022-05-25 17:38:59 -0500 | [diff] [blame] | 207 | 'kb' or 'Kb' divide by 8192 (1 << 13) |
| 208 | 'mb' or 'Mb' divide by 8,388,608 (1 << 23) |
| 209 | 'gb' or 'Gb' divide by 8,589,934,592 (1 << 33) |
David Leach | 1e5a830 | 2021-11-08 23:24:22 -0600 | [diff] [blame] | 210 | """ |
Kumar Gala | 338b4319 | 2020-04-03 05:02:35 -0500 | [diff] [blame] | 211 | if not node: |
| 212 | return 0 |
| 213 | |
| 214 | if prop not in node.props: |
| 215 | return 0 |
| 216 | |
| 217 | if node.props[prop].type != "int": |
| 218 | return 0 |
| 219 | |
David Leach | 1e5a830 | 2021-11-08 23:24:22 -0600 | [diff] [blame] | 220 | return node.props[prop].val >> _dt_units_to_scale(unit) |
Kumar Gala | 338b4319 | 2020-04-03 05:02:35 -0500 | [diff] [blame] | 221 | |
| 222 | |
Eivind Jølsgard | 3865e08 | 2022-03-18 10:50:00 +0100 | [diff] [blame] | 223 | def _node_array_prop(node, prop, index=0, unit=None): |
| 224 | """ |
| 225 | This function takes a 'node' and will look to see if that 'node' has a |
| 226 | property called 'prop' and if that 'prop' is an array type will return |
| 227 | the value of the property 'prop' at the given 'index' as either a string int |
| 228 | or string hex value. If the property 'prop' is not found or the given 'index' |
| 229 | is out of range it will return 0. |
| 230 | |
| 231 | The function will divide the value based on 'unit': |
| 232 | None No division |
| 233 | 'k' or 'K' divide by 1024 (1 << 10) |
| 234 | 'm' or 'M' divide by 1,048,576 (1 << 20) |
| 235 | 'g' or 'G' divide by 1,073,741,824 (1 << 30) |
| 236 | """ |
| 237 | if not node: |
| 238 | return 0 |
| 239 | |
| 240 | if prop not in node.props: |
| 241 | return 0 |
| 242 | if node.props[prop].type != "array": |
| 243 | return 0 |
| 244 | if int(index) >= len(node.props[prop].val): |
| 245 | return 0 |
| 246 | return node.props[prop].val[int(index)] >> _dt_units_to_scale(unit) |
| 247 | |
| 248 | |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 249 | def _dt_chosen_reg_addr(kconf, chosen, index=0, unit=None): |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 250 | """ |
| 251 | This function takes a 'chosen' property and treats that property as a path |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 252 | to an EDT node. If it finds an EDT node, it will look to see if that |
Nazar Kazakov | f483b1b | 2022-03-16 21:07:43 +0000 | [diff] [blame] | 253 | node has a register at the given 'index' and return the address value of |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 254 | that reg, if not we return 0. |
| 255 | |
| 256 | The function will divide the value based on 'unit': |
| 257 | None No division |
| 258 | 'k' or 'K' divide by 1024 (1 << 10) |
| 259 | 'm' or 'M' divide by 1,048,576 (1 << 20) |
| 260 | 'g' or 'G' divide by 1,073,741,824 (1 << 30) |
Daniel DeGrasse | 6064da8 | 2022-05-25 17:38:59 -0500 | [diff] [blame] | 261 | 'kb' or 'Kb' divide by 8192 (1 << 13) |
| 262 | 'mb' or 'Mb' divide by 8,388,608 (1 << 23) |
| 263 | 'gb' or 'Gb' divide by 8,589,934,592 (1 << 33) |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 264 | """ |
| 265 | if doc_mode or edt is None: |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 266 | return 0 |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 267 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 268 | node = edt.chosen_node(chosen) |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 269 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 270 | return _node_reg_addr(node, index, unit) |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 271 | |
| 272 | |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 273 | def _dt_chosen_reg_size(kconf, chosen, index=0, unit=None): |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 274 | """ |
| 275 | This function takes a 'chosen' property and treats that property as a path |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 276 | to an EDT node. If it finds an EDT node, it will look to see if that node |
| 277 | has a register at the given 'index' and return the size value of that reg, |
| 278 | if not we return 0. |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 279 | |
| 280 | The function will divide the value based on 'unit': |
| 281 | None No division |
| 282 | 'k' or 'K' divide by 1024 (1 << 10) |
| 283 | 'm' or 'M' divide by 1,048,576 (1 << 20) |
| 284 | 'g' or 'G' divide by 1,073,741,824 (1 << 30) |
Daniel DeGrasse | 6064da8 | 2022-05-25 17:38:59 -0500 | [diff] [blame] | 285 | 'kb' or 'Kb' divide by 8192 (1 << 13) |
| 286 | 'mb' or 'Mb' divide by 8,388,608 (1 << 23) |
| 287 | 'gb' or 'Gb' divide by 8,589,934,592 (1 << 33) |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 288 | """ |
| 289 | if doc_mode or edt is None: |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 290 | return 0 |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 291 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 292 | node = edt.chosen_node(chosen) |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 293 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 294 | return _node_reg_size(node, index, unit) |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 295 | |
| 296 | |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 297 | def dt_chosen_reg(kconf, name, chosen, index=0, unit=None): |
| 298 | """ |
| 299 | This function just routes to the proper function and converts |
| 300 | the result to either a string int or string hex value. |
| 301 | """ |
| 302 | if name == "dt_chosen_reg_size_int": |
| 303 | return str(_dt_chosen_reg_size(kconf, chosen, index, unit)) |
| 304 | if name == "dt_chosen_reg_size_hex": |
| 305 | return hex(_dt_chosen_reg_size(kconf, chosen, index, unit)) |
| 306 | if name == "dt_chosen_reg_addr_int": |
| 307 | return str(_dt_chosen_reg_addr(kconf, chosen, index, unit)) |
| 308 | if name == "dt_chosen_reg_addr_hex": |
| 309 | return hex(_dt_chosen_reg_addr(kconf, chosen, index, unit)) |
| 310 | |
| 311 | |
| 312 | def _dt_node_reg_addr(kconf, path, index=0, unit=None): |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 313 | """ |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 314 | This function takes a 'path' and looks for an EDT node at that path. If it |
| 315 | finds an EDT node, it will look to see if that node has a register at the |
| 316 | given 'index' and return the address value of that reg, if not we return 0. |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 317 | |
| 318 | The function will divide the value based on 'unit': |
| 319 | None No division |
| 320 | 'k' or 'K' divide by 1024 (1 << 10) |
| 321 | 'm' or 'M' divide by 1,048,576 (1 << 20) |
| 322 | 'g' or 'G' divide by 1,073,741,824 (1 << 30) |
Daniel DeGrasse | 6064da8 | 2022-05-25 17:38:59 -0500 | [diff] [blame] | 323 | 'kb' or 'Kb' divide by 8192 (1 << 13) |
| 324 | 'mb' or 'Mb' divide by 8,388,608 (1 << 23) |
| 325 | 'gb' or 'Gb' divide by 8,589,934,592 (1 << 33) |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 326 | """ |
| 327 | if doc_mode or edt is None: |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 328 | return 0 |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 329 | |
| 330 | try: |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 331 | node = edt.get_node(path) |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 332 | except edtlib.EDTError: |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 333 | return 0 |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 334 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 335 | return _node_reg_addr(node, index, unit) |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 336 | |
| 337 | |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 338 | def _dt_node_reg_size(kconf, path, index=0, unit=None): |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 339 | """ |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 340 | This function takes a 'path' and looks for an EDT node at that path. If it |
| 341 | finds an EDT node, it will look to see if that node has a register at the |
| 342 | given 'index' and return the size value of that reg, if not we return 0. |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 343 | |
| 344 | The function will divide the value based on 'unit': |
| 345 | None No division |
| 346 | 'k' or 'K' divide by 1024 (1 << 10) |
| 347 | 'm' or 'M' divide by 1,048,576 (1 << 20) |
| 348 | 'g' or 'G' divide by 1,073,741,824 (1 << 30) |
Daniel DeGrasse | 6064da8 | 2022-05-25 17:38:59 -0500 | [diff] [blame] | 349 | 'kb' or 'Kb' divide by 8192 (1 << 13) |
| 350 | 'mb' or 'Mb' divide by 8,388,608 (1 << 23) |
| 351 | 'gb' or 'Gb' divide by 8,589,934,592 (1 << 33) |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 352 | """ |
| 353 | if doc_mode or edt is None: |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 354 | return 0 |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 355 | |
| 356 | try: |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 357 | node = edt.get_node(path) |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 358 | except edtlib.EDTError: |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 359 | return 0 |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 360 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 361 | return _node_reg_size(node, index, unit) |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 362 | |
| 363 | |
Kumar Gala | 22e7449 | 2019-10-23 15:15:59 -0500 | [diff] [blame] | 364 | def dt_node_reg(kconf, name, path, index=0, unit=None): |
| 365 | """ |
| 366 | This function just routes to the proper function and converts |
| 367 | the result to either a string int or string hex value. |
| 368 | """ |
| 369 | if name == "dt_node_reg_size_int": |
| 370 | return str(_dt_node_reg_size(kconf, path, index, unit)) |
| 371 | if name == "dt_node_reg_size_hex": |
| 372 | return hex(_dt_node_reg_size(kconf, path, index, unit)) |
| 373 | if name == "dt_node_reg_addr_int": |
| 374 | return str(_dt_node_reg_addr(kconf, path, index, unit)) |
| 375 | if name == "dt_node_reg_addr_hex": |
| 376 | return hex(_dt_node_reg_addr(kconf, path, index, unit)) |
| 377 | |
Jordan Yates | 999afdc | 2023-07-30 13:33:33 +1000 | [diff] [blame] | 378 | def dt_nodelabel_reg(kconf, name, label, index=0, unit=None): |
| 379 | """ |
| 380 | This function is like dt_node_reg(), but the 'label' argument |
| 381 | should be a node label, like "foo" is here: |
| 382 | |
| 383 | foo: some-node { ... }; |
| 384 | """ |
| 385 | if doc_mode or edt is None: |
| 386 | node = None |
| 387 | else: |
| 388 | node = edt.label2node.get(label) |
| 389 | |
| 390 | if name == "dt_nodelabel_reg_size_int": |
| 391 | return str(_dt_node_reg_size(kconf, node.path, index, unit)) if node else "0" |
| 392 | if name == "dt_nodelabel_reg_size_hex": |
| 393 | return hex(_dt_node_reg_size(kconf, node.path, index, unit)) if node else "0x0" |
| 394 | if name == "dt_nodelabel_reg_addr_int": |
| 395 | return str(_dt_node_reg_addr(kconf, node.path, index, unit)) if node else "0" |
| 396 | if name == "dt_nodelabel_reg_addr_hex": |
| 397 | return hex(_dt_node_reg_addr(kconf, node.path, index, unit)) if node else "0x0" |
| 398 | |
| 399 | |
Michał Barnaś | a1ab8da | 2022-03-08 17:44:04 +0100 | [diff] [blame] | 400 | def _dt_node_bool_prop_generic(node_search_function, search_arg, prop): |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 401 | """ |
Michał Barnaś | a1ab8da | 2022-03-08 17:44:04 +0100 | [diff] [blame] | 402 | This function takes the 'node_search_function' and uses it to search for |
| 403 | a node with 'search_arg' and if node exists, checks if 'prop' exists |
| 404 | inside the node and is a boolean, if it is true, returns "y". |
| 405 | Otherwise, it returns "n". |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 406 | """ |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 407 | try: |
Michał Barnaś | a1ab8da | 2022-03-08 17:44:04 +0100 | [diff] [blame] | 408 | node = node_search_function(search_arg) |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 409 | except edtlib.EDTError: |
| 410 | return "n" |
| 411 | |
Andrzej Głąbek | 2399433 | 2022-03-23 14:45:11 +0100 | [diff] [blame] | 412 | if node is None: |
| 413 | return "n" |
| 414 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 415 | if prop not in node.props: |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 416 | return "n" |
| 417 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 418 | if node.props[prop].type != "boolean": |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 419 | return "n" |
| 420 | |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 421 | if node.props[prop].val: |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 422 | return "y" |
| 423 | |
| 424 | return "n" |
| 425 | |
Michał Barnaś | a1ab8da | 2022-03-08 17:44:04 +0100 | [diff] [blame] | 426 | def dt_node_bool_prop(kconf, _, path, prop): |
Erwan Gouriou | b711028 | 2021-01-07 12:06:31 +0100 | [diff] [blame] | 427 | """ |
Michał Barnaś | a1ab8da | 2022-03-08 17:44:04 +0100 | [diff] [blame] | 428 | This function takes a 'path' and looks for an EDT node at that path. If it |
| 429 | finds an EDT node, it will look to see if that node has a boolean property |
Erwan Gouriou | b711028 | 2021-01-07 12:06:31 +0100 | [diff] [blame] | 430 | by the name of 'prop'. If the 'prop' exists it will return "y" otherwise |
| 431 | we return "n". |
| 432 | """ |
Erwan Gouriou | b711028 | 2021-01-07 12:06:31 +0100 | [diff] [blame] | 433 | if doc_mode or edt is None: |
| 434 | return "n" |
| 435 | |
Michał Barnaś | a1ab8da | 2022-03-08 17:44:04 +0100 | [diff] [blame] | 436 | return _dt_node_bool_prop_generic(edt.get_node, path, prop) |
| 437 | |
| 438 | def dt_nodelabel_bool_prop(kconf, _, label, prop): |
| 439 | """ |
| 440 | This function takes a 'label' and looks for an EDT node with that label. |
| 441 | If it finds an EDT node, it will look to see if that node has a boolean |
| 442 | property by the name of 'prop'. If the 'prop' exists it will return "y" |
| 443 | otherwise we return "n". |
| 444 | """ |
| 445 | if doc_mode or edt is None: |
| 446 | return "n" |
| 447 | |
| 448 | return _dt_node_bool_prop_generic(edt.label2node.get, label, prop) |
| 449 | |
Stephen Stauts | d4b8db7 | 2022-12-27 11:40:17 +0100 | [diff] [blame] | 450 | def dt_chosen_bool_prop(kconf, _, chosen, prop): |
| 451 | """ |
| 452 | This function takes a /chosen node property named 'chosen', and |
| 453 | looks for the chosen node. If that node exists and has a boolean |
| 454 | property 'prop', it returns "y". Otherwise, it returns "n". |
| 455 | """ |
| 456 | if doc_mode or edt is None: |
| 457 | return "n" |
| 458 | |
| 459 | return _dt_node_bool_prop_generic(edt.chosen_node, chosen, prop) |
| 460 | |
Michał Barnaś | a1ab8da | 2022-03-08 17:44:04 +0100 | [diff] [blame] | 461 | def _dt_node_has_prop_generic(node_search_function, search_arg, prop): |
| 462 | """ |
| 463 | This function takes the 'node_search_function' and uses it to search for |
| 464 | a node with 'search_arg' and if node exists, then checks if 'prop' |
| 465 | exists inside the node and returns "y". Otherwise, it returns "n". |
| 466 | """ |
Erwan Gouriou | b711028 | 2021-01-07 12:06:31 +0100 | [diff] [blame] | 467 | try: |
Michał Barnaś | a1ab8da | 2022-03-08 17:44:04 +0100 | [diff] [blame] | 468 | node = node_search_function(search_arg) |
Erwan Gouriou | b711028 | 2021-01-07 12:06:31 +0100 | [diff] [blame] | 469 | except edtlib.EDTError: |
| 470 | return "n" |
| 471 | |
| 472 | if node is None: |
| 473 | return "n" |
| 474 | |
| 475 | if prop in node.props: |
| 476 | return "y" |
| 477 | |
| 478 | return "n" |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 479 | |
Michał Barnaś | a1ab8da | 2022-03-08 17:44:04 +0100 | [diff] [blame] | 480 | def dt_node_has_prop(kconf, _, path, prop): |
| 481 | """ |
| 482 | This function takes a 'path' and looks for an EDT node at that path. If it |
| 483 | finds an EDT node, it will look to see if that node has a property |
| 484 | by the name of 'prop'. If the 'prop' exists it will return "y" otherwise |
| 485 | it returns "n". |
| 486 | """ |
| 487 | if doc_mode or edt is None: |
| 488 | return "n" |
| 489 | |
| 490 | return _dt_node_has_prop_generic(edt.get_node, path, prop) |
| 491 | |
| 492 | def dt_nodelabel_has_prop(kconf, _, label, prop): |
| 493 | """ |
| 494 | This function takes a 'label' and looks for an EDT node with that label. |
| 495 | If it finds an EDT node, it will look to see if that node has a property |
| 496 | by the name of 'prop'. If the 'prop' exists it will return "y" otherwise |
| 497 | it returns "n". |
| 498 | """ |
| 499 | if doc_mode or edt is None: |
| 500 | return "n" |
| 501 | |
| 502 | return _dt_node_has_prop_generic(edt.label2node.get, label, prop) |
| 503 | |
David Leach | 1e5a830 | 2021-11-08 23:24:22 -0600 | [diff] [blame] | 504 | def dt_node_int_prop(kconf, name, path, prop, unit=None): |
Kumar Gala | 338b4319 | 2020-04-03 05:02:35 -0500 | [diff] [blame] | 505 | """ |
| 506 | This function takes a 'path' and property name ('prop') looks for an EDT |
| 507 | node at that path. If it finds an EDT node, it will look to see if that |
| 508 | node has a property called 'prop' and if that 'prop' is an integer type |
| 509 | will return the value of the property 'prop' as either a string int or |
| 510 | string hex value, if not we return 0. |
Kumar Gala | 338b4319 | 2020-04-03 05:02:35 -0500 | [diff] [blame] | 511 | |
David Leach | 1e5a830 | 2021-11-08 23:24:22 -0600 | [diff] [blame] | 512 | The function will divide the value based on 'unit': |
| 513 | None No division |
| 514 | 'k' or 'K' divide by 1024 (1 << 10) |
| 515 | 'm' or 'M' divide by 1,048,576 (1 << 20) |
| 516 | 'g' or 'G' divide by 1,073,741,824 (1 << 30) |
Daniel DeGrasse | 6064da8 | 2022-05-25 17:38:59 -0500 | [diff] [blame] | 517 | 'kb' or 'Kb' divide by 8192 (1 << 13) |
| 518 | 'mb' or 'Mb' divide by 8,388,608 (1 << 23) |
| 519 | 'gb' or 'Gb' divide by 8,589,934,592 (1 << 33) |
David Leach | 1e5a830 | 2021-11-08 23:24:22 -0600 | [diff] [blame] | 520 | """ |
Kumar Gala | 338b4319 | 2020-04-03 05:02:35 -0500 | [diff] [blame] | 521 | if doc_mode or edt is None: |
| 522 | return "0" |
| 523 | |
| 524 | try: |
| 525 | node = edt.get_node(path) |
| 526 | except edtlib.EDTError: |
| 527 | return "0" |
| 528 | |
| 529 | if name == "dt_node_int_prop_int": |
David Leach | 1e5a830 | 2021-11-08 23:24:22 -0600 | [diff] [blame] | 530 | return str(_node_int_prop(node, prop, unit)) |
Kumar Gala | 338b4319 | 2020-04-03 05:02:35 -0500 | [diff] [blame] | 531 | if name == "dt_node_int_prop_hex": |
David Leach | 1e5a830 | 2021-11-08 23:24:22 -0600 | [diff] [blame] | 532 | return hex(_node_int_prop(node, prop, unit)) |
Kumar Gala | 338b4319 | 2020-04-03 05:02:35 -0500 | [diff] [blame] | 533 | |
Eivind Jølsgard | 3865e08 | 2022-03-18 10:50:00 +0100 | [diff] [blame] | 534 | |
| 535 | def dt_node_array_prop(kconf, name, path, prop, index, unit=None): |
| 536 | """ |
| 537 | This function takes a 'path', property name ('prop') and index ('index') |
| 538 | and looks for an EDT node at that path. If it finds an EDT node, it will |
| 539 | look to see if that node has a property called 'prop' and if that 'prop' |
| 540 | is an array type will return the value of the property 'prop' at the given |
| 541 | 'index' as either a string int or string hex value. If not found we return 0. |
| 542 | |
| 543 | The function will divide the value based on 'unit': |
| 544 | None No division |
| 545 | 'k' or 'K' divide by 1024 (1 << 10) |
| 546 | 'm' or 'M' divide by 1,048,576 (1 << 20) |
| 547 | 'g' or 'G' divide by 1,073,741,824 (1 << 30) |
| 548 | """ |
| 549 | if doc_mode or edt is None: |
| 550 | return "0" |
| 551 | |
| 552 | try: |
| 553 | node = edt.get_node(path) |
| 554 | except edtlib.EDTError: |
| 555 | return "0" |
| 556 | if name == "dt_node_array_prop_int": |
| 557 | return str(_node_array_prop(node, prop, index, unit)) |
| 558 | if name == "dt_node_array_prop_hex": |
| 559 | return hex(_node_array_prop(node, prop, index, unit)) |
| 560 | |
| 561 | |
Johann Fischer | 73199f2 | 2021-11-18 17:12:23 +0100 | [diff] [blame] | 562 | def dt_node_str_prop_equals(kconf, _, path, prop, val): |
| 563 | """ |
| 564 | This function takes a 'path' and property name ('prop') looks for an EDT |
| 565 | node at that path. If it finds an EDT node, it will look to see if that |
| 566 | node has a property 'prop' of type string. If that 'prop' is equal to 'val' |
| 567 | it will return "y" otherwise return "n". |
| 568 | """ |
| 569 | |
| 570 | if doc_mode or edt is None: |
| 571 | return "n" |
| 572 | |
| 573 | try: |
| 574 | node = edt.get_node(path) |
| 575 | except edtlib.EDTError: |
| 576 | return "n" |
| 577 | |
| 578 | if prop not in node.props: |
| 579 | return "n" |
| 580 | |
| 581 | if node.props[prop].type != "string": |
| 582 | return "n" |
| 583 | |
| 584 | if node.props[prop].val == val: |
| 585 | return "y" |
| 586 | |
| 587 | return "n" |
Kumar Gala | 338b4319 | 2020-04-03 05:02:35 -0500 | [diff] [blame] | 588 | |
Andrzej Głąbek | 9f2a27b | 2022-03-15 14:08:21 +0100 | [diff] [blame] | 589 | |
| 590 | def dt_has_compat(kconf, _, compat): |
| 591 | """ |
| 592 | This function takes a 'compat' and returns "y" if any compatible node |
| 593 | can be found in the EDT, otherwise it returns "n". |
| 594 | """ |
| 595 | if doc_mode or edt is None: |
| 596 | return "n" |
| 597 | |
| 598 | return "y" if compat in edt.compat2nodes else "n" |
| 599 | |
| 600 | |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 601 | def dt_compat_enabled(kconf, _, compat): |
| 602 | """ |
Martí Bolívar | 8165008 | 2020-10-05 20:02:13 -0700 | [diff] [blame] | 603 | This function takes a 'compat' and returns "y" if we find a status "okay" |
Ulf Magnusson | 73ac146 | 2019-09-23 05:14:18 +0200 | [diff] [blame] | 604 | compatible node in the EDT otherwise we return "n" |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 605 | """ |
| 606 | if doc_mode or edt is None: |
| 607 | return "n" |
| 608 | |
Martí Bolívar | 8165008 | 2020-10-05 20:02:13 -0700 | [diff] [blame] | 609 | return "y" if compat in edt.compat2okay else "n" |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 610 | |
| 611 | |
Martí Bolívar | 3cd4f6c | 2020-04-10 15:37:58 -0700 | [diff] [blame] | 612 | def dt_compat_on_bus(kconf, _, compat, bus): |
| 613 | """ |
| 614 | This function takes a 'compat' and returns "y" if we find an "enabled" |
| 615 | compatible node in the EDT which is on bus 'bus'. It returns "n" otherwise. |
| 616 | """ |
| 617 | if doc_mode or edt is None: |
| 618 | return "n" |
| 619 | |
Andrzej Głąbek | f9c1f89 | 2021-02-03 13:53:48 +0100 | [diff] [blame] | 620 | if compat in edt.compat2okay: |
| 621 | for node in edt.compat2okay[compat]: |
Daniel Leung | 418c915 | 2022-08-26 10:52:32 -0700 | [diff] [blame] | 622 | if node.on_buses is not None and bus in node.on_buses: |
Andrzej Głąbek | f9c1f89 | 2021-02-03 13:53:48 +0100 | [diff] [blame] | 623 | return "y" |
Martí Bolívar | 3cd4f6c | 2020-04-10 15:37:58 -0700 | [diff] [blame] | 624 | |
| 625 | return "n" |
| 626 | |
| 627 | |
Andrzej Głąbek | 3331a20 | 2020-02-14 11:53:21 +0100 | [diff] [blame] | 628 | def dt_nodelabel_has_compat(kconf, _, label, compat): |
| 629 | """ |
Andrzej Głąbek | cd00a3a | 2022-03-28 12:16:51 +0200 | [diff] [blame] | 630 | This function takes a 'label' and looks for an EDT node with that label. |
| 631 | If it finds such node, it returns "y" if this node is compatible with |
| 632 | the provided 'compat'. Otherwise, it return "n" . |
| 633 | """ |
| 634 | if doc_mode or edt is None: |
| 635 | return "n" |
| 636 | |
| 637 | node = edt.label2node.get(label) |
| 638 | |
| 639 | if node and compat in node.compats: |
| 640 | return "y" |
| 641 | |
| 642 | return "n" |
| 643 | |
Daniel DeGrasse | 6aa7194 | 2022-08-26 12:12:24 -0500 | [diff] [blame] | 644 | def dt_node_has_compat(kconf, _, path, compat): |
| 645 | """ |
| 646 | This function takes a 'path' and looks for an EDT node at that path. If it |
| 647 | finds an EDT node, it returns "y" if this node is compatible with |
| 648 | the provided 'compat'. Otherwise, it return "n" . |
| 649 | """ |
| 650 | |
| 651 | if doc_mode or edt is None: |
| 652 | return "n" |
| 653 | |
| 654 | try: |
| 655 | node = edt.get_node(path) |
| 656 | except edtlib.EDTError: |
| 657 | return "n" |
| 658 | |
| 659 | if node and compat in node.compats: |
| 660 | return "y" |
| 661 | |
| 662 | return "n" |
Andrzej Głąbek | cd00a3a | 2022-03-28 12:16:51 +0200 | [diff] [blame] | 663 | |
| 664 | def dt_nodelabel_enabled_with_compat(kconf, _, label, compat): |
| 665 | """ |
Andrzej Głąbek | 3331a20 | 2020-02-14 11:53:21 +0100 | [diff] [blame] | 666 | This function takes a 'label' and returns "y" if an "enabled" node with |
| 667 | such label can be found in the EDT and that node is compatible with the |
| 668 | provided 'compat', otherwise it returns "n". |
| 669 | """ |
| 670 | if doc_mode or edt is None: |
| 671 | return "n" |
| 672 | |
Andrzej Głąbek | f9c1f89 | 2021-02-03 13:53:48 +0100 | [diff] [blame] | 673 | if compat in edt.compat2okay: |
| 674 | for node in edt.compat2okay[compat]: |
| 675 | if label in node.labels: |
| 676 | return "y" |
Andrzej Głąbek | 3331a20 | 2020-02-14 11:53:21 +0100 | [diff] [blame] | 677 | |
| 678 | return "n" |
| 679 | |
| 680 | |
Stephen Stauts | d4b8db7 | 2022-12-27 11:40:17 +0100 | [diff] [blame] | 681 | def dt_nodelabel_array_prop_has_val(kconf, _, label, prop, val): |
| 682 | """ |
| 683 | This function looks for a node with node label 'label'. |
| 684 | If the node exists, it checks if the node node has a property |
| 685 | 'prop' with type "array". If so, and the property contains |
| 686 | an element equal to the integer 'val', it returns "y". |
| 687 | Otherwise, it returns "n". |
| 688 | """ |
| 689 | if doc_mode or edt is None: |
| 690 | return "n" |
| 691 | |
| 692 | node = edt.label2node.get(label) |
| 693 | |
| 694 | if not node or (prop not in node.props) or (node.props[prop].type != "array"): |
| 695 | return "n" |
| 696 | else: |
| 697 | return "y" if int(val, base=0) in node.props[prop].val else "n" |
| 698 | |
| 699 | |
Martí Bolívar | 1fff235 | 2020-04-22 18:06:18 -0700 | [diff] [blame] | 700 | def dt_nodelabel_path(kconf, _, label): |
| 701 | """ |
| 702 | This function takes a node label (not a label property) and |
| 703 | returns the path to the node which has that label, or an empty |
| 704 | string if there is no such node. |
| 705 | """ |
| 706 | if doc_mode or edt is None: |
| 707 | return "" |
| 708 | |
| 709 | node = edt.label2node.get(label) |
| 710 | |
| 711 | return node.path if node else "" |
| 712 | |
Daniel DeGrasse | db9bcd9 | 2022-08-26 12:10:14 -0500 | [diff] [blame] | 713 | def dt_node_parent(kconf, _, path): |
| 714 | """ |
| 715 | This function takes a 'path' and looks for an EDT node at that path. If it |
| 716 | finds an EDT node, it will look for the parent of that node. If the parent |
| 717 | exists, it will return the path to that parent. Otherwise, an empty string |
| 718 | will be returned. |
| 719 | """ |
| 720 | if doc_mode or edt is None: |
| 721 | return "" |
| 722 | |
| 723 | try: |
| 724 | node = edt.get_node(path) |
| 725 | except edtlib.EDTError: |
| 726 | return "" |
| 727 | |
| 728 | if node is None: |
| 729 | return "" |
| 730 | |
| 731 | return node.parent.path if node.parent else "" |
Martí Bolívar | 1fff235 | 2020-04-22 18:06:18 -0700 | [diff] [blame] | 732 | |
Henrik Brix Andersen | fba6c7f | 2023-01-18 17:43:02 +0100 | [diff] [blame] | 733 | def dt_gpio_hogs_enabled(kconf, _): |
| 734 | """ |
| 735 | Return "y" if any GPIO hog node is enabled. Otherwise, return "n". |
| 736 | """ |
| 737 | if doc_mode or edt is None: |
| 738 | return "n" |
| 739 | |
| 740 | for node in edt.nodes: |
| 741 | if node.gpio_hogs and node.status == "okay": |
| 742 | return "y" |
| 743 | |
| 744 | return "n" |
| 745 | |
Erwan Gouriou | 17537c7 | 2019-11-22 10:06:57 +0100 | [diff] [blame] | 746 | def shields_list_contains(kconf, _, shield): |
| 747 | """ |
| 748 | Return "n" if cmake environment variable 'SHIELD_AS_LIST' doesn't exist. |
| 749 | Return "y" if 'shield' is present list obtained after 'SHIELD_AS_LIST' |
| 750 | has been split using ";" as a separator and "n" otherwise. |
| 751 | """ |
| 752 | try: |
| 753 | list = os.environ['SHIELD_AS_LIST'] |
| 754 | except KeyError: |
| 755 | return "n" |
| 756 | |
| 757 | return "y" if shield in list.split(";") else "n" |
| 758 | |
| 759 | |
Martí Bolívar | 006319f | 2020-07-21 15:20:18 -0700 | [diff] [blame] | 760 | # Keys in this dict are the function names as they appear |
| 761 | # in Kconfig files. The values are tuples in this form: |
| 762 | # |
| 763 | # (python_function, minimum_number_of_args, maximum_number_of_args) |
| 764 | # |
| 765 | # Each python function is given a kconf object and its name in the |
| 766 | # Kconfig file, followed by arguments from the Kconfig file. |
| 767 | # |
| 768 | # See the kconfiglib documentation for more details. |
Kumar Gala | 87915cd | 2018-11-15 11:51:50 -0600 | [diff] [blame] | 769 | functions = { |
Andrzej Głąbek | 9f2a27b | 2022-03-15 14:08:21 +0100 | [diff] [blame] | 770 | "dt_has_compat": (dt_has_compat, 1, 1), |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 771 | "dt_compat_enabled": (dt_compat_enabled, 1, 1), |
Martí Bolívar | 3cd4f6c | 2020-04-10 15:37:58 -0700 | [diff] [blame] | 772 | "dt_compat_on_bus": (dt_compat_on_bus, 2, 2), |
Kumar Gala | 5735397 | 2019-08-28 09:30:23 -0500 | [diff] [blame] | 773 | "dt_chosen_label": (dt_chosen_label, 1, 1), |
Kumar Gala | 07e5d89 | 2019-11-04 10:20:59 -0600 | [diff] [blame] | 774 | "dt_chosen_enabled": (dt_chosen_enabled, 1, 1), |
Martí Bolívar | 7ff3ebc | 2020-04-23 12:28:06 -0700 | [diff] [blame] | 775 | "dt_chosen_path": (dt_chosen_path, 1, 1), |
Daniel DeGrasse | fbefc50 | 2022-04-11 11:53:03 -0500 | [diff] [blame] | 776 | "dt_chosen_has_compat": (dt_chosen_has_compat, 2, 2), |
Martí Bolívar | 24677f9 | 2020-04-28 16:52:35 -0700 | [diff] [blame] | 777 | "dt_path_enabled": (dt_node_enabled, 1, 1), |
| 778 | "dt_alias_enabled": (dt_node_enabled, 1, 1), |
Kumar Gala | 0353d22 | 2020-02-13 23:43:42 -0600 | [diff] [blame] | 779 | "dt_nodelabel_enabled": (dt_nodelabel_enabled, 1, 1), |
Andrzej Głąbek | cd00a3a | 2022-03-28 12:16:51 +0200 | [diff] [blame] | 780 | "dt_nodelabel_enabled_with_compat": (dt_nodelabel_enabled_with_compat, 2, 2), |
Ulf Magnusson | b4e1807 | 2019-12-23 11:07:27 +0100 | [diff] [blame] | 781 | "dt_chosen_reg_addr_int": (dt_chosen_reg, 1, 3), |
| 782 | "dt_chosen_reg_addr_hex": (dt_chosen_reg, 1, 3), |
| 783 | "dt_chosen_reg_size_int": (dt_chosen_reg, 1, 3), |
| 784 | "dt_chosen_reg_size_hex": (dt_chosen_reg, 1, 3), |
| 785 | "dt_node_reg_addr_int": (dt_node_reg, 1, 3), |
| 786 | "dt_node_reg_addr_hex": (dt_node_reg, 1, 3), |
| 787 | "dt_node_reg_size_int": (dt_node_reg, 1, 3), |
| 788 | "dt_node_reg_size_hex": (dt_node_reg, 1, 3), |
Jordan Yates | 999afdc | 2023-07-30 13:33:33 +1000 | [diff] [blame] | 789 | "dt_nodelabel_reg_addr_int": (dt_nodelabel_reg, 1, 3), |
| 790 | "dt_nodelabel_reg_addr_hex": (dt_nodelabel_reg, 1, 3), |
| 791 | "dt_nodelabel_reg_size_int": (dt_nodelabel_reg, 1, 3), |
| 792 | "dt_nodelabel_reg_size_hex": (dt_nodelabel_reg, 1, 3), |
Michał Barnaś | a1ab8da | 2022-03-08 17:44:04 +0100 | [diff] [blame] | 793 | "dt_node_bool_prop": (dt_node_bool_prop, 2, 2), |
| 794 | "dt_nodelabel_bool_prop": (dt_nodelabel_bool_prop, 2, 2), |
Stephen Stauts | d4b8db7 | 2022-12-27 11:40:17 +0100 | [diff] [blame] | 795 | "dt_chosen_bool_prop": (dt_chosen_bool_prop, 2, 2), |
Erwan Gouriou | b711028 | 2021-01-07 12:06:31 +0100 | [diff] [blame] | 796 | "dt_node_has_prop": (dt_node_has_prop, 2, 2), |
Michał Barnaś | a1ab8da | 2022-03-08 17:44:04 +0100 | [diff] [blame] | 797 | "dt_nodelabel_has_prop": (dt_nodelabel_has_prop, 2, 2), |
David Leach | 1e5a830 | 2021-11-08 23:24:22 -0600 | [diff] [blame] | 798 | "dt_node_int_prop_int": (dt_node_int_prop, 2, 3), |
| 799 | "dt_node_int_prop_hex": (dt_node_int_prop, 2, 3), |
Eivind Jølsgard | 3865e08 | 2022-03-18 10:50:00 +0100 | [diff] [blame] | 800 | "dt_node_array_prop_int": (dt_node_array_prop, 3, 4), |
| 801 | "dt_node_array_prop_hex": (dt_node_array_prop, 3, 4), |
Johann Fischer | 73199f2 | 2021-11-18 17:12:23 +0100 | [diff] [blame] | 802 | "dt_node_str_prop_equals": (dt_node_str_prop_equals, 3, 3), |
Andrzej Głąbek | 3331a20 | 2020-02-14 11:53:21 +0100 | [diff] [blame] | 803 | "dt_nodelabel_has_compat": (dt_nodelabel_has_compat, 2, 2), |
Daniel DeGrasse | 6aa7194 | 2022-08-26 12:12:24 -0500 | [diff] [blame] | 804 | "dt_node_has_compat": (dt_node_has_compat, 2, 2), |
Martí Bolívar | 1fff235 | 2020-04-22 18:06:18 -0700 | [diff] [blame] | 805 | "dt_nodelabel_path": (dt_nodelabel_path, 1, 1), |
Daniel DeGrasse | db9bcd9 | 2022-08-26 12:10:14 -0500 | [diff] [blame] | 806 | "dt_node_parent": (dt_node_parent, 1, 1), |
Stephen Stauts | d4b8db7 | 2022-12-27 11:40:17 +0100 | [diff] [blame] | 807 | "dt_nodelabel_array_prop_has_val": (dt_nodelabel_array_prop_has_val, 3, 3), |
Henrik Brix Andersen | fba6c7f | 2023-01-18 17:43:02 +0100 | [diff] [blame] | 808 | "dt_gpio_hogs_enabled": (dt_gpio_hogs_enabled, 0, 0), |
Erwan Gouriou | 17537c7 | 2019-11-22 10:06:57 +0100 | [diff] [blame] | 809 | "shields_list_contains": (shields_list_contains, 1, 1), |
Kumar Gala | 87915cd | 2018-11-15 11:51:50 -0600 | [diff] [blame] | 810 | } |