This module contains SCMI Clock protocol APIs.
|
| file | scmi_clock.h |
| | Header file containing scmi clock protocol APIs.
|
| |
|
| int32_t | SCMI_clockGetProtocolAttrs (SCMI_Handle handle, uint32_t *numClocks) |
| | API to get clock protocol attributes using clockSCMI protocol. More...
|
| |
| int32_t | SCMI_clockGetAttrs (SCMI_Handle handle, uint32_t clockId, uint32_t *attributes, uint8_t *name) |
| | API to get clock attributes for a clock Id. More...
|
| |
| int32_t | SCMI_clockConfigSet (SCMI_Handle handle, uint32_t clockId, uint32_t clockState) |
| | API to set clock state for a clock to enable or disable state. More...
|
| |
| int32_t | SCMI_clockConfigGet (SCMI_Handle handle, uint32_t clockId, uint32_t *clockState) |
| | API to get clock state for a clock. More...
|
| |
| int32_t | SCMI_clockNameGet (SCMI_Handle handle, uint32_t clockId, uint8_t *name) |
| | API to get clock's extended name. More...
|
| |
| int32_t | SCMI_clockRateGet (SCMI_Handle handle, uint32_t clockId, uint64_t *clockRate) |
| | API to get clock rate for a clock. More...
|
| |
| int32_t | SCMI_clockRateSet (SCMI_Handle handle, uint32_t clockId, uint64_t clockRate) |
| | API to set clock rate for a clock. More...
|
| |
| int32_t | SCMI_clockParentSet (SCMI_Handle handle, uint32_t clockId, uint32_t parentId) |
| | API to set parent for a clock. More...
|
| |
| int32_t | SCMI_clockParentGet (SCMI_Handle handle, uint32_t clockId, uint32_t *parentId) |
| | API to get parent for a clock. More...
|
| |
| int32_t | SCMI_clockGetPossibleParents (SCMI_Handle handle, uint32_t clockId, uint32_t *numPosParents, uint32_t *possibleParents) |
| | API to get possible parents for a clock. More...
|
| |
| int32_t | SCMI_clockProtocolInit (SCMI_Handle handle) |
| | API to initialise clock protocol. More...
|
| |
◆ SCMI_clockGetProtocolAttrs()
| int32_t SCMI_clockGetProtocolAttrs |
( |
SCMI_Handle |
handle, |
|
|
uint32_t * |
numClocks |
|
) |
| |
API to get clock protocol attributes using clockSCMI protocol.
- Parameters
-
| handle | SCMI_Handle handle returned from SCMI_open |
| numClocks | Pointer to get number of clocks |
- Returns
- SystemP_SUCCESS or SystemP_FAILURE
◆ SCMI_clockGetAttrs()
| int32_t SCMI_clockGetAttrs |
( |
SCMI_Handle |
handle, |
|
|
uint32_t |
clockId, |
|
|
uint32_t * |
attributes, |
|
|
uint8_t * |
name |
|
) |
| |
API to get clock attributes for a clock Id.
- Parameters
-
| handle | SCMI_Handle handle returned from SCMI_open |
| clockId | Clock Identifier |
| attributes | Pointer to clock attributes |
| name | Pointer to name of clock |
- Returns
- SystemP_SUCCESS or SystemP_FAILURE
◆ SCMI_clockConfigSet()
| int32_t SCMI_clockConfigSet |
( |
SCMI_Handle |
handle, |
|
|
uint32_t |
clockId, |
|
|
uint32_t |
clockState |
|
) |
| |
API to set clock state for a clock to enable or disable state.
- Parameters
-
| handle | SCMI_Handle handle returned from SCMI_open |
| clockId | Clock Identifier |
| clockState | Clock state |
- Returns
- SystemP_SUCCESS or SystemP_FAILURE
◆ SCMI_clockConfigGet()
| int32_t SCMI_clockConfigGet |
( |
SCMI_Handle |
handle, |
|
|
uint32_t |
clockId, |
|
|
uint32_t * |
clockState |
|
) |
| |
API to get clock state for a clock.
- Parameters
-
| handle | SCMI_Handle handle returned from SCMI_open |
| clockId | Clock Identifier |
| clockState | Pointer to Clock state |
- Returns
- SystemP_SUCCESS or SystemP_FAILURE
◆ SCMI_clockNameGet()
| int32_t SCMI_clockNameGet |
( |
SCMI_Handle |
handle, |
|
|
uint32_t |
clockId, |
|
|
uint8_t * |
name |
|
) |
| |
API to get clock's extended name.
- Parameters
-
| handle | SCMI_Handle handle returned from SCMI_open |
| clockId | Clock Identifier |
| name | Pointer to extended name |
- Returns
- SystemP_SUCCESS or SystemP_FAILURE
◆ SCMI_clockRateGet()
| int32_t SCMI_clockRateGet |
( |
SCMI_Handle |
handle, |
|
|
uint32_t |
clockId, |
|
|
uint64_t * |
clockRate |
|
) |
| |
API to get clock rate for a clock.
- Parameters
-
| handle | SCMI_Handle handle returned from SCMI_open |
| clockId | Clock Identifier |
| clockRate | Pointer to clock rate |
- Returns
- SystemP_SUCCESS or SystemP_FAILURE
◆ SCMI_clockRateSet()
| int32_t SCMI_clockRateSet |
( |
SCMI_Handle |
handle, |
|
|
uint32_t |
clockId, |
|
|
uint64_t |
clockRate |
|
) |
| |
API to set clock rate for a clock.
- Parameters
-
| handle | SCMI_Handle handle returned from SCMI_open |
| clockId | Clock Identifier |
| clockRate | Clock rate |
- Returns
- SystemP_SUCCESS or SystemP_FAILURE
◆ SCMI_clockParentSet()
| int32_t SCMI_clockParentSet |
( |
SCMI_Handle |
handle, |
|
|
uint32_t |
clockId, |
|
|
uint32_t |
parentId |
|
) |
| |
API to set parent for a clock.
- Parameters
-
| handle | SCMI_Handle handle returned from SCMI_open |
| clockId | Clock Identifier |
| parentId | Parent Identifier for the clock |
- Returns
- SystemP_SUCCESS or SystemP_FAILURE
◆ SCMI_clockParentGet()
| int32_t SCMI_clockParentGet |
( |
SCMI_Handle |
handle, |
|
|
uint32_t |
clockId, |
|
|
uint32_t * |
parentId |
|
) |
| |
API to get parent for a clock.
- Parameters
-
| handle | SCMI_Handle handle returned from SCMI_open |
| clockId | Clock Identifier |
| parentId | Pointer to Parent Identifier for the clock |
- Returns
- SystemP_SUCCESS or SystemP_FAILURE
◆ SCMI_clockGetPossibleParents()
| int32_t SCMI_clockGetPossibleParents |
( |
SCMI_Handle |
handle, |
|
|
uint32_t |
clockId, |
|
|
uint32_t * |
numPosParents, |
|
|
uint32_t * |
possibleParents |
|
) |
| |
API to get possible parents for a clock.
- Parameters
-
| handle | SCMI_Handle handle returned from SCMI_open |
| clockId | Clock Identifier |
| numPosParents | Pointer to number for possible parents. |
| possibleParents | Pointer to array of possible parents. |
- Returns
- SystemP_SUCCESS or SystemP_FAILURE
◆ SCMI_clockProtocolInit()
API to initialise clock protocol.
- Parameters
-
| handle | SCMI_Handle handle returned from SCMI_open |
- Returns
- SystemP_SUCCESS or SystemP_FAILURE
1.8.20