PWRM_idleClocks
2-324
C Interface
Syntax
status = PWRM_idleClocks(domainMask, idleStatus);
Parameters
Uns
domainMask; /* bitmask of clock domains to be idled */
Uns
*idleStatus;
/* contents of ISTR after idling */
Return Value
PWRM_Status status;
/* returned status */
Reentrant
yes
Description
PWRM_idleClocks immediately turns off the specified clock domains.
This allows applications to idle non-CPU domains at any point in the
application.
The domainMask is a bitmask that specifies clock domains to be idled.
This value is written to the ICR register before idling the processor. See
the Idling tab of the configuration properties for descriptions of required
interactions between idled clock domains. The bitmask can be formed
using the following predefined mask constants:
The idleStatus parameter should point to the location where
PWRM_idleClocks should write the contents of the Idle Status Register
(ISTR) after idling clock domains. If PWRM_idleClocks returns
PWRM_EFAIL, this parameter can be used to determine which domains
were idled and which were not. For example, if a bit was set in the
domainMask but is not set in idleStatus, the corresponding domain could
not be idled.
PWRM_idleClocks
Immediately idle clock domains
Name
Usage
PWRM_IDLEDMA
Idle the DMA clock domain
PWRM_IDLECACHE
Idle the CACHE clock domain
PWRM_IDLEPERIPH
Idle the PERIPH clock domain
PWRM_IDLEEMIF
Idle the EMIF clock domain
PWRM_IDLEIPORT
Idle the IPORT clock domain (OMAP 2420 only)
PWRM_IDLEHWA
Idle the HWA clock domain (OMAP 2420 only)
PWRM_IDLEMPORT
Idle the MPORT clock domain (OMAP 2420 only)
PWRM_IDLEXPORT
Idle the XPORT clock domain (OMAP 2420 only)