1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
|
/*************************************************************************/ /*!
@Title MMU Management
@Copyright Copyright (c) Imagination Technologies Ltd. All Rights Reserved
@Description Implements basic low level control of MMU.
@License Dual MIT/GPLv2
The contents of this file are subject to the MIT license as set out below.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
Alternatively, the contents of this file may be used under the terms of
the GNU General Public License Version 2 ("GPL") in which case the provisions
of GPL are applicable instead of those above.
If you wish to allow use of your version of this file only under the terms of
GPL, and not to allow others to use your version of this file under the terms
of the MIT license, indicate your decision by deleting the provisions above
and replace them with the notice and other provisions required by GPL as set
out in the file called "GPL-COPYING" included in this distribution. If you do
not delete the provisions above, a recipient may use your version of this file
under the terms of either the MIT license or GPL.
This License is also included in this distribution in the file called
"MIT-COPYING".
EXCEPT AS OTHERWISE STATED IN A NEGOTIATED AGREEMENT: (A) THE SOFTWARE IS
PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT; AND (B) IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/ /**************************************************************************/
#ifndef _MMU_H_
#define _MMU_H_
#include "sgxinfokm.h"
/*
******************************************************************************
FUNCTION: MMU_Initialise
PURPOSE: Initialise the mmu module.
PARAMETERS: None
RETURNS: PVRSRV_ERROR
******************************************************************************/
PVRSRV_ERROR
MMU_Initialise (PVRSRV_DEVICE_NODE *psDeviceNode, MMU_CONTEXT **ppsMMUContext, IMG_DEV_PHYADDR *psPDDevPAddr);
/*
******************************************************************************
FUNCTION: MMU_Finalise
PURPOSE: Finalise the mmu module, deallocate all resources.
PARAMETERS: None.
RETURNS: None.
******************************************************************************/
IMG_VOID
MMU_Finalise (MMU_CONTEXT *psMMUContext);
/*
******************************************************************************
FUNCTION: MMU_InsertHeap
PURPOSE: Inserts shared heap into the specified context
from the kernel context
PARAMETERS: None.
RETURNS: None.
******************************************************************************/
IMG_VOID
MMU_InsertHeap(MMU_CONTEXT *psMMUContext, MMU_HEAP *psMMUHeap);
/*
******************************************************************************
FUNCTION: MMU_Create
PURPOSE: Create an mmu device.
PARAMETERS: In: psMMUContext -
In: psDevArena -
Out: ppsVMArena
RETURNS: MMU_HEAP
******************************************************************************/
MMU_HEAP *
MMU_Create (MMU_CONTEXT *psMMUContext,
DEV_ARENA_DESCRIPTOR *psDevArena,
RA_ARENA **ppsVMArena,
PDUMP_MMU_ATTRIB **ppsMMUAttrib);
/*
******************************************************************************
FUNCTION: MMU_Delete
PURPOSE: Delete an mmu device.
PARAMETERS: In: pMMUHeap - The mmu to delete.
RETURNS:
******************************************************************************/
IMG_VOID
MMU_Delete (MMU_HEAP *pMMUHeap);
/*
******************************************************************************
FUNCTION: MMU_Alloc
PURPOSE: Allocate space in an mmu's virtual address space.
PARAMETERS: In: pMMUHeap - MMU to allocate on.
In: uSize - Size in bytes to allocate.
Out: pActualSize - If non null receives actual size allocated.
In: uFlags - Allocation flags.
In: uDevVAddrAlignment - Required alignment.
Out: pDevVAddr - Receives base address of allocation.
RETURNS: IMG_TRUE - Success
IMG_FALSE - Failure
******************************************************************************/
IMG_BOOL
MMU_Alloc (MMU_HEAP *pMMUHeap,
IMG_SIZE_T uSize,
IMG_SIZE_T *pActualSize,
IMG_UINT32 uFlags,
IMG_UINT32 uDevVAddrAlignment,
IMG_DEV_VIRTADDR *pDevVAddr);
/*
******************************************************************************
FUNCTION: MMU_Free
PURPOSE: Frees space in an mmu's virtual address space.
PARAMETERS: In: pMMUHeap - MMU to free on.
In: DevVAddr - Base address of allocation.
RETURNS: IMG_TRUE - Success
IMG_FALSE - Failure
******************************************************************************/
IMG_VOID
MMU_Free (MMU_HEAP *pMMUHeap,
IMG_DEV_VIRTADDR DevVAddr,
IMG_UINT32 ui32Size);
/*
******************************************************************************
FUNCTION: MMU_Enable
PURPOSE: Enable an mmu. Establishes pages tables and takes the mmu out
of bypass and waits for the mmu to acknowledge enabled.
PARAMETERS: In: pMMUHeap - the mmu
RETURNS: None
******************************************************************************/
IMG_VOID
MMU_Enable (MMU_HEAP *pMMUHeap);
/*
******************************************************************************
FUNCTION: MMU_Disable
PURPOSE: Disable an mmu, takes the mmu into bypass.
PARAMETERS: In: pMMUHeap - the mmu
RETURNS: None
******************************************************************************/
IMG_VOID
MMU_Disable (MMU_HEAP *pMMUHeap);
/*
******************************************************************************
FUNCTION: MMU_MapPages
PURPOSE: Create a mapping for a range of pages from a device physical
adddress to a specified device virtual address.
PARAMETERS: In: pMMUHeap - the mmu.
In: DevVAddr - the device virtual address.
In: SysPAddr - the system physical address of the page to map.
In: uSize - size of memory range in bytes
In: ui32MemFlags - page table flags.
In: hUniqueTag - A unique ID for use as a tag identifier
RETURNS: None
******************************************************************************/
IMG_VOID
MMU_MapPages (MMU_HEAP *pMMUHeap,
IMG_DEV_VIRTADDR DevVAddr,
IMG_SYS_PHYADDR SysPAddr,
IMG_SIZE_T uSize,
IMG_UINT32 ui32MemFlags,
IMG_HANDLE hUniqueTag);
/*
******************************************************************************
FUNCTION: MMU_MapPagesSparse
PURPOSE: Create a mapping for a range of pages from a device physical
adddress to a specified device virtual address.
PARAMETERS: In: pMMUHeap - the mmu.
In: DevVAddr - the device virtual address.
In: SysPAddr - the system physical address of the page to map.
In: ui32ChunkSize - Size of the chunk (must be page multiple)
In: ui32NumVirtChunks - Number of virtual chunks
In: ui32NumPhysChunks - Number of physical chunks
In: pabMapChunk - Mapping array
In: ui32MemFlags - page table flags.
In: hUniqueTag - A unique ID for use as a tag identifier
RETURNS: None
******************************************************************************/
IMG_VOID
MMU_MapPagesSparse (MMU_HEAP *pMMUHeap,
IMG_DEV_VIRTADDR DevVAddr,
IMG_SYS_PHYADDR SysPAddr,
IMG_UINT32 ui32ChunkSize,
IMG_UINT32 ui32NumVirtChunks,
IMG_UINT32 ui32NumPhysChunks,
IMG_BOOL *pabMapChunk,
IMG_UINT32 ui32MemFlags,
IMG_HANDLE hUniqueTag);
/*
******************************************************************************
FUNCTION: MMU_MapShadow
PURPOSE: Create a mapping for a range of pages from a CPU virtual
adddress to a specified device virtual address.
PARAMETERS: In: pMMUHeap - the mmu.
In: MapBaseDevVAddr - A page aligned device virtual address
to start mapping from.
In: uByteSize - A page aligned mapping length in bytes.
In: CpuVAddr - A page aligned CPU virtual address.
In: hOSMemHandle - An alternative OS specific memory handle
for mapping RAM without a CPU virtual
address
Out: pDevVAddr - deprecated
In: hUniqueTag - A unique ID for use as a tag identifier
In: ui32MemFlags - page table flags.
RETURNS: None
******************************************************************************/
IMG_VOID
MMU_MapShadow (MMU_HEAP * pMMUHeap,
IMG_DEV_VIRTADDR MapBaseDevVAddr,
IMG_SIZE_T uByteSize,
IMG_CPU_VIRTADDR CpuVAddr,
IMG_HANDLE hOSMemHandle,
IMG_DEV_VIRTADDR * pDevVAddr,
IMG_UINT32 ui32MemFlags,
IMG_HANDLE hUniqueTag);
/*
******************************************************************************
FUNCTION: MMU_MapShadowSparse
PURPOSE: Create a mapping for a range of pages from a CPU virtual
adddress to a specified device virtual address.
PARAMETERS: In: pMMUHeap - the mmu.
In: MapBaseDevVAddr - A page aligned device virtual address
to start mapping from.
In: ui32ChunkSize - Size of the chunk (must be page multiple)
In: ui32NumVirtChunks - Number of virtual chunks
In: ui32NumPhysChunks - Number of physical chunks
In: pabMapChunk - Mapping array
In: CpuVAddr - A page aligned CPU virtual address.
In: hOSMemHandle - An alternative OS specific memory handle
for mapping RAM without a CPU virtual
address
Out: pDevVAddr - deprecated
In: hUniqueTag - A unique ID for use as a tag identifier
In: ui32MemFlags - page table flags.
RETURNS: None
******************************************************************************/
IMG_VOID
MMU_MapShadowSparse (MMU_HEAP * pMMUHeap,
IMG_DEV_VIRTADDR MapBaseDevVAddr,
IMG_UINT32 ui32ChunkSize,
IMG_UINT32 ui32NumVirtChunks,
IMG_UINT32 ui32NumPhysChunks,
IMG_BOOL * pabMapChunk,
IMG_CPU_VIRTADDR CpuVAddr,
IMG_HANDLE hOSMemHandle,
IMG_DEV_VIRTADDR * pDevVAddr,
IMG_UINT32 ui32MemFlags,
IMG_HANDLE hUniqueTag);
/*
******************************************************************************
FUNCTION: MMU_UnmapPages
PURPOSE: unmaps pages and invalidates virtual address.
PARAMETERS: In: psMMUHeap - the mmu.
In: sDevVAddr - the device virtual address.
In: ui32PageCount - page count.
RETURNS: None
******************************************************************************/
IMG_VOID
MMU_UnmapPages (MMU_HEAP *psMMUHeap,
IMG_DEV_VIRTADDR sDevVAddr,
IMG_UINT32 ui32PageCount,
IMG_HANDLE hUniqueTag);
/*
******************************************************************************
FUNCTION: MMU_MapScatter
PURPOSE: Create a mapping for a list of pages to a specified device
virtual address.
PARAMETERS: In: pMMUHeap - the mmu.
In: DevVAddr - the device virtual address.
In: psSysAddr - the list of physical addresses of the pages to
map.
RETURNS: None
******************************************************************************/
IMG_VOID
MMU_MapScatter (MMU_HEAP *pMMUHeap,
IMG_DEV_VIRTADDR DevVAddr,
IMG_SYS_PHYADDR *psSysAddr,
IMG_SIZE_T uSize,
IMG_UINT32 ui32MemFlags,
IMG_HANDLE hUniqueTag);
/*
******************************************************************************
FUNCTION: MMU_GetPhysPageAddr
PURPOSE: extracts physical address from MMU page tables
PARAMETERS: In: pMMUHeap - the mmu
PARAMETERS: In: sDevVPageAddr - the virtual address to extract physical
page mapping from
RETURNS: IMG_DEV_PHYADDR
******************************************************************************/
IMG_DEV_PHYADDR
MMU_GetPhysPageAddr(MMU_HEAP *pMMUHeap, IMG_DEV_VIRTADDR sDevVPageAddr);
/*
******************************************************************************
FUNCTION: MMU_GetPDDevPAddr
PURPOSE: returns PD given the MMU context (SGX to MMU API)
PARAMETERS: In: pMMUContext - the mmu
RETURNS: IMG_DEV_PHYADDR
******************************************************************************/
IMG_DEV_PHYADDR
MMU_GetPDDevPAddr(MMU_CONTEXT *pMMUContext);
#ifdef SUPPORT_SGX_MMU_BYPASS
/*
******************************************************************************
FUNCTION: EnableHostAccess
PURPOSE: Enables Host accesses to device memory, by passing the device
MMU address translation
PARAMETERS: In: psMMUContext
RETURNS: None
******************************************************************************/
IMG_VOID
EnableHostAccess (MMU_CONTEXT *psMMUContext);
/*
******************************************************************************
FUNCTION: DisableHostAccess
PURPOSE: Disables Host accesses to device memory, by passing the device
MMU address translation
PARAMETERS: In: psMMUContext
RETURNS: None
******************************************************************************/
IMG_VOID
DisableHostAccess (MMU_CONTEXT *psMMUContext);
#endif
/*
******************************************************************************
FUNCTION: MMU_InvalidateDirectoryCache
PURPOSE: Invalidates the page directory cache
PARAMETERS: In: psDevInfo
RETURNS: None
******************************************************************************/
IMG_VOID MMU_InvalidateDirectoryCache(PVRSRV_SGXDEV_INFO *psDevInfo);
/*
******************************************************************************
FUNCTION: MMU_BIFResetPDAlloc
PURPOSE: Allocate a dummy Page Directory which causes all virtual
addresses to page fault.
PARAMETERS: In: psDevInfo - device info
RETURNS: PVRSRV_OK or error
******************************************************************************/
PVRSRV_ERROR MMU_BIFResetPDAlloc(PVRSRV_SGXDEV_INFO *psDevInfo);
/*
******************************************************************************
FUNCTION: MMU_BIFResetPDFree
PURPOSE: Free resources allocated in MMU_BIFResetPDAlloc.
PARAMETERS: In: psDevInfo - device info
RETURNS:
******************************************************************************/
IMG_VOID MMU_BIFResetPDFree(PVRSRV_SGXDEV_INFO *psDevInfo);
#if defined(SUPPORT_EXTERNAL_SYSTEM_CACHE)
/*
******************************************************************************
FUNCTION: MMU_MapExtSystemCacheRegs
PURPOSE: maps external system cache control registers into SGX MMU
PARAMETERS: In: psDeviceNode - device node
RETURNS:
******************************************************************************/
PVRSRV_ERROR MMU_MapExtSystemCacheRegs(PVRSRV_DEVICE_NODE *psDeviceNode);
/*
******************************************************************************
FUNCTION: MMU_UnmapExtSystemCacheRegs
PURPOSE: unmaps external system cache control registers
PARAMETERS: In: psDeviceNode - device node
RETURNS:
******************************************************************************/
PVRSRV_ERROR MMU_UnmapExtSystemCacheRegs(PVRSRV_DEVICE_NODE *psDeviceNode);
#endif /* #if defined(SUPPORT_EXTERNAL_SYSTEM_CACHE) */
/*
******************************************************************************
FUNCTION: MMU_IsHeapShared
PURPOSE: Is this heap shared?
PARAMETERS: In: pMMU_Heap
RETURNS: true if heap is shared
******************************************************************************/
IMG_BOOL MMU_IsHeapShared(MMU_HEAP* pMMU_Heap);
#if defined(FIX_HW_BRN_31620)
/*
******************************************************************************
FUNCTION: MMU_GetCacheFlushRange
PURPOSE: Gets device physical address of the mmu context.
PARAMETERS: In: pMMUContext - the mmu context
Out: pui32RangeMask - Bit mask showing which PD cache
lines have changed
RETURNS: None
******************************************************************************/
IMG_VOID MMU_GetCacheFlushRange(MMU_CONTEXT *pMMUContext, IMG_UINT32 *pui32RangeMask);
/*
******************************************************************************
FUNCTION: MMU_GetPDPhysAddr
PURPOSE: Gets device physical address of the mmu contexts PD.
PARAMETERS: In: pMMUContext - the mmu context
Out: psDevPAddr - Address of PD
RETURNS: None
******************************************************************************/
IMG_VOID MMU_GetPDPhysAddr(MMU_CONTEXT *pMMUContext, IMG_DEV_PHYADDR *psDevPAddr);
#endif
IMG_VOID MMU_CheckFaultAddr(PVRSRV_SGXDEV_INFO *psDevInfo, IMG_UINT32 ui32PDDevPAddr, IMG_UINT32 ui32RegVal);
#if defined(PDUMP)
/*
******************************************************************************
FUNCTION: MMU_GetPDumpContextID
PURPOSE: translates device mem context to unique pdump identifier
PARAMETERS: In: hDevMemContext - device memory per-process context
RETURNS: context identifier used internally in pdump
******************************************************************************/
IMG_UINT32 MMU_GetPDumpContextID(IMG_HANDLE hDevMemContext);
#endif /* #ifdef PDUMP */
#endif /* #ifndef _MMU_H_ */
|
