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 #define drm_i915_private inteldrm_softc
18 
19 struct drm_i915_private;
20 struct drm_i915_gem_object;
21 struct intel_memory_region;
22 struct sg_table;
23 
24 /**
25  *  Base memory type
26  */
27 enum intel_memory_type {
28 	INTEL_MEMORY_SYSTEM = 0,
29 	INTEL_MEMORY_LOCAL,
30 	INTEL_MEMORY_STOLEN,
31 };
32 
33 enum intel_region_id {
34 	INTEL_REGION_SMEM = 0,
35 	INTEL_REGION_LMEM,
36 	INTEL_REGION_STOLEN,
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   BIT(INTEL_REGION_STOLEN)
43 
44 #define INTEL_MEMORY_TYPE_SHIFT 16
45 
46 #define MEMORY_TYPE_FROM_REGION(r) (ilog2((r) >> INTEL_MEMORY_TYPE_SHIFT))
47 #define MEMORY_INSTANCE_FROM_REGION(r) (ilog2((r) & 0xffff))
48 
49 #define I915_ALLOC_MIN_PAGE_SIZE  BIT(0)
50 #define I915_ALLOC_CONTIGUOUS     BIT(1)
51 
52 #define for_each_memory_region(mr, i915, id) \
53 	for (id = 0; id < ARRAY_SIZE((i915)->mm.regions); id++) \
54 		for_each_if((mr) = (i915)->mm.regions[id])
55 
56 /**
57  * Memory regions encoded as type | instance
58  */
59 extern const u32 intel_region_map[];
60 
61 struct intel_memory_region_ops {
62 	unsigned int flags;
63 
64 	int (*init)(struct intel_memory_region *mem);
65 	void (*release)(struct intel_memory_region *mem);
66 
67 	struct drm_i915_gem_object *
68 	(*create_object)(struct intel_memory_region *mem,
69 			 resource_size_t size,
70 			 unsigned int flags);
71 };
72 
73 struct intel_memory_region {
74 	struct drm_i915_private *i915;
75 
76 	const struct intel_memory_region_ops *ops;
77 
78 #ifdef notyet
79 	struct io_mapping iomap;
80 #endif
81 	struct resource region;
82 
83 	/* For fake LMEM */
84 	struct drm_mm_node fake_mappable;
85 
86 	struct i915_buddy_mm mm;
87 	struct rwlock mm_lock;
88 
89 	struct kref kref;
90 
91 	resource_size_t io_start;
92 	resource_size_t min_page_size;
93 	resource_size_t total;
94 	resource_size_t avail;
95 
96 	unsigned int type;
97 	unsigned int instance;
98 	unsigned int id;
99 	char name[8];
100 
101 	dma_addr_t remap_addr;
102 
103 	struct {
104 		struct rwlock lock; /* Protects access to objects */
105 		struct list_head list;
106 		struct list_head purgeable;
107 	} objects;
108 };
109 
110 int intel_memory_region_init_buddy(struct intel_memory_region *mem);
111 void intel_memory_region_release_buddy(struct intel_memory_region *mem);
112 
113 int __intel_memory_region_get_pages_buddy(struct intel_memory_region *mem,
114 					  resource_size_t size,
115 					  unsigned int flags,
116 					  struct list_head *blocks);
117 struct i915_buddy_block *
118 __intel_memory_region_get_block_buddy(struct intel_memory_region *mem,
119 				      resource_size_t size,
120 				      unsigned int flags);
121 void __intel_memory_region_put_pages_buddy(struct intel_memory_region *mem,
122 					   struct list_head *blocks);
123 void __intel_memory_region_put_block_buddy(struct i915_buddy_block *block);
124 
125 struct intel_memory_region *
126 intel_memory_region_create(struct drm_i915_private *i915,
127 			   resource_size_t start,
128 			   resource_size_t size,
129 			   resource_size_t min_page_size,
130 			   resource_size_t io_start,
131 			   const struct intel_memory_region_ops *ops);
132 
133 struct intel_memory_region *
134 intel_memory_region_get(struct intel_memory_region *mem);
135 void intel_memory_region_put(struct intel_memory_region *mem);
136 
137 int intel_memory_regions_hw_probe(struct drm_i915_private *i915);
138 void intel_memory_regions_driver_release(struct drm_i915_private *i915);
139 struct intel_memory_region *
140 intel_memory_region_by_type(struct drm_i915_private *i915,
141 			    enum intel_memory_type mem_type);
142 
143 __printf(2, 3) void
144 intel_memory_region_set_name(struct intel_memory_region *mem,
145 			     const char *fmt, ...);
146 
147 #endif
148