svn commit: r247344 - in stable/9: share/man/man9 sys/kern

[John Baldwin]

Author: jhb
Date: Tue Feb 26 20:19:19 2013
New Revision: 247344
URL: http://svnweb.freebsd.org/changeset/base/247344

Log:
  MFC 239512:
  Add a BUS_CHILD_DELETED() method that a bus can hook to allow it to cleanup
  any bus-specific state (such as ivars) when a child device is deleted.

Added:
  stable/9/share/man/man9/BUS_CHILD_DELETED.9
     - copied unchanged from r239512, head/share/man/man9/BUS_CHILD_DELETED.9
Modified:
  stable/9/share/man/man9/Makefile
  stable/9/sys/kern/bus_if.m
  stable/9/sys/kern/subr_bus.c
Directory Properties:
  stable/9/share/man/man9/   (props changed)
  stable/9/sys/   (props changed)

Copied: stable/9/share/man/man9/BUS_CHILD_DELETED.9 (from r239512, head/share/man/man9/BUS_CHILD_DELETED.9)
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ stable/9/share/man/man9/BUS_CHILD_DELETED.9	Tue Feb 26 20:19:19 2013	(r247344, copy of r239512, head/share/man/man9/BUS_CHILD_DELETED.9)
@@ -0,0 +1,55 @@
+.\" -*- nroff -*-
+.\"
+.\" Copyright (c) 2012 Advanced Computing Technologies LLC
+.\" Written by: John H. Baldwin <jhb at FreeBSD.org>
+.\" All rights reserved.
+.\"
+.\" 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 AUTHOR AND CONTRIBUTORS ``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 AUTHOR OR CONTRIBUTORS 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 August 21, 2012
+.Dt BUS_CHILD_DELETED 9
+.Os
+.Sh NAME
+.Nm BUS_CHILD_DELETED
+.Nd "notify a bus device that a child is being deleted"
+.Sh SYNOPSIS
+.In sys/param.h
+.In sys/bus.h
+.Ft void
+.Fn BUS_CHILD_DELETED "device_t dev" "device_t child"
+.Sh DESCRIPTION
+The
+.Fn BUS_CHILD_DELETED
+method is invoked by the new-bus framework when a device is deleted.
+A bus driver can provide an implementation of this method to
+release bus-specific resources associated with a device such as
+instance variables.
+.Sh SEE ALSO
+.Xr BUS_ADD_CHILD 9 ,
+.Xr device 9
+.Sh HISTORY
+The
+.Fn BUS_CHILD_DELETED
+method first appeared in
+.Fx 10.0 .

Modified: stable/9/share/man/man9/Makefile
==============================================================================
--- stable/9/share/man/man9/Makefile	Tue Feb 26 20:18:25 2013	(r247343)
+++ stable/9/share/man/man9/Makefile	Tue Feb 26 20:19:19 2013	(r247344)
@@ -26,6 +26,7 @@ MAN=	accept_filter.9 \
 	bus_alloc_resource.9 \
 	BUS_BIND_INTR.9 \
 	bus_child_present.9 \
+	BUS_CHILD_DELETED.9 \
 	BUS_CONFIG_INTR.9 \
 	BUS_DESCRIBE_INTR.9 \
 	bus_dma.9 \

Modified: stable/9/sys/kern/bus_if.m
==============================================================================
--- stable/9/sys/kern/bus_if.m	Tue Feb 26 20:18:25 2013	(r247343)
+++ stable/9/sys/kern/bus_if.m	Tue Feb 26 20:19:19 2013	(r247344)
@@ -160,6 +160,20 @@ METHOD int write_ivar {
 };
 
 /**
+ * @brief Notify a bus that a child was deleted
+ *
+ * Called at the beginning of device_delete_child() to allow the parent
+ * to teardown any bus-specific state for the child.
+ * 
+ * @param _dev		the device whose child is being deleted
+ * @param _child	the child device which is being deleted
+ */
+METHOD void child_deleted {
+	device_t _dev;
+	device_t _child;
+};
+
+/**
  * @brief Notify a bus that a child was detached
  *
  * Called after the child's DEVICE_DETACH() method to allow the parent

Modified: stable/9/sys/kern/subr_bus.c
==============================================================================
--- stable/9/sys/kern/subr_bus.c	Tue Feb 26 20:18:25 2013	(r247343)
+++ stable/9/sys/kern/subr_bus.c	Tue Feb 26 20:19:19 2013	(r247344)
@@ -1871,6 +1871,8 @@ device_delete_child(device_t dev, device
 		return (error);
 	if (child->devclass)
 		devclass_delete_device(child->devclass, child);
+	if (child->parent)
+		BUS_CHILD_DELETED(dev, child);
 	TAILQ_REMOVE(&dev->children, child, link);
 	TAILQ_REMOVE(&bus_data_devices, child, devlink);
 	kobj_delete((kobj_t) child, M_BUS);