usr/src/man/man9p/pm.9p

   1 '\" te
   2 .\"  Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH PM 9P "Jan 20, 2004"
   7 .SH NAME
   8 pm \- Power Management properties
   9 .SH DESCRIPTION
  10 .sp
  11 .LP
  12 The \fBpm-hardware-state\fR property can be used to influence the behavior of
  13 the Power Management framework. Its syntax and interpretation is described
  14 below.
  15 .sp
  16 .LP
  17 Note that this property is only interpreted by the system immediately after the
  18 device has successfully attached. Changes in the property made by the driver
  19 after the driver has attached will not be recognized.
  20 .sp
  21 .LP
  22 \fBpm-hardware-state\fR is a string-valued property. The existence of the
  23 \fBpm-hardware-state\fR property indicates that a device needs special handling
  24 by the Power Management framework with regard to its hardware state.
  25 .sp
  26 .LP
  27 If the value of this property is \fBneeds-suspend-resume\fR, the device has a
  28 hardware state that cannot be deduced by the framework. The framework
  29 definition of a device with hardware state is one with a \fBreg\fR property.
  30 Some drivers, such as \fBSCSI\fR disk and tape drivers, have no \fBreg\fR
  31 property but manage devices with "remote" hardware. Such a device must have a
  32 \fBpm-hardware-state\fR property with a value of \fBneeds-suspend-resume\fR for
  33 the system to identify it as needing a call to its \fBdetach\fR(9E) entry point
  34 with command \fBDDI_SUSPEND\fR when system is suspended, and a call to
  35 \fBattach\fR(9E) with command \fBDDI_RESUME\fR when system is resumed. For
  36 devices using original Power Management interfaces (which are now obsolete)
  37 \fBdetach\fR(9E) is also called with \fBDDI_PM_SUSPEND\fR before power is
  38 removed from the device, and \fBattach\fR(9E) is called with
  39 \fBDDI_PM_RESUME\fR after power is restored.
  40 .sp
  41 .LP
  42 A value of \fBno-suspend-resume\fR indicates that, in spite of the existence of
  43 a \fBreg\fR property, a device has no hardware state that needs saving and
  44 restoring. A device exporting this property will not have its \fBdetach()\fR
  45 entry point called with command \fBDDI_SUSPEND\fR when system is suspended, nor
  46 will its \fBattach()\fR entry point be called with command \fBDDI_RESUME\fR
  47 when system is resumed. For devices using the original (and now obsolete) Power
  48 Management interfaces, \fBdetach\fR(9E) will not be called with
  49 \fBDDI_PM_SUSPEND\fR command before power is removed from the device, nor
  50 \fBattach\fR(9E) will be called with \fBDDI_PM_RESUME\fR command after power is
  51 restored to the device.
  52 .sp
  53 .LP
  54 A value of \fBparental-suspend-resume\fR indicates that the device does not
  55 implement the \fBdetach\fR(9E) \fBDDI_SUSPEND\fR semantics, nor the
  56 \fBattach()\fR \fBDDI_RESUME\fR semantics, but that a call should be made up
  57 the device tree by the framework to effect the saving and/or restoring of
  58 hardware state for this device. For devices using original Power Management
  59 interfaces (which are now obsolete), it also indicates that the device does not
  60 implement the \fBdetach\fR(9E) \fBDDI_PM_SUSPEND\fR semantics, nor the
  61 \fBattach\fR(9E) \fBDDI_PM_RESUME\fR semantics, but that a call should be made
  62 up the device tree by the framework to effect the saving and/or restoring the
  63 hardware state for this device.
  64 .SH ATTRIBUTES
  65 .sp
  66 .LP
  67 See \fBattributes\fR(5) for descriptions of the following attributes:
  68 .sp
  69
  70 .sp
  71 .TS
  72 box;
  73 c | c
  74 l | l .
  75 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  76 _
  77 Interface stability     Committed
  78 .TE
  79
  80 .SH SEE ALSO
  81 .sp
  82 .LP
  83 \fBpower.conf\fR(4), \fBpm\fR(7D), \fBattach\fR(9E), \fBdetach\fR(9E),
  84 \fBpm_busy_component\fR(9F), \fBpm_idle_component\fR(9F),
  85 \fBpm-components\fR(9P)
  86 .sp
  87 .LP
  88 \fIWriting Device Drivers\fR