te
Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
pm_power_has_changed - Notify Power Management framework of autonomous power level change

#include <sys/ddi.h>
#include <sys/sunddi.h>

int pm_power_has_changed(dev_info_t *dip, int component, int level);

illumos DDI specific (illumos DDI) dip component level The pm_power_has_changed(9F) function notifies the Power Management framework that the power level of component of dip has changed to level.

Normally power level changes are initiated by the Power Management framework due to device idleness, or through a request to the framework from the driver via pm_raise_power(9F) or pm_lower_power(9F), but some devices may change power levels on their own. For the framework to track the power level of the device under these circumstances, the framework must be notified of autonomous power level changes by a call to pm_power_has_changed().

Because of the asynchronous nature of these events, the Power Management framework might have called power(9E) between the device's autonomous power level change and the driver calling pm_power_has_changed(), or the framework may be in the process of changing the power level when pm_power_has_changed() is called. To handle these situations correctly, the driver should verify that the device is indeed at the level or set the device to the level if it doesn't support inquirying of power levels, before calling pm_power_has_changed(). In addition, the driver should prevent a power(9E) entry point from running in parallel with pm_power_has_changed().

Note -

The pm_power_has_changed() function returns: DDI_SUCCESS DDI_FAILURE This function can be called from user or kernel context. This function can also be called from interrupt context, providing that it is not the first Power Management function called by the driver. A hypothetical driver might include this code to handle pm_power_has_changed(9F):

static int
xxusb_intr(struct buf *bp)
{

 ...


 /*
 * At this point the device has informed us that it has
 * changed power level on its own. Inform this to framework.
 * We need to take care of the case when framework has
 * already called power() entry point and changed power level
 * before we were able to inform framework of this change.
 * Handle this by comparing the informed power level with
 * the actual power level and only doing the call if they
 * are same. In addition, make sure that power() doesn't get
 * run in parallel with this code by holding the mutex.
 */
 ASSERT(mutex_owned(&xsp->lock));
 if (level_informed == *(xsp->level_reg_addr)) {
 if (pm_power_has_changed(xsp->dip, XXUSB_COMPONENT,
 level_informed) != DDI_SUCCESS) {
 mutex_exit( &xsp->lock);
 return(DDI_INTR_UNCLAIMED);
 }
 }

 ....

}


xxdisk_power(dev_info *dip, int comp, int level)
{
 mutex_enter( xsp->lock);

 ...

 ...

}

See attributes(7) for a description of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE

Interface Stability Committed

pm (4D), power.conf (5), attach (9E), detach (9E), power (9E), pm_busy_component (9F), pm_idle_component (9F), pm_lower_power (9F), pm_raise_power (9F), pm (9P), pm-components (9P)

Writing Device Drivers