board: amlogic: move boards doc into doc/board/amlogic
v2 cover board: amlogic: move boards doc into doc/board/amlogic
As asked by Tom, this moves all the Amlogic board documentation into doc/board/amlogic into RsT and proper index with feature matrix.
Changes since v1:
- added SPDX-License-Identifier to rst files
Neil Armstrong (2):
board: amlogic: move boards doc into doc/board/amlogic
board: amlogic: add board doc files to MAINTAINERS
MAINTAINERS | 1 + board/amlogic/p200/MAINTAINERS | 3 + board/amlogic/p201/MAINTAINERS | 1 + board/amlogic/p212/MAINTAINERS | 4 + board/amlogic/q200/MAINTAINERS | 1 + board/amlogic/s400/MAINTAINERS | 1 + board/amlogic/sei510/MAINTAINERS | 1 + board/amlogic/sei610/MAINTAINERS | 1 + board/amlogic/u200/MAINTAINERS | 1 + board/amlogic/w400/MAINTAINERS | 4 + doc/board/amlogic/index.rst | 95 +++++++++ .../board/amlogic/khadas-vim.rst | 140 ++++++------- .../board/amlogic/khadas-vim2.rst | 138 ++++++------- .../board/amlogic/khadas-vim3.rst | 191 ++++++++--------- .../board/amlogic/khadas-vim3l.rst | 191 +++++++++-------- .../board/amlogic/libretech-ac.rst | 144 +++++++------ .../board/amlogic/libretech-cc.rst | 141 ++++++------- .../board/amlogic/nanopi-k2.rst | 138 +++++++------ .../board/amlogic/odroid-c2.rst | 52 +++-- .../board/amlogic/odroid-n2.rst | 189 ++++++++--------- .../README.p200 => doc/board/amlogic/p200.rst | 138 ++++++------- .../README.p201 => doc/board/amlogic/p201.rst | 138 ++++++------- .../README.p212 => doc/board/amlogic/p212.rst | 138 ++++++------- .../README.q200 => doc/board/amlogic/q200.rst | 138 ++++++------- .../s400/README => doc/board/amlogic/s400.rst | 152 +++++++------- .../README => doc/board/amlogic/sei510.rst | 192 ++++++++--------- .../README => doc/board/amlogic/sei610.rst | 187 +++++++++-------- .../u200/README => doc/board/amlogic/u200.rst | 190 +++++++++-------- .../README.w400 => doc/board/amlogic/w400.rst | 194 +++++++++--------- doc/board/index.rst | 1 + 30 files changed, 1536 insertions(+), 1369 deletions(-) create mode 100644 doc/board/amlogic/index.rst rename board/amlogic/p212/README.khadas-vim => doc/board/amlogic/khadas-vim.rst (24%) rename board/amlogic/q200/README.khadas-vim2 => doc/board/amlogic/khadas-vim2.rst (26%) rename board/amlogic/w400/README.khadas-vim3 => doc/board/amlogic/khadas-vim3.rst (19%) rename board/amlogic/w400/README.khadas-vim3l => doc/board/amlogic/khadas-vim3l.rst (19%) rename board/amlogic/p212/README.libretech-ac => doc/board/amlogic/libretech-ac.rst (21%) rename board/amlogic/p212/README.libretech-cc => doc/board/amlogic/libretech-cc.rst (46%) rename board/amlogic/p200/README.nanopi-k2 => doc/board/amlogic/nanopi-k2.rst (24%) rename board/amlogic/p200/README.odroid-c2 => doc/board/amlogic/odroid-c2.rst (56%) rename board/amlogic/w400/README.odroid-n2 => doc/board/amlogic/odroid-n2.rst (19%) rename board/amlogic/p200/README.p200 => doc/board/amlogic/p200.rst (23%) rename board/amlogic/p201/README.p201 => doc/board/amlogic/p201.rst (23%) rename board/amlogic/p212/README.p212 => doc/board/amlogic/p212.rst (23%) rename board/amlogic/q200/README.q200 => doc/board/amlogic/q200.rst (24%) rename board/amlogic/s400/README => doc/board/amlogic/s400.rst (21%) rename board/amlogic/sei510/README => doc/board/amlogic/sei510.rst (14%) rename board/amlogic/sei610/README => doc/board/amlogic/sei610.rst (16%) rename board/amlogic/u200/README => doc/board/amlogic/u200.rst (17%) rename board/amlogic/w400/README.w400 => doc/board/amlogic/w400.rst (17%)
Signature · 1 line
2.22.0
PATCH v2 1/2 board: amlogic: move boards doc into doc/board/amlogic
Move the natural text Amlogic board README files to doc/board/amlogic into reStructuredText and :
- add reStructuredText markup for bash code
- fix secondary titles markup
- move board support into global support matrix
--- doc/board/amlogic/index.rst | 95 +++++++++ .../board/amlogic/khadas-vim.rst | 140 ++++++------- .../board/amlogic/khadas-vim2.rst | 138 ++++++------- .../board/amlogic/khadas-vim3.rst | 191 ++++++++--------- .../board/amlogic/khadas-vim3l.rst | 191 +++++++++-------- .../board/amlogic/libretech-ac.rst | 144 +++++++------ .../board/amlogic/libretech-cc.rst | 141 ++++++------- .../board/amlogic/nanopi-k2.rst | 138 +++++++------ .../board/amlogic/odroid-c2.rst | 52 +++-- .../board/amlogic/odroid-n2.rst | 189 ++++++++--------- .../README.p200 => doc/board/amlogic/p200.rst | 138 ++++++------- .../README.p201 => doc/board/amlogic/p201.rst | 138 ++++++------- .../README.p212 => doc/board/amlogic/p212.rst | 138 ++++++------- .../README.q200 => doc/board/amlogic/q200.rst | 138 ++++++------- .../s400/README => doc/board/amlogic/s400.rst | 152 +++++++------- .../README => doc/board/amlogic/sei510.rst | 192 ++++++++--------- .../README => doc/board/amlogic/sei610.rst | 187 +++++++++-------- .../u200/README => doc/board/amlogic/u200.rst | 190 +++++++++-------- .../README.w400 => doc/board/amlogic/w400.rst | 194 +++++++++--------- doc/board/index.rst | 1 + 20 files changed, 1518 insertions(+), 1369 deletions(-) create mode 100644 doc/board/amlogic/index.rst rename board/amlogic/p212/README.khadas-vim => doc/board/amlogic/khadas-vim.rst (24%) rename board/amlogic/q200/README.khadas-vim2 => doc/board/amlogic/khadas-vim2.rst (26%) rename board/amlogic/w400/README.khadas-vim3 => doc/board/amlogic/khadas-vim3.rst (19%) rename board/amlogic/w400/README.khadas-vim3l => doc/board/amlogic/khadas-vim3l.rst (19%) rename board/amlogic/p212/README.libretech-ac => doc/board/amlogic/libretech-ac.rst (21%) rename board/amlogic/p212/README.libretech-cc => doc/board/amlogic/libretech-cc.rst (46%) rename board/amlogic/p200/README.nanopi-k2 => doc/board/amlogic/nanopi-k2.rst (24%) rename board/amlogic/p200/README.odroid-c2 => doc/board/amlogic/odroid-c2.rst (56%) rename board/amlogic/w400/README.odroid-n2 => doc/board/amlogic/odroid-n2.rst (19%) rename board/amlogic/p200/README.p200 => doc/board/amlogic/p200.rst (23%) rename board/amlogic/p201/README.p201 => doc/board/amlogic/p201.rst (23%) rename board/amlogic/p212/README.p212 => doc/board/amlogic/p212.rst (23%) rename board/amlogic/q200/README.q200 => doc/board/amlogic/q200.rst (24%) rename board/amlogic/s400/README => doc/board/amlogic/s400.rst (21%) rename board/amlogic/sei510/README => doc/board/amlogic/sei510.rst (14%) rename board/amlogic/sei610/README => doc/board/amlogic/sei610.rst (16%) rename board/amlogic/u200/README => doc/board/amlogic/u200.rst (17%) rename board/amlogic/w400/README.w400 => doc/board/amlogic/w400.rst (17%)
doc/board/amlogic/index.rst new file +95 -0
@@ -0,0 +1,95 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +Amlogic +======= + +Hardware Support Matrix +----------------------- + +An up-do-date matrix is also available on: http://linux-meson.com + +This matrix concerns the actual source code version. + ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| | S905 | S905X | S912 | A113X | S905X2 | S922X | S905X3 | +| | | S805X | S905D | | S905D2 | A311D | S905D3 | +| | | | | | S905Y2 | | | ++===============================+===========+==============+==============+============+============+=============+==============+ +| Boards | Odroid-C2 | P212 | Khadas VIM2 | S400 | U200 | Odroid-N2 | SEI610 | +| | Nanopi-K2 | Khadas-VIM | Libretech-PC | | SEI510 | Khadas-VIM3 | Khadas-VIM3L | +| | P200 | LibreTech-CC | | | | | | +| | P201 | LibreTech-AC | | | | | | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| UART | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| Pinctrl/GPIO | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| Clock Control | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| PWM | No | No | No | No | No | No | No | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| Reset Control | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| Infrared Decoder | No | No | No | No | No | No | No | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| Ethernet | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| Multi-core | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| Fuse access | **Yes** | **Yes** |**Yes** |**Yes** |**Yes** |**Yes** | **Yes** | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| SPI (FC) | **Yes** | **Yes** | **Yes** | **Yes** |**Yes** | **Yes** | No | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| SPI (CC) | No | No | No | No | No | No | No | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| I2C | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| USB | **Yes** | **Yes** | **Yes** | No | **Yes** | **Yes** | **Yes** | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| USB OTG | No | **Yes** | **Yes** | No | **Yes** | **Yes** | **Yes** | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| eMMC | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| SDCard | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| NAND | No | No | No | No | No | No | No | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| ADC | **Yes** | **Yes** | **Yes** | No | No | No | No | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| CVBS Output | **Yes** | **Yes** | **Yes** | *N/A* | **Yes** | **Yes** | **Yes** | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| HDMI Output | **Yes** | **Yes** | **Yes** | *N/A* | **Yes** | **Yes** | **Yes** | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| CEC | No | No | No | *N/A* | No | No | No | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| Thermal Sensor | No | No | No | No | No | No | No | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| LCD/LVDS Output | No | *N/A* | No | No | No | No | No | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ +| SoC (version) information | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | **Yes** | ++-------------------------------+-----------+--------------+--------------+------------+------------+-------------+--------------+ + +Board Documentation +------------------- + +.. toctree:: + :maxdepth: 1 + + khadas-vim2 + khadas-vim3l + khadas-vim3 + khadas-vim + libretech-ac + libretech-cc + nanopi-k2 + odroid-c2 + odroid-n2 + p200 + p201 + p212 + q200 + s400 + sei510 + sei610 + u200 + w400
doc/board/amlogic/khadas-vim.rst renamed from board/amlogic/p212/README.khadas-vim +70 -70
161 lines not on this page · raw message
doc/board/amlogic/khadas-vim2.rst renamed from board/amlogic/q200/README.khadas-vim2 +69 -69
158 lines not on this page · raw message
doc/board/amlogic/khadas-vim3.rst renamed from board/amlogic/w400/README.khadas-vim3 +96 -95
215 lines not on this page · raw message
doc/board/amlogic/khadas-vim3l.rst renamed from board/amlogic/w400/README.khadas-vim3l +95 -96
214 lines not on this page · raw message
doc/board/amlogic/libretech-ac.rst renamed from board/amlogic/p212/README.libretech-ac +76 -68
166 lines not on this page · raw message
doc/board/amlogic/libretech-cc.rst renamed from board/amlogic/p212/README.libretech-cc +71 -70
174 lines not on this page · raw message
doc/board/amlogic/nanopi-k2.rst renamed from board/amlogic/p200/README.nanopi-k2 +72 -66
158 lines not on this page · raw message
doc/board/amlogic/odroid-c2.rst renamed from board/amlogic/p200/README.odroid-c2 +25 -27
78 lines not on this page · raw message
doc/board/amlogic/odroid-n2.rst renamed from board/amlogic/w400/README.odroid-n2 +95 -94
213 lines not on this page · raw message
doc/board/amlogic/p200.rst renamed from board/amlogic/p200/README.p200 +69 -69
158 lines not on this page · raw message
doc/board/amlogic/p201.rst renamed from board/amlogic/p201/README.p201 +69 -69
158 lines not on this page · raw message
doc/board/amlogic/p212.rst renamed from board/amlogic/p212/README.p212 +69 -69
158 lines not on this page · raw message
doc/board/amlogic/q200.rst renamed from board/amlogic/q200/README.q200 +69 -69
158 lines not on this page · raw message
doc/board/amlogic/s400.rst renamed from board/amlogic/s400/README +76 -76
172 lines not on this page · raw message
doc/board/amlogic/sei510.rst renamed from board/amlogic/sei510/README +100 -92
215 lines not on this page · raw message
doc/board/amlogic/sei610.rst renamed from board/amlogic/sei610/README +101 -86
208 lines not on this page · raw message
doc/board/amlogic/u200.rst renamed from board/amlogic/u200/README +99 -91
141 lines not on this page · raw message
doc/board/amlogic/w400.rst renamed from board/amlogic/w400/README.w400 +101 -93
194 lines not on this page · raw message
The rest of this diff is not shown. View the raw message.
Signature · 1 line
2.22.0
Part of the diff is not shown here. View the raw message.
PATCH v2 2/2 board: amlogic: add board doc files to MAINTAINERS
In reply to Neil ArmstrongAdd the recently added reStructuredText board documentation in the appropriate MAINTAINERS files.
--- MAINTAINERS | 1 + board/amlogic/p200/MAINTAINERS | 3 +++ board/amlogic/p201/MAINTAINERS | 1 + board/amlogic/p212/MAINTAINERS | 4 ++++ board/amlogic/q200/MAINTAINERS | 1 + board/amlogic/s400/MAINTAINERS | 1 + board/amlogic/sei510/MAINTAINERS | 1 + board/amlogic/sei610/MAINTAINERS | 1 + board/amlogic/u200/MAINTAINERS | 1 + board/amlogic/w400/MAINTAINERS | 4 ++++ 10 files changed, 18 insertions(+)
MAINTAINERS +1 -0
@@ -145,6 +145,7 @@ F: drivers/power/domain/meson-gx-pwrc-vpu.c F: drivers/video/meson/ F: include/configs/meson64.h F: include/configs/meson64_android.h +F: doc/board/amlogic/ N: meson ARM BROADCOM BCM283X
board/amlogic/p200/MAINTAINERS +3 -0
@@ -7,3 +7,6 @@ F: board/amlogic/p200/ F: configs/nanopi-k2_defconfig F: configs/odroid-c2_defconfig F: configs/p200_defconfig +F: doc/board/amlogic/p200.rst +F: doc/board/amlogic/nanopi-k2.rst +F: doc/board/amlogic/odroid-c2.rst
board/amlogic/p201/MAINTAINERS +1 -0
@@ -4,3 +4,4 @@ S: Maintained L: [email protected] F: board/amlogic/p201/ F: configs/p201_defconfig +F: doc/board/amlogic/p201.rst
board/amlogic/p212/MAINTAINERS +4 -0
@@ -8,3 +8,7 @@ F: configs/khadas-vim_defconfig F: configs/libretech-ac_defconfig F: configs/libretech-cc_defconfig F: configs/p212_defconfig +F: doc/board/amlogic/p212.rst +F: doc/board/amlogic/libretech-ac.rst +F: doc/board/amlogic/libretech-cc.rst +F: doc/board/amlogic/khadas-vim.rst
board/amlogic/q200/MAINTAINERS +1 -0
@@ -7,3 +7,4 @@ F: include/configs/q200.h F: configs/khadas-vim2_defconfig F: configs/libretech-s905d-pc_defconfig F: configs/libretech-s912-pc_defconfig +F: doc/board/amlogic/khadas-vim2.rst
board/amlogic/s400/MAINTAINERS +1 -0
@@ -5,3 +5,4 @@ L: [email protected] F: board/amlogic/s400/ F: include/configs/s400.h F: configs/s400_defconfig +F: doc/board/amlogic/s400.rst
board/amlogic/sei510/MAINTAINERS +1 -0
@@ -5,3 +5,4 @@ L: [email protected] F: board/amlogic/sei510/ F: configs/sei510_defconfig F: include/configs/sei510.h +F: doc/board/amlogic/sei510.rst
board/amlogic/sei610/MAINTAINERS +1 -0
@@ -5,3 +5,4 @@ L: [email protected] F: board/amlogic/sei610/ F: configs/sei610_defconfig F: include/configs/sei610.h +F: doc/board/amlogic/sei610.rst
board/amlogic/u200/MAINTAINERS +1 -0
@@ -4,3 +4,4 @@ S: Maintained L: [email protected] F: board/amlogic/u200/ F: configs/u200_defconfig +F: doc/board/amlogic/u200.rst
board/amlogic/w400/MAINTAINERS +4 -0
@@ -6,3 +6,7 @@ F: board/amlogic/w400/ F: configs/khadas-vim3_defconfig F: configs/khadas-vim3l_defconfig F: configs/odroid-n2_defconfig +F: doc/board/amlogic/w400.rst +F: doc/board/amlogic/khadas-vim3.rst +F: doc/board/amlogic/khadas-vim3l.rst +F: doc/board/amlogic/odroid-n2.rst
Signature · 1 line
2.22.0