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

Update 2 #25

Merged
merged 13 commits into from
Apr 29, 2024
Merged

Update 2 #25

merged 13 commits into from
Apr 29, 2024

Conversation

lftan
Copy link
Collaborator

@lftan lftan commented Apr 23, 2024

  • Update description and fix grammar in some service group chapters.
  • Refer to SBI spec for System Reset Types and System Suspend Types.

Platform can optionally support notifications of events which might occur in the platform. PuC can send these notification messages to AP if they are implemented
and AP has subscribed to these. Events supported are described above in System
Suspend Notifications.
This service allows the AP to subscribe to System Suspend service group
Copy link
Collaborator

@pathakraul pathakraul Apr 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use single convention for names? example: System Suspend or system suspend. This applies to such service-groups/services names in the whole spec. Either is fine for me

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will change to "System Suspend", since it is a special term in the spec.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should use SYSTEM_SUSPEND instead of "System Suspend" when used for the service group name.
Same for other service groups.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But at places in text we are referring the name as functionality in general and not the service group name

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets go with anything but single convention, we can deal with this later

executes WFI instruction.
type. It requires that all harts except the calling hart to be in the STOPPED
state as defined by the Hart State Management service group. The system
transitions into the low power state only after the requesting HART executes
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we write HART in smallcase everywhere?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok

Ley Foon Tan added 6 commits April 24, 2024 12:05
- Fix grammar
- Fine tune description
- 80 character per line

Signed-off-by: Ley Foon Tan <leyfoon.tan@starfivetech.com>
Refer to Suspend Types definition in SBI spec for SUSPEND_TYPE.

Signed-off-by: Ley Foon Tan <leyfoon.tan@starfivetech.com>
…service

The returned Attributes flags (bit-30) already indicates the SUSPEND_TYPE
is support or not. Remove RPMI_ERROR_NOT_SUPPORTED from return code.

Signed-off-by: Ley Foon Tan <leyfoon.tan@starfivetech.com>
- Fix grammar
- Fine tune description
- 80 characters per line

Signed-off-by: Ley Foon Tan <leyfoon.tan@starfivetech.com>
Refer to Reset Types definition in SBI spec for RESET_TYPE.

Signed-off-by: Ley Foon Tan <leyfoon.tan@starfivetech.com>
So that RPMI_ERROR_NOT_SUPPORTED can display in one line.

Signed-off-by: Ley Foon Tan <leyfoon.tan@starfivetech.com>

* Initial handshaking between the Application processor and Platform
micro-controller.
* Initial handshaking between the Application processor and the Platform
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Application Processor and Platform Microcontroller everywhere ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

@@ -26,23 +29,25 @@ Following table lists the service group
| 0x80000 - 0xFFFFF | _Implementation Specific Service Groups_
|===
NOTE: The services listed in each service group do not follow any sequence and
are not defined in any specific order. It's possible that any particular service
in any service group inherently requires to be called first before other defined services before that.
are not defined in any specific order. It's possible that a particular service
Copy link
Collaborator

@pathakraul pathakraul Apr 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should reframe this to mention that services defined in the sequence in spec does not represent the calling order in the implementation

Ley Foon Tan added 7 commits April 25, 2024 14:28
- Fix grammar
- Fine tune description
- 80 characters per line

Signed-off-by: Ley Foon Tan <leyfoon.tan@starfivetech.com>
Change "Micro-controller" to "Microcontroller".

Signed-off-by: Ley Foon Tan <leyfoon.tan@starfivetech.com>
We use "AP" in the document now, change it.

Signed-off-by: Ley Foon Tan <leyfoon.tan@starfivetech.com>
Uses same term in whole document.

Signed-off-by: Ley Foon Tan <leyfoon.tan@starfivetech.com>
Signed-off-by: Ley Foon Tan <leyfoon.tan@starfivetech.com>
Since prefix already has BASE, rename it.

Signed-off-by: Ley Foon Tan <leyfoon.tan@starfivetech.com>
Other service groups don't have this, remove this.

Signed-off-by: Ley Foon Tan <leyfoon.tan@starfivetech.com>
@pathakraul pathakraul merged commit 35221e8 into riscv-non-isa:main Apr 29, 2024
1 check passed
@lftan lftan deleted the update-2 branch September 4, 2024 02:14
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.

2 participants