..
   Copyright (c) 2023 OpenHW Group

   Licensed under the Solderpad Hardware Licence, Version 2.1 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

   https://solderpad.org/licenses/SHL-2.1/

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

   SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1

======================
CORE-V-MCU User Manual
======================

..  toctree::
    :caption: CORE-V-MCU Introduction:
    :maxdepth: 1

    doc-src/overview.rst
    doc-src/terminology.rst
    doc-src/open-source-development-at-openhw.rst
    doc-src/high_level_architecture.rst
    doc-src/device_characteristics.rst
    doc-src/package_information.rst
    doc-src/integration.rst
    doc-src/io_assignment_tables.rst
    doc-src/startup.rst
    doc-src/mmap.rst
    doc-src/interrupts.rst
    doc-src/clock_domains.rst
    doc-src/debug_approach.rst
    doc-src/evaluation_kits.rst
    doc-src/software_support.rst


..  toctree::
    :caption: CORE-V-MCU Bus Interconnect:
    :maxdepth: 1
    :glob:

    doc-src/tcdm_interconnect.rst
    doc-src/apb_peripheral_interconnect.rst


..  toctree::
    :caption: CORE-V-MCU Subsystems:
    :maxdepth: 1
    :glob:

    doc-src/core_complex_subsystem.rst
    doc-src/udma_subsystem.rst
    doc-src/efpga_subsystem.rst


..  toctree::
    :caption: CORE-V-MCU IP Blocks:
    :maxdepth: 1
    :glob:

    doc-src/ip-blocks/apb_adv_timer.rst
    doc-src/ip-blocks/apb_soc_ctrl.rst
    doc-src/ip-blocks/apb_fll_if.rst
    doc-src/ip-blocks/apb_gpio.rst
    doc-src/ip-blocks/apb_timer.rst
    doc-src/ip-blocks/apb_i2cs.rst
    doc-src/ip-blocks/apb_event_cntrl.rst
    doc-src/ip-blocks/udma_cam.rst
    doc-src/ip-blocks/udma_i2cm.rst
    doc-src/ip-blocks/udma_sdio.rst
    doc-src/ip-blocks/udma_qspim.rst
    doc-src/ip-blocks/udma_uart.rst