From 87a4fc1081d51f70545a5a4732f70ebdfb8e5dc1 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Thu, 21 Oct 2021 03:17:51 +0200 Subject: doc: require Sphinx 3.4.3 For enums documented according to the requirements in chapter "Structure, union, and enumeration documentation" of https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html errors occur with Sphinx 2.4.4 which disappear with Sphinx 3.4.3, e.g. /builds/u-boot/custodians/u-boot-efi/doc/api/sysreset:6: ./include/sysreset.h:60:Unknown interpreted text role "enum". Sphinx 3.4.3 is the version used by Debian in the current release. Signed-off-by: Heinrich Schuchardt --- doc/sphinx/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/sphinx/requirements.txt b/doc/sphinx/requirements.txt index af79d2c..4555a94 100644 --- a/doc/sphinx/requirements.txt +++ b/doc/sphinx/requirements.txt @@ -1,4 +1,4 @@ docutils==0.16 -Sphinx==2.4.4 +Sphinx==3.4.3 sphinx_rtd_theme six -- cgit v1.1 From 1da0b6ab2a2183b1c9e4cf3623d3e796931c861f Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Thu, 23 Sep 2021 11:06:16 +0200 Subject: doc: add system reset to API documentation Complete the Sphinx documentation in include/sysreset.h Add the include to the generated HTML documentation of the U-Boot API. Signed-off-by: Heinrich Schuchardt --- doc/api/index.rst | 1 + doc/api/sysreset.rst | 7 +++++++ 2 files changed, 8 insertions(+) create mode 100644 doc/api/sysreset.rst (limited to 'doc') diff --git a/doc/api/index.rst b/doc/api/index.rst index ea02aa5..281d1dc 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -15,5 +15,6 @@ U-Boot API documentation rng sandbox serial + sysreset timer unicode diff --git a/doc/api/sysreset.rst b/doc/api/sysreset.rst new file mode 100644 index 0000000..a51b06c --- /dev/null +++ b/doc/api/sysreset.rst @@ -0,0 +1,7 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +System reset +============ + +.. kernel-doc:: include/sysreset.h + :internal: -- cgit v1.1 From 2443fd7032ffb28626f5705b9003269196d1e0f4 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Mon, 11 Oct 2021 14:59:48 +0200 Subject: doc: add python3-pkg-resources to build dependencies tools/binman/control.py imports Python package pkg_resources. Signed-off-by: Heinrich Schuchardt Reviewed-by: Simon Glass --- doc/build/gcc.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/build/gcc.rst b/doc/build/gcc.rst index 6c4b4ad..cdd7970 100644 --- a/doc/build/gcc.rst +++ b/doc/build/gcc.rst @@ -27,9 +27,9 @@ Depending on the build targets further packages maybe needed device-tree-compiler dfu-util efitools flex gdisk graphviz imagemagick \ liblz4-tool libguestfs-tools libncurses-dev libpython3-dev libsdl2-dev \ libssl-dev lz4 lzma lzma-alone openssl pkg-config python3 \ - python3-coverage python3-pycryptodome python3-pyelftools python3-pytest \ - python3-sphinxcontrib.apidoc python3-sphinx-rtd-theme python3-virtualenv \ - swig + python3-coverage python3-pkg-resources python3-pycryptodome \ + python3-pyelftools python3-pytest python3-sphinxcontrib.apidoc \ + python3-sphinx-rtd-theme python3-virtualenv swig SUSE based ~~~~~~~~~~ -- cgit v1.1 From 0c83c8ac407e4d889c4c0541070c191a3d977299 Mon Sep 17 00:00:00 2001 From: Thomas Huth Date: Tue, 19 Oct 2021 09:25:52 +0200 Subject: doc: Remove obsolete README.440-DDR-performance file The PPC 440 support has been removed in commit 98f705c9cefd ("powerpc: remove 4xx support") already, so this file is certainly not required anymore. Signed-off-by: Thomas Huth Reviewed-by: Stefan Roese --- doc/README.440-DDR-performance | 90 ------------------------------------------ 1 file changed, 90 deletions(-) delete mode 100644 doc/README.440-DDR-performance (limited to 'doc') diff --git a/doc/README.440-DDR-performance b/doc/README.440-DDR-performance deleted file mode 100644 index 66b97bc..0000000 --- a/doc/README.440-DDR-performance +++ /dev/null @@ -1,90 +0,0 @@ -AMCC suggested to set the PMU bit to 0 for best performace on the -PPC440 DDR controller. The 440er common DDR setup files (sdram.c & -spd_sdram.c) are changed accordingly. So all 440er boards using -these setup routines will automatically receive this performance -increase. - -Please see below some benchmarks done by AMCC to demonstrate this -performance changes: - - ----------------------------------------- -SDRAM0_CFG0[PMU] = 1 (U-Boot default for Bamboo, Yosemite and Yellowstone) ----------------------------------------- -Stream benchmark results -------------------------------------------------------------- -This system uses 8 bytes per DOUBLE PRECISION word. -------------------------------------------------------------- -Array size = 2000000, Offset = 0 -Total memory required = 45.8 MB. -Each test is run 10 times, but only -the *best* time for each is used. -------------------------------------------------------------- -Your clock granularity/precision appears to be 1 microseconds. -Each test below will take on the order of 112345 microseconds. - (= 112345 clock ticks) -Increase the size of the arrays if this shows that you are not getting -at least 20 clock ticks per test. -------------------------------------------------------------- -WARNING -- The above is only a rough guideline. -For best results, please be sure you know the precision of your system -timer. -------------------------------------------------------------- -Function Rate (MB/s) RMS time Min time Max time -Copy: 256.7683 0.1248 0.1246 0.1250 -Scale: 246.0157 0.1302 0.1301 0.1302 -Add: 255.0316 0.1883 0.1882 0.1885 -Triad: 253.1245 0.1897 0.1896 0.1899 - - -TTCP Benchmark Results -ttcp-t: socket -ttcp-t: connect -ttcp-t: buflen=8192, nbuf=2048, align=16384/0, port=5000 tcp -> -localhost -ttcp-t: 16777216 bytes in 0.28 real seconds = 454.29 Mbit/sec +++ -ttcp-t: 2048 I/O calls, msec/call = 0.14, calls/sec = 7268.57 -ttcp-t: 0.0user 0.1sys 0:00real 60% 0i+0d 0maxrss 0+2pf 3+1506csw - ----------------------------------------- -SDRAM0_CFG0[PMU] = 0 (Suggested modification) -Setting PMU = 0 provides a noticeable performance improvement *2% to -5% improvement in memory performance. -*Improves the Mbit/sec for TTCP benchmark by almost 76%. ----------------------------------------- -Stream benchmark results -------------------------------------------------------------- -This system uses 8 bytes per DOUBLE PRECISION word. -------------------------------------------------------------- -Array size = 2000000, Offset = 0 -Total memory required = 45.8 MB. -Each test is run 10 times, but only -the *best* time for each is used. -------------------------------------------------------------- -Your clock granularity/precision appears to be 1 microseconds. -Each test below will take on the order of 120066 microseconds. - (= 120066 clock ticks) -Increase the size of the arrays if this shows that you are not getting -at least 20 clock ticks per test. -------------------------------------------------------------- -WARNING -- The above is only a rough guideline. -For best results, please be sure you know the precision of your system -timer. -------------------------------------------------------------- -Function Rate (MB/s) RMS time Min time Max time -Copy: 262.5167 0.1221 0.1219 0.1223 -Scale: 258.4856 0.1238 0.1238 0.1240 -Add: 262.5404 0.1829 0.1828 0.1831 -Triad: 266.8594 0.1800 0.1799 0.1802 - -TTCP Benchmark Results -ttcp-t: socket -ttcp-t: connect -ttcp-t: buflen=8192, nbuf=2048, align=16384/0, port=5000 tcp -> -localhost -ttcp-t: 16777216 bytes in 0.16 real seconds = 804.06 Mbit/sec +++ -ttcp-t: 2048 I/O calls, msec/call = 0.08, calls/sec = 12864.89 -ttcp-t: 0.0user 0.0sys 0:00real 46% 0i+0d 0maxrss 0+2pf 120+1csw - - -2006-07-28, Stefan Roese -- cgit v1.1