Skip to content

Commit

Permalink
Merge pull request #308 from MikeOpenHWGroup/um_hdrs
Browse files Browse the repository at this point in the history
User Manual license headers
  • Loading branch information
MikeOpenHWGroup authored Dec 14, 2020
2 parents c45466f + cffcded commit 35d07fd
Show file tree
Hide file tree
Showing 22 changed files with 379 additions and 2 deletions.
21 changes: 20 additions & 1 deletion cores/cv32e40p/user_manual/Makefile
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
#
# Copyright (c) 2020 OpenHW Group
#
# Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
#
# 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.0
#
###############################################################################
#
# Minimal makefile for Sphinx documentation
#

Expand All @@ -16,4 +35,4 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
17 changes: 17 additions & 0 deletions cores/cv32e40p/user_manual/source/apu.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
..
Copyright (c) 2020 OpenHW Group
Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
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.0
.. _apu:

Auxiliary Processing Unit (APU)
Expand Down
18 changes: 18 additions & 0 deletions cores/cv32e40p/user_manual/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# -*- coding: utf-8 -*-
#
# Copyright (c) 2020 OpenHW Group
#
# Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
#
# 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.0
#
###############################################################################
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
Expand Down
17 changes: 17 additions & 0 deletions cores/cv32e40p/user_manual/source/control_status_registers.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
..
Copyright (c) 2020 OpenHW Group
Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
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.0
.. _cs-registers:

Control and Status Registers
Expand Down
17 changes: 17 additions & 0 deletions cores/cv32e40p/user_manual/source/core_versions.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
..
Copyright (c) 2020 OpenHW Group
Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
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.0
Core Versions and RTL Freeze Rules
==================================

Expand Down
17 changes: 17 additions & 0 deletions cores/cv32e40p/user_manual/source/corev_hw_loop.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
..
Copyright (c) 2020 OpenHW Group
Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
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.0
.. _hwloop-specs:

CORE-V Hardware Loop Extensions
Expand Down
17 changes: 17 additions & 0 deletions cores/cv32e40p/user_manual/source/debug.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
..
Copyright (c) 2020 OpenHW Group
Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
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.0
.. _debug-support:

Debug & Trigger
Expand Down
17 changes: 17 additions & 0 deletions cores/cv32e40p/user_manual/source/exceptions_interrupts.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
..
Copyright (c) 2020 OpenHW Group
Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
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.0
.. _exceptions-interrupts:

Exceptions and Interrupts
Expand Down
19 changes: 18 additions & 1 deletion cores/cv32e40p/user_manual/source/fpu.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
..
Copyright (c) 2020 OpenHW Group
Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
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.0
.. _fpu:

Floating Point Unit (FPU)
Expand Down Expand Up @@ -30,4 +47,4 @@ When using floating-point extensions the standard specifies a
floating-point status and control register (:ref:`csr-fcsr`) which contains the
exceptions that occurred since it was last reset and the rounding mode.
:ref:`csr-fflags` and :ref:`csr-frm` can be accessed directly or via :ref:`csr-fcsr` which is mapped to
those two registers.
those two registers.
17 changes: 17 additions & 0 deletions cores/cv32e40p/user_manual/source/getting_started.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
..
Copyright (c) 2020 OpenHW Group
Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
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.0
.. _getting-started:

Getting Started with CV32E40P
Expand Down
17 changes: 17 additions & 0 deletions cores/cv32e40p/user_manual/source/glossary.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
..
Copyright (c) 2020 OpenHW Group
Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
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.0
.. _glossary:

Glossary
Expand Down
17 changes: 17 additions & 0 deletions cores/cv32e40p/user_manual/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
..
Copyright (c) 2020 OpenHW Group
Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
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.0
OpenHW Group CV32E40P User Manual
=================================
Editor: **Davide Schiavone**
Expand Down
17 changes: 17 additions & 0 deletions cores/cv32e40p/user_manual/source/instruction_fetch.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
..
Copyright (c) 2020 OpenHW Group
Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
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.0
.. _instruction-fetch:

Instruction Fetch
Expand Down
17 changes: 17 additions & 0 deletions cores/cv32e40p/user_manual/source/instruction_set_extensions.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
..
Copyright (c) 2020 OpenHW Group
Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
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.0
.. _custom-isa-extensions:

CORE-V Instruction Set Extensions
Expand Down
17 changes: 17 additions & 0 deletions cores/cv32e40p/user_manual/source/integration.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
..
Copyright (c) 2020 OpenHW Group
Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
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.0
.. _core-integration:

Core Integration
Expand Down
17 changes: 17 additions & 0 deletions cores/cv32e40p/user_manual/source/intro.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
..
Copyright (c) 2020 OpenHW Group
Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
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.0
Introduction
=============

Expand Down
17 changes: 17 additions & 0 deletions cores/cv32e40p/user_manual/source/load_store_unit.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
..
Copyright (c) 2020 OpenHW Group
Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
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.0
.. _load-store-unit:

Load-Store-Unit (LSU)
Expand Down
17 changes: 17 additions & 0 deletions cores/cv32e40p/user_manual/source/perf_counters.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
..
Copyright (c) 2020 OpenHW Group
Licensed under the Solderpad Hardware Licence, Version 2.0 (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/
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.0
.. _performance-counters:

Performance Counters
Expand Down
Loading

0 comments on commit 35d07fd

Please sign in to comment.