xref: /illumos-gate/usr/src/man/man9p/removable-media.9p (revision 09fbbb7d1b5a956a9b81304070dcff318a4a158e)
te
Copyright (c) 2001, 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]
REMOVABLE-MEDIA 9P "Jun 15, 2001"
NAME
removable-media - removable media device property
DESCRIPTION

A device that supports removable media\(emsuch as CDROM, JAZZ, and ZIP drives\(emand that supports power management and expects automatic mounting of the device via the volume manager should export the boolean (zero length) property removable-media. This property enables the system to make the power state of the device dependent on the power state of the frame buffer and monitor. See the power.conf(5) discussion of the device-dependency-property entry for more information.

Devices that behave like removable devices (such as PC ATA cards, where the controller and media both are removed at the same time) should also export this property.

EXAMPLES

Example 1 removable-media Entry

An example of a removable-media entry from the .conf file of a driver is shown below.

# This entry keeps removable media from being powered down unless
# the console framebuffer and monitor are powered down
#
removable-media=1;

Example 2 Implementation in attach()

Below is an example of how the entry above would be implemented in the attach(9E) function of the driver.

xxattach(dev_info_t *dip, ddi_attach_cmd_t cmd)
 {
 ...
 if (ddi_prop_create(DDI_DEV_T_NONE, dip, DDI_PROP_CANSLEEP,
 "removable-media", NULL, 0)) != DDI_PROP_SUCCESS)
 goto failed;
 ...
 }
ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface stability Committed
SEE ALSO

pm (4D), power.conf (5), attach (9E), detach (9E), ddi_prop_create (9F)

Writing Device Drivers