1quiesce(9E) Driver Entry Points quiesce(9E)
2
6 quiesce - quiesce a device
7
9 #include <sys/ddi.h>
10 #include <sys/sunddi.h>
11 int prefixquiesce(dev_info_t *dip);
13 int ddi_quiesce_not_needed(dev_info_t *dip);
16
19 Solaris DDI specific (Solaris DDI)
20
22 dip A pointer to the device's dev_info structure.
23
26 The quiesce() function quiesces a device so that the device no longer
27 generates interrupts, modifies or accesses memory. The driver should
28 reset the device to a hardware state from which the device can be cor‐
29 rectly configured by the driver's attach() routine without a system
30 power cycle or being configured by the firmware. For devices with a
31 defined reset state configuration, the driver should return that device
32 to that state as part of the quiesce operation. Fast Reboot, where
33 firmware is bypassed when booting to a new OS image, is such a case.
34 quiesce() is only called for an attached device instance as one of the
37 final operations of a reboot sequence, and no other thread can be
38 active for this device. The system guarantees that no other driver
39 entry point is active or invoked while quiesce() is invoked. The system
40 also guarantees that no timeout or taskq is invoked. The system is sin‐
41 gle-threaded and can not be interrupted. Therefore, the driver's qui‐
42 esce() implementation must not use locks or timeouts, or rely on them
43 being called. The driver must discard all outstanding I/O instead of
44 waiting for completion. At the conclusion of the quiesce() operation,
45 the driver must guarantee that the device no longer has access to mem‐
46 ory or interrupts.
47 The only DDI interfaces that can be called by the quiesce() implementa‐
50 tion are non-blocking functions, such as the ddi_get*() and ddi_put*()
51 functions.
52 If quiesce() determines a particular instance of the device cannot be
55 quiesced when requested because of some exceptional condition, qui‐
56 esce() returns DDI_FAILURE. This rarely happens.
57 If a driver has previously implemented the obsolete reset() interface,
60 its functionality must be merged into quiesce(). The driver's reset()
61 routine is no longer called if an implementation of quiesce() is
62 present.
63 ddi_quiesce_not_needed() always returns DDI_SUCCESS. A driver can set
66 its devo_quiesce device function to ddi_quiesce_not_needed() to indi‐
67 cate that the device it manages does not need to be quiesced.
68
70 quiesce() returns the following:
71 DDI_SUCCESS The device has been successfully quiesced.
73 DDI_FAILURE The operation failed.
76
79 This function is called from kernel context only.
80
82 reboot(1M), uadmin(1M), uadmin(2), attach(9E), detach(9E),
83 ddi_add_intr(9F), ddi_map_regs(9F), pci_config_setup(9F), timeout(9F),
84 dev_ops(9S)
85
87 When quiesce() is called, the system is single-threaded, therefore the
88 driver's quiesce() implementation must not be blocked. For example, the
89 implementation must not create or tear down mappings, call FMA func‐
90 tions, or create or cancel callbacks.
91SunOS 5.11 16 Sep 2008 quiesce(9E)