Merge pull request #979 from pascalgouedo/dev_dd_pgo_doc

User Manual improvements.

docs/source/conf.py

@@ -1,20 +1,20 @@
 # -*- 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.
+#  Copyright 2024 OpenHW Group and Dolphin Design
+#  SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
+# 
+#  Licensed under the Solderpad Hardware License v 2.1 (the "License");
+#  you may not use this file except in compliance with the License, or,
+#  at your option, the Apache License version 2.0.
 #  You may obtain a copy of the License at
 # 
-#  https://solderpad.org/licenses/
+#  https://solderpad.org/licenses/SHL-2.1/
 # 
-#  Unless required by applicable law or agreed to in writing, software
+#  Unless required by applicable law or agreed to in writing, any work
 #  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
 #
 ###############################################################################
 #
@@ -44,7 +44,7 @@
 # The short X.Y version
 version = u''
 # The full version, including alpha/beta/rc tags
-release = u''
+release = u'v1.7.1'
 
 
 # -- General configuration ---------------------------------------------------
@@ -148,6 +148,8 @@
 
 # -- Options for LaTeX output ------------------------------------------------
 
+latex_logo = '../images/openhw-landscape.png'
+
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     #

docs/source/control_status_registers.rst

@@ -1,20 +1,20 @@
 ..
-   Copyright (c) 2023 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.
+   Copyright 2024 OpenHW Group and Dolphin Design
+   SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
+  
+   Licensed under the Solderpad Hardware License v 2.1 (the "License");
+   you may not use this file except in compliance with the License, or,
+   at your option, the Apache License version 2.0.
    You may obtain a copy of the License at
-
-   https://solderpad.org/licenses/
-
-   Unless required by applicable law or agreed to in writing, software
+  
+   https://solderpad.org/licenses/SHL-2.1/
+  
+   Unless required by applicable law or agreed to in writing, any work
    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

docs/source/core_versions.rst

@@ -1,19 +1,19 @@
 ..
-   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.
+   Copyright 2024 OpenHW Group and Dolphin Design
+   SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
+  
+   Licensed under the Solderpad Hardware License v 2.1 (the "License");
+   you may not use this file except in compliance with the License, or,
+   at your option, the Apache License version 2.0.
    You may obtain a copy of the License at
   
-   https://solderpad.org/licenses/
+   https://solderpad.org/licenses/SHL-2.1/
   
-   Unless required by applicable law or agreed to in writing, software
+   Unless required by applicable law or agreed to in writing, any work
    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:
 

docs/source/corev_hw_loop.rst

@@ -1,19 +1,19 @@
 ..
-   Copyright (c) 2023 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.
+   Copyright 2024 OpenHW Group and Dolphin Design
+   SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
+  
+   Licensed under the Solderpad Hardware License v 2.1 (the "License");
+   you may not use this file except in compliance with the License, or,
+   at your option, the Apache License version 2.0.
    You may obtain a copy of the License at
   
-   https://solderpad.org/licenses/
+   https://solderpad.org/licenses/SHL-2.1/
   
-   Unless required by applicable law or agreed to in writing, software
+   Unless required by applicable law or agreed to in writing, any work
    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:
 

docs/source/debug.rst

@@ -1,19 +1,19 @@
 ..
-   Copyright (c) 2023 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.
+   Copyright 2024 OpenHW Group and Dolphin Design
+   SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
+  
+   Licensed under the Solderpad Hardware License v 2.1 (the "License");
+   you may not use this file except in compliance with the License, or,
+   at your option, the Apache License version 2.0.
    You may obtain a copy of the License at
   
-   https://solderpad.org/licenses/
+   https://solderpad.org/licenses/SHL-2.1/
   
-   Unless required by applicable law or agreed to in writing, software
+   Unless required by applicable law or agreed to in writing, any work
    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:
 

docs/source/exceptions_interrupts.rst

@@ -1,19 +1,19 @@
 ..
-   Copyright (c) 2023 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.
+   Copyright 2024 OpenHW Group and Dolphin Design
+   SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
+  
+   Licensed under the Solderpad Hardware License v 2.1 (the "License");
+   you may not use this file except in compliance with the License, or,
+   at your option, the Apache License version 2.0.
    You may obtain a copy of the License at
   
-   https://solderpad.org/licenses/
+   https://solderpad.org/licenses/SHL-2.1/
   
-   Unless required by applicable law or agreed to in writing, software
+   Unless required by applicable law or agreed to in writing, any work
    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:
 

docs/source/fpu.rst

@@ -1,18 +1,19 @@
 ..
-   Copyright (c) 2023 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.
+   Copyright 2024 OpenHW Group and Dolphin Design
+   SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
+  
+   Licensed under the Solderpad Hardware License v 2.1 (the "License");
+   you may not use this file except in compliance with the License, or,
+   at your option, the Apache License version 2.0.
    You may obtain a copy of the License at
   
-   https://solderpad.org/licenses/
+   https://solderpad.org/licenses/SHL-2.1/
   
-   Unless required by applicable law or agreed to in writing, software
+   Unless required by applicable law or agreed to in writing, any work
    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:

docs/source/glossary.rst

@@ -1,19 +1,19 @@
 ..
-   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.
+   Copyright 2024 OpenHW Group and Dolphin Design
+   SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
+  
+   Licensed under the Solderpad Hardware License v 2.1 (the "License");
+   you may not use this file except in compliance with the License, or,
+   at your option, the Apache License version 2.0.
    You may obtain a copy of the License at
   
-   https://solderpad.org/licenses/
+   https://solderpad.org/licenses/SHL-2.1/
   
-   Unless required by applicable law or agreed to in writing, software
+   Unless required by applicable law or agreed to in writing, any work
    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:
 

docs/source/index.rst

@@ -1,19 +1,19 @@
 ..
-   Copyright (c) 2023 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.
+   Copyright 2024 OpenHW Group and Dolphin Design
+   SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
+  
+   Licensed under the Solderpad Hardware License v 2.1 (the "License");
+   you may not use this file except in compliance with the License, or,
+   at your option, the Apache License version 2.0.
    You may obtain a copy of the License at
   
-   https://solderpad.org/licenses/
+   https://solderpad.org/licenses/SHL-2.1/
   
-   Unless required by applicable law or agreed to in writing, software
+   Unless required by applicable law or agreed to in writing, any work
    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
 =================================

docs/source/instruction_fetch.rst

@@ -1,19 +1,19 @@
 ..
-   Copyright (c) 2023 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.
+   Copyright 2024 OpenHW Group and Dolphin Design
+   SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
+  
+   Licensed under the Solderpad Hardware License v 2.1 (the "License");
+   you may not use this file except in compliance with the License, or,
+   at your option, the Apache License version 2.0.
    You may obtain a copy of the License at
   
-   https://solderpad.org/licenses/
+   https://solderpad.org/licenses/SHL-2.1/
   
-   Unless required by applicable law or agreed to in writing, software
+   Unless required by applicable law or agreed to in writing, any work
    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:
 

docs/source/instruction_set_extensions.rst

@@ -1,19 +1,19 @@
 ..
-   Copyright (c) 2023 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.
+   Copyright 2024 OpenHW Group and Dolphin Design
+   SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
+  
+   Licensed under the Solderpad Hardware License v 2.1 (the "License");
+   you may not use this file except in compliance with the License, or,
+   at your option, the Apache License version 2.0.
    You may obtain a copy of the License at
   
-   https://solderpad.org/licenses/
+   https://solderpad.org/licenses/SHL-2.1/
   
-   Unless required by applicable law or agreed to in writing, software
+   Unless required by applicable law or agreed to in writing, any work
    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:
 

docs/source/integration.rst

@@ -1,19 +1,19 @@
 ..
-   Copyright (c) 2023 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.
+   Copyright 2024 OpenHW Group and Dolphin Design
+   SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
+  
+   Licensed under the Solderpad Hardware License v 2.1 (the "License");
+   you may not use this file except in compliance with the License, or,
+   at your option, the Apache License version 2.0.
    You may obtain a copy of the License at
   
-   https://solderpad.org/licenses/
+   https://solderpad.org/licenses/SHL-2.1/
   
-   Unless required by applicable law or agreed to in writing, software
+   Unless required by applicable law or agreed to in writing, any work
    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:
 

docs/source/intro.rst

@@ -1,20 +1,20 @@
 ..
-   Copyright (c) 2023 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.
+   Copyright 2024 OpenHW Group and Dolphin Design
+   SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
+  
+   Licensed under the Solderpad Hardware License v 2.1 (the "License");
+   you may not use this file except in compliance with the License, or,
+   at your option, the Apache License version 2.0.
    You may obtain a copy of the License at
-
-   https://solderpad.org/licenses/
-
-   Unless required by applicable law or agreed to in writing, software
+  
+   https://solderpad.org/licenses/SHL-2.1/
+  
+   Unless required by applicable law or agreed to in writing, any work
    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
 =============