diff options
| l---------[-rw-r--r--] | README.hardware | 425 | ||||
| l--------- | README.poky | 1 | ||||
| -rw-r--r-- | meta-poky/README.poky (renamed from README) | 2 | ||||
| -rw-r--r-- | meta-yocto-bsp/README.hardware | 407 |
4 files changed, 410 insertions, 425 deletions
diff --git a/README.hardware b/README.hardware index dc6a08dea7..8b6258d49d 100644..120000 --- a/README.hardware +++ b/README.hardware | |||
| @@ -1,424 +1 @@ | |||
| 1 | Poky Hardware README | meta-yocto-bsp/README.hardware \ No newline at end of file | |
| 2 | ==================== | ||
| 3 | |||
| 4 | This file gives details about using Poky with the reference machines | ||
| 5 | supported out of the box. A full list of supported reference target machines | ||
| 6 | can be found by looking in the following directories: | ||
| 7 | |||
| 8 | meta/conf/machine/ | ||
| 9 | meta-yocto-bsp/conf/machine/ | ||
| 10 | |||
| 11 | If you are in doubt about using Poky/OpenEmbedded with your hardware, consult | ||
| 12 | the documentation for your board/device. | ||
| 13 | |||
| 14 | Support for additional devices is normally added by creating BSP layers - for | ||
| 15 | more information please see the Yocto Board Support Package (BSP) Developer's | ||
| 16 | Guide - documentation source is in documentation/bspguide or download the PDF | ||
| 17 | from: | ||
| 18 | |||
| 19 | http://yoctoproject.org/documentation | ||
| 20 | |||
| 21 | Support for physical reference hardware has now been split out into a | ||
| 22 | meta-yocto-bsp layer which can be removed separately from other layers if not | ||
| 23 | needed. | ||
| 24 | |||
| 25 | |||
| 26 | QEMU Emulation Targets | ||
| 27 | ====================== | ||
| 28 | |||
| 29 | To simplify development, the build system supports building images to | ||
| 30 | work with the QEMU emulator in system emulation mode. Several architectures | ||
| 31 | are currently supported: | ||
| 32 | |||
| 33 | * ARM (qemuarm) | ||
| 34 | * x86 (qemux86) | ||
| 35 | * x86-64 (qemux86-64) | ||
| 36 | * PowerPC (qemuppc) | ||
| 37 | * MIPS (qemumips) | ||
| 38 | |||
| 39 | Use of the QEMU images is covered in the Yocto Project Reference Manual. | ||
| 40 | The appropriate MACHINE variable value corresponding to the target is given | ||
| 41 | in brackets. | ||
| 42 | |||
| 43 | |||
| 44 | Hardware Reference Boards | ||
| 45 | ========================= | ||
| 46 | |||
| 47 | The following boards are supported by the meta-yocto-bsp layer: | ||
| 48 | |||
| 49 | * Texas Instruments Beaglebone (beaglebone) | ||
| 50 | * Freescale MPC8315E-RDB (mpc8315e-rdb) | ||
| 51 | |||
| 52 | For more information see the board's section below. The appropriate MACHINE | ||
| 53 | variable value corresponding to the board is given in brackets. | ||
| 54 | |||
| 55 | Reference Board Maintenance | ||
| 56 | =========================== | ||
| 57 | |||
| 58 | Send pull requests, patches, comments or questions about meta-yocto-bsps to poky@yoctoproject.org | ||
| 59 | |||
| 60 | Maintainers: Kevin Hao <kexin.hao@windriver.com> | ||
| 61 | Bruce Ashfield <bruce.ashfield@windriver.com> | ||
| 62 | |||
| 63 | Consumer Devices | ||
| 64 | ================ | ||
| 65 | |||
| 66 | The following consumer devices are supported by the meta-yocto-bsp layer: | ||
| 67 | |||
| 68 | * Intel x86 based PCs and devices (genericx86) | ||
| 69 | * Ubiquiti Networks EdgeRouter Lite (edgerouter) | ||
| 70 | |||
| 71 | For more information see the device's section below. The appropriate MACHINE | ||
| 72 | variable value corresponding to the device is given in brackets. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | Specific Hardware Documentation | ||
| 77 | =============================== | ||
| 78 | |||
| 79 | |||
| 80 | Intel x86 based PCs and devices (genericx86*) | ||
| 81 | ============================================= | ||
| 82 | |||
| 83 | The genericx86 and genericx86-64 MACHINE are tested on the following platforms: | ||
| 84 | |||
| 85 | Intel Xeon/Core i-Series: | ||
| 86 | + Intel NUC5 Series - ix-52xx Series SOC (Broadwell) | ||
| 87 | + Intel NUC6 Series - ix-62xx Series SOC (Skylake) | ||
| 88 | + Intel Shumway Xeon Server | ||
| 89 | |||
| 90 | Intel Atom platforms: | ||
| 91 | + MinnowBoard MAX - E3825 SOC (Bay Trail) | ||
| 92 | + MinnowBoard MAX - Turbot (ADI Engineering) - E3826 SOC (Bay Trail) | ||
| 93 | - These boards can be either 32bot or 64bit modes depending on firmware | ||
| 94 | - See minnowboard.org for details | ||
| 95 | + Intel Braswell SOC | ||
| 96 | |||
| 97 | and is likely to work on many unlisted Atom/Core/Xeon based devices. The MACHINE | ||
| 98 | type supports ethernet, wifi, sound, and Intel/vesa graphics by default in | ||
| 99 | addition to common PC input devices, busses, and so on. | ||
| 100 | |||
| 101 | Depending on the device, it can boot from a traditional hard-disk, a USB device, | ||
| 102 | or over the network. Writing generated images to physical media is | ||
| 103 | straightforward with a caveat for USB devices. The following examples assume the | ||
| 104 | target boot device is /dev/sdb, be sure to verify this and use the correct | ||
| 105 | device as the following commands are run as root and are not reversable. | ||
| 106 | |||
| 107 | USB Device: | ||
| 108 | 1. Build a live image. This image type consists of a simple filesystem | ||
| 109 | without a partition table, which is suitable for USB keys, and with the | ||
| 110 | default setup for the genericx86 machine, this image type is built | ||
| 111 | automatically for any image you build. For example: | ||
| 112 | |||
| 113 | $ bitbake core-image-minimal | ||
| 114 | |||
| 115 | 2. Use the "dd" utility to write the image to the raw block device. For | ||
| 116 | example: | ||
| 117 | |||
| 118 | # dd if=core-image-minimal-genericx86.hddimg of=/dev/sdb | ||
| 119 | |||
| 120 | If the device fails to boot with "Boot error" displayed, or apparently | ||
| 121 | stops just after the SYSLINUX version banner, it is likely the BIOS cannot | ||
| 122 | understand the physical layout of the disk (or rather it expects a | ||
| 123 | particular layout and cannot handle anything else). There are two possible | ||
| 124 | solutions to this problem: | ||
| 125 | |||
| 126 | 1. Change the BIOS USB Device setting to HDD mode. The label will vary by | ||
| 127 | device, but the idea is to force BIOS to read the Cylinder/Head/Sector | ||
| 128 | geometry from the device. | ||
| 129 | |||
| 130 | 2. Use a ".wic" image with an EFI partition | ||
| 131 | |||
| 132 | a) With a default grub-efi bootloader: | ||
| 133 | # dd if=core-image-minimal-genericx86-64.wic of=/dev/sdb | ||
| 134 | |||
| 135 | b) Use systemd-boot instead | ||
| 136 | - Build an image with EFI_PROVIDER="systemd-boot" then use the above | ||
| 137 | dd command to write the image to a USB stick. | ||
| 138 | |||
| 139 | |||
| 140 | Texas Instruments Beaglebone (beaglebone) | ||
| 141 | ========================================= | ||
| 142 | |||
| 143 | The Beaglebone is an ARM Cortex-A8 development board with USB, Ethernet, 2D/3D | ||
| 144 | accelerated graphics, audio, serial, JTAG, and SD/MMC. The Black adds a faster | ||
| 145 | CPU, more RAM, eMMC flash and a micro HDMI port. The beaglebone MACHINE is | ||
| 146 | tested on the following platforms: | ||
| 147 | |||
| 148 | o Beaglebone Black A6 | ||
| 149 | o Beaglebone A6 (the original "White" model) | ||
| 150 | |||
| 151 | The Beaglebone Black has eMMC, while the White does not. Pressing the USER/BOOT | ||
| 152 | button when powering on will temporarily change the boot order. But for the sake | ||
| 153 | of simplicity, these instructions assume you have erased the eMMC on the Black, | ||
| 154 | so its boot behavior matches that of the White and boots off of SD card. To do | ||
| 155 | this, issue the following commands from the u-boot prompt: | ||
| 156 | |||
| 157 | # mmc dev 1 | ||
| 158 | # mmc erase 0 512 | ||
| 159 | |||
| 160 | To further tailor these instructions for your board, please refer to the | ||
| 161 | documentation at http://www.beagleboard.org/bone and http://www.beagleboard.org/black | ||
| 162 | |||
| 163 | From a Linux system with access to the image files perform the following steps: | ||
| 164 | |||
| 165 | 1. Build an image. For example: | ||
| 166 | |||
| 167 | $ bitbake core-image-minimal | ||
| 168 | |||
| 169 | 2. Use the "dd" utility to write the image to the SD card. For example: | ||
| 170 | |||
| 171 | # dd core-image-minimal-beaglebone.wic of=/dev/sdb | ||
| 172 | |||
| 173 | 3. Insert the SD card into the Beaglebone and boot the board. | ||
| 174 | |||
| 175 | Freescale MPC8315E-RDB (mpc8315e-rdb) | ||
| 176 | ===================================== | ||
| 177 | |||
| 178 | The MPC8315 PowerPC reference platform (MPC8315E-RDB) is aimed at hardware and | ||
| 179 | software development of network attached storage (NAS) and digital media server | ||
| 180 | applications. The MPC8315E-RDB features the PowerQUICC II Pro processor, which | ||
| 181 | includes a built-in security accelerator. | ||
| 182 | |||
| 183 | (Note: you may find it easier to order MPC8315E-RDBA; this appears to be the | ||
| 184 | same board in an enclosure with accessories. In any case it is fully | ||
| 185 | compatible with the instructions given here.) | ||
| 186 | |||
| 187 | Setup instructions | ||
| 188 | ------------------ | ||
| 189 | |||
| 190 | You will need the following: | ||
| 191 | * NFS root setup on your workstation | ||
| 192 | * TFTP server installed on your workstation | ||
| 193 | * Straight-thru 9-conductor serial cable (DB9, M/F) connected from your | ||
| 194 | PC to UART1 | ||
| 195 | * Ethernet connected to the first ethernet port on the board | ||
| 196 | |||
| 197 | --- Preparation --- | ||
| 198 | |||
| 199 | Note: if you have altered your board's ethernet MAC address(es) from the | ||
| 200 | defaults, or you need to do so because you want multiple boards on the same | ||
| 201 | network, then you will need to change the values in the dts file (patch | ||
| 202 | linux/arch/powerpc/boot/dts/mpc8315erdb.dts within the kernel source). If | ||
| 203 | you have left them at the factory default then you shouldn't need to do | ||
| 204 | anything here. | ||
| 205 | |||
| 206 | Note: To boot from USB disk you need u-boot that supports 'ext2load usb' | ||
| 207 | command. You need to setup TFTP server, load u-boot from there and | ||
| 208 | flash it to NOR flash. | ||
| 209 | |||
| 210 | Beware! Flashing bootloader is potentially dangerous operation that can | ||
| 211 | brick your device if done incorrectly. Please, make sure you understand | ||
| 212 | what below commands mean before executing them. | ||
| 213 | |||
| 214 | Load the new u-boot.bin from TFTP server to memory address 200000 | ||
| 215 | => tftp 200000 u-boot.bin | ||
| 216 | |||
| 217 | Disable flash protection | ||
| 218 | => protect off all | ||
| 219 | |||
| 220 | Erase the old u-boot from fe000000 to fe06ffff in NOR flash. | ||
| 221 | The size is 0x70000 (458752 bytes) | ||
| 222 | => erase fe000000 fe06ffff | ||
| 223 | |||
| 224 | Copy the new u-boot from address 200000 to fe000000 | ||
| 225 | the size is 0x70000. It has to be greater or equal to u-boot.bin size | ||
| 226 | => cp.b 200000 fe000000 70000 | ||
| 227 | |||
| 228 | Enable flash protection again | ||
| 229 | => protect on all | ||
| 230 | |||
| 231 | Reset the board | ||
| 232 | => reset | ||
| 233 | |||
| 234 | --- Booting from USB disk --- | ||
| 235 | |||
| 236 | 1. Flash partitioned image to the USB disk | ||
| 237 | |||
| 238 | # dd if=core-image-minimal-mpc8315e-rdb.wic of=/dev/sdb | ||
| 239 | |||
| 240 | 2. Plug USB disk into the MPC8315 board | ||
| 241 | |||
| 242 | 3. Connect the board's first serial port to your workstation and then start up | ||
| 243 | your favourite serial terminal so that you will be able to interact with | ||
| 244 | the serial console. If you don't have a favourite, picocom is suggested: | ||
| 245 | |||
| 246 | $ picocom /dev/ttyUSB0 -b 115200 | ||
| 247 | |||
| 248 | 4. Power up or reset the board and press a key on the terminal when prompted | ||
| 249 | to get to the U-Boot command line | ||
| 250 | |||
| 251 | 5. Optional. Load the u-boot.bin from the USB disk: | ||
| 252 | |||
| 253 | => usb start | ||
| 254 | => ext2load usb 0:1 200000 u-boot.bin | ||
| 255 | |||
| 256 | and flash it to NOR flash as described above. | ||
| 257 | |||
| 258 | 6. Load the kernel and dtb from the first partition of the USB disk: | ||
| 259 | |||
| 260 | => usb start | ||
| 261 | => ext2load usb 0:1 1000000 uImage | ||
| 262 | => ext2load usb 0:1 2000000 dtb | ||
| 263 | |||
| 264 | 7. Set bootargs and boot up the device | ||
| 265 | |||
| 266 | => setenv bootargs root=/dev/sdb2 rw rootwait console=ttyS0,115200 | ||
| 267 | => bootm 1000000 - 2000000 | ||
| 268 | |||
| 269 | |||
| 270 | --- Booting from NFS root --- | ||
| 271 | |||
| 272 | Load the kernel and dtb (device tree blob), and boot the system as follows: | ||
| 273 | |||
| 274 | 1. Get the kernel (uImage-mpc8315e-rdb.bin) and dtb (uImage-mpc8315e-rdb.dtb) | ||
| 275 | files from the tmp/deploy directory, and make them available on your TFTP | ||
| 276 | server. | ||
| 277 | |||
| 278 | 2. Connect the board's first serial port to your workstation and then start up | ||
| 279 | your favourite serial terminal so that you will be able to interact with | ||
| 280 | the serial console. If you don't have a favourite, picocom is suggested: | ||
| 281 | |||
| 282 | $ picocom /dev/ttyUSB0 -b 115200 | ||
| 283 | |||
| 284 | 3. Power up or reset the board and press a key on the terminal when prompted | ||
| 285 | to get to the U-Boot command line | ||
| 286 | |||
| 287 | 4. Set up the environment in U-Boot: | ||
| 288 | |||
| 289 | => setenv ipaddr <board ip> | ||
| 290 | => setenv serverip <tftp server ip> | ||
| 291 | => setenv bootargs root=/dev/nfs rw nfsroot=<nfsroot ip>:<rootfs path> ip=<board ip>:<server ip>:<gateway ip>:255.255.255.0:mpc8315e:eth0:off console=ttyS0,115200 | ||
| 292 | |||
| 293 | 5. Download the kernel and dtb, and boot: | ||
| 294 | |||
| 295 | => tftp 1000000 uImage-mpc8315e-rdb.bin | ||
| 296 | => tftp 2000000 uImage-mpc8315e-rdb.dtb | ||
| 297 | => bootm 1000000 - 2000000 | ||
| 298 | |||
| 299 | --- Booting from JFFS2 root --- | ||
| 300 | |||
| 301 | 1. First boot the board with NFS root. | ||
| 302 | |||
| 303 | 2. Erase the MTD partition which will be used as root: | ||
| 304 | |||
| 305 | $ flash_eraseall /dev/mtd3 | ||
| 306 | |||
| 307 | 3. Copy the JFFS2 image to the MTD partition: | ||
| 308 | |||
| 309 | $ flashcp core-image-minimal-mpc8315e-rdb.jffs2 /dev/mtd3 | ||
| 310 | |||
| 311 | 4. Then reboot the board and set up the environment in U-Boot: | ||
| 312 | |||
| 313 | => setenv bootargs root=/dev/mtdblock3 rootfstype=jffs2 console=ttyS0,115200 | ||
| 314 | |||
| 315 | |||
| 316 | Ubiquiti Networks EdgeRouter Lite (edgerouter) | ||
| 317 | ============================================== | ||
| 318 | |||
| 319 | The EdgeRouter Lite is part of the EdgeMax series. It is a MIPS64 router | ||
| 320 | (based on the Cavium Octeon processor) with 512MB of RAM, which uses an | ||
| 321 | internal USB pendrive for storage. | ||
| 322 | |||
| 323 | Setup instructions | ||
| 324 | ------------------ | ||
| 325 | |||
| 326 | You will need the following: | ||
| 327 | * RJ45 -> serial ("rollover") cable connected from your PC to the CONSOLE | ||
| 328 | port on the device | ||
| 329 | * Ethernet connected to the first ethernet port on the board | ||
| 330 | |||
| 331 | If using NFS as part of the setup process, you will also need: | ||
| 332 | * NFS root setup on your workstation | ||
| 333 | * TFTP server installed on your workstation (if fetching the kernel from | ||
| 334 | TFTP, see below). | ||
| 335 | |||
| 336 | --- Preparation --- | ||
| 337 | |||
| 338 | Build an image (e.g. core-image-minimal) using "edgerouter" as the MACHINE. | ||
| 339 | In the following instruction it is based on core-image-minimal. Another target | ||
| 340 | may be similiar with it. | ||
| 341 | |||
| 342 | --- Booting from NFS root / kernel via TFTP --- | ||
| 343 | |||
| 344 | Load the kernel, and boot the system as follows: | ||
| 345 | |||
| 346 | 1. Get the kernel (vmlinux) file from the tmp/deploy/images/edgerouter | ||
| 347 | directory, and make them available on your TFTP server. | ||
| 348 | |||
| 349 | 2. Connect the board's first serial port to your workstation and then start up | ||
| 350 | your favourite serial terminal so that you will be able to interact with | ||
| 351 | the serial console. If you don't have a favourite, picocom is suggested: | ||
| 352 | |||
| 353 | $ picocom /dev/ttyS0 -b 115200 | ||
| 354 | |||
| 355 | 3. Power up or reset the board and press a key on the terminal when prompted | ||
| 356 | to get to the U-Boot command line | ||
| 357 | |||
| 358 | 4. Set up the environment in U-Boot: | ||
| 359 | |||
| 360 | => setenv ipaddr <board ip> | ||
| 361 | => setenv serverip <tftp server ip> | ||
| 362 | |||
| 363 | 5. Download the kernel and boot: | ||
| 364 | |||
| 365 | => tftp tftp $loadaddr vmlinux | ||
| 366 | => bootoctlinux $loadaddr coremask=0x3 root=/dev/nfs rw nfsroot=<nfsroot ip>:<rootfs path> ip=<board ip>:<server ip>:<gateway ip>:<netmask>:edgerouter:eth0:off mtdparts=phys_mapped_flash:512k(boot0),512k(boot1),64k@3072k(eeprom) | ||
| 367 | |||
| 368 | --- Booting from USB disk --- | ||
| 369 | |||
| 370 | To boot from the USB disk, you either need to remove it from the edgerouter | ||
| 371 | box and populate it from another computer, or use a previously booted NFS | ||
| 372 | image and populate from the edgerouter itself. | ||
| 373 | |||
| 374 | Type 1: Use partitioned image | ||
| 375 | ----------------------------- | ||
| 376 | |||
| 377 | Steps: | ||
| 378 | |||
| 379 | 1. Remove the USB disk from the edgerouter and insert it into a computer | ||
| 380 | that has access to your build artifacts. | ||
| 381 | |||
| 382 | 2. Flash the image. | ||
| 383 | |||
| 384 | # dd if=core-image-minimal-edgerouter.wic of=/dev/sdb | ||
| 385 | |||
| 386 | 3. Insert USB disk into the edgerouter and boot it. | ||
| 387 | |||
| 388 | Type 2: NFS | ||
| 389 | ----------- | ||
| 390 | |||
| 391 | Note: If you place the kernel on the ext3 partition, you must re-create the | ||
| 392 | ext3 filesystem, since the factory u-boot can only handle 128 byte inodes and | ||
| 393 | cannot read the partition otherwise. | ||
| 394 | |||
| 395 | These boot instructions assume that you have recreated the ext3 filesystem with | ||
| 396 | 128 byte inodes, you have an updated uboot or you are running and image capable | ||
| 397 | of making the filesystem on the board itself. | ||
| 398 | |||
| 399 | |||
| 400 | 1. Boot from NFS root | ||
| 401 | |||
| 402 | 2. Mount the USB disk partition 2 and then extract the contents of | ||
| 403 | tmp/deploy/core-image-XXXX.tar.bz2 into it. | ||
| 404 | |||
| 405 | Before starting, copy core-image-minimal-xxx.tar.bz2 and vmlinux into | ||
| 406 | rootfs path on your workstation. | ||
| 407 | |||
| 408 | and then, | ||
| 409 | |||
| 410 | # mount /dev/sda2 /media/sda2 | ||
| 411 | # tar -xvjpf core-image-minimal-XXX.tar.bz2 -C /media/sda2 | ||
| 412 | # cp vmlinux /media/sda2/boot/vmlinux | ||
| 413 | # umount /media/sda2 | ||
| 414 | # reboot | ||
| 415 | |||
| 416 | 3. Reboot the board and press a key on the terminal when prompted to get to the U-Boot | ||
| 417 | command line: | ||
| 418 | |||
| 419 | # reboot | ||
| 420 | |||
| 421 | 4. Load the kernel and boot: | ||
| 422 | |||
| 423 | => ext2load usb 0:2 $loadaddr boot/vmlinux | ||
| 424 | => bootoctlinux $loadaddr coremask=0x3 root=/dev/sda2 rw rootwait mtdparts=phys_mapped_flash:512k(boot0),512k(boot1),64k@3072k(eeprom) | ||
diff --git a/README.poky b/README.poky new file mode 120000 index 0000000000..1877dca102 --- /dev/null +++ b/README.poky | |||
| @@ -0,0 +1 @@ | |||
| meta-poky/README.poky \ No newline at end of file | |||
diff --git a/README b/meta-poky/README.poky index 9a526779ba..0a42843186 100644 --- a/README +++ b/meta-poky/README.poky | |||
| @@ -55,4 +55,4 @@ repository. | |||
| 55 | Mailing list: openembedded-core@lists.openembedded.org | 55 | Mailing list: openembedded-core@lists.openembedded.org |
| 56 | 56 | ||
| 57 | Note: The scripts directory should be treated with extra care as it is a mix of | 57 | Note: The scripts directory should be treated with extra care as it is a mix of |
| 58 | oe-core and poky-specific files. | 58 | oe-core and poky-specific files from meta-poky. |
diff --git a/meta-yocto-bsp/README.hardware b/meta-yocto-bsp/README.hardware new file mode 100644 index 0000000000..84c5afa909 --- /dev/null +++ b/meta-yocto-bsp/README.hardware | |||
| @@ -0,0 +1,407 @@ | |||
| 1 | Yocto Project Hardware Reference BSPs README | ||
| 2 | ============================================ | ||
| 3 | |||
| 4 | This file gives details about using the Yocto Project hardware reference BSPs. | ||
| 5 | The machines supported can be seen in the conf/machine/ directory and are listed | ||
| 6 | below. There is one per supported hardware architecture and these are primarily | ||
| 7 | used to validate that the Yocto Project works on the hardware arctectures of | ||
| 8 | those machines. | ||
| 9 | |||
| 10 | If you are in doubt about using Poky/OpenEmbedded/Yocto Project with your hardware, | ||
| 11 | consult the documentation for your board/device. | ||
| 12 | |||
| 13 | Support for additional devices is normally added by adding BSP layers to your | ||
| 14 | configuration. For more information please see the Yocto Board Support Package | ||
| 15 | (BSP) Developer's Guide - documentation source is in documentation/bspguide or | ||
| 16 | download the PDF from: | ||
| 17 | |||
| 18 | http://yoctoproject.org/documentation | ||
| 19 | |||
| 20 | Note that these reference BSPs use the linux-yocto kernel and in general don't | ||
| 21 | pull in binary module support for the platforms. This means some device functionality | ||
| 22 | may be limited compared to a 'full' BSP which may be available. | ||
| 23 | |||
| 24 | |||
| 25 | Hardware Reference Boards | ||
| 26 | ========================= | ||
| 27 | |||
| 28 | The following boards are supported by the meta-yocto-bsp layer: | ||
| 29 | |||
| 30 | * Texas Instruments Beaglebone (beaglebone) | ||
| 31 | * Freescale MPC8315E-RDB (mpc8315e-rdb) | ||
| 32 | * Ubiquiti Networks EdgeRouter Lite (edgerouter) | ||
| 33 | * General IA platforms (genericx86 and genericx86-64) | ||
| 34 | |||
| 35 | For more information see the board's section below. The appropriate MACHINE | ||
| 36 | variable value corresponding to the board is given in brackets. | ||
| 37 | |||
| 38 | Reference Board Maintenance | ||
| 39 | =========================== | ||
| 40 | |||
| 41 | Send pull requests, patches, comments or questions about meta-yocto-bsps to poky@yoctoproject.org | ||
| 42 | |||
| 43 | Maintainers: Kevin Hao <kexin.hao@windriver.com> | ||
| 44 | Bruce Ashfield <bruce.ashfield@windriver.com> | ||
| 45 | |||
| 46 | Consumer Devices | ||
| 47 | ================ | ||
| 48 | |||
| 49 | The following consumer devices are supported by the meta-yocto-bsp layer: | ||
| 50 | |||
| 51 | * Intel x86 based PCs and devices (genericx86) | ||
| 52 | * Ubiquiti Networks EdgeRouter Lite (edgerouter) | ||
| 53 | |||
| 54 | For more information see the device's section below. The appropriate MACHINE | ||
| 55 | variable value corresponding to the device is given in brackets. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | Specific Hardware Documentation | ||
| 60 | =============================== | ||
| 61 | |||
| 62 | |||
| 63 | Intel x86 based PCs and devices (genericx86*) | ||
| 64 | ============================================= | ||
| 65 | |||
| 66 | The genericx86 and genericx86-64 MACHINE are tested on the following platforms: | ||
| 67 | |||
| 68 | Intel Xeon/Core i-Series: | ||
| 69 | + Intel NUC5 Series - ix-52xx Series SOC (Broadwell) | ||
| 70 | + Intel NUC6 Series - ix-62xx Series SOC (Skylake) | ||
| 71 | + Intel Shumway Xeon Server | ||
| 72 | |||
| 73 | Intel Atom platforms: | ||
| 74 | + MinnowBoard MAX - E3825 SOC (Bay Trail) | ||
| 75 | + MinnowBoard MAX - Turbot (ADI Engineering) - E3826 SOC (Bay Trail) | ||
| 76 | - These boards can be either 32bot or 64bit modes depending on firmware | ||
| 77 | - See minnowboard.org for details | ||
| 78 | + Intel Braswell SOC | ||
| 79 | |||
| 80 | and is likely to work on many unlisted Atom/Core/Xeon based devices. The MACHINE | ||
| 81 | type supports ethernet, wifi, sound, and Intel/vesa graphics by default in | ||
| 82 | addition to common PC input devices, busses, and so on. | ||
| 83 | |||
| 84 | Depending on the device, it can boot from a traditional hard-disk, a USB device, | ||
| 85 | or over the network. Writing generated images to physical media is | ||
| 86 | straightforward with a caveat for USB devices. The following examples assume the | ||
| 87 | target boot device is /dev/sdb, be sure to verify this and use the correct | ||
| 88 | device as the following commands are run as root and are not reversable. | ||
| 89 | |||
| 90 | USB Device: | ||
| 91 | 1. Build a live image. This image type consists of a simple filesystem | ||
| 92 | without a partition table, which is suitable for USB keys, and with the | ||
| 93 | default setup for the genericx86 machine, this image type is built | ||
| 94 | automatically for any image you build. For example: | ||
| 95 | |||
| 96 | $ bitbake core-image-minimal | ||
| 97 | |||
| 98 | 2. Use the "dd" utility to write the image to the raw block device. For | ||
| 99 | example: | ||
| 100 | |||
| 101 | # dd if=core-image-minimal-genericx86.hddimg of=/dev/sdb | ||
| 102 | |||
| 103 | If the device fails to boot with "Boot error" displayed, or apparently | ||
| 104 | stops just after the SYSLINUX version banner, it is likely the BIOS cannot | ||
| 105 | understand the physical layout of the disk (or rather it expects a | ||
| 106 | particular layout and cannot handle anything else). There are two possible | ||
| 107 | solutions to this problem: | ||
| 108 | |||
| 109 | 1. Change the BIOS USB Device setting to HDD mode. The label will vary by | ||
| 110 | device, but the idea is to force BIOS to read the Cylinder/Head/Sector | ||
| 111 | geometry from the device. | ||
| 112 | |||
| 113 | 2. Use a ".wic" image with an EFI partition | ||
| 114 | |||
| 115 | a) With a default grub-efi bootloader: | ||
| 116 | # dd if=core-image-minimal-genericx86-64.wic of=/dev/sdb | ||
| 117 | |||
| 118 | b) Use systemd-boot instead | ||
| 119 | - Build an image with EFI_PROVIDER="systemd-boot" then use the above | ||
| 120 | dd command to write the image to a USB stick. | ||
| 121 | |||
| 122 | |||
| 123 | Texas Instruments Beaglebone (beaglebone) | ||
| 124 | ========================================= | ||
| 125 | |||
| 126 | The Beaglebone is an ARM Cortex-A8 development board with USB, Ethernet, 2D/3D | ||
| 127 | accelerated graphics, audio, serial, JTAG, and SD/MMC. The Black adds a faster | ||
| 128 | CPU, more RAM, eMMC flash and a micro HDMI port. The beaglebone MACHINE is | ||
| 129 | tested on the following platforms: | ||
| 130 | |||
| 131 | o Beaglebone Black A6 | ||
| 132 | o Beaglebone A6 (the original "White" model) | ||
| 133 | |||
| 134 | The Beaglebone Black has eMMC, while the White does not. Pressing the USER/BOOT | ||
| 135 | button when powering on will temporarily change the boot order. But for the sake | ||
| 136 | of simplicity, these instructions assume you have erased the eMMC on the Black, | ||
| 137 | so its boot behavior matches that of the White and boots off of SD card. To do | ||
| 138 | this, issue the following commands from the u-boot prompt: | ||
| 139 | |||
| 140 | # mmc dev 1 | ||
| 141 | # mmc erase 0 512 | ||
| 142 | |||
| 143 | To further tailor these instructions for your board, please refer to the | ||
| 144 | documentation at http://www.beagleboard.org/bone and http://www.beagleboard.org/black | ||
| 145 | |||
| 146 | From a Linux system with access to the image files perform the following steps: | ||
| 147 | |||
| 148 | 1. Build an image. For example: | ||
| 149 | |||
| 150 | $ bitbake core-image-minimal | ||
| 151 | |||
| 152 | 2. Use the "dd" utility to write the image to the SD card. For example: | ||
| 153 | |||
| 154 | # dd core-image-minimal-beaglebone.wic of=/dev/sdb | ||
| 155 | |||
| 156 | 3. Insert the SD card into the Beaglebone and boot the board. | ||
| 157 | |||
| 158 | Freescale MPC8315E-RDB (mpc8315e-rdb) | ||
| 159 | ===================================== | ||
| 160 | |||
| 161 | The MPC8315 PowerPC reference platform (MPC8315E-RDB) is aimed at hardware and | ||
| 162 | software development of network attached storage (NAS) and digital media server | ||
| 163 | applications. The MPC8315E-RDB features the PowerQUICC II Pro processor, which | ||
| 164 | includes a built-in security accelerator. | ||
| 165 | |||
| 166 | (Note: you may find it easier to order MPC8315E-RDBA; this appears to be the | ||
| 167 | same board in an enclosure with accessories. In any case it is fully | ||
| 168 | compatible with the instructions given here.) | ||
| 169 | |||
| 170 | Setup instructions | ||
| 171 | ------------------ | ||
| 172 | |||
| 173 | You will need the following: | ||
| 174 | * NFS root setup on your workstation | ||
| 175 | * TFTP server installed on your workstation | ||
| 176 | * Straight-thru 9-conductor serial cable (DB9, M/F) connected from your | ||
| 177 | PC to UART1 | ||
| 178 | * Ethernet connected to the first ethernet port on the board | ||
| 179 | |||
| 180 | --- Preparation --- | ||
| 181 | |||
| 182 | Note: if you have altered your board's ethernet MAC address(es) from the | ||
| 183 | defaults, or you need to do so because you want multiple boards on the same | ||
| 184 | network, then you will need to change the values in the dts file (patch | ||
| 185 | linux/arch/powerpc/boot/dts/mpc8315erdb.dts within the kernel source). If | ||
| 186 | you have left them at the factory default then you shouldn't need to do | ||
| 187 | anything here. | ||
| 188 | |||
| 189 | Note: To boot from USB disk you need u-boot that supports 'ext2load usb' | ||
| 190 | command. You need to setup TFTP server, load u-boot from there and | ||
| 191 | flash it to NOR flash. | ||
| 192 | |||
| 193 | Beware! Flashing bootloader is potentially dangerous operation that can | ||
| 194 | brick your device if done incorrectly. Please, make sure you understand | ||
| 195 | what below commands mean before executing them. | ||
| 196 | |||
| 197 | Load the new u-boot.bin from TFTP server to memory address 200000 | ||
| 198 | => tftp 200000 u-boot.bin | ||
| 199 | |||
| 200 | Disable flash protection | ||
| 201 | => protect off all | ||
| 202 | |||
| 203 | Erase the old u-boot from fe000000 to fe06ffff in NOR flash. | ||
| 204 | The size is 0x70000 (458752 bytes) | ||
| 205 | => erase fe000000 fe06ffff | ||
| 206 | |||
| 207 | Copy the new u-boot from address 200000 to fe000000 | ||
| 208 | the size is 0x70000. It has to be greater or equal to u-boot.bin size | ||
| 209 | => cp.b 200000 fe000000 70000 | ||
| 210 | |||
| 211 | Enable flash protection again | ||
| 212 | => protect on all | ||
| 213 | |||
| 214 | Reset the board | ||
| 215 | => reset | ||
| 216 | |||
| 217 | --- Booting from USB disk --- | ||
| 218 | |||
| 219 | 1. Flash partitioned image to the USB disk | ||
| 220 | |||
| 221 | # dd if=core-image-minimal-mpc8315e-rdb.wic of=/dev/sdb | ||
| 222 | |||
| 223 | 2. Plug USB disk into the MPC8315 board | ||
| 224 | |||
| 225 | 3. Connect the board's first serial port to your workstation and then start up | ||
| 226 | your favourite serial terminal so that you will be able to interact with | ||
| 227 | the serial console. If you don't have a favourite, picocom is suggested: | ||
| 228 | |||
| 229 | $ picocom /dev/ttyUSB0 -b 115200 | ||
| 230 | |||
| 231 | 4. Power up or reset the board and press a key on the terminal when prompted | ||
| 232 | to get to the U-Boot command line | ||
| 233 | |||
| 234 | 5. Optional. Load the u-boot.bin from the USB disk: | ||
| 235 | |||
| 236 | => usb start | ||
| 237 | => ext2load usb 0:1 200000 u-boot.bin | ||
| 238 | |||
| 239 | and flash it to NOR flash as described above. | ||
| 240 | |||
| 241 | 6. Load the kernel and dtb from the first partition of the USB disk: | ||
| 242 | |||
| 243 | => usb start | ||
| 244 | => ext2load usb 0:1 1000000 uImage | ||
| 245 | => ext2load usb 0:1 2000000 dtb | ||
| 246 | |||
| 247 | 7. Set bootargs and boot up the device | ||
| 248 | |||
| 249 | => setenv bootargs root=/dev/sdb2 rw rootwait console=ttyS0,115200 | ||
| 250 | => bootm 1000000 - 2000000 | ||
| 251 | |||
| 252 | |||
| 253 | --- Booting from NFS root --- | ||
| 254 | |||
| 255 | Load the kernel and dtb (device tree blob), and boot the system as follows: | ||
| 256 | |||
| 257 | 1. Get the kernel (uImage-mpc8315e-rdb.bin) and dtb (uImage-mpc8315e-rdb.dtb) | ||
| 258 | files from the tmp/deploy directory, and make them available on your TFTP | ||
| 259 | server. | ||
| 260 | |||
| 261 | 2. Connect the board's first serial port to your workstation and then start up | ||
| 262 | your favourite serial terminal so that you will be able to interact with | ||
| 263 | the serial console. If you don't have a favourite, picocom is suggested: | ||
| 264 | |||
| 265 | $ picocom /dev/ttyUSB0 -b 115200 | ||
| 266 | |||
| 267 | 3. Power up or reset the board and press a key on the terminal when prompted | ||
| 268 | to get to the U-Boot command line | ||
| 269 | |||
| 270 | 4. Set up the environment in U-Boot: | ||
| 271 | |||
| 272 | => setenv ipaddr <board ip> | ||
| 273 | => setenv serverip <tftp server ip> | ||
| 274 | => setenv bootargs root=/dev/nfs rw nfsroot=<nfsroot ip>:<rootfs path> ip=<board ip>:<server ip>:<gateway ip>:255.255.255.0:mpc8315e:eth0:off console=ttyS0,115200 | ||
| 275 | |||
| 276 | 5. Download the kernel and dtb, and boot: | ||
| 277 | |||
| 278 | => tftp 1000000 uImage-mpc8315e-rdb.bin | ||
| 279 | => tftp 2000000 uImage-mpc8315e-rdb.dtb | ||
| 280 | => bootm 1000000 - 2000000 | ||
| 281 | |||
| 282 | --- Booting from JFFS2 root --- | ||
| 283 | |||
| 284 | 1. First boot the board with NFS root. | ||
| 285 | |||
| 286 | 2. Erase the MTD partition which will be used as root: | ||
| 287 | |||
| 288 | $ flash_eraseall /dev/mtd3 | ||
| 289 | |||
| 290 | 3. Copy the JFFS2 image to the MTD partition: | ||
| 291 | |||
| 292 | $ flashcp core-image-minimal-mpc8315e-rdb.jffs2 /dev/mtd3 | ||
| 293 | |||
| 294 | 4. Then reboot the board and set up the environment in U-Boot: | ||
| 295 | |||
| 296 | => setenv bootargs root=/dev/mtdblock3 rootfstype=jffs2 console=ttyS0,115200 | ||
| 297 | |||
| 298 | |||
| 299 | Ubiquiti Networks EdgeRouter Lite (edgerouter) | ||
| 300 | ============================================== | ||
| 301 | |||
| 302 | The EdgeRouter Lite is part of the EdgeMax series. It is a MIPS64 router | ||
| 303 | (based on the Cavium Octeon processor) with 512MB of RAM, which uses an | ||
| 304 | internal USB pendrive for storage. | ||
| 305 | |||
| 306 | Setup instructions | ||
| 307 | ------------------ | ||
| 308 | |||
| 309 | You will need the following: | ||
| 310 | * RJ45 -> serial ("rollover") cable connected from your PC to the CONSOLE | ||
| 311 | port on the device | ||
| 312 | * Ethernet connected to the first ethernet port on the board | ||
| 313 | |||
| 314 | If using NFS as part of the setup process, you will also need: | ||
| 315 | * NFS root setup on your workstation | ||
| 316 | * TFTP server installed on your workstation (if fetching the kernel from | ||
| 317 | TFTP, see below). | ||
| 318 | |||
| 319 | --- Preparation --- | ||
| 320 | |||
| 321 | Build an image (e.g. core-image-minimal) using "edgerouter" as the MACHINE. | ||
| 322 | In the following instruction it is based on core-image-minimal. Another target | ||
| 323 | may be similiar with it. | ||
| 324 | |||
| 325 | --- Booting from NFS root / kernel via TFTP --- | ||
| 326 | |||
| 327 | Load the kernel, and boot the system as follows: | ||
| 328 | |||
| 329 | 1. Get the kernel (vmlinux) file from the tmp/deploy/images/edgerouter | ||
| 330 | directory, and make them available on your TFTP server. | ||
| 331 | |||
| 332 | 2. Connect the board's first serial port to your workstation and then start up | ||
| 333 | your favourite serial terminal so that you will be able to interact with | ||
| 334 | the serial console. If you don't have a favourite, picocom is suggested: | ||
| 335 | |||
| 336 | $ picocom /dev/ttyS0 -b 115200 | ||
| 337 | |||
| 338 | 3. Power up or reset the board and press a key on the terminal when prompted | ||
| 339 | to get to the U-Boot command line | ||
| 340 | |||
| 341 | 4. Set up the environment in U-Boot: | ||
| 342 | |||
| 343 | => setenv ipaddr <board ip> | ||
| 344 | => setenv serverip <tftp server ip> | ||
| 345 | |||
| 346 | 5. Download the kernel and boot: | ||
| 347 | |||
| 348 | => tftp tftp $loadaddr vmlinux | ||
| 349 | => bootoctlinux $loadaddr coremask=0x3 root=/dev/nfs rw nfsroot=<nfsroot ip>:<rootfs path> ip=<board ip>:<server ip>:<gateway ip>:<netmask>:edgerouter:eth0:off mtdparts=phys_mapped_flash:512k(boot0),512k(boot1),64k@3072k(eeprom) | ||
| 350 | |||
| 351 | --- Booting from USB disk --- | ||
| 352 | |||
| 353 | To boot from the USB disk, you either need to remove it from the edgerouter | ||
| 354 | box and populate it from another computer, or use a previously booted NFS | ||
| 355 | image and populate from the edgerouter itself. | ||
| 356 | |||
| 357 | Type 1: Use partitioned image | ||
| 358 | ----------------------------- | ||
| 359 | |||
| 360 | Steps: | ||
| 361 | |||
| 362 | 1. Remove the USB disk from the edgerouter and insert it into a computer | ||
| 363 | that has access to your build artifacts. | ||
| 364 | |||
| 365 | 2. Flash the image. | ||
| 366 | |||
| 367 | # dd if=core-image-minimal-edgerouter.wic of=/dev/sdb | ||
| 368 | |||
| 369 | 3. Insert USB disk into the edgerouter and boot it. | ||
| 370 | |||
| 371 | Type 2: NFS | ||
| 372 | ----------- | ||
| 373 | |||
| 374 | Note: If you place the kernel on the ext3 partition, you must re-create the | ||
| 375 | ext3 filesystem, since the factory u-boot can only handle 128 byte inodes and | ||
| 376 | cannot read the partition otherwise. | ||
| 377 | |||
| 378 | These boot instructions assume that you have recreated the ext3 filesystem with | ||
| 379 | 128 byte inodes, you have an updated uboot or you are running and image capable | ||
| 380 | of making the filesystem on the board itself. | ||
| 381 | |||
| 382 | |||
| 383 | 1. Boot from NFS root | ||
| 384 | |||
| 385 | 2. Mount the USB disk partition 2 and then extract the contents of | ||
| 386 | tmp/deploy/core-image-XXXX.tar.bz2 into it. | ||
| 387 | |||
| 388 | Before starting, copy core-image-minimal-xxx.tar.bz2 and vmlinux into | ||
| 389 | rootfs path on your workstation. | ||
| 390 | |||
| 391 | and then, | ||
| 392 | |||
| 393 | # mount /dev/sda2 /media/sda2 | ||
| 394 | # tar -xvjpf core-image-minimal-XXX.tar.bz2 -C /media/sda2 | ||
| 395 | # cp vmlinux /media/sda2/boot/vmlinux | ||
| 396 | # umount /media/sda2 | ||
| 397 | # reboot | ||
| 398 | |||
| 399 | 3. Reboot the board and press a key on the terminal when prompted to get to the U-Boot | ||
| 400 | command line: | ||
| 401 | |||
| 402 | # reboot | ||
| 403 | |||
| 404 | 4. Load the kernel and boot: | ||
| 405 | |||
| 406 | => ext2load usb 0:2 $loadaddr boot/vmlinux | ||
| 407 | => bootoctlinux $loadaddr coremask=0x3 root=/dev/sda2 rw rootwait mtdparts=phys_mapped_flash:512k(boot0),512k(boot1),64k@3072k(eeprom) | ||
