summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: fb9e3b9)
raw | patch | inline | side by side (parent: fb9e3b9)
sciclient: docs: design: Update to add Domain reset information REL.CORESDK.07.03.00.02 REL.CORESDK.07.03.00.03 REL.CORESDK.07.03.00.04
author | Piyali Goswami <piyali_g@ti.com> | |
Fri, 12 Feb 2021 04:01:46 +0000 (09:31 +0530) | ||
committer | Sujith Shivalingappa <sujith.s@ti.com> | |
Mon, 15 Feb 2021 10:56:51 +0000 (04:56 -0600) |
Doc update to add domain groups reset API information
Signed-off-by: Piyali Goswami <piyali_g@ti.com>
Signed-off-by: Piyali Goswami <piyali_g@ti.com>
packages/ti/drv/sciclient/docs/design/lld.rst | patch | blob | history |
diff --git a/packages/ti/drv/sciclient/docs/design/lld.rst b/packages/ti/drv/sciclient/docs/design/lld.rst
index e76b0a5b45996baad4c66e0af36e862708bb2464..0f6147a2051cb1e7e9d96c91aecaf5dc759b2c58 100644 (file)
**See Also**
None
+Sciclient_pmDomainReset
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ Trigger warm reset of a domain
+ NOTE: Depending on permissions configured for the SoC, not all domains
+ can be reset
+
+ \n<b>Message</b>: #TISCI_MSG_SYS_RESET
+ \n<b>Request</b>: #tisci_msg_sys_reset_req
+ \n<b>Response</b>: #tisci_msg_sys_reset_resp
+
+**Syntax**
+
+int32_t Sciclient_pmDomainReset(domgrp_t domGrp, uint32_t timeout);
+
+**Arguments**
+
+ domGrp : The domain to be reset.
+
+ timeout : Gives a sense of how long to wait for the operation.
+ Refer \ref Sciclient_ServiceOperationTimeout.
+
+
+
+**Return Value**
+CSL_PASS on success, else failure
+
+**Comments**
+If domGrp = 0, this API functions like Sciclient_pmDeviceReset.
+
+**Constraints**
+None
+
+**See Also**
+None
+
Sciclient_pmIsModuleValid
~~~~~~~~~~~~~~~~~~~~~~~~~~~