xref: /illumos-gate/usr/src/man/man3devinfo/di_prom_prop_data.3devinfo (revision 05ede3db5e3b7d540afbccdc872c735770e82ef3)
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_PROP_DATA 3DEVINFO "Dec 1, 1998"
NAME
di_prom_prop_data, di_prom_prop_next, di_prom_prop_name - access PROM device information
SYNOPSIS

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

di_prom_prop_t di_prom_prop_next(di_prom_handle_t ph, di_node_t node,
 di_prom_prop_t prom_prop);

char *di_prom_prop_name(di_prom_prop_t prom_prop);

int di_prom_prop_data(di_prom_prop_t prom_prop, uchar_t **prop_data);
PARAMETERS
node

Handle to a device node in the snapshot of kernel device tree.

ph

PROM handle

prom_prop

Handle to a PROM property.

prop_data

Address of a pointer.

DESCRIPTION

The di_prom_prop_next() function obtains a handle to the next property on the PROM property list associated with node. If prom_prop is DI_PROM_PROP_NIL, the first property associated with node is returned.

The di_prom_prop_name() function returns the name of the prom_prop property.

The di_prom_prop_data() function returns the value of the prom_prop property. The return value is a non-negative integer specifying the size in number of bytes in prop_data.

All memory allocated by these functions is managed by the library and must not be freed by the caller.

RETURN VALUES

The di_prom_prop_data() function returns the number of bytes in prop_data and prop_data is updated to point to a byte array containing the property value. If 0 is returned, the property is a boolean property and the existence of this property indicates the value is true.

The di_prom_prop_name() function returns a pointer to a string that contains the name of prom_prop.

The di_prom_prop_next() function returns a handle to the next PROM property. DI_PROM_PROP_NIL is returned if no additional properties exist.

ERRORS

See openprom(7D) for a description of possible errors.

ATTRIBUTES

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

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

attributes(5), openprom(7D)

Writing Device Drivers