freebsd-skq/share/man/man9/device_get_state.9

.\" -*- nroff -*-
.\"
.\" Copyright (c) 1998 Doug Rabson
.\"
.\" All rights reserved.
.\"
.\" This program is free software.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd June 16, 1998
.Dt DEVICE_GET_STATE 9
.Os
.Sh NAME
.Nm device_get_state ,
.Nm device_busy ,
.Nm device_unbusy ,
.Nm device_is_alive ,
.Nm device_is_attached
.Nd manipulate device state
.Sh SYNOPSIS
.In sys/param.h
.In sys/bus.h
.Ft device_state_t
.Fn device_get_state "device_t dev"
.Ft void
.Fn device_busy "device_t dev"
.Ft void
.Fn device_unbusy "device_t dev"
.Ft int
.Fn device_is_alive "device_t dev"
.Ft int
.Fn device_is_attached "device_t dev"
.Sh DESCRIPTION
The current state of a device is accessed by calling
.Fn device_get_state
which returns
.Dv DS_NOTPRESENT ,
.Dv DS_ALIVE ,
.Dv DS_ATTACHED
or
.Dv DS_BUSY
(described in
.Xr device 9 ) .
To test see if a device was successfully probed, call
.Fn device_is_alive
which simply returns if the state is greater or equal to
.Dv DS_ALIVE .
To test see if a device was successfully attached, call
.Fn device_is_attached
which simply returns if the state is greater or equal to
.Dv DS_ATTACHED .
.Pp
Each device has a busy count which is incremented when
.Fn device_busy
is called and decremented when
.Fn device_unbusy
is called.
Both routines return an error if the device state is less than
.Dv DS_ATTACHED .
.Pp
When
.Fn device_busy
is called on a device in the
.Dv DS_ATTACHED
state, the device changes to the
.Dv DS_BUSY
state.
When
.Fn device_unbusy
is called and after decrementing, the busy count for the device is
zero, the device changes to the
.Dv DS_ATTACHED
state.
.Sh SEE ALSO
.Xr device 9
.Sh AUTHORS
This manual page was written by
.An Doug Rabson .
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`.\" -- nroff --`
			`.\"`
			`.\" Copyright (c) 1998 Doug Rabson`
			`.\"`
			`.\" All rights reserved.`
			`.\"`
			`.\" This program is free software.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
			`.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES`
			`.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.`
			`.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,`
			`.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT`
			`.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,`
			`.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY`
			`.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT`
			`.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF`
			`.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`.\"`
			`.Dd June 16, 1998`
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 10:48:36 +00:00			`.Dt DEVICE_GET_STATE 9`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00			`.Os`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`.Sh NAME`
			`.Nm device_get_state ,`
			`.Nm device_busy ,`
			`.Nm device_unbusy ,`
device_is_alive already was documented in device_get_state, so remove the separate man page. Document new device_is_attached there and remove that new man page too. Connect device_get_name to build, and install a link for device_get_nameunit. strangely nobody noticed this yet... 2003-04-22 00:21:28 +00:00			`.Nm device_is_alive ,`
			`.Nm device_is_attached`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`.Nd manipulate device state`
			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In sys/param.h`
			`.In sys/bus.h`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`.Ft device_state_t`
			`.Fn device_get_state "device_t dev"`
			`.Ft void`
			`.Fn device_busy "device_t dev"`
			`.Ft void`
			`.Fn device_unbusy "device_t dev"`
			`.Ft int`
			`.Fn device_is_alive "device_t dev"`
device_is_alive already was documented in device_get_state, so remove the separate man page. Document new device_is_attached there and remove that new man page too. Connect device_get_name to build, and install a link for device_get_nameunit. strangely nobody noticed this yet... 2003-04-22 00:21:28 +00:00			`.Ft int`
			`.Fn device_is_attached "device_t dev"`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`.Sh DESCRIPTION`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`The current state of a device is accessed by calling`
mdoc(7) police: Deal with self-xrefs. 2002-12-24 13:41:48 +00:00			`.Fn device_get_state`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`which returns`
			`.Dv DS_NOTPRESENT ,`
			`.Dv DS_ALIVE ,`
			`.Dv DS_ATTACHED`
			`or`
			`.Dv DS_BUSY`
			`(described in`
Prepare for mdoc(7)NG. 2001-01-16 09:32:40 +00:00			`.Xr device 9 ) .`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`To test see if a device was successfully probed, call`
mdoc(7) police: Deal with self-xrefs. 2002-12-24 13:41:48 +00:00			`.Fn device_is_alive`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`which simply returns if the state is greater or equal to`
			`.Dv DS_ALIVE .`
device_is_alive already was documented in device_get_state, so remove the separate man page. Document new device_is_attached there and remove that new man page too. Connect device_get_name to build, and install a link for device_get_nameunit. strangely nobody noticed this yet... 2003-04-22 00:21:28 +00:00			`To test see if a device was successfully attached, call`
			`.Fn device_is_attached`
			`which simply returns if the state is greater or equal to`
			`.Dv DS_ATTACHED .`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`.Pp`
			`Each device has a busy count which is incremented when`
mdoc(7) police: Deal with self-xrefs. 2002-12-24 13:41:48 +00:00			`.Fn device_busy`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`is called and decremented when`
mdoc(7) police: Deal with self-xrefs. 2002-12-24 13:41:48 +00:00			`.Fn device_unbusy`
Mdoc Janitor: * Fix hard sentence breaks. * NOTE: devstat(9) requires more mdoc(7) work. 2003-10-23 01:54:06 +00:00			`is called.`
			`Both routines return an error if the device state is less than`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`.Dv DS_ATTACHED .`
			`.Pp`
			`When`
mdoc(7) police: Deal with self-xrefs. 2002-12-24 13:41:48 +00:00			`.Fn device_busy`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`is called on a device in the`
			`.Dv DS_ATTACHED`
			`state, the device changes to the`
			`.Dv DS_BUSY`
			`state.`
			`When`
mdoc(7) police: Deal with self-xrefs. 2002-12-24 13:41:48 +00:00			`.Fn device_unbusy`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`is called and after decrementing, the busy count for the device is`
			`zero, the device changes to the`
			`.Dv DS_ATTACHED`
			`state.`
			`.Sh SEE ALSO`
			`.Xr device 9`
			`.Sh AUTHORS`
Mdoc Janitor: * Use 'manual' instead of 'man' for consistency. 2003-10-23 06:24:55 +00:00			`This manual page was written by`
Add manpages for the new device framework. 1998-09-03 21:52:05 +00:00			`.An Doug Rabson .`