public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Rebecca Cran" <rebecca@bsdio.com>
To: devel@edk2.groups.io, Leif Lindholm <leif@nuviainc.com>,
	Ard Biesheuvel <ardb+tianocore@kernel.org>
Cc: Rebecca Cran <rebecca@bsdio.com>
Subject: [edk2-platforms PATCH v2 6/6] Platform/BeagleBoard: Add Readme.rst
Date: Tue, 28 Sep 2021 13:33:20 -0600	[thread overview]
Message-ID: <20210928193320.197688-7-rebecca@bsdio.com> (raw)
In-Reply-To: <20210928193320.197688-1-rebecca@bsdio.com>

Add a Readme.rst file to explain what this package is for, link to
additional information etc.

Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
---
 Platform/BeagleBoard/BeagleBoardPkg/Readme.rst | 28 ++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/Platform/BeagleBoard/BeagleBoardPkg/Readme.rst b/Platform/BeagleBoard/BeagleBoardPkg/Readme.rst
new file mode 100644
index 000000000000..b97eb02eea66
--- /dev/null
+++ b/Platform/BeagleBoard/BeagleBoardPkg/Readme.rst
@@ -0,0 +1,28 @@
+==============
+BeagleBoardPkg
+==============
+
+This package provides support for the original OMAP3530-based BeagleBoard
+(https://beagleboard.org/beagleboard).
+
+Resources
+---------
+
+- BeagleBoard.org Support Page: https://elinux.org/Beagleboard:Main_Page#BeagleBoard
+- BeagleBoard Main Page: https://elinux.org/Beagleboard:BeagleBoard
+- BeagleBoard Community Page: https://elinux.org/BeagleBoard_Community
+- System Reference Manual: https://github.com/beagleboard/BeagleBoard/blob/master/BeagleBoard_revC5_SRM.pdf
+- OMAP35x Technical Reference Manual: https://www.ti.com/lit/ug/spruf98y/spruf98y.pdf
+- Schematics, BOM etc.: https://github.com/beagleboard/beagleboard
+
+Running
+-------
+
+Since the BeagleBoard only has 64KB SRAM and the ROM bootloader can load
+a maximum 128KB file, we use the `MLO` loader to load EDK2.
+BEAGLEBOARD_EFI.fd must be renamed to `u-boot.bin`.
+
+The programs in the Tools directory are for adding the Configuration Header
+that's needed for code to run via the ROM bootloader. They're kept for reference
+and are unused.
+
-- 
2.31.1



  parent reply	other threads:[~2021-09-28 19:33 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-28 19:33 [edk2-platforms PATCH v2 0/6] Some BeagleBoardPkg fixes Rebecca Cran
2021-09-28 19:33 ` [edk2-platforms PATCH v2 1/6] BeagleBoardPkg: Remove the configuration and image headers from flash Rebecca Cran
2021-09-28 19:33 ` [edk2-platforms PATCH v2 2/6] BeagleBoardPkg: Remove PerformanceLib from build Rebecca Cran
2021-09-28 19:33 ` [edk2-platforms PATCH v2 3/6] BeagleBoardPkg: Align PE sections to 4K Rebecca Cran
2021-09-28 19:33 ` [edk2-platforms PATCH v2 4/6] Omap35xxPkg: InterruptDxe: add gEfiCpuArchProtocolGuid runtime dependency Rebecca Cran
2021-09-28 19:33 ` [edk2-platforms PATCH v2 5/6] Platform/BeagleBoard: bump Fv size to 768KB to fix NOOPT build Rebecca Cran
2021-09-28 19:33 ` Rebecca Cran [this message]
2021-09-30 13:57 ` [edk2-platforms PATCH v2 0/6] Some BeagleBoardPkg fixes Leif Lindholm

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210928193320.197688-7-rebecca@bsdio.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox