usr/src/man/man3devinfo/di_prop_lookup_bytes.3devinfo

   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 DI_PROP_LOOKUP_BYTES 3DEVINFO "Mar 26, 2001"
   7 .SH NAME
   8 di_prop_lookup_bytes, di_prop_lookup_ints, di_prop_lookup_int64,
   9 di_prop_lookup_strings \- search for a property
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-ldevinfo\fR [ \fIlibrary\fR... ]
  14 #include <libdevinfo.h>
  15
  16 \fBint\fR \fBdi_prop_lookup_bytes\fR(\fBdev_t\fR \fIdev\fR, \fBdi_node_t\fR \fInode\fR,
  17      \fBconst char *\fR\fIprop_name\fR, \fBuchar_t **\fR\fIprop_data\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBint\fR \fBdi_prop_lookup_ints\fR(\fBdev_t\fR \fIdev\fR, \fBdi_node_t\fR \fInode\fR,
  23      \fBconst char *\fR\fIprop_name\fR, \fBint **\fR\fIprop_data\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBint\fR \fBdi_prop_lookup_int64\fR(\fBdev_t\fR \fIdev\fR, \fBdi_node_t\fR \fInode\fR,
  29      \fBconst char *\fR\fIprop_name\fR, \fBint64_t **\fR\fIprop_data\fR);
  30 .fi
  31
  32 .LP
  33 .nf
  34 \fBint\fR \fBdi_prop_lookup_strings\fR(\fBdev_t\fR \fIdev\fR, \fBdi_node_t\fR \fInode\fR,
  35      \fBconst char *\fR\fIprop_name\fR, \fBchar **\fR\fIprop_data\fR);
  36 .fi
  37
  38 .SH PARAMETERS
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIdev\fR\fR
  43 .ad
  44 .RS 13n
  45 \fBdev_t\fR of minor node with which the property is associated.
  46 \fBDDI_DEV_T_ANY\fR is a wild card that matches all \fBdev_t\fR's, including
  47 \fBDDI_DEV_T_NONE\fR.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fInode\fR\fR
  54 .ad
  55 .RS 13n
  56 Handle to the device node with which the property is associated.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fIprop_data\fR\fR
  63 .ad
  64 .RS 13n
  65 For \fBdi_prop_lookup_bytes()\fR, the address to a pointer to an array of
  66 unsigned characters containing the property data.
  67 .sp
  68 For \fBdi_prop_lookup_ints()\fR, the address to a pointer to an array of
  69 integers containing the property data.
  70 .sp
  71 For \fBdi_prop_lookup_int64()\fR, the address to a pointer to an array of
  72 64-bit integers containing the property data.
  73 .sp
  74 For \fBdi_prop_lookup_strings()\fR, the address to a pointer to a buffer
  75 containing a concatenation of null-terminated strings containing the property
  76 data.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fIprop_name\fR\fR
  83 .ad
  84 .RS 13n
  85 Name of the property for which to search.
  86 .RE
  87
  88 .SH DESCRIPTION
  89 .sp
  90 .LP
  91 These functions return the value of a known property name type and \fBdev_t\fR
  92 value. All memory allocated by these functions is managed by the library and
  93 must not be freed by the caller.
  94 .SH RETURN VALUES
  95 .sp
  96 .LP
  97 If the property is found, the number of entries in \fIprop_data\fR is returned.
  98 If the property is a boolean type, 0 is returned and the existence of this
  99 property indicates the value is true. Otherwise, -1 is returned and \fIerrno\fR
 100 is set to indicate the error.
 101 .SH ERRORS
 102 .sp
 103 .LP
 104 These functions will fail if:
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBEINVAL\fR\fR
 109 .ad
 110 .RS 11n
 111 Invalid argument.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fBENOTSUP\fR\fR
 118 .ad
 119 .RS 11n
 120 The snapshot contains no property information.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBENXIO\fR\fR
 127 .ad
 128 .RS 11n
 129 The property does not exist; try \fBdi_prom_prop_lookup_*()\fR.
 130 .RE
 131
 132 .SH ATTRIBUTES
 133 .sp
 134 .LP
 135 See \fBattributes\fR(5) for descriptions of the following attributes:
 136 .sp
 137
 138 .sp
 139 .TS
 140 box;
 141 c | c
 142 l | l .
 143 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 144 _
 145 Interface Stability     Evolving
 146 _
 147 MT-Level        Safe
 148 .TE
 149
 150 .SH SEE ALSO
 151 .sp
 152 .LP
 153 \fBdi_init\fR(3DEVINFO), \fBdi_prom_prop_lookup_bytes\fR(3DEVINFO),
 154 \fBlibdevinfo\fR(3LIB), \fBattributes\fR(5)
 155 .sp
 156 .LP
 157 \fIWriting Device Drivers\fR