From df033b28de6b9fe0724499d88b2c1db3eac2b44f Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Tue, 5 Apr 2022 10:58:04 -0400 Subject: [PATCH] doc: create new Hardware Support section Add new hardware section and move all related content from old structure. Signed-off-by: Anas Nashif --- doc/guides/index.rst | 1 - doc/{guides => hardware}/arch/arc-support-status.rst | 0 doc/{guides => hardware}/arch/arm_cortex_m.rst | 0 doc/{guides => hardware}/arch/index.rst | 0 doc/{guides => hardware}/arch/x86.rst | 0 doc/hardware/index.rst | 10 ++++++++++ doc/{reference => hardware}/peripherals/adc.rst | 0 .../peripherals}/audio/codec.rst | 0 doc/{reference => hardware/peripherals}/audio/dmic.rst | 0 doc/{reference => hardware/peripherals}/audio/i2s.rst | 0 .../peripherals}/audio/index.rst | 0 .../peripherals/clock_control.rst | 0 doc/{reference => hardware}/peripherals/counter.rst | 0 doc/{reference => hardware}/peripherals/dac.rst | 0 .../peripherals}/display/index.rst | 0 doc/{reference => hardware}/peripherals/dma.rst | 0 .../peripherals/ec_host_cmd_periph.rst | 0 doc/{reference => hardware/peripherals}/edac/index.rst | 0 doc/{reference => hardware}/peripherals/eeprom.rst | 0 doc/{reference => hardware}/peripherals/entropy.rst | 0 doc/{reference => hardware}/peripherals/espi.rst | 0 doc/{reference => hardware}/peripherals/flash.rst | 0 doc/{reference => hardware}/peripherals/gna.rst | 0 doc/{reference => hardware}/peripherals/gpio.rst | 0 doc/{reference => hardware}/peripherals/hwinfo.rst | 0 doc/{reference => hardware}/peripherals/i2c.rst | 0 .../peripherals/i2c_eeprom_slave.rst | 0 doc/{reference => hardware}/peripherals/index.rst | 3 +++ doc/{reference => hardware}/peripherals/ipm.rst | 0 doc/{reference => hardware}/peripherals/kscan.rst | 0 doc/{reference => hardware}/peripherals/led.rst | 0 doc/{reference => hardware}/peripherals/mbox.rst | 0 doc/{reference => hardware}/peripherals/mdio.rst | 0 doc/{reference => hardware}/peripherals/peci.rst | 0 doc/{reference => hardware}/peripherals/pinmux.rst | 0 doc/{reference => hardware}/peripherals/ps2.rst | 0 doc/{reference => hardware}/peripherals/pwm.rst | 0 doc/{reference => hardware}/peripherals/regulators.rst | 0 doc/{reference => hardware}/peripherals/reset.rst | 0 doc/{reference => hardware}/peripherals/rtc.rst | 0 doc/{reference => hardware}/peripherals/sensor.rst | 0 doc/{reference => hardware}/peripherals/spi.rst | 0 doc/{reference => hardware}/peripherals/tcpc.rst | 0 doc/{reference => hardware}/peripherals/uart.rst | 0 doc/{reference => hardware}/peripherals/video.rst | 0 doc/{reference => hardware}/peripherals/watchdog.rst | 0 doc/index-tex.rst | 1 + doc/index.rst | 1 + doc/reference/index.rst | 9 +-------- 49 files changed, 16 insertions(+), 9 deletions(-) rename doc/{guides => hardware}/arch/arc-support-status.rst (100%) rename doc/{guides => hardware}/arch/arm_cortex_m.rst (100%) rename doc/{guides => hardware}/arch/index.rst (100%) rename doc/{guides => hardware}/arch/x86.rst (100%) create mode 100644 doc/hardware/index.rst rename doc/{reference => hardware}/peripherals/adc.rst (100%) rename doc/{reference => hardware/peripherals}/audio/codec.rst (100%) rename doc/{reference => hardware/peripherals}/audio/dmic.rst (100%) rename doc/{reference => hardware/peripherals}/audio/i2s.rst (100%) rename doc/{reference => hardware/peripherals}/audio/index.rst (100%) rename doc/{reference => hardware}/peripherals/clock_control.rst (100%) rename doc/{reference => hardware}/peripherals/counter.rst (100%) rename doc/{reference => hardware}/peripherals/dac.rst (100%) rename doc/{reference => hardware/peripherals}/display/index.rst (100%) rename doc/{reference => hardware}/peripherals/dma.rst (100%) rename doc/{reference => hardware}/peripherals/ec_host_cmd_periph.rst (100%) rename doc/{reference => hardware/peripherals}/edac/index.rst (100%) rename doc/{reference => hardware}/peripherals/eeprom.rst (100%) rename doc/{reference => hardware}/peripherals/entropy.rst (100%) rename doc/{reference => hardware}/peripherals/espi.rst (100%) rename doc/{reference => hardware}/peripherals/flash.rst (100%) rename doc/{reference => hardware}/peripherals/gna.rst (100%) rename doc/{reference => hardware}/peripherals/gpio.rst (100%) rename doc/{reference => hardware}/peripherals/hwinfo.rst (100%) rename doc/{reference => hardware}/peripherals/i2c.rst (100%) rename doc/{reference => hardware}/peripherals/i2c_eeprom_slave.rst (100%) rename doc/{reference => hardware}/peripherals/index.rst (90%) rename doc/{reference => hardware}/peripherals/ipm.rst (100%) rename doc/{reference => hardware}/peripherals/kscan.rst (100%) rename doc/{reference => hardware}/peripherals/led.rst (100%) rename doc/{reference => hardware}/peripherals/mbox.rst (100%) rename doc/{reference => hardware}/peripherals/mdio.rst (100%) rename doc/{reference => hardware}/peripherals/peci.rst (100%) rename doc/{reference => hardware}/peripherals/pinmux.rst (100%) rename doc/{reference => hardware}/peripherals/ps2.rst (100%) rename doc/{reference => hardware}/peripherals/pwm.rst (100%) rename doc/{reference => hardware}/peripherals/regulators.rst (100%) rename doc/{reference => hardware}/peripherals/reset.rst (100%) rename doc/{reference => hardware}/peripherals/rtc.rst (100%) rename doc/{reference => hardware}/peripherals/sensor.rst (100%) rename doc/{reference => hardware}/peripherals/spi.rst (100%) rename doc/{reference => hardware}/peripherals/tcpc.rst (100%) rename doc/{reference => hardware}/peripherals/uart.rst (100%) rename doc/{reference => hardware}/peripherals/video.rst (100%) rename doc/{reference => hardware}/peripherals/watchdog.rst (100%) diff --git a/doc/guides/index.rst b/doc/guides/index.rst index 81ca9fd0c5f..34104dcb011 100644 --- a/doc/guides/index.rst +++ b/doc/guides/index.rst @@ -6,7 +6,6 @@ User and Developer Guides .. toctree:: :maxdepth: 1 - arch/index.rst coccinelle.rst code-relocation.rst flash_debug/index diff --git a/doc/guides/arch/arc-support-status.rst b/doc/hardware/arch/arc-support-status.rst similarity index 100% rename from doc/guides/arch/arc-support-status.rst rename to doc/hardware/arch/arc-support-status.rst diff --git a/doc/guides/arch/arm_cortex_m.rst b/doc/hardware/arch/arm_cortex_m.rst similarity index 100% rename from doc/guides/arch/arm_cortex_m.rst rename to doc/hardware/arch/arm_cortex_m.rst diff --git a/doc/guides/arch/index.rst b/doc/hardware/arch/index.rst similarity index 100% rename from doc/guides/arch/index.rst rename to doc/hardware/arch/index.rst diff --git a/doc/guides/arch/x86.rst b/doc/hardware/arch/x86.rst similarity index 100% rename from doc/guides/arch/x86.rst rename to doc/hardware/arch/x86.rst diff --git a/doc/hardware/index.rst b/doc/hardware/index.rst new file mode 100644 index 00000000000..fa5bc49a496 --- /dev/null +++ b/doc/hardware/index.rst @@ -0,0 +1,10 @@ +.. _hardware_support: + +Hardware Support +################ + +.. toctree:: + :maxdepth: 1 + + arch/index.rst + peripherals/index.rst diff --git a/doc/reference/peripherals/adc.rst b/doc/hardware/peripherals/adc.rst similarity index 100% rename from doc/reference/peripherals/adc.rst rename to doc/hardware/peripherals/adc.rst diff --git a/doc/reference/audio/codec.rst b/doc/hardware/peripherals/audio/codec.rst similarity index 100% rename from doc/reference/audio/codec.rst rename to doc/hardware/peripherals/audio/codec.rst diff --git a/doc/reference/audio/dmic.rst b/doc/hardware/peripherals/audio/dmic.rst similarity index 100% rename from doc/reference/audio/dmic.rst rename to doc/hardware/peripherals/audio/dmic.rst diff --git a/doc/reference/audio/i2s.rst b/doc/hardware/peripherals/audio/i2s.rst similarity index 100% rename from doc/reference/audio/i2s.rst rename to doc/hardware/peripherals/audio/i2s.rst diff --git a/doc/reference/audio/index.rst b/doc/hardware/peripherals/audio/index.rst similarity index 100% rename from doc/reference/audio/index.rst rename to doc/hardware/peripherals/audio/index.rst diff --git a/doc/reference/peripherals/clock_control.rst b/doc/hardware/peripherals/clock_control.rst similarity index 100% rename from doc/reference/peripherals/clock_control.rst rename to doc/hardware/peripherals/clock_control.rst diff --git a/doc/reference/peripherals/counter.rst b/doc/hardware/peripherals/counter.rst similarity index 100% rename from doc/reference/peripherals/counter.rst rename to doc/hardware/peripherals/counter.rst diff --git a/doc/reference/peripherals/dac.rst b/doc/hardware/peripherals/dac.rst similarity index 100% rename from doc/reference/peripherals/dac.rst rename to doc/hardware/peripherals/dac.rst diff --git a/doc/reference/display/index.rst b/doc/hardware/peripherals/display/index.rst similarity index 100% rename from doc/reference/display/index.rst rename to doc/hardware/peripherals/display/index.rst diff --git a/doc/reference/peripherals/dma.rst b/doc/hardware/peripherals/dma.rst similarity index 100% rename from doc/reference/peripherals/dma.rst rename to doc/hardware/peripherals/dma.rst diff --git a/doc/reference/peripherals/ec_host_cmd_periph.rst b/doc/hardware/peripherals/ec_host_cmd_periph.rst similarity index 100% rename from doc/reference/peripherals/ec_host_cmd_periph.rst rename to doc/hardware/peripherals/ec_host_cmd_periph.rst diff --git a/doc/reference/edac/index.rst b/doc/hardware/peripherals/edac/index.rst similarity index 100% rename from doc/reference/edac/index.rst rename to doc/hardware/peripherals/edac/index.rst diff --git a/doc/reference/peripherals/eeprom.rst b/doc/hardware/peripherals/eeprom.rst similarity index 100% rename from doc/reference/peripherals/eeprom.rst rename to doc/hardware/peripherals/eeprom.rst diff --git a/doc/reference/peripherals/entropy.rst b/doc/hardware/peripherals/entropy.rst similarity index 100% rename from doc/reference/peripherals/entropy.rst rename to doc/hardware/peripherals/entropy.rst diff --git a/doc/reference/peripherals/espi.rst b/doc/hardware/peripherals/espi.rst similarity index 100% rename from doc/reference/peripherals/espi.rst rename to doc/hardware/peripherals/espi.rst diff --git a/doc/reference/peripherals/flash.rst b/doc/hardware/peripherals/flash.rst similarity index 100% rename from doc/reference/peripherals/flash.rst rename to doc/hardware/peripherals/flash.rst diff --git a/doc/reference/peripherals/gna.rst b/doc/hardware/peripherals/gna.rst similarity index 100% rename from doc/reference/peripherals/gna.rst rename to doc/hardware/peripherals/gna.rst diff --git a/doc/reference/peripherals/gpio.rst b/doc/hardware/peripherals/gpio.rst similarity index 100% rename from doc/reference/peripherals/gpio.rst rename to doc/hardware/peripherals/gpio.rst diff --git a/doc/reference/peripherals/hwinfo.rst b/doc/hardware/peripherals/hwinfo.rst similarity index 100% rename from doc/reference/peripherals/hwinfo.rst rename to doc/hardware/peripherals/hwinfo.rst diff --git a/doc/reference/peripherals/i2c.rst b/doc/hardware/peripherals/i2c.rst similarity index 100% rename from doc/reference/peripherals/i2c.rst rename to doc/hardware/peripherals/i2c.rst diff --git a/doc/reference/peripherals/i2c_eeprom_slave.rst b/doc/hardware/peripherals/i2c_eeprom_slave.rst similarity index 100% rename from doc/reference/peripherals/i2c_eeprom_slave.rst rename to doc/hardware/peripherals/i2c_eeprom_slave.rst diff --git a/doc/reference/peripherals/index.rst b/doc/hardware/peripherals/index.rst similarity index 90% rename from doc/reference/peripherals/index.rst rename to doc/hardware/peripherals/index.rst index db9d81061ab..3b85f7ca040 100644 --- a/doc/reference/peripherals/index.rst +++ b/doc/hardware/peripherals/index.rst @@ -7,11 +7,14 @@ Peripherals :maxdepth: 1 adc.rst + audio/index.rst counter.rst clock_control.rst dac.rst + display/index.rst dma.rst ec_host_cmd_periph.rst + edac/index.rst eeprom.rst entropy.rst flash.rst diff --git a/doc/reference/peripherals/ipm.rst b/doc/hardware/peripherals/ipm.rst similarity index 100% rename from doc/reference/peripherals/ipm.rst rename to doc/hardware/peripherals/ipm.rst diff --git a/doc/reference/peripherals/kscan.rst b/doc/hardware/peripherals/kscan.rst similarity index 100% rename from doc/reference/peripherals/kscan.rst rename to doc/hardware/peripherals/kscan.rst diff --git a/doc/reference/peripherals/led.rst b/doc/hardware/peripherals/led.rst similarity index 100% rename from doc/reference/peripherals/led.rst rename to doc/hardware/peripherals/led.rst diff --git a/doc/reference/peripherals/mbox.rst b/doc/hardware/peripherals/mbox.rst similarity index 100% rename from doc/reference/peripherals/mbox.rst rename to doc/hardware/peripherals/mbox.rst diff --git a/doc/reference/peripherals/mdio.rst b/doc/hardware/peripherals/mdio.rst similarity index 100% rename from doc/reference/peripherals/mdio.rst rename to doc/hardware/peripherals/mdio.rst diff --git a/doc/reference/peripherals/peci.rst b/doc/hardware/peripherals/peci.rst similarity index 100% rename from doc/reference/peripherals/peci.rst rename to doc/hardware/peripherals/peci.rst diff --git a/doc/reference/peripherals/pinmux.rst b/doc/hardware/peripherals/pinmux.rst similarity index 100% rename from doc/reference/peripherals/pinmux.rst rename to doc/hardware/peripherals/pinmux.rst diff --git a/doc/reference/peripherals/ps2.rst b/doc/hardware/peripherals/ps2.rst similarity index 100% rename from doc/reference/peripherals/ps2.rst rename to doc/hardware/peripherals/ps2.rst diff --git a/doc/reference/peripherals/pwm.rst b/doc/hardware/peripherals/pwm.rst similarity index 100% rename from doc/reference/peripherals/pwm.rst rename to doc/hardware/peripherals/pwm.rst diff --git a/doc/reference/peripherals/regulators.rst b/doc/hardware/peripherals/regulators.rst similarity index 100% rename from doc/reference/peripherals/regulators.rst rename to doc/hardware/peripherals/regulators.rst diff --git a/doc/reference/peripherals/reset.rst b/doc/hardware/peripherals/reset.rst similarity index 100% rename from doc/reference/peripherals/reset.rst rename to doc/hardware/peripherals/reset.rst diff --git a/doc/reference/peripherals/rtc.rst b/doc/hardware/peripherals/rtc.rst similarity index 100% rename from doc/reference/peripherals/rtc.rst rename to doc/hardware/peripherals/rtc.rst diff --git a/doc/reference/peripherals/sensor.rst b/doc/hardware/peripherals/sensor.rst similarity index 100% rename from doc/reference/peripherals/sensor.rst rename to doc/hardware/peripherals/sensor.rst diff --git a/doc/reference/peripherals/spi.rst b/doc/hardware/peripherals/spi.rst similarity index 100% rename from doc/reference/peripherals/spi.rst rename to doc/hardware/peripherals/spi.rst diff --git a/doc/reference/peripherals/tcpc.rst b/doc/hardware/peripherals/tcpc.rst similarity index 100% rename from doc/reference/peripherals/tcpc.rst rename to doc/hardware/peripherals/tcpc.rst diff --git a/doc/reference/peripherals/uart.rst b/doc/hardware/peripherals/uart.rst similarity index 100% rename from doc/reference/peripherals/uart.rst rename to doc/hardware/peripherals/uart.rst diff --git a/doc/reference/peripherals/video.rst b/doc/hardware/peripherals/video.rst similarity index 100% rename from doc/reference/peripherals/video.rst rename to doc/hardware/peripherals/video.rst diff --git a/doc/reference/peripherals/watchdog.rst b/doc/hardware/peripherals/watchdog.rst similarity index 100% rename from doc/reference/peripherals/watchdog.rst rename to doc/hardware/peripherals/watchdog.rst diff --git a/doc/index-tex.rst b/doc/index-tex.rst index cb4325243be..5bfda356af0 100644 --- a/doc/index-tex.rst +++ b/doc/index-tex.rst @@ -21,6 +21,7 @@ Zephyr Project Documentation services/index.rst reference/index.rst guides/index.rst + hardware/index.rst security/index.rst contribute/index.rst project/index.rst diff --git a/doc/index.rst b/doc/index.rst index 7cc59f514ca..a34be483684 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -109,6 +109,7 @@ Sections services/index.rst reference/index.rst guides/index.rst + hardware/index.rst security/index.rst contribute/index.rst project/index.rst diff --git a/doc/reference/index.rst b/doc/reference/index.rst index af37c5c954e..2a307ce867e 100644 --- a/doc/reference/index.rst +++ b/doc/reference/index.rst @@ -8,17 +8,10 @@ API Reference :maxdepth: 2 api/index.rst - audio/index.rst canbus/index.rst - display/index.rst - edac/index.rst - iterable_sections/index.rst - libc/index.rst misc/index modbus/index.rst - peripherals/index.rst + pinctrl/index.rst - storage/index.rst - task_wdt/index.rst usb/index.rst virtualization/index.rst