xref: /dragonfly/sys/sys/bus_private.h (revision 606a6e92)
1 /*-
2  * Copyright (c) 1997, 1998 Doug Rabson
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD: src/sys/sys/bus_private.h,v 1.11.2.2 2000/08/03 00:25:22 peter Exp $
27  * $DragonFly: src/sys/sys/bus_private.h,v 1.7 2004/12/30 07:01:52 cpressey Exp $
28  */
29 
30 #ifndef _SYS_BUS_PRIVATE_H_
31 #define _SYS_BUS_PRIVATE_H_
32 
33 #if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
34 #error "This file should not be included by userland programs."
35 #endif
36 
37 #include <sys/bus.h>
38 
39 /*
40  * Used to attach drivers to devclasses.
41  */
42 typedef struct driverlink *driverlink_t;
43 struct driverlink {
44 	kobj_class_t		driver;
45 	TAILQ_ENTRY(driverlink) link;	/* list of drivers in devclass */
46 };
47 
48 /*
49  * Forward declarations
50  */
51 typedef TAILQ_HEAD(devclass_list, devclass) devclass_list_t;
52 typedef TAILQ_HEAD(driver_list, driverlink) driver_list_t;
53 typedef TAILQ_HEAD(device_list, device) device_list_t;
54 
55 struct devclass {
56 	TAILQ_ENTRY(devclass) link;
57 	devclass_t	parent;		/* parent in devclass hierarchy */
58 	driver_list_t	drivers;	/* bus devclasses store drivers for bus */
59 	char		*name;
60 	device_t	*devices;	/* array of devices indexed by unit */
61 	int		maxunit;	/* size of devices array */
62 };
63 
64 /*
65  * Resources from config(8).
66  */
67 typedef enum {
68 	RES_INT, RES_STRING, RES_LONG
69 } resource_type;
70 
71 struct config_resource {
72 	char		*name;
73 	resource_type	type;
74 	union {
75 		long	longval;
76 		int	intval;
77 		char*	stringval;
78 	} u;
79 };
80 
81 struct config_device {
82 	char			*name;		/* e.g. "lpt", "wdc" etc */
83 	int			unit;
84 	int			resource_count;
85 	struct config_resource	*resources;
86 };
87 
88 /*
89  * Implementation of device.
90  */
91 struct device {
92 	/*
93 	 * A device is a kernel object. The first field must be the
94 	 * current ops table for the object.
95 	 */
96 	KOBJ_FIELDS;
97 
98 	/*
99 	 * Device hierarchy.
100 	 */
101 	TAILQ_ENTRY(device)	link;		/* list of devices in parent */
102 	device_t		parent;
103 	device_list_t		children;	/* list of subordinate devices */
104 
105 	/*
106 	 * Details of this device.
107 	 */
108 	driver_t	*driver;
109 	devclass_t	devclass;	/* device class which we are in */
110 	int		unit;
111 	char*		nameunit;	/* name+unit e.g. foodev0 */
112 	char*		desc;		/* driver specific description */
113 	int		busy;		/* count of calls to device_busy() */
114 	device_state_t	state;
115 	uint32_t	devflags;	/* api level flags for device_get_flags() */
116 	u_short		flags;
117 #define DF_ENABLED	0x0001		/* device should be probed/attached */
118 #define DF_FIXEDCLASS	0x0002		/* devclass specified at create time */
119 #define DF_WILDCARD	0x0004		/* unit was originally wildcard */
120 #define DF_DESCMALLOCED	0x0008		/* description was malloced */
121 #define DF_QUIET	0x0010		/* don't print verbose attach message */
122 #define DF_DONENOMATCH	0x0020		/* don't execute DEVICE_NOMATCH again */
123 #define DF_EXTERNALSOFTC 0x0040		/* softc not allocated by us */
124 	u_char		order;		/* order from device_add_child_ordered() */
125 	u_char		pad;
126 #ifdef DEVICE_SYSCTLS
127 	struct sysctl_oid	oid[4];
128 	struct sysctl_oid_list oidlist[1];
129 #endif
130 	void		*ivars;
131 	void		*softc;
132 };
133 
134 struct device_op_desc {
135 	unsigned int	offset;		/* offset in driver ops */
136 	struct method*	method;		/* internal method implementation */
137 	devop_t		deflt;		/* default implementation */
138 	const char*	name;		/* unique name (for registration) */
139 };
140 
141 #endif /* !_SYS_BUS_PRIVATE_H_ */
142