summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Barker <pbarker@toganlabs.com>2017-05-23 10:26:05 +0100
committerAndrei Gherzan <andrei@gherzan.com>2017-05-26 12:16:52 +0100
commit03976f7ff12885d1205effe526c83b10ed4252fe (patch)
tree461c9904c83f102fb27096b5718b57aedb9311dd
parent4f2dd0f0e8d09afcb08c5ec57f20c763814596df (diff)
downloadmeta-raspberrypi-03976f7ff12885d1205effe526c83b10ed4252fe.tar.gz
docs: Initial split of README into docs directory
The top-level README document has got pretty unwieldy and so we need to switch to add some more structure to our documentation. The first step is to split out sub-sections of the README document into separate files in a new 'docs' directory. Whilst splitting up the README, we can also take the opportunity to tidy things up and fix a couple of typos. Signed-off-by: Paul Barker <pbarker@toganlabs.com>
Diffstat
-rw-r--r--README.md269
-rw-r--r--docs/contributing.md36
-rw-r--r--docs/extra-apps.md8
-rw-r--r--docs/extra-build-config.md183
-rw-r--r--docs/layer-contents.md24
5 files changed, 267 insertions, 253 deletions
diff --git a/README.md b/README.md
index 0d18b26..be23e25 100644
--- a/README.md
+++ b/README.md
@@ -8,283 +8,46 @@ Yocto BSP layer for the Raspberry Pi boards - http://www.raspberrypi.org/ .
8[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/agherzan/meta-raspberrypi) 8[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/agherzan/meta-raspberrypi)
9 9
10## Quick links 10## Quick links
11
11* Git repository web frontend: http://git.yoctoproject.org/cgit/cgit.cgi/meta-raspberrypi/ 12* Git repository web frontend: http://git.yoctoproject.org/cgit/cgit.cgi/meta-raspberrypi/
12* Mailing list (yocto mailing list): yocto@yoctoproject.org 13* Mailing list (yocto mailing list): yocto@yoctoproject.org
13* Issues management (Github Issues): https://github.com/agherzan/meta-raspberrypi/issues 14* Issues management (Github Issues): https://github.com/agherzan/meta-raspberrypi/issues
14 15
15## Contents 16## Description
16```
171. Description
182. Yocto BSP Layer - Raspberry Pi
19 2.A. How to use it
20 2.B. Images
213. Optional build configuration
22 3.A. Compressed deployed files
23 3.B. GPU memory
24 3.C. Add purchased license codecs
25 3.D. Disable overscan
26 3.E. Set overclocking options
27 3.F. Video camera support with V4L2 drivers
28 3.G. Enable offline compositing support
29 3.H. Enable kgdb over console support
30 3.I. Boot to U-Boot
31 3.J. Image with Initramfs
32 3.K. Device tree support
33 3.L. Enable SPI bus
34 3.M. Enable I2C
35 3.N. Enable PiTFT support
36 3.O. Misc. display
37 3.P. Enable UART support
384. Extra apps
39 4.A. omxplayer
405. Board Configuration
41 5.A. Audio Routing
426. Source code and mirrors
437. Contribution
44 7.A. Mailing list
45 7.B. Patches and pull requests
46 7.C. Github Issues
478. Maintainers
48```
49 17
50### 1. Description
51This is the general hardware specific BSP overlay for the RaspberryPi device. 18This is the general hardware specific BSP overlay for the RaspberryPi device.
19
52More information can be found at: http://www.raspberrypi.org/ (Official Site) 20More information can be found at: http://www.raspberrypi.org/ (Official Site)
53The core BSP part of meta-raspberrypi should work with different OpenEmbedded/Yocto distributions and layer stacks, such as: 21
22The core BSP part of meta-raspberrypi should work with different
23OpenEmbedded/Yocto distributions and layer stacks, such as:
24
54* Distro-less (only with OE-Core). 25* Distro-less (only with OE-Core).
55* Angstrom. 26* Angstrom.
56* Yocto/Poky (main focus of testing). 27* Yocto/Poky (main focus of testing).
57 28
58### 2. Yocto BSP Layer - RaspberryPi 29## Dependencies
30
59This layer depends on: 31This layer depends on:
32
60* URI: git://git.yoctoproject.org/poky 33* URI: git://git.yoctoproject.org/poky
61 * branch: master 34 * branch: master
62 * revision: HEAD 35 * revision: HEAD
36
63* URI: git://git.openembedded.org/meta-openembedded 37* URI: git://git.openembedded.org/meta-openembedded
64 * layers: meta-oe, meta-multimedia, meta-networking, meta-python 38 * layers: meta-oe, meta-multimedia, meta-networking, meta-python
65 * branch: master 39 * branch: master
66 * revision: HEAD 40 * revision: HEAD
67 41
68#### 2.A. How to use it 42## Quick Start
43
691. source poky/oe-init-build-env rpi-build 441. source poky/oe-init-build-env rpi-build
702. Add this layer to bblayers.conf and dthe dependencies above 452. Add this layer to bblayers.conf and the dependencies above
713. Set MACHINE in local.conf to one of the supported boards: 463. Set MACHINE in local.conf to one of the supported boards
72 * raspberrypi
73 * raspberrypi0
74 * raspberrypi0-wifi
75 * raspberrypi2
76 * raspberrypi3
77 * raspberrypi3-64 (64 bit kernel & userspace)
78 * raspberrypi-cm (dummy alias for raspberrypi)
79 * raspberrypi-cm3 (dummy alias for raspberrypi2)
804. bitbake rpi-hwup-image 474. bitbake rpi-hwup-image
815. dd to a SD card the generated sdimg file (use xzcat if rpi-sdimg.xz is used) 485. dd to a SD card the generated sdimg file (use xzcat if rpi-sdimg.xz is used)
826. Boot your RPI. 496. Boot your RPI.
83 50
84#### 2.B. Images 51## Maintainers
85* rpi-hwup-image
86 * Hardware up image
87* rpi-basic-image
88 * Based on rpi-hwup-image with some added features (ex: splash)
89* rpi-test-image
90 * Image based on rpi-basic-image which includes most of the packages in this layer and some media samples.
91
92### 3. Optional build configuration
93There are a set of ways in which a user can influence different paramenters of the build. We list here the ones that are closely related to this BSP or specific to it. For the rest please check: http://www.yoctoproject.org/docs/latest/ref-manual/ref-manual.html
94
95#### 3.A. Compressed deployed files
961. Overwrite IMAGE_FSTYPES in local.conf
97 * `IMAGE_FSTYPES = "tar.bz2 ext3.xz"`
982. Overwrite SDIMG_ROOTFS_TYPE in local.conf
99 * `SDIMG_ROOTFS_TYPE = "ext3.xz"`
1003. Overwrite SDIMG_COMPRESSION in local.conf
101 * `SDIMG_COMPRESSION = "xz"`
102
103Accommodate the values above to your own needs (ex: ext3 / ext4).
104
105#### 3.B. GPU memory
106| Variable | Details |
107|----------------|---------------------------------------------------------------------|
108| `GPU_MEM` | GPU memory in megabyte. Sets the memory split between the ARM and |
109| | GPU. ARM gets the remaining memory. Min 16. Default 64. |
110| `GPU_MEM_256` | GPU memory in megabyte for the 256MB Raspberry Pi. Ignored by the |
111| | 512MB RP. Overrides gpu_mem. Max 192. Default not set. |
112| `GPU_MEM_512` | GPU memory in megabyte for the 512MB Raspberry Pi. Ignored by the |
113| | 256MB RP. Overrides gpu_mem. Max 448. Default not set. |
114| `GPU_MEM_1024` | GPU memory in megabyte for the 1024MB Raspberry Pi. Ignored by the |
115| | 256MB/512MB RP. Overrides gpu_mem. Max 944. Default not set. |
116
117#### 3.C. Add purchased license codecs
118To add you own licenses use variables `KEY_DECODE_MPG2` and `KEY_DECODE_WVC1` in local.conf. Example:
119```
120KEY_DECODE_MPG2 = "12345678"
121KEY_DECODE_WVC1 = "12345678"
122```
123You can supply more licenses separated by comma. Example:
124```
125KEY_DECODE_WVC1 = "0x12345678,0xabcdabcd,0x87654321"
126```
127
128#### 3.D. Disable overscan
129By default the GPU adds a black border around the video output to compensate for TVs which cut off part of the image. To disable this set this variable in local.conf:
130`DISABLE_OVERSCAN = "1"`
131
132#### 3.E. Set overclocking options
133The Raspberry PI can be overclocked. As of now overclocking up to the "Turbo Mode" is officially supported by the raspbery and does not void warranty. Check the config.txt for a detailed description of options and modes. Example turbo mode:
134```
135ARM_FREQ = "1000"
136CORE_FREQ = "500"
137SDRAM_FREQ = "500"
138OVER_VOLTAGE = "6"
139```
140
141#### 3.F. Video camera support with V4L2 drivers
142Set this variable to enable support for the video camera (Linux 3.12.4+ required)
143`VIDEO_CAMERA = "1"`
144
145#### 3.G. Enable offline compositing support
146Set this variable to enable support for dispmanx offline compositing:
147`DISPMANX_OFFLINE = "1"`
148
149This will enable the firmware to fall back to off-line compositing of Dispmanx elements. Normally the compositing is done on-line, during scanout, but cannot handle too many elements. With off-line enabled, an off-screen buffer is allocated for compositing. When scene complexity (number and sizes
150of elements) is high, compositing will happen off-line into the buffer.
151
152Heavily recommended for Wayland/Weston.
153
154See: http://wayland.freedesktop.org/raspberrypi.html
155
156#### 3.H. Enable kgdb over console support
157To add the kdbg over console (kgdboc) parameter to the kernel command line, set this variable in local.conf:
158`ENABLE_KGDB = "1"`
159
160#### 3.I. Boot to U-Boot
161To have u-boot load kernel image, set in your local.conf:
162`KERNEL_IMAGETYPE = "uImage"`
163
164This will make kernel.img be u-boot image which will load uImage. By default, kernel.img is the actual kernel image (ex. Image).
165
166#### 3.J. Image with Initramfs
167To build an initramfs image :
168* Set this 3 kernel variables (in linux-raspberrypi.inc for example)
169 - kernel_configure_variable BLK_DEV_INITRD y
170 - kernel_configure_variable INITRAMFS_SOURCE ""
171 - kernel_configure_variable RD_GZIP y
172* Set the yocto variables (in linux-raspberrypi.inc for example)
173 - `INITRAMFS_IMAGE = "<a name for your initramfs image>"`
174 - `INITRAMFS_IMAGE_BUNDLE = "1"`
175* Set the meta-rasberrypi variable (in raspberrypi.conf for example)
176 - `KERNEL_INITRAMFS = "-initramfs"`
177
178#### 3.K. Device tree support
179Device tree for RPi is only supported when using linux-raspberrypi 3.18+ kernels.
180* Set `KERNEL_DEVICETREE` (in conf/machine/raspberrypi.conf)
181 - the trailer is added to the kernel image before kernel install task. While creating the SDCard image, this modified kernel is put on boot partition (as kernel.img) as well as DeviceTree blobs (.dtb files).
182
183NOTE: `KERNEL_DEVICETREE` is default enabled for kernel >= 3.18 and always disabled for
184 older kernel versions.
185
186#### 3.L. Enable SPI bus
187When using device tree kernels, set this variable to enable the SPI bus:
188`ENABLE_SPI_BUS = "1"`
189
190#### 3.M. Enable I2C
191When using device tree kernels, set this variable to enable I2C:
192`ENABLE_I2C = "1"`
193
194#### 3.N. Enable PiTFT support
195Basic support for using PiTFT screens can be enabled by adding below in local.conf:
196
197* `MACHINE_FEATURES += "pitft"`
198 - This will enable SPI bus and i2c device-trees, it will also setup framebuffer for console and x server on PiTFT.
199
200NOTE: To get this working the overlay for the PiTFT model must be build, added and specified as well (dtoverlay=<driver> in config.txt).
201
202Below is a list of currently supported PiTFT models in meta-raspberrypi, the modelname should be added as a MACHINE_FEATURES in local.conf like below:
203`MACHINE_FEATURES += "pitft <modelname>"`
204
205List of currently supported models:
206* pitft22
207* pitft28r
208* pitft35r
209
210#### 3.O. Misc. display
211If you would like to use the Waveshare "C" 1024×600, 7 inch Capacitive Touch Screen LCD, HDMI interface (http://www.waveshare.com/7inch-HDMI-LCD-C.htm) Rev 2.1, please set the following in your local.conf:
212`WAVESHARE_1024X600_C_2_1 = "1"`
213
214#### 3.P. Enable UART
215RaspberryPi 0, 1, 2 and CM will have UART console enabled by default.
216
217RaspberryPi 0 WiFi and 3 does not have the UART enabled by default because this needs a fixed core frequency and enable_uart wil set it to the minimum. Certain operations - 60fps h264 decode, high quality deinterlace - which aren't performed on the ARM may be affected, and we wouldn't want to do that to users
218who don't want to use the serial port. Users who want serial console support on RaspberryPi3 will have to explicitely set in local.conf: `ENABLE_UART = "1"`.
219
220Ref.:
221* https://github.com/raspberrypi/firmware/issues/553
222* https://github.com/RPi-Distro/repo/issues/22
223
224### 4. Extra apps
225
226#### 4.A. omxplayer
227omxplayer depends on libav which has a commercial license. So in order to be able to compile omxplayer you will need to whiteflag the commercial licenseadding to you local.conf:
228`LICENSE_FLAGS_WHITELIST = "commercial"`
229
230### 5. Board Configuration
231
232#### 5.A. Audio Routing
233To load audio driver
234`modprobe snd-bcm2835`
235To test audio playback
236`aplay test.wav`
237
238Note that without HDMI connected this emits audio from the 3.5in jack connector as expected. However With an HDMI display connected there is no audio output from the jack connector.
239
240To force the audio routing via the 3.5in jack connector use
241`amixer cset numid=3 1`
242
243Options to amixer cset are:
244```
2450=auto
2461=headphones
2472=hdmi
248```
249
250### 6. Source code and mirrors
251
252Main repo:
253* git://git.yoctoproject.org/meta-raspberrypi
254* http://git.yoctoproject.org/git/meta-raspberrypi
255
256Github mirror:
257* https://github.com/agherzan/meta-raspberrypi
258
259Bitbucket mirror:
260* https://bitbucket.org/agherzan/meta-raspberrypi
261
262
263### 7. Contributing
264
265#### 7.A. Mailing list
266The main communication tool we use is a mailing list:
267* yocto@yoctoproject.org
268* https://lists.yoctoproject.org/listinfo/yocto
269
270Feel free to ask any kind of questions but always prepend your email subject with "[meta-raspberrypi]". This is because we use the 'yocto' mailing list and not a perticular 'meta-raspberrypi' mailing list.
271
272#### 7.B. Patches and pull requests
273All the contributions should be compliant with the openembedded patch guidelines: http://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines
274
275To contribute to this project you should send pull requests to the github mirror (https://github.com/agherzan/meta-raspberrypi). **Additionally** you can send the patches for review to the above specified mailing list.
276
277When creating patches for the mailing list, please use something like:
278`git format-patch -s --subject-prefix='meta-raspberrypi][PATCH' origin`
279
280When sending patches to the mailing list, please use something like:
281`git send-email --to yocto@yoctoproject.org <generated patch>`
282
283#### 7.B. Github issues
284In order to manage and trace the meta-raspberrypi issues, we use github issues: https://github.com/agherzan/meta-raspberrypi/issues
285
286If you push patches which have a github issue associated, please provide the issue number in the commit log just before "Signed-off-by" line(s). Example line for a bug:
287`[Issue #13]`
288 52
289### 8. Maintainers
290* Andrei Gherzan `<andrei at gherzan.ro>` 53* Andrei Gherzan `<andrei at gherzan.ro>`
diff --git a/docs/contributing.md b/docs/contributing.md
new file mode 100644
index 0000000..370957d
--- /dev/null
+++ b/docs/contributing.md
@@ -0,0 +1,36 @@
1# Contributing
2
3## Mailing list
4
5The main communication tool we use is a mailing list:
6* yocto@yoctoproject.org
7* https://lists.yoctoproject.org/listinfo/yocto
8
9Feel free to ask any kind of questions but always prepend your email subject
10with "[meta-raspberrypi]". This is because we use the 'yocto' mailing list and
11not a perticular 'meta-raspberrypi' mailing list.
12
13## Patches and pull requests
14
15All the contributions should be compliant with the openembedded patch
16guidelines: http://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines
17
18To contribute to this project you should send pull requests to the github mirror
19(https://github.com/agherzan/meta-raspberrypi). **Additionally** you can send
20the patches for review to the above specified mailing list.
21
22When creating patches for the mailing list, please use something like:
23`git format-patch -s --subject-prefix='meta-raspberrypi][PATCH' origin`
24
25When sending patches to the mailing list, please use something like:
26`git send-email --to yocto@yoctoproject.org <generated patch>`
27
28## Github issues
29
30In order to manage and trace the meta-raspberrypi issues, we use github issues:
31https://github.com/agherzan/meta-raspberrypi/issues
32
33If you push patches which have a github issue associated, please provide the
34issue number in the commit log just before "Signed-off-by" line(s). Example line
35for a bug:
36`[Issue #13]`
diff --git a/docs/extra-apps.md b/docs/extra-apps.md
new file mode 100644
index 0000000..b9ee2cb
--- /dev/null
+++ b/docs/extra-apps.md
@@ -0,0 +1,8 @@
1# Extra apps
2
3## omxplayer
4
5omxplayer depends on libav which has a commercial license. So in order to be
6able to compile omxplayer you will need to whiteflag the commercial
7licenseadding to you local.conf:
8`LICENSE_FLAGS_WHITELIST = "commercial"`
diff --git a/docs/extra-build-config.md b/docs/extra-build-config.md
new file mode 100644
index 0000000..ed0261e
--- /dev/null
+++ b/docs/extra-build-config.md
@@ -0,0 +1,183 @@
1# Optional build configuration
2
3There are a set of ways in which a user can influence different paramenters of
4the build. We list here the ones that are closely related to this BSP or
5specific to it. For the rest please check:
6<http://www.yoctoproject.org/docs/latest/ref-manual/ref-manual.html>
7
8## Compressed deployed files
9
101. Overwrite IMAGE_FSTYPES in local.conf
11 * `IMAGE_FSTYPES = "tar.bz2 ext3.xz"`
12
132. Overwrite SDIMG_ROOTFS_TYPE in local.conf
14 * `SDIMG_ROOTFS_TYPE = "ext3.xz"`
15
163. Overwrite SDIMG_COMPRESSION in local.conf
17 * `SDIMG_COMPRESSION = "xz"`
18
19Accommodate the values above to your own needs (ex: ext3 / ext4).
20
21## GPU memory
22
23| Variable | Details |
24|----------------|---------------------------------------------------------------------|
25| `GPU_MEM` | GPU memory in megabyte. Sets the memory split between the ARM and |
26| | GPU. ARM gets the remaining memory. Min 16. Default 64. |
27| `GPU_MEM_256` | GPU memory in megabyte for the 256MB Raspberry Pi. Ignored by the |
28| | 512MB RP. Overrides gpu_mem. Max 192. Default not set. |
29| `GPU_MEM_512` | GPU memory in megabyte for the 512MB Raspberry Pi. Ignored by the |
30| | 256MB RP. Overrides gpu_mem. Max 448. Default not set. |
31| `GPU_MEM_1024` | GPU memory in megabyte for the 1024MB Raspberry Pi. Ignored by the |
32| | 256MB/512MB RP. Overrides gpu_mem. Max 944. Default not set. |
33
34## Add purchased license codecs
35
36To add you own licenses use variables `KEY_DECODE_MPG2` and `KEY_DECODE_WVC1` in
37local.conf. Example:
38```
39KEY_DECODE_MPG2 = "12345678"
40KEY_DECODE_WVC1 = "12345678"
41```
42
43You can supply more licenses separated by comma. Example:
44```
45KEY_DECODE_WVC1 = "0x12345678,0xabcdabcd,0x87654321"
46```
47
48## Disable overscan
49
50By default the GPU adds a black border around the video output to compensate for
51TVs which cut off part of the image. To disable this set this variable in
52local.conf:
53`DISABLE_OVERSCAN = "1"`
54
55## Set overclocking options
56
57The Raspberry PI can be overclocked. As of now overclocking up to the "Turbo
58Mode" is officially supported by the raspbery and does not void warranty. Check
59the config.txt for a detailed description of options and modes. Example turbo
60mode:
61```
62ARM_FREQ = "1000"
63CORE_FREQ = "500"
64SDRAM_FREQ = "500"
65OVER_VOLTAGE = "6"
66```
67
68## Video camera support with V4L2 drivers
69
70Set this variable to enable support for the video camera (Linux 3.12.4+
71required)
72`VIDEO_CAMERA = "1"`
73
74## Enable offline compositing support
75
76Set this variable to enable support for dispmanx offline compositing:
77`DISPMANX_OFFLINE = "1"`
78
79This will enable the firmware to fall back to off-line compositing of Dispmanx
80elements. Normally the compositing is done on-line, during scanout, but cannot
81handle too many elements. With off-line enabled, an off-screen buffer is
82allocated for compositing. When scene complexity (number and sizes
83of elements) is high, compositing will happen off-line into the buffer.
84
85Heavily recommended for Wayland/Weston.
86
87See: <http://wayland.freedesktop.org/raspberrypi.html>
88
89## Enable kgdb over console support
90
91To add the kdbg over console (kgdboc) parameter to the kernel command line, set
92this variable in local.conf:
93`ENABLE_KGDB = "1"`
94
95## Boot to U-Boot
96
97To have u-boot load kernel image, set in your local.conf:
98`KERNEL_IMAGETYPE = "uImage"`
99
100This will make kernel.img be u-boot image which will load uImage. By default,
101kernel.img is the actual kernel image (ex. Image).
102
103## Image with Initramfs
104
105To build an initramfs image:
106
107* Set this 3 kernel variables (in linux-raspberrypi.inc for example)
108 - kernel_configure_variable BLK_DEV_INITRD y
109 - kernel_configure_variable INITRAMFS_SOURCE ""
110 - kernel_configure_variable RD_GZIP y
111
112* Set the yocto variables (in linux-raspberrypi.inc for example)
113 - `INITRAMFS_IMAGE = "<a name for your initramfs image>"`
114 - `INITRAMFS_IMAGE_BUNDLE = "1"`
115
116* Set the meta-rasberrypi variable (in raspberrypi.conf for example)
117 - `KERNEL_INITRAMFS = "-initramfs"`
118
119## Device tree support
120
121Device tree for RPi is only supported when using linux-raspberrypi 3.18+
122kernels.
123
124* Set `KERNEL_DEVICETREE` (in conf/machine/raspberrypi.conf)
125 - the trailer is added to the kernel image before kernel install task. While
126 creating the SDCard image, this modified kernel is put on boot partition (as
127 kernel.img) as well as DeviceTree blobs (.dtb files).
128
129NOTE: `KERNEL_DEVICETREE` is default enabled for kernel >= 3.18 and always
130disabled for older kernel versions.
131
132## Enable SPI bus
133
134When using device tree kernels, set this variable to enable the SPI bus:
135`ENABLE_SPI_BUS = "1"`
136
137## Enable I2C
138
139When using device tree kernels, set this variable to enable I2C:
140`ENABLE_I2C = "1"`
141
142## Enable PiTFT support
143
144Basic support for using PiTFT screens can be enabled by adding below in
145local.conf:
146
147* `MACHINE_FEATURES += "pitft"`
148 - This will enable SPI bus and i2c device-trees, it will also setup
149 framebuffer for console and x server on PiTFT.
150
151NOTE: To get this working the overlay for the PiTFT model must be build, added
152and specified as well (dtoverlay=<driver> in config.txt).
153
154Below is a list of currently supported PiTFT models in meta-raspberrypi, the
155modelname should be added as a MACHINE_FEATURES in local.conf like below:
156`MACHINE_FEATURES += "pitft <modelname>"`
157
158List of currently supported models:
159* pitft22
160* pitft28r
161* pitft35r
162
163## Misc. display
164
165If you would like to use the Waveshare "C" 1024×600, 7 inch Capacitive Touch
166Screen LCD, HDMI interface (<http://www.waveshare.com/7inch-HDMI-LCD-C.htm>) Rev
1672.1, please set the following in your local.conf:
168`WAVESHARE_1024X600_C_2_1 = "1"`
169
170## Enable UART
171
172RaspberryPi 0, 1, 2 and CM will have UART console enabled by default.
173
174RaspberryPi 0 WiFi and 3 does not have the UART enabled by default because this
175needs a fixed core frequency and enable_uart wil set it to the minimum. Certain
176operations - 60fps h264 decode, high quality deinterlace - which aren't
177performed on the ARM may be affected, and we wouldn't want to do that to users
178who don't want to use the serial port. Users who want serial console support on
179RaspberryPi3 will have to explicitely set in local.conf: `ENABLE_UART = "1"`.
180
181Ref.:
182* <https://github.com/raspberrypi/firmware/issues/553>
183* <https://github.com/RPi-Distro/repo/issues/22>
diff --git a/docs/layer-contents.md b/docs/layer-contents.md
new file mode 100644
index 0000000..29cfa35
--- /dev/null
+++ b/docs/layer-contents.md
@@ -0,0 +1,24 @@
1# Layer Contents
2
3## Supported Machines
4
5* raspberrypi
6* raspberrypi0
7* raspberrypi0-wifi
8* raspberrypi2
9* raspberrypi3
10* raspberrypi3-64 (64 bit kernel & userspace)
11* raspberrypi-cm (dummy alias for raspberrypi)
12* raspberrypi-cm3 (dummy alias for raspberrypi2)
13
14## Images
15
16* rpi-hwup-image
17 * Hardware up image
18
19* rpi-basic-image
20 * Based on rpi-hwup-image with some added features (ex: splash)
21
22* rpi-test-image
23 * Image based on rpi-basic-image which includes most of the packages in this
24 layer and some media samples.
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2025-05-13 17:45:42 +0000