Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CORE_V_MCU high level design specs #328

Merged
merged 3 commits into from
Jan 18, 2024

Conversation

cst-rameez
Copy link
Contributor

Adding high level design specs for the IPs which have insufficient information in core_v_mcu user manual https://docs.openhwgroup.org/projects/core-v-mcu/

Following are CORE-V-MCU IP blocks whose documents are updated:
APB Advanced Timer
APB SoC Controller
APB PLL Interface
APB_GPIO
APB Timer
ABP I2C Slave
APB Event Control
UDMA CAMERA Interface
UDMA SD Card Interface

@MikeOpenHWGroup
Copy link
Member

Hi @cst-rameez, thank you for this tremendous contribution to the CORE-V-MCU User Manual. It is much appreciated. I am in the process of reviewing the technical content and will leave my comments here. In the meantime there are two legal issues to resolve:

  1. Please work with @DBees to ensure you are covered by the ECA. This is most important - we cannot accept your contribution unless this is complete.
  2. Please re-instate the comment headers for the RST files you are updating. Here I will use docs/doc-src/ip-blocks/apb_adv_timer.rst as an example:
..
   Copyright (c) 2023 OpenHW Group

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

This is the License Header and it is a legal requirement that you maintain this. Of course, your organization is making a significant contribution, so you can add that to the License Header like this:

   Copyright (c) 2023 OpenHW Group
   Copyright (c) 2024 CircuitSutra

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

The next few lines in the comment header are intended as a helpful guide for editors to illustrate how to create section headers.

.. Level 1
   =======

   Level 2
   -------

   Level 3
   ~~~~~~~

   Level 4
   ^^^^^^^

Lastly, this is a tag that can be used to create hyper-links between chapters, so it should remain.

.. _apb_advanced_timer:

@DBees
Copy link
Contributor

DBees commented Jan 3, 2024

@MikeOpenHWGroup @cst-rameez it appears the ECA is in good shape

@disdi
Copy link

disdi commented Jan 3, 2024

Really nice work.

@MikeOpenHWGroup
Copy link
Member

it appears the ECA is in good shape

Really? The Eclipse ECA Validation Service says, "There is no valid ECA on file for [email protected]." and the eclipsefdn/eca check in this PR's run-flow is still failing.

@DBees
Copy link
Contributor

DBees commented Jan 18, 2024

@cst-rameez my error. Can you please (as requested for the first pull request made to programs repo), log into your Eclipse Foundation Account and click the "I work for an employer who is an Eclipse Foundation member" and identify your employer. That should clear it. If that doesn't work, can you please ping me and we can chat live.

@cst-rameez
Copy link
Contributor Author

Hi @DBees, I have updated my profile. could you please check what could be the problem now?

@DBees
Copy link
Contributor

DBees commented Jan 18, 2024

HI @cst-rameez thank you. I have verified that your ECA status is now good. Can you please make an additional trivial commit (add a comma or a space). I think that should clear it here.

@cst-rameez
Copy link
Contributor Author

Hi @cst-rameez, thank you for this tremendous contribution to the CORE-V-MCU User Manual. It is much appreciated. I am in the process of reviewing the technical content and will leave my comments here. In the meantime there are two legal issues to resolve:

  1. Please work with @DBees to ensure you are covered by the ECA. This is most important - we cannot accept your contribution unless this is complete.
  2. Please re-instate the comment headers for the RST files you are updating. Here I will use docs/doc-src/ip-blocks/apb_adv_timer.rst as an example:
..
   Copyright (c) 2023 OpenHW Group

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

This is the License Header and it is a legal requirement that you maintain this. Of course, your organization is making a significant contribution, so you can add that to the License Header like this:

   Copyright (c) 2023 OpenHW Group
   Copyright (c) 2024 CircuitSutra

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

The next few lines in the comment header are intended as a helpful guide for editors to illustrate how to create section headers.

.. Level 1
   =======

   Level 2
   -------

   Level 3
   ~~~~~~~

   Level 4
   ^^^^^^^

Lastly, this is a tag that can be used to create hyper-links between chapters, so it should remain.

.. _apb_advanced_timer:

Incorporated the following changes mentioned above.

@DBees DBees merged commit 43d07a6 into openhwgroup:master Jan 18, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants