xref: /src/sys/kern/device_calls

$NetBSD: device_calls,v 1.2 2025/09/08 00:12:21 thorpej Exp $

/*-
 * Copyright (c) 2021 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Jason R. Thorpe.
 *
 * 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 NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
 */

/*
 * Device calls used by the device autoconfiguration subsystem
 */

subsystem device;

/*
 * device-enumerate-children
 *
 * Enumerates the direct children of a device, invoking the callback for
 * each one.  The callback is passed the devhandle_t corresponding to the
 * child device, as well as a user-supplied argument.  If the callback
 * returns true, then enumeration continues.  If the callback returns false,
 * enumeration is stopped.
 */
device-enumerate-children {
	bool	(*callback)(device_t, devhandle_t, void *);
	void *	callback_arg;
};

/*
 * device-is-system-todr
 *
 * This is a filter that is considered when attaching the system TODR / RTC.
 * For systems which may have multiple TODR / RTC devices, the platform
 * device tree may have information about which is authoritative.  This is
 * an optional method, and in its absence, the system will proceed as if
 * the answer was "yes".
 */
device-is-system-todr {
	bool	result;		/* OUT */
};