share/man/man3devinfo/di_prom_init.3devinfo

   1 '\" te
   2 .\" Copyright (c) 1998, 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_PROM_INIT 3DEVINFO "Dec 1, 1998"
   7 .SH NAME
   8 di_prom_init, di_prom_fini \- create and destroy a handle to the PROM device
   9 information
  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 \fBdi_prom_handle_t\fR \fBdi_prom_init\fR(\fBvoid\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBvoid\fR \fBdi_prom_fini\fR(\fBdi_prom_handle_t\fR  \fIph\fR);
  22 .fi
  23
  24 .SH PARAMETERS
  25 .sp
  26 .ne 2
  27 .na
  28 \fB\fIph\fR\fR
  29 .ad
  30 .RS 6n
  31 Handle to \fBprom\fR returned by \fBdi_prom_init()\fR.
  32 .RE
  33
  34 .SH DESCRIPTION
  35 .sp
  36 .LP
  37 For device nodes whose \fBnodeid\fR value is \fBDI_PROM_NODEID\fR (see
  38 \fBdi_nodeid\fR(3DEVINFO)), additional properties can be retrieved from the
  39 \fBPROM\fR. The \fBdi_prom_init()\fR function returns a handle that is used to
  40 retrieve such properties. This handle is passed to
  41 \fBdi_prom_prop_lookup_bytes\fR(3DEVINFO) and
  42 \fBdi_prom_prop_next\fR(3DEVINFO).
  43 .sp
  44 .LP
  45 The \fBdi_prom_fini()\fR function destroys the handle  and all handles to the
  46 \fBPROM\fR device information obtained from that handle.
  47 .SH RETURN VALUES
  48 .sp
  49 .LP
  50 Upon successful completion, \fBdi_prom_init()\fR returns a handle. Otherwise,
  51 \fBDI_PROM_HANDLE_NIL\fR is returned and \fBerrno\fR is set to indicate the
  52 error.
  53 .SH ERRORS
  54 .sp
  55 .LP
  56 The \fBdi_prom_init()\fR sets \fBerrno\fR function to any error code that can
  57 also be set by \fBopenprom\fR(7D) or \fBmalloc\fR(3C).
  58 .SH ATTRIBUTES
  59 .sp
  60 .LP
  61 See \fBattributes\fR(5)  for descriptions of the following attributes:
  62 .sp
  63
  64 .sp
  65 .TS
  66 box;
  67 c | c
  68 l | l .
  69 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  70 _
  71 Interface Stability     Evolving
  72 _
  73 MT-Level        Safe
  74 .TE
  75
  76 .SH SEE ALSO
  77 .sp
  78 .LP
  79 \fBdi_nodeid\fR(3DEVINFO), \fBdi_prom_prop_next\fR(3DEVINFO),
  80 \fBdi_prom_prop_lookup_bytes\fR(3DEVINFO), \fBlibdevinfo\fR(3LIB),
  81 \fBmalloc\fR(3C), \fBattributes\fR(5), \fBopenprom\fR(7D)