summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Update references to Yocto mailing listAndrei Gherzan2021-11-141-3/+3
| | | | | | | | The mailing list infrastructure at Yocto project changed (for a good while now) but we still reference the old address/links. Update them accordingly. Signed-off-by: Andrei Gherzan <andrei@gherzan.com>
* docs: Advertise raspberrypi0-2w-64 supported machineAndrei Gherzan2021-11-141-0/+1
| | | | Signed-off-by: Andrei Gherzan <andrei@gherzan.com>
* docs: Add module dependency/requirement for RtDAndrei Gherzan2021-11-141-0/+1
| | | | | | | myst_parser is not in the default Read The Docs container by default. Pull it in as we use it for parsing the markdown files. Signed-off-by: Andrei Gherzan <andrei@gherzan.com>
* docs: Fix RtD buildAndrei Gherzan2021-11-141-6/+2
| | | | | | | | Markdown parser has changed[1]. [1] https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html#using-markdown-with-sphinx Signed-off-by: Andrei Gherzan <andrei@gherzan.com>
* docs: Bump copyright yearAndrei Gherzan2021-11-141-1/+1
| | | | Signed-off-by: Andrei Gherzan <andrei@gherzan.com>
* rpi-config: Allow setting hdmi_cvtOtavio Salvador2021-08-111-1/+1
| | | | Signed-off-by: Otavio Salvador <otavio@ossystems.com.br>
* Manually fix conversionMartin Jansa2021-08-041-2/+2
| | | | Signed-off-by: Martin Jansa <Martin.Jansa@gmail.com>
* Convert to new override syntaxMartin Jansa2021-08-042-5/+5
| | | | | | | | | | This is the result of automated script conversion: oe-core/scripts/contrib/convert-overrides.py . converting the metadata to use ":" as the override character instead of "_". Signed-off-by: Martin Jansa <Martin.Jansa@gmail.com>
* Add WM8960 soundcard supportDevendra Tewari2021-06-101-0/+21
| | | | Signed-off-by: Devendra Tewari <devendra.tewari@gmail.com>
* [documentation]Add USB host support in documentationAurelian Zanoschi2021-02-041-0/+9
| | | | Signed-off-by: Aurelian Zanoschi <aurelian17@gmail.com>
* libcamera: Enabled camera overlays define basedMadhavan Krishnan2020-11-141-0/+14
| | | | | | | | | | | | | Added imx219.dtbo file in the overlays, and added dtoverlay in /boot/config.txt define based. To enable Sony Raspberry pi camera imx219 sensor, need to set the variable RASPBERRYPI_CAMERA_V2 as 1. In future, we can add any camera overlays here to support and use them with libcamera. Signed-off-by: Madhavan Krishnan <madhavan.krishnan@linaro.org>
* docs: Correct minor spelling issuesAndrzej Bednarski2020-09-111-4/+4
| | | | | | Correct spelling issues in the 'extra-build-config.md' file. Signed-off-by: Andrzej Bednarski <andrzej.bednarski@gmail.com>
* docs/extra-build-config.md: document vars to add to boot partitionChristopher Clark2020-07-291-0/+25
| | | | | | FATPAYLOAD, DEPLOYPAYLOAD and RPI_SDIMG_EXTRA_DEPENDS Signed-off-by: Christopher Clark <christopher.w.clark@gmail.com>
* docs/extra-build-config.md: Document CAN_OSCILLATOR variableJakub Luzny2020-07-291-7/+13
| | | | | | | Add instructions how to use CAN_OSCILLATOR variable and declare support for the Waveshare RS485 CAN HAT. Signed-off-by: Jakub Luzny <jakub@luzny.cz>
* docs: Added documentation for Pican2 Duo supportcolin2020-07-231-0/+7
| | | | | | | Added documentation for ENABLE_DUAL_CAN build configuration and support for Pican2 Duo board. Signed-off-by: Colin McAllister <colinmca242@gmail.com>
* docs/extra-build-config.md: InfraredLeon Anavi2020-06-241-0/+12
| | | | | | | Add instructions how to use variable ENABLE_IR for infrared support, for example with LIRC. Signed-off-by: Leon Anavi <leon.anavi@konsulko.com>
* Update layer-contents.md to include pi4M. ter Woord2020-06-211-0/+2
| | | | Signed-off-by: Matthijs ter Woord <matthijsterwoord@gmail.com>
* docs/extra-build-config.md: Auto-load I2C modulesLeon Anavi2020-04-031-0/+4
| | | | | | | Add instructions how to auto-load I2C kernel modules with KERNEL_MODULE_AUTOLOAD when I2C is enabled. Signed-off-by: Leon Anavi <leon.anavi@konsulko.com>
* Add support for PiTFT 2.8" with capacitive touchErik Botö2020-01-141-0/+1
| | | | | | | | Add support for the Adafruit PiTFT Plus 320x240 2.8" TFT with Capacitive Touchscreen, using the same patterns used for the other versions of the PiTFT screens. Signed-off-by: Erik Botö <erik.boto@gmail.com>
* extra-build-config.md: Document DISABLE_VC4GRAPHICSAndrei Gherzan2019-09-161-0/+4
| | | | Signed-off-by: Andrei Gherzan <andrei@gherzan.ro>
* extra-build-config.md: add RPi 0W to UART sectionBernardo A. Rodrigues2019-09-101-1/+1
| | | | | | This makes it clear in the docs that ENABLE_UART can be used both for the RPi 0W or 3. Signed-off-by: Bernardo A. Rodrigues <bernardaraujor@gmail.com>
* docs/layer-contents.md: raspberrypi-cm3 is a stand alone machine nowAndrei Gherzan2019-02-191-1/+1
| | | | Signed-off-by: Andrei Gherzan <andrei@gherzan.ro>
* docs: improve the contributing sectionHugo Hromic2018-12-151-19/+90
| | | | | | | | * Rephrased some paragraphs * Better organised the section itself * Added guideline and formatting examples for commit log messages Signed-off-by: Hugo Hromic <hhromic@gmail.com>
* Add Pican2 supportFabien Lahoudere2018-12-121-0/+9
| | | | | | | | | | | In order to make Pican 2 work, we : - add mcp2515.dto to the overlay list - add a variable to enable it in local.conf - create a udev rule to mount interface http://skpang.co.uk/catalog/pican2-canbus-board-for-raspberry-pi-23-p-1475.html Signed-off-by: Fabien Lahoudere <fabien.lahoudere@collabora.com>
* extra-build-config.md: Update docs as per SDIMG_COMPRESSION removalIurii Lunev2018-12-121-3/+0
| | | | | | | | | Using SDIMG_COMPRESSION variable to choose compression type for produced images is deprecated. IMAGE_FSTYPES should be used instead. This patch removes any reference to SDIMG_COMPRESSION variable within the build documentation. Signed-off-by: Iurii Lunev <koolkhel@mail.ru>
* docs: Add more info on generating initramfs imagesKhem Raj2018-11-151-0/+3
| | | | Signed-off-by: Khem Raj <raj.khem@gmail.com>
* extra-build-config.md: Improve documentation on generating initramfs imageKhem Raj2018-11-081-3/+4
| | | | Signed-off-by: Khem Raj <raj.khem@gmail.com>
* sdcard_image-rpi.bbclass: drop KERNEL_INITRAMFS variableMartin Jansa2018-07-161-3/+0
| | | | | | | | | | | | | | | | | | | | | | * use INITRAMFS_SYMLINK_NAME from new kernel-artifact-names.bbclass instead of KERNEL_INITRAMFS * the documentation says that KERNEL_INITRAMFS should be used to define extension of initramfs, but in linux-raspberrypi.inc it's defined only to 1 or empty based on INITRAMFS_IMAGE_BUNDLE variable and I don't see any code in meta-raspberry or oe-core which would use KERNEL_INITRAMFS to actualy name the initramfs artifact to create: ${DEPLOY_DIR_IMAGE}/${KERNEL_IMAGETYPE}${KERNEL_INITRAMFS}-${MACHINE}.bin used in classes/sdcard_image-rpi.bbclass * also fix the assumption that there is -${MACHINE} suffix in: ${DEPLOY_DIR_IMAGE}/${KERNEL_IMAGETYPE}${KERNEL_INITRAMFS}-${MACHINE}.bin because that's defined as KERNEL_IMAGE_SYMLINK_NAME and some DISTROs might use different value * this depends on oe-core changes which were merged today: http://git.openembedded.org/openembedded-core/commit/?id=7d0ef0eaa1bfe97015a774c26f5791622e7e8b12 * this is the last piece of previous pull-request: https://github.com/agherzan/meta-raspberrypi/pull/159 Signed-off-by: Martin Jansa <Martin.Jansa@gmail.com>
* docs: document support for 802.15.4 hatAnton Gerasimov2018-06-041-0/+8
| | | | Signed-off-by: Anton Gerasimov <tossel@gmail.com>
* linux-firmware: restore and merge bluez-firmwarePeter A. Bigot2018-05-141-9/+9
| | | | | | | | | | | | The attempt to Raspbian updated firmware blobs in packages separate from linux-firmware introduced unresolvable conflicts with the standard linux-firmware roll-up package. Revert to using an augmented linux-firmware recipe that overrides and adds firmware from two Raspbian repositories that have up-to-date images. Closes #244 Signed-off-by: Peter A. Bigot <pab@pabigot.com>
* rpi-config: add helper to enable dwc2 peripheral supportPeter A. Bigot2018-05-051-1/+9
| | | | | | | | Document and add support to easily enable USB gadget mode. Also fix a spelling error. Signed-off-by: Peter A. Bigot <pab@pabigot.com>
* rpi-config: support more commonly used config variables and update documentationHugo Hromic2018-04-201-3/+45
| | | | | | | | | | | Added support for and documented the following new extra build options: * gpu_freq overclocking option * disable boot rainbow splash screen * configure the boot delay after GPU firmware loading * configure common HDMI and composite video options Signed-off-by: Hugo Hromic <hhromic@gmail.com>
* layer-contents.md: Update documentationag_rpi3bplusAndrei Gherzan2018-03-291-0/+12
| | | | | | | * Raspberry Pi 3B+ support mentioned * Add info about linux-firmware-raspbian Signed-off-by: Andrei Gherzan <andrei@gherzan.com>
* docs: Remove reference to deprecated imagesPaul Barker2018-03-231-7/+5
| | | | Signed-off-by: Paul Barker <pbarker@toganlabs.com>
* docs: Do not force alabaster themePaul Barker2017-12-181-1/+1
| | | | | | | | | | Sphinx will use the 'alabaster' theme by default when building locally. However, Read the Docs will use their own theme by default which suits their site better. By not specifying html_theme we allow both targets to use the appropriate default theme. Signed-off-by: Paul Barker <pbarker@toganlabs.com>
* rpi-config: Add RPI_EXTRA_CONFIG optionPaul Barker2017-12-181-0/+16
| | | | | | | The variable RPI_EXTRA_CONFIG can be set in local.conf to append text to the Raspberry Pi config.txt file as described in the documentation. Signed-off-by: Paul Barker <pbarker@toganlabs.com>
* docs: Drop comment on broken raspberrypi3-64 HDMI outputPaul Barker2017-10-121-6/+0
| | | | | | Graphical output on raspberrypi3-64 should now be fixed. Signed-off-by: Paul Barker <pbarker@toganlabs.com>
* Support using u-boot with Image format for raspberrypi3-64Paul Barker2017-09-241-3/+5
| | | | | | | | For raspberrypi3-64 we need to use the Image or Image.gz format with u-boot instead of the legacy uImage format. We also need to issue the 'booti' command to boot the kernel instead of 'bootm'. Signed-off-by: Paul Barker <pbarker@toganlabs.com>
* extra-apps.md: Document limitations of raspberrypi3-64Khem Raj2017-09-081-0/+6
| | | | Signed-off-by: Khem Raj <raj.khem@gmail.com>
* linux-raspberrypi: Add option for disabling rpi boot logo.Zdzisław Krajewski2017-09-011-0/+6
| | | | Signed-off-by Zdzisław Krajewski <zdzichucb@gmail.com>
* docs: Format all links correctlyPaul Barker2017-05-261-5/+5
| | | | Signed-off-by: Paul Barker <pbarker@toganlabs.com>
* docs: small editorial fixMirza Krak2017-05-261-1/+1
| | | | Signed-off-by: Mirza Krak <mirza.krak@endian.se>
* docs: drop "Device tree support" sectionMirza Krak2017-05-261-13/+0
| | | | | | | We no longer provide any Linux kernel which do not have device-tree support and all machines setup KERNEL_DEVICETREE correctly. Signed-off-by: Mirza Krak <mirza.krak@endian.se>
* docs: fix alignment of "code blocks"Mirza Krak2017-05-263-30/+42
| | | | | | | | | | | | | | | | | | | | | We provide a lot of variable examples as code blocks in the following format: some text: `Variable` or some test: `Variable` Which is not as pretty as (when converted to html/pdf): some text: Variable Converted all and hoppefully this will improve readability a bit. Signed-off-by: Mirza Krak <mirza.krak@endian.se>
* docs: Remove incompatible table formatPaul Barker2017-05-261-10/+11
| | | | | | | Sadly sphinx doesn't support pipe tables in markdown at the minute. Let's use a bullet-point list instead. Signed-off-by: Paul Barker <pbarker@toganlabs.com>
* docs: Include readme in sphinx documentationPaul Barker2017-05-262-0/+2
| | | | | | | This allows us to avoid having to duplicate any information in the readme into another documentation file. Signed-off-by: Paul Barker <pbarker@toganlabs.com>
* docs: Initial sphinx configurationPaul Barker2017-05-263-0/+593
| | | | | | | | | | This allows us to create documentation by running 'make html' or 'make latexpdf' in the docs directory. It depends on sphinx and the recommonmark python module (for parsing markdown files in sphinx). Creation of the PDF document requires a full LaTeX toolchain to be installed. Signed-off-by: Paul Barker <pbarker@toganlabs.com>
* docs: Initial split of README into docs directoryPaul Barker2017-05-264-0/+251
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>