1/*-
2 * SPDX-License-Identifier: MIT
3 *
4 * Copyright 1998 Massachusetts Institute of Technology
5 *
6 * Permission to use, copy, modify, and distribute this software and
7 * its documentation for any purpose and without fee is hereby
8 * granted, provided that both the above copyright notice and this
9 * permission notice appear in all copies, that both the above
10 * copyright notice and this permission notice appear in all
11 * supporting documentation, and that the name of M.I.T. not be used
12 * in advertising or publicity pertaining to distribution of the
13 * software without specific, written prior permission. M.I.T. makes
14 * no representations about the suitability of this software for any
15 * purpose. It is provided "as is" without express or implied
16 * warranty.
17 *
18 * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS
19 * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
20 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
22 * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
25 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
28 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * SUCH DAMAGE.
30 */
31
32#ifndef _SYS_RMAN_H_
33#define _SYS_RMAN_H_ 1
34
35#ifndef _KERNEL
36#include <sys/queue.h>
37#else
38#include <machine/_bus.h>
39#include <machine/resource.h>
40#endif
41
42#define RF_ALLOCATED 0x0001 /* resource has been reserved */
43#define RF_ACTIVE 0x0002 /* resource allocation has been activated */
44#define RF_SHAREABLE 0x0004 /* resource permits contemporaneous sharing */
45#define RF_SPARE1 0x0008
46#define RF_SPARE2 0x0010
47#define RF_FIRSTSHARE 0x0020 /* first in sharing list */
48#define RF_PREFETCHABLE 0x0040 /* resource is prefetchable */
49#define RF_OPTIONAL 0x0080 /* for bus_alloc_resources() */
50#define RF_UNMAPPED 0x0100 /* don't map resource when activating */
51
52#define RF_ALIGNMENT_SHIFT 10 /* alignment size bit starts bit 10 */
53#define RF_ALIGNMENT_MASK (0x003F << RF_ALIGNMENT_SHIFT)
54 /* resource address alignment size bit mask */
55#define RF_ALIGNMENT_LOG2(x) ((x) << RF_ALIGNMENT_SHIFT)
56#define RF_ALIGNMENT(x) (((x) & RF_ALIGNMENT_MASK) >> RF_ALIGNMENT_SHIFT)
57
58enum rman_type { RMAN_UNINIT = 0, RMAN_GAUGE, RMAN_ARRAY };
59
60/*
61 * String length exported to userspace for resource names, etc.
62 */
63#define RM_TEXTLEN 32
64
65#define RM_MAX_END (~(rman_res_t)0)
66
67#define RMAN_IS_DEFAULT_RANGE(s,e) ((s) == 0 && (e) == RM_MAX_END)
68
69/*
70 * Userspace-exported structures.
71 */
72struct u_resource {
73 uintptr_t r_handle; /* resource uniquifier */
74 uintptr_t r_parent; /* parent rman */
75 uintptr_t r_device; /* device owning this resource */
76 char r_devname[RM_TEXTLEN]; /* device name XXX obsolete */
77
78 rman_res_t r_start; /* offset in resource space */
79 rman_res_t r_size; /* size in resource space */
80 u_int r_flags; /* RF_* flags */
81};
82
83struct u_rman {
84 uintptr_t rm_handle; /* rman uniquifier */
85 char rm_descr[RM_TEXTLEN]; /* rman description */
86
87 rman_res_t rm_start; /* base of managed region */
88 rman_res_t rm_size; /* size of managed region */
89 enum rman_type rm_type; /* region type */
90};
91
92#ifdef _KERNEL
93
94/*
95 * The public (kernel) view of struct resource
96 *
97 * NB: Changing the offset/size/type of existing fields in struct resource
98 * NB: breaks the device driver ABI and is strongly FORBIDDEN.
99 * NB: Appending new fields is probably just misguided.
100 */
101
102struct resource {
103 struct resource_i *__r_i;
104 bus_space_tag_t r_bustag; /* bus_space tag */
105 bus_space_handle_t r_bushandle; /* bus_space handle */
106};
107
108struct resource_i;
109struct resource_map;
110
111TAILQ_HEAD(resource_head, resource_i);
112
113struct rman {
114 struct resource_head rm_list;
115 struct mtx *rm_mtx; /* mutex used to protect rm_list */
116 TAILQ_ENTRY(rman) rm_link; /* link in list of all rmans */
117 rman_res_t rm_start; /* index of globally first entry */
118 rman_res_t rm_end; /* index of globally last entry */
119 enum rman_type rm_type; /* what type of resource this is */
120 const char *rm_descr; /* text descripion of this resource */
121};
122TAILQ_HEAD(rman_head, rman);
123
124int rman_activate_resource(struct resource *r);
125int rman_adjust_resource(struct resource *r, rman_res_t start, rman_res_t end);
126int rman_first_free_region(struct rman *rm, rman_res_t *start, rman_res_t *end);
127bus_space_handle_t rman_get_bushandle(const struct resource *);
128bus_space_tag_t rman_get_bustag(const struct resource *);
129rman_res_t rman_get_end(const struct resource *);
130device_t rman_get_device(const struct resource *);
131u_int rman_get_flags(const struct resource *);
132void *rman_get_irq_cookie(const struct resource *);
133void rman_get_mapping(const struct resource *, struct resource_map *);
134int rman_get_rid(const struct resource *);
135rman_res_t rman_get_size(const struct resource *);
136rman_res_t rman_get_start(const struct resource *);
137int rman_get_type(const struct resource *);
138void *rman_get_virtual(const struct resource *);
139int rman_deactivate_resource(struct resource *r);
140int rman_fini(struct rman *rm);
141int rman_init(struct rman *rm);
142int rman_init_from_resource(struct rman *rm, struct resource *r);
143int rman_last_free_region(struct rman *rm, rman_res_t *start, rman_res_t *end);
144uint32_t rman_make_alignment_flags(uint32_t size);
145int rman_manage_region(struct rman *rm, rman_res_t start, rman_res_t end);
146int rman_is_region_manager(const struct resource *r, const struct rman *rm);
147int rman_release_resource(struct resource *r);
148struct resource *rman_reserve_resource(struct rman *rm, rman_res_t start,
149 rman_res_t end, rman_res_t count,
150 u_int flags, device_t dev);
151void rman_set_bushandle(struct resource *_r, bus_space_handle_t _h);
152void rman_set_bustag(struct resource *_r, bus_space_tag_t _t);
153void rman_set_device(struct resource *_r, device_t _dev);
154void rman_set_irq_cookie(struct resource *_r, void *_c);
155void rman_set_mapping(struct resource *, struct resource_map *);
156void rman_set_rid(struct resource *_r, int _rid);
157void rman_set_type(struct resource *_r, int _type);
158void rman_set_virtual(struct resource *_r, void *_v);
159
160extern struct rman_head rman_head;
161
162#endif /* _KERNEL */
163
164#endif /* !_SYS_RMAN_H_ */