drm/i915: mark stolen as private
[linux-2.6-microblaze.git] / drivers / gpu / drm / i915 / intel_memory_region.h
1 /* SPDX-License-Identifier: MIT */
2 /*
3  * Copyright © 2019 Intel Corporation
4  */
5
6 #ifndef __INTEL_MEMORY_REGION_H__
7 #define __INTEL_MEMORY_REGION_H__
8
9 #include <linux/kref.h>
10 #include <linux/ioport.h>
11 #include <linux/mutex.h>
12 #include <linux/io-mapping.h>
13 #include <drm/drm_mm.h>
14
15 #include "i915_buddy.h"
16
17 struct drm_i915_private;
18 struct drm_i915_gem_object;
19 struct intel_memory_region;
20 struct sg_table;
21
22 /**
23  *  Base memory type
24  */
25 enum intel_memory_type {
26         INTEL_MEMORY_SYSTEM = 0,
27         INTEL_MEMORY_LOCAL,
28         INTEL_MEMORY_STOLEN_SYSTEM,
29         INTEL_MEMORY_STOLEN_LOCAL,
30 };
31
32 enum intel_region_id {
33         INTEL_REGION_SMEM = 0,
34         INTEL_REGION_LMEM,
35         INTEL_REGION_STOLEN_SMEM,
36         INTEL_REGION_STOLEN_LMEM,
37         INTEL_REGION_UNKNOWN, /* Should be last */
38 };
39
40 #define REGION_SMEM     BIT(INTEL_REGION_SMEM)
41 #define REGION_LMEM     BIT(INTEL_REGION_LMEM)
42 #define REGION_STOLEN_SMEM   BIT(INTEL_REGION_STOLEN_SMEM)
43 #define REGION_STOLEN_LMEM   BIT(INTEL_REGION_STOLEN_LMEM)
44
45 #define I915_ALLOC_MIN_PAGE_SIZE  BIT(0)
46 #define I915_ALLOC_CONTIGUOUS     BIT(1)
47
48 #define for_each_memory_region(mr, i915, id) \
49         for (id = 0; id < ARRAY_SIZE((i915)->mm.regions); id++) \
50                 for_each_if((mr) = (i915)->mm.regions[id])
51
52 struct intel_memory_region_ops {
53         unsigned int flags;
54
55         int (*init)(struct intel_memory_region *mem);
56         void (*release)(struct intel_memory_region *mem);
57
58         int (*init_object)(struct intel_memory_region *mem,
59                            struct drm_i915_gem_object *obj,
60                            resource_size_t size,
61                            unsigned int flags);
62 };
63
64 struct intel_memory_region {
65         struct drm_i915_private *i915;
66
67         const struct intel_memory_region_ops *ops;
68
69         struct io_mapping iomap;
70         struct resource region;
71
72         /* For fake LMEM */
73         struct drm_mm_node fake_mappable;
74
75         struct i915_buddy_mm mm;
76         struct mutex mm_lock;
77
78         struct kref kref;
79
80         resource_size_t io_start;
81         resource_size_t min_page_size;
82         resource_size_t total;
83         resource_size_t avail;
84
85         u16 type;
86         u16 instance;
87         enum intel_region_id id;
88         char name[16];
89         bool private; /* not for userspace */
90
91         struct list_head reserved;
92
93         dma_addr_t remap_addr;
94
95         struct {
96                 struct mutex lock; /* Protects access to objects */
97                 struct list_head list;
98                 struct list_head purgeable;
99         } objects;
100 };
101
102 int intel_memory_region_init_buddy(struct intel_memory_region *mem);
103 void intel_memory_region_release_buddy(struct intel_memory_region *mem);
104
105 int __intel_memory_region_get_pages_buddy(struct intel_memory_region *mem,
106                                           resource_size_t size,
107                                           unsigned int flags,
108                                           struct list_head *blocks);
109 struct i915_buddy_block *
110 __intel_memory_region_get_block_buddy(struct intel_memory_region *mem,
111                                       resource_size_t size,
112                                       unsigned int flags);
113 void __intel_memory_region_put_pages_buddy(struct intel_memory_region *mem,
114                                            struct list_head *blocks);
115 void __intel_memory_region_put_block_buddy(struct i915_buddy_block *block);
116
117 int intel_memory_region_reserve(struct intel_memory_region *mem,
118                                 u64 offset, u64 size);
119
120 struct intel_memory_region *
121 intel_memory_region_create(struct drm_i915_private *i915,
122                            resource_size_t start,
123                            resource_size_t size,
124                            resource_size_t min_page_size,
125                            resource_size_t io_start,
126                            const struct intel_memory_region_ops *ops);
127
128 struct intel_memory_region *
129 intel_memory_region_get(struct intel_memory_region *mem);
130 void intel_memory_region_put(struct intel_memory_region *mem);
131
132 int intel_memory_regions_hw_probe(struct drm_i915_private *i915);
133 void intel_memory_regions_driver_release(struct drm_i915_private *i915);
134 struct intel_memory_region *
135 intel_memory_region_by_type(struct drm_i915_private *i915,
136                             enum intel_memory_type mem_type);
137
138 __printf(2, 3) void
139 intel_memory_region_set_name(struct intel_memory_region *mem,
140                              const char *fmt, ...);
141
142 #endif