FreeBSD/Linux Kernel Cross Reference
sys/kern/bus_if.m
1 #
2 # Copyright (c) 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$
27 #
28
29 INTERFACE bus;
30
31 #
32 # This is called from system code which prints out a description of a
33 # device. It should describe the attachment that the child has with
34 # the parent. For instance the TurboLaser bus prints which node the
35 # device is attached to.
36 #
37 METHOD void print_child {
38 device_t dev;
39 device_t child;
40 };
41
42 #
43 # These two methods manage a bus specific set of instance variables of
44 # a child device. The intention is that each different type of bus
45 # defines a set of appropriate instance variables (such as ports and
46 # irqs for ISA bus etc.)
47 #
48 # This information could be given to the child device as a struct but
49 # that makes it hard for a bus to add or remove variables without
50 # forcing an edit and recompile for all drivers which may not be
51 # possible for vendor supplied binary drivers.
52
53 #
54 # Read an instance variable. Return 0 on success.
55 #
56 METHOD int read_ivar {
57 device_t dev;
58 device_t child;
59 int index;
60 uintptr_t *result;
61 };
62
63 #
64 # Write an instance variable. Return 0 on success.
65 #
66 METHOD int write_ivar {
67 device_t dev;
68 device_t child;
69 int index;
70 uintptr_t value;
71 };
72
73 #
74 # Allocate a system resource attached to `dev' on behalf of `child'.
75 # The types are defined in <machine/resource.h>; the meaning of the
76 # resource-ID field varies from bus to bus (but *rid == 0 is always
77 # valid if the resource type is). start and end reflect the allowable
78 # range, and should be passed as `0UL' and `~0UL', respectively, if
79 # the client has no range restriction. count is the number of consecutive
80 # indices in the resource required. flags is a set of sharing flags
81 # as defined in <sys/rman.h>.
82 #
83 # Returns a resource or a null pointer on failure. The caller is
84 # responsible for calling rman_activate_resource() when it actually
85 # uses the resource.
86 #
87 METHOD struct resource * alloc_resource {
88 device_t dev;
89 device_t child;
90 int type;
91 int *rid;
92 u_long start;
93 u_long end;
94 u_long count;
95 u_int flags;
96 };
97
98 METHOD int activate_resource {
99 device_t dev;
100 device_t child;
101 int type;
102 int rid;
103 struct resource *r;
104 };
105
106 METHOD int deactivate_resource {
107 device_t dev;
108 device_t child;
109 int type;
110 int rid;
111 struct resource *r;
112 };
113
114 #
115 # Free a resource allocated by the preceding method. The `rid' value
116 # must be the same as the one returned by BUS_ALLOC_RESOURCE (which
117 # is not necessarily the same as the one the client passed).
118 #
119 METHOD int release_resource {
120 device_t dev;
121 device_t child;
122 int type;
123 int rid;
124 struct resource *res;
125 };
126
127 METHOD int setup_intr {
128 device_t dev;
129 device_t child;
130 struct resource *irq;
131 driver_intr_t *intr;
132 void *arg;
133 void **cookiep;
134 };
135
136 METHOD int teardown_intr {
137 device_t dev;
138 device_t child;
139 struct resource *irq;
140 void *cookie;
141 };
Cache object: 7a84563b08dc06e8aed63b2d3a9a1059
|