Sync usage with man page.
[netbsd-mini2440.git] / sys / external / bsd / drm / dist / libdrm / nouveau / nouveau_bo.h
blob84a43487b6f076c8a423dcfcf7d6e72c056b3f2d
1 /*
2 * Copyright 2007 Nouveau Project
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
18 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
19 * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
23 #ifndef __NOUVEAU_BO_H__
24 #define __NOUVEAU_BO_H__
26 /* Relocation/Buffer type flags */
27 #define NOUVEAU_BO_VRAM (1 << 0)
28 #define NOUVEAU_BO_GART (1 << 1)
29 #define NOUVEAU_BO_RD (1 << 2)
30 #define NOUVEAU_BO_WR (1 << 3)
31 #define NOUVEAU_BO_RDWR (NOUVEAU_BO_RD | NOUVEAU_BO_WR)
32 #define NOUVEAU_BO_MAP (1 << 4)
33 #define NOUVEAU_BO_PIN (1 << 5)
34 #define NOUVEAU_BO_LOW (1 << 6)
35 #define NOUVEAU_BO_HIGH (1 << 7)
36 #define NOUVEAU_BO_OR (1 << 8)
37 #define NOUVEAU_BO_LOCAL (1 << 9)
38 #define NOUVEAU_BO_TILED (1 << 10)
39 #define NOUVEAU_BO_ZTILE (1 << 11)
40 #define NOUVEAU_BO_DUMMY (1 << 31)
42 struct nouveau_bo {
43 struct nouveau_device *device;
44 uint32_t handle;
46 uint64_t size;
47 void *map;
49 int tiled;
51 /* Available when buffer is pinned *only* */
52 uint32_t flags;
53 uint64_t offset;
56 int
57 nouveau_bo_new(struct nouveau_device *, uint32_t flags, int align, int size,
58 struct nouveau_bo **);
60 int
61 nouveau_bo_user(struct nouveau_device *, void *ptr, int size,
62 struct nouveau_bo **);
64 int
65 nouveau_bo_fake(struct nouveau_device *dev, uint64_t offset, uint32_t flags,
66 uint32_t size, void *map, struct nouveau_bo **);
68 int
69 nouveau_bo_handle_get(struct nouveau_bo *, uint32_t *);
71 int
72 nouveau_bo_handle_ref(struct nouveau_device *, uint32_t handle,
73 struct nouveau_bo **);
75 int
76 nouveau_bo_ref(struct nouveau_bo *, struct nouveau_bo **);
78 int
79 nouveau_bo_map(struct nouveau_bo *, uint32_t flags);
81 void
82 nouveau_bo_unmap(struct nouveau_bo *);
84 int
85 nouveau_bo_pin(struct nouveau_bo *, uint32_t flags);
87 void
88 nouveau_bo_unpin(struct nouveau_bo *);
90 int
91 nouveau_bo_tile(struct nouveau_bo *, uint32_t flags, uint32_t delta,
92 uint32_t size);
94 int
95 nouveau_bo_busy(struct nouveau_bo *, uint32_t access);
97 #endif