.. _design_soc_hbird:

HummingBird SoC
===============

HummingBird SoC is an evaluation FPGA SoC based on HummingBird RISC-V Core
for customer to evaluate HummingBird Process Core.

.. note::

    HummingBird SoC is no longer maintained now, there is a v2 version,
    please click :ref:`design_soc_hbirdv2` to learn about it.

To get the up to date documentation about this SoC, please click:

* `HummingBird SoC project source code`_

.. _design_soc_hbird_overview:

Overview
--------

To easy user to evaluate HummingBird RISC-V Processor Core, the prototype
SoC (called Hummingbird SoC) is provided for evaluation purpose.

This prototype SoC includes:

* Processor Core, it can be RISC-V Core.
* On-Chip SRAMs for instruction and data.
* The SoC buses.
* The basic peripherals, such as UART, GPIO, SPI, I2C, etc.

With this prototype SoC, user can run simulations, map it into the FPGA board,
and run with real embedded application examples.

The SoC diagram can be checked as below :ref:`figure_design_soc_hbird_1`

.. _figure_design_soc_hbird_1:

.. figure:: /asserts/images/hbird_soc_diagram.png
    :width: 80 %
    :align: center
    :alt: HummingBird SoC Diagram

    HummingBird SoC Diagram

The SoC memory map for SoC resources is as below :ref:`figure_design_soc_hbird_2`

.. _figure_design_soc_hbird_2:

.. figure:: /asserts/images/hbird_soc_memory_map.png
    :width: 80 %
    :align: center
    :alt: HummingBird SoC Memory Map

    HummingBird SoC Memory Map

If you want to learn more about this evaluation SoC, please check
`HummingBird SoC project source code`_.

.. _design_soc_hbird_boards:

Supported Boards
----------------

In HummingBird SDK, we support the following boards based on **HummingBird** SoC, see:

* :ref:`design_board_hbird_eval`

.. _design_soc_hbird_usage:

Usage
-----

If you want to use this **HummingBird** SoC in HummingBird SDK, you need to set the
:ref:`develop_buildsystem_var_soc` Makefile variable to ``hbird``.

.. code-block:: shell

    # Choose SoC to be hbird
    # the following command will build application
    # using default hbird SoC based board
    # defined in Build System and application Makefile
    make SOC=hbird all


.. _Nuclei: https://nucleisys.com/
.. _HummingBird SoC project source code: https://github.com/SI-RISCV/e200_opensource