1. Improvements in Base, System Reset and System Suspend service groups #38
Conversation
src/srvgrp-system-suspend.adoc
Outdated
| | 0 | ||
| | SUSPEND_TYPE | ||
| | uint32 | ||
| | Suspend type |
There was a problem hiding this comment.
either link to line 32 or to Sleep types definitions in SBI spc.
There was a problem hiding this comment.
There was a problem hiding this comment.
or link to Line 21 (not line 32) in this adoc. Can create a sub-section then reference link to it
| | 0 | SUSPEND_TYPE | uint32 | Suspend type value. + | ||
| Refer to https://github.com/riscv-non-isa/riscv-sbi-doc/blob/master/src/ext-sys-suspend.adoc#table_susp_sleep_types[*SUSP System Sleep Types*^] | ||
| in the RISC-V SBI Specification cite:[SBI] for the SUSPEND_TYPE definition. | ||
| | Word |
There was a problem hiding this comment.
in the new pdf, font size of italic text is look bigger than other text. This can be changed?
There was a problem hiding this comment.
We are relying on the format theme coming from the docs_resource submodule.
I think your repo has not the updated docs_resources folder. This is how it currently looks
There was a problem hiding this comment.
font size looks okay after update doc-resources
src/srvgrp-system-suspend.adoc
Outdated
| | 1 | ||
| | SUSPEND_TYPE | ||
| | uint32 | ||
| | Suspend type. |
There was a problem hiding this comment.
Same here, reference link to 'Suspend type'
| ! Error Code | ||
| ! Description | ||
|
|
||
| ! RPMI_ERROR_NOT_SUPPORTED |
There was a problem hiding this comment.
other services has RPMI_SUCCESS for success, need have this error code for all services?
| | 0 | ||
| | RESET_TYPE | ||
| | uint32 | ||
| | Reset type |
There was a problem hiding this comment.
add the reference link to line 30
| ! RPMI_ERROR_NOT_FOUND | ||
| ! EVENT_ID is not supported or invalid. | ||
|
|
||
| ! RPMI_ERROR_NOT_SUPPORTED |
There was a problem hiding this comment.
Adjust the table column width to fix the whole text in one line.
In SYSSUSP_ENABLE_NOTIFICATION table:
| ! Error Code | ||
| ! Description | ||
|
|
||
| ! RPMI_ERROR_NOT_SUPPORTED |
There was a problem hiding this comment.
here also, make it one line.
| ! RPMI_ERROR_NOT_FOUND | ||
| ! `EVENT_ID` is not supported or invalid. | ||
|
|
||
| ! RPMI_ERROR_NOT_SUPPORTED |
There was a problem hiding this comment.
same here, make it display in one line.
pathakraul
force-pushed
the
rpathak_sysreset_syssuspend
branch
from
9aaa1b5 to
b2a1c84
Compare
|
Addressed all the comments, hopefully without missing any. |
pathakraul
changed the title
|
I pushed commit for Base service group also |
src/srvgrp-system-suspend.adoc
Outdated
| been complete. | ||
|
|
||
| ==== Suspend Types | ||
| RPMI supports suspend states and their values as defined by SBI |
There was a problem hiding this comment.
Use 'suspend types' instead of suspend states here?
| | 0x01 | SYSSUSP_ENABLE_NOTIFICATION | NORMAL_REQUEST | ||
| | 0x02 | SYSSUSP_GET_ATTRIBUTES | NORMAL_REQUEST | ||
| | 0x03 | SYSSUSP_SUSPEND | NORMAL_REQUEST | ||
| | Service ID |
There was a problem hiding this comment.
This table should move to before the "Suspend Types" sub-section. It is under chapter "4.3.1. Suspend Types" now.
| | 0x01 | SYSRST_ENABLE_NOTIFICATION | NORMAL_REQUEST | ||
| | 0x02 | SYSRST_GET_ATTRIBUTES | NORMAL_REQUEST | ||
| | 0x03 | SYSRST_RESET | POSTED_REQUEST | ||
| | Service ID |
There was a problem hiding this comment.
same here, move to before subsection of "Reset Types"
src/srvgrp-system-reset.adoc
Outdated
| | RESET_TYPE | ||
| | uint32 | ||
| | Reset type + | ||
| Refer <<Reset Types>> section for supported reset types. |
There was a problem hiding this comment.
can remove 'section'here, generated pdf has Section in front.
eg:
Refer Section 4.2.1 section for supported reset types.
src/srvgrp-system-reset.adoc
Outdated
| | RESET_TYPE | ||
| | uint32 | ||
| | Reset type + | ||
| Refer <<Reset Types>> section for supported reset types. |
src/srvgrp-base.adoc
Outdated
| A service group is a collection of services which are logically grouped | ||
| according to the functionality they provide. For example, all voltage related | ||
| services/messages are collectively referred to as the Voltage Service Group. | ||
| === Service Group: BASE (servicegroup_id: 0x0001) |
There was a problem hiding this comment.
In the Message Format chapter, we use "SERVICEGROUP_ID", should standardize this?
Same for "SERVICE_ID" in each sub-chapter header.
| | Description | ||
|
|
||
| | 0x001 | ||
| | REQUEST_HANDLE_ERROR |
There was a problem hiding this comment.
adjust table width, so that fix whole word in one line
| ==== Service: BASE_GET_IMPLEMENTATION_ID (service_id: 0x03) | ||
| This service is used to get a `32-bit` RPMI implementation ID assigned to the | ||
| software which implements the RPMI specification. Every implementation ID is | ||
| unique and listed in the table <<table_base_rpmi_impl_id>> |
There was a problem hiding this comment.
It display like this, fix it.
| | Platform Identifier field length in bytes. | ||
|
|
||
| | 2 | ||
| | PLATFORM_ID |
There was a problem hiding this comment.
make them display in one line
| 0: Service group not implemented by platform. | ||
| 1: Service group implemented by platform. | ||
| | 1 | ||
| | SERVICE_GROUP_STATUS |
There was a problem hiding this comment.
make this display in one line
pathakraul
force-pushed
the
rpathak_sysreset_syssuspend
branch
from
ecde115 to
e72eb72
Compare
Signed-off-by: Rahul Pathak <[email protected]>
Signed-off-by: Rahul Pathak <[email protected]>
Signed-off-by: Rahul Pathak <[email protected]>
Signed-off-by: Rahul Pathak <[email protected]>
pathakraul
force-pushed
the
rpathak_sysreset_syssuspend
branch
from
e72eb72 to
a568ffe
Compare
Signed-off-by: Rahul Pathak <[email protected]>
pathakraul
changed the title
|
Merging this since other PRs are dependent on this, we have more review stages coming in |
No description provided.