share/man/man9f/ddi_dev_is_needed.9f

   1 '\" te
   2 .\"  Copyright (c) 2003, 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 DDI_DEV_IS_NEEDED 9F "Dec 7, 2003"
   7 .SH NAME
   8 ddi_dev_is_needed \- inform the system that a device's component is required
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/ddi.h>
  13 #include <sys/sunddi.h>
  14
  15
  16
  17 \fBint\fR \fBddi_dev_is_needed\fR(\fBdev_info_t *\fR\fIdip\fR, \fBint\fR \fIcomponent\fR, \fBint\fR \fIlevel\fR);
  18 .fi
  19
  20 .SH INTERFACE LEVEL
  21 .sp
  22 .LP
  23 Solaris DDI specific (Solaris DDI)
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIdip\fR\fR
  29 .ad
  30 .RS 13n
  31 Pointer to the device's \fBdev_info\fR structure.
  32 .RE
  33
  34 .sp
  35 .ne 2
  36 .na
  37 \fB\fIcomponent\fR\fR
  38 .ad
  39 .RS 13n
  40 Component of the driver which is needed.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fIlevel\fR\fR
  47 .ad
  48 .RS 13n
  49 Power level at which the component is needed.
  50 .RE
  51
  52 .SH DESCRIPTION
  53 .sp
  54 .LP
  55 The \fBddi_dev_is_needed()\fR function is obsolete and will be removed in a
  56 future release. It is recommended that device drivers use
  57 \fBpm_raise_power\fR(9F) and \fBpm_lower_power\fR(9F).
  58 .sp
  59 .LP
  60 The \fBddi_dev_is_needed()\fR function informs the system that a device
  61 component is needed at the specified power level. The \fIlevel\fR argument must
  62 be non-zero.
  63 .sp
  64 .LP
  65 This function sets a \fIcomponent\fR to the required level and sets all devices
  66 which depend on this to their normal power levels.
  67 .sp
  68 .LP
  69 The state of the device should be examined before each physical access. The
  70 \fBddi_dev_is_needed()\fR function should be called to set a \fIcomponent\fR to
  71 the required power level if the operation to be performed requires the
  72 component to be at a power level other than its current level.
  73 .sp
  74 .LP
  75 The \fBddi_dev_is_needed()\fR function might cause re-entry of the driver.
  76 Deadlock may result if driver locks are held across the call to
  77 \fBddi_dev_is_needed()\fR.
  78 .SH RETURN VALUES
  79 .sp
  80 .LP
  81 The \fBddi_dev_is_needed()\fR function returns:
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBDDI_SUCCESS\fR\fR
  86 .ad
  87 .RS 15n
  88 Power successfully set to the requested level.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBDDI_FAILURE\fR\fR
  95 .ad
  96 .RS 15n
  97 An error occurred.
  98 .RE
  99
 100 .SH EXAMPLES
 101 .LP
 102 \fBExample 1 \fRdisk driver code
 103 .sp
 104 .LP
 105 A hypothetical disk driver might include this code:
 106
 107 .sp
 108 .in +2
 109 .nf
 110      static int
 111 xxdisk_spun_down(struct xxstate *xsp)
 112 {
 113                 return (xsp->power_level[DISK_COMPONENT] < POWER_SPUN_UP);
 114 }
 115 static int
 116 xxdisk_strategy(struct buf *bp)
 117 {
 118
 119 \&.\|.\|.
 120
 121         mutex_enter(&xxstate_lock);
 122         /*
 123         * Since we have to drop the mutex, we have to do this in a loop
 124         * in case we get preempted and the device gets taken away from
 125         * us again
 126         */
 127         while (device_spun_down(sp)) {
 128                 mutex_exit(&xxstate_lock);
 129                 if (ddi_dev_is_needed(xsp->mydip,
 130                         XXDISK_COMPONENT, XXPOWER_SPUN_UP) != DDI_SUCCESS) {
 131                                 bioerror(bp,EIO);
 132                                 biodone(bp);
 133                 return (0);
 134         }
 135                 mutex_enter(&xxstate_lock);
 136         }
 137         xsp->device_busy++;
 138         mutex_exit(&xxstate_lock);
 139
 140 \&.\|.\|.
 141
 142 }
 143 .fi
 144 .in -2
 145
 146 .SH CONTEXT
 147 .sp
 148 .LP
 149 This function can be called from user or kernel context.
 150 .SH ATTRIBUTES
 151 .sp
 152 .LP
 153 See \fBattributes\fR(5) for descriptions of the following attributes:
 154 .sp
 155
 156 .sp
 157 .TS
 158 box;
 159 c | c
 160 l | l .
 161 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 162 _
 163 Interface Stability     Obsolete
 164 .TE
 165
 166 .SH SEE ALSO
 167 .sp
 168 .LP
 169 \fBpm\fR(7D), \fBpm-components\fR(9P), \fBattach\fR(9E), \fBdetach\fR(9E),
 170 \fBpower\fR(9E), \fBpm_busy_component\fR(9F), \fBpm_idle_component\fR(9F)
 171 .sp
 172 .LP
 173 \fIWriting Device Drivers\fR