* [PATCH master 2/5] Documentation: boards: stm32mp: search engine optimization
2020-10-20 3:29 [PATCH master 1/5] Documentation: smhfs: fix some typos Ahmad Fatoum
@ 2020-10-20 3:29 ` Ahmad Fatoum
2020-10-20 3:29 ` [PATCH master 3/5] Documentation: glossary: add some extra info Ahmad Fatoum
` (3 subsequent siblings)
4 siblings, 0 replies; 6+ messages in thread
From: Ahmad Fatoum @ 2020-10-20 3:29 UTC (permalink / raw)
To: barebox; +Cc: Ahmad Fatoum
The vendor calls it STM32MP1. Have this name appear in the documentation
as well to be easier found during web search.
Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
Documentation/boards/stm32mp.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/boards/stm32mp.rst b/Documentation/boards/stm32mp.rst
index a06578602d9d..87fff7d1259b 100644
--- a/Documentation/boards/stm32mp.rst
+++ b/Documentation/boards/stm32mp.rst
@@ -5,7 +5,7 @@ The STM32MP is a line of 32-bit ARM SoCs. They reuse peripherals of the
STM32 line of microcontrollers and can have a STM32 MCU embedded as co-processor
as well.
-The boot process of the STM32MP SoC is a two step process.
+The boot process of the STM32MP1 SoC is a two step process.
The first stage boot loader (FSBL) is loaded by the ROM code into the built-in
SYSRAM and executed. The FSBL sets up the SDRAM, install a secure monitor and
then the second stage boot loader (SSBL) is loaded into DRAM.
--
2.28.0
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 6+ messages in thread* [PATCH master 3/5] Documentation: glossary: add some extra info
2020-10-20 3:29 [PATCH master 1/5] Documentation: smhfs: fix some typos Ahmad Fatoum
2020-10-20 3:29 ` [PATCH master 2/5] Documentation: boards: stm32mp: search engine optimization Ahmad Fatoum
@ 2020-10-20 3:29 ` Ahmad Fatoum
2020-10-20 3:29 ` [PATCH master 4/5] Documentation: x86: note EFI support Ahmad Fatoum
` (2 subsequent siblings)
4 siblings, 0 replies; 6+ messages in thread
From: Ahmad Fatoum @ 2020-10-20 3:29 UTC (permalink / raw)
To: barebox; +Cc: Ahmad Fatoum
Besides expanding the acronyms, a short description text can be useful.
Add one where appropriate and sort the list alphabetically.
Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
Documentation/glossary.rst | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/Documentation/glossary.rst b/Documentation/glossary.rst
index 106dce98a9ef..88d356fbab64 100644
--- a/Documentation/glossary.rst
+++ b/Documentation/glossary.rst
@@ -5,17 +5,17 @@ Glossary
.. glossary:: :sorted:
- FDT
- Flattened Device Tree
+ DTS
+ Device Tree Source
DTB
- Device Tree Blob (or Binary)
+ Device Tree Blob (or Binary). The result of compiling a DTS.
- DTS
- Device Tree Source
+ FDT
+ Flattened Device Tree. A DTB loaded into memory.
PBL
- Pre BootLoader image
+ Pre BootLoader image. The board-specific entry point attached in front of multi-image barebox binaries.
ESP
EFI System Partition
--
2.28.0
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 6+ messages in thread* [PATCH master 4/5] Documentation: x86: note EFI support
2020-10-20 3:29 [PATCH master 1/5] Documentation: smhfs: fix some typos Ahmad Fatoum
2020-10-20 3:29 ` [PATCH master 2/5] Documentation: boards: stm32mp: search engine optimization Ahmad Fatoum
2020-10-20 3:29 ` [PATCH master 3/5] Documentation: glossary: add some extra info Ahmad Fatoum
@ 2020-10-20 3:29 ` Ahmad Fatoum
2020-10-20 3:29 ` [PATCH master 5/5] Documentation: aarch64-qemu-virt: note physical target support Ahmad Fatoum
2020-10-21 9:51 ` [PATCH master 1/5] Documentation: smhfs: fix some typos Sascha Hauer
4 siblings, 0 replies; 6+ messages in thread
From: Ahmad Fatoum @ 2020-10-20 3:29 UTC (permalink / raw)
To: barebox; +Cc: Ahmad Fatoum
Most users are better served by using the EFI support. Add an info box
to nudge them into the correct direction.
Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
Documentation/boards/x86.rst | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/Documentation/boards/x86.rst b/Documentation/boards/x86.rst
index 4514a766a216..c0d5a64b9d45 100644
--- a/Documentation/boards/x86.rst
+++ b/Documentation/boards/x86.rst
@@ -1,6 +1,11 @@
x86
===
+.. note::
+ This is about legacy x86 PC boot, which is not as well supported as booting
+ under UEFI. Refer to :doc:`boards/efi.rst` for documentation on the barebox
+ EFI support.
+
Features
--------
--
2.28.0
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH master 5/5] Documentation: aarch64-qemu-virt: note physical target support
2020-10-20 3:29 [PATCH master 1/5] Documentation: smhfs: fix some typos Ahmad Fatoum
` (2 preceding siblings ...)
2020-10-20 3:29 ` [PATCH master 4/5] Documentation: x86: note EFI support Ahmad Fatoum
@ 2020-10-20 3:29 ` Ahmad Fatoum
2020-10-21 9:51 ` [PATCH master 1/5] Documentation: smhfs: fix some typos Sascha Hauer
4 siblings, 0 replies; 6+ messages in thread
From: Ahmad Fatoum @ 2020-10-20 3:29 UTC (permalink / raw)
To: barebox; +Cc: Ahmad Fatoum
The documentation structure is a bit unfortunate because it says
4.1. Aarch64, but lists only a single virtual board. Fix this by:
- Removing the Aarch64 heading, as there are more boards outside it
- Explicitly note that this documentation page only refers to the
virtual target
Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
---
Documentation/boards/aarch64-qemu-virt.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/boards/aarch64-qemu-virt.rst b/Documentation/boards/aarch64-qemu-virt.rst
index e21791af164a..5f6cd882d546 100644
--- a/Documentation/boards/aarch64-qemu-virt.rst
+++ b/Documentation/boards/aarch64-qemu-virt.rst
@@ -1,8 +1,8 @@
-Aarch64
-=======
-
Aarch64 Qemu virt
------------------
+=================
+
+Besides a number of physical ARM64 targets, barebox also supports a
+``qemu-virt64`` board.
Running barebox on QEMU aarch64 virt machine
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
--
2.28.0
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 6+ messages in thread* Re: [PATCH master 1/5] Documentation: smhfs: fix some typos
2020-10-20 3:29 [PATCH master 1/5] Documentation: smhfs: fix some typos Ahmad Fatoum
` (3 preceding siblings ...)
2020-10-20 3:29 ` [PATCH master 5/5] Documentation: aarch64-qemu-virt: note physical target support Ahmad Fatoum
@ 2020-10-21 9:51 ` Sascha Hauer
4 siblings, 0 replies; 6+ messages in thread
From: Sascha Hauer @ 2020-10-21 9:51 UTC (permalink / raw)
To: Ahmad Fatoum; +Cc: barebox
On Tue, Oct 20, 2020 at 05:29:33AM +0200, Ahmad Fatoum wrote:
> There are a few typos in the document. Fix them.
>
> Signed-off-by: Ahmad Fatoum <a.fatoum@pengutronix.de>
> ---
> Documentation/filesystems/smhfs.rst | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
Applied, thanks
Sascha
>
> diff --git a/Documentation/filesystems/smhfs.rst b/Documentation/filesystems/smhfs.rst
> index 8f8a0ec6b74d..f70ca6015fcf 100644
> --- a/Documentation/filesystems/smhfs.rst
> +++ b/Documentation/filesystems/smhfs.rst
> @@ -8,12 +8,12 @@ File I/O over ARM semihosting support
> Target Side Setup
> -----------------
>
> -barebox can communicate with debug programms attached via SWD/JTAG by
> +barebox can communicate with debug programs attached via SWD/JTAG by
> means of ARM semihosting protocol.
>
> -Not all of the I/O primitives neccessary to implement a full
> +Not all of the I/O primitives necessary to implement a full
> filesystem are exposed in ARM semihosting API and because of that some
> -aspects of filesystem funcionality are missing. Implementation does
> +aspects of filesystem functionality are missing. Implementation does
> not have support for listing directories. This means a
> :ref:`command_ls` to a SMHFS-mounted path will show an empty
> directory. Nevertheless, the files are there.
> @@ -29,7 +29,7 @@ Host Side Setup
> ---------------
>
> FIXME: Currently OpenOCD does not work correctly if Barebox is built
> -with MMU enabled, so before using this featrue, please make sure that
> +with MMU enabled, so before using this feature, please make sure that
> MMU is disabled in your particular configuration
>
> To make semihosting work host machine connected to the target via
> --
> 2.28.0
>
>
> _______________________________________________
> barebox mailing list
> barebox@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/barebox
>
--
Pengutronix e.K. | |
Steuerwalder Str. 21 | http://www.pengutronix.de/ |
31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
^ permalink raw reply [flat|nested] 6+ messages in thread