drivers/gpu/rogue_m/hwdefs/km/rgxmmudefs_km.h

   1 /*************************************************************************/ /*!
   2 @Title          Hardware definition file rgxmmudefs_km.h
   3 @Copyright      Copyright (c) Imagination Technologies Ltd. All Rights Reserved
   4 @License        Dual MIT/GPLv2
   5
   6 The contents of this file are subject to the MIT license as set out below.
   7
   8 Permission is hereby granted, free of charge, to any person obtaining a copy
   9 of this software and associated documentation files (the "Software"), to deal
  10 in the Software without restriction, including without limitation the rights
  11 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12 copies of the Software, and to permit persons to whom the Software is
  13 furnished to do so, subject to the following conditions:
  14
  15 The above copyright notice and this permission notice shall be included in
  16 all copies or substantial portions of the Software.
  17
  18 Alternatively, the contents of this file may be used under the terms of
  19 the GNU General Public License Version 2 ("GPL") in which case the provisions
  20 of GPL are applicable instead of those above.
  21
  22 If you wish to allow use of your version of this file only under the terms of
  23 GPL, and not to allow others to use your version of this file under the terms
  24 of the MIT license, indicate your decision by deleting the provisions above
  25 and replace them with the notice and other provisions required by GPL as set
  26 out in the file called "GPL-COPYING" included in this distribution. If you do
  27 not delete the provisions above, a recipient may use your version of this file
  28 under the terms of either the MIT license or GPL.
  29
  30 This License is also included in this distribution in the file called
  31 "MIT-COPYING".
  32
  33 EXCEPT AS OTHERWISE STATED IN A NEGOTIATED AGREEMENT: (A) THE SOFTWARE IS
  34 PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
  35 BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  36 PURPOSE AND NONINFRINGEMENT; AND (B) IN NO EVENT SHALL THE AUTHORS OR
  37 COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
  38 IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  39 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  40 */ /**************************************************************************/
  41
  42 /*               ****   Autogenerated C -- do not edit    ****               */
  43
  44 /*
  45  * Generated by regconv version MAIN@2782796
  46  *   from files:
  47  *      rogue_bif.def
  48  *      rogue_bif.def
  49  */
  50
  51
  52 #ifndef _RGXMMUDEFS_KM_H_
  53 #define _RGXMMUDEFS_KM_H_
  54
  55 #include "img_types.h"
  56
  57 /*
  58
  59                 Encoding of DM (note value 0x6 not used)
  60
  61 */
  62 #define RGX_BIF_DM_ENCODING_VERTEX                        (0x00000000U)
  63 #define RGX_BIF_DM_ENCODING_PIXEL                         (0x00000001U)
  64 #define RGX_BIF_DM_ENCODING_COMPUTE                       (0x00000002U)
  65 #define RGX_BIF_DM_ENCODING_TLA                           (0x00000003U)
  66 #define RGX_BIF_DM_ENCODING_PB_VCE                        (0x00000004U)
  67 #define RGX_BIF_DM_ENCODING_PB_TE                         (0x00000005U)
  68 #define RGX_BIF_DM_ENCODING_META                          (0x00000007U)
  69 #define RGX_BIF_DM_ENCODING_HOST                          (0x00000008U)
  70 #define RGX_BIF_DM_ENCODING_PM_ALIST                      (0x00000009U)
  71
  72
  73 /*
  74
  75                 Labelling of fields within virtual address
  76
  77 */
  78 /*
  79 Page Catalogue entry #
  80 */
  81 #define RGX_MMUCTRL_VADDR_PC_INDEX_SHIFT                  (30U)
  82 #define RGX_MMUCTRL_VADDR_PC_INDEX_CLRMSK                 (IMG_UINT64_C(0XFFFFFF003FFFFFFF))
  83 /*
  84 Page Directory entry #
  85 */
  86 #define RGX_MMUCTRL_VADDR_PD_INDEX_SHIFT                  (21U)
  87 #define RGX_MMUCTRL_VADDR_PD_INDEX_CLRMSK                 (IMG_UINT64_C(0XFFFFFFFFC01FFFFF))
  88 /*
  89 Page Table entry #
  90 */
  91 #define RGX_MMUCTRL_VADDR_PT_INDEX_SHIFT                  (12U)
  92 #define RGX_MMUCTRL_VADDR_PT_INDEX_CLRMSK                 (IMG_UINT64_C(0XFFFFFFFFFFE00FFF))
  93
  94
  95 /*
  96
  97                 Number of entries in a PC
  98
  99 */
 100 #define RGX_MMUCTRL_ENTRIES_PC_VALUE                      (0x00000400U)
 101
 102
 103 /*
 104
 105                 Number of entries in a PD
 106
 107 */
 108 #define RGX_MMUCTRL_ENTRIES_PD_VALUE                      (0x00000200U)
 109
 110
 111 /*
 112
 113                 Number of entries in a PT
 114
 115 */
 116 #define RGX_MMUCTRL_ENTRIES_PT_VALUE                      (0x00000200U)
 117
 118
 119 /*
 120
 121                 Size in bits of the PC entries in memory
 122
 123 */
 124 #define RGX_MMUCTRL_ENTRY_SIZE_PC_VALUE                   (0x00000020U)
 125
 126
 127 /*
 128
 129                 Size in bits of the PD entries in memory
 130
 131 */
 132 #define RGX_MMUCTRL_ENTRY_SIZE_PD_VALUE                   (0x00000040U)
 133
 134
 135 /*
 136
 137                 Size in bits of the PT entries in memory
 138
 139 */
 140 #define RGX_MMUCTRL_ENTRY_SIZE_PT_VALUE                   (0x00000040U)
 141
 142
 143 /*
 144
 145                 Encoding of page size field
 146
 147 */
 148 #define RGX_MMUCTRL_PAGE_SIZE_MASK                        (0x00000007U)
 149 #define RGX_MMUCTRL_PAGE_SIZE_4KB                         (0x00000000U)
 150 #define RGX_MMUCTRL_PAGE_SIZE_16KB                        (0x00000001U)
 151 #define RGX_MMUCTRL_PAGE_SIZE_64KB                        (0x00000002U)
 152 #define RGX_MMUCTRL_PAGE_SIZE_256KB                       (0x00000003U)
 153 #define RGX_MMUCTRL_PAGE_SIZE_1MB                         (0x00000004U)
 154 #define RGX_MMUCTRL_PAGE_SIZE_2MB                         (0x00000005U)
 155
 156
 157 /*
 158
 159                 Range of bits used for 4KB Physical Page
 160
 161 */
 162 #define RGX_MMUCTRL_PAGE_4KB_RANGE_SHIFT                  (12U)
 163 #define RGX_MMUCTRL_PAGE_4KB_RANGE_CLRMSK                 (IMG_UINT64_C(0XFFFFFF0000000FFF))
 164
 165
 166 /*
 167
 168                 Range of bits used for 16KB Physical Page
 169
 170 */
 171 #define RGX_MMUCTRL_PAGE_16KB_RANGE_SHIFT                 (14U)
 172 #define RGX_MMUCTRL_PAGE_16KB_RANGE_CLRMSK                (IMG_UINT64_C(0XFFFFFF0000003FFF))
 173
 174
 175 /*
 176
 177                 Range of bits used for 64KB Physical Page
 178
 179 */
 180 #define RGX_MMUCTRL_PAGE_64KB_RANGE_SHIFT                 (16U)
 181 #define RGX_MMUCTRL_PAGE_64KB_RANGE_CLRMSK                (IMG_UINT64_C(0XFFFFFF000000FFFF))
 182
 183
 184 /*
 185
 186                 Range of bits used for 256KB Physical Page
 187
 188 */
 189 #define RGX_MMUCTRL_PAGE_256KB_RANGE_SHIFT                (18U)
 190 #define RGX_MMUCTRL_PAGE_256KB_RANGE_CLRMSK               (IMG_UINT64_C(0XFFFFFF000003FFFF))
 191
 192
 193 /*
 194
 195                 Range of bits used for 1MB Physical Page
 196
 197 */
 198 #define RGX_MMUCTRL_PAGE_1MB_RANGE_SHIFT                  (20U)
 199 #define RGX_MMUCTRL_PAGE_1MB_RANGE_CLRMSK                 (IMG_UINT64_C(0XFFFFFF00000FFFFF))
 200
 201
 202 /*
 203
 204                 Range of bits used for 2MB Physical Page
 205
 206 */
 207 #define RGX_MMUCTRL_PAGE_2MB_RANGE_SHIFT                  (21U)
 208 #define RGX_MMUCTRL_PAGE_2MB_RANGE_CLRMSK                 (IMG_UINT64_C(0XFFFFFF00001FFFFF))
 209
 210
 211 /*
 212
 213                 Range of bits used for PT Base Address for 4KB Physical Page
 214
 215 */
 216 #define RGX_MMUCTRL_PT_BASE_4KB_RANGE_SHIFT               (12U)
 217 #define RGX_MMUCTRL_PT_BASE_4KB_RANGE_CLRMSK              (IMG_UINT64_C(0XFFFFFF0000000FFF))
 218
 219
 220 /*
 221
 222                 Range of bits used for PT Base Address for 16KB Physical Page
 223
 224 */
 225 #define RGX_MMUCTRL_PT_BASE_16KB_RANGE_SHIFT              (10U)
 226 #define RGX_MMUCTRL_PT_BASE_16KB_RANGE_CLRMSK             (IMG_UINT64_C(0XFFFFFF00000003FF))
 227
 228
 229 /*
 230
 231                 Range of bits used for PT Base Address for 64KB Physical Page
 232
 233 */
 234 #define RGX_MMUCTRL_PT_BASE_64KB_RANGE_SHIFT              (8U)
 235 #define RGX_MMUCTRL_PT_BASE_64KB_RANGE_CLRMSK             (IMG_UINT64_C(0XFFFFFF00000000FF))
 236
 237
 238 /*
 239
 240                 Range of bits used for PT Base Address for 256KB Physical Page
 241
 242 */
 243 #define RGX_MMUCTRL_PT_BASE_256KB_RANGE_SHIFT             (6U)
 244 #define RGX_MMUCTRL_PT_BASE_256KB_RANGE_CLRMSK            (IMG_UINT64_C(0XFFFFFF000000003F))
 245
 246
 247 /*
 248
 249                 Range of bits used for PT Base Address for 1MB Physical Page
 250
 251 */
 252 #define RGX_MMUCTRL_PT_BASE_1MB_RANGE_SHIFT               (5U)
 253 #define RGX_MMUCTRL_PT_BASE_1MB_RANGE_CLRMSK              (IMG_UINT64_C(0XFFFFFF000000001F))
 254
 255
 256 /*
 257
 258                 Range of bits used for PT Base Address for 2MB Physical Page
 259
 260 */
 261 #define RGX_MMUCTRL_PT_BASE_2MB_RANGE_SHIFT               (5U)
 262 #define RGX_MMUCTRL_PT_BASE_2MB_RANGE_CLRMSK              (IMG_UINT64_C(0XFFFFFF000000001F))
 263
 264
 265 /*
 266
 267                 Format of Page Table data
 268
 269 */
 270 /*
 271 PM/Meta protect bit
 272 */
 273 #define RGX_MMUCTRL_PT_DATA_PM_META_PROTECT_SHIFT         (62U)
 274 #define RGX_MMUCTRL_PT_DATA_PM_META_PROTECT_CLRMSK        (IMG_UINT64_C(0XBFFFFFFFFFFFFFFF))
 275 #define RGX_MMUCTRL_PT_DATA_PM_META_PROTECT_EN            (IMG_UINT64_C(0X4000000000000000))
 276 /*
 277 Upper part of vp page field
 278 */
 279 #define RGX_MMUCTRL_PT_DATA_VP_PAGE_HI_SHIFT              (40U)
 280 #define RGX_MMUCTRL_PT_DATA_VP_PAGE_HI_CLRMSK             (IMG_UINT64_C(0XC00000FFFFFFFFFF))
 281 /*
 282 Physical page address
 283 */
 284 #define RGX_MMUCTRL_PT_DATA_PAGE_SHIFT                    (12U)
 285 #define RGX_MMUCTRL_PT_DATA_PAGE_CLRMSK                   (IMG_UINT64_C(0XFFFFFF0000000FFF))
 286 /*
 287 Lower part of vp page field
 288 */
 289 #define RGX_MMUCTRL_PT_DATA_VP_PAGE_LO_SHIFT              (6U)
 290 #define RGX_MMUCTRL_PT_DATA_VP_PAGE_LO_CLRMSK             (IMG_UINT64_C(0XFFFFFFFFFFFFF03F))
 291 /*
 292 Entry pending
 293 */
 294 #define RGX_MMUCTRL_PT_DATA_ENTRY_PENDING_SHIFT           (5U)
 295 #define RGX_MMUCTRL_PT_DATA_ENTRY_PENDING_CLRMSK          (IMG_UINT64_C(0XFFFFFFFFFFFFFFDF))
 296 #define RGX_MMUCTRL_PT_DATA_ENTRY_PENDING_EN              (IMG_UINT64_C(0X0000000000000020))
 297 /*
 298 PM Src
 299 */
 300 #define RGX_MMUCTRL_PT_DATA_PM_SRC_SHIFT                  (4U)
 301 #define RGX_MMUCTRL_PT_DATA_PM_SRC_CLRMSK                 (IMG_UINT64_C(0XFFFFFFFFFFFFFFEF))
 302 #define RGX_MMUCTRL_PT_DATA_PM_SRC_EN                     (IMG_UINT64_C(0X0000000000000010))
 303 /*
 304 SLC Bypass Ctrl
 305 */
 306 #define RGX_MMUCTRL_PT_DATA_SLC_BYPASS_CTRL_SHIFT         (3U)
 307 #define RGX_MMUCTRL_PT_DATA_SLC_BYPASS_CTRL_CLRMSK        (IMG_UINT64_C(0XFFFFFFFFFFFFFFF7))
 308 #define RGX_MMUCTRL_PT_DATA_SLC_BYPASS_CTRL_EN            (IMG_UINT64_C(0X0000000000000008))
 309 /*
 310 Cache Coherency bit
 311 */
 312 #define RGX_MMUCTRL_PT_DATA_CC_SHIFT                      (2U)
 313 #define RGX_MMUCTRL_PT_DATA_CC_CLRMSK                     (IMG_UINT64_C(0XFFFFFFFFFFFFFFFB))
 314 #define RGX_MMUCTRL_PT_DATA_CC_EN                         (IMG_UINT64_C(0X0000000000000004))
 315 /*
 316 Read only
 317 */
 318 #define RGX_MMUCTRL_PT_DATA_READ_ONLY_SHIFT               (1U)
 319 #define RGX_MMUCTRL_PT_DATA_READ_ONLY_CLRMSK              (IMG_UINT64_C(0XFFFFFFFFFFFFFFFD))
 320 #define RGX_MMUCTRL_PT_DATA_READ_ONLY_EN                  (IMG_UINT64_C(0X0000000000000002))
 321 /*
 322 Entry valid
 323 */
 324 #define RGX_MMUCTRL_PT_DATA_VALID_SHIFT                   (0U)
 325 #define RGX_MMUCTRL_PT_DATA_VALID_CLRMSK                  (IMG_UINT64_C(0XFFFFFFFFFFFFFFFE))
 326 #define RGX_MMUCTRL_PT_DATA_VALID_EN                      (IMG_UINT64_C(0X0000000000000001))
 327
 328
 329 /*
 330
 331                 Format of Page Directory data
 332
 333 */
 334 /*
 335 Entry pending
 336 */
 337 #define RGX_MMUCTRL_PD_DATA_ENTRY_PENDING_SHIFT           (40U)
 338 #define RGX_MMUCTRL_PD_DATA_ENTRY_PENDING_CLRMSK          (IMG_UINT64_C(0XFFFFFEFFFFFFFFFF))
 339 #define RGX_MMUCTRL_PD_DATA_ENTRY_PENDING_EN              (IMG_UINT64_C(0X0000010000000000))
 340 /*
 341 Page Table base address
 342 */
 343 #define RGX_MMUCTRL_PD_DATA_PT_BASE_SHIFT                 (5U)
 344 #define RGX_MMUCTRL_PD_DATA_PT_BASE_CLRMSK                (IMG_UINT64_C(0XFFFFFF000000001F))
 345 /*
 346 Page Size
 347 */
 348 #define RGX_MMUCTRL_PD_DATA_PAGE_SIZE_SHIFT               (1U)
 349 #define RGX_MMUCTRL_PD_DATA_PAGE_SIZE_CLRMSK              (IMG_UINT64_C(0XFFFFFFFFFFFFFFF1))
 350 #define RGX_MMUCTRL_PD_DATA_PAGE_SIZE_4KB                 (IMG_UINT64_C(0000000000000000))
 351 #define RGX_MMUCTRL_PD_DATA_PAGE_SIZE_16KB                (IMG_UINT64_C(0x0000000000000002))
 352 #define RGX_MMUCTRL_PD_DATA_PAGE_SIZE_64KB                (IMG_UINT64_C(0x0000000000000004))
 353 #define RGX_MMUCTRL_PD_DATA_PAGE_SIZE_256KB               (IMG_UINT64_C(0x0000000000000006))
 354 #define RGX_MMUCTRL_PD_DATA_PAGE_SIZE_1MB                 (IMG_UINT64_C(0x0000000000000008))
 355 #define RGX_MMUCTRL_PD_DATA_PAGE_SIZE_2MB                 (IMG_UINT64_C(0x000000000000000a))
 356 /*
 357 Entry valid
 358 */
 359 #define RGX_MMUCTRL_PD_DATA_VALID_SHIFT                   (0U)
 360 #define RGX_MMUCTRL_PD_DATA_VALID_CLRMSK                  (IMG_UINT64_C(0XFFFFFFFFFFFFFFFE))
 361 #define RGX_MMUCTRL_PD_DATA_VALID_EN                      (IMG_UINT64_C(0X0000000000000001))
 362
 363
 364 /*
 365
 366                 Format of Page Catalogue data
 367
 368 */
 369 /*
 370 Page Catalogue base address
 371 */
 372 #define RGX_MMUCTRL_PC_DATA_PD_BASE_SHIFT                 (4U)
 373 #define RGX_MMUCTRL_PC_DATA_PD_BASE_CLRMSK                (0X0000000FU)
 374 #define RGX_MMUCTRL_PC_DATA_PD_BASE_ALIGNSHIFT            (12U)
 375 #define RGX_MMUCTRL_PC_DATA_PD_BASE_ALIGNSIZE             (4096U)
 376 /*
 377 Entry pending
 378 */
 379 #define RGX_MMUCTRL_PC_DATA_ENTRY_PENDING_SHIFT           (1U)
 380 #define RGX_MMUCTRL_PC_DATA_ENTRY_PENDING_CLRMSK          (0XFFFFFFFDU)
 381 #define RGX_MMUCTRL_PC_DATA_ENTRY_PENDING_EN              (0X00000002U)
 382 /*
 383 Entry valid
 384 */
 385 #define RGX_MMUCTRL_PC_DATA_VALID_SHIFT                   (0U)
 386 #define RGX_MMUCTRL_PC_DATA_VALID_CLRMSK                  (0XFFFFFFFEU)
 387 #define RGX_MMUCTRL_PC_DATA_VALID_EN                      (0X00000001U)
 388
 389
 390 #endif /* _RGXMMUDEFS_KM_H_ */
 391
 392 /*****************************************************************************
 393  End of file (rgxmmudefs_km.h)
 394 *****************************************************************************/
 395