dts/Kconfig

   1 #
   2 # Device Tree Control
   3 #
   4
   5 config SUPPORT_OF_CONTROL
   6         bool
   7
   8 config PYLIBFDT
   9         bool
  10
  11 config DTOC
  12         bool
  13         select PYLIBFDT
  14
  15 config BINMAN
  16         bool
  17         select DTOC
  18
  19 config BINMAN_STANDALONE_FDT
  20         bool
  21         depends on BINMAN
  22         default y if OF_BOARD
  23         help
  24           This option tells U-Boot build system that a standalone device tree
  25           source is explicitly required when using binman to package U-Boot.
  26
  27           This is not necessary in a common scenario where a device tree source
  28           that contains the binman node is provided in the arch/<arch>/dts
  29           directory for a specific board. Such device tree sources are built for
  30           OF_SEPARATE or OF_EMBED. However for a scenario like the board device
  31           tree blob is not provided in the U-Boot build tree, but fed to U-Boot
  32           in the runtime, e.g.: in the OF_BOARD case that it is passed by
  33           a prior stage bootloader. For such scenario, a standalone device tree
  34           blob containing binman node to describe how to package U-Boot should
  35           be provided explicitly.
  36
  37 menu "Device Tree Control"
  38         depends on SUPPORT_OF_CONTROL
  39
  40 config OF_CONTROL
  41         bool "Run-time configuration via Device Tree"
  42         select OF_LIBFDT if !OF_PLATDATA
  43         select OF_REAL if !OF_PLATDATA
  44         help
  45           This feature provides for run-time configuration of U-Boot
  46           via a flattened device tree.
  47
  48 config OF_REAL
  49         bool
  50         help
  51           Indicates that a real devicetree is available which can be accessed
  52           at runtime. This means that dev_read_...() functions can be used to
  53           read data from the devicetree for each device. This is true if
  54           OF_CONTROL is enabled in U-Boot proper.
  55
  56 config OF_BOARD_FIXUP
  57         bool "Board-specific manipulation of Device Tree"
  58         help
  59           In certain circumstances it is necessary to be able to modify
  60           U-Boot's device tree (e.g. to delete device from it). This option
  61           make the Device Tree writeable and provides a board-specific
  62           "board_fix_fdt" callback (called during pre-relocation time), which
  63           enables the board initialization to modifiy the Device Tree. The
  64           modified copy is subsequently used by U-Boot after relocation.
  65
  66 config SPL_OF_CONTROL
  67         bool "Enable run-time configuration via Device Tree in SPL"
  68         depends on SPL && OF_CONTROL
  69         select SPL_OF_LIBFDT if !SPL_OF_PLATDATA
  70         select SPL_OF_REAL if !SPL_OF_PLATDATA
  71         help
  72           Some boards use device tree in U-Boot but only have 4KB of SRAM
  73           which is not enough to support device tree. Disable this option to
  74           allow such boards to be supported by U-Boot SPL.
  75
  76 config TPL_OF_CONTROL
  77         bool "Enable run-time configuration via Device Tree in TPL"
  78         depends on TPL && OF_CONTROL
  79         select TPL_OF_LIBFDT if !TPL_OF_PLATDATA
  80         select TPL_OF_REAL if !TPL_OF_PLATDATA
  81         help
  82           Some boards use device tree in U-Boot but only have 4KB of SRAM
  83           which is not enough to support device tree. Enable this option to
  84           allow such boards to be supported by U-Boot TPL.
  85
  86 config OF_LIVE
  87         bool "Enable use of a live tree"
  88         depends on DM && OF_CONTROL
  89         help
  90           Normally U-Boot uses a flat device tree which saves space and
  91           avoids the need to unpack the tree before use. However a flat
  92           tree does not support modification from within U-Boot since it
  93           can invalidate driver-model device tree offsets. This option
  94           enables a live tree which is available after relocation,
  95           and can be adjusted as needed.
  96
  97 choice
  98         prompt "Provider of DTB for DT control"
  99         depends on OF_CONTROL
 100
 101 config OF_SEPARATE
 102         bool "Separate DTB for DT control"
 103         depends on !SANDBOX
 104         help
 105           If this option is enabled, the device tree will be built and
 106           placed as a separate u-boot.dtb file alongside the U-Boot image.
 107
 108 config OF_EMBED
 109         bool "Embedded DTB for DT control"
 110         help
 111           If this option is enabled, the device tree will be picked up and
 112           built into the U-Boot image. This is suitable for local debugging
 113           and development only and is not recommended for production devices.
 114           Boards in the mainline U-Boot tree should not use it.
 115
 116 config OF_BOARD
 117         bool "Provided by the board (e.g a previous loader) at runtime"
 118         depends on !SANDBOX
 119         help
 120           If this option is enabled, the device tree will be provided by
 121           the board at runtime if the board supports it, instead of being
 122           bundled with the image.
 123
 124 config OF_HOSTFILE
 125         bool "Host filed DTB for DT control"
 126         depends on SANDBOX
 127         help
 128           If this option is enabled, DTB will be read from a file on startup.
 129           This is only useful for Sandbox.  Use the -d flag to U-Boot to
 130           specify the file to read.
 131
 132 endchoice
 133
 134 config DEFAULT_DEVICE_TREE
 135         string "Default Device Tree for DT control"
 136         depends on OF_CONTROL
 137         help
 138           This option specifies the default Device Tree used for DT control.
 139           It can be overridden from the command line:
 140           $ make DEVICE_TREE=<device-tree-name>
 141
 142 config OF_LIST
 143         string "List of device tree files to include for DT control"
 144         depends on SPL_LOAD_FIT || MULTI_DTB_FIT
 145         default DEFAULT_DEVICE_TREE
 146         help
 147           This option specifies a list of device tree files to use for DT
 148           control. These will be packaged into a FIT. At run-time, U-boot
 149           or SPL will select the correct DT to use by examining the
 150           hardware (e.g. reading a board ID value). This is a list of
 151           device tree files (without the directory or .dtb suffix)
 152           separated by <space>.
 153
 154 config OF_OVERLAY_LIST
 155         string "List of device tree overlays to include for DT control"
 156         depends on SPL_LOAD_FIT_APPLY_OVERLAY
 157         help
 158           This option specifies a list of device tree overlays to use for DT
 159           control. This option can then be used by a FIT generator to include
 160           the overlays in the FIT image.
 161
 162 choice
 163         prompt "OF LIST compression"
 164         depends on MULTI_DTB_FIT
 165         default MULTI_DTB_FIT_NO_COMPRESSION
 166
 167 config MULTI_DTB_FIT_LZO
 168         bool "LZO"
 169         depends on SYS_MALLOC_F
 170         select LZO
 171         help
 172           Compress the FIT image containing the DTBs available for the SPL
 173           using LZO compression. (requires lzop on host).
 174
 175 config MULTI_DTB_FIT_GZIP
 176         bool "GZIP"
 177         depends on SYS_MALLOC_F
 178         select GZIP
 179         help
 180           Compress the FIT image containing the DTBs available for the SPL
 181           using GZIP compression. (requires gzip on host)
 182
 183 config MULTI_DTB_FIT_NO_COMPRESSION
 184         bool "No compression"
 185         help
 186           Do not compress the FIT image containing the DTBs available for the SPL.
 187           Use this options only if LZO is not available and the DTBs are very small.
 188 endchoice
 189
 190 choice
 191         prompt "Location of uncompressed DTBs"
 192         depends on (MULTI_DTB_FIT_GZIP || MULTI_DTB_FIT_LZO)
 193         default MULTI_DTB_FIT_DYN_ALLOC if SYS_MALLOC_F
 194
 195 config MULTI_DTB_FIT_DYN_ALLOC
 196         bool "Dynamically allocate the memory"
 197         depends on SYS_MALLOC_F
 198
 199 config MULTI_DTB_FIT_USER_DEFINED_AREA
 200         bool "User-defined location"
 201 endchoice
 202
 203 config MULTI_DTB_FIT_UNCOMPRESS_SZ
 204         hex "Size of memory reserved to uncompress the DTBs"
 205         depends on (MULTI_DTB_FIT_GZIP || MULTI_DTB_FIT_LZO)
 206         default 0x8000
 207         help
 208            This is the size of this area where the DTBs are uncompressed.
 209            If this area is dynamically allocated, make sure that
 210            SYS_MALLOC_F_LEN is big enough to contain it.
 211
 212 config MULTI_DTB_FIT_USER_DEF_ADDR
 213         hex "Address of memory where dtbs are uncompressed"
 214         depends on MULTI_DTB_FIT_USER_DEFINED_AREA
 215         help
 216            the FIT image containing the DTBs is uncompressed in an area defined
 217            at compilation time. This is the address of this area. It must be
 218            aligned on 2-byte boundary.
 219
 220 config DTB_RESELECT
 221         bool "Support swapping dtbs at a later point in boot"
 222         depends on MULTI_DTB_FIT
 223         help
 224           It is possible during initial boot you may need to use a generic
 225           dtb until you can fully determine the board your running on. This
 226           config allows boards to implement a function at a later point
 227           during boot to switch to the "correct" dtb.
 228
 229 config MULTI_DTB_FIT
 230         bool "Support embedding several DTBs in a FIT image for u-boot"
 231         help
 232           This option provides hooks to allow U-boot to parse an
 233           appended FIT image and enable board specific code to then select
 234           the correct DTB to be used. Use this if you need to support
 235           multiple DTBs but don't use the SPL.
 236
 237
 238 config SPL_MULTI_DTB_FIT
 239         depends on SPL_LOAD_FIT && SPL_OF_REAL
 240         bool "Support embedding several DTBs in a FIT image for the SPL"
 241         help
 242           This option provides the SPL with the ability to select its own
 243           DTB at runtime from an appended FIT image containing several DTBs.
 244           This allows using the same SPL binary on multiple platforms.
 245           The primary purpose is to handle different versions of
 246           the same platform without tweaking the platform code if the
 247           differences can be expressed in the DTBs (common examples are: bus
 248           capabilities, pad configurations).
 249
 250 config SPL_OF_LIST
 251         string "List of device tree files to include for DT control in SPL"
 252         depends on SPL_MULTI_DTB_FIT
 253         default OF_LIST
 254         help
 255           This option specifies a list of device tree files to use for DT
 256           control in the SPL. These will be packaged into a FIT. At run-time,
 257           the SPL will select the correct DT to use by examining the
 258           hardware (e.g. reading a board ID value). This is a list of
 259           device tree files (without the directory or .dtb suffix)
 260           separated by <space>.
 261
 262 choice
 263         prompt "SPL OF LIST compression"
 264         depends on SPL_MULTI_DTB_FIT
 265         default SPL_MULTI_DTB_FIT_LZO
 266
 267 config SPL_MULTI_DTB_FIT_LZO
 268         bool "LZO"
 269         depends on SYS_MALLOC_F
 270         select SPL_LZO
 271         help
 272           Compress the FIT image containing the DTBs available for the SPL
 273           using LZO compression. (requires lzop on host).
 274
 275 config SPL_MULTI_DTB_FIT_GZIP
 276         bool "GZIP"
 277         depends on SYS_MALLOC_F
 278         select SPL_GZIP
 279         help
 280           Compress the FIT image containing the DTBs available for the SPL
 281           using GZIP compression. (requires gzip on host)
 282
 283 config SPL_MULTI_DTB_FIT_NO_COMPRESSION
 284         bool "No compression"
 285         help
 286           Do not compress the FIT image containing the DTBs available for the SPL.
 287           Use this options only if LZO is not available and the DTBs are very small.
 288 endchoice
 289
 290 choice
 291         prompt "Location of uncompressed DTBs"
 292         depends on (SPL_MULTI_DTB_FIT_GZIP || SPL_MULTI_DTB_FIT_LZO)
 293         default SPL_MULTI_DTB_FIT_DYN_ALLOC if SYS_MALLOC_F
 294
 295 config SPL_MULTI_DTB_FIT_DYN_ALLOC
 296         bool "Dynamically allocate the memory"
 297         depends on SYS_MALLOC_F
 298
 299 config SPL_MULTI_DTB_FIT_USER_DEFINED_AREA
 300         bool "User-defined location"
 301 endchoice
 302
 303 config SPL_MULTI_DTB_FIT_UNCOMPRESS_SZ
 304         hex "Size of memory reserved to uncompress the DTBs"
 305         depends on (SPL_MULTI_DTB_FIT_GZIP || SPL_MULTI_DTB_FIT_LZO)
 306         default 0x8000
 307         help
 308            This is the size of this area where the DTBs are uncompressed.
 309            If this area is dynamically allocated, make sure that
 310            SPL_SYS_MALLOC_F_LEN is big enough to contain it.
 311
 312 config SPL_MULTI_DTB_FIT_USER_DEF_ADDR
 313         hex "Address of memory where dtbs are uncompressed"
 314         depends on SPL_MULTI_DTB_FIT_USER_DEFINED_AREA
 315         help
 316            the FIT image containing the DTBs is uncompressed in an area defined
 317            at compilation time. This is the address of this area. It must be
 318            aligned on 2-byte boundary.
 319
 320 config OF_SPL_REMOVE_PROPS
 321         string "List of device tree properties to drop for SPL"
 322         depends on SPL_OF_CONTROL
 323         default "interrupt-parent interrupts" if SPL_PINCTRL && SPL_CLK
 324         default "clocks clock-names interrupt-parent interrupts" if SPL_PINCTRL
 325         default "pinctrl-0 pinctrl-names interrupt-parent interrupts" if SPL_CLK
 326         default "pinctrl-0 pinctrl-names clocks clock-names interrupt-parent interrupts"
 327         help
 328           Since SPL normally runs in a reduced memory space, the device tree
 329           is cut down to only what is needed to load and start U-Boot. Only
 330           nodes marked with the property "u-boot,dm-pre-reloc" will be
 331           included. In addition, some properties are not used by U-Boot and
 332           can be discarded. This option defines the list of properties to
 333           discard.
 334
 335 config OF_DTB_PROPS_REMOVE
 336         bool "Enable removal of device tree properties"
 337         depends on OF_CONTROL
 338         help
 339           Some boards have restricted amount of storage for U-Boot image.
 340           If the generated binary doesn't fit into available image storage,
 341           the built-in device tree could probably be cut down by removing
 342           some not required device tree properties to reduce the image size.
 343           Enable this option and define the properties to be removed in the
 344           CONFIG_OF_REMOVE_PROPS list. Do not enable this option if you must
 345           pass the built-in DTB directly to the kernel!
 346
 347 config OF_REMOVE_PROPS
 348         string "List of device tree properties to drop"
 349         depends on OF_DTB_PROPS_REMOVE
 350         default "interrupt-parent interrupts" if PINCTRL
 351         help
 352           Some properties are not used by U-Boot and can be discarded.
 353           This option defines the list of properties to discard.
 354
 355 config SPL_OF_PLATDATA
 356         bool "Generate platform data for use in SPL"
 357         depends on SPL_OF_CONTROL
 358         select DTOC
 359         select SPL_OF_PLATDATA_DRIVER_RT if !SPL_OF_PLATDATA_INST
 360         help
 361           For very constrained SPL environments the overhead of decoding
 362           device tree nodes and converting their contents into platform data
 363           is too large. This overhead includes libfdt code as well as the
 364           device tree contents itself. The latter is fairly compact, but the
 365           former can add 3KB or more to a Thumb 2 Image.
 366
 367           This option enables generation of platform data from the device
 368           tree as C code. This code creates devices using U_BOOT_DRVINFO()
 369           declarations. The benefit is that it allows driver code to access
 370           the platform data directly in C structures, avoidin the libfdt
 371           overhead.
 372
 373           This option works by generating C structure declarations for each
 374           compatible string, then adding platform data and U_BOOT_DRVINFO
 375           declarations for each node. See of-plat.txt for more information.
 376
 377 config SPL_OF_REAL
 378         bool
 379         help
 380           Indicates that a real devicetree is available which can be accessed
 381           at runtime. This means that dev_read_...() functions can be used to
 382           read data from the devicetree for each device. This is true if
 383           SPL_OF_CONTROL is enabled and not SPL_OF_PLATDATA
 384
 385 if SPL_OF_PLATDATA
 386
 387 config SPL_OF_PLATDATA_PARENT
 388         bool "Support parent information in devices"
 389         default y
 390         help
 391           Generally it is useful to be able to access the parent of a device
 392           with of-platdata. To save space this can be disabled, but in that
 393           case dev_get_parent() will always return NULL;
 394
 395 config SPL_OF_PLATDATA_INST
 396         bool "Declare devices at build time"
 397         help
 398           Declare devices as udevice instances so that they do not need to be
 399           bound when U-Boot starts. This can save time and code space.
 400
 401 config SPL_OF_PLATDATA_NO_BIND
 402         bool "Don't allow run-time binding of devices"
 403         depends on SPL_OF_PLATDATA_INST
 404         default y
 405         help
 406           This removes the ability to bind devices at run time, thus saving
 407           some code space in U-Boot. This can be disabled if binding is needed,
 408           at the code of some code size increase.
 409
 410 config SPL_OF_PLATDATA_RT
 411         bool "Use a separate struct for device runtime data"
 412         depends on SPL_OF_PLATDATA_INST
 413         default y
 414         help
 415           For systems running SPL from read-only memory it is convenient to
 416           separate out the runtime information, so that the devices don't need
 417           to be copied before being used. This moves the read-write parts of
 418           struct udevice (at present just the flags) into a separate struct,
 419           which is allocated at runtime.
 420
 421 config SPL_OF_PLATDATA_DRIVER_RT
 422         bool
 423         help
 424           Use a separate struct for driver runtime data.
 425
 426           This enables the driver_rt information, used with of-platdata when
 427           of-platdata-inst is not used. It allows finding devices by their
 428           driver data.
 429
 430 endif
 431
 432 config TPL_OF_REAL
 433         bool
 434         help
 435           Indicates that a real devicetree is available which can be accessed
 436           at runtime. This means that dev_read_...() functions can be used to
 437           read data from the devicetree for each device. This is true if
 438           TPL_OF_CONTROL is enabled and not TPL_OF_PLATDATA
 439
 440 config TPL_OF_PLATDATA
 441         bool "Generate platform data for use in TPL"
 442         depends on TPL_OF_CONTROL
 443         select DTOC
 444         select TPL_OF_PLATDATA_DRIVER_RT if !TPL_OF_PLATDATA_INST
 445         help
 446           For very constrained SPL environments the overhead of decoding
 447           device tree nodes and converting their contents into platform data
 448           is too large. This overhead includes libfdt code as well as the
 449           device tree contents itself. The latter is fairly compact, but the
 450           former can add 3KB or more to a Thumb 2 Image.
 451
 452           This option enables generation of platform data from the device
 453           tree as C code. This code creates devices using U_BOOT_DRVINFO()
 454           declarations. The benefit is that it allows driver code to access
 455           the platform data directly in C structures, avoidin the libfdt
 456           overhead.
 457
 458           This option works by generating C structure declarations for each
 459           compatible string, then adding platform data and U_BOOT_DRVINFO
 460           declarations for each node. See of-plat.txt for more information.
 461
 462 if TPL_OF_PLATDATA
 463
 464 config TPL_OF_PLATDATA_PARENT
 465         bool "Support parent information in devices"
 466         default y
 467         help
 468           Generally it is useful to be able to access the parent of a device
 469           with of-platdata. To save space this can be disabled, but in that
 470           case dev_get_parent() will always return NULL;
 471
 472 config TPL_OF_PLATDATA_INST
 473         bool "Declare devices at build time"
 474
 475         help
 476           Declare devices as udevice instances so that they do not need to be
 477           bound when U-Boot starts. This can save time and code space.
 478
 479 config TPL_OF_PLATDATA_NO_BIND
 480         bool "Don't allow run-time binding of devices"
 481         depends on TPL_OF_PLATDATA_INST
 482         default y
 483         help
 484           This removes the ability to bind devices at run time, thus saving
 485           some code space in U-Boot. This can be disabled if binding is needed,
 486           at the code of some code size increase.
 487
 488 config TPL_OF_PLATDATA_RT
 489         bool "Use a separate struct for device runtime data"
 490         depends on TPL_OF_PLATDATA_INST
 491         default y
 492         help
 493           For systems running TPL from read-only memory it is convenient to
 494           separate out the runtime information, so that the devices don't need
 495           to be copied before being used. This moves the read-write parts of
 496           struct udevice (at present just the flags) into a separate struct,
 497           which is allocated at runtime.
 498
 499 config TPL_OF_PLATDATA_DRIVER_RT
 500         bool
 501         help
 502           Use a separate struct for driver runtime data.
 503
 504           This enables the driver_rt information, used with of-platdata when
 505           of-platdata-inst is not used. It allows finding devices by their
 506           driver data.
 507
 508 endif
 509
 510 endmenu