usr/src/man/man9e/prop_op.9e

   1 '\" te
   2 .\" Copyright (c) 2000 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 PROP_OP 9E "Jul 8, 1996"
   7 .SH NAME
   8 prop_op \- report driver property information
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/types.h>
  13 #include <sys/ddi.h>
  14 #include <sys/sunddi.h>
  15
  16
  17
  18 \fBint prefix\fR\fBprop_op\fR(\fBdev_t\fR \fIdev\fR, \fBdev_info_t *\fR\fIdip\fR,
  19      \fBddi_prop_op_t\fR \fIprop_op\fR, \fBint\fR \fIflags\fR, \fBchar *\fR\fIname\fR, \fBcaddr_t\fR \fIvaluep\fR,
  20      \fBint *\fR\fIlengthp\fR);
  21 .fi
  22
  23 .SH INTERFACE LEVEL
  24 .sp
  25 .LP
  26 Solaris DDI specific (Solaris DDI). This entry point is required, but it can be
  27 \fBddi_prop_op\fR(9F).
  28 .SH ARGUMENTS
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIdev\fR\fR
  33 .ad
  34 .RS 12n
  35 Device number associated with this device.
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fIdip\fR\fR
  42 .ad
  43 .RS 12n
  44 A pointer to the  device information structure for this device.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fIprop_op\fR\fR
  51 .ad
  52 .RS 12n
  53 Property operator. Valid operators are:
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBPROP_LEN\fR \fR
  58 .ad
  59 .RS 26n
  60 Get property length only. (\fIvaluep\fR unaffected).
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fB\fBPROP_LEN_AND_VAL_BUF\fR\fR
  67 .ad
  68 .RS 26n
  69 Get length and value into caller's buffer. (\fIvaluep\fR used as input).
  70 .RE
  71
  72 .sp
  73 .ne 2
  74 .na
  75 \fB\fBPROP_LEN_AND_VAL_ALLOC\fR\fR
  76 .ad
  77 .RS 26n
  78 Get length and value into allocated buffer. (\fIvaluep\fR returned as pointer
  79 to pointer to allocated buffer).
  80 .RE
  81
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fIflags\fR\fR
  88 .ad
  89 .RS 12n
  90 The only possible flag value is:
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBDDI_PROP_DONTPASS\fR\fR
  95 .ad
  96 .RS 21n
  97 Do not pass request to parent if property not found.
  98 .RE
  99
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fIname\fR\fR
 106 .ad
 107 .RS 12n
 108 Pointer to name of property to be interrogated.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fIvaluep\fR \fR
 115 .ad
 116 .RS 12n
 117 If  \fIprop_op\fR is  \fBPROP_LEN_AND_VAL_BUF\fR, this should be a pointer to
 118 the user's buffer.  If \fIprop_op\fR is \fBPROP_LEN_AND_VAL_ALLOC\fR, this
 119 should be the \fIaddress\fR of a pointer.
 120 .RE
 121
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fIlengthp\fR \fR
 126 .ad
 127 .RS 12n
 128 On exit,  *\fIlengthp\fR will contain the property length.  If \fIprop_op\fR is
 129 \fBPROP_LEN_AND_VAL_BUF\fR then \fIlengthp\fR should point to an \fBint\fR that
 130 contains the length of caller's buffer,  before calling \fBprop_op()\fR.
 131 .RE
 132
 133 .SH DESCRIPTION
 134 .sp
 135 .LP
 136 \fBprop_op()\fR is an entry point which reports the values of certain
 137 properties of the driver or device to the system. Each driver must have a
 138 \fIprefix\fR \fBprop_op\fR entry point, but most drivers that do not need to
 139 create or manage their own properties can use \fBddi_prop_op()\fR for this
 140 entry point.  Then the driver can use \fBddi_prop_update\fR(9F) to create
 141 properties for its device.
 142 .SH RETURN VALUES
 143 .sp
 144 .LP
 145 \fBprop_op()\fR should return:
 146 .sp
 147 .ne 2
 148 .na
 149 \fB\fBDDI_PROP_SUCCESS\fR \fR
 150 .ad
 151 .RS 27n
 152 Property found and returned.
 153 .RE
 154
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fBDDI_PROP_NOT_FOUND\fR \fR
 159 .ad
 160 .RS 27n
 161 Property not found.
 162 .RE
 163
 164 .sp
 165 .ne 2
 166 .na
 167 \fB\fBDDI_PROP_UNDEFINED\fR \fR
 168 .ad
 169 .RS 27n
 170 Prop explicitly undefined.
 171 .RE
 172
 173 .sp
 174 .ne 2
 175 .na
 176 \fB\fBDDI_PROP_NO_MEMORY\fR \fR
 177 .ad
 178 .RS 27n
 179 Property found, but unable to allocate memory. \fIlengthp\fR has the correct
 180 property length.
 181 .RE
 182
 183 .sp
 184 .ne 2
 185 .na
 186 \fB\fBDDI_PROP_BUF_TOO_SMALL\fR \fR
 187 .ad
 188 .RS 27n
 189 Property found, but the supplied buffer is too small. \fIlengthp\fR has the
 190 correct property length.
 191 .RE
 192
 193 .SH EXAMPLES
 194 .LP
 195 \fBExample 1 \fRUsing \fBprop_op()\fR to Report Property Information
 196 .sp
 197 .LP
 198 In the following example, \fBprop_op()\fR intercepts requests for the
 199 \fItemperature\fR property. The driver tracks changes to \fItemperature\fR
 200 using a variable in the state structure in order to avoid frequent calls to
 201 \fBddi_prop_update\fR(9F). The \fItemperature\fR property is only updated when
 202 a request is made for this property.  It then uses the system routine
 203 \fBddi_prop_op\fR(9F) to process the property request.  If the property request
 204 is not specific to a device, the driver does not intercept the request. This is
 205 indicated when the value of the  \fIdev\fR parameter is equal to
 206 \fBDDI_DEV_T_ANY\fR.
 207
 208 .sp
 209 .in +2
 210 .nf
 211 int temperature;        /* current device temperature */
 212  .
 213  .
 214  .
 215 static int
 216 xxprop_op(dev_t dev, dev_info_t *dip, ddi_prop_op_t prop_op,
 217      int flags, char *name, caddr_t valuep, int *lengthp)
 218 {
 219                         int  instance;
 220                         struct xxstate *xsp;
 221      if (dev == DDI_DEV_T_ANY)
 222                                 goto skip;
 223      instance = getminor(dev);
 224      xsp = ddi_get_soft_state(statep, instance);
 225      if (xsp == NULL)
 226                                 return (DDI_PROP_NOT_FOUND);
 227      if (strcmp(name, "temperature") == 0) {
 228                                 ddi_prop_update_int(dev, dip,\e
 229            "temperature", temperature);
 230      }
 231                        /*       other cases...  */
 232      skip:
 233      return (ddi_prop_op(dev, dip, prop_op, flags,\e
 234              name, valuep, lengthp));
 235 }
 236 .fi
 237 .in -2
 238
 239 .SH SEE ALSO
 240 .sp
 241 .LP
 242 \fBIntro\fR(9E), \fBddi_prop_op\fR(9F), \fBddi_prop_update\fR(9F)
 243 .sp
 244 .LP
 245 \fIWriting Device Drivers\fR