man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: July 2014
 
 

di_prom_prop_lookup_ints(3DEVINFO)

Name

di_prom_prop_lookup_bytes, di_prom_prop_lookup_ints, di_prom_prop_lookup_strings - search for a PROM property

Synopsis

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

int di_prom_prop_lookup_bytes(di_prom_handle_t ph, di_node_t node,
     const char *prop_name, uchar_t **prop_data);
int di_prom_prop_lookup_ints(di_prom_handle_t ph, di_node_t node,
     const char *prop_name, int **prop_data);
int di_prom_prop_lookup_strings(di_prom_handle_t ph, di_node_t node,
     const char *prop_name, char **prop_data);

Parameters

node

Handle to device node in snapshot created by di_init(3DEVINFO).

ph

Handle returned by di_prom_init(3DEVINFO).

prop_data

For di_prom_prop_lookup_bytes(), the address of a pointer to an array of unsigned characters.

For di_prom_prop_lookup_ints(), the address of a pointer to an integer.

For di_prom_prop_lookup_strings(), the address of pointer to a buffer.

prop_name

The name of the property being searched.

Description

These functions return the value of a known PROM property name and value type and update the prop_data pointer to reference memory that contains the property value. All memory allocated by these functions is managed by the library and must not be freed by the caller.

Return Values

If the property is found, the number of entries in prop_data is returned. If the property is a boolean type, 0 is returned and the existence of this property indicates the value is true. Otherwise, -1 is returned and errno is set to indicate the error.

For di_prom_prop_lookup_bytes(), the number of entries is the number of unsigned characters contained in the buffer pointed to by prop_data.

For di_prom_prop_lookup_ints(), the number of entries is the number of integers contained in the buffer pointed to by prop_data.

For di_prom_prop_lookup_strings(), the number of entries is the number of null-terminated strings contained in the buffer. The strings are stored in a concatenated format in the buffer.

Errors

These functions will fail if::

EINVAL

Invalid argument.

ENXIO

The property does not exist.

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Interface Stability
Committed
MT-Level
Safe

See Also

di_init(3DEVINFO), di_prom_prop_next(3DEVINFO), libdevinfo(3LIB), attributes(5), openprom(7D)

Writing Device Drivers for Oracle Solaris 11.2