aboutsummaryrefslogtreecommitdiff
path: root/drivers/char/drm/drm_sman.h
blob: 39a39fefeef14784f6f4a5bbe292a692e2ae427b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
/**************************************************************************
 *
 * Copyright 2006 Tungsten Graphics, Inc., Bismarck, ND., USA.
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
 * USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 *
 **************************************************************************/
/*
 * Simple memory MANager interface that keeps track on allocate regions on a
 * per "owner" basis. All regions associated with an "owner" can be released
 * with a simple call. Typically if the "owner" exists. The owner is any
 * "unsigned long" identifier. Can typically be a pointer to a file private
 * struct or a context identifier.
 *
 * Authors:
 * Thomas Hellström <thomas-at-tungstengraphics-dot-com>
 */

#ifndef DRM_SMAN_H
#define DRM_SMAN_H

#include "drmP.h"
#include "drm_hashtab.h"

/*
 * A class that is an abstration of a simple memory allocator.
 * The sman implementation provides a default such allocator
 * using the drm_mm.c implementation. But the user can replace it.
 * See the SiS implementation, which may use the SiS FB kernel module
 * for memory management.
 */

struct drm_sman_mm {
	/* private info. If allocated, needs to be destroyed by the destroy
	   function */
	void *private;

	/* Allocate a memory block with given size and alignment.
	   Return an opaque reference to the memory block */

	void *(*allocate) (void *private, unsigned long size,
			   unsigned alignment);

	/* Free a memory block. "ref" is the opaque reference that we got from
	   the "alloc" function */

	void (*free) (void *private, void *ref);

	/* Free all resources associated with this allocator */

	void (*destroy) (void *private);

	/* Return a memory offset from the opaque reference returned from the
	   "alloc" function */

	unsigned long (*offset) (void *private, void *ref);
};

struct drm_memblock_item {
	struct list_head owner_list;
	struct drm_hash_item user_hash;
	void *mm_info;
	struct drm_sman_mm *mm;
	struct drm_sman *sman;
};

struct drm_sman {
	struct drm_sman_mm *mm;
	int num_managers;
	struct drm_open_hash owner_hash_tab;
	struct drm_open_hash user_hash_tab;
	struct list_head owner_items;
};

/*
 * Take down a memory manager. This function should only be called after a
 * successful init and after a call to drm_sman_cleanup.
 */

extern void drm_sman_takedown(struct drm_sman * sman);

/*
 * Allocate structures for a manager.
 * num_managers are the number of memory pools to manage. (VRAM, AGP, ....)
 * user_order is the log2 of the number of buckets in the user hash table.
 *	    set this to approximately log2 of the max number of memory regions
 *	    that will be allocated for _all_ pools together.
 * owner_order is the log2 of the number of buckets in the owner hash table.
 *	    set this to approximately log2 of
 *	    the number of client file connections that will
 *	    be using the manager.
 *
 */

extern int drm_sman_init(struct drm_sman * sman, unsigned int num_managers,
			 unsigned int user_order, unsigned int owner_order);

/*
 * Initialize a drm_mm.c allocator. Should be called only once for each
 * manager unless a customized allogator is used.
 */

extern int drm_sman_set_range(struct drm_sman * sman, unsigned int manager,
			      unsigned long start, unsigned long size);

/*
 * Initialize a customized allocator for one of the managers.
 * (See the SiS module). The object pointed to by "allocator" is copied,
 * so it can be destroyed after this call.
 */

extern int drm_sman_set_manager(struct drm_sman * sman, unsigned int mananger,
				struct drm_sman_mm * allocator);

/*
 * Allocate a memory block. Aligment is not implemented yet.
 */

extern struct drm_memblock_item *drm_sman_alloc(struct drm_sman * sman,
						unsigned int manager,
						unsigned long size,
						unsigned alignment,
						unsigned long owner);
/*
 * Free a memory block identified by its user hash key.
 */

extern int drm_sman_free_key(struct drm_sman * sman, unsigned int key);

/*
 * returns 1 iff there are no stale memory blocks associated with this owner.
 * Typically called to determine if we need to idle the hardware and call
 * drm_sman_owner_cleanup. If there are no stale memory blocks, it removes all
 * resources associated with owner.
 */

extern int drm_sman_owner_clean(struct drm_sman * sman, unsigned long owner);

/*
 * Frees all stale memory blocks associated with this owner. Note that this
 * requires that the hardware is finished with all blocks, so the graphics engine
 * should be idled before this call is made. This function also frees
 * any resources associated with "owner" and should be called when owner
 * is not going to be referenced anymore.
 */

extern void drm_sman_owner_cleanup(struct drm_sman * sman, unsigned long owner);

/*
 * Frees all stale memory blocks associated with the memory manager.
 * See idling above.
 */

extern void drm_sman_cleanup(struct drm_sman * sman);

#endif