1/**********************************************************
2 * Copyright 2007-2009 VMware, Inc.  All rights reserved.
3 *
4 * Permission is hereby granted, free of charge, to any person
5 * obtaining a copy of this software and associated documentation
6 * files (the "Software"), to deal in the Software without
7 * restriction, including without limitation the rights to use, copy,
8 * modify, merge, publish, distribute, sublicense, and/or sell copies
9 * of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be
13 * included in all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
19 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
20 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 *
24 **********************************************************/
25
26/*
27 * svga3d_caps.h --
28 *
29 *       Definitions for SVGA3D hardware capabilities.  Capabilities
30 *       are used to query for optional rendering features during
31 *       driver initialization. The capability data is stored as very
32 *       basic key/value dictionary within the "FIFO register" memory
33 *       area at the beginning of BAR2.
34 *
35 *       Note that these definitions are only for 3D capabilities.
36 *       The SVGA device also has "device capabilities" and "FIFO
37 *       capabilities", which are non-3D-specific and are stored as
38 *       bitfields rather than key/value pairs.
39 */
40
41#ifndef _SVGA3D_CAPS_H_
42#define _SVGA3D_CAPS_H_
43
44#define SVGA_FIFO_3D_CAPS_SIZE   (SVGA_FIFO_3D_CAPS_LAST - \
45                                  SVGA_FIFO_3D_CAPS + 1)
46
47
48/*
49 * SVGA3dCapsRecordType
50 *
51 *    Record types that can be found in the caps block.
52 *    Related record types are grouped together numerically so that
53 *    SVGA3dCaps_FindRecord() can be applied on a range of record
54 *    types.
55 */
56
57typedef enum {
58   SVGA3DCAPS_RECORD_UNKNOWN        = 0,
59   SVGA3DCAPS_RECORD_DEVCAPS_MIN    = 0x100,
60   SVGA3DCAPS_RECORD_DEVCAPS        = 0x100,
61   SVGA3DCAPS_RECORD_DEVCAPS_MAX    = 0x1ff,
62} SVGA3dCapsRecordType;
63
64
65/*
66 * SVGA3dCapsRecordHeader
67 *
68 *    Header field leading each caps block record. Contains the offset (in
69 *    register words, NOT bytes) to the next caps block record (or the end
70 *    of caps block records which will be a zero word) and the record type
71 *    as defined above.
72 */
73
74typedef
75struct SVGA3dCapsRecordHeader {
76   uint32 length;
77   SVGA3dCapsRecordType type;
78}
79SVGA3dCapsRecordHeader;
80
81
82/*
83 * SVGA3dCapsRecord
84 *
85 *    Caps block record; "data" is a placeholder for the actual data structure
86 *    contained within the record; for example a record containing a FOOBAR
87 *    structure would be of size "sizeof(SVGA3dCapsRecordHeader) +
88 *    sizeof(FOOBAR)".
89 */
90
91typedef
92struct SVGA3dCapsRecord {
93   SVGA3dCapsRecordHeader header;
94   uint32 data[1];
95}
96SVGA3dCapsRecord;
97
98
99typedef uint32 SVGA3dCapPair[2];
100
101
102/*
103 *----------------------------------------------------------------------
104 *
105 * SVGA3dCaps_FindRecord
106 *
107 *    Finds the record with the highest-valued type within the given range
108 *    in the caps block.
109 *
110 *    Result: pointer to found record, or NULL if not found.
111 *
112 *----------------------------------------------------------------------
113 */
114
115static INLINE SVGA3dCapsRecord *
116SVGA3dCaps_FindRecord(const uint32 *capsBlock,
117                      SVGA3dCapsRecordType recordTypeMin,
118                      SVGA3dCapsRecordType recordTypeMax)
119{
120   SVGA3dCapsRecord *record, *found = NULL;
121   uint32 offset;
122
123   /*
124    * Search linearly through the caps block records for the specified type.
125    */
126   for (offset = 0; capsBlock[offset] != 0; offset += capsBlock[offset]) {
127      record = (SVGA3dCapsRecord *) (capsBlock + offset);
128      if ((record->header.type >= recordTypeMin) &&
129          (record->header.type <= recordTypeMax) &&
130          (!found || (record->header.type > found->header.type))) {
131         found = record;
132      }
133   }
134
135   return found;
136}
137
138
139#endif // _SVGA3D_CAPS_H_
140