2 * Copyright © 2014 Advanced Micro Devices, Inc.
5 * Permission is hereby granted, free of charge, to any person obtaining
6 * a copy of this software and associated documentation files (the
7 * "Software"), to deal in the Software without restriction, including
8 * without limitation the rights to use, copy, modify, merge, publish,
9 * distribute, sub license, and/or sell copies of the Software, and to
10 * permit persons to whom the Software is furnished to do so, subject to
11 * the following conditions:
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
14 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
15 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
16 * NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS, AUTHORS
17 * AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 * USE OR OTHER DEALINGS IN THE SOFTWARE.
22 * The above copyright notice and this permission notice (including the
23 * next paragraph) shall be included in all copies or substantial portions
28 ***************************************************************************************************
29 * @file addrinterface.h
30 * @brief Contains the addrlib interfaces declaration and parameter defines
31 ***************************************************************************************************
33 #ifndef __ADDR_INTERFACE_H__
34 #define __ADDR_INTERFACE_H__
36 #include "addrtypes.h"
38 #if defined(__cplusplus)
43 #define ADDRLIB_VERSION_MAJOR 5
44 #define ADDRLIB_VERSION_MINOR 25
45 #define ADDRLIB_VERSION ((ADDRLIB_VERSION_MAJOR << 16) | ADDRLIB_VERSION_MINOR)
47 /// Virtually all interface functions need ADDR_HANDLE as first parameter
48 typedef VOID
* ADDR_HANDLE
;
50 /// Client handle used in callbacks
51 typedef VOID
* ADDR_CLIENT_HANDLE
;
54 * /////////////////////////////////////////////////////////////////////////////////////////////////
55 * // Callback functions
56 * /////////////////////////////////////////////////////////////////////////////////////////////////
57 * typedef VOID* (ADDR_API* ADDR_ALLOCSYSMEM)(
58 * const ADDR_ALLOCSYSMEM_INPUT* pInput);
59 * typedef ADDR_E_RETURNCODE (ADDR_API* ADDR_FREESYSMEM)(
61 * typedef ADDR_E_RETURNCODE (ADDR_API* ADDR_DEBUGPRINT)(
62 * const ADDR_DEBUGPRINT_INPUT* pInput);
64 * /////////////////////////////////////////////////////////////////////////////////////////////////
65 * // Create/Destroy/Config functions
66 * /////////////////////////////////////////////////////////////////////////////////////////////////
70 * /////////////////////////////////////////////////////////////////////////////////////////////////
71 * // Surface functions
72 * /////////////////////////////////////////////////////////////////////////////////////////////////
73 * AddrComputeSurfaceInfo()
74 * AddrComputeSurfaceAddrFromCoord()
75 * AddrComputeSurfaceCoordFromAddr()
77 * /////////////////////////////////////////////////////////////////////////////////////////////////
79 * /////////////////////////////////////////////////////////////////////////////////////////////////
80 * AddrComputeHtileInfo()
81 * AddrComputeHtileAddrFromCoord()
82 * AddrComputeHtileCoordFromAddr()
84 * /////////////////////////////////////////////////////////////////////////////////////////////////
86 * /////////////////////////////////////////////////////////////////////////////////////////////////
87 * AddrComputeCmaskInfo()
88 * AddrComputeCmaskAddrFromCoord()
89 * AddrComputeCmaskCoordFromAddr()
91 * /////////////////////////////////////////////////////////////////////////////////////////////////
93 * /////////////////////////////////////////////////////////////////////////////////////////////////
94 * AddrComputeFmaskInfo()
95 * AddrComputeFmaskAddrFromCoord()
96 * AddrComputeFmaskCoordFromAddr()
98 * /////////////////////////////////////////////////////////////////////////////////////////////////
99 * // Element/Utility functions
100 * /////////////////////////////////////////////////////////////////////////////////////////////////
101 * ElemFlt32ToDepthPixel()
102 * ElemFlt32ToColorPixel()
103 * AddrExtractBankPipeSwizzle()
104 * AddrCombineBankPipeSwizzle()
105 * AddrComputeSliceSwizzle()
106 * AddrConvertTileInfoToHW()
107 * AddrConvertTileIndex()
108 * AddrConvertTileIndex1()
110 * AddrComputeBaseSwizzle()
112 * AddrUseCombinedSwizzle()
116 ///////////////////////////////////////////////////////////////////////////////////////////////////
117 // Callback functions
118 ///////////////////////////////////////////////////////////////////////////////////////////////////
121 ***************************************************************************************************
122 * @brief Alloc system memory flags.
123 * @note These flags are reserved for future use and if flags are added will minimize the impact
125 ***************************************************************************************************
127 typedef union _ADDR_ALLOCSYSMEM_FLAGS
131 UINT_32 reserved
: 32; ///< Reserved for future use.
135 } ADDR_ALLOCSYSMEM_FLAGS
;
138 ***************************************************************************************************
139 * @brief Alloc system memory input structure
140 ***************************************************************************************************
142 typedef struct _ADDR_ALLOCSYSMEM_INPUT
144 UINT_32 size
; ///< Size of this structure in bytes
146 ADDR_ALLOCSYSMEM_FLAGS flags
; ///< System memory flags.
147 UINT_32 sizeInBytes
; ///< System memory allocation size in bytes.
148 ADDR_CLIENT_HANDLE hClient
; ///< Client handle
149 } ADDR_ALLOCSYSMEM_INPUT
;
152 ***************************************************************************************************
155 * Allocate system memory callback function. Returns valid pointer on success.
156 ***************************************************************************************************
158 typedef VOID
* (ADDR_API
* ADDR_ALLOCSYSMEM
)(
159 const ADDR_ALLOCSYSMEM_INPUT
* pInput
);
162 ***************************************************************************************************
163 * @brief Free system memory input structure
164 ***************************************************************************************************
166 typedef struct _ADDR_FREESYSMEM_INPUT
168 UINT_32 size
; ///< Size of this structure in bytes
170 VOID
* pVirtAddr
; ///< Virtual address
171 ADDR_CLIENT_HANDLE hClient
; ///< Client handle
172 } ADDR_FREESYSMEM_INPUT
;
175 ***************************************************************************************************
178 * Free system memory callback function.
179 * Returns ADDR_OK on success.
180 ***************************************************************************************************
182 typedef ADDR_E_RETURNCODE (ADDR_API
* ADDR_FREESYSMEM
)(
183 const ADDR_FREESYSMEM_INPUT
* pInput
);
186 ***************************************************************************************************
187 * @brief Print debug message input structure
188 ***************************************************************************************************
190 typedef struct _ADDR_DEBUGPRINT_INPUT
192 UINT_32 size
; ///< Size of this structure in bytes
194 CHAR
* pDebugString
; ///< Debug print string
195 va_list ap
; ///< Variable argument list
196 ADDR_CLIENT_HANDLE hClient
; ///< Client handle
197 } ADDR_DEBUGPRINT_INPUT
;
200 ***************************************************************************************************
203 * Print debug message callback function.
204 * Returns ADDR_OK on success.
205 ***************************************************************************************************
207 typedef ADDR_E_RETURNCODE (ADDR_API
* ADDR_DEBUGPRINT
)(
208 const ADDR_DEBUGPRINT_INPUT
* pInput
);
211 ***************************************************************************************************
215 * Address Library needs client to provide system memory alloc/free routines.
216 ***************************************************************************************************
218 typedef struct _ADDR_CALLBACKS
220 ADDR_ALLOCSYSMEM allocSysMem
; ///< Routine to allocate system memory
221 ADDR_FREESYSMEM freeSysMem
; ///< Routine to free system memory
222 ADDR_DEBUGPRINT debugPrint
; ///< Routine to print debug message
225 ///////////////////////////////////////////////////////////////////////////////////////////////////
226 // Create/Destroy functions
227 ///////////////////////////////////////////////////////////////////////////////////////////////////
230 ***************************************************************************************************
234 * This structure is used to pass some setup in creation of AddrLib
236 ***************************************************************************************************
238 typedef union _ADDR_CREATE_FLAGS
242 UINT_32 noCubeMipSlicesPad
: 1; ///< Turn cubemap faces padding off
243 UINT_32 fillSizeFields
: 1; ///< If clients fill size fields in all input and
245 UINT_32 useTileIndex
: 1; ///< Make tileIndex field in input valid
246 UINT_32 useCombinedSwizzle
: 1; ///< Use combined tile swizzle
247 UINT_32 checkLast2DLevel
: 1; ///< Check the last 2D mip sub level
248 UINT_32 useHtileSliceAlign
: 1; ///< Do htile single slice alignment
249 UINT_32 allowLargeThickTile
: 1; ///< Allow 64*thickness*bytesPerPixel > rowSize
250 UINT_32 reserved
: 25; ///< Reserved bits for future use
257 ***************************************************************************************************
258 * ADDR_REGISTER_VALUE
261 * Data from registers to setup AddrLib global data, used in AddrCreate
262 ***************************************************************************************************
264 typedef struct _ADDR_REGISTER_VALUE
266 UINT_32 gbAddrConfig
; ///< For R8xx, use GB_ADDR_CONFIG register value.
267 /// For R6xx/R7xx, use GB_TILING_CONFIG.
268 /// But they can be treated as the same.
269 /// if this value is 0, use chip to set default value
270 UINT_32 backendDisables
; ///< 1 bit per backend, starting with LSB. 1=disabled,0=enabled.
271 /// Register value of CC_RB_BACKEND_DISABLE.BACKEND_DISABLE
273 /// R800 registers-----------------------------------------------
274 UINT_32 noOfBanks
; ///< Number of h/w ram banks - For r800: MC_ARB_RAMCFG.NOOFBANK
275 /// No enums for this value in h/w header files
279 UINT_32 noOfRanks
; /// MC_ARB_RAMCFG.NOOFRANK
282 /// SI (R1000) registers-----------------------------------------
283 const UINT_32
* pTileConfig
; ///< Global tile setting tables
284 UINT_32 noOfEntries
; ///< Number of entries in pTileConfig
286 ///< CI registers-------------------------------------------------
287 const UINT_32
* pMacroTileConfig
; ///< Global macro tile mode table
288 UINT_32 noOfMacroEntries
; ///< Number of entries in pMacroTileConfig
290 } ADDR_REGISTER_VALUE
;
293 ***************************************************************************************************
297 * Parameters use to create an AddrLib Object. Caller must provide all fields.
299 ***************************************************************************************************
301 typedef struct _ADDR_CREATE_INPUT
303 UINT_32 size
; ///< Size of this structure in bytes
305 UINT_32 chipEngine
; ///< Chip Engine
306 UINT_32 chipFamily
; ///< Chip Family
307 UINT_32 chipRevision
; ///< Chip Revision
308 ADDR_CALLBACKS callbacks
; ///< Callbacks for sysmem alloc/free/print
309 ADDR_CREATE_FLAGS createFlags
; ///< Flags to setup AddrLib
310 ADDR_REGISTER_VALUE regValue
; ///< Data from registers to setup AddrLib global data
311 ADDR_CLIENT_HANDLE hClient
; ///< Client handle
312 UINT_32 minPitchAlignPixels
; ///< Minimum pitch alignment in pixels
316 ***************************************************************************************************
317 * ADDR_CREATEINFO_OUTPUT
320 * Return AddrLib handle to client driver
322 ***************************************************************************************************
324 typedef struct _ADDR_CREATE_OUTPUT
326 UINT_32 size
; ///< Size of this structure in bytes
328 ADDR_HANDLE hLib
; ///< Address lib handle
329 } ADDR_CREATE_OUTPUT
;
332 ***************************************************************************************************
336 * Create AddrLib object, must be called before any interface calls
339 * ADDR_OK if successful
340 ***************************************************************************************************
342 ADDR_E_RETURNCODE ADDR_API
AddrCreate(
343 const ADDR_CREATE_INPUT
* pAddrCreateIn
,
344 ADDR_CREATE_OUTPUT
* pAddrCreateOut
);
349 ***************************************************************************************************
353 * Destroy AddrLib object, must be called to free internally allocated resources.
356 * ADDR_OK if successful
357 ***************************************************************************************************
359 ADDR_E_RETURNCODE ADDR_API
AddrDestroy(
364 ///////////////////////////////////////////////////////////////////////////////////////////////////
366 ///////////////////////////////////////////////////////////////////////////////////////////////////
369 ***************************************************************************************************
371 * Bank/tiling parameters. On function input, these can be set as desired or
372 * left 0 for AddrLib to calculate/default. On function output, these are the actual
375 * Valid bankWidth/bankHeight value:
376 * 1,2,4,8. They are factors instead of pixels or bytes.
378 * The bank number remains constant across each row of the
379 * macro tile as each pipe is selected, so the number of
380 * tiles in the x direction with the same bank number will
381 * be bank_width * num_pipes.
382 ***************************************************************************************************
384 typedef struct _ADDR_TILEINFO
386 /// Any of these parameters can be set to 0 to use the HW default.
387 UINT_32 banks
; ///< Number of banks, numerical value
388 UINT_32 bankWidth
; ///< Number of tiles in the X direction in the same bank
389 UINT_32 bankHeight
; ///< Number of tiles in the Y direction in the same bank
390 UINT_32 macroAspectRatio
; ///< Macro tile aspect ratio. 1-1:1, 2-4:1, 4-16:1, 8-64:1
391 UINT_32 tileSplitBytes
; ///< Tile split size, in bytes
392 AddrPipeCfg pipeConfig
; ///< Pipe Config = HW enum + 1
395 // Create a define to avoid client change. The removal of R800 is because we plan to implement SI
396 // within 800 HWL - An AddrPipeCfg is added in above data structure
397 typedef ADDR_TILEINFO ADDR_R800_TILEINFO
;
400 ***************************************************************************************************
402 * Information needed by quad buffer stereo support
403 ***************************************************************************************************
405 typedef struct _ADDR_QBSTEREOINFO
407 UINT_32 eyeHeight
; ///< Height (in pixel rows) to right eye
408 UINT_32 rightOffset
; ///< Offset (in bytes) to right eye
409 UINT_32 rightSwizzle
; ///< TileSwizzle for right eyes
413 ***************************************************************************************************
418 ***************************************************************************************************
420 typedef union _ADDR_SURFACE_FLAGS
424 UINT_32 color
: 1; ///< Flag indicates this is a color buffer
425 UINT_32 depth
: 1; ///< Flag indicates this is a depth/stencil buffer
426 UINT_32 stencil
: 1; ///< Flag indicates this is a stencil buffer
427 UINT_32 texture
: 1; ///< Flag indicates this is a texture
428 UINT_32 cube
: 1; ///< Flag indicates this is a cubemap
429 UINT_32 volume
: 1; ///< Flag indicates this is a volume texture
430 UINT_32 fmask
: 1; ///< Flag indicates this is an fmask
431 UINT_32 cubeAsArray
: 1; ///< Flag indicates if treat cubemap as arrays
432 UINT_32 compressZ
: 1; ///< Flag indicates z buffer is compressed
433 UINT_32 overlay
: 1; ///< Flag indicates this is an overlay surface
434 UINT_32 noStencil
: 1; ///< Flag indicates this depth has no separate stencil
435 UINT_32 display
: 1; ///< Flag indicates this should match display controller req.
436 UINT_32 opt4Space
: 1; ///< Flag indicates this surface should be optimized for space
437 /// i.e. save some memory but may lose performance
438 UINT_32 prt
: 1; ///< Flag for partially resident texture
439 UINT_32 qbStereo
: 1; ///< Quad buffer stereo surface
440 UINT_32 pow2Pad
: 1; ///< SI: Pad to pow2, must set for mipmap (include level0)
441 UINT_32 interleaved
: 1; ///< Special flag for interleaved YUV surface padding
442 UINT_32 tcCompatible
: 1; ///< Flag indicates surface needs to be shader readable
443 UINT_32 dispTileType
: 1; ///< NI: force display Tiling for 128 bit shared resoruce
444 UINT_32 dccCompatible
: 1; ///< VI: whether to support dcc fast clear
445 UINT_32 czDispCompatible
: 1; ///< SI+: CZ family has a HW bug needs special alignment.
446 /// This flag indicates we need to follow the alignment with
447 /// CZ families or other ASICs under PX configuration + CZ.
448 UINT_32 nonSplit
: 1; ///< CI: depth texture should not be split
449 UINT_32 reserved
: 10; ///< Reserved bits
453 } ADDR_SURFACE_FLAGS
;
456 ***************************************************************************************************
457 * ADDR_COMPUTE_SURFACE_INFO_INPUT
460 * Input structure for AddrComputeSurfaceInfo
461 ***************************************************************************************************
463 typedef struct _ADDR_COMPUTE_SURFACE_INFO_INPUT
465 UINT_32 size
; ///< Size of this structure in bytes
467 AddrTileMode tileMode
; ///< Tile mode
468 AddrFormat format
; ///< If format is set to valid one, bpp/width/height
469 /// might be overwritten
470 UINT_32 bpp
; ///< Bits per pixel
471 UINT_32 numSamples
; ///< Number of samples
472 UINT_32 width
; ///< Width, in pixels
473 UINT_32 height
; ///< Height, in pixels
474 UINT_32 numSlices
; ///< Number of surface slices or depth
475 UINT_32 slice
; ///< Slice index
476 UINT_32 mipLevel
; ///< Current mipmap level
477 ADDR_SURFACE_FLAGS flags
; ///< Surface type flags
478 UINT_32 numFrags
; ///< Number of fragments, leave it zero or the same as
479 /// number of samples for normal AA; Set it to the
480 /// number of fragments for EQAA
481 /// r800 and later HWL parameters
482 // Needed by 2D tiling, for linear and 1D tiling, just keep them 0's
483 ADDR_TILEINFO
* pTileInfo
; ///< 2D tile parameters. Set to 0 to default/calculate
484 AddrTileType tileType
; ///< Micro tiling type, not needed when tileIndex != -1
485 INT_32 tileIndex
; ///< Tile index, MUST be -1 if you don't want to use it
486 /// while the global useTileIndex is set to 1
487 UINT_32 basePitch
; ///< Base level pitch in pixels, 0 means ignored, is a
488 /// must for mip levels from SI+.
489 /// Don't use pitch in blocks for compressed formats!
490 } ADDR_COMPUTE_SURFACE_INFO_INPUT
;
493 ***************************************************************************************************
494 * ADDR_COMPUTE_SURFACE_INFO_OUTPUT
497 * Output structure for AddrComputeSurfInfo
499 Element: AddrLib unit for computing. e.g. BCn: 4x4 blocks; R32B32B32: 32bit with 3x pitch
500 Pixel: Original pixel
501 ***************************************************************************************************
503 typedef struct _ADDR_COMPUTE_SURFACE_INFO_OUTPUT
505 UINT_32 size
; ///< Size of this structure in bytes
507 UINT_32 pitch
; ///< Pitch in elements (in blocks for compressed formats)
508 UINT_32 height
; ///< Height in elements (in blocks for compressed formats)
509 UINT_32 depth
; ///< Number of slice/depth
510 UINT_64 surfSize
; ///< Surface size in bytes
511 AddrTileMode tileMode
; ///< Actual tile mode. May differ from that in input
512 UINT_32 baseAlign
; ///< Base address alignment
513 UINT_32 pitchAlign
; ///< Pitch alignment, in elements
514 UINT_32 heightAlign
; ///< Height alignment, in elements
515 UINT_32 depthAlign
; ///< Depth alignment, aligned to thickness, for 3d texture
516 UINT_32 bpp
; ///< Bits per elements (e.g. blocks for BCn, 1/3 for 96bit)
517 UINT_32 pixelPitch
; ///< Pitch in original pixels
518 UINT_32 pixelHeight
; ///< Height in original pixels
519 UINT_32 pixelBits
; ///< Original bits per pixel, passed from input
520 UINT_64 sliceSize
; ///< Size of slice specified by input's slice
521 /// The result is controlled by surface flags & createFlags
522 /// By default this value equals to surfSize for volume
523 UINT_32 pitchTileMax
; ///< PITCH_TILE_MAX value for h/w register
524 UINT_32 heightTileMax
; ///< HEIGHT_TILE_MAX value for h/w register
525 UINT_32 sliceTileMax
; ///< SLICE_TILE_MAX value for h/w register
527 UINT_32 numSamples
; ///< Pass the effective numSamples processed in this call
529 /// r800 and later HWL parameters
530 ADDR_TILEINFO
* pTileInfo
; ///< Tile parameters used. Filled in if 0 on input
531 AddrTileType tileType
; ///< Micro tiling type, only valid when tileIndex != -1
532 INT_32 tileIndex
; ///< Tile index, MAY be "downgraded"
534 INT_32 macroModeIndex
; ///< Index in macro tile mode table if there is one (CI)
538 /// Special information to work around SI mipmap swizzle bug UBTS #317508
539 UINT_32 last2DLevel
: 1; ///< TRUE if this is the last 2D(3D) tiled
540 ///< Only meaningful when create flag checkLast2DLevel is set
541 UINT_32 tcCompatible
: 1; ///< If the surface can be shader compatible
542 UINT_32 reserved
:30; ///< Reserved bits
546 ADDR_QBSTEREOINFO
* pStereoInfo
;///< Stereo information, needed when .qbStereo flag is TRUE
547 } ADDR_COMPUTE_SURFACE_INFO_OUTPUT
;
550 ***************************************************************************************************
551 * AddrComputeSurfaceInfo
554 * Compute surface width/height/depth/alignments and suitable tiling mode
555 ***************************************************************************************************
557 ADDR_E_RETURNCODE ADDR_API
AddrComputeSurfaceInfo(
559 const ADDR_COMPUTE_SURFACE_INFO_INPUT
* pIn
,
560 ADDR_COMPUTE_SURFACE_INFO_OUTPUT
* pOut
);
565 ***************************************************************************************************
566 * ADDR_COMPUTE_SURFACE_ADDRFROMCOORD_INPUT
569 * Input structure for AddrComputeSurfaceAddrFromCoord
570 ***************************************************************************************************
572 typedef struct _ADDR_COMPUTE_SURFACE_ADDRFROMCOORD_INPUT
574 UINT_32 size
; ///< Size of this structure in bytes
576 UINT_32 x
; ///< X coordinate
577 UINT_32 y
; ///< Y coordinate
578 UINT_32 slice
; ///< Slice index
579 UINT_32 sample
; ///< Sample index, use fragment index for EQAA
581 UINT_32 bpp
; ///< Bits per pixel
582 UINT_32 pitch
; ///< Surface pitch, in pixels
583 UINT_32 height
; ///< Surface height, in pixels
584 UINT_32 numSlices
; ///< Surface depth
585 UINT_32 numSamples
; ///< Number of samples
587 AddrTileMode tileMode
; ///< Tile mode
588 BOOL_32 isDepth
; ///< TRUE if the surface uses depth sample ordering within
589 /// micro tile. Textures can also choose depth sample order
590 UINT_32 tileBase
; ///< Base offset (in bits) inside micro tile which handles
591 /// the case that components are stored separately
592 UINT_32 compBits
; ///< The component bits actually needed(for planar surface)
594 UINT_32 numFrags
; ///< Number of fragments, leave it zero or the same as
595 /// number of samples for normal AA; Set it to the
596 /// number of fragments for EQAA
597 /// r800 and later HWL parameters
598 // Used for 1D tiling above
599 AddrTileType tileType
; ///< See defintion of AddrTileType
602 UINT_32 ignoreSE
: 1; ///< TRUE if shader engines are ignored. This is texture
603 /// only flag. Only non-RT texture can set this to TRUE
604 UINT_32 reserved
:31; ///< Reserved for future use.
606 // 2D tiling needs following structure
607 ADDR_TILEINFO
* pTileInfo
; ///< 2D tile parameters. Client must provide all data
608 INT_32 tileIndex
; ///< Tile index, MUST be -1 if you don't want to use it
609 /// while the global useTileIndex is set to 1
614 UINT_32 bankSwizzle
; ///< Bank swizzle
615 UINT_32 pipeSwizzle
; ///< Pipe swizzle
617 UINT_32 tileSwizzle
; ///< Combined swizzle, if useCombinedSwizzle is TRUE
620 #if ADDR_AM_BUILD // These two fields are not valid in SW blt since no HTILE access
621 UINT_32 addr5Swizzle
; ///< ADDR5_SWIZZLE_MASK of DB_DEPTH_INFO
622 BOOL_32 is32ByteTile
; ///< Caller must have access to HTILE buffer and know if
623 /// this tile is compressed to 32B
625 } ADDR_COMPUTE_SURFACE_ADDRFROMCOORD_INPUT
;
628 ***************************************************************************************************
629 * ADDR_COMPUTE_SURFACE_ADDRFROMCOORD_OUTPUT
632 * Output structure for AddrComputeSurfaceAddrFromCoord
633 ***************************************************************************************************
635 typedef struct _ADDR_COMPUTE_SURFACE_ADDRFROMCOORD_OUTPUT
637 UINT_32 size
; ///< Size of this structure in bytes
639 UINT_64 addr
; ///< Byte address
640 UINT_32 bitPosition
; ///< Bit position within surfaceAddr, 0-7.
641 /// For surface bpp < 8, e.g. FMT_1.
642 UINT_32 prtBlockIndex
; ///< Index of a PRT tile (64K block)
643 } ADDR_COMPUTE_SURFACE_ADDRFROMCOORD_OUTPUT
;
646 ***************************************************************************************************
647 * AddrComputeSurfaceAddrFromCoord
650 * Compute surface address from a given coordinate.
651 ***************************************************************************************************
653 ADDR_E_RETURNCODE ADDR_API
AddrComputeSurfaceAddrFromCoord(
655 const ADDR_COMPUTE_SURFACE_ADDRFROMCOORD_INPUT
* pIn
,
656 ADDR_COMPUTE_SURFACE_ADDRFROMCOORD_OUTPUT
* pOut
);
661 ***************************************************************************************************
662 * ADDR_COMPUTE_SURFACE_COORDFROMADDR_INPUT
665 * Input structure for AddrComputeSurfaceCoordFromAddr
666 ***************************************************************************************************
668 typedef struct _ADDR_COMPUTE_SURFACE_COORDFROMADDR_INPUT
670 UINT_32 size
; ///< Size of this structure in bytes
672 UINT_64 addr
; ///< Address in bytes
673 UINT_32 bitPosition
; ///< Bit position in addr. 0-7. for surface bpp < 8,
675 UINT_32 bpp
; ///< Bits per pixel
676 UINT_32 pitch
; ///< Pitch, in pixels
677 UINT_32 height
; ///< Height in pixels
678 UINT_32 numSlices
; ///< Surface depth
679 UINT_32 numSamples
; ///< Number of samples
681 AddrTileMode tileMode
; ///< Tile mode
682 BOOL_32 isDepth
; ///< Surface uses depth sample ordering within micro tile.
683 /// Note: Textures can choose depth sample order as well.
684 UINT_32 tileBase
; ///< Base offset (in bits) inside micro tile which handles
685 /// the case that components are stored separately
686 UINT_32 compBits
; ///< The component bits actually needed(for planar surface)
688 UINT_32 numFrags
; ///< Number of fragments, leave it zero or the same as
689 /// number of samples for normal AA; Set it to the
690 /// number of fragments for EQAA
691 /// r800 and later HWL parameters
692 // Used for 1D tiling above
693 AddrTileType tileType
; ///< See defintion of AddrTileType
696 UINT_32 ignoreSE
: 1; ///< TRUE if shader engines are ignored. This is texture
697 /// only flag. Only non-RT texture can set this to TRUE
698 UINT_32 reserved
:31; ///< Reserved for future use.
700 // 2D tiling needs following structure
701 ADDR_TILEINFO
* pTileInfo
; ///< 2D tile parameters. Client must provide all data
702 INT_32 tileIndex
; ///< Tile index, MUST be -1 if you don't want to use it
703 /// while the global useTileIndex is set to 1
708 UINT_32 bankSwizzle
; ///< Bank swizzle
709 UINT_32 pipeSwizzle
; ///< Pipe swizzle
711 UINT_32 tileSwizzle
; ///< Combined swizzle, if useCombinedSwizzle is TRUE
713 } ADDR_COMPUTE_SURFACE_COORDFROMADDR_INPUT
;
716 ***************************************************************************************************
717 * ADDR_COMPUTE_SURFACE_COORDFROMADDR_OUTPUT
720 * Output structure for AddrComputeSurfaceCoordFromAddr
721 ***************************************************************************************************
723 typedef struct _ADDR_COMPUTE_SURFACE_COORDFROMADDR_OUTPUT
725 UINT_32 size
; ///< Size of this structure in bytes
727 UINT_32 x
; ///< X coordinate
728 UINT_32 y
; ///< Y coordinate
729 UINT_32 slice
; ///< Index of slices
730 UINT_32 sample
; ///< Index of samples, means fragment index for EQAA
731 } ADDR_COMPUTE_SURFACE_COORDFROMADDR_OUTPUT
;
734 ***************************************************************************************************
735 * AddrComputeSurfaceCoordFromAddr
738 * Compute coordinate from a given surface address
739 ***************************************************************************************************
741 ADDR_E_RETURNCODE ADDR_API
AddrComputeSurfaceCoordFromAddr(
743 const ADDR_COMPUTE_SURFACE_COORDFROMADDR_INPUT
* pIn
,
744 ADDR_COMPUTE_SURFACE_COORDFROMADDR_OUTPUT
* pOut
);
746 ///////////////////////////////////////////////////////////////////////////////////////////////////
748 ///////////////////////////////////////////////////////////////////////////////////////////////////
751 ***************************************************************************************************
756 ***************************************************************************************************
758 typedef union _ADDR_HTILE_FLAGS
762 UINT_32 tcCompatible
: 1; ///< Flag indicates surface needs to be shader readable
763 UINT_32 reserved
:31; ///< Reserved bits
770 ***************************************************************************************************
771 * ADDR_COMPUTE_HTILE_INFO_INPUT
774 * Input structure of AddrComputeHtileInfo
775 ***************************************************************************************************
777 typedef struct _ADDR_COMPUTE_HTILE_INFO_INPUT
779 UINT_32 size
; ///< Size of this structure in bytes
781 ADDR_HTILE_FLAGS flags
; ///< HTILE flags
782 UINT_32 pitch
; ///< Surface pitch, in pixels
783 UINT_32 height
; ///< Surface height, in pixels
784 UINT_32 numSlices
; ///< Number of slices
785 BOOL_32 isLinear
; ///< Linear or tiled HTILE layout
786 AddrHtileBlockSize blockWidth
; ///< 4 or 8. EG above only support 8
787 AddrHtileBlockSize blockHeight
; ///< 4 or 8. EG above only support 8
788 ADDR_TILEINFO
* pTileInfo
; ///< Tile info
790 INT_32 tileIndex
; ///< Tile index, MUST be -1 if you don't want to use it
791 /// while the global useTileIndex is set to 1
792 INT_32 macroModeIndex
; ///< Index in macro tile mode table if there is one (CI)
793 ///< README: When tileIndex is not -1, this must be valid
794 } ADDR_COMPUTE_HTILE_INFO_INPUT
;
797 ***************************************************************************************************
798 * ADDR_COMPUTE_HTILE_INFO_OUTPUT
801 * Output structure of AddrComputeHtileInfo
802 ***************************************************************************************************
804 typedef struct _ADDR_COMPUTE_HTILE_INFO_OUTPUT
806 UINT_32 size
; ///< Size of this structure in bytes
808 UINT_32 pitch
; ///< Pitch in pixels of depth buffer represented in this
809 /// HTile buffer. This might be larger than original depth
810 /// buffer pitch when called with an unaligned pitch.
811 UINT_32 height
; ///< Height in pixels, as above
812 UINT_64 htileBytes
; ///< Size of HTILE buffer, in bytes
813 UINT_32 baseAlign
; ///< Base alignment
814 UINT_32 bpp
; ///< Bits per pixel for HTILE is how many bits for an 8x8 block!
815 UINT_32 macroWidth
; ///< Macro width in pixels, actually squared cache shape
816 UINT_32 macroHeight
; ///< Macro height in pixels
817 UINT_64 sliceSize
; ///< Slice size, in bytes.
818 } ADDR_COMPUTE_HTILE_INFO_OUTPUT
;
821 ***************************************************************************************************
822 * AddrComputeHtileInfo
825 * Compute Htile pitch, height, base alignment and size in bytes
826 ***************************************************************************************************
828 ADDR_E_RETURNCODE ADDR_API
AddrComputeHtileInfo(
830 const ADDR_COMPUTE_HTILE_INFO_INPUT
* pIn
,
831 ADDR_COMPUTE_HTILE_INFO_OUTPUT
* pOut
);
836 ***************************************************************************************************
837 * ADDR_COMPUTE_HTILE_ADDRFROMCOORD_INPUT
840 * Input structure for AddrComputeHtileAddrFromCoord
841 ***************************************************************************************************
843 typedef struct _ADDR_COMPUTE_HTILE_ADDRFROMCOORD_INPUT
845 UINT_32 size
; ///< Size of this structure in bytes
847 UINT_32 pitch
; ///< Pitch, in pixels
848 UINT_32 height
; ///< Height in pixels
849 UINT_32 x
; ///< X coordinate
850 UINT_32 y
; ///< Y coordinate
851 UINT_32 slice
; ///< Index of slice
852 UINT_32 numSlices
; ///< Number of slices
853 BOOL_32 isLinear
; ///< Linear or tiled HTILE layout
854 AddrHtileBlockSize blockWidth
; ///< 4 or 8. 1 means 8, 0 means 4. EG above only support 8
855 AddrHtileBlockSize blockHeight
; ///< 4 or 8. 1 means 8, 0 means 4. EG above only support 8
856 ADDR_TILEINFO
* pTileInfo
; ///< Tile info
858 INT_32 tileIndex
; ///< Tile index, MUST be -1 if you don't want to use it
859 /// while the global useTileIndex is set to 1
860 INT_32 macroModeIndex
; ///< Index in macro tile mode table if there is one (CI)
861 ///< README: When tileIndex is not -1, this must be valid
862 } ADDR_COMPUTE_HTILE_ADDRFROMCOORD_INPUT
;
865 ***************************************************************************************************
866 * ADDR_COMPUTE_HTILE_ADDRFROMCOORD_OUTPUT
869 * Output structure for AddrComputeHtileAddrFromCoord
870 ***************************************************************************************************
872 typedef struct _ADDR_COMPUTE_HTILE_ADDRFROMCOORD_OUTPUT
874 UINT_32 size
; ///< Size of this structure in bytes
876 UINT_64 addr
; ///< Address in bytes
877 UINT_32 bitPosition
; ///< Bit position, 0 or 4. CMASK and HTILE shares some lib method.
878 /// So we keep bitPosition for HTILE as well
879 } ADDR_COMPUTE_HTILE_ADDRFROMCOORD_OUTPUT
;
882 ***************************************************************************************************
883 * AddrComputeHtileAddrFromCoord
886 * Compute Htile address according to coordinates (of depth buffer)
887 ***************************************************************************************************
889 ADDR_E_RETURNCODE ADDR_API
AddrComputeHtileAddrFromCoord(
891 const ADDR_COMPUTE_HTILE_ADDRFROMCOORD_INPUT
* pIn
,
892 ADDR_COMPUTE_HTILE_ADDRFROMCOORD_OUTPUT
* pOut
);
897 ***************************************************************************************************
898 * ADDR_COMPUTE_HTILE_COORDFROMADDR_INPUT
901 * Input structure for AddrComputeHtileCoordFromAddr
902 ***************************************************************************************************
904 typedef struct _ADDR_COMPUTE_HTILE_COORDFROMADDR_INPUT
906 UINT_32 size
; ///< Size of this structure in bytes
908 UINT_64 addr
; ///< Address
909 UINT_32 bitPosition
; ///< Bit position 0 or 4. CMASK and HTILE share some methods
910 /// so we keep bitPosition for HTILE as well
911 UINT_32 pitch
; ///< Pitch, in pixels
912 UINT_32 height
; ///< Height, in pixels
913 UINT_32 numSlices
; ///< Number of slices
914 BOOL_32 isLinear
; ///< Linear or tiled HTILE layout
915 AddrHtileBlockSize blockWidth
; ///< 4 or 8. 1 means 8, 0 means 4. R8xx/R9xx only support 8
916 AddrHtileBlockSize blockHeight
; ///< 4 or 8. 1 means 8, 0 means 4. R8xx/R9xx only support 8
917 ADDR_TILEINFO
* pTileInfo
; ///< Tile info
919 INT_32 tileIndex
; ///< Tile index, MUST be -1 if you don't want to use it
920 /// while the global useTileIndex is set to 1
921 INT_32 macroModeIndex
; ///< Index in macro tile mode table if there is one (CI)
922 ///< README: When tileIndex is not -1, this must be valid
923 } ADDR_COMPUTE_HTILE_COORDFROMADDR_INPUT
;
926 ***************************************************************************************************
927 * ADDR_COMPUTE_HTILE_COORDFROMADDR_OUTPUT
930 * Output structure for AddrComputeHtileCoordFromAddr
931 ***************************************************************************************************
933 typedef struct _ADDR_COMPUTE_HTILE_COORDFROMADDR_OUTPUT
935 UINT_32 size
; ///< Size of this structure in bytes
937 UINT_32 x
; ///< X coordinate
938 UINT_32 y
; ///< Y coordinate
939 UINT_32 slice
; ///< Slice index
940 } ADDR_COMPUTE_HTILE_COORDFROMADDR_OUTPUT
;
943 ***************************************************************************************************
944 * AddrComputeHtileCoordFromAddr
947 * Compute coordinates within depth buffer (1st pixel of a micro tile) according to
949 ***************************************************************************************************
951 ADDR_E_RETURNCODE ADDR_API
AddrComputeHtileCoordFromAddr(
953 const ADDR_COMPUTE_HTILE_COORDFROMADDR_INPUT
* pIn
,
954 ADDR_COMPUTE_HTILE_COORDFROMADDR_OUTPUT
* pOut
);
958 ///////////////////////////////////////////////////////////////////////////////////////////////////
960 ///////////////////////////////////////////////////////////////////////////////////////////////////
963 ***************************************************************************************************
968 ***************************************************************************************************
970 typedef union _ADDR_CMASK_FLAGS
974 UINT_32 tcCompatible
: 1; ///< Flag indicates surface needs to be shader readable
975 UINT_32 reserved
:31; ///< Reserved bits
982 ***************************************************************************************************
983 * ADDR_COMPUTE_CMASK_INFO_INPUT
986 * Input structure of AddrComputeCmaskInfo
987 ***************************************************************************************************
989 typedef struct _ADDR_COMPUTE_CMASKINFO_INPUT
991 UINT_32 size
; ///< Size of this structure in bytes
993 ADDR_CMASK_FLAGS flags
; ///< CMASK flags
994 UINT_32 pitch
; ///< Pitch, in pixels, of color buffer
995 UINT_32 height
; ///< Height, in pixels, of color buffer
996 UINT_32 numSlices
; ///< Number of slices, of color buffer
997 BOOL_32 isLinear
; ///< Linear or tiled layout, Only SI can be linear
998 ADDR_TILEINFO
* pTileInfo
; ///< Tile info
1000 INT_32 tileIndex
; ///< Tile index, MUST be -1 if you don't want to use it
1001 /// while the global useTileIndex is set to 1
1002 INT_32 macroModeIndex
; ///< Index in macro tile mode table if there is one (CI)
1003 ///< README: When tileIndex is not -1, this must be valid
1004 } ADDR_COMPUTE_CMASK_INFO_INPUT
;
1007 ***************************************************************************************************
1008 * ADDR_COMPUTE_CMASK_INFO_OUTPUT
1011 * Output structure of AddrComputeCmaskInfo
1012 ***************************************************************************************************
1014 typedef struct _ADDR_COMPUTE_CMASK_INFO_OUTPUT
1016 UINT_32 size
; ///< Size of this structure in bytes
1018 UINT_32 pitch
; ///< Pitch in pixels of color buffer which
1019 /// this Cmask matches. The size might be larger than
1020 /// original color buffer pitch when called with
1021 /// an unaligned pitch.
1022 UINT_32 height
; ///< Height in pixels, as above
1023 UINT_64 cmaskBytes
; ///< Size in bytes of CMask buffer
1024 UINT_32 baseAlign
; ///< Base alignment
1025 UINT_32 blockMax
; ///< Cmask block size. Need this to set CB_COLORn_MASK register
1026 UINT_32 macroWidth
; ///< Macro width in pixels, actually squared cache shape
1027 UINT_32 macroHeight
; ///< Macro height in pixels
1028 UINT_64 sliceSize
; ///< Slice size, in bytes.
1029 } ADDR_COMPUTE_CMASK_INFO_OUTPUT
;
1032 ***************************************************************************************************
1033 * AddrComputeCmaskInfo
1036 * Compute Cmask pitch, height, base alignment and size in bytes from color buffer
1038 ***************************************************************************************************
1040 ADDR_E_RETURNCODE ADDR_API
AddrComputeCmaskInfo(
1042 const ADDR_COMPUTE_CMASK_INFO_INPUT
* pIn
,
1043 ADDR_COMPUTE_CMASK_INFO_OUTPUT
* pOut
);
1048 ***************************************************************************************************
1049 * ADDR_COMPUTE_CMASK_ADDRFROMCOORD_INPUT
1052 * Input structure for AddrComputeCmaskAddrFromCoord
1054 ***************************************************************************************************
1056 typedef struct _ADDR_COMPUTE_CMASK_ADDRFROMCOORD_INPUT
1058 UINT_32 size
; ///< Size of this structure in bytes
1059 UINT_32 x
; ///< X coordinate
1060 UINT_32 y
; ///< Y coordinate
1061 UINT_64 fmaskAddr
; ///< Fmask addr for tc compatible Cmask
1062 UINT_32 slice
; ///< Slice index
1063 UINT_32 pitch
; ///< Pitch in pixels, of color buffer
1064 UINT_32 height
; ///< Height in pixels, of color buffer
1065 UINT_32 numSlices
; ///< Number of slices
1067 BOOL_32 isLinear
; ///< Linear or tiled layout, Only SI can be linear
1068 ADDR_CMASK_FLAGS flags
; ///< CMASK flags
1069 ADDR_TILEINFO
* pTileInfo
; ///< Tile info
1071 INT_32 tileIndex
; ///< Tile index, MUST be -1 if you don't want to use it
1072 ///< while the global useTileIndex is set to 1
1073 INT_32 macroModeIndex
; ///< Index in macro tile mode table if there is one (CI)
1074 ///< README: When tileIndex is not -1, this must be valid
1075 } ADDR_COMPUTE_CMASK_ADDRFROMCOORD_INPUT
;
1078 ***************************************************************************************************
1079 * ADDR_COMPUTE_CMASK_ADDRFROMCOORD_OUTPUT
1082 * Output structure for AddrComputeCmaskAddrFromCoord
1083 ***************************************************************************************************
1085 typedef struct _ADDR_COMPUTE_CMASK_ADDRFROMCOORD_OUTPUT
1087 UINT_32 size
; ///< Size of this structure in bytes
1089 UINT_64 addr
; ///< CMASK address in bytes
1090 UINT_32 bitPosition
; ///< Bit position within addr, 0-7. CMASK is 4 bpp,
1091 /// so the address may be located in bit 0 (0) or 4 (4)
1092 } ADDR_COMPUTE_CMASK_ADDRFROMCOORD_OUTPUT
;
1095 ***************************************************************************************************
1096 * AddrComputeCmaskAddrFromCoord
1099 * Compute Cmask address according to coordinates (of MSAA color buffer)
1100 ***************************************************************************************************
1102 ADDR_E_RETURNCODE ADDR_API
AddrComputeCmaskAddrFromCoord(
1104 const ADDR_COMPUTE_CMASK_ADDRFROMCOORD_INPUT
* pIn
,
1105 ADDR_COMPUTE_CMASK_ADDRFROMCOORD_OUTPUT
* pOut
);
1110 ***************************************************************************************************
1111 * ADDR_COMPUTE_CMASK_COORDFROMADDR_INPUT
1114 * Input structure for AddrComputeCmaskCoordFromAddr
1115 ***************************************************************************************************
1117 typedef struct _ADDR_COMPUTE_CMASK_COORDFROMADDR_INPUT
1119 UINT_32 size
; ///< Size of this structure in bytes
1121 UINT_64 addr
; ///< CMASK address in bytes
1122 UINT_32 bitPosition
; ///< Bit position within addr, 0-7. CMASK is 4 bpp,
1123 /// so the address may be located in bit 0 (0) or 4 (4)
1124 UINT_32 pitch
; ///< Pitch, in pixels
1125 UINT_32 height
; ///< Height in pixels
1126 UINT_32 numSlices
; ///< Number of slices
1127 BOOL_32 isLinear
; ///< Linear or tiled layout, Only SI can be linear
1128 ADDR_TILEINFO
* pTileInfo
; ///< Tile info
1130 INT_32 tileIndex
; ///< Tile index, MUST be -1 if you don't want to use it
1131 /// while the global useTileIndex is set to 1
1132 INT_32 macroModeIndex
; ///< Index in macro tile mode table if there is one (CI)
1133 ///< README: When tileIndex is not -1, this must be valid
1134 } ADDR_COMPUTE_CMASK_COORDFROMADDR_INPUT
;
1137 ***************************************************************************************************
1138 * ADDR_COMPUTE_CMASK_COORDFROMADDR_OUTPUT
1141 * Output structure for AddrComputeCmaskCoordFromAddr
1142 ***************************************************************************************************
1144 typedef struct _ADDR_COMPUTE_CMASK_COORDFROMADDR_OUTPUT
1146 UINT_32 size
; ///< Size of this structure in bytes
1148 UINT_32 x
; ///< X coordinate
1149 UINT_32 y
; ///< Y coordinate
1150 UINT_32 slice
; ///< Slice index
1151 } ADDR_COMPUTE_CMASK_COORDFROMADDR_OUTPUT
;
1154 ***************************************************************************************************
1155 * AddrComputeCmaskCoordFromAddr
1158 * Compute coordinates within color buffer (1st pixel of a micro tile) according to
1160 ***************************************************************************************************
1162 ADDR_E_RETURNCODE ADDR_API
AddrComputeCmaskCoordFromAddr(
1164 const ADDR_COMPUTE_CMASK_COORDFROMADDR_INPUT
* pIn
,
1165 ADDR_COMPUTE_CMASK_COORDFROMADDR_OUTPUT
* pOut
);
1169 ///////////////////////////////////////////////////////////////////////////////////////////////////
1171 ///////////////////////////////////////////////////////////////////////////////////////////////////
1174 ***************************************************************************************************
1175 * ADDR_COMPUTE_FMASK_INFO_INPUT
1178 * Input structure for AddrComputeFmaskInfo
1179 ***************************************************************************************************
1181 typedef struct _ADDR_COMPUTE_FMASK_INFO_INPUT
1183 UINT_32 size
; ///< Size of this structure in bytes
1185 AddrTileMode tileMode
; ///< Tile mode
1186 UINT_32 pitch
; ///< Surface pitch, in pixels
1187 UINT_32 height
; ///< Surface height, in pixels
1188 UINT_32 numSlices
; ///< Number of slice/depth
1189 UINT_32 numSamples
; ///< Number of samples
1190 UINT_32 numFrags
; ///< Number of fragments, leave it zero or the same as
1191 /// number of samples for normal AA; Set it to the
1192 /// number of fragments for EQAA
1193 /// r800 and later HWL parameters
1196 UINT_32 resolved
: 1; ///< TRUE if the surface is for resolved fmask, only used
1197 /// by H/W clients. S/W should always set it to FALSE.
1198 UINT_32 reserved
: 31; ///< Reserved for future use.
1200 ADDR_TILEINFO
* pTileInfo
; ///< 2D tiling parameters. Clients must give valid data
1201 INT_32 tileIndex
; ///< Tile index, MUST be -1 if you don't want to use it
1202 /// while the global useTileIndex is set to 1
1203 } ADDR_COMPUTE_FMASK_INFO_INPUT
;
1206 ***************************************************************************************************
1207 * ADDR_COMPUTE_FMASK_INFO_OUTPUT
1210 * Output structure for AddrComputeFmaskInfo
1211 ***************************************************************************************************
1213 typedef struct _ADDR_COMPUTE_FMASK_INFO_OUTPUT
1215 UINT_32 size
; ///< Size of this structure in bytes
1217 UINT_32 pitch
; ///< Pitch of fmask in pixels
1218 UINT_32 height
; ///< Height of fmask in pixels
1219 UINT_32 numSlices
; ///< Slices of fmask
1220 UINT_64 fmaskBytes
; ///< Size of fmask in bytes
1221 UINT_32 baseAlign
; ///< Base address alignment
1222 UINT_32 pitchAlign
; ///< Pitch alignment
1223 UINT_32 heightAlign
; ///< Height alignment
1224 UINT_32 bpp
; ///< Bits per pixel of FMASK is: number of bit planes
1225 UINT_32 numSamples
; ///< Number of samples, used for dump, export this since input
1226 /// may be changed in 9xx and above
1227 /// r800 and later HWL parameters
1228 ADDR_TILEINFO
* pTileInfo
; ///< Tile parameters used. Fmask can have different
1229 /// bank_height from color buffer
1230 INT_32 tileIndex
; ///< Tile index, MUST be -1 if you don't want to use it
1231 /// while the global useTileIndex is set to 1
1232 INT_32 macroModeIndex
; ///< Index in macro tile mode table if there is one (CI)
1233 UINT_64 sliceSize
; ///< Size of slice in bytes
1234 } ADDR_COMPUTE_FMASK_INFO_OUTPUT
;
1237 ***************************************************************************************************
1238 * AddrComputeFmaskInfo
1241 * Compute Fmask pitch/height/depth/alignments and size in bytes
1242 ***************************************************************************************************
1244 ADDR_E_RETURNCODE ADDR_API
AddrComputeFmaskInfo(
1246 const ADDR_COMPUTE_FMASK_INFO_INPUT
* pIn
,
1247 ADDR_COMPUTE_FMASK_INFO_OUTPUT
* pOut
);
1252 ***************************************************************************************************
1253 * ADDR_COMPUTE_FMASK_ADDRFROMCOORD_INPUT
1256 * Input structure for AddrComputeFmaskAddrFromCoord
1257 ***************************************************************************************************
1259 typedef struct _ADDR_COMPUTE_FMASK_ADDRFROMCOORD_INPUT
1261 UINT_32 size
; ///< Size of this structure in bytes
1263 UINT_32 x
; ///< X coordinate
1264 UINT_32 y
; ///< Y coordinate
1265 UINT_32 slice
; ///< Slice index
1266 UINT_32 plane
; ///< Plane number
1267 UINT_32 sample
; ///< Sample index (fragment index for EQAA)
1269 UINT_32 pitch
; ///< Surface pitch, in pixels
1270 UINT_32 height
; ///< Surface height, in pixels
1271 UINT_32 numSamples
; ///< Number of samples
1272 UINT_32 numFrags
; ///< Number of fragments, leave it zero or the same as
1273 /// number of samples for normal AA; Set it to the
1274 /// number of fragments for EQAA
1276 AddrTileMode tileMode
; ///< Tile mode
1281 UINT_32 bankSwizzle
; ///< Bank swizzle
1282 UINT_32 pipeSwizzle
; ///< Pipe swizzle
1284 UINT_32 tileSwizzle
; ///< Combined swizzle, if useCombinedSwizzle is TRUE
1287 /// r800 and later HWL parameters
1290 UINT_32 resolved
: 1; ///< TRUE if this is a resolved fmask, used by H/W clients
1291 UINT_32 ignoreSE
: 1; ///< TRUE if shader engines are ignored.
1292 UINT_32 reserved
: 30; ///< Reserved for future use.
1294 ADDR_TILEINFO
* pTileInfo
; ///< 2D tiling parameters. Client must provide all data
1296 } ADDR_COMPUTE_FMASK_ADDRFROMCOORD_INPUT
;
1299 ***************************************************************************************************
1300 * ADDR_COMPUTE_FMASK_ADDRFROMCOORD_OUTPUT
1303 * Output structure for AddrComputeFmaskAddrFromCoord
1304 ***************************************************************************************************
1306 typedef struct _ADDR_COMPUTE_FMASK_ADDRFROMCOORD_OUTPUT
1308 UINT_32 size
; ///< Size of this structure in bytes
1310 UINT_64 addr
; ///< Fmask address
1311 UINT_32 bitPosition
; ///< Bit position within fmaskAddr, 0-7.
1312 } ADDR_COMPUTE_FMASK_ADDRFROMCOORD_OUTPUT
;
1315 ***************************************************************************************************
1316 * AddrComputeFmaskAddrFromCoord
1319 * Compute Fmask address according to coordinates (x,y,slice,sample,plane)
1320 ***************************************************************************************************
1322 ADDR_E_RETURNCODE ADDR_API
AddrComputeFmaskAddrFromCoord(
1324 const ADDR_COMPUTE_FMASK_ADDRFROMCOORD_INPUT
* pIn
,
1325 ADDR_COMPUTE_FMASK_ADDRFROMCOORD_OUTPUT
* pOut
);
1330 ***************************************************************************************************
1331 * ADDR_COMPUTE_FMASK_COORDFROMADDR_INPUT
1334 * Input structure for AddrComputeFmaskCoordFromAddr
1335 ***************************************************************************************************
1337 typedef struct _ADDR_COMPUTE_FMASK_COORDFROMADDR_INPUT
1339 UINT_32 size
; ///< Size of this structure in bytes
1341 UINT_64 addr
; ///< Address
1342 UINT_32 bitPosition
; ///< Bit position within addr, 0-7.
1344 UINT_32 pitch
; ///< Pitch, in pixels
1345 UINT_32 height
; ///< Height in pixels
1346 UINT_32 numSamples
; ///< Number of samples
1347 UINT_32 numFrags
; ///< Number of fragments
1348 AddrTileMode tileMode
; ///< Tile mode
1353 UINT_32 bankSwizzle
; ///< Bank swizzle
1354 UINT_32 pipeSwizzle
; ///< Pipe swizzle
1356 UINT_32 tileSwizzle
; ///< Combined swizzle, if useCombinedSwizzle is TRUE
1359 /// r800 and later HWL parameters
1362 UINT_32 resolved
: 1; ///< TRUE if this is a resolved fmask, used by HW components
1363 UINT_32 ignoreSE
: 1; ///< TRUE if shader engines are ignored.
1364 UINT_32 reserved
: 30; ///< Reserved for future use.
1366 ADDR_TILEINFO
* pTileInfo
; ///< 2D tile parameters. Client must provide all data
1368 } ADDR_COMPUTE_FMASK_COORDFROMADDR_INPUT
;
1371 ***************************************************************************************************
1372 * ADDR_COMPUTE_FMASK_COORDFROMADDR_OUTPUT
1375 * Output structure for AddrComputeFmaskCoordFromAddr
1376 ***************************************************************************************************
1378 typedef struct _ADDR_COMPUTE_FMASK_COORDFROMADDR_OUTPUT
1380 UINT_32 size
; ///< Size of this structure in bytes
1382 UINT_32 x
; ///< X coordinate
1383 UINT_32 y
; ///< Y coordinate
1384 UINT_32 slice
; ///< Slice index
1385 UINT_32 plane
; ///< Plane number
1386 UINT_32 sample
; ///< Sample index (fragment index for EQAA)
1387 } ADDR_COMPUTE_FMASK_COORDFROMADDR_OUTPUT
;
1390 ***************************************************************************************************
1391 * AddrComputeFmaskCoordFromAddr
1394 * Compute FMASK coordinate from an given address
1395 ***************************************************************************************************
1397 ADDR_E_RETURNCODE ADDR_API
AddrComputeFmaskCoordFromAddr(
1399 const ADDR_COMPUTE_FMASK_COORDFROMADDR_INPUT
* pIn
,
1400 ADDR_COMPUTE_FMASK_COORDFROMADDR_OUTPUT
* pOut
);
1404 ///////////////////////////////////////////////////////////////////////////////////////////////////
1405 // Element/utility functions
1406 ///////////////////////////////////////////////////////////////////////////////////////////////////
1409 ***************************************************************************************************
1413 * Get AddrLib version number
1414 ***************************************************************************************************
1416 UINT_32 ADDR_API
AddrGetVersion(ADDR_HANDLE hLib
);
1419 ***************************************************************************************************
1423 * Return TRUE if tileIndex is enabled in this address library
1424 ***************************************************************************************************
1426 BOOL_32 ADDR_API
AddrUseTileIndex(ADDR_HANDLE hLib
);
1429 ***************************************************************************************************
1430 * AddrUseCombinedSwizzle
1433 * Return TRUE if combined swizzle is enabled in this address library
1434 ***************************************************************************************************
1436 BOOL_32 ADDR_API
AddrUseCombinedSwizzle(ADDR_HANDLE hLib
);
1439 ***************************************************************************************************
1440 * ADDR_EXTRACT_BANKPIPE_SWIZZLE_INPUT
1443 * Input structure of AddrExtractBankPipeSwizzle
1444 ***************************************************************************************************
1446 typedef struct _ADDR_EXTRACT_BANKPIPE_SWIZZLE_INPUT
1448 UINT_32 size
; ///< Size of this structure in bytes
1450 UINT_32 base256b
; ///< Base256b value
1452 /// r800 and later HWL parameters
1453 ADDR_TILEINFO
* pTileInfo
; ///< 2D tile parameters. Client must provide all data
1455 INT_32 tileIndex
; ///< Tile index, MUST be -1 if you don't want to use it
1456 /// while the global useTileIndex is set to 1
1457 INT_32 macroModeIndex
; ///< Index in macro tile mode table if there is one (CI)
1458 ///< README: When tileIndex is not -1, this must be valid
1459 } ADDR_EXTRACT_BANKPIPE_SWIZZLE_INPUT
;
1462 ***************************************************************************************************
1463 * ADDR_EXTRACT_BANKPIPE_SWIZZLE_OUTPUT
1466 * Output structure of AddrExtractBankPipeSwizzle
1467 ***************************************************************************************************
1469 typedef struct _ADDR_EXTRACT_BANKPIPE_SWIZZLE_OUTPUT
1471 UINT_32 size
; ///< Size of this structure in bytes
1473 UINT_32 bankSwizzle
; ///< Bank swizzle
1474 UINT_32 pipeSwizzle
; ///< Pipe swizzle
1475 } ADDR_EXTRACT_BANKPIPE_SWIZZLE_OUTPUT
;
1478 ***************************************************************************************************
1479 * AddrExtractBankPipeSwizzle
1482 * Extract Bank and Pipe swizzle from base256b
1484 * ADDR_OK if no error
1485 ***************************************************************************************************
1487 ADDR_E_RETURNCODE ADDR_API
AddrExtractBankPipeSwizzle(
1489 const ADDR_EXTRACT_BANKPIPE_SWIZZLE_INPUT
* pIn
,
1490 ADDR_EXTRACT_BANKPIPE_SWIZZLE_OUTPUT
* pOut
);
1494 ***************************************************************************************************
1495 * ADDR_COMBINE_BANKPIPE_SWIZZLE_INPUT
1498 * Input structure of AddrCombineBankPipeSwizzle
1499 ***************************************************************************************************
1501 typedef struct _ADDR_COMBINE_BANKPIPE_SWIZZLE_INPUT
1503 UINT_32 size
; ///< Size of this structure in bytes
1505 UINT_32 bankSwizzle
; ///< Bank swizzle
1506 UINT_32 pipeSwizzle
; ///< Pipe swizzle
1507 UINT_64 baseAddr
; ///< Base address (leave it zero for driver clients)
1509 /// r800 and later HWL parameters
1510 ADDR_TILEINFO
* pTileInfo
; ///< 2D tile parameters. Client must provide all data
1512 INT_32 tileIndex
; ///< Tile index, MUST be -1 if you don't want to use it
1513 /// while the global useTileIndex is set to 1
1514 INT_32 macroModeIndex
; ///< Index in macro tile mode table if there is one (CI)
1515 ///< README: When tileIndex is not -1, this must be valid
1516 } ADDR_COMBINE_BANKPIPE_SWIZZLE_INPUT
;
1519 ***************************************************************************************************
1520 * ADDR_COMBINE_BANKPIPE_SWIZZLE_OUTPUT
1523 * Output structure of AddrCombineBankPipeSwizzle
1524 ***************************************************************************************************
1526 typedef struct _ADDR_COMBINE_BANKPIPE_SWIZZLE_OUTPUT
1528 UINT_32 size
; ///< Size of this structure in bytes
1530 UINT_32 tileSwizzle
; ///< Combined swizzle
1531 } ADDR_COMBINE_BANKPIPE_SWIZZLE_OUTPUT
;
1534 ***************************************************************************************************
1535 * AddrCombineBankPipeSwizzle
1538 * Combine Bank and Pipe swizzle
1540 * ADDR_OK if no error
1542 * baseAddr here is full MCAddress instead of base256b
1543 ***************************************************************************************************
1545 ADDR_E_RETURNCODE ADDR_API
AddrCombineBankPipeSwizzle(
1547 const ADDR_COMBINE_BANKPIPE_SWIZZLE_INPUT
* pIn
,
1548 ADDR_COMBINE_BANKPIPE_SWIZZLE_OUTPUT
* pOut
);
1553 ***************************************************************************************************
1554 * ADDR_COMPUTE_SLICESWIZZLE_INPUT
1557 * Input structure of AddrComputeSliceSwizzle
1558 ***************************************************************************************************
1560 typedef struct _ADDR_COMPUTE_SLICESWIZZLE_INPUT
1562 UINT_32 size
; ///< Size of this structure in bytes
1564 AddrTileMode tileMode
; ///< Tile Mode
1565 UINT_32 baseSwizzle
; ///< Base tile swizzle
1566 UINT_32 slice
; ///< Slice index
1567 UINT_64 baseAddr
; ///< Base address, driver should leave it 0 in most cases
1569 /// r800 and later HWL parameters
1570 ADDR_TILEINFO
* pTileInfo
; ///< 2D tile parameters. Actually banks needed here!
1572 INT_32 tileIndex
; ///< Tile index, MUST be -1 if you don't want to use it
1573 /// while the global useTileIndex is set to 1
1574 INT_32 macroModeIndex
; ///< Index in macro tile mode table if there is one (CI)
1575 ///< README: When tileIndex is not -1, this must be valid
1576 } ADDR_COMPUTE_SLICESWIZZLE_INPUT
;
1581 ***************************************************************************************************
1582 * ADDR_COMPUTE_SLICESWIZZLE_OUTPUT
1585 * Output structure of AddrComputeSliceSwizzle
1586 ***************************************************************************************************
1588 typedef struct _ADDR_COMPUTE_SLICESWIZZLE_OUTPUT
1590 UINT_32 size
; ///< Size of this structure in bytes
1592 UINT_32 tileSwizzle
; ///< Recalculated tileSwizzle value
1593 } ADDR_COMPUTE_SLICESWIZZLE_OUTPUT
;
1596 ***************************************************************************************************
1597 * AddrComputeSliceSwizzle
1600 * Extract Bank and Pipe swizzle from base256b
1602 * ADDR_OK if no error
1603 ***************************************************************************************************
1605 ADDR_E_RETURNCODE ADDR_API
AddrComputeSliceSwizzle(
1607 const ADDR_COMPUTE_SLICESWIZZLE_INPUT
* pIn
,
1608 ADDR_COMPUTE_SLICESWIZZLE_OUTPUT
* pOut
);
1612 ***************************************************************************************************
1613 * AddrSwizzleGenOption
1616 * Which swizzle generating options: legacy or linear
1617 ***************************************************************************************************
1619 typedef enum _AddrSwizzleGenOption
1621 ADDR_SWIZZLE_GEN_DEFAULT
= 0, ///< As is in client driver implemention for swizzle
1622 ADDR_SWIZZLE_GEN_LINEAR
= 1, ///< Using a linear increment of swizzle
1623 } AddrSwizzleGenOption
;
1626 ***************************************************************************************************
1630 * Controls how swizzle is generated
1631 ***************************************************************************************************
1633 typedef union _ADDR_SWIZZLE_OPTION
1637 UINT_32 genOption
: 1; ///< The way swizzle is generated, see AddrSwizzleGenOption
1638 UINT_32 reduceBankBit
: 1; ///< TRUE if we need reduce swizzle bits
1639 UINT_32 reserved
:30; ///< Reserved bits
1644 } ADDR_SWIZZLE_OPTION
;
1647 ***************************************************************************************************
1648 * ADDR_COMPUTE_BASE_SWIZZLE_INPUT
1651 * Input structure of AddrComputeBaseSwizzle
1652 ***************************************************************************************************
1654 typedef struct _ADDR_COMPUTE_BASE_SWIZZLE_INPUT
1656 UINT_32 size
; ///< Size of this structure in bytes
1658 ADDR_SWIZZLE_OPTION option
; ///< Swizzle option
1659 UINT_32 surfIndex
; ///< Index of this surface type
1660 AddrTileMode tileMode
; ///< Tile Mode
1662 /// r800 and later HWL parameters
1663 ADDR_TILEINFO
* pTileInfo
; ///< 2D tile parameters. Actually banks needed here!
1665 INT_32 tileIndex
; ///< Tile index, MUST be -1 if you don't want to use it
1666 /// while the global useTileIndex is set to 1
1667 INT_32 macroModeIndex
; ///< Index in macro tile mode table if there is one (CI)
1668 ///< README: When tileIndex is not -1, this must be valid
1669 } ADDR_COMPUTE_BASE_SWIZZLE_INPUT
;
1672 ***************************************************************************************************
1673 * ADDR_COMPUTE_BASE_SWIZZLE_OUTPUT
1676 * Output structure of AddrComputeBaseSwizzle
1677 ***************************************************************************************************
1679 typedef struct _ADDR_COMPUTE_BASE_SWIZZLE_OUTPUT
1681 UINT_32 size
; ///< Size of this structure in bytes
1683 UINT_32 tileSwizzle
; ///< Combined swizzle
1684 } ADDR_COMPUTE_BASE_SWIZZLE_OUTPUT
;
1687 ***************************************************************************************************
1688 * AddrComputeBaseSwizzle
1691 * Return a Combined Bank and Pipe swizzle base on surface based on surface type/index
1693 * ADDR_OK if no error
1694 ***************************************************************************************************
1696 ADDR_E_RETURNCODE ADDR_API
AddrComputeBaseSwizzle(
1698 const ADDR_COMPUTE_BASE_SWIZZLE_INPUT
* pIn
,
1699 ADDR_COMPUTE_BASE_SWIZZLE_OUTPUT
* pOut
);
1704 ***************************************************************************************************
1705 * ELEM_GETEXPORTNORM_INPUT
1708 * Input structure for ElemGetExportNorm
1710 ***************************************************************************************************
1712 typedef struct _ELEM_GETEXPORTNORM_INPUT
1714 UINT_32 size
; ///< Size of this structure in bytes
1716 AddrColorFormat format
; ///< Color buffer format; Client should use ColorFormat
1717 AddrSurfaceNumber num
; ///< Surface number type; Client should use NumberType
1718 AddrSurfaceSwap swap
; ///< Surface swap byte swap; Client should use SurfaceSwap
1719 UINT_32 numSamples
; ///< Number of samples
1720 } ELEM_GETEXPORTNORM_INPUT
;
1723 ***************************************************************************************************
1727 * Helper function to check one format can be EXPORT_NUM, which is a register
1728 * CB_COLOR_INFO.SURFACE_FORMAT. FP16 can be reported as EXPORT_NORM for rv770 in r600
1731 * The implementation is only for r600.
1732 * 00 - EXPORT_FULL: PS exports are 4 pixels with 4 components with 32-bits-per-component. (two
1733 * clocks per export)
1734 * 01 - EXPORT_NORM: PS exports are 4 pixels with 4 components with 16-bits-per-component. (one
1737 ***************************************************************************************************
1739 BOOL_32 ADDR_API
ElemGetExportNorm(
1741 const ELEM_GETEXPORTNORM_INPUT
* pIn
);
1746 ***************************************************************************************************
1747 * ELEM_FLT32TODEPTHPIXEL_INPUT
1750 * Input structure for addrFlt32ToDepthPixel
1752 ***************************************************************************************************
1754 typedef struct _ELEM_FLT32TODEPTHPIXEL_INPUT
1756 UINT_32 size
; ///< Size of this structure in bytes
1758 AddrDepthFormat format
; ///< Depth buffer format
1759 ADDR_FLT_32 comps
[2]; ///< Component values (Z/stencil)
1760 } ELEM_FLT32TODEPTHPIXEL_INPUT
;
1763 ***************************************************************************************************
1764 * ELEM_FLT32TODEPTHPIXEL_INPUT
1767 * Output structure for ElemFlt32ToDepthPixel
1769 ***************************************************************************************************
1771 typedef struct _ELEM_FLT32TODEPTHPIXEL_OUTPUT
1773 UINT_32 size
; ///< Size of this structure in bytes
1775 UINT_8
* pPixel
; ///< Real depth value. Same data type as depth buffer.
1776 /// Client must provide enough storage for this type.
1777 UINT_32 depthBase
; ///< Tile base in bits for depth bits
1778 UINT_32 stencilBase
; ///< Tile base in bits for stencil bits
1779 UINT_32 depthBits
; ///< Bits for depth
1780 UINT_32 stencilBits
; ///< Bits for stencil
1781 } ELEM_FLT32TODEPTHPIXEL_OUTPUT
;
1784 ***************************************************************************************************
1785 * ElemFlt32ToDepthPixel
1788 * Convert a FLT_32 value to a depth/stencil pixel value
1793 ***************************************************************************************************
1795 ADDR_E_RETURNCODE ADDR_API
ElemFlt32ToDepthPixel(
1797 const ELEM_FLT32TODEPTHPIXEL_INPUT
* pIn
,
1798 ELEM_FLT32TODEPTHPIXEL_OUTPUT
* pOut
);
1803 ***************************************************************************************************
1804 * ELEM_FLT32TOCOLORPIXEL_INPUT
1807 * Input structure for addrFlt32ToColorPixel
1809 ***************************************************************************************************
1811 typedef struct _ELEM_FLT32TOCOLORPIXEL_INPUT
1813 UINT_32 size
; ///< Size of this structure in bytes
1815 AddrColorFormat format
; ///< Color buffer format
1816 AddrSurfaceNumber surfNum
; ///< Surface number
1817 AddrSurfaceSwap surfSwap
; ///< Surface swap
1818 ADDR_FLT_32 comps
[4]; ///< Component values (r/g/b/a)
1819 } ELEM_FLT32TOCOLORPIXEL_INPUT
;
1822 ***************************************************************************************************
1823 * ELEM_FLT32TOCOLORPIXEL_INPUT
1826 * Output structure for ElemFlt32ToColorPixel
1828 ***************************************************************************************************
1830 typedef struct _ELEM_FLT32TOCOLORPIXEL_OUTPUT
1832 UINT_32 size
; ///< Size of this structure in bytes
1834 UINT_8
* pPixel
; ///< Real color value. Same data type as color buffer.
1835 /// Client must provide enough storage for this type.
1836 } ELEM_FLT32TOCOLORPIXEL_OUTPUT
;
1839 ***************************************************************************************************
1840 * ElemFlt32ToColorPixel
1843 * Convert a FLT_32 value to a red/green/blue/alpha pixel value
1848 ***************************************************************************************************
1850 ADDR_E_RETURNCODE ADDR_API
ElemFlt32ToColorPixel(
1852 const ELEM_FLT32TOCOLORPIXEL_INPUT
* pIn
,
1853 ELEM_FLT32TOCOLORPIXEL_OUTPUT
* pOut
);
1857 ***************************************************************************************************
1858 * ADDR_CONVERT_TILEINFOTOHW_INPUT
1861 * Input structure for AddrConvertTileInfoToHW
1863 * When reverse is TRUE, indices are igonred
1864 ***************************************************************************************************
1866 typedef struct _ADDR_CONVERT_TILEINFOTOHW_INPUT
1868 UINT_32 size
; ///< Size of this structure in bytes
1869 BOOL_32 reverse
; ///< Convert control flag.
1870 /// FALSE: convert from real value to HW value;
1871 /// TRUE: convert from HW value to real value.
1873 /// r800 and later HWL parameters
1874 ADDR_TILEINFO
* pTileInfo
; ///< Tile parameters with real value
1876 INT_32 tileIndex
; ///< Tile index, MUST be -1 if you don't want to use it
1877 /// while the global useTileIndex is set to 1
1878 INT_32 macroModeIndex
; ///< Index in macro tile mode table if there is one (CI)
1879 ///< README: When tileIndex is not -1, this must be valid
1880 } ADDR_CONVERT_TILEINFOTOHW_INPUT
;
1883 ***************************************************************************************************
1884 * ADDR_CONVERT_TILEINFOTOHW_OUTPUT
1887 * Output structure for AddrConvertTileInfoToHW
1888 ***************************************************************************************************
1890 typedef struct _ADDR_CONVERT_TILEINFOTOHW_OUTPUT
1892 UINT_32 size
; ///< Size of this structure in bytes
1894 /// r800 and later HWL parameters
1895 ADDR_TILEINFO
* pTileInfo
; ///< Tile parameters with hardware register value
1897 } ADDR_CONVERT_TILEINFOTOHW_OUTPUT
;
1900 ***************************************************************************************************
1901 * AddrConvertTileInfoToHW
1904 * Convert tile info from real value to hardware register value
1905 ***************************************************************************************************
1907 ADDR_E_RETURNCODE ADDR_API
AddrConvertTileInfoToHW(
1909 const ADDR_CONVERT_TILEINFOTOHW_INPUT
* pIn
,
1910 ADDR_CONVERT_TILEINFOTOHW_OUTPUT
* pOut
);
1915 ***************************************************************************************************
1916 * ADDR_CONVERT_TILEINDEX_INPUT
1919 * Input structure for AddrConvertTileIndex
1920 ***************************************************************************************************
1922 typedef struct _ADDR_CONVERT_TILEINDEX_INPUT
1924 UINT_32 size
; ///< Size of this structure in bytes
1926 INT_32 tileIndex
; ///< Tile index
1927 INT_32 macroModeIndex
; ///< Index in macro tile mode table if there is one (CI)
1928 BOOL_32 tileInfoHw
; ///< Set to TRUE if client wants HW enum, otherwise actual
1929 } ADDR_CONVERT_TILEINDEX_INPUT
;
1932 ***************************************************************************************************
1933 * ADDR_CONVERT_TILEINDEX_OUTPUT
1936 * Output structure for AddrConvertTileIndex
1937 ***************************************************************************************************
1939 typedef struct _ADDR_CONVERT_TILEINDEX_OUTPUT
1941 UINT_32 size
; ///< Size of this structure in bytes
1943 AddrTileMode tileMode
; ///< Tile mode
1944 AddrTileType tileType
; ///< Tile type
1945 ADDR_TILEINFO
* pTileInfo
; ///< Tile info
1947 } ADDR_CONVERT_TILEINDEX_OUTPUT
;
1950 ***************************************************************************************************
1951 * AddrConvertTileIndex
1954 * Convert tile index to tile mode/type/info
1955 ***************************************************************************************************
1957 ADDR_E_RETURNCODE ADDR_API
AddrConvertTileIndex(
1959 const ADDR_CONVERT_TILEINDEX_INPUT
* pIn
,
1960 ADDR_CONVERT_TILEINDEX_OUTPUT
* pOut
);
1965 ***************************************************************************************************
1966 * ADDR_CONVERT_TILEINDEX1_INPUT
1969 * Input structure for AddrConvertTileIndex1 (without macro mode index)
1970 ***************************************************************************************************
1972 typedef struct _ADDR_CONVERT_TILEINDEX1_INPUT
1974 UINT_32 size
; ///< Size of this structure in bytes
1976 INT_32 tileIndex
; ///< Tile index
1977 UINT_32 bpp
; ///< Bits per pixel
1978 UINT_32 numSamples
; ///< Number of samples
1979 BOOL_32 tileInfoHw
; ///< Set to TRUE if client wants HW enum, otherwise actual
1980 } ADDR_CONVERT_TILEINDEX1_INPUT
;
1983 ***************************************************************************************************
1984 * AddrConvertTileIndex1
1987 * Convert tile index to tile mode/type/info
1988 ***************************************************************************************************
1990 ADDR_E_RETURNCODE ADDR_API
AddrConvertTileIndex1(
1992 const ADDR_CONVERT_TILEINDEX1_INPUT
* pIn
,
1993 ADDR_CONVERT_TILEINDEX_OUTPUT
* pOut
);
1998 ***************************************************************************************************
1999 * ADDR_GET_TILEINDEX_INPUT
2002 * Input structure for AddrGetTileIndex
2003 ***************************************************************************************************
2005 typedef struct _ADDR_GET_TILEINDEX_INPUT
2007 UINT_32 size
; ///< Size of this structure in bytes
2009 AddrTileMode tileMode
; ///< Tile mode
2010 AddrTileType tileType
; ///< Tile-type: disp/non-disp/...
2011 ADDR_TILEINFO
* pTileInfo
; ///< Pointer to tile-info structure, can be NULL for linear/1D
2012 } ADDR_GET_TILEINDEX_INPUT
;
2015 ***************************************************************************************************
2016 * ADDR_GET_TILEINDEX_OUTPUT
2019 * Output structure for AddrGetTileIndex
2020 ***************************************************************************************************
2022 typedef struct _ADDR_GET_TILEINDEX_OUTPUT
2024 UINT_32 size
; ///< Size of this structure in bytes
2026 INT_32 index
; ///< index in table
2027 } ADDR_GET_TILEINDEX_OUTPUT
;
2030 ***************************************************************************************************
2034 * Get the tiling mode index in table
2035 ***************************************************************************************************
2037 ADDR_E_RETURNCODE ADDR_API
AddrGetTileIndex(
2039 const ADDR_GET_TILEINDEX_INPUT
* pIn
,
2040 ADDR_GET_TILEINDEX_OUTPUT
* pOut
);
2046 ***************************************************************************************************
2047 * ADDR_PRT_INFO_INPUT
2050 * Input structure for AddrComputePrtInfo
2051 ***************************************************************************************************
2053 typedef struct _ADDR_PRT_INFO_INPUT
2055 AddrFormat format
; ///< Surface format
2056 UINT_32 baseMipWidth
; ///< Base mipmap width
2057 UINT_32 baseMipHeight
; ///< Base mipmap height
2058 UINT_32 baseMipDepth
; ///< Base mipmap depth
2059 UINT_32 numFrags
; ///< Number of fragments,
2060 } ADDR_PRT_INFO_INPUT
;
2063 ***************************************************************************************************
2064 * ADDR_PRT_INFO_OUTPUT
2067 * Input structure for AddrComputePrtInfo
2068 ***************************************************************************************************
2070 typedef struct _ADDR_PRT_INFO_OUTPUT
2072 UINT_32 prtTileWidth
;
2073 UINT_32 prtTileHeight
;
2074 } ADDR_PRT_INFO_OUTPUT
;
2077 ***************************************************************************************************
2078 * AddrComputePrtInfo
2081 * Compute prt surface related information
2082 ***************************************************************************************************
2084 ADDR_E_RETURNCODE ADDR_API
AddrComputePrtInfo(
2086 const ADDR_PRT_INFO_INPUT
* pIn
,
2087 ADDR_PRT_INFO_OUTPUT
* pOut
);
2089 ///////////////////////////////////////////////////////////////////////////////////////////////////
2090 // DCC key functions
2091 ///////////////////////////////////////////////////////////////////////////////////////////////////
2094 ***************************************************************************************************
2095 * _ADDR_COMPUTE_DCCINFO_INPUT
2098 * Input structure of AddrComputeDccInfo
2099 ***************************************************************************************************
2101 typedef struct _ADDR_COMPUTE_DCCINFO_INPUT
2103 UINT_32 size
; ///< Size of this structure in bytes
2104 UINT_32 bpp
; ///< BitPP of color surface
2105 UINT_32 numSamples
; ///< Sample number of color surface
2106 UINT_64 colorSurfSize
; ///< Size of color surface to which dcc key is bound
2107 AddrTileMode tileMode
; ///< Tile mode of color surface
2108 ADDR_TILEINFO tileInfo
; ///< Tile info of color surface
2109 UINT_32 tileSwizzle
; ///< Tile swizzle
2110 INT_32 tileIndex
; ///< Tile index of color surface,
2111 ///< MUST be -1 if you don't want to use it
2112 ///< while the global useTileIndex is set to 1
2113 INT_32 macroModeIndex
; ///< Index in macro tile mode table if there is one (CI)
2114 ///< README: When tileIndex is not -1, this must be valid
2115 } ADDR_COMPUTE_DCCINFO_INPUT
;
2118 ***************************************************************************************************
2119 * ADDR_COMPUTE_DCCINFO_OUTPUT
2122 * Output structure of AddrComputeDccInfo
2123 ***************************************************************************************************
2125 typedef struct _ADDR_COMPUTE_DCCINFO_OUTPUT
2127 UINT_32 size
; ///< Size of this structure in bytes
2128 UINT_64 dccRamBaseAlign
; ///< Base alignment of dcc key
2129 UINT_64 dccRamSize
; ///< Size of dcc key
2130 UINT_64 dccFastClearSize
; ///< Size of dcc key portion that can be fast cleared
2131 BOOL_32 subLvlCompressible
; ///< whether sub resource is compressiable
2132 } ADDR_COMPUTE_DCCINFO_OUTPUT
;
2135 ***************************************************************************************************
2136 * AddrComputeDccInfo
2139 * Compute DCC key size, base alignment
2141 ***************************************************************************************************
2143 ADDR_E_RETURNCODE ADDR_API
AddrComputeDccInfo(
2145 const ADDR_COMPUTE_DCCINFO_INPUT
* pIn
,
2146 ADDR_COMPUTE_DCCINFO_OUTPUT
* pOut
);
2148 #if defined(__cplusplus)
2152 #endif // __ADDR_INTERFACE_H__