Subversion Repositories Kolibri OS

Rev

Rev 4103 | Rev 4568 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
3262 Serge 1
/**************************************************************************
2
 *
3
 * Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., USA
4
 * All Rights Reserved.
5
 *
6
 * Permission is hereby granted, free of charge, to any person obtaining a
7
 * copy of this software and associated documentation files (the
8
 * "Software"), to deal in the Software without restriction, including
9
 * without limitation the rights to use, copy, modify, merge, publish,
10
 * distribute, sub license, and/or sell copies of the Software, and to
11
 * permit persons to whom the Software is furnished to do so, subject to
12
 * the following conditions:
13
 *
14
 * The above copyright notice and this permission notice (including the
15
 * next paragraph) shall be included in all copies or substantial portions
16
 * of the Software.
17
 *
18
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
21
 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
22
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
23
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
24
 * USE OR OTHER DEALINGS IN THE SOFTWARE.
25
 *
26
 **************************************************************************/
27
/*
28
 * Authors: Thomas Hellstrom 
29
 */
30
 
31
#ifndef _TTM_BO_API_H_
32
#define _TTM_BO_API_H_
33
 
34
#include 
4110 Serge 35
#include 
3262 Serge 36
#include 
37
#include 
38
#include 
39
#include 
40
#include 
41
#include 
42
 
43
struct ttm_bo_device;
44
 
45
struct drm_mm_node;
46
 
4065 Serge 47
struct reservation_object {
48
	struct mutex lock;
49
};
3262 Serge 50
 
4065 Serge 51
 
3262 Serge 52
/**
53
 * struct ttm_placement
54
 *
55
 * @fpfn:		first valid page frame number to put the object
56
 * @lpfn:		last valid page frame number to put the object
57
 * @num_placement:	number of preferred placements
58
 * @placement:		preferred placements
59
 * @num_busy_placement:	number of preferred placements when need to evict buffer
60
 * @busy_placement:	preferred placements when need to evict buffer
61
 *
62
 * Structure indicating the placement you request for an object.
63
 */
64
struct ttm_placement {
65
	unsigned	fpfn;
66
	unsigned	lpfn;
67
	unsigned	num_placement;
68
	const uint32_t	*placement;
69
	unsigned	num_busy_placement;
70
	const uint32_t	*busy_placement;
71
};
72
 
73
/**
74
 * struct ttm_bus_placement
75
 *
76
 * @addr:		mapped virtual address
77
 * @base:		bus base address
78
 * @is_iomem:		is this io memory ?
79
 * @size:		size in byte
80
 * @offset:		offset from the base address
81
 * @io_reserved_vm:     The VM system has a refcount in @io_reserved_count
82
 * @io_reserved_count:  Refcounting the numbers of callers to ttm_mem_io_reserve
83
 *
84
 * Structure indicating the bus placement of an object.
85
 */
86
struct ttm_bus_placement {
87
	void		*addr;
88
	unsigned long	base;
89
	unsigned long	size;
90
	unsigned long	offset;
91
	bool		is_iomem;
92
	bool		io_reserved_vm;
93
	uint64_t        io_reserved_count;
94
};
95
 
96
 
97
/**
98
 * struct ttm_mem_reg
99
 *
100
 * @mm_node: Memory manager node.
101
 * @size: Requested size of memory region.
102
 * @num_pages: Actual size of memory region in pages.
103
 * @page_alignment: Page alignment.
104
 * @placement: Placement flags.
105
 * @bus: Placement on io bus accessible to the CPU
106
 *
107
 * Structure indicating the placement and space resources used by a
108
 * buffer object.
109
 */
110
 
111
struct ttm_mem_reg {
112
	void *mm_node;
113
	unsigned long start;
114
	unsigned long size;
115
	unsigned long num_pages;
116
	uint32_t page_alignment;
117
	uint32_t mem_type;
118
	uint32_t placement;
119
	struct ttm_bus_placement bus;
120
};
121
 
122
/**
123
 * enum ttm_bo_type
124
 *
125
 * @ttm_bo_type_device:	These are 'normal' buffers that can
126
 * be mmapped by user space. Each of these bos occupy a slot in the
127
 * device address space, that can be used for normal vm operations.
128
 *
129
 * @ttm_bo_type_kernel: These buffers are like ttm_bo_type_device buffers,
130
 * but they cannot be accessed from user-space. For kernel-only use.
131
 *
132
 * @ttm_bo_type_sg: Buffer made from dmabuf sg table shared with another
133
 * driver.
134
 */
135
 
136
enum ttm_bo_type {
137
	ttm_bo_type_device,
138
	ttm_bo_type_kernel,
139
	ttm_bo_type_sg
140
};
141
 
142
struct ttm_tt;
143
 
144
/**
145
 * struct ttm_buffer_object
146
 *
147
 * @bdev: Pointer to the buffer object device structure.
148
 * @type: The bo type.
149
 * @destroy: Destruction function. If NULL, kfree is used.
150
 * @num_pages: Actual number of pages.
151
 * @acc_size: Accounted size for this object.
152
 * @kref: Reference count of this buffer object. When this refcount reaches
153
 * zero, the object is put on the delayed delete list.
154
 * @list_kref: List reference count of this buffer object. This member is
155
 * used to avoid destruction while the buffer object is still on a list.
156
 * Lru lists may keep one refcount, the delayed delete list, and kref != 0
157
 * keeps one refcount. When this refcount reaches zero,
158
 * the object is destroyed.
159
 * @mem: structure describing current placement.
160
 * @persistent_swap_storage: Usually the swap storage is deleted for buffers
161
 * pinned in physical memory. If this behaviour is not desired, this member
162
 * holds a pointer to a persistent shmem object.
163
 * @ttm: TTM structure holding system pages.
164
 * @evicted: Whether the object was evicted without user-space knowing.
165
 * @cpu_writes: For synchronization. Number of cpu writers.
166
 * @lru: List head for the lru list.
167
 * @ddestroy: List head for the delayed destroy list.
168
 * @swap: List head for swap LRU list.
169
 * @sync_obj: Pointer to a synchronization object.
170
 * @priv_flags: Flags describing buffer object internal state.
4103 Serge 171
 * @vma_node: Address space manager node.
3262 Serge 172
 * @offset: The current GPU offset, which can have different meanings
173
 * depending on the memory type. For SYSTEM type memory, it should be 0.
174
 * @cur_placement: Hint of current placement.
175
 *
176
 * Base class for TTM buffer object, that deals with data placement and CPU
177
 * mappings. GPU mappings are really up to the driver, but for simpler GPUs
178
 * the driver can usually use the placement offset @offset directly as the
179
 * GPU virtual address. For drivers implementing multiple
180
 * GPU memory manager contexts, the driver should manage the address space
181
 * in these contexts separately and use these objects to get the correct
182
 * placement and caching for these GPU maps. This makes it possible to use
183
 * these objects for even quite elaborate memory management schemes.
184
 * The destroy member, the API visibility of this object makes it possible
185
 * to derive driver specific types.
186
 */
187
 
188
struct ttm_buffer_object {
189
	/**
190
	 * Members constant at init.
191
	 */
192
 
193
	struct ttm_bo_global *glob;
194
	struct ttm_bo_device *bdev;
195
	enum ttm_bo_type type;
196
	void (*destroy) (struct ttm_buffer_object *);
197
	unsigned long num_pages;
198
	size_t acc_size;
199
 
200
	/**
201
	* Members not needing protection.
202
	*/
203
 
204
	struct kref kref;
205
	struct kref list_kref;
206
 
207
	/**
4065 Serge 208
	 * Members protected by the bo::resv::reserved lock.
3262 Serge 209
	 */
210
 
211
	struct ttm_mem_reg mem;
212
	struct file *persistent_swap_storage;
213
	struct ttm_tt *ttm;
214
	bool evicted;
215
 
216
	/**
217
	 * Members protected by the bo::reserved lock only when written to.
218
	 */
219
 
220
	atomic_t cpu_writers;
221
 
222
	/**
223
	 * Members protected by the bdev::lru_lock.
224
	 */
225
 
226
	struct list_head lru;
227
	struct list_head ddestroy;
228
	struct list_head swap;
229
	struct list_head io_reserve_lru;
230
 
231
	/**
232
	 * Members protected by struct buffer_object_device::fence_lock
233
	 * In addition, setting sync_obj to anything else
234
	 * than NULL requires bo::reserved to be held. This allows for
235
	 * checking NULL while reserved but not holding the mentioned lock.
236
	 */
237
 
238
	void *sync_obj;
239
	unsigned long priv_flags;
240
 
4110 Serge 241
	struct drm_vma_offset_node vma_node;
3262 Serge 242
 
243
	/**
244
	 * Special members that are protected by the reserve lock
245
	 * and the bo::lock when written to. Can be read with
246
	 * either of these locks held.
247
	 */
248
 
249
	unsigned long offset;
250
	uint32_t cur_placement;
251
 
252
	struct sg_table *sg;
4065 Serge 253
 
254
	struct reservation_object *resv;
255
	struct reservation_object ttm_resv;
3262 Serge 256
};
257
 
258
/**
259
 * struct ttm_bo_kmap_obj
260
 *
261
 * @virtual: The current kernel virtual address.
262
 * @page: The page when kmap'ing a single page.
263
 * @bo_kmap_type: Type of bo_kmap.
264
 *
265
 * Object describing a kernel mapping. Since a TTM bo may be located
266
 * in various memory types with various caching policies, the
267
 * mapping can either be an ioremap, a vmap, a kmap or part of a
268
 * premapped region.
269
 */
270
 
271
#define TTM_BO_MAP_IOMEM_MASK 0x80
272
struct ttm_bo_kmap_obj {
273
	void *virtual;
274
	struct page *page;
275
	enum {
276
		ttm_bo_map_iomap        = 1 | TTM_BO_MAP_IOMEM_MASK,
277
		ttm_bo_map_vmap         = 2,
278
		ttm_bo_map_kmap         = 3,
279
		ttm_bo_map_premapped    = 4 | TTM_BO_MAP_IOMEM_MASK,
280
	} bo_kmap_type;
281
	struct ttm_buffer_object *bo;
282
};
283
 
284
/**
285
 * ttm_bo_reference - reference a struct ttm_buffer_object
286
 *
287
 * @bo: The buffer object.
288
 *
289
 * Returns a refcounted pointer to a buffer object.
290
 */
291
 
292
static inline struct ttm_buffer_object *
293
ttm_bo_reference(struct ttm_buffer_object *bo)
294
{
295
	kref_get(&bo->kref);
296
	return bo;
297
}
298
 
299
/**
300
 * ttm_bo_wait - wait for buffer idle.
301
 *
302
 * @bo:  The buffer object.
303
 * @interruptible:  Use interruptible wait.
304
 * @no_wait:  Return immediately if buffer is busy.
305
 *
306
 * This function must be called with the bo::mutex held, and makes
307
 * sure any previous rendering to the buffer is completed.
308
 * Note: It might be necessary to block validations before the
309
 * wait by reserving the buffer.
310
 * Returns -EBUSY if no_wait is true and the buffer is busy.
311
 * Returns -ERESTARTSYS if interrupted by a signal.
312
 */
313
extern int ttm_bo_wait(struct ttm_buffer_object *bo, bool lazy,
314
		       bool interruptible, bool no_wait);
315
/**
316
 * ttm_bo_validate
317
 *
318
 * @bo: The buffer object.
319
 * @placement: Proposed placement for the buffer object.
320
 * @interruptible: Sleep interruptible if sleeping.
321
 * @no_wait_gpu: Return immediately if the GPU is busy.
322
 *
323
 * Changes placement and caching policy of the buffer object
324
 * according proposed placement.
325
 * Returns
326
 * -EINVAL on invalid proposed placement.
327
 * -ENOMEM on out-of-memory condition.
328
 * -EBUSY if no_wait is true and buffer busy.
329
 * -ERESTARTSYS if interrupted by a signal.
330
 */
331
extern int ttm_bo_validate(struct ttm_buffer_object *bo,
332
				struct ttm_placement *placement,
333
				bool interruptible,
334
				bool no_wait_gpu);
335
 
336
/**
337
 * ttm_bo_unref
338
 *
339
 * @bo: The buffer object.
340
 *
341
 * Unreference and clear a pointer to a buffer object.
342
 */
343
extern void ttm_bo_unref(struct ttm_buffer_object **bo);
344
 
345
 
346
/**
347
 * ttm_bo_list_ref_sub
348
 *
349
 * @bo: The buffer object.
350
 * @count: The number of references with which to decrease @bo::list_kref;
351
 * @never_free: The refcount should not reach zero with this operation.
352
 *
353
 * Release @count lru list references to this buffer object.
354
 */
355
extern void ttm_bo_list_ref_sub(struct ttm_buffer_object *bo, int count,
356
				bool never_free);
357
 
358
/**
359
 * ttm_bo_add_to_lru
360
 *
361
 * @bo: The buffer object.
362
 *
363
 * Add this bo to the relevant mem type lru and, if it's backed by
364
 * system pages (ttms) to the swap list.
365
 * This function must be called with struct ttm_bo_global::lru_lock held, and
366
 * is typically called immediately prior to unreserving a bo.
367
 */
368
extern void ttm_bo_add_to_lru(struct ttm_buffer_object *bo);
369
 
370
/**
371
 * ttm_bo_del_from_lru
372
 *
373
 * @bo: The buffer object.
374
 *
375
 * Remove this bo from all lru lists used to lookup and reserve an object.
376
 * This function must be called with struct ttm_bo_global::lru_lock held,
377
 * and is usually called just immediately after the bo has been reserved to
378
 * avoid recursive reservation from lru lists.
379
 */
380
extern int ttm_bo_del_from_lru(struct ttm_buffer_object *bo);
381
 
382
 
383
/**
384
 * ttm_bo_lock_delayed_workqueue
385
 *
386
 * Prevent the delayed workqueue from running.
387
 * Returns
388
 * True if the workqueue was queued at the time
389
 */
390
extern int ttm_bo_lock_delayed_workqueue(struct ttm_bo_device *bdev);
391
 
392
/**
393
 * ttm_bo_unlock_delayed_workqueue
394
 *
395
 * Allows the delayed workqueue to run.
396
 */
397
extern void ttm_bo_unlock_delayed_workqueue(struct ttm_bo_device *bdev,
398
					    int resched);
399
 
400
/**
401
 * ttm_bo_synccpu_write_grab
402
 *
403
 * @bo: The buffer object:
404
 * @no_wait: Return immediately if buffer is busy.
405
 *
406
 * Synchronizes a buffer object for CPU RW access. This means
407
 * command submission that affects the buffer will return -EBUSY
408
 * until ttm_bo_synccpu_write_release is called.
409
 *
410
 * Returns
411
 * -EBUSY if the buffer is busy and no_wait is true.
412
 * -ERESTARTSYS if interrupted by a signal.
413
 */
414
extern int
415
ttm_bo_synccpu_write_grab(struct ttm_buffer_object *bo, bool no_wait);
416
 
417
/**
418
 * ttm_bo_synccpu_write_release:
419
 *
420
 * @bo : The buffer object.
421
 *
422
 * Releases a synccpu lock.
423
 */
424
extern void ttm_bo_synccpu_write_release(struct ttm_buffer_object *bo);
425
 
426
/**
427
 * ttm_bo_acc_size
428
 *
429
 * @bdev: Pointer to a ttm_bo_device struct.
430
 * @bo_size: size of the buffer object in byte.
431
 * @struct_size: size of the structure holding buffer object datas
432
 *
433
 * Returns size to account for a buffer object
434
 */
435
size_t ttm_bo_acc_size(struct ttm_bo_device *bdev,
436
		       unsigned long bo_size,
437
		       unsigned struct_size);
438
size_t ttm_bo_dma_acc_size(struct ttm_bo_device *bdev,
439
			   unsigned long bo_size,
440
			   unsigned struct_size);
441
 
442
/**
443
 * ttm_bo_init
444
 *
445
 * @bdev: Pointer to a ttm_bo_device struct.
446
 * @bo: Pointer to a ttm_buffer_object to be initialized.
447
 * @size: Requested size of buffer object.
448
 * @type: Requested type of buffer object.
449
 * @flags: Initial placement flags.
450
 * @page_alignment: Data alignment in pages.
451
 * @interruptible: If needing to sleep to wait for GPU resources,
452
 * sleep interruptible.
453
 * @persistent_swap_storage: Usually the swap storage is deleted for buffers
454
 * pinned in physical memory. If this behaviour is not desired, this member
455
 * holds a pointer to a persistent shmem object. Typically, this would
456
 * point to the shmem object backing a GEM object if TTM is used to back a
457
 * GEM user interface.
458
 * @acc_size: Accounted size for this object.
459
 * @destroy: Destroy function. Use NULL for kfree().
460
 *
461
 * This function initializes a pre-allocated struct ttm_buffer_object.
462
 * As this object may be part of a larger structure, this function,
463
 * together with the @destroy function,
464
 * enables driver-specific objects derived from a ttm_buffer_object.
465
 * On successful return, the object kref and list_kref are set to 1.
466
 * If a failure occurs, the function will call the @destroy function, or
467
 * kfree() if @destroy is NULL. Thus, after a failure, dereferencing @bo is
468
 * illegal and will likely cause memory corruption.
469
 *
470
 * Returns
471
 * -ENOMEM: Out of memory.
472
 * -EINVAL: Invalid placement flags.
473
 * -ERESTARTSYS: Interrupted by signal while sleeping waiting for resources.
474
 */
475
 
476
extern int ttm_bo_init(struct ttm_bo_device *bdev,
477
			struct ttm_buffer_object *bo,
478
			unsigned long size,
479
			enum ttm_bo_type type,
480
			struct ttm_placement *placement,
481
			uint32_t page_alignment,
482
			bool interrubtible,
483
			struct file *persistent_swap_storage,
484
			size_t acc_size,
485
			struct sg_table *sg,
486
			void (*destroy) (struct ttm_buffer_object *));
487
 
488
/**
489
 * ttm_bo_synccpu_object_init
490
 *
491
 * @bdev: Pointer to a ttm_bo_device struct.
492
 * @bo: Pointer to a ttm_buffer_object to be initialized.
493
 * @size: Requested size of buffer object.
494
 * @type: Requested type of buffer object.
495
 * @flags: Initial placement flags.
496
 * @page_alignment: Data alignment in pages.
497
 * @interruptible: If needing to sleep while waiting for GPU resources,
498
 * sleep interruptible.
499
 * @persistent_swap_storage: Usually the swap storage is deleted for buffers
500
 * pinned in physical memory. If this behaviour is not desired, this member
501
 * holds a pointer to a persistent shmem object. Typically, this would
502
 * point to the shmem object backing a GEM object if TTM is used to back a
503
 * GEM user interface.
504
 * @p_bo: On successful completion *p_bo points to the created object.
505
 *
506
 * This function allocates a ttm_buffer_object, and then calls ttm_bo_init
507
 * on that object. The destroy function is set to kfree().
508
 * Returns
509
 * -ENOMEM: Out of memory.
510
 * -EINVAL: Invalid placement flags.
511
 * -ERESTARTSYS: Interrupted by signal while waiting for resources.
512
 */
513
 
514
extern int ttm_bo_create(struct ttm_bo_device *bdev,
515
				unsigned long size,
516
				enum ttm_bo_type type,
517
				struct ttm_placement *placement,
518
				uint32_t page_alignment,
519
				bool interruptible,
520
				struct file *persistent_swap_storage,
521
				struct ttm_buffer_object **p_bo);
522
 
523
/**
524
 * ttm_bo_check_placement
525
 *
526
 * @bo:		the buffer object.
527
 * @placement:	placements
528
 *
529
 * Performs minimal validity checking on an intended change of
530
 * placement flags.
531
 * Returns
532
 * -EINVAL: Intended change is invalid or not allowed.
533
 */
534
extern int ttm_bo_check_placement(struct ttm_buffer_object *bo,
535
					struct ttm_placement *placement);
536
 
537
/**
538
 * ttm_bo_init_mm
539
 *
540
 * @bdev: Pointer to a ttm_bo_device struct.
541
 * @mem_type: The memory type.
542
 * @p_size: size managed area in pages.
543
 *
544
 * Initialize a manager for a given memory type.
545
 * Note: if part of driver firstopen, it must be protected from a
546
 * potentially racing lastclose.
547
 * Returns:
548
 * -EINVAL: invalid size or memory type.
549
 * -ENOMEM: Not enough memory.
550
 * May also return driver-specified errors.
551
 */
552
 
553
extern int ttm_bo_init_mm(struct ttm_bo_device *bdev, unsigned type,
554
				unsigned long p_size);
555
/**
556
 * ttm_bo_clean_mm
557
 *
558
 * @bdev: Pointer to a ttm_bo_device struct.
559
 * @mem_type: The memory type.
560
 *
561
 * Take down a manager for a given memory type after first walking
562
 * the LRU list to evict any buffers left alive.
563
 *
564
 * Normally, this function is part of lastclose() or unload(), and at that
565
 * point there shouldn't be any buffers left created by user-space, since
566
 * there should've been removed by the file descriptor release() method.
567
 * However, before this function is run, make sure to signal all sync objects,
568
 * and verify that the delayed delete queue is empty. The driver must also
569
 * make sure that there are no NO_EVICT buffers present in this memory type
570
 * when the call is made.
571
 *
572
 * If this function is part of a VT switch, the caller must make sure that
573
 * there are no appications currently validating buffers before this
574
 * function is called. The caller can do that by first taking the
575
 * struct ttm_bo_device::ttm_lock in write mode.
576
 *
577
 * Returns:
578
 * -EINVAL: invalid or uninitialized memory type.
579
 * -EBUSY: There are still buffers left in this memory type.
580
 */
581
 
582
extern int ttm_bo_clean_mm(struct ttm_bo_device *bdev, unsigned mem_type);
583
 
584
/**
585
 * ttm_bo_evict_mm
586
 *
587
 * @bdev: Pointer to a ttm_bo_device struct.
588
 * @mem_type: The memory type.
589
 *
590
 * Evicts all buffers on the lru list of the memory type.
591
 * This is normally part of a VT switch or an
592
 * out-of-memory-space-due-to-fragmentation handler.
593
 * The caller must make sure that there are no other processes
594
 * currently validating buffers, and can do that by taking the
595
 * struct ttm_bo_device::ttm_lock in write mode.
596
 *
597
 * Returns:
598
 * -EINVAL: Invalid or uninitialized memory type.
599
 * -ERESTARTSYS: The call was interrupted by a signal while waiting to
600
 * evict a buffer.
601
 */
602
 
603
extern int ttm_bo_evict_mm(struct ttm_bo_device *bdev, unsigned mem_type);
604
 
605
/**
606
 * ttm_kmap_obj_virtual
607
 *
608
 * @map: A struct ttm_bo_kmap_obj returned from ttm_bo_kmap.
609
 * @is_iomem: Pointer to an integer that on return indicates 1 if the
610
 * virtual map is io memory, 0 if normal memory.
611
 *
612
 * Returns the virtual address of a buffer object area mapped by ttm_bo_kmap.
613
 * If *is_iomem is 1 on return, the virtual address points to an io memory area,
614
 * that should strictly be accessed by the iowriteXX() and similar functions.
615
 */
616
 
617
static inline void *ttm_kmap_obj_virtual(struct ttm_bo_kmap_obj *map,
618
					 bool *is_iomem)
619
{
620
	*is_iomem = !!(map->bo_kmap_type & TTM_BO_MAP_IOMEM_MASK);
621
	return map->virtual;
622
}
623
 
624
/**
625
 * ttm_bo_kmap
626
 *
627
 * @bo: The buffer object.
628
 * @start_page: The first page to map.
629
 * @num_pages: Number of pages to map.
630
 * @map: pointer to a struct ttm_bo_kmap_obj representing the map.
631
 *
632
 * Sets up a kernel virtual mapping, using ioremap, vmap or kmap to the
633
 * data in the buffer object. The ttm_kmap_obj_virtual function can then be
634
 * used to obtain a virtual address to the data.
635
 *
636
 * Returns
637
 * -ENOMEM: Out of memory.
638
 * -EINVAL: Invalid range.
639
 */
640
 
641
extern int ttm_bo_kmap(struct ttm_buffer_object *bo, unsigned long start_page,
642
		       unsigned long num_pages, struct ttm_bo_kmap_obj *map);
643
 
644
/**
645
 * ttm_bo_kunmap
646
 *
647
 * @map: Object describing the map to unmap.
648
 *
649
 * Unmaps a kernel map set up by ttm_bo_kmap.
650
 */
651
 
652
extern void ttm_bo_kunmap(struct ttm_bo_kmap_obj *map);
653
 
654
/**
655
 * ttm_fbdev_mmap - mmap fbdev memory backed by a ttm buffer object.
656
 *
657
 * @vma:       vma as input from the fbdev mmap method.
658
 * @bo:        The bo backing the address space. The address space will
659
 * have the same size as the bo, and start at offset 0.
660
 *
661
 * This function is intended to be called by the fbdev mmap method
662
 * if the fbdev address space is to be backed by a bo.
663
 */
664
 
665
extern int ttm_fbdev_mmap(struct vm_area_struct *vma,
666
			  struct ttm_buffer_object *bo);
667
 
668
/**
669
 * ttm_bo_mmap - mmap out of the ttm device address space.
670
 *
671
 * @filp:      filp as input from the mmap method.
672
 * @vma:       vma as input from the mmap method.
673
 * @bdev:      Pointer to the ttm_bo_device with the address space manager.
674
 *
675
 * This function is intended to be called by the device mmap method.
676
 * if the device address space is to be backed by the bo manager.
677
 */
678
 
679
extern int ttm_bo_mmap(struct file *filp, struct vm_area_struct *vma,
680
		       struct ttm_bo_device *bdev);
681
 
682
/**
683
 * ttm_bo_io
684
 *
685
 * @bdev:      Pointer to the struct ttm_bo_device.
686
 * @filp:      Pointer to the struct file attempting to read / write.
687
 * @wbuf:      User-space pointer to address of buffer to write. NULL on read.
688
 * @rbuf:      User-space pointer to address of buffer to read into.
689
 * Null on write.
690
 * @count:     Number of bytes to read / write.
691
 * @f_pos:     Pointer to current file position.
692
 * @write:     1 for read, 0 for write.
693
 *
694
 * This function implements read / write into ttm buffer objects, and is
695
 * intended to
696
 * be called from the fops::read and fops::write method.
697
 * Returns:
698
 * See man (2) write, man(2) read. In particular,
699
 * the function may return -ERESTARTSYS if
700
 * interrupted by a signal.
701
 */
702
 
703
extern ssize_t ttm_bo_io(struct ttm_bo_device *bdev, struct file *filp,
704
			 const char __user *wbuf, char __user *rbuf,
705
			 size_t count, loff_t *f_pos, bool write);
706
 
707
extern void ttm_bo_swapout_all(struct ttm_bo_device *bdev);
708
 
709
#endif