summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/README.ae3502
-rw-r--r--doc/README.commands36
-rw-r--r--doc/README.video20
-rw-r--r--doc/device-tree-bindings/w1/mxc-w1.txt37
-rw-r--r--doc/driver-model/MIGRATION.txt10
-rw-r--r--doc/imx/mkimage/imximage.txt2
-rw-r--r--doc/imx/mkimage/mxsimage.txt4
7 files changed, 104 insertions, 7 deletions
diff --git a/doc/README.ae350 b/doc/README.ae350
index fe75b80eb7..189a6b7ec3 100644
--- a/doc/README.ae350
+++ b/doc/README.ae350
@@ -25,7 +25,7 @@ Build and boot steps
build:
1. Prepare the toolchains and make sure the $PATH to toolchains is correct.
-2. Use `make ax25-ae350_defconfig` in u-boot root to build the image.
+2. Use `make ae350_rv[32|64]_defconfig` in u-boot root to build the image for 32 or 64 bit.
Verification
====================
diff --git a/doc/README.commands b/doc/README.commands
index 1d29c4d91d..0ccadae0b7 100644
--- a/doc/README.commands
+++ b/doc/README.commands
@@ -28,6 +28,42 @@ comp: Pointer to the completion function. May be NULL.
entering the command arguments to complete the entry. Command
completion is only available if CONFIG_AUTO_COMPLETE is defined.
+Sub-command definition
+----------------------
+
+Likewise an array of cmd_tbl_t holding sub-commands can be created using either
+of the following macros:
+
+* U_BOOT_CMD_MKENT(name, maxargs, repeatable, command, "usage", "help")
+* U_BOOT_CMD_MKENTCOMPLETE(name, maxargs, repeatable, command, "usage, "help",
+ comp)
+
+This table has to be evaluated in the command function of the main command, e.g.
+
+ static cmd_tbl_t cmd_sub[] = {
+ U_BOOT_CMD_MKENT(foo, CONFIG_SYS_MAXARGS, 1, do_foo, "", ""),
+ U_BOOT_CMD_MKENT(bar, CONFIG_SYS_MAXARGS, 1, do_bar, "", ""),
+ };
+
+ static int do_cmd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
+ {
+ cmd_tbl_t *cp;
+
+ if (argc < 2)
+ return CMD_RET_USAGE;
+
+ /* drop sub-command argument */
+ argc--;
+ argv++;
+
+ cp = find_cmd_tbl(argv[0], cmd_ut_sub, ARRAY_SIZE(cmd_sub));
+
+ if (cp)
+ return cp->cmd(cmdtp, flag, argc, argv);
+
+ return CMD_RET_USAGE;
+ }
+
Command function
----------------
diff --git a/doc/README.video b/doc/README.video
index 09a26b1793..ced35bd2db 100644
--- a/doc/README.video
+++ b/doc/README.video
@@ -75,3 +75,23 @@ The sunxi U-Boot driver supports the following video-mode options:
For example to always use the hdmi connector, even if no cable is inserted,
using edid info when available and otherwise initalizing it at 1024x768@60Hz,
use: "setenv video-mode sunxi:1024x768-24@60,monitor=dvi,hpd=0,edid=1".
+
+
+TrueType fonts
+--------------
+
+U-Boot supports the use of antialiased TrueType fonts on some platforms. This
+has been tested in x86, ARMv7 and sandbox.
+
+To enable this, select CONFIG_CONSOLE_TRUETYPE. You can choose between several
+fonts, with CONSOLE_TRUETYPE_NIMBUS being the default.
+
+TrueType support requires floating point at present. On ARMv7 platforms you
+need to disable use of the private libgcc. You can do this by disabling
+CONFIG_USE_PRIVATE_LIBGCC. See chromebook_jerry for an example. Note that this
+increases U-Boot's size by about 70KB at present.
+
+On ARM you should also make sure your toolchain supports hardfp. This is
+normally given in the name of your toolchain, e.g. arm-linux-gnueabihf (hf
+means hardware floating point). You can also run gcc with -v to see if it has
+this option.
diff --git a/doc/device-tree-bindings/w1/mxc-w1.txt b/doc/device-tree-bindings/w1/mxc-w1.txt
new file mode 100644
index 0000000000..1fb49cc111
--- /dev/null
+++ b/doc/device-tree-bindings/w1/mxc-w1.txt
@@ -0,0 +1,37 @@
+NXP i.MX (MXC) One wire bus master controller
+=======================
+
+Child nodes are required in device tree. The driver will detect
+the devices serial number and then search in the child nodes in the device tree
+for the proper node and try to match it with the device.
+
+Also check doc/device-tree-bindings/w1-eeprom for possible child nodes drivers
+
+Driver:
+- drivers/w1/mxc_w1.c
+
+Required properties:
+- compatible : should be one of
+ "fsl,imx21-owire", "fsl,imx27-owire", "fsl,imx31-owire", "fsl,imx25-owire"
+ "fsl,imx25-owire", "fsl,imx35-owire", "fsl,imx50-owire", "fsl,imx53-owire"
+
+- reg : Address and length of the register set for the device
+
+Optional:
+* none
+
+Example:
+ onewire {
+ compatible = "fsl,imx53-owire";
+ reg = <0x63fa4000 0x4000>;
+ };
+
+Example with child:
+ onewire {
+ compatible = "fsl,imx53-owire";
+ reg = <0x63fa4000 0x4000>;
+
+ eeprom1: eeprom@0 {
+ compatible = "maxim,ds24xxx";
+ };
+ };
diff --git a/doc/driver-model/MIGRATION.txt b/doc/driver-model/MIGRATION.txt
index dce4aa3e1d..183d7f5293 100644
--- a/doc/driver-model/MIGRATION.txt
+++ b/doc/driver-model/MIGRATION.txt
@@ -55,9 +55,6 @@ CONFIG_DM_SPI_FLASH
Board Maintainers should submit the patches for enabling DM_SPI and DM_SPI_FLASH
to move the migration with in the deadline.
-Status: In progress
-Deadline: 2018.09
-
No dm conversion yet:
drivers/spi/cf_spi.c
drivers/spi/fsl_espi.c
@@ -69,6 +66,9 @@ No dm conversion yet:
drivers/spi/sh_spi.c
drivers/spi/soft_spi_legacy.c
+ Status: In progress
+ Deadline: 2019.04
+
Partially converted:
drivers/spi/atcspi200_spi.c
drivers/spi/davinci_spi.c
@@ -79,6 +79,10 @@ Partially converted:
drivers/spi/omap3_spi.c
drivers/spi/ti_qspi.c
+ Status: In progress
+ Deadline: 2019.07
+
--
Jagan Teki <jagan@openedev.com>
+12/24/2018
03/14/2018
diff --git a/doc/imx/mkimage/imximage.txt b/doc/imx/mkimage/imximage.txt
index 803682f558..f2cf23c5da 100644
--- a/doc/imx/mkimage/imximage.txt
+++ b/doc/imx/mkimage/imximage.txt
@@ -175,7 +175,7 @@ Warning: setting sector offset for DOS compatiblity
We have set 255 heads, 63 sector. We have to set the cylinder.
The value to be set can be calculated with:
- cilynder = <total size> / <heads> / <sectors> / <blocksize>
+ cylinder = <total size> / <heads> / <sectors> / <blocksize>
in this example,
1981284352 / 255 / 63 / 512 = 239.x = 239
diff --git a/doc/imx/mkimage/mxsimage.txt b/doc/imx/mkimage/mxsimage.txt
index c3975ee5e6..9159f93a97 100644
--- a/doc/imx/mkimage/mxsimage.txt
+++ b/doc/imx/mkimage/mxsimage.txt
@@ -46,7 +46,7 @@ These semantics and rules will be outlined now.
TAG [LAST]
- LAST :: Flag denoting the last section in the file
- - After a "TAG" unstruction, any of the following instructions may follow
+ - After a "TAG" instruction, any of the following instructions may follow
in any order and any quantity:
NOOP
@@ -142,7 +142,7 @@ These semantics and rules will be outlined now.
- An optional flags lines can be one of the following:
DISPLAYPROGRESS
- - Enable boot progress output form the BootROM.
+ - Enable boot progress output from the BootROM.
- If the boot progress output from the BootROM is enabled, the BootROM will
produce a letter on the Debug UART for each instruction it started processing.