diff --git a/.github/workflows/pdf-at-pr.yaml b/.github/workflows/pdf-at-pr.yaml new file mode 100644 index 00000000..b74cac6f --- /dev/null +++ b/.github/workflows/pdf-at-pr.yaml @@ -0,0 +1,38 @@ +# This workflow will install Python dependencies and generate PDF file at PR +name: Create offline documentation on PR + +on: + pull_request: + types: [opened, reopened, synchronize, labeled] + workflow_dispatch: + +jobs: + build: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: [ 3.8 ] + + steps: + - uses: actions/checkout@v4 + with: + ref: ${{ github.event.pull_request.head.sha }} + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v5 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install setuptools wheel + pip install -r requirements.txt + - name: Run mkdocs --clean + run: | + mkdocs build --clean + + - name: Upload pdf + uses: actions/upload-artifact@v4 + with: + name: artifact + path: site/pdf/document.pdf + diff --git a/README.md b/README.md index 048e3b17..349769ae 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,8 @@ pip install --use-pep517 -r requirements.txt To build and serve the documentation locally, allowing you to make edits and observe the results in real time, use: ```bash -mkdocs build --clean && mkdocs serve +mkdocs build --clean +mkdocs serve -a 0.0.0.0:8000 ``` You will be able to make edits to existing files and observe the results in real time. diff --git a/docs/Community_Governance.md b/docs/Community_Governance.md deleted file mode 100644 index 9ae765b4..00000000 --- a/docs/Community_Governance.md +++ /dev/null @@ -1,40 +0,0 @@ -# Armbian Governance - -## Armbian Board Maintainers - -You can see the current list of supported boards and their maintainers here - -## Armbian Platform Maintainers - -| Area | Lead Maintainers | Maintainers | Acronyms, Codenames | additional info | -|-------------------------------|-----------------|-------------------------------|---------------------------------|--------------------------------------| -| Build Scripts | @Igorpecovnik | @The-going @iav @Miouyouyou @rpardini @150balbes | `/lib/*.sh` | code responsible for building images | -| Armbian-Tools | @Igorpecovnik | @Miouyouyou @sgjava @TheLinuxBug | armbian-config, armbian-monitor | userland tools provided by Armbian | -| Armbian-Tools: armbian-config | | | armbian-config | | -| Multimedia/Desktops | | @JMCC @jernejsk @Miouyouyou | | | - -## Additional Armbian Roles - -| Area | Lead Maintainers | Maintainers | Acronyms, Codenames | additional info | -|------------------------------|-----------------|----------------------------------------------------------|---------------------|-----------------| -| Release Management | @Igorpecovnik @Heisath @TonyMac32 @TRS-80 | [Click to view the full list of Maintainers](https://docs.armbian.com/Release_Board-Maintainers/) | | | -| Testing and Code Quality, CI | | @Igorpecovnik | | | -| Security | | | | | -| Documentation | @TheLinuxBug | @Werner @TRS-80 | | | -| Community Engagement | @TheLinuxBug | @NicoD @Tido @Werner @TRS-80 | | | -| Legal and Financial | @Igorpecovnik | | | | -| Web and Infrastucture | | @TheLinuxBug @cats | | | -| Forums moderation | @Werner | [Click to view the full list of Moderators](https://forum.armbian.com/members/2-moderators/) | | | -| IRC, Discord | @Werner | | | | - -## Community Governance Charters and Documentation -Coming soon! - -## Hackers Emeritus - -Members who have stepped away from the project, but had a huge impact. We always welcome their contributions and wisdom. - -* @TKaiser -* @zador.blood.stained -* @RNeese -* @Lanefu diff --git a/docs/Community_IRC.md b/docs/Community_IRC.md index fca9a95d..535b50b1 100644 --- a/docs/Community_IRC.md +++ b/docs/Community_IRC.md @@ -1,3 +1,14 @@ +--- +title: Armbian Social Media Channels +description: Social media channels maintained by Armbian project team +--- + +# Social media + +## Armbian on Twitter and Mastodon + +Armbian short announcements are done via 𝕏 (formerly known as Twitter): and + # IRC Channel / Discord / Matrix ## 👏 Overview diff --git a/docs/Developer-Guide_Build-Options.md b/docs/Developer-Guide_Build-Options.md index 262257cd..70f97432 100644 --- a/docs/Developer-Guide_Build-Options.md +++ b/docs/Developer-Guide_Build-Options.md @@ -69,7 +69,7 @@ Usage: # Build options -These parameters are meant to be applied to the `./compile.sh` command. They are **all** optional. They can also be added to your [build configuration file](/Developer-Guide_Build-Preparation/#providing-build-configuration) to save time. Default values are marked **bold** if applicable. +These parameters are meant to be applied to the `./compile.sh` command. They are **all** optional. They can also be added to your [build configuration file](Developer-Guide_Build-Preparation.md#providing-build-configuration) to save time. Default values are marked **bold** if applicable. ## Main options @@ -269,6 +269,6 @@ When selecting the zstd compression level (`zstd:[1-15]`), both the host and the - **AUFS** ( **yes** | no ): include support for [AUFS](https://en.wikipedia.org/wiki/Aufs) - **SKIP_BOOTSPLASH** ( yes | **no** ): use kernel bootsplash. Disable in case of troubles - **CONSOLE_AUTOLOGIN** ( **yes** | no ): automatically login as root for local consoles. Disable if your security threat model requires. -- **EXT** (`fake-vcgencmd`): execute [extension](/Developer-Guide_Extensions/) during the build +- **EXT** (`fake-vcgencmd`): execute [extension](Developer-Guide_Extensions.md) during the build - `fake-vcgencmd`: include [fake vcgencmd](https://github.com/clach04/fake_vcgencmd) to monitor and control boards from [Android](https://eidottermihi.github.io/rpicheck/) - **INCLUDE_HOME_DIR** ( yes | **no** ): include directories created inside /home in final image. diff --git a/docs/Hardware_Allwinner-A20.md b/docs/Hardware_Allwinner-A20.md deleted file mode 100644 index 0ee55fc8..00000000 --- a/docs/Hardware_Allwinner-A20.md +++ /dev/null @@ -1,60 +0,0 @@ -# Allwinner A10 & A20 boards - -## Overview - -Both *legacy* and *current* kernels are stable and production ready and mostly sharing the same features through backports. - -- **Note: Kernel 3.4.x has been dropped due to lacking upstream support which has ended in 2017.** - -### Features - -- Enabled audio devices: analog, 8 channel HDMI, spdif and I2S (if wired and enabled in HW configuration) -- Bluetooth ready (working with supported external keys) -- [Enabled overlayfs](/User-Guide_Advanced-Features/#how-to-freeze-your-filesystem-outdated) (outdated) -- [I2C](https://en.wikipedia.org/wiki/I%C2%B2C) ready and tested with small 16×2 LCD. Basic i2c tools included. -- SPI ready and tested with ILI9341 based 2.4″ TFT LCD display. -- [Drivers for small TFT LCD](https://github.com/notro/fbtft) display modules. -- [Clustering / stacking](https://en.wikipedia.org/wiki/Cluster_(computing)) -- Onboard LED attached to SD card activity (script.bin) -- [Docker ready](/User-Guide_Advanced-Features/#how-to-run-docker) -- Enabled audio devices: analog, SPDIF (if available) & USB -- [USB / UAS](https://linux-sunxi.org/USB/UAS) – more efficient disk access over USB (A20 and H3) -- [CAN bus](https://en.wikipedia.org/wiki/CAN_bus) – Controller Area Network -- [USB OTG connector](https://linux-sunxi.org/USB_Gadget) – OTG or host mode -- Bluetooth ready (working with supported external keys) -- [I2C](https://en.wikipedia.org/wiki/I%C2%B2C) ready and tested with small 16×2 LCD. Basic i2c tools included. -- Onboard LED attached to SD card activity (not enabled on all boards yet) - -### Bugs or limitation - -- NAND install sometime fails. Workaround: install [~~Lubuntu to NAND~~](http://dl.cubieboard.org/software/a20-cubietruck/lubuntu/) with [~~Phoenix tools~~](http://docs.cubieboard.org/downloads) and run install again. (Links no longer available - 27/01/21 Werner) -- Shutdown results into reboot under certain conditions. -- SATA port multiplier support is disabled by default, can be enabled by adding kernel parameter `ahci_sunxi.enable_pmp=1` -- Screen output from kernel is set to HDMI by default. Boot loader can detect and switch, kernel not. - - -## Desktop - -[![IMAGE ALT TEXT](https://img.youtube.com/vi/hsthqj90vTU/0.jpg)](https://www.youtube.com/watch?v=hsthqj90vTU "Armbian Desktop") - -- HW accelerated video playback (if available) -- MALI Open GLES (if available) -- Pre-installed: Firefox, LibreOffice Writer, Thunderbird -- Lightweight XFCE desktop -- Autologin, when normal user is created – no login manager (/etc/default/nodm) - -## Notes - -### Setting non-standard monitor settings for A10, A20 and A31 based boards in u-boot - -Following commands (example) needs to be executed in u-boot command prompt: -``` -setenv video-mode sunxi:1024x768-24@60,monitor=dvi,hpd=0,edid=0,overscan_x=1,overscan_y=2 -saveenv -``` - -Since environment is reset after flashing u-boot, you need to do this after every u-boot upgrade or put this to u-boot script - -## Resources - -[Armbian packages repository](https://www.armbian.com/kernel/) diff --git a/docs/Hardware_Allwinner-H3.md b/docs/Hardware_Allwinner-H3.md deleted file mode 100644 index ebc9e4ef..00000000 --- a/docs/Hardware_Allwinner-H3.md +++ /dev/null @@ -1,45 +0,0 @@ -# Allwinner H3 boards - -## Overview - -The H3 SoC from Allwinner is meant for OTT boxes and therefore its reference design is _not_ accompanied by a separate PMIC (power management IC) unlike _A series_ Allwinner SoCs (like A10, A20, A64, ...). No PMIC means also that there is no battery charging/monitoring implemented so H3 is not that much suited for mobile devices. On the other hand some pretty cheap H3 boards were released that can be driven with rather low consumption and therefore combining H3 devices with a battery became a real use case with boards like [Orange Pi One/Lite](https://linux-sunxi.org/Orange_Pi_Lite), NanoPi [NEO and Neo AIR](https://linux-sunxi.org/FriendlyARM_NanoPi_NEO). - -As usual [SoC](https://linux-sunxi.org/H3) and [device information](https://linux-sunxi.org/Category:H3_Devices) can be found in Linux-sunxi wiki. Same applies to status of [mainlining kernel efforts](https://linux-sunxi.org/Linux_mainlining_effort). Adding to the usual SoC feature set (I2C, SPI, PWM, UART, SDIO, GPIO and so on) H3 has one USB OTG port, 3 real USB host ports (not exposed on all devices), Fast- and Gigabit Ethernet capablities (board specific), a Mali400MP2 GPU and Allwinner's video encoding/decoding engine. - -When CPU or GPU cores are fully utilized H3 tends to overheat over time like any other popular ARM SoC released within the last 2-3 years. With Armbian we provide sane dvfs (dynamic voltage frequency scaling) settings that help a lot with throttling. In case you plan to operate your H3 device constantly under high load please check Armbian forums first since boards behave differently (related to voltage regulation and PCB size and design -- some use copper layers to spread the heat away from the SoC). Also consider applying a heatsink to the SoC (a fan should not be necessary unless you want to do number crunching on your board and then you obviously chose the wrong device). - -You find some [differentiation criteria regarding supported H3 devices as well as an overview/history of H3 software support in our forums](https://forum.armbian.com/topic/1351-h3-board-buyers-guide/) or use Jean-Luc's [nice comparison table](https://www.cnx-software.com/2016/06/08/allwinner-h3-boards-comparison-tables-with-orange-pi-banana-pi-m2-nanopi-p1-and-h3-olinuxino-nano-boards/#comments) (both slightly outdated since more H3 devices have been released in the meantime). - -## Kernel support - -Almost all features of the H3 SoC are supported on Armbian's _current_ branch. Please refer to the [Linux sunxi support sheet](https://linux-sunxi.org/Linux_mainlining_effort). - -## Default settings - -- CPU frequency settings are 480 MHz to 1.37 GHz on most boards (cpufreq governor is _interactive_ therefore the boards only increase CPU speed and consumption when needed). Varity might occur due to different voltage regulators and heat dissipation behaviour. Theoretically lower frequencies are possible but disabled by default due to known stability issues. -- Armbian unlike older/other H3 OS images uses the green led as 'power on' indicator (blinking means 'ready to login' or 'shutting down'), the red led (blue on NanoPis) can be used for your own purpose. - -## Tips and tricks (general) - -- An insufficient power supply **is the root cause of many weird symptoms/problems**. Never trust in ratings written on the PSU since they might be wrong, the PSU might be old/dying and cable/contact resistance adds to problems. In other words: Before you blame Armbian for strange behaviour please try at least one second power supply (this applies to both PSU and cable between PSU and board if this is separate -- especially USB cables really suck due to high resistance leading to severe voltage drops). -- In case you experience instabilities check your SD card using `armbianmonitor -c $HOME` and think about installing [RPi-Monitor for H3](https://www.cnx-software.com/2016/03/17/rpi-monitor-is-a-web-based-remote-monitor-for-arm-development-boards-such-as-raspberry-pi-and-orange-pi/) to get an idea whether you suffer from overheating (`sudo armbianmonitor -r` will install everything needed). -- Especially for desktop images the speed of your SD card matters. If possible try to use our _armbian-install_ script to move the rootfs away from SD card. The script also works with USB disks flawlessly ([some background information](https://forum.armbian.com/topic/793-moving-to-harddisk/)). - -## Tips and tricks (H3 specific / lowering consumption) (outdated) - -Recent research showed that H3 boards operated as wired IoT nodes need way less power compared to Raspberry Pis in the same situation (ethernet active). If you want to use your H3 device headless (server/IoT) and care about power consumption then there exist a couple of tweaks to get your board being more energy efficient when using in the meantime unsupported 3.x kernel (no tests done yet with up-to-date _legacy_/_current_ kernel): - -- Disabling HDMI/GPU saves ~200mW. -- Allowing to temporarely only negotiate a Fast Ethernet connection on GbE capable boards saves +350 mW. -- Adjusting DRAM clockspeed is surprisingly another way to control consumption (on NanoPi NEO for example changing DRAM clockspeed between 132 MHz and 672 MHz results in consumption differences of 470mW). -- Limiting maximum CPU clockspeed will help with lowering maximum consumption (think about scripts running amok or something going terribly wrong), the same applies to limiting the count of active CPU cores. -- Choosing a board with Fast instead of Gigabit Ethernet or disabling GbE on the latter using `ethtool` or `ifconfig` saves at least 150 mW (board specific). - -As an example: We chose default Armbian settings for NanoPi NEO to ensure this board is not able to exceed 2W consumption when running with no peripherals connected. This resulted in CPU and DRAM clockspeed of just 480/408 MHz while _booting_ (the first ~20 seconds). In normal operation we limit maximum CPU clockspeed to 912 MHz to stay below the 2W consumption barrier even in worst case scenarios. - -In case you want to have a few more percent maximum CPU performance you would need to set maximum cpufreq to 1200 MHz instead of 'just' 912 MHz maximum CPU clock using our new [h3consumption tool](https://forum.armbian.com/topic/1878-testers-wanted-h3consumption-to-be-included-into-future-armbian-releases/). Be warned: This will both heavily increase consumption and SoC temperature since exceeding 912 MHz CPU clockspeed means feeding the SoC with 1.3V instead of 1.1V core voltage (most smaller H3 devices use a voltage regulator only switching between two voltages to feed the SoC based on load). - -Walking this route in the other direction is more interesting: In case you want to use an H3 device as IoT node you might want to limit both idle and maximum consumption. That should involve disabling stuff not needed (eg. HDMI/GPU since this saves 200mW) or limiting ressource consumption: Lowering maximum clockspeeds for both CPU and DRAM or even disabling CPU cores (which helps _not_ with idle consumption since ARM cores enter low-power modes if not needed but can help lowering maximum consumption requirements). - -Since all of this stuff is based on recent research and being still WiP please consider reading through relevant threads in Armbian forums **and** join development/research/discussions: [SBC consumption/performance comparisons](https://forum.armbian.com/topic/1748-sbc-consumptionperformance-comparisons/) and [Default settings for NanoPi NEO/Air](https://forum.armbian.com/topic/1728-rfc-default-settings-for-nanopi-neoair/). - diff --git a/docs/Hardware_Allwinner-H5-A64.md b/docs/Hardware_Allwinner-H5-A64.md deleted file mode 100644 index 57c040c6..00000000 --- a/docs/Hardware_Allwinner-H5-A64.md +++ /dev/null @@ -1,10 +0,0 @@ -# Allwinner H5 and A64 boards - -## Overview - -[See the generic Allwinner page](https://docs.armbian.com/Hardware_Allwinner/) - -## Warning - -Using the board without cooling in conjunction with the stable release of Ambian using kernel 5.4.y there is a risk of the board getting **permanently damaged** due to overheating. -If you decide to try the board without cooling, you can use `sudo armbianmonitor -r` to keep an eye on the temperatures. diff --git a/docs/Hardware_Allwinner-H6.md b/docs/Hardware_Allwinner-H6.md deleted file mode 100644 index 29f6e1eb..00000000 --- a/docs/Hardware_Allwinner-H6.md +++ /dev/null @@ -1,24 +0,0 @@ -# Allwinner H6 - -See also [generic Allwinner page](https://docs.armbian.com/Hardware_Allwinner/), - -## CPU frequency - -The H6 CPU frequency has ben soft-capped at 1,48 GHz to avoid thermal throttling too fast. This limit can be lifted by editing -`/etc/default/cpufrequtils` and set `MAX_SPEED` to `1810000`. -With the release of Armbian 20.05 "Kagu" new thermal zones have been added making this limitation obsolete and therefore has been removed. All H6 boards now clocking at the highest possible value OOB. - -**Warning** -Adding proper cooling is highly recommended. - -## PCIe (un-)supported - -Some H6 SoC based boards (like Pine H64 Model a, discontinued) are shipped with a PCIe slot. This slot **cannot** work out of the box as it has to be considered as broken by design. [Linux-Sunxi](https://linux-sunxi.org/H6#Errata) writes about this: - -> Allwinner H6 has a quirky PCIe controller that doesn't map the PCIe address space properly (only 64k accessible at one time) to CPU, and accessing the PCIe config space, I/O space or memory space will need to be wrapped. As Linux doesn't wrap PCIe memory space access, it's not possible to do a proper PCIe controller driver for H6. The BSP kernel modifies the driver to wrap the access, so it's also not generic, and only devices with modified driver will work. - -Icenowy is working on a wrapper to make PCIe work. Check [forums](https://forum.armbian.com/topic/13529-a-try-on-utilizing-h6-pcie-with-virtualization/). - -## Networking - -Trouble getting ethernet connection? Check [here](https://forum.armbian.com/topic/9368-orangepi-3-h6-allwiner-chip/page/32/?tab=comments#comment-105682) diff --git a/docs/Hardware_Allwinner.md b/docs/Hardware_Allwinner.md deleted file mode 100644 index 6203895b..00000000 --- a/docs/Hardware_Allwinner.md +++ /dev/null @@ -1,189 +0,0 @@ -# Generic howto for Allwinner devices - -## Legacy or current kernel ? - -Many Armbian images come in two flavours : _Legacy_ (using an older kernel version) and _current_ (up-to-date LTS kernel). Depending on kernel version, the procedure to enable/disable features is not the same. - - * _Legacy_ kernel (5.4.x): DT (Device Tree) overlays - * _Current_ kernel (5.10.x) : DT (Device Tree) overlays - -**Note:** Support for older kernel versiones (like 3.4.x or 3.10.x) has been dropped. - -### What flavour am I using ? - -Best way to know is by checking your kernel version : - -``` -root@bananapipro:~# uname -a -Linux bananapipro 4.5.2-sunxi #11 SMP Thu Apr 28 21:53:25 CEST 2016 armv7l GNU/Linux -``` - -In this example the kernel version is 4.5.2 so you can use DT to tweak some settings. If you get a kernel version 3.X then you'll be certainly using FEX like on an Orange Pi Plus 2E : - -``` -root@orangepiplus2e:~# uname -a -Linux orangepiplus2e 5.4.45-sun8i #10 SMP PREEMPT Wed Jun 1 19:43:08 CEST 2016 armv7l GNU/Linux -``` - -## Enable Hardware Features - -Some boards require some manual configuration to turn on/off certain features. In some cases, the procedure is "less than obvious", so we document some basic examples here. - -### How to reconfigure video output? - -This affect _current_ kernel only. - -U-Boot supports HDMI and LCD output on Allwinner sunxi SoCs, LCD output requires the `CONFIG_VIDEO_LCD_MODE` Kconfig value to be set. - -The sunxi U-Boot driver supports the following video-mode options: - -- `monitor=[none|dvi|hdmi|lcd|vga|composite-*]` - Select the video output to use - - - `none`: Disable video output. - - `dvi/hdmi`: Selects output over the hdmi connector with dvi resp. hdmi output format, if edid is used the format is automatically selected. - - `lcd`: Selects video output to a LCD screen. - - `vga`: Selects video output over the VGA connector. - - `composite-pal/composite-ntsc/composite-pal-m/composite-pal-nc`: Selects composite video output, note the specified resolution is ignored with composite video output. - - Defaults to `monitor=dvi`. - -- `hpd=[0|1]` - Enable use of the HDMI HotPlug Detect feature - 0: Disabled. Configure DVI/HDMI output even if no cable is detected - 1: Enabled. Fallback to the LCD / VGA / none in that order (if available) - Defaults to `hpd=1`. - -- `hpd_delay=` - How long to wait for the HDMI HPD signal in milliseconds - When the monitor and the board power up at the same time, it may take some time for the monitor to assert the HPD signal. This configures how long to wait for the HPD signal before assuming no cable is connected. - Defaults to `hpd_delay=500`. - -- `edid=[0|1]` - Enable use of DDC + EDID to get monitor info - 0: Disabled. - 1: Enabled. If valid EDID info was read from the monitor the EDID info will overrides the xres, yres and refresh from the video-mode env. variable. - Defaults to `edid=1`. - -- `overscan_x/overscan_y=` - Set x/y overscan value - This configures a black border on the left and right resp. top and bottom to deal with overscanning displays. Defaults to `overscan_x=32` and `overscan_y=20` for composite monitors, 0 for other monitors. - -For example to always use the HDMI connector, even if no cable is inserted, using edid info when available and otherwise initalizing it at 1024x768@60Hz, use: `setenv video-mode sunxi:1024x768-24@60,monitor=dvi,hpd=0,edid=0`. - -Parameters regarding video must be saved into U-Boot environment file since they must be read before reading boot script. You can do this by adding `saveenv` command at the end of boot script (boot.cmd). Remember to recompile boot.cmd to boot.scr and note that changes will come into action after second boot. - -### Connect your LCD display - -I tried three different display connection types: I2C, (4bit) parallel and SPI. All of them are working perfectly with my image. I didn’t took a picture of the third one. It’s a standard Hitachi HD44780 based 20×4 LCD, wired and tested [according to wiringBP example](https://github.com/LeMaker/WiringBP). - -#### I2C - -![](https://www.igorpecovnik.com/wp-content/uploads/2014/09/banana-i2c-display1.jpg) - -I am using [this code](https://github.com/vvromanov/cb_i2c_lcd) for mainline kernel and with [changed line](https://github.com/vvromanov/cb_i2c_lcd/blob/master/i2c_lcd.c#L28): /dev/i2c-%u = /dev/i2c-2 for Legacy kernel. - -#### SPI - -![](https://www.igorpecovnik.com/wp-content/uploads/2014/09/banana-spi-display.jpg) - -- I am using [2.4″ 240×320 SPI TFT LCD Serial Port Module+5/3.3V Pbc Adapter Micro SD ILI9341](https://www.google.com/search?q=2.4%E2%80%B3+240%C3%97320+SPI+TFT+LCD+Serial+Port+Module%2B5%2F3.3V+Pbc+Adapter+Micro+SD+ILI9341&oq=2.4%E2%80%B3+240%C3%97320+SPI+TFT+LCD+Serial+Port+Module%2B5%2F3.3V+Pbc+Adapter+Micro+SD+ILI9341) -- Wire according to [this map](https://blog.riyas.org/2014/07/quickly-test-il9341-22-inch-22-spi-tft-raspbmc-fbtft.html). -- You have to use Armbian 1.5 or newer. Currently working only under Legacy kernel. -- Add this to your /etc/modules: -`fbtft_device name=adafruit22a rotate=90 speed=48000000 fps=50 gpios=reset:25,led:19,dc:24` -- Reboot -- Test – display some picture on the screen: -`fbi -d /dev/fb2 -T 1 -noverbose -a yourimage.jpg` - -#### LVDS - - - -Currently working only under Legacy kernel. - -Image has pre-loaded settings for two LVDS display. - -To enable 7 inch. - -`ln -sf /boot/bin/bananapilcd7.bin /boot/script.bin` - -To enable 5 inch. - -`ln -sf /boot/bin/bananapilcd5.bin /boot/script.bin` - -If you need touch screen support, add this module to your /etc/modules - -`ft5x_ts` - -#### Framebuffer - -[Linux Framebuffer drivers for small TFT LCD display modules.](https://github.com/notro/fbtft/wiki) - -## FEX (outdated/unsupported, informational only) - -### Which file should I edit - -Armbian embed a lot of BIN files, but a symlink point to the one in use : - -``` -root@orangepiplus2e:~# ls -la /boot/script.bin -lrwxrwxrwx 1 root root 22 Jun 1 20:30 /boot/script.bin -> bin/orangepiplus2e.bin -``` - -### Updating a FEX - -You may need to use `sudo` with all the following commands. - -The whole process won't overwrite any of your files. If you're paranoid, you can make a proper backup of your BIN file : - -``` -cp /boot/script.bin /boot/bin/script.bin.backup -``` - -Then you can decompile your BIN into a FEX : - -``` -bin2fex /boot/script.bin /tmp/custom.fex -``` - -Finally you can edit your FEX file with your favorite text editor and compile it back to a BIN : - -``` -fex2bin /tmp/custom.fex /boot/bin/custom.bin -``` - -The last step is to change the symlink to use your custom BIN : - -``` -ln -sf /boot/bin/custom.bin /boot/script.bin -``` - -### H3 based Orange Pi, legacy kernel - -#### Enable serial /dev/ttyS3 on pins 8 and 10 of the 40 pin header - -Update the FEX configuration (which is compiled into a .bin) located at /boot/script.bin - -Decompile .bin to .fex -``` -cd /boot -bin2fex script.bin > custom.fex -rm script.bin # only removes symbolic link -``` - -Edit .fex file -``` -[uart3] -uart_used = 1 ; Change from 0 to 1 -uart_port = 3 -uart_type = 2 ; In this case we have a 2 pin UART -uart_tx = port:PA13<3><1> -uart_rx = port:PA14<3><1> -``` - -Compile .fex to .bin -``` -fex2bin custom.fex > script.bin -``` - -Reboot - -Notice that /dev/ttyS3 appears. That is your new UART device. diff --git a/docs/Hardware_Freescale-imx6.md b/docs/Hardware_Freescale-imx6.md deleted file mode 100644 index 566d18fb..00000000 --- a/docs/Hardware_Freescale-imx6.md +++ /dev/null @@ -1,101 +0,0 @@ -# Cubox and Hummingboard boards - -## Legacy -System images with legacy kernel - -- Kernel [3.14.x](https://github.com/linux4kix/linux-linaro-stable-mx6) with large hardware support, headers and some firmware included -- [Docker ready](https://forum.armbian.com/topic/490-docker-on-armbian/) – [what is Docker](https://www.docker.com/why-docker/)? -- PCI-E operational (Hummingboard Pro, Gate & Edge) -- mSATA / m2 operational (Hummingboard Pro & Edge) -- Enabled audio devices: HDMI, spdif, analogue -- [Bluetooth ready](https://wiki.debian.org/BluetoothUser) (working with Cubox-i/HB PRO on-board device or external key) -- [I2C](https://en.wikipedia.org/wiki/I%C2%B2C) ready and tested with small 16×2 LCD. Basic i2c tools included. -- SPI ready and tested with ILI9341 based 2.4″ TFT LCD display. -- [Drivers for small TFT LCD](https://github.com/notro/fbtft) display modules. -- [USB redirector](https://www.incentivespro.com/usb-server-usage.html) – for sharing USB over TCP/IP (disabled by default /etc/init.d/rc.usbsrvd) - -### Bugs or limitation - -- Gigabit ethernet transfer rate is around 50% of its theoretical max rate (internal chip bus limitation) - -## Mainline -System images with mainline kernel - -- [Mainline](https://www.kernel.org/) with large hardware support, headers and some firmware included -- [Docker ready](/User-Guide_Advanced-Features/#how-to-run-docker) – [what is Docker](https://www.docker.com/why-docker/)? -- PCI-E operational (Hummingboard Pro, Gate & Edge) -- mSATA / m2 operational (Hummingboard Pro & Edge) -- Enabled audio devices -- Bluetooth ready (working with supported external keys) - -### Set board type -By default the mainline Hummingboard / Cubox-i Armbian images are configured for the Cubox-I with a dual or quad core -SOM. - -To run the image on another platform or SOM the correct device tree file needs to be specified. These files are stored in -`/boot/dtb`. To set the correct device tree blow a `fdt_file=` parameter needs to be added to `/boot/armbianEnv.txt`. - -Set the `fdt_file=` parameter according to the list below: - -IMX6 Solo / DualLite: - -- [Hummingboard] `fdt_file=imx6dl-hummingboard.dtb` -- [Hummingboard v2] `fdt_file=imx6dl-hummingboard2.dtb` -- [Cubox-I] `fdt_file=imx6dl-cubox-i.dtb` - -IMX6 Dual / Quad: - -- [Hummingboard] `fdt_file=imx6q-hummingboard.dtb` -- [Hummingboard v2] `fdt_file=imx6q-hummingboard2.dtb` -- [Cubox-I] `fdt_file=imx6q-cubox-i.dtb` (Default) - -If a v1.5 SOM (with eMMC) is used the device tree names need to be changed, e.g.: `imx6q-cubox-i-som-v15.dtb` or -`imx6q-cubox-i-emmc-som-v15.dtb`. - -### Bugs or limitation - -- Gigabit ethernet transfer rate is around 50% of its theoretical max rate (internal chip bus limitation) - -## Desktop - -- Pre-installed: Firefox, LibreOffice Writer, Thunderbird -- Lightweight XFCE desktop -- Autologin, when normal user is created – no login manager (/etc/default/nodm) - -## Connect your LCD display - -I tried two different display connection types: I2C and SPI. Both are working perfectly with my image 2.6 or higher. - -![](https://www.armbian.com/wp-content/uploads/2014/08/hummingboard-display.png) - -- I am using [2.4″ 240×320 SPI TFT LCD Serial Port Module+5/3.3V Pbc Adapter Micro SD ILI9341](https://www.google.com/search?q=2.4%E2%80%B3+240%C3%97320+SPI+TFT+LCD+Serial+Port+Module%2B5%2F3.3V+Pbc+Adapter+Micro+SD+ILI9341&oq=2.4%E2%80%B3+240%C3%97320+SPI+TFT+LCD+Serial+Port+Module%2B5%2F3.3V+Pbc+Adapter+Micro+SD+ILI9341) -- Wire according to [this map](https://blog.riyas.org/2014/07/quickly-test-il9341-22-inch-22-spi-tft-raspbmc-fbtft.html). -- You have to use Armbian 1.5 or newer. Currently working only under Legacy kernel. -- Add this to your /etc/modules: -`fbtft_device name=adafruit22a rotate=90 speed=48000000 fps=50 gpios=reset:67,led:72,dc:195 busnum=1` -- Reboot -- Test – display some picture on the screen: -`fbi -d /dev/fb2 -T 1 -noverbose -a yourimage.jpg` -- [Troubleshooting and settings for other displays -LVDS](https://github.com/notro/fbtft/wiki) - -## GPIO - -[How to control HummingBoard GPIO from kernel space?](http://forum.solid-run.com/viewtopic.php?forum_uri=&t=2345&start=) - -## Udoo Quad - -- [Kernel 3.14.x](https://github.com/UDOOboard/linux_kernel) and [4.4.x](https://github.com/patrykk/linux-udoo) with some hardware support, headers and some firmware included -- [Docker ready](https://forum.armbian.com/topic/490-docker-on-armbian/) – [what is Docker](https://www.docker.com/why-docker/)? -- Wireless adapter with DHCP ready but disabled (/etc/network/interfaces, WPA2: normal connect, bonding / notebook or AP mode). It can handle between 40-70Mbit/s. -- SATA operational -- Enabled analogue (VT1613) and HDMI audio device - -### Bugs - -SATA & USB install not working on legacy kernel - -## Udoo Neo - -- [Kernel 3.14.x](https://github.com/UDOOboard/linux_kernel) with some hardware support, headers and some firmware included -- Wireless adapter with DHCP ready but disabled diff --git a/docs/Hardware_Marvell.md b/docs/Hardware_Marvell.md deleted file mode 100644 index 9a1b40e4..00000000 --- a/docs/Hardware_Marvell.md +++ /dev/null @@ -1,66 +0,0 @@ -# Marvell Armada - -## Helios4 - -### Overview - -All builds provide 100% hardware support for Helios4. - -### Build Version Status - -#### Legacy - -- U-Boot : Mainline 2019.04 -- Linux Kernel : Mainline 4.19.y - -#### Current - -- U-Boot : Mainline 2019.04 -- Linux Kernel : Mainline 5.4.y - -### Known Limitations - -* SDcard High Speed timing have compatibility issue with some brands.
-Temporary workaround : Disable UHS option/support.
-Can be manually enable, refer to the following [page](https://wiki.kobol.io/sdcard) (2020-11-25 link broken [archive](https://web.archive.org/web/20191113071529/https://wiki.kobol.io/sdcard/)). - -* During SATA heavy load, accessing SPI NOR Flash will generate ATA errors.
-Temporary workaround : Disable SPI NOR flash.
-Can be manually enable, refer to the following [page](https://wiki.kobol.io/spi) (2020-11-25 link broken [archive](https://web.archive.org/web/20191113071543/https://wiki.kobol.io/spi/)). - -### Notes - -Find more details about hardware support and configuration on [Helios4 Wiki](https://wiki.kobol.io). - -## Clearfog Pro/Base - -### Overview - -Both builds provide close to 100% hardware support, some slight differences are listed below. - -### Build Version Status - -#### Legacy/Current - -- [Mainline kernel](https://www.kernel.org/) with large hardware support, headers and some firmware included -- [Docker ready](/User-Guide_Advanced-Features/#how-to-run-docker) -- Both mPCIe are operational and [convertible to mSATA](#converting-mpcie-to-msata), M2 operational -- Added patch to unlock Atheros regulatory restrictions which unlock 5Ghz AP mode in cheap Atheros cards (ath9 driver) -- Bluetooth ready (working with supported external keys) -- [I2C](https://en.wikipedia.org/wiki/I%C2%B2C) ready. Basic i2c tools included. -- [SPI](https://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus) ready but untested. -- SFP is working at up to 1GB/s even with faster fiber modules -- SFP DDMI is operational (`sudo ethtool -m eth2`) - -### Bugs or limitation - -- all builds suffer from minor problems with specific mPCIe combinations. If you run into problems check [this test matrix](https://docs.google.com/spreadsheets/d/1izPD5XUzQC0ZZWb8FMBMkofN73w-m_6bjrtZK-zr_b4) for some known working/not working combinations. - -### Converting mPCIe to mSATA - -- To convert mPCIe to mSATA you have to enable the corresponding patches in [u-boot-mvebu](https://github.com/armbian/build/tree/master/patch/u-boot/u-boot-mvebu-dev). Afterwards rebuild u-boot with our build system and write the new u-boot to your boot medium. If you need assistance ask in the forum. - -### Notes - -- In case you ever run into troubles and ask for help in the forums please ensure to provide a serial console log (UART adapter on board accessible through Micro USB with 115200/8/N/1 settings) -- The boards can boot from various sources that are adjustable with a DIP switch. Comprehensive information about the necessary preparations [available here](https://github.com/nightseas/arm_applications/blob/master/doc/getting_started_with_clearfog_base.md). diff --git a/docs/Hardware_Rockchip.md b/docs/Hardware_Rockchip.md deleted file mode 100644 index b880813d..00000000 --- a/docs/Hardware_Rockchip.md +++ /dev/null @@ -1,48 +0,0 @@ -# Rockchip RK3399/RK3328 boards - -## Graphics 3D hardware acceleration -In mainline kernel, panfrost kernel driver paired with Mesa 22.0 (or more recent) provides excellent results, capable of 3D rendering and 2D composited user interfaces. -Also Gnome and KDE compositors are perfectly usable out of the box. - -There can be other issues like "unusual" screen resolutions like 1920x1200 are neither properly detected nor supported while classic *FullHD* 1920x1080 should be fine. - -## USB-C -The connector is supported and is capable of switching between USB and DP modes (tested on Orange Pi 4 LTS board). - -## Overclock overlay -The RK3399 can be overclocked at own risk. Use `rockchip-rk3399-opp-2ghz.dtbo` this. - -# Rockchip RK322x/RK3288 boards - -## Graphics 3D hardware acceleration -In mainline kernel, panfrost (RK3288) or lima (RK322x) kernel drivers, paired with Mesa 22.0 (or more recent), provides excellent results, capable of 3D rendering and 2D composited user interfaces. -Also Gnome and KDE compositors are perfectly usable out of the box. - -Usually a wide range of resolutions is supported with these SoCs, due to custom HDMI timings imported in the kernel drivers through external patches from LibreELEC project. Resolution support has been reported to work up to 4k resolutions, but some unusual and uncommon setup may still have unexpected issues. - -# Video Decoders for RK322x/RK3288/RK3328/RK3399 - updated March 2024 - -Video decoding is fully supported for these SoCs via kernel V4L2 stateless drivers like Hantro and rkvdec, though it requires userland support to be actually exploited. -Userland support is provided by gstreamer or FFmpeg frameworks, but their support varies among distributions because some bits are still missing. -For that reason, an experimental Debian/Ubuntu repository for Armbian is available at [https://forum.armbian.com/topic/32449-repository-for-v4l2request-hardware-video-decoding-rockchip-allwinner/](https://forum.armbian.com/topic/32449-repository-for-v4l2request-hardware-video-decoding-rockchip-allwinner/) to provide FFmpeg and MPV packages already compiled with the proper support for V4L2 stateless decoders. - -Hardware available and Supported video decoders are: -* h.264 -* h.265 -* VP8 -* VP9 - -Despite support level is getting better, at the moment of writing this documentation some bits are still moving for h.265 and VP9 and not finalized yet, though they should be usable and provide a good experience. - -Also DRMPRIME support in the kernel is quite established right now and it is possible to have both full-screen and windowed hardware decoding. - -Note: if you are asking about browsers, we are not there yet. Hardware video decoding and composition with existing graphics is a quite complex matter and all the actors in the pipeline should agree on the same protocols. - -# Video Decoders for RK35xx series - updated March 2024 - -Support in the mainline kernel is not yet ready or have not been tested yet. -These products have both rkvdec and Hantro IP (RK356x and RK3588 have Hantro G1) but there are no reports of their actual support or readiness. - -# Video Encoders - -All the SoCs above have Hantro IP which is capable of both decoding and encoding, but yet encoding support has not been tested and thus it is not known what is its state. diff --git a/docs/Process_Documentation.md b/docs/Process_Documentation.md deleted file mode 120000 index 32d46ee8..00000000 --- a/docs/Process_Documentation.md +++ /dev/null @@ -1 +0,0 @@ -../README.md \ No newline at end of file diff --git a/docs/Process_Release-Model.md b/docs/Process_Release-Model.md index 2079c212..606dccca 100644 --- a/docs/Process_Release-Model.md +++ b/docs/Process_Release-Model.md @@ -1,4 +1,14 @@ -# Release model +# Rolling releases + +Armbian makes daily rolliong releases which includes generating daily updates of stable kernels and daily releases of unstable kernels and userspace packages. + + + +Images are available at respective board download pages: + + + +# Point releases ## Release Dates diff --git a/docs/User-Guide_Allwinner_overlays.md b/docs/User-Guide_Allwinner_overlays.md deleted file mode 120000 index 25ade281..00000000 --- a/docs/User-Guide_Allwinner_overlays.md +++ /dev/null @@ -1 +0,0 @@ -User-Guide_Armbian_overlays.md \ No newline at end of file diff --git a/docs/User-Guide_Getting-Started-Download-Page.md b/docs/User-Guide_Getting-Started-Download-Page.md deleted file mode 100644 index 94d4e90d..00000000 --- a/docs/User-Guide_Getting-Started-Download-Page.md +++ /dev/null @@ -1,16 +0,0 @@ -**Preparation** - -Make sure you have a **good & reliable** SD card and a **proper power supply**. The XZ-compressed should be written with an approved imaging tool capable of validating the burn. - -**Approved Imaging Tools** - -* [USBImager](https://gitlab.com/bztsrc/usbimager) a lightweight cross-platform imaging tool -* [Balena Etcher](https://www.balena.io/etcher/) an electron / node.js based cross-platform imaging tool [(may contain spyware)](https://github.com/balena-io/etcher/issues?q=is%3Aissue+spyware) - -**Boot** - -Insert SD card into a slot and power the board. (First) boot (with DHCP) takes up to 35 seconds with a class 10 SD Card and cheapest board. - -**Login** - -Login as **root** on HDMI / serial console or via SSH and use password **1234**. You will be prompted to change this password at first login. Next you will be asked to create a normal user account that is sudo enabled (beware of default QWERTY keyboard settings at this stage). diff --git a/docs/User-Guide_Migration_from_Bananian.md b/docs/User-Guide_Migration_from_Bananian.md deleted file mode 100644 index 0329788b..00000000 --- a/docs/User-Guide_Migration_from_Bananian.md +++ /dev/null @@ -1,45 +0,0 @@ -# Migration from Bananian to Armbian - -*NOTE: THIS IS DEPRECATED* - -While technically possible to do an **in-place** upgrade/crossgrade from latest Bananian release (or similar SBC distros) to Armbian currently there exists no tool helping with this and most probably will never exist. At the bottom is explained where to find ressources that help with a manual in-place upgrade but we start with outlining the problems and our recommendations: - -## The challenges: - -### SD cards wear out after a certain amount of data being written to - -Only reasonable base for an migration to Armbian would be an updated Bananian installation (Bananian 16.04, already Debian Jessie based, Nico's 4.4 kernel). In case Bananian users are still on version 15.04 or earlier they need to upgrade to a more recent Bananian version anyway to move Bananian's base to Jessie. Such `apt-get dist-upgrade` tasks come with heavy write activity. Especially when planning a dist-upgrade to Stretch later this amount of random write activity on older/smaller SD cards might kill them. If the SD card is not brand new it's highly recommended to create a clone/backup first prior to every upgrade step. If the SD card is really old please be prepared that it might not survive an `apt-get dist-upgrade`. - -### All hardware will die eventually - -A lot of Bananian installations today have been running 24/7 for 3 years or even longer. While these little SBC are well suited for light-weight server tasks, the hardware can't exactly be called 'server grade'. Please keep this in mind if you're about to spend some time on a manual migration attempt that once you're done maybe your hardware will stop working few weeks/months later if it already runs +24 months. - -### Hardware up to the task? - -The vast majority of [boards Bananian runs on](https://www.bananian.org/hardware) is based on Allwinner's dual core A20 SoC which was a nice improvement over the first single-core Raspberry Pis few years ago but is pretty slow by today's standards. An awful lot of users (us Armbians **all** included) were excited by A20's 'native SATA' capabilities few years ago just to realize after purchase when using SATA attached storage that it's awfully slow and most probably the slowest 'native' SATA implementation existing (please wake up if in doubt and educate yourself [here](https://forum.armbian.com/topic/1925-some-storage-benchmarks-on-sbcs/&do=findComment&comment=34192), [here](https://linux-sunxi.org/Sunxi_devices_as_NAS#Influence_of_the_chosen_OS_image_on_NAS_performance) or [here](https://forum.openmediavault.org/index.php/Thread/19871-Which-energy-efficient-ARM-platform-to-choose/?postID=154980#post154980). Important: combining Allwinner's crappy SATA implementation with port multipliers [is always wrong](https://github.com/armbian/build/issues/548#issuecomment-332918004)). - -At the time of this writing (Oct 2017) Armbian supports +25 other ARM boards that show between 2 and 6 times better CPU performance than A20 devices. +20 boards we support show better network performance (A20 Gigabit Ethernet is not fully capable of 940 Mbits/sec in both directions). +15 boards support 2GB DRAM (a few even more just recently). And if you don't need Gigabit Ethernet you can get a new and fully supported board still better suited for light-weight server tasks than any Banana Pi for as less as $11 shipping included (check [this overview](https://forum.armbian.com/topic/1351-h3-board-buyers-guide/&do=findComment&comment=28169) please). - -While this diversity of ARM species might be confusing the good news is: When Armbian is running on them they all behave the same. - -## Alternatives to an in-place migration: - -### Continue on same hardware but prevent SD card hassles - -Especially if you run since years off the same SD card please be prepared that it might not survive an `apt-get dist-upgrade` and similar upgrade/crossgrade tasks. It's **strongly** recommended to clone/backup your card prior to every necessary upgrade step. Since this is time consuming and just a measure to prepare for what will happen in the future anyway (your SD card failing eventually -- if you're lucky immediately, if you're out of luck it will corrupt a lot of data dying slowly) a great idea is to buy a new one **now**. Please see [our community's collection of SD card performance tests](https://forum.armbian.com/topic/954-sd-card-performance/) and especially the 3 links at the top dealing with reliability concerns. - -Once you bought a new, fast and hopefully reliable SD card, you should [test it according to our documentation](https://docs.armbian.com/User-Guide_Getting-Started/#how-to-prepare-a-sd-card), then burn a fresh Armbian image on it and manually transfer data and settings from your Bananian installation. This way you preserve your current settings/data on the old Bananian SD card saving you also a lot of time/efforts to clone/backup stuff. - -**Important note:** if you're interested in NAS use cases you could also choose an OMV image from official [download location](https://sourceforge.net/projects/openmediavault/files/) (all the ARM board images are now based on Armbian, funnily even the ones for Raspberry Pi) - -### Replacing the hardware - -If your Bananian installation has been running for years, you better think about evaluating new hardware now. As explained above, A20's SATA implementation is [awfully slow](https://forum.armbian.com/topic/1925-some-storage-benchmarks-on-sbcs/&do=findComment&comment=34192) compared to good SATA implementations (Espressobin, Clearfog, Helios4) or even recent USB3 solutions, also Banana Pis can not saturate Gigabit Ethernet. It's almost 2018 now and we can choose from a variety of energy efficient boards more suited for the job. - -[My](https://forum.armbian.com/profile/7-tkaiser/) personal strategy was turning the various A20 servers into backup devices now receiving btrfs snapshots from better suited ARM servers in the meantime. New installation on new board, carefully migrating settings from Bananas, Cubietrucks or Lime boards to new server, testing, testing, testing, new installation on A20 device, setting up btrfs send|receive, testing, testing, testing, done. - -## In-place migration tipps: - -Since there is no easy migration tool you can only rely on contents collected below https://github.com/armbian/build/issues/648 -- if you read carefully through we had some hope experienced Bananian users would be volunteering in providing an in-place upgrade tool from Bananian to Armbian but unfortunately to no avail. So 6 months after the problem came to our attention we're now providing this document to help those affected taking the right decisions. Still no need to hurry, Bananian receives bug and security fixes for another 6 months so take your time and evaluate carefully which way to choose. - -Trivia: Anyone understanding german **will** enjoy Nico's refreshing [Rise and Fall of Bananian Linux](https://frank-mankel.de/kategorien/36-froscon/288-froscon-12) talk. diff --git a/docs/User-Guide_Networking.md b/docs/User-Guide_Networking.md index fd2ac1e8..93dbfaf5 100644 --- a/docs/User-Guide_Networking.md +++ b/docs/User-Guide_Networking.md @@ -153,7 +153,7 @@ Replace `eth0` with the name of your Ethernet Interface. ### Connecting to a wireless network -For connecting to a wireless network, you can use the same method as mention above for use with [`networkd` on minimal images](#connect-to-wireless-network). Just make sure to replace `renderer: networkd` with `renderer: NetworkManager`. +For connecting to a wireless network, you can use the same method as mention above for use with [`networkd` on minimal images](#connecting-to-a-wireless-network). Just make sure to replace `renderer: networkd` with `renderer: NetworkManager`. Alternatively, you can also use Network-Manager directly via the command line or GUI tools on your desktop: diff --git a/docs/board_details/clearfog.md b/docs/board_details/clearfog.md deleted file mode 100644 index d1987812..00000000 --- a/docs/board_details/clearfog.md +++ /dev/null @@ -1,16 +0,0 @@ -To boot the image from USB flash: - -- Write the image to a USB flash drive -- Insert the flash drive into the USB3.0 port -- Load the modified u-boot (from the Armbian image) using the UART method -- Stop the default boot sequence -- Execute in u-boot prompt: `run usbboot` - -To flash the image to eMMC: - -- Boot the image from USB flash -- Write the image to eMMC using `dd` or other methods -- Mount the eMMC partition and add a line `emmc_fix=on` to `/boot/armbianEnv.txt` file - this changes the DT during boot to switch from SD with card detect switch to a non-removable eMMC. -- Unmount the eMMC partition and reboot - -Please refer to [this](https://forum.armbian.com/topic/3072-clearfog-pro-emmc-requires-sd-card-to-detect-device/) forum thread for the USB boot details and [this](https://forum.solid-run.com/linux-kernel-and-bootloaders-f34/unstable-mmc-operation-with-upstream-kernel-t2986.html) thread for a discussion of known eMMC issues. diff --git a/docs/board_details/espressobin.md b/docs/board_details/espressobin.md deleted file mode 100644 index 6b2fdf2b..00000000 --- a/docs/board_details/espressobin.md +++ /dev/null @@ -1,16 +0,0 @@ -- manual flashing to latest u-boot is mandatory! [Download](https://dl.armbian.com/espressobin/u-boot/) the right boot flash for your board: 512,1G,2G, number of RAM chips and appropirate memory speeds. You can obtain numbers from current boot prompt. Copy this `flash-image-MEM-RAM_CHIPS-CPU_DDR_boot_sd_and_usb.bin` to your FAT formatted USB key, plug it into USB3.0 port and execute from u-boot prompt: - - bubt flash-image-MEM-RAM_CHIPS-CPU_DDR_boot_sd_and_usb.bin spi usb - - After updating your SPI flash with most recent "sd\_and\_usb" u-boot, you can boot from USB or SD card the exact same way. - -- in case you came from stock boot loader or your boot environment was erased somehow, this is what you need to put into u-boot: - - setenv initrd_addr 0x1100000 - setenv image_name boot/Image - setenv load_script 'if test -e mmc 0:1 boot/boot.scr; then echo \"... booting from SD\";setenv boot_interface mmc;else echo \"... booting from USB/SATA\";usb start;setenv boot_interface usb;fi;if test -e \$boot_interface 0:1 boot/boot.scr;then ext4load \$boot_interface 0:1 0x00800000 boot/boot.scr; source; fi' - setenv bootcmd 'run get_images; run set_bootargs; run load_script;booti \$kernel_addr \$ramfs_addr \$fdt_addr' - saveenv -- If you manage to crash your SPI, proceed with [SATA boot recovery](https://wiki.espressobin.net/tiki-index.php?page=Boot+ESPRESSObin+from+SATA+drive). -- booting directly from SATA is currently broken. -- rebooting works with 4.14.y and SD media while it is broken with SATA and USB (always stops) diff --git a/docs/board_details/images/miqi_connectors.png b/docs/board_details/images/miqi_connectors.png deleted file mode 100644 index 7c68f7f7..00000000 Binary files a/docs/board_details/images/miqi_connectors.png and /dev/null differ diff --git a/docs/board_details/images/unbrick-miqi.png b/docs/board_details/images/unbrick-miqi.png deleted file mode 100644 index 1974a3aa..00000000 Binary files a/docs/board_details/images/unbrick-miqi.png and /dev/null differ diff --git a/docs/board_details/miqi.md b/docs/board_details/miqi.md deleted file mode 100644 index 6538a8e3..00000000 --- a/docs/board_details/miqi.md +++ /dev/null @@ -1,8 +0,0 @@ -**How to unbrick MiQi?** - -When you can't restore your bootloader with pressing and holding the button while powering, you need to shorten this resistor with some tweezers and power the board. [Than proceed with flashing stock u-boot](https://github.com/mqmaker/miqi-prebuilt). - -![](https://raw.githubusercontent.com/armbian/documentation/master/docs/board_details/images/unbrick-miqi.png) -![](https://raw.githubusercontent.com/armbian/documentation/master/docs/board_details/images/miqi_connectors.png) - - diff --git a/docs/board_details/odroidc1.md b/docs/board_details/odroidc1.md deleted file mode 100644 index d334c7ad..00000000 --- a/docs/board_details/odroidc1.md +++ /dev/null @@ -1,8 +0,0 @@ -- Please note: From a software point of view ODROID C1, C1+ and C0 are (nearly) identical. For Hardware differences between C1 and C1+ and to see how to use USB OTG on the latter please see [here](https://odroid.com/dokuwiki/doku.php?id=en:c1_hardware#c1_has_below_improvements_from_the_original_c1). C0 is a stripped down and more power efficient C1+ that can be battery powered (see here [how to read out battery voltage](https://odroid.com/dokuwiki/doku.php?id=en:c0_read_battery_voltage)) -- Comprehensive device information and various tips&tricks can be found in [Hardkernel's wiki](https://odroid.com/dokuwiki/doku.php?id=en:odroid-c1). Please be aware that some of the information does not apply to Armbian (eg. we use a different partition table). Schematics can be found [here](https://dn.odroid.com/S805/Schematics/). -- Idle consumption of an ODROID-C1+ with Armbian defaults varies between 1800 mW (@504 MHz) and 1900 mW (@1728 MHz -- temperature also differs just by 2°C -- for reasons please refer to the ['race to idle' concept](https://en.wikipedia.org/wiki/Dynamic_frequency_scaling#Performance_impact). -- By defining `setenv hdmioutput "0"` and `setenv vpu "0"` in `/boot/boot.ini` followed by a reboot you get true headless mode (no consumption savings but `MemTotal` increases from 804 MB to 941 MB -- check `/proc/meminfo` if in doubt) -- You can save at least 170mW by cutting power to the internal USB hub (and also all USB devices connected to any of the type A receptacles) using `/sys/class/gpio/gpio4` (see description [here](https://forum.odroid.com/viewtopic.php?f=112&t=23763#p160852)). The same way you have full control over power consumption of a connected host powered USB disk: `umount /mnt/usb && echo 0 >/sys/class/gpio/gpio4/value` and `echo 1 >/sys/class/gpio/gpio4/value && sleep 2 && mount /mnt/usb` -- Interestingly at least on C1+ consumption remains the same if you switch from Gbit to Fast Ethernet or disable Ethernet at all. It seems the GbE PHY is powered all the time (maybe related to [performance/stabiity problems on ODROID-C1 in early 2015](https://forum.odroid.com/viewtopic.php?f=115&t=8121)) -- Ethernet performance is ~940 Mbits/sec in TX direction and 400-500 Mbits/sec in RX direction. You might be able to tweak the latter a little, just have a look in the link one paragraph above. -- the red led is a power led while the blue led is custom. Boot stage: as soon as u-boot is loaded the blue led lights solid and when kernel starts this changes to `heartbeat` blinking with default settings. Check `cat /sys/class/leds/*blue*/trigger` for other functionality. diff --git a/docs/board_details/odroidc2.md b/docs/board_details/odroidc2.md deleted file mode 100644 index 2f863aa8..00000000 --- a/docs/board_details/odroidc2.md +++ /dev/null @@ -1,10 +0,0 @@ -- Comprehensive device information and various tips&tricks can be found in [Hardkernel's wiki](https://odroid.com/dokuwiki/doku.php?id=en:odroid-c2). Please be aware that some of the information does not apply to Armbian (eg. we use a different partition table). Schematics can be found [here](https://dn.odroid.com/S905/Schematic/). -- Idle consumption with legacy image in headless mode (`setenv nographics "1"` defined in `/boot/boot.ini`) and only Gigabit Ethernet connected is between ~2300 mW (@500 MHz) and ~2400 mW (@1536 MHz). Hardkernel provides the possibility to [exceed 1536 MHz max cpufreq](https://odroid.com/dokuwiki/doku.php?id=en:c2_set_cpu_freq) but Armbian refrains from doing so. In case you want to change settings please keep in mind that you might have to adjust both `/boot/boot.ini` and `/etc/defaults/cpufrequtils`. -- The legacy kernel we use implements a few different cpufreq governors that show partially strange behaviour (`interactive` most of the times acting like `performance` for example). Since idle consumption differences between different cpufreq governors are negligible choosing even `performance` seems to be ok. At least `conservative` governor that switches between upper and lower clockspeeds (for details see [here](https://github.com/igorpecovnik/lib/issues/499#issuecomment-253481174)) leads to some USB performance drops while not providing significant savings. In case you activate higher clockspeeds please keep in mind that switching then to `performance` governor is needed since otherwise you might end up with a slower system since the added cpufreq operating points will slow down switching to highest clockspeed when needed. -- If you don't need GbE network transfer speeds switching to Fast Ethernet with `ethtool -s eth0 speed 100 duplex full` saves ~230 mW. Completely disabling Ethernet saves an additional 100mW. -- GbE Ethernet speed should reach 935 Mbits/sec in TX direction. In RX direction with defaults you should get 800 Mbits/sec but with some tuning it should be able to exceed 900 Mbits/sec: - - echo 32768 > /proc/sys/net/core/rps_sock_flow_entries - - echo 32768 > /sys/class/net/eth0/queues/rx-0/rps_flow_cnt -- You can save at least 170mW by cutting power to the internal USB hub (and also all USB devices connected to any of the type A receptacles) using `/sys/class/gpio/gpio126` (see description [here](https://forum.odroid.com/viewtopic.php?t=22637&p=151969#p151982)). The same way you have full control over power consumption of a connected host powered USB disk: `umount /mnt/usb && echo 0 >/sys/class/gpio/gpio126/value` and `echo 1 >/sys/class/gpio/gpio126/value && sleep 2 && mount /mnt/usb` -- Reducing DRAM clockspeed to reduce consumption doesn't work (difference between default 912 MHz and 408 MHz is just ~100mW less and also [requires a reboot](https://odroid.com/dokuwiki/doku.php?id=en:c2_adjust_ddrclk)) -- the red led is a power led while the blue led is custom. Boot stage: as soon as u-boot is loaded the blue led lights solid and when kernel starts this changes to `heartbeat` blinking with default settings. Check `cat /sys/class/leds/*blue*/trigger` for other functionality. diff --git a/docs/board_details/odroidhc1.md b/docs/board_details/odroidhc1.md deleted file mode 100644 index 6e5c6548..00000000 --- a/docs/board_details/odroidhc1.md +++ /dev/null @@ -1,11 +0,0 @@ -- a stripped down XU4 version dropping the internal USB hub, display and GPIO support but adding instead a great performing and UAS capable USB-to-SATA bridge (JMS578) directly to the PCB so no more cable/contact issues, no more underpowering and no more UAS hassles with some disk enclosures (that contain a broken SATA bridge or combine a working UAS capable chip with a branded/broken firmware) - -from Review: -> https://forum.armbian.com/topic/4983-odroid-hc1/ - -1. Software support efforts needed for HC1 (or the other variants MC1 or HC2) are zero since Hardkernel kept everything 100% compatible to ODROID XU4 -1. HC1 is a very nice design addressing a few of XU3/XU4 former USB3 issues (mostly related to 'hardware' issues like cable/contact problems with USB3-A or underpowering) -1. Heat dissipation works very well (and combining this enclosure design with a huge, slow and therefore silent fan is always an option, Hardkernel evens sells a large fan suitable for 4 HC1 or MC1 units) -1. The used JMS578 bridge chip to provide SATA access is a really good choice since this IC does not only support UAS (USB Attached SCSI, way more efficient than the older MassStorage protocol and also the reason why SSDs perform twice as fast on HC1 now with 4.x kernel) but also SAT ('SCSI / ATA Translation') so you can make use of tools like hdparm/hdidle without any issues and also TRIM (though software support is lacking at least in 4.9 kernel tested with) -1. Dealing with attached SATA disks is way more reliable than on other 'USB only' platforms since connection/underpowering problems are solved -1. Only downside is the age/generation of the Exynos 5422 SoC since being an ARMv7 design it's lacking for example 'ARM crypto extensions' compared to some more recent ARM SoCs which can do stuff like AES encryption a lot more efficient/faster diff --git a/docs/board_details/orangepipc2.md b/docs/board_details/orangepipc2.md deleted file mode 100644 index a92e6a33..00000000 --- a/docs/board_details/orangepipc2.md +++ /dev/null @@ -1,20 +0,0 @@ -Following features that arent't present in the mainline kernel should work: - -- Ethernet -- DVFS -- THS -- DRM/KMS HDMI display driver with audio (2ch / stereo only) and CEC support - -Refer to the [status matrix](https://linux-sunxi.org/Linux_mainlining_effort#Status_Matrix) for mainline kernel support status - -Features that do not work: - -- CVBS (composite video) output -- Proper shutdown - switching off the power is recommended -- Suspend/resume - -Features that do not work and will not be added anytime soon: - -- Hardware accelerated video decoding (Cedrus) -- Mali driver -- CSI camera input diff --git a/docs/board_details/pine64.md b/docs/board_details/pine64.md deleted file mode 100644 index cf339f7b..00000000 --- a/docs/board_details/pine64.md +++ /dev/null @@ -1,22 +0,0 @@ -- **Important**: A few Pine64+ devices suffer from a Gbit Ethernet issue related to the GbE PHY leading to a severe amount of packet losses which might render Ethernet unuseable. It's confirmed as [hardware issue](https://forum.pine64.org/showthread.php?tid=835&pid=19773#pid19773) and if you're affected or not can be simply checked by testing network throughput with *iperf3*. Against another GbE capable device you should exceed 900 Mbits/sec with Armbian (only 800 Mbits/sec in RX direction when not using Xenial due to [iperf3 being single-threaded in both directions then and bottlenecked by CPU](https://forum.armbian.com/topic/1917-armbian-running-on-pine64-and-other-a64h5-devices/?p=14673)). If you see low throughput and high retransmit counts then a work-around is to switch Pine64+ to Fast Ethernet only by adding `ethtool -s eth0 speed 100 duplex full` to `/etc/rc.local`. At the time of this writing a true fix is only replacing the defective board by Pine Microsystems Inc. -- The only led on the board is a power led, it starts to light as soon as power is available and does not indicate anything else. So the only 'DOA or not?' indicator on this board is to burn an image, connect Ethernet, power on the board and wait 20 seconds whether the leds on the Ethernet jack show activity or not. -- Comprehensive device information is available [in linux-sunxi wiki](https://linux-sunxi.org/Pine64). -- Idle consumption with legacy image is ~1500 mW on Pine64 (or Pine64+ forced to use Fast Ethernet) and 1870 mW on Pine64+ (if you don't need GbE network transfer speeds switching to Fast Ethernet with `ethtool -s eth0 speed 100 duplex full` saves ~350 mW). CPU stress test results in consumption of a little over 4 W. -- Since the default DC-IN connector unfortunately is made with a Micro USB jack it's important to keep in mind that most USB cables have a resistance way too high which leads to undervoltage situations. In case you run into stability problems please power your Pine64(+) through the Euler pins (see [linux-sunxi wiki](https://linux-sunxi.org/File:Pine64_Powered_through_Euler_Connector.jpg) for details) on the GPIO header. -- If you clone one Armbian installation for more than one Pine64 please keep in mind that currently the Ethernet MAC address will be chosen randomly on first boot and then saved in `/boot/uEnv.txt`. To avoid MAC address collisions you must adjust the address there or delete the whole `ethaddr` line (next boot will [assign a new MAC address automagically](https://github.com/igorpecovnik/lib/blob/54070358c28d5e88f14305f2e8d179875e5b2e5e/scripts/firstrun#L411-L414)). OS images from Aug 2016 or before suffer from [this bug](https://github.com/longsleep/linux-pine64/commit/58636d53c21e1ee31e98bb971ebf95ebf44d6f2a) so `/boot/uEnv.txt` has to be adjusted manually in any case if more than one Pine64 joins the same Ethernet network. -- Even if HDMI situation is still somewhat limited Armbian starting with release 5.21 supports setting the default resolution in `/boot/armbianEnv.txt` (defaults to `720p60` and could be changed to 4K@30Hz for example with an entry `disp_mode=2160p30` -- for the list of supported resolutions please have a look into `/boot/boot.cmd`) -- If you use a DVI display don't forget to define `disp_dvi_compat=1` in `/boot/armbianEnv.txt` (supported starting with 5.21). -- If you want to run heavy loads on Pine64 please keep in mind that you might need a heatsink to prevent throttling. Armbian uses community throttling settings that protect A64 SoC from overheating but without improved heat dissipation any heavy workload running longer than 60 seconds will result in CPU cores being clocked down to stay below 90°C SoC temperature. See the [PINE A64 heat sink locations](https://wiki.pine64.org/images/2/2e/Pine64_Board_Connector_heatsink.png). -- Situation with mainline kernel can be considered experimental. At the moment only basic functionality is implemented and **no** thermal protection (throttling) is working (no cpufreq scaling also and no access to PMIC too). Therefore also pretty conservative settings are used which negatively impact performance. -- In case you use mainline kernel already you can adjust cpufreq to 864 MHz for example by adding a line with `mw.l 0x1c20000 0x80001110` to `/boot/boot.cmd` (don't exceed 864 MHz now since [VDD_CPUX is currently limited to 1.1V](https://linux-sunxi.org/Pine64#CPU_clock_speed_limit)). By defining `mw.l 0x1c2005c 1` on a separate line you can speed up USB and Ethernet -- [Reference](https://forum.armbian.com/topic/1917-armbian-running-on-pine64-and-other-a64h5-devices/?p=15225)). -- It's possible to convert the upper USB port (normally an OTG port) into a full USB host port using an own PHY by setting some [magic bits](https://irclog.whitequark.org/linux-sunxi/2016-09-06#17478535;). -- To use/configure Wi-Fi (currently only supported with legacy images) the most simple way is to use `NetworkManager`. Simply follow these steps (as root): - - `echo "blacklist 8723bs_vq0" >/etc/modprobe.d/8723bs_vq0.conf` (optional, not really necessary) - - `sed -i 's/p2p0/p2p0,wlan1/' /etc/NetworkManager/NetworkManager.conf` (optional, not really necessary) - - `nmtui` (choose then *Activate a connection*) -- You could also use the other Wi-Fi interface for an access point at the same time. In this case you want to use `wlan1` and follow [these instructions](https://help.ubuntu.com/community/WifiDocs/WirelessAccessPoint). Please note that Armbian already ships with an example default config `/etc/network/interfaces.hostapd` using `wlan0` and that we also ship with an own `hostapd` version (check with `dpkg -l | grep hostapd`). -- Starting with [Armbian 5.21](https://github.com/igorpecovnik/lib/commit/04e6a4d76ad71a9f2117ae8b07c41617bfcb1eae) fixed camera drivers for both SK54EC and OV5640 are included. -- Currently BT is not supported out of the box by Armbian. Please read through [this thread in pine64 forum](https://forum.pine64.org/showthread.php?tid=2248&pid=21412#pid21412) to enable it. -- Starting with Armbian 5.24 in `/boot/armbianEnv.txt` camera support can be activated: `camera_type=none|s5k4ec|ov5640` (defaults to `none`, reboot needed for changes to take effect). Note that you also need kernel module supporting CSI that is [included](https://github.com/armbian/build/pull/5041) in later versions of Armbian. -- Pine64's own LCD with touchscreen support can simply be activated in `/boot/armbianEnv.txt` by setting `overlays=pine64-7inch-lcd`. -- Starting with 5.25 in `/boot/armbianEnv.txt` two more parameters can be set: `gmac-tx-delay` (defaults to `3`) and `gmac-rx-delay` (defaults to `0`). Adjusting this parameters should not be necessary but in case you are curious or experience bad Gigabit Ethernet performance please read through [the appropriate github issue](https://github.com/igorpecovnik/lib/issues/546). diff --git a/docs/boards/bananapi.md b/docs/boards/bananapi.md deleted file mode 100644 index 4e786233..00000000 --- a/docs/boards/bananapi.md +++ /dev/null @@ -1,3 +0,0 @@ -- total memory is 1000Mb (disabled all memory reservations for GPU on CLI images) -- drivers for [LVDS LCD display modules](https://www.lenovator.com/7-inch-LCD) are added. TS module: ft5x_ts, added configuration for 7″ – [other sizes](https://github.com/LeMaker/fex_configuration/tree/master/fex). - diff --git a/docs/boards/bananapiplus.md b/docs/boards/bananapiplus.md deleted file mode 100644 index 24158c07..00000000 --- a/docs/boards/bananapiplus.md +++ /dev/null @@ -1,9 +0,0 @@ -This is a universal image shared with the Banana Pi board. - -To get full functionality of this board please login as root and execute: - - echo 'fdtfile=sun7i-a20-bananapi-m1-plus.dtb' >> /boot/armbianEnv.txt - ln -fs bin/bananapim1plus.bin /boot/script.bin - reboot - -WiFi does not want to connect in legacy kernel, while it works fine in mainline. \ No newline at end of file diff --git a/docs/boards/beelinkx2.md b/docs/boards/beelinkx2.md deleted file mode 100644 index bc2686e2..00000000 --- a/docs/boards/beelinkx2.md +++ /dev/null @@ -1 +0,0 @@ -- Device has [different wireless chips](https://forum.armbian.com/topic/872-beelink-x2-with-armbian-possible) so wlan0 (WIFI connection) might not work out of the box. diff --git a/docs/boards/cubieboard.md b/docs/boards/cubieboard.md deleted file mode 100644 index ae0b5396..00000000 --- a/docs/boards/cubieboard.md +++ /dev/null @@ -1,2 +0,0 @@ -- installation to NAND with root on SATA/USB is not supported. Legacy kernel only, where NAND support exist. -- total memory is 1000Mb (disabled all memory reservations for GPU on CLI images) \ No newline at end of file diff --git a/docs/boards/cubieboard2.md b/docs/boards/cubieboard2.md deleted file mode 100644 index 8089d421..00000000 --- a/docs/boards/cubieboard2.md +++ /dev/null @@ -1,4 +0,0 @@ -- [PWM ready](https://github.com/dwilkins/pwm-sunxi) on pin PB2 (legacy) -- total memory is 1000Mb (disabled all memory reservations for GPU on CLI images) -- support for dual micro SD card version (since v4.5) -- make sure you power the board via power connector otherwise your USB port won’t be powered \ No newline at end of file diff --git a/docs/boards/cubietruck.md b/docs/boards/cubietruck.md deleted file mode 100644 index 4a754883..00000000 --- a/docs/boards/cubietruck.md +++ /dev/null @@ -1,6 +0,0 @@ -- [PWM ready](https://github.com/dwilkins/pwm-sunxi) on pin PB2 (legacy) -- bluetooth working with on-board device. Enabled by default on both kernels. -- total memory is 2000Mb (disabled all memory reservations for GPU on CLI images) -- due to bad PCB placement, there is [some crosstalk between Wifi and VGA in certain videomodes](https://linux-sunxi.org/Cubietruck#VGA) -- make sure you power the board via power connector otherwise your USB port won’t be powered -- Our OS images are only for A20 based Cubietruck and do not work on H8 based so called [Cubietruck Plus](https://linux-sunxi.org/Cubietech_Cubietruck_Plus) (we don't support CT+ anytime soon due too some design flaws like no real SATA and thermal problems) diff --git a/docs/boards/cubox-i.md b/docs/boards/cubox-i.md deleted file mode 100644 index 8f87f92b..00000000 --- a/docs/boards/cubox-i.md +++ /dev/null @@ -1 +0,0 @@ -- mainline kernel images: audio does not work on all devices, Bluetooth is unstable. \ No newline at end of file diff --git a/docs/boards/lamobo-r1.md b/docs/boards/lamobo-r1.md deleted file mode 100644 index 78641773..00000000 --- a/docs/boards/lamobo-r1.md +++ /dev/null @@ -1,4 +0,0 @@ -- total memory is 1000Mb (disabled all memory reservations for GPU) -- drivers for [LVDS LCD display modules](https://www.lenovator.com/7-inch-LCD) are added. TS module: ft5x_ts, added configuration for 7″ – [other sizes](https://github.com/LeMaker/fex_configuration/tree/master/fex). -- legacy kernel: BCM53125 switch configured as follows – looking at front of ports: |2|1|0|4|(LAN=manual) |3|(WAN=dhcp and bridged to enabled wireless adapter in (theoretical) high throughput mode with SSID lamobo and password 12345678 -- mainline kernel: please check the "Known issues" tab. diff --git a/docs/boards/lepotato.md b/docs/boards/lepotato.md deleted file mode 100644 index 87e988f1..00000000 --- a/docs/boards/lepotato.md +++ /dev/null @@ -1,3 +0,0 @@ -- Troubles with HDMI to VGA converters -- Not many screen resolution supported -- Ethernet drivers need some fixing diff --git a/docs/boards/lime-a10.md b/docs/boards/lime-a10.md deleted file mode 100644 index a3b05d5a..00000000 --- a/docs/boards/lime-a10.md +++ /dev/null @@ -1 +0,0 @@ -- installation to NAND with root on SATA/USB is not supported. Legacy kernel only, where NAND support exist. \ No newline at end of file diff --git a/docs/boards/miqi.md b/docs/boards/miqi.md deleted file mode 100644 index b43c9089..00000000 --- a/docs/boards/miqi.md +++ /dev/null @@ -1,9 +0,0 @@ -- it's highly recommended to [power via header](https://forum.armbian.com/topic/1095-miqi-is-a-35-single-board-computer-with-rockchip-rk3288/#comment-8338) with quality and powerful (3A) PSU - if you want stable operations and overclocking? In another words - don't even try to power via stock micro USB power connector since your board will suffer from regular crashing and might not even boot up. -- to boot from SD card you need to press and hold a button on the back side of the board and power on. This erases bootloader on eMMC and now you can boot from SD. In case of troubles use [this tool to restore stock bootloader](https://github.com/mqmaker/miqi-prebuilt). -- known issues: MALI and video acceleration libraries are not installed yet -- overclocking to 2.2Ghz is possible with (patched) mainline kernel. Enable with: - - echo 1 > /sys/devices/system/cpu/cpufreq/boost # enable turbo - nano /etc/default/cpufrequtils # adjust new limit - /etc/init.d/cpufrequtils restart # restart cpufrequtils - diff --git a/docs/boards/nanopiair.md b/docs/boards/nanopiair.md deleted file mode 100644 index 5969774c..00000000 --- a/docs/boards/nanopiair.md +++ /dev/null @@ -1,3 +0,0 @@ -- Wireless: Air has no aerial so you need to attach an antenna to the u.FL connector! -- known issues with legacy images / testing needed: audio out in all variants -- serial console gadget on the OTG port is available after the system boots up. Please make sure that board is properly powered (i.e. with microUSB Y cable or via GPIO pins) because a standard PC USB port will not provide enough current to the board diff --git a/docs/boards/nanopik2.md b/docs/boards/nanopik2.md deleted file mode 100644 index e4b0303a..00000000 --- a/docs/boards/nanopik2.md +++ /dev/null @@ -1,2 +0,0 @@ -- mainline kernel images: HDMI output not yet implemented -- troubles with HDMI to VGA converters. Not many screen resolution supported \ No newline at end of file diff --git a/docs/boards/nanopim1.md b/docs/boards/nanopim1.md deleted file mode 100644 index a8fe24d8..00000000 --- a/docs/boards/nanopim1.md +++ /dev/null @@ -1 +0,0 @@ -- You can use this image also with pcDuino4 Nano (being an [OEM variant of NanoPi M1](https://www.cnx-software.com/2016/09/13/20-pcduino4-nano-is-yet-another-allwinner-h3-development-board-sort-of/)) diff --git a/docs/boards/nanopineo.md b/docs/boards/nanopineo.md deleted file mode 100644 index e674111d..00000000 --- a/docs/boards/nanopineo.md +++ /dev/null @@ -1,2 +0,0 @@ -- known issues with legacy images / testing needed: audio out in all variants -- serial console gadget on the OTG port is available after the system boots up. Please make sure that board is properly powered (i.e. with microUSB Y cable or via GPIO pins) because a standard PC USB port will not provide enough current to the board diff --git a/docs/boards/orangepi.md b/docs/boards/orangepi.md deleted file mode 100644 index 46ecae48..00000000 --- a/docs/boards/orangepi.md +++ /dev/null @@ -1,12 +0,0 @@ -This is a universal image shared with the Banana Pi board. - -To get full functionality of this board please login as root and execute: - - apt-get update - apt-get upgrade - source /etc/armbian-release - dpkg -r linux-u-boot-bananapi-${BRANCH} linux-$(lsb_release -cs)-root-${BRANCH}-bananapi - apt-get -y install linux-u-boot-orangepi-${BRANCH} linux-$(lsb_release -cs)-root-${BRANCH}-orangepi - ln -fs bin/orangepi.bin /boot/script.bin - echo orangepi > /etc/hostname - reboot \ No newline at end of file diff --git a/docs/boards/orangepilite.md b/docs/boards/orangepilite.md deleted file mode 100644 index 17354ec3..00000000 --- a/docs/boards/orangepilite.md +++ /dev/null @@ -1 +0,0 @@ -- serial console gadget on the OTG port is available after the system boots up. Please make sure that board is properly powered (i.e. with microUSB Y cable or via GPIO pins) because a standard PC USB port will not provide enough current to the board diff --git a/docs/boards/orangepizero.md b/docs/boards/orangepizero.md deleted file mode 100644 index 6be8f78f..00000000 --- a/docs/boards/orangepizero.md +++ /dev/null @@ -1,2 +0,0 @@ -- serial console gadget on the OTG port is available after the system boots up. Please make sure that board is properly powered (i.e. with microUSB Y cable or via GPIO pins) because a standard PC USB port will not provide enough current to the board -- it is possible to boot Armbian images from USB storage if a proper mainline u-boot is programmed to the onboard SPI flash diff --git a/docs/boards/pine64.md b/docs/boards/pine64.md deleted file mode 100644 index 9028b311..00000000 --- a/docs/boards/pine64.md +++ /dev/null @@ -1 +0,0 @@ -See the [board details](../board_details/pine64.md). diff --git a/docs/boards/pinebook-a64.md b/docs/boards/pinebook-a64.md deleted file mode 100644 index 7b559022..00000000 --- a/docs/boards/pinebook-a64.md +++ /dev/null @@ -1,3 +0,0 @@ -- having anything plugged into headphone jack might prevent booting (serial console pinmuxed) -- touchpad occasionally causes mouse pointer jumps -- HDMI output not yet implemented diff --git a/docs/boards/tinkerboard.md b/docs/boards/tinkerboard.md deleted file mode 100644 index 5b8a11a3..00000000 --- a/docs/boards/tinkerboard.md +++ /dev/null @@ -1,7 +0,0 @@ -- Severe powering troubles due to Micro USB power connector. It's recommended to [power through GPIO pins](https://forum.armbian.com/topic/3327-asus-tinkerboard/&do=findComment&comment=32047) to prevent under-voltage issues (instabilities, boot/crash cycles). -- Overclocking to 2.2GHz is possible with quality 3A PSU connected to GPIO pins and (patched) mainline kernel. Enable with: - - echo 1 > /sys/devices/system/cpu/cpufreq/boost # enable turbo - nano /etc/default/cpufrequtils # adjust new limit - service cpufrequtils restart # restart cpufrequtils - diff --git a/docs/index.md b/docs/index.md index 01247d40..901c00d1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -67,7 +67,7 @@ If you still cannot find what you need here visit the [_Armbian forum_](https:// Armbian will publish and distribute “stable” CLI images for maintained boards through its mirror network. *Supported/maintained* is not a guarantee. *Supported/maintained* has a named maintainer and implies a particular SBC is at a high level of software maturity. Due to the complexity and lack-of-openness in the ecosystem it is unlikely that all accelerated and specialized functionalities (like 3D, VE, I²C...) will be available. -For more information is see the [Board Support Guide](User-Guide_Board-Support-Rules/) +For more information is see the [Board Support Guide](User-Guide_Board-Support-Rules.md) ### Maintained boards @@ -80,7 +80,7 @@ Due to lack of manpower we unfortunately have to be very picky about bug reports # Get Involved! # -* [Contribute](Process_Contribute/) +* [Contribute](Process_Contribute.md) * [Community](https://forum.armbian.com/) * [Contact](https://www.armbian.com/#contact) diff --git a/docs/known_issues/cubox.md b/docs/known_issues/cubox.md deleted file mode 100644 index fb50cb71..00000000 --- a/docs/known_issues/cubox.md +++ /dev/null @@ -1,5 +0,0 @@ -- Gigabit ethernet transfer rate is around 50% of its theoretical max rate (internal chip bus limitation) - -**Mainline kernel images (all boards)** (`next` branch) - -- use armbian-config to select proper DTB for your board (armbian-config -> system -> DTB) \ No newline at end of file diff --git a/docs/known_issues/odroidc2.md b/docs/known_issues/odroidc2.md deleted file mode 100644 index d3f5a12f..00000000 --- a/docs/known_issues/odroidc2.md +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/known_issues/odroidhc1.md b/docs/known_issues/odroidhc1.md deleted file mode 100644 index 8fb997a4..00000000 --- a/docs/known_issues/odroidhc1.md +++ /dev/null @@ -1,41 +0,0 @@ -**Legacy kernel images** - -Based on a review from @tkaiser, - -> https://forum.armbian.com/topic/4983-odroid-hc1/ - -1. Use next kernel, -1. don't think about USB3 issues any more (that's a XU4 problem), -1. don't expect serial console problems (that was an Armbian problem), and -1. please overthink 'rootfs on HDD' (on SSD that's great, HDDs are too slow and you prevent them from sleeping when moving the rootfs on them). - -- eMMC install might be broken if you don't have recent uboot on your eMMC card - you must update it. Add `run copy_uboot_sd2emmc` to your boot.ini, boot from SD card with attached eMMC. This is one time job - remove that command from boot.ini, -- serial console is broken. - -**Mainline kernel images** -TBD - -Hardkernel kept everything 100% compatible to ODROID XU4 - -With HC1 we're talking about Hardkernel's 4.9 or mainline - -**Unverified matter** -> derived from comment chain in the review - -1. Mine is not connecting at gigabit - fast ethernet only. Same cable (+few others), same PSU, same SD card, any kernel, while XU4 runs at Gigabit w/o problem -> Possibly a cable quality issue, as a cable swap caused the problem to disappear - -**Notes** -1. Based on the XU4 template with exceptions - -1. To avoid 'using up' write cycles on the SD media, once working, move to a RO root -filesystem, and 'chain boot' into the 2.5 in SATA drive (either SSD or spinnnig) -which do not have the same 'wear' issues - -**Boot message chain** -1. Made with: -> armbianmonitor -u output - -test run done with external RTL8153 behind internal USB3 hub on XU4 - -> http://sprunge.us/cOJP diff --git a/docs/known_issues/odroidxu4.md b/docs/known_issues/odroidxu4.md deleted file mode 100644 index e525bef4..00000000 --- a/docs/known_issues/odroidxu4.md +++ /dev/null @@ -1 +0,0 @@ -- eMMC install might be broken if you don't have recent uboot on your eMMC card - you must update it. Boot from SD card, run armbian-install and choose "Update bootloader on a special eMMC partition". After that, you can use eMMC as boot device. You only need to do this once. \ No newline at end of file diff --git a/docs/known_issues/sun4i.md b/docs/known_issues/sun4i.md deleted file mode 100644 index 13d635b9..00000000 --- a/docs/known_issues/sun4i.md +++ /dev/null @@ -1,5 +0,0 @@ -**Mainline kernel** (`current`/`edge` branches) - -- [different GPIO numbering](https://linux-sunxi.org/GPIO) -- experimental video acceleration -- `schedutil` governor may cause clicks and pops on audio output - change to `ondemand` to work around this issue diff --git a/docs/known_issues/sun50iw1.md b/docs/known_issues/sun50iw1.md deleted file mode 100644 index acd17c07..00000000 --- a/docs/known_issues/sun50iw1.md +++ /dev/null @@ -1,8 +0,0 @@ -**Mainline kernel images (all boards) ** (`current` and `edge` branch) - -- [Check mainlining effort status matrix](https://linux-sunxi.org/Linux_mainlining_effort#Status_Matrix) - -**Board: Pine64/Pine64+ ** - -- Gigabit Ethernet performance: on some boards was confirmed as [hardware issue](https://forum.pine64.org/showthread.php?tid=835&pid=19773#pid19773), though the legacy kernel received a workaround that may help on some boards. -- Gigabit Ethernet performance: setting TX/RX delays manually in /boot/armbianEnv may improve performance on some boards. Refer to [this github issue](https://github.com/igorpecovnik/lib/issues/546) for the details. diff --git a/docs/known_issues/sun50iw2.md b/docs/known_issues/sun50iw2.md deleted file mode 100644 index 2b5ab4a8..00000000 --- a/docs/known_issues/sun50iw2.md +++ /dev/null @@ -1,4 +0,0 @@ -**All currently available OS images for H5 boards are experimental** - -- don't use them for anything productive but just to give constructive feedback to developers -- `shutdown` might result in reboots instead or board doesn't really power off (cut power physically) diff --git a/docs/known_issues/sun7i.md b/docs/known_issues/sun7i.md deleted file mode 100644 index 26dbcb61..00000000 --- a/docs/known_issues/sun7i.md +++ /dev/null @@ -1,11 +0,0 @@ -**Mainline kernel** (`current`/`edge` branches) - -- No hardware accelerated video decoding -- [Different GPIO numbering](https://linux-sunxi.org/GPIO) compared to old legacy 3.x kernel -- `schedutil` CPU governor may cause clicks and pops on audio output - change to `ondemand` to work around this issue - -**Board: Lamobo R1 ** - -- b53 switch driver in mainline kernel uses DSA interface for configuration instead of `swconfig` tool. Please check [this](https://github.com/igorpecovnik/lib/issues/511) issue for details -- underpower issues are possible when using hard drive, HDMI and wireless together. Connecting a battery may help -- Gigabit Ethernet transfer rate is around 300Mbit diff --git a/docs/known_issues/sun8i.md b/docs/known_issues/sun8i.md deleted file mode 100644 index 47dc5c89..00000000 --- a/docs/known_issues/sun8i.md +++ /dev/null @@ -1,9 +0,0 @@ -**Mainline kernel images (all boards) ** (`current`/`edge` branches) - -- No hardware accelerated video decoding -- TV Out is not supported on any H2+/H3board - -**Board: Orange Pi Zero and NanoPi Duo ** - -- Onboard wireless module (XR819) has poor software support so wireless connection issues are expected -- Orange Pi Zero rev 1.4 reports [false high CPU temperatures](https://forum.armbian.com/topic/4313-new-opi-zero-yet-another-high-temperature-issue). diff --git a/docs/known_issues/udoo.md b/docs/known_issues/udoo.md deleted file mode 100644 index e069cc7f..00000000 --- a/docs/known_issues/udoo.md +++ /dev/null @@ -1 +0,0 @@ -- Gigabit ethernet transfer rate is around 50% of its theoretical max rate (internal chip bus limitation) \ No newline at end of file diff --git a/docs/webpage/download-deprecated.md b/docs/webpage/download-deprecated.md deleted file mode 100644 index ad40cbd0..00000000 --- a/docs/webpage/download-deprecated.md +++ /dev/null @@ -1,13 +0,0 @@ -Reasons for moving devices to this section: - -- no active software development (mainline u-boot and kernel) -- no support from vendor (hardware samples, documentation, software packages) -- never was sold, only samples in small quantities were available -- hardware design flaws don't allow using these devices without stability issues - -Support status: - -- images are stable but we don't test updating, -- images are provided with no support, -- most images has frozen kernel and u-boot packages to prevent their upgrades. - diff --git a/docs/webpage/download-stable.md b/docs/webpage/download-stable.md deleted file mode 100644 index 570802c7..00000000 --- a/docs/webpage/download-stable.md +++ /dev/null @@ -1,3 +0,0 @@ -Stable images were tested and they must work apart from known issues and features that were not implemented. Support is provided as far as possible (in general there is no support for 3rd party hardware like DVB tuners and software like Kodi). Please check the documentation and existing forum posts before posting a question. - -# If you don't find your board, check other download sections: [Work in progress](https://www.armbian.com/work-in-progress/) and [Deprecated](https://www.armbian.com/deprecated/). # \ No newline at end of file diff --git a/docs/webpage/download-wip.md b/docs/webpage/download-wip.md deleted file mode 100644 index 53cbd988..00000000 --- a/docs/webpage/download-wip.md +++ /dev/null @@ -1,2 +0,0 @@ -These are the boards we're currently working on but they are not ready! -Images here are provided only for developers and experienced users. diff --git a/mkdocs.yml b/mkdocs.yml index 7a339631..398c2e15 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,8 +1,9 @@ site_name: Armbian Documentation site_author: "Armbian team" - -copyright: Copyright © 2015 - 2024 Armbian team +site_url: https://docs.armbian.com +site_description: Official documentation for Armbian OS and Armbian build framework +copyright: Copyright © 2013 - 2024 Armbian.com repo_url: https://github.com/armbian/documentation repo_name: armbian/documentation @@ -38,6 +39,8 @@ extra: social: - icon: fontawesome/brands/github link: https://github.com/armbian + - icon: fontawesome/solid/house + link: https://www.armbian.com/ - icon: fontawesome/brands/twitter link: https://twitter.com/armbian @@ -60,24 +63,41 @@ markdown_extensions: linenums: true use_pygments: true - pymdownx.superfences + - markdown.extensions.admonition # Highlighted warning/info blocks + - markdown.extensions.attr_list # Set custom HTML attributes {: } + - markdown.extensions.footnotes # Footnotes [^1] + - markdown.extensions.meta # Define meta data (page title and description) at the top of the Markdown document + - markdown.extensions.smarty # Automatically convert dashes, underscore, three-dots and quotes to text symbols + - markdown.extensions.tables # Tables + - markdown.extensions.toc: # Add HTML id attribute to headers + permalink: true # Headers are links to themselves + - pymdownx.betterem: # More intuitive emphasis handling + smart_enable: all # Even smarter for both (asterisk and underscore) syntax => GitHub-like + - pymdownx.details # Collapsible details blocks - pymdownx.emoji: emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:material.extensions.emoji.to_svg nav: - - Home: index.md - - 'Board' : - - 'Maintainers_Procedures_and_Guidelines' : 'Board_Maintainers_Procedures_and_Guidelines.md' - - - 'Community' : - - 'Governance' : 'Community_Governance.md' - - 'IRC' : 'Community_IRC.md' - - 'Torrent' : 'Community_Torrent.md' - - - 'Developer Guide' : + + - 'ARMBIAN OS': + - 'Overview': 'index.md' + - 'Quick facts' : 'Quick_facts.md' + - 'Getting Started' : 'User-Guide_Getting-Started.md' + - 'Armbian Config' : 'User-Guide_Armbian-Config.md' + - 'Networking' : 'User-Guide_Networking.md' + - 'Fine Tuning' : 'User-Guide_Fine-Tuning.md' + - 'Basic Troubleshooting' : 'User-Guide_Basic-Troubleshooting.md' + - 'Recovery' : 'User-Guide_Recovery.md' + - 'Advanced Features' : 'User-Guide_Advanced-Features.md' + - 'Device tree overlays' : 'User-Guide_Armbian_overlays.md' + - 'FAQ' : 'User-Guide_FAQ.md' + + - 'ARMBIAN BUILD FRAMEWORK' : - 'User Configurations' : 'Developer-Guide_User-Configurations.md' - 'Extensions Hooks' : 'Developer-Guide_Extensions-Hooks.md' - 'Welcome' : 'Developer-Guide_Welcome.md' + - 'Board Maintainers' : 'Release_Board-Maintainers.md' - 'Build Process' : 'Developer-Guide_Build-Process.md' - 'Building with Multipass' : 'Developer-Guide_Building-with-Multipass.md' - 'Build Options' : 'Developer-Guide_Build-Options.md' @@ -86,49 +106,22 @@ nav: - 'Extensions' : 'Developer-Guide_Extensions.md' - 'Testing Procedures' : 'Developer-Guide_Testing-Procedures.md' - 'Build Preparation' : 'Developer-Guide_Build-Preparation.md' - - - 'Development Code' : - - 'Review_Procedures_and_Guidelines' : 'Development-Code_Review_Procedures_and_Guidelines.md' - - - 'Hardware' : - - 'Marvell' : 'Hardware_Marvell.md' - - 'Allwinner A20' : 'Hardware_Allwinner-A20.md' - - 'Rockchip' : 'Hardware_Rockchip.md' - - 'Allwinner H5 A64' : 'Hardware_Allwinner-H5-A64.md' - - 'Allwinner' : 'Hardware_Allwinner.md' - - 'Allwinner H3' : 'Hardware_Allwinner-H3.md' - - 'Allwinner H6' : 'Hardware_Allwinner-H6.md' - - 'Freescale imx6' : 'Hardware_Freescale-imx6.md' - - - 'Process' : - - 'Documentation' : 'Process_Documentation.md' + + - 'DEVELOPMENT' : - 'Contribute' : 'Process_Contribute.md' - - 'CI' : 'Process_CI.md' - 'Managing_Workflow' : 'Process_Managing_Workflow.md' - 'Armbian Task Tracking' : 'Process_Armbian-Task-Tracking.md' - 'Merge Policy' : 'Process_Merge-Policy.md' + - 'Board Support Rules' : 'User-Guide_Board-Support-Rules.md' + - 'Maintainers_Procedures_and_Guidelines' : 'Board_Maintainers_Procedures_and_Guidelines.md' + - 'CI' : 'Process_CI.md' + - 'Review_Procedures_and_Guidelines' : 'Development-Code_Review_Procedures_and_Guidelines.md' + + - 'OS RELEASES' : + - 'Release Model' : 'Process_Release-Model.md' - - - 'Quick' : - - 'facts' : 'Quick_facts.md' - - - 'Release' : - 'Changelog' : 'Release_Changelog.md' - - 'Board Maintainers' : 'Release_Board-Maintainers.md' - - - 'User Guide' : - - 'FAQ' : 'User-Guide_FAQ.md' - - 'Getting Started' : 'User-Guide_Getting-Started.md' - - 'Recovery' : 'User-Guide_Recovery.md' - - 'Allwinner_overlays' : 'User-Guide_Allwinner_overlays.md' - - 'Armbian Config' : 'User-Guide_Armbian-Config.md' - - 'Basic Troubleshooting' : 'User-Guide_Basic-Troubleshooting.md' - - 'Getting Started Download Page' : 'User-Guide_Getting-Started-Download-Page.md' - - 'Migration_from_Bananian' : 'User-Guide_Migration_from_Bananian.md' - - 'Fine Tuning' : 'User-Guide_Fine-Tuning.md' - - 'Board Support Rules' : 'User-Guide_Board-Support-Rules.md' - - 'Advanced Features' : 'User-Guide_Advanced-Features.md' - - 'Networking' : 'User-Guide_Networking.md' - - 'Armbian_overlays' : 'User-Guide_Armbian_overlays.md' - + - 'COMMUNITY' : + - 'IRC' : 'Community_IRC.md' + - 'Torrent' : 'Community_Torrent.md' diff --git a/overrides/main.html b/overrides/main.html index 9210284d..1aeea62d 100644 --- a/overrides/main.html +++ b/overrides/main.html @@ -2,10 +2,10 @@ {% block announce %} - + Armbian needs your help! + {% include ".icons/fontawesome/solid/heart.svg" %} +   Become a sponsor to Armbian! {% endblock %}