summaryrefslogtreecommitdiffstats
path: root/sys/kern/device_if.m
diff options
context:
space:
mode:
authorimp <imp@FreeBSD.org>2004-08-12 17:26:22 +0000
committerimp <imp@FreeBSD.org>2004-08-12 17:26:22 +0000
commit482740a238b6b7d0f1c649d1d3391e801547f668 (patch)
treeefd693da64d811d48cb18fda0a04b3619a3b1c43 /sys/kern/device_if.m
parent09c41336ae891508da0d990920e3395aaeb66a6c (diff)
downloadFreeBSD-src-482740a238b6b7d0f1c649d1d3391e801547f668.zip
FreeBSD-src-482740a238b6b7d0f1c649d1d3391e801547f668.tar.gz
Minor formatting fixes for lines > 80 characters
Diffstat (limited to 'sys/kern/device_if.m')
-rw-r--r--sys/kern/device_if.m45
1 files changed, 23 insertions, 22 deletions
diff --git a/sys/kern/device_if.m b/sys/kern/device_if.m
index 6507150..8b97f4e 100644
--- a/sys/kern/device_if.m
+++ b/sys/kern/device_if.m
@@ -1,5 +1,5 @@
#
-# Copyright (c) 1998,2004 Doug Rabson
+# Copyright (c) 1998-2004 Doug Rabson
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
@@ -135,18 +135,19 @@ METHOD int probe {
};
/**
- * @brief Called by a parent device to allow drivers to add new devices to the parent.
- *
- * The DEVICE_IDENTIFY() method is used by some drivers (e.g. the ISA bus driver)
- * to help populate the bus device with a useful set of child devices, normally by
- * calling the BUS_ADD_CHILD() method of the parent device. For instance,
- * the ISA bus driver uses several special drivers, including the isahint driver and
- * the pnp driver to create child devices based on configuration hints and PnP bus
+ * @brief Allow a device driver to detect devices not otherwise enumerated.
+ *
+ * The DEVICE_IDENTIFY() method is used by some drivers (e.g. the ISA
+ * bus driver) to help populate the bus device with a useful set of
+ * child devices, normally by calling the BUS_ADD_CHILD() method of
+ * the parent device. For instance, the ISA bus driver uses several
+ * special drivers, including the isahint driver and the pnp driver to
+ * create child devices based on configuration hints and PnP bus
* probes respectively.
*
- * Many bus drivers which support true plug-and-play do not need to use this method
- * at all since child devices can be discovered automatically without help from
- * child drivers.
+ * Many bus drivers which support true plug-and-play do not need to
+ * use this method at all since child devices can be discovered
+ * automatically without help from child drivers.
*
* To include this method in a device driver, use a line like this
* in the driver's method list:
@@ -235,15 +236,15 @@ METHOD int shutdown {
} DEFAULT null_shutdown;
/**
- * @brief This is called by the power-management subsystem when a suspend has been
- * requested by the user or by some automatic mechanism.
+ * @brief This is called by the power-management subsystem when a
+ * suspend has been requested by the user or by some automatic
+ * mechanism.
*
- * This gives
- * drivers a chance to veto the suspend or save their configuration before
- * power is removed.
+ * This gives drivers a chance to veto the suspend or save their
+ * configuration before power is removed.
*
- * To include this method in a device driver, use a line like this
- * in the driver's method list:
+ * To include this method in a device driver, use a line like this in
+ * the driver's method list:
*
* @code
* KOBJMETHOD(device_suspend, foo_suspend)
@@ -252,8 +253,8 @@ METHOD int shutdown {
* @param dev the device being suspended
*
* @retval 0 success
- * @retval non-zero an error occurred while attempting to prepare the device
- * for suspension
+ * @retval non-zero an error occurred while attempting to prepare the
+ * device for suspension
*
* @see DEVICE_RESUME()
*/
@@ -274,8 +275,8 @@ METHOD int suspend {
* @param dev the device being resumed
*
* @retval 0 success
- * @retval non-zero an error occurred while attempting to restore the device
- * from suspension
+ * @retval non-zero an error occurred while attempting to restore the
+ * device from suspension
*
* @see DEVICE_SUSPEND()
*/
OpenPOWER on IntegriCloud