xref: /illumos-gate/usr/src/man/man3devinfo/di_prom_init.3devinfo (revision 2bbdd445a21f9d61f4a0ca0faf05d5ceb2bd91f3)
te
Copyright (c) 1998, Sun Microsystems, Inc. All Rights Reserved
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.
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.
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]
DI_PROM_INIT 3DEVINFO "Dec 1, 1998"
NAME
di_prom_init, di_prom_fini - create and destroy a handle to the PROM device information
SYNOPSIS

cc [ flag... ] file... -ldevinfo [ library... ]
#include <libdevinfo.h>

di_prom_handle_t di_prom_init(void);

void di_prom_fini(di_prom_handle_t ph);
PARAMETERS
ph

Handle to prom returned by di_prom_init().

DESCRIPTION

For device nodes whose nodeid value is DI_PROM_NODEID (see di_nodeid(3DEVINFO)), additional properties can be retrieved from the PROM. The di_prom_init() function returns a handle that is used to retrieve such properties. This handle is passed to di_prom_prop_lookup_bytes(3DEVINFO) and di_prom_prop_next(3DEVINFO).

The di_prom_fini() function destroys the handle and all handles to the PROM device information obtained from that handle.

RETURN VALUES

Upon successful completion, di_prom_init() returns a handle. Otherwise, DI_PROM_HANDLE_NIL is returned and errno is set to indicate the error.

ERRORS

The di_prom_init() sets errno function to any error code that can also be set by openprom(7D) or malloc(3C).

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Evolving
MT-Level Safe
SEE ALSO

di_nodeid(3DEVINFO), di_prom_prop_next(3DEVINFO), di_prom_prop_lookup_bytes(3DEVINFO), libdevinfo(3LIB), malloc(3C), attributes(5), openprom(7D)