usr/src/man/man9p/no-involuntary-power-cycles.9p

   1 '\" te
   2 .\" Copyright (c) 2001, 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 NO-INVOLUNTARY-POWER-CYCLES 9P "Mar 22, 2001"
   7 .SH NAME
   8 no-involuntary-power-cycles \- device property to prevent involuntary power
   9 cycles
  10 .SH DESCRIPTION
  11 .sp
  12 .LP
  13 A device that might be damaged by power cycles should export the boolean (zero
  14 length) property \fBno-involuntary-power-cycles\fR to notify the system that
  15 all power cycles for the device must be under the control of the device driver.
  16 .sp
  17 .LP
  18 The presence of this property prevents power from being removed from a device
  19 or any ancestor of the device while the device driver is detached, unless the
  20 device was voluntarily powered off as a result of the device driver calling
  21 \fBpm_lower_power\fR(9F).
  22 .sp
  23 .LP
  24 The presence of \fBno-involuntary-power-cycles\fR also forces attachment of the
  25 device driver during a CPR suspend operation and prevents the suspend from
  26 taking place, unless the device driver returns \fBDDI_SUCCESS\fR when its
  27 \fBdetach\fR(9E) entry point is called with \fBDDI_SUSPEND\fR.
  28 .sp
  29 .LP
  30 The presence of \fBno-involuntary-power-cycles\fR does not prevent the system
  31 from being powered off due to a \fBhalt\fR(1M) or \fBuadmin\fR(1M) invocation,
  32 except for CPR suspend.
  33 .sp
  34 .LP
  35 This property can be exported by a device that is not power manageable, in
  36 which case power is not removed from the device or from any of its ancestors,
  37 even when the driver for the device and the drivers for its ancestors are
  38 detached.
  39 .SH EXAMPLES
  40 .LP
  41 \fBExample 1 \fRUse of Property in Driver's Configuration File
  42 .sp
  43 .LP
  44 The following is an example of a \fBno-involuntary-power-cycles\fR entry in a
  45 driver's \fB\&.conf\fR file:
  46
  47 .sp
  48 .in +2
  49 .nf
  50 no-involuntary-power-cycles=1;
  51      ...
  52 .fi
  53 .in -2
  54
  55 .LP
  56 \fBExample 2 \fRUse of Property in \fBattach()\fR Function
  57 .sp
  58 .LP
  59 The following is an example of how the preceding \fB\&.conf\fR file entry would
  60 be implemented in the \fBattach\fR(9E) function of a driver:
  61
  62 .sp
  63 .in +2
  64 .nf
  65 xxattach(dev_info_t *dip, ddi_attach_cmd_t cmd)
  66   {
  67    ...
  68        if (ddi_prop_create(DDI_DEV_T_NONE, dip, DDI_PROP_CANSLEEP,
  69            "no-involuntary-power-cycles", NULL, 0) != DDI_PROP_SUCCESS)
  70             goto failed;
  71    ...
  72    }
  73 .fi
  74 .in -2
  75
  76 .SH ATTRIBUTES
  77 .sp
  78 .LP
  79 See \fBattributes\fR(5) for descriptions of the following attributes:
  80 .sp
  81
  82 .sp
  83 .TS
  84 box;
  85 c | c
  86 l | l .
  87 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  88 _
  89 Interface stability     Committed
  90 .TE
  91
  92 .SH SEE ALSO
  93 .sp
  94 .LP
  95 \fBattributes\fR(5), \fBpm\fR(7D), \fBattach\fR(9E), \fBdetach\fR(9E),
  96 \fBddi_prop_create\fR(9F)
  97 .sp
  98 .LP
  99 \fIWriting Device Drivers\fR