aboutsummaryrefslogtreecommitdiff
path: root/Documentation/manual.txt
AgeCommit message (Collapse)AuthorFilesLines
2023-05-26dtc: Add an option to generate __local_fixups__ and __fixups__Uwe Kleine-König1-0/+14
This records detailed usage of labels in a dtb. This is needed in overlays (and enabled implicitly for these). For ordinary device trees it can be used to restore labels when compiling back to dts format. Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> Message-Id: <20230523080941.419330-1-u.kleine-koenig@pengutronix.de> Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2023-04-28manual: Fix and improve documentation about -@Uwe Kleine-König1-5/+3
Device trees with a /plugin/ tag ("overlays") generate a __fixups__ node when needed and independent of -q being given or not. The same is true for __local__fixups__. So don't mention these two nodes in the paragraph about -@. To not shorten the description too much, describe the semantic of the properties contained in the generated __symbols__ node. Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2022-07-30manual.txt: Follow README.md and remove JonPierre-Clément Tosi1-2/+1
Following 0ee1d479b23a ("Remove Jon Loeliger from maintainers list"), make the "Submitting Patches" section of the manual.txt consistent with the README by requesting patches to only be sent to David. Cc: Jon Loeliger <loeliger@gmail.com> Signed-off-by: Pierre-Clément Tosi <ptosi@google.com> Message-Id: <20220729131019.806164-1-ptosi@google.com> Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2021-12-09Support 'r' format for printing raw bytes with fdtgetRafał Miłecki1-1/+1
FT is sometimes used for storing raw data. That is quite common for U-Boot FIT images. Extracting such data is not trivial currently. Using type 's' (string) will replace every 0x00 (NUL) with 0x20 (space). Using type 'x' will print bytes but in xxd incompatible format. This commit adds support for 'r' (raw) format. Example usage: fdtget -t r firmware.itb /images/foo data > image.raw Support for encoding isn't added as there isn't any clean way of passing binary data as command line argument. Signed-off-by: Rafał Miłecki <rafal@milecki.pl> Message-Id: <20211209061420.29466-1-zajec5@gmail.com> Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2021-01-28Update Jon Loeliger's emailDavid Gibson1-1/+1
At Jon's request update to a more current address. Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2019-05-21Fix typos in various documentation and source filesThomas Huth1-6/+6
The typos have been discovered with the "codespell" utility. Signed-off-by: Thomas Huth <thuth@redhat.com> Message-Id: <20190520081209.20415-1-thuth@redhat.com> Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2018-09-13Add support for YAML encoded outputGrant Likely1-0/+3
YAML encoded DT is useful for validation of DTs using binding schemas. The YAML encoding is an intermediate format used for validation and is therefore subject to change as needed. The YAML output is dependent on DTS input with type information preserved. Signed-off-by: Grant Likely <grant.likely@arm.com> [robh: make YAML support optional, build fixes, Travis CI test, preserve type information in paths and phandles] Signed-off-by: Rob Herring <robh@kernel.org> Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2018-06-07fdtput: Add documentationSimon Glass1-0/+33
This is missing at present and the fdtput tool could use a litle more information than just its help text. This might be useful for distributions which want to provide a man page. Signed-off-by: Simon Glass <sjg@chromium.org> Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2018-06-07fdtget: Add documentationSimon Glass1-0/+31
This is missing at present and the fdtget tool is no-longer trivial. Add a little bit of information. This might be useful for distributions which want to provide a man page. Signed-off-by: Simon Glass <sjg@chromium.org> Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2017-06-15fdtoverlay: A tool that applies overlaysPantelis Antoniou1-0/+14
Since libfdt support overlay application on FDT blobs, provide a command line tool that applies an arbitrary number of overlays, one after another to a base fdt blob and output the result in the given file. Signed-off-by: Pantelis Antoniou <pantelis.antoniou@konsulko.com> Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2017-06-14manual: Document missing optionsPantelis Antoniou1-1/+5
The -d and -s options were undocumented. Add an entry in the manual. Signed-off-by: Pantelis Antoniou <pantelis.antoniou@konsulko.com> Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2017-01-30manual: Fix typo it -> inStephen Boyd1-1/+1
Two its in a row can't be right. Signed-off-by: Stephen Boyd <stephen.boyd@linaro.org> Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2016-12-09dtc: Plugin and fixup supportPantelis Antoniou1-1/+20
This patch enable the generation of symbols & local fixup information for trees compiled with the -@ (--symbols) option. Using this patch labels in the tree and their users emit information in __symbols__ and __local_fixups__ nodes. The __fixups__ node make possible the dynamic resolution of phandle references which are present in the plugin tree but lie in the tree that are applying the overlay against. Signed-off-by: Pantelis Antoniou <pantelis.antoniou@konsulko.com> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de> Signed-off-by: Jan Luebbe <jlu@pengutronix.de> Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2014-03-03Update source code location for dtc in manual.txtHeinrich Schuchardt1-12/+10
The information about the location of the source code of the device tree compiler was inaccurate. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2012-10-16Add documentation on how to submit patchesMichael Ellerman1-0/+5
Signed-off-by: Michael Ellerman <michael@ellerman.id.au> Acked-by: David Gibson <david@gibson.dropbear.id.au>
2012-01-13dtc: Implement -d option to write out a dependency fileStephen Warren1-0/+3
This will allow callers to rebuild .dtb files when any of the /include/d .dtsi files are modified, not just the top-level .dts file. Signed-off-by: Stephen Warren <swarren@nvidia.com> Acked-by: David Gibson <david@gibson.dropbear.id.au>
2011-10-26fdtdump: rename from ftdumpMike Frysinger1-5/+5
The freetype package already installs a binary named "ftdump", so the dtc package conflicts with that. So rename the newer dtc tool to "fdtdump". This even makes a bit more sense: ftdump: [F]lat device [T]ree [dump] fdtdump: [F]lat [D]evice [T]ree [dump] Signed-off-by: Mike Frysinger <vapier@gentoo.org> Acked-by: David Gibson <david@gibson.dropbear.id.au>
2008-10-03Some Documentation fixes and generalizations.Jon Loeliger1-6/+20
Updated a jdl.com URL reference. Generalized the new section IV to be "Utility Tools" and added a small blurb about ftdump as well. Signed-off-by: Jon Loeliger <jdl@jdl.com>
2008-10-03Install & document convert-dtsv0Niklaus Giger1-0/+20
Signed-off-by: Niklaus Giger <niklaus.giger@member.fsf.org> Acked-by: David Gibson <david@gibson.dropbear.id.au>
2007-09-18dtc: Whitespace cleanupDavid Gibson1-1/+1
This large patch removes all trailing whitespace from dtc (including libfdt, the testsuite and documentation). It also removes a handful of redundant blank lines (at the end of functions, or when there are two blank lines together for no particular reason). As well as anything else, this means that quilt won't whinge when I go to convert the whole of libfdt into a patch to apply to the kernel. Signed-off-by: David Gibson <david@gibson.dropbear.id.au>
2007-08-09Add initial Device Tree Compiler manualJon Loeliger1-0/+618
This is the new location for technical descriptions of the DTC. Derived from the kernel's Documentation/powerpc/booting-without-of.txt. The booting-without-of.txt that was here was very old and out of date. Signed-off-by: Jon Loeliger <jdl@freescale.com>