attach man page on SmartOS

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

ATTACH(9E)							    ATTACH(9E)

       attach - Attach a device to the system, or resume it

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

       int prefixattach(dev_info_t *dip, ddi_attach_cmd_t cmd);

       Solaris DDI specific (Solaris DDI)

	      A pointer to the device's dev_info structure.

	      Attach  type.  Possible  values  are  DDI_ATTACH and DDI_RESUME.
	      Other values are reserved. The driver must return DDI_FAILURE if
	      reserved values are passed to it.

       The  attach(9E)	function  is  the device-specific initialization entry
       point. This entry point is required and must be written.

       The DDI_ATTACH command must be provided in the attach(9E) entry	point.
       DDI_ATTACH  is  used  to	 initialize  a	given  device  instance.  When
       attach(9E) is called with cmd set to DDI_ATTACH, all normal kernel ser‐
       vices  (such  as	 kmem_alloc(9F))  are available for use by the driver.
       Device interrupts are not blocked when attaching a device to  the  sys‐

       The  attach(9E) function is called once for each instance of the device
       on the system with cmd set to DDI_ATTACH.  Until	 attach(9E)  succeeds,
       the  only  driver  entry point which may be called is getinfo(9E).  See
       the Writing Device Drivers for more information.	 The  instance	number
       may be obtained using ddi_get_instance(9F).

       At attach time, all components of a power-manageable device are assumed
       to be at unknown levels. Before using the device, the driver  needs  to
       bring   the   required	component(s)  to  a  known  power  level.  The
       pm_raise_power(9F) function can be used to set the  power  level	 of  a
       component. This function must not be called before data structures ref‐
       erenced in power(9E) have been initialized.

       The attach() function may be called with cmd set	 to  DDI_RESUME	 after
       detach(9E) has been successfully called with cmd set to DDI_SUSPEND.

       When called with cmd set to DDI_RESUME, attach() must restore the hard‐
       ware state of a device (power may have been removed from	 the  device),
       allow  pending  requests to continue, and service new requests. In this
       case, the driver must not make any assumptions about the state  of  the
       hardware, but must restore the state of the device except for the power
       level of components.

       If the device driver uses the automatic device Power Management	inter‐
       faces  (driver  exports the pm-components(9P) property), the Power Man‐
       agement framework sets its notion of the power level of each  component
       of a device to unknown while processing a DDI_RESUME command.

       The  driver  can	 deal  with components during DDI_RESUME in one of the
       following ways:

	   1.	  If the driver can determine the power level of the component
		  without  having  to  power  it  up  (for example, by calling
		  ddi_peek(9F) or some other device-specific method)  then  it
		  should  notify  the  power level to the framework by calling

	   2.	  The driver must also set its own notion of the  power	 level
		  of  the  component  to unknown. The system will consider the
		  component idle or busy based on  the	most  recent  call  to
		  pm_idle_component(9F) or pm_busy_component(9F) for that com‐
		  ponent. If the component is idle for	sufficient  time,  the
		  framework  will call into the driver's power(9E) entry point
		  to turn the component off. If the driver needs to access the
		  device,  then	 it  must call pm_raise_power(9F) to bring the
		  component up to the level needed for the  device  access  to
		  succeed.  The driver must honor any request to set the power
		  level of the component, since it cannot make any  assumption
		  about	 what power level the component has (or it should have
		  called pm_power_has_changed(9F) as  outlined	above).	 As  a
		  special  case of this, the driver may bring the component to
		  a known state because it wants to perform  an	 operation  on
		  the  device  as  part	 of its DDI_RESUME processing (such as
		  loading firmware so that it can detect hot-plug events).

       The attach() function returns:

		      Successful completion

		      Operation failed

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

       │Interface Stability │ Committed	      │

       cpr(7), pm(7D),	pm(9P),	 pm-components(9P),  detach(9E),  getinfo(9E),
       identify(9E),   open(9E),   power(9E),	probe(9E),   ddi_add_intr(9F),
       ddi_create_minor_node(9F),   ddi_get_instance(9F),    ddi_map_regs(9F),
       kmem_alloc(9F), pm_raise_power(9F)

       Writing Device Drivers

				  Jan 7, 2004			    ATTACH(9E)

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