summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2018-10-10MLK-19722-8 doc: imx: Improve i.MX documentation namingBreno Lima
There is no need to have README in all i.MX documents name. Remove README from i.MX docs name and add .txt file extension. Signed-off-by: Breno Lima <breno.lima@nxp.com> Reviewed-by: Ye Li <ye.li@nxp.com> (cherry picked from commit 49f36f64066b6cd9ac23d08b2b7af63b5ed9717d)
2018-10-10MLK-19722-7 doc: imx: misc: Reorganize miscellaneous documentationBreno Lima
The Serial Download Protocol feature is availible in various i.MX SoCs. Move README.sdp document to imx/misc directory. Signed-off-by: Breno Lima <breno.lima@nxp.com> (cherry picked from commit 39eed8d1444c6cfe8f8a75959a322205b41f5807)
2018-10-10MLK-19722-6 doc: imx: hab: Reorganize High Assurance Boot documentationBreno Lima
The current High Assurance Boot document README.mxc_hab include details for the following features in a single file: - HAB Secure Boot - HAB Encrypted Boot Split HAB documentation in a specific directory for a cleaner documentation structure, subsequent patches will include more content in HAB documentation. Signed-off-by: Breno Lima <breno.lima@nxp.com> (cherry picked from commit d2d545d78899e191f2d5c0f1b9b429db2de840ac)
2018-10-10MLK-19722-5 doc: imx: Reorganize i.MX SoC common documentationBreno Lima
The following documents describe device details according to the i.MX family: - README.imx25 - README.imx27 - README.imx5 - README.imx6 - README.mxs Move all device common related document to doc/imx/common for a better directory structure. Signed-off-by: Breno Lima <breno.lima@nxp.com> (cherry picked from commit 2098487e28507e64f54ff0ce8d3826ff6e2936c0)
2018-10-10MLK-19722-4 doc: imx: mkimage: reorganize i.MX mkimage documentationBreno Lima
The following documents describe the image type used by the mkimage tool to generate U-Boot images for i.MX devices. - README.imximage - README.mxsimage Move all mkimage related document to doc/imx/mkimage for a better directory structure. Signed-off-by: Breno Lima <breno.lima@nxp.com> (cherry picked from commit 57310be619b009bd7df804702d1bad724bc87430)
2018-10-10MLK-19722-3 doc: imx: Move SPD related info to the appropriate docBreno Lima
Currently the Serial Download Protocol tools and procedure are documented in two places: - doc/imx/README.sdp - doc/imx/README.imx6 It is better to consolidate all SDP related information into README.sdp file, so move the content from README.imx6 to README.sdp. Signed-off-by: Breno Lima <breno.lima@nxp.com> (cherry picked from commit 27373a1723f427fd271ff1b39de2f0bca8c5302d)
2018-10-10MLK-19722-2 doc: imx: reorganize i.MX documentationBreno Lima
Currently the U-Boot doc/ directory contains the following files that are only relevant for i.MX devices: - doc/README.imx25 - doc/README.imx27 - doc/README.imx5 - doc/README.imx6 - doc/README.imximage - doc/README.mxc_hab - doc/README.mxs - doc/README.mxsimage - doc/README.sdp Move all content to a common i.MX folder for a better documentation structure. Signed-off-by: Breno Lima <breno.lima@nxp.com> (cherry picked from commit a5e99a185aa09dfe964d9ba3f435f2ec0374c033)
2018-10-10MLK-19722-1 doc: Move device tree bindings documentation to ↵Breno Lima
doc/device-tree-bindings Currently the U-Boot project contains 2 documentation directories: - doc/ - Documentation/ The Documentation directory only contains device tree bindings related content, so move the 2 files to doc/device-tree-bindings/. This commit is based in a previous submission in U-Boot upstream: http://git.denx.de/?p=u-boot.git;a=commit;h=ad7061ed742e1312289644268859a0f4b512aaee Signed-off-by: Breno Lima <breno.lima@nxp.com> (cherry picked from commit 10bb5cf4d0a4d079c1463df6d4cb3f51f1b5ad18)
2018-03-11doc: mxc_hab: Update i.MX HAB documentationBreno Lima
The README.mxc_hab is outdated and need improvements, add the following modifications: - Reorganize document and remove duplicate content - Add CST download link - Update CST package name - Align command lines with CST v2.3.3 - Update U-Boot binary name - Remove CSF padding since is not documented in AN4581 Signed-off-by: Breno Lima <breno.lima@nxp.com>
2018-03-11doc: mxc_hab: Move HAB related info to the appropriate docBreno Lima
Currently the High Assurance Boot procedure is documented in two places: - doc/README.imx6 - doc/README.mxc_hab It is better to consolidate all HAB related information into README.mxc_hab file, so move the content from README.imx6 to README.mxc_hab. Signed-off-by: Breno Lima <breno.lima@nxp.com> Reviewed-by: Fabio Estevam <fabio.estevam@nxp.com>
2018-02-23Remove config_distro_defaults.hAdam Ford
With the contents of config_distro_defaults.h migrated to Kconfig, we can remove this header file completely Signed-off-by: Adam Ford <aford173@gmail.com>
2018-02-10efi_loader: split README.efi into two separate documentsHeinrich Schuchardt
README.efi describes two different concepts: * U-Boot exposing the UEFI API * U-Boot running on top of UEFI. This patch splits the document in two. Religious references are removed. The separation of the concepts makes sense before detailing the internals of U-Boot exposing the UEFI API in a future patch. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Signed-off-by: Alexander Graf <agraf@suse.de>
2018-02-07doc: watchdog: Remove Blackfin related documentation entryLukasz Majewski
This commit cleans up the README.watchdog by removing the reminescent of ADI's Blackfin architecture removed some time ago. Signed-off-by: Lukasz Majewski <lukma@denx.de>
2018-02-04Merge git://git.denx.de/u-boot-dmTom Rini
2018-02-04doc: mxc_hab: Improve the config option listFabio Estevam
The original text is from the time that the config options were not converted to Kconfig. After the conversion to Kconfig only CONFIG_SECURE_BOOT and CONFIG_CMD_DEKBLOB need to be selected by the user. The other config options are automatically selected by the Kconfig logic. Signed-off-by: Fabio Estevam <fabio.estevam@nxp.com> Reviewed-by: Breno Lima <breno.lima@nxp.com>
2018-02-03log: add category LOGC_EFIHeinrich Schuchardt
The EFI implementation does not fit into any of the existing categories. Provide LOGC_EFI so that EFI related message can be filtered. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
2018-02-03log: Add a way to log error-return valuesSimon Glass
When functions return an error it propagates up the stack to the point where it is reported. Often the error code provides enough information about the root cause of the error that this is obvious what went wrong. However in some cases the error may be hard to trace. For example if a driver uses several devices to perform an operation, it may not be obvious which one failed. Add a log_ret() macro to help with this. This can be used to wrap any error-return value. The logging system will then output a log record when the original error is generated, making it easy to trace the call stack of the error. This macro can significantly impact code size, so its use is controlled by a Kconfig option, which is enabled for sandbox. Signed-off-by: Simon Glass <sjg@chromium.org>
2018-02-03log: Add documentation for commands and formattingSimon Glass
Add some notes about recent new features. Signed-off-by: Simon Glass <sjg@chromium.org>
2018-01-31Merge tag 'xilinx-for-v2018.03' of git://git.denx.de/u-boot-microblazeTom Rini
Xilinx changes for v2018.03 - Several Kconfig fixes (also moving configs to defconfigs) - Some DTS updates - ZynqMP psu rework based on Zynq concept - Add low level initialization for zc770 and zcu102 - Add support for Zynq zc770 x16 nand configuration - Add mini nand/emmc ZynqMP targets - Some arasan nand changes
2018-01-30doc: zynq: Describe status of zc770-xm011Michal Simek
zc770-xm011 is also added and supported. Reflect this in README. Signed-off-by: Michal Simek <michal.simek@xilinx.com>
2018-01-28efi_loader: add a README.iscsi describing booting via iSCSIHeinrich Schuchardt
The appended README explains how U-Boot and iPXE can be used to boot a diskless system from an iSCSI SAN. The maintainer for README.efi and README.iscsi is set. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> [agraf: s/Adress/Address/] Signed-off-by: Alexander Graf <agraf@suse.de>
2018-01-26Merge git://git.denx.de/u-boot-spiTom Rini
2018-01-24doc: Update the zynq u-boot statusEzequiel Garcia
NAND and QSPI devices are now supported, so mark them as such. Cc: Michal Simek <michal.simek@xilinx.com> Signed-off-by: Ezequiel Garcia <ezequiel@vanguardiasur.com.ar> Signed-off-by: Michal Simek <michal.simek@xilinx.com>
2018-01-24dts: cadence_spi: Update documentation for DT bindingsJason Rush
Update documentation to reflect adopting the Linux DT bindings. Tested on TI K2G platform: Tested-by: Vignesh R <vigneshr@ti.com> Tested on a socfpga-cyclonev board: Tested-by: Simon Goldschmidt <sgoldschmidt@de.pepperl-fuchs.com> Signed-off-by: Jason Rush <jarush@gmail.com> Reviewed-by: Jagan Teki <jagan@openedev.com> Acked-by: Simon Goldschmidt <sgoldschmidt@de.pepperl-fuchs.com> Acked-by: Marek Vasut <marex@denx.de>
2018-01-22fs: Migrate ext4 to KconfigTuomas Tynkkynen
Migrate the following symbols to Kconfig: CONFIG_FS_EXT4 CONFIG_EXT4_WRITE The definitions in config_fallbacks.h can now be expressed in Kconfig. Signed-off-by: Tuomas Tynkkynen <tuomas@tuxera.com>
2018-01-19m68k: Drop unreferenced CONFIG_* definesTuomas Tynkkynen
The following config symbols are only defined once and never referenced anywhere else: CONFIG_AMCORE CONFIG_ASTRO5373L CONFIG_M52277EVB CONFIG_M5253DEMO CONFIG_M5253EVBE CONFIG_M5275EVB CONFIG_M54418TWR CONFIG_STMARK2 Most of them are config symbols named after the respective boards which seems to have been a standard practice at some point. Signed-off-by: Tuomas Tynkkynen <tuomas@tuxera.com>
2018-01-19ARM: Document AArch64 version of qemu-armTuomas Tynkkynen
It's mostly obvious, except that QEMU is annoying and requires an explicit '-cpu cortex-a57' (or some other 64-bit core) to actually run in 64-bit mode. While at it, remove the references to setting the ARCH environment variable; that is not used in U-Boot. Signed-off-by: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi> Reviewed-by: Tom Rini <trini@konsulko.com>
2018-01-15doc: fix incorrect usage of DT node unit addressAndre Przywara
The DT spec demands a unit-address in a node name to match the "reg" property in that node. Newer dtc versions will throw warnings if this is not the case. Fix all occurences in various documentation files where this was not observed, to not give bad examples to the reader. Signed-off-by: Andre Przywara <andre.przywara@arm.com>
2018-01-15doc: FIT image: fix incorrect examples of DT node unit addressAndre Przywara
The DT spec demands a unit-address of a node name to match the "reg" property in that node. Newer dtc versions will throw warnings if this is not the case. Fix all occurences in the FIT image example files where this was not observed, to not give bad examples to the reader. Signed-off-by: Andre Przywara <andre.przywara@arm.com>
2018-01-15doc: FIT image: fix incorrect description of DT node unit addressAndre Przywara
The DT spec demands a unit-address in a node name to match the "reg" property in that node. Newer dtc versions will throw warnings if this is not the case. Fix all occurences in the FIT image documentation files where this was not observed, to not give bad examples to the reader. Signed-off-by: Andre Przywara <andre.przywara@arm.com>
2018-01-12riscv: doc: Add relative doc to describe RISC-VRick Chen
Add documents to describe NX25 and AE250. Also update other documents for RISC-V. Signed-off-by: Rick Chen <rick@andestech.com> Signed-off-by: Rick Chen <rickchen36@gmail.com> Signed-off-by: Greentime Hu <green.hu@gmail.com>
2018-01-10rockchip:usb: add a simple readme for rockusbEddie Cai
add a simple readme to introduce rockusb and tell people how to use it Signed-off-by: Eddie Cai <eddie.cai.linux@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2018-01-10doc: bindings: soft-spi: update documentation to match the codeMiquel Raynal
Linux bindings have been introduced in the code (removing the U-Boot specific ones) without documentation update. Compatible string has changed, as well as the four GPIO properties. Reflect this by updating the soft-spi.txt documentation. Fixes: 102412c415 ("dm: spi: soft_spi: switch to use linux compatible string") Signed-off-by: Miquel Raynal <miquel.raynal@free-electrons.com> Reviewed-by: Jagan Teki <jagan@amarulasolutions.com>
2017-12-14Merge git://git.denx.de/u-boot-dmTom Rini
2017-12-12power: extend prefix match to regulator-name propertyFelix Brack
This patch extends pmic_bind_children prefix matching. In addition to the node name the property regulator-name is used while trying to match prefixes. This allows assigning different drivers to regulator nodes named regulator@1 and regulator@10 for example. I have discarded the idea of using other properties then regulator-name as I do not see any benefit in using property compatible or even regulator-compatible. Of course I am open to change this if there are good reasons to do so. Signed-off-by: Felix Brack <fb@ltec.ch> Reviewed-by: Simon Glass <sjg@chromium.org>
2017-12-12SPL: Add FIT data-position property supportPeng Fan
For external data, FIT has a optional property "data-position" which can set the external data to a fixed offset to FIT beginning. Add the support for this property in SPL FIT. Signed-off-by: Ye Li <ye.li@nxp.com> Signed-off-by: Peng Fan <peng.fan@nxp.com> Reviewed-by: Simon Glass <sjg@chromium.org> Reviewed-by: Tomas Melin <tomas.melin@vaisala.com> Cc: Pantelis Antoniou <pantelis.antoniou@konsulko.com> Cc: "Andrew F. Davis" <afd@ti.com> Cc: Igor Grinberg <grinberg@compulab.co.il> Cc: "tomas.melin@vaisala.com" <tomas.melin@vaisala.com> Cc: Kever Yang <kever.yang@rock-chips.com> Cc: Andre Przywara <andre.przywara@arm.com> Cc: York Sun <york.sun@nxp.com> Cc: Lokesh Vutla <lokeshvutla@ti.com> Cc: "Cooper Jr., Franklin" <fcooper@ti.com> Cc: George McCollister <george.mccollister@gmail.com> Cc: Tuomas Tynkkynen <tuomas.tynkkynen@iki.fi> Cc: Jean-Jacques Hiblot <jjhiblot@ti.com> Cc: Rick Altherr <raltherr@google.com> Cc: Tom Rini <trini@konsulko.com> Reviewed-by: Lokesh Vutla <lokeshvutla@ti.com> Reviewed-by: York Sun <york.sun@nxp.com>
2017-12-11ARC: clk: introduce HSDK CGU clock driverEugeniy Paltsev
Synopsys HSDK clock controller generates and supplies clocks to various controllers and peripherals within the SoC. Each clock has assigned identifier and client device tree nodes can use this identifier to specify the clock which they consume. All available clocks are defined as preprocessor macros in the dt-bindings/clock/snps,hsdk-cgu.h header and can be used in device tree sources. Signed-off-by: Eugeniy Paltsev <Eugeniy.Paltsev@synopsys.com> Signed-off-by: Alexey Brodkin <abrodkin@synopsys.com>
2017-12-07log: Add documentationSimon Glass
Add documentation for the log system. Signed-off-by: Simon Glass <sjg@chromium.org> Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
2017-11-30rockchip: rk3399-puma: add code to allow forcing a power-on resetPhilipp Tomsich
The reset circuitry in the RK3399 only resets 'almost all logic' when a software reset is performed. To make our software maintenance easier in the future, we want to have the option (controlled by a DTS property) to force all reset causes other than a power-on reset to trigger a power-on reset via a GPIO trigger. This adds the necessary support to the rk3399-puma (i.e. RK3399-Q7) board-support and the documentation for the new property (sysreset-gpio) within the /config-node. Signed-off-by: Philipp Tomsich <philipp.tomsich@theobroma-systems.com> Tested-by: Klaus Goger <klaus.goger@theobroma-systems.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2017-11-30dt-bindings: spi: Add andestech atcspi200 spi binding docRick Chen
Add a document to describe Andestech atcspi200 spi and binding information. Signed-off-by: Rick Chen <rick@andestech.com>
2017-11-30dt-bindings: timer: Add andestech atcpit100 timerRick Chen
Add a document to describe Andestech atcpit100 timer and binding information. Signed-off-by: rick <rick@andestech.com> Signed-off-by: Rick Chen <rickchen36@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2017-11-28Merge git://git.denx.de/u-boot-socfpgaTom Rini
2017-11-26ARM: socfpga: add bindings doc for arria10 fpga managerTien Fong Chee
This DT binding doc is porting from Linux DT binding doc. commit 1adcbea4201a6852362aa5ece573f1f169b28113 Add a device tree bindings document for the SoCFPGA Arria10 FPGA Manager driver. Signed-off-by: Alan Tull <atull@opensource.altera.com> Acked-by: Rob Herring <robh@kernel.org> Acked-By: Moritz Fischer <moritz.fischer@ettus.com> Signed-off-by: Rob Herring <robh@kernel.org> Signed-off-by: Tien Fong Chee <tien.fong.chee@intel.com>
2017-11-26MAINTAINERS: Update maintainer for USB xHCIBin Meng
As discussed with Marek, this adds myself as the maintainer to offload the USB xHCI part. Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
2017-11-21rockchip: rk3188: use boot0 hook to load up SPL in 2 stepsPhilipp Tomsich
For the RK3188, the BROM will attempt to load up the first stage image (SPL for the RK3188) in two steps: first 1KB to offset 0x800 in the SRAM and then the remainder to offset 0xc00 in the SRAM. It always enters at 0x804, though. With this changeset, the RK3188 boot removes the TPL (stub) stage and builds a single SPL binary that utilizes the early back-to-bootrom via the boot0-hook. Consequently, the passing of the saved boot params via pmu->os_reg[2] is also removed. Signed-off-by: Philipp Tomsich <philipp.tomsich@theobroma-systems.com>
2017-11-21thermal: ti-bandgap: Add support for temperature sensorFaiz Abbas
The dra7xx series of SOCs contain a temperature sensor and an associated analog-to-digital converter (ADC) which produces an output which is proportional to the SOC temperature. Add support for this temperature sensor. Signed-off-by: Faiz Abbas <faiz_abbas@ti.com> Reviewed-by: Simon Glass <sjg@chromium.org>
2017-11-20Makefile: add coccicheck targetHeinrich Schuchardt
Coccinelle is a program for static code analysis. For details on Coccinelle see http://coccinelle.lip6.fr/ Add scripts/coccicheck copied from Linux kernel v4.14. The coccicheck script executes the tests *.cocci in directory scripts/coccinelle by calling spatch. In Makefile add a coccicheck target. You can use it with make coccicheck MODE=<mode> where mode in patch, report, context, org. Add a copy of Linux v4.14 file Documentation/dev-tools/coccinelle.rst as doc/README.coccinelle. Cc: Simon Glass <sjg@chromium.org> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2017-11-17env: Save environment at the end of an MMC partitionJorge Ramirez-Ortiz
Allow the platform to define a partition by name at the end of which the environment data will be located. Signed-off-by: Jorge Ramirez-Ortiz <jorge.ramirez-ortiz@linaro.org>
2017-11-10rockchip: doc: Fix U-Boot proper location for falconJagan Teki
This patch fixed U-Boot proper location has been missed to update in bewlo commit "rockchip: doc: update U-Boot location info" (sha1: 73e6dbe855f357a8330cfd53ff3033303611c1ad) Signed-off-by: Jagan Teki <jagan@amarulasolutions.com> Acked-by: Philipp Tomsich <philipp.tomsich@theobroma-systems.com> Reviewed-by: Philipp Tomsich <philipp.tomsich@theobroma-systems.com>
2017-11-10rockchip: doc: update U-Boot location infoGoldschmidt Simon
The U-Boot location has been moved to block 16384. This is 8MB, not 4MB. Signed-off-by: Simon Goldschmidt <sgoldschmidt@de.pepperl-fuchs.com> Reviewed-by: Jagan Teki <jagan@openedev.com> Acked-by: Philipp Tomsich <philipp.tomsich@theobroma-systems.com> Reviewed-by: Philipp Tomsich <philipp.tomsich@theobroma-systems.com>