device_calls revision 1.3 
1$NetBSD: device_calls,v 1.3 2025/10/03 16:49:07 thorpej Exp $
2
3/*-
4 * Copyright (c) 2021 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32/*
33 * Device calls used by the device autoconfiguration subsystem
34 */
35
36subsystem device;
37
38/*
39 * device-enumerate-children
40 *
41 * Enumerates the direct children of a device, invoking the callback for
42 * each one.  The callback is passed the devhandle_t corresponding to the
43 * child device, as well as a user-supplied argument.  If the callback
44 * returns true, then enumeration continues.  If the callback returns false,
45 * enumeration is stopped.
46 */
47device-enumerate-children {
48	bool	(*callback)(device_t, devhandle_t, void *);
49	void *	callback_arg;
50};
51
52/*
53 * device-register
54 *
55 * This is a hook for the platform device tree implementation to
56 * inspect or take action upon a new device before the machine-
57 * specific device_register() function is called.
58 */
59device-register {
60	void *	aux;		/* IN */
61};
62
63/*
64 * device-is-system-todr
65 *
66 * This is a filter that is considered when attaching the system TODR / RTC.
67 * For systems which may have multiple TODR / RTC devices, the platform
68 * device tree may have information about which is authoritative.  This is
69 * an optional method, and in its absence, the system will proceed as if
70 * the answer was "yes".
71 */
72device-is-system-todr {
73	bool	result;		/* OUT */
74};
75