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