summaryrefslogtreecommitdiffstats
path: root/meta-yocto-bsp
diff options
context:
space:
mode:
authorRoss Burton <ross.burton@arm.com>2024-03-28 12:22:23 +0000
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-03-28 12:35:11 +0000
commit07d62690b0c3d1250809401e349fc528ff9947f7 (patch)
tree75bfb6da94c6bb156634b77725341dc06f868d7b /meta-yocto-bsp
parentf2ff622a4c83948f7612c535034f5dbcb28781a8 (diff)
downloadpoky-07d62690b0c3d1250809401e349fc528ff9947f7.tar.gz
README.hardware.md: fix Markdown formatting
This file is has a .md extension so it's meant to be Markdown. Reformat it so that it's actually Markdown. (From meta-yocto rev: 53470f2050efeb09935c238f22ce62a0185d0e13) Signed-off-by: Ross Burton <ross.burton@arm.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'meta-yocto-bsp')
-rw-r--r--meta-yocto-bsp/README.hardware.md65
1 files changed, 32 insertions, 33 deletions
diff --git a/meta-yocto-bsp/README.hardware.md b/meta-yocto-bsp/README.hardware.md
index bb8f57913f..a129063afa 100644
--- a/meta-yocto-bsp/README.hardware.md
+++ b/meta-yocto-bsp/README.hardware.md
@@ -1,5 +1,5 @@
1 Yocto Project Hardware Reference BSPs README 1Yocto Project Hardware Reference BSPs README
2 ============================================ 2============================================
3 3
4This file gives details about using the Yocto Project hardware reference BSPs. 4This file gives details about using the Yocto Project hardware reference BSPs.
5The machines supported can be seen in the conf/machine/ directory and are listed 5The machines supported can be seen in the conf/machine/ directory and are listed
@@ -13,9 +13,7 @@ consult the documentation for your board/device.
13Support for additional devices is normally added by adding BSP layers to your 13Support for additional devices is normally added by adding BSP layers to your
14configuration. For more information please see the Yocto Board Support Package 14configuration. For more information please see the Yocto Board Support Package
15(BSP) Developer's Guide - documentation source is in documentation/bspguide or 15(BSP) Developer's Guide - documentation source is in documentation/bspguide or
16download the PDF from: 16download the PDF from https://docs.yoctoproject.org/
17
18 https://docs.yoctoproject.org/
19 17
20Note that these reference BSPs use the linux-yocto kernel and in general don't 18Note that these reference BSPs use the linux-yocto kernel and in general don't
21pull in binary module support for the platforms. This means some device functionality 19pull in binary module support for the platforms. This means some device functionality
@@ -27,9 +25,9 @@ Hardware Reference Boards
27 25
28The following boards are supported by the meta-yocto-bsp layer: 26The following boards are supported by the meta-yocto-bsp layer:
29 27
30 * Texas Instruments Beaglebone (beaglebone-yocto) 28 * Texas Instruments Beaglebone (`beaglebone-yocto`)
31 * General 64-bit Arm SystemReady platforms (genericarm64) 29 * General 64-bit Arm SystemReady platforms (`genericarm64`)
32 * General IA platforms (genericx86 and genericx86-64) 30 * General IA platforms (`genericx86` and `genericx86-64`)
33 31
34For more information see the board's section below. The appropriate MACHINE 32For more information see the board's section below. The appropriate MACHINE
35variable value corresponding to the board is given in brackets. 33variable value corresponding to the board is given in brackets.
@@ -40,36 +38,36 @@ Reference Board Maintenance and Contributions
40Please refer to our contributor guide here: https://docs.yoctoproject.org/dev/contributor-guide/ 38Please refer to our contributor guide here: https://docs.yoctoproject.org/dev/contributor-guide/
41for full details on how to submit changes. 39for full details on how to submit changes.
42 40
43As a quick guide, patches should be sent to poky@lists.yoctoproject.org 41As a quick guide, patches should be sent to <poky@lists.yoctoproject.org>
44The git command to do that would be: 42The git command to do that would be:
45 43
46 git send-email -M -1 --to poky@lists.yoctoproject.org 44 git send-email -M -1 --to poky@lists.yoctoproject.org
47 45
48Send pull requests, patches, comments or questions about meta-yocto-bsp to 46Send pull requests, patches, comments or questions about meta-yocto-bsp to
49poky@lists.yoctoproject.org 47<poky@lists.yoctoproject.org>.
50 48
51Maintainers: Kevin Hao <kexin.hao@windriver.com> 49Maintainers:
52 Bruce Ashfield <bruce.ashfield@gmail.com> 50* Kevin Hao <kexin.hao@windriver.com>
51* Bruce Ashfield <bruce.ashfield@gmail.com>
53 52
54Consumer Devices 53Consumer Devices
55================ 54================
56 55
57The following consumer devices are supported by the meta-yocto-bsp layer: 56The following consumer devices are supported by the meta-yocto-bsp layer:
58 57
59 * Arm-based SystemReady devices (genericarm64) 58 * Arm-based SystemReady devices (`genericarm64`)
60 * Intel x86 based PCs and devices (genericx86 and genericx86-64) 59 * Intel x86 based PCs and devices (`genericx86` and `genericx86-64`)
61 60
62For more information see the device's section below. The appropriate MACHINE 61For more information see the device's section below. The appropriate MACHINE
63variable value corresponding to the device is given in brackets. 62variable value corresponding to the device is given in brackets.
64 63
65 64
66 65Specific Hardware Documentation
67 Specific Hardware Documentation 66===============================
68 ===============================
69 67
70 68
71Intel x86 based PCs and devices (genericx86*) 69Intel x86 based PCs and devices (genericx86*)
72============================================= 70---------------------------------------------
73 71
74The genericx86 and genericx86-64 MACHINE are tested on the following platforms: 72The genericx86 and genericx86-64 MACHINE are tested on the following platforms:
75 73
@@ -96,17 +94,18 @@ target boot device is /dev/sdb, be sure to verify this and use the correct
96device as the following commands are run as root and are not reversable. 94device as the following commands are run as root and are not reversable.
97 95
98USB Device: 96USB Device:
97
99 1. Build a live image. This image type consists of a simple filesystem 98 1. Build a live image. This image type consists of a simple filesystem
100 without a partition table, which is suitable for USB keys, and with the 99 without a partition table, which is suitable for USB keys, and with the
101 default setup for the genericx86 machine, this image type is built 100 default setup for the genericx86 machine, this image type is built
102 automatically for any image you build. For example: 101 automatically for any image you build. For example:
103 102
104 $ bitbake core-image-minimal 103 $ bitbake core-image-minimal
105 104
106 2. Use the "dd" utility to write the image to the raw block device. For 105 2. Use the `dd` utility to write the image to the raw block device. For
107 example: 106 example:
108 107
109 # dd if=core-image-minimal-genericx86.hddimg of=/dev/sdb 108 # dd if=core-image-minimal-genericx86.hddimg of=/dev/sdb
110 109
111 If the device fails to boot with "Boot error" displayed, or apparently 110 If the device fails to boot with "Boot error" displayed, or apparently
112 stops just after the SYSLINUX version banner, it is likely the BIOS cannot 111 stops just after the SYSLINUX version banner, it is likely the BIOS cannot
@@ -120,16 +119,16 @@ USB Device:
120 119
121 2. Use a ".wic" image with an EFI partition 120 2. Use a ".wic" image with an EFI partition
122 121
123 a) With a default grub-efi bootloader: 122 1. With a default grub-efi bootloader:
124 # dd if=core-image-minimal-genericx86-64.wic of=/dev/sdb
125 123
126 b) Use systemd-boot instead 124 # dd if=core-image-minimal-genericx86-64.wic of=/dev/sdb
127 - Build an image with EFI_PROVIDER="systemd-boot" then use the above
128 dd command to write the image to a USB stick.
129 125
126 2. Use systemd-boot instead. Build an image with `EFI_PROVIDER="systemd-boot"` then use the above
127 `dd` command to write the image to a USB stick.
130 128
131SystemReady Arm Platforms 129
132========================= 130SystemReady Arm Platforms (genericarm64)
131----------------------------------------
133 132
134The genericarm64 MACHINE is designed to work on standard SystemReady IR 133The genericarm64 MACHINE is designed to work on standard SystemReady IR
135compliant boards with preinstalled firmware. 134compliant boards with preinstalled firmware.
@@ -143,15 +142,15 @@ SD card for booting, for example.
143 142
144 143
145Texas Instruments Beaglebone (beaglebone-yocto) 144Texas Instruments Beaglebone (beaglebone-yocto)
146=============================================== 145-----------------------------------------------
147 146
148The Beaglebone is an ARM Cortex-A8 development board with USB, Ethernet, 2D/3D 147The Beaglebone is an ARM Cortex-A8 development board with USB, Ethernet, 2D/3D
149accelerated graphics, audio, serial, JTAG, and SD/MMC. The Black adds a faster 148accelerated graphics, audio, serial, JTAG, and SD/MMC. The Black adds a faster
150CPU, more RAM, eMMC flash and a micro HDMI port. The beaglebone MACHINE is 149CPU, more RAM, eMMC flash and a micro HDMI port. The beaglebone MACHINE is
151tested on the following platforms: 150tested on the following platforms:
152 151
153 o Beaglebone Black A6 152 * Beaglebone Black A6
154 o Beaglebone A6 (the original "White" model) 153 * Beaglebone A6 (the original "White" model)
155 154
156The Beaglebone Black has eMMC, while the White does not. Pressing the USER/BOOT 155The Beaglebone Black has eMMC, while the White does not. Pressing the USER/BOOT
157button when powering on will temporarily change the boot order. But for the sake 156button when powering on will temporarily change the boot order. But for the sake
@@ -169,10 +168,10 @@ From a Linux system with access to the image files perform the following steps:
169 168
170 1. Build an image. For example: 169 1. Build an image. For example:
171 170
172 $ bitbake core-image-minimal 171 $ bitbake core-image-minimal
173 172
174 2. Use the "dd" utility to write the image to the SD card. For example: 173 2. Use the "dd" utility to write the image to the SD card. For example:
175 174
176 # dd if=core-image-minimal-beaglebone-yocto.wic of=/dev/sdb 175 # dd if=core-image-minimal-beaglebone-yocto.wic of=/dev/sdb
177 176
178 3. Insert the SD card into the Beaglebone and boot the board. 177 3. Insert the SD card into the Beaglebone and boot the board.