ddi_prop_get_int man page on SmartOS

Man page or keyword search:  
man Server   16655 pages
apropos Keyword Search (all sections)
Output format
SmartOS logo
[printable version]


       ddi_prop_get_int, ddi_prop_get_int64 - lookup integer property

       #include <sys/ddi.h>
       #include <sys/sunddi.h>

       int ddi_prop_get_int(dev_t match_dev, dev_info_t *dip, uint_t flags,
	    char *name, int defvalue);

       int64_t ddi_prop_get_int64(dev_t match_dev, dev_info_t *dip, uint_t flags,
	    char *name, int64_t defvalue);

		    Device number associated with property or DDI_DEV_T_ANY.

		    Pointer  to	 the device info node of device whose property
		    list should be searched.

		    Possible flag values are some combination of:

					 Do not pass request to parent	device
					 information   node  if	 property  not

					 Do  not  look	at   PROM   properties
					 (ignored  on  platforms  that	do not
					 support PROM properties).

		    String containing the name of the property.

		    An integer value that is returned if the  property	cannot
		    be found.

       Solaris DDI specific (Solaris DDI).

       The ddi_prop_get_int() and ddi_prop_get_int64() functions search for an
       integer property and, if found, returns the value of the property.

       Properties are searched for based on the dip, name, match_dev, and  the
       type of the data (integer). The property search order is as follows:

	   1.	  Search software properties created by the driver.

	   2.	  Search  the  software	 properties  created by the system (or
		  nexus nodes in the device info tree).

	   3.	  Search the driver global properties list.

	   4.	  If DDI_PROP_NOTPROM is not set, search the  PROM  properties
		  (if they exist).

	   5.	  If  DDI_PROP_DONTPASS	 is  not set, pass this request to the
		  parent device information node.

	   6.	  Return defvalue.

       Usually, the match_dev argument should be set to the actual device num‐
       ber  that  this	property is associated with. However, if the match_dev
       argument	   is	 DDI_DEV_T_ANY,	   then	    ddi_prop_get_int()	   and
       ddi_prop_get_int()  will	 match the request regardless of the match_dev
       the property was created with. If a property was created with match_dev
       set  to	DDI_DEV_T_NONE,	 then the only way to look up this property is
       with a match_dev set to DDI_DEV_T_ANY. PROM properties are always  cre‐
       ated with match_dev set to DDI_DEV_T_NONE.

       name must always be set to the name of the property being looked up.

       The  return  value  of the routine is the value of the property. If the
       property is not found, the argument defvalue is returned as  the	 value
       of the property.

       ddi_prop_get_int64()  will not search the PROM for 64-bit property val‐

       ddi_prop_get_int() and ddi_prop_get_int64() return  the	value  of  the
       property.  If  the  property  is	 not  found,  the argument defvalue is
       returned. If the property is found, but cannot be decoded into  an  int
       or an int64, then DDI_PROP_NOT_FOUND is returned.

       ddi_prop_get_int()  and ddi_prop_get_int64() can be called from user or
       kernel context.

       Example 1 Using ddi_prop_get_int()

       The following example demonstrates the use of ddi_prop_get_int().

	      * Get the value of the integer "width" property, using
	      * our own default if no such property exists
	      width = ddi_prop_get_int(xx_dev, xx_dip, 0, "width",

       ddi_prop_exists(9F),	ddi_prop_lookup(9F),	  ddi_prop_remove(9F),

       Writing Device Drivers

				 Aug 25, 2001		  DDI_PROP_GET_INT(9F)

List of man pages available for SmartOS

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
Vote for polarhome
Free Shell Accounts :: the biggest list on the net