1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
/*
* Copyright (c) 2007-2018 NVIDIA Corporation. All Rights Reserved.
*
* NVIDIA Corporation and its licensors retain all intellectual property and
* proprietary rights in and to this software and related documentation. Any
* use, reproduction, disclosure or distribution of this software and related
* documentation without an express license agreement from NVIDIA Corporation
* is strictly prohibited.
*/
#ifndef INCLUDED_NVRM_DRF_H
#define INCLUDED_NVRM_DRF_H
/**
* @defgroup nvrm_drf RM DRF Macros
*
* @ingroup nvddk_rm
*
* The following suite of macros are used for generating values to write into
* hardware registers, or for extracting fields from read registers. The
* hardware headers have a RANGE define for each field in the register in the
* form of x:y, 'x' being the high bit, 'y' the lower. Through a clever use
* of the C ternary operator, x:y may be passed into the macros below to
* geneate masks, shift values, etc.
*
* There are two basic flavors of DRF macros, the first is used to define
* a new register value from 0, the other is modifiying a field given a
* register value. An example of the first:
*
* reg = NV_DRF_DEF( HW, REGISTER0, FIELD0, VALUE0 )
* | NV_DRF_DEF( HW, REGISTER0, FIELD3, VALUE2 );
*
* To modify 'reg' from the previous example:
*
* reg = NV_FLD_SET_DRF_DEF( HW, REGISTER0, FIELD2, VALUE1, reg );
*
* To pass in numeric values instead of defined values from the header:
*
* reg = NV_DRF_NUM( HW, REGISTER3, FIELD2, 1024 );
*
* To read a value from a register:
*
* val = NV_DRF_VAL( HW, REGISTER3, FIELD2, reg );
*
* Some registers have non-zero reset values which may be extracted from the
* hardware headers via NV_RESETVAL.
*/
/*
* The NV_FIELD_* macros are helper macros for the public NV_DRF_* macros.
*/
#define NV_FIELD_LOWBIT(x) (0?x)
#define NV_FIELD_HIGHBIT(x) (1?x)
#define NV_FIELD_SIZE(x) (NV_FIELD_HIGHBIT(x)-NV_FIELD_LOWBIT(x)+1)
#define NV_FIELD_SHIFT(x) ((0?x)%32)
#define NV_FIELD_MASK(x) (0xFFFFFFFFUL>>(31-((1?x)%32)+((0?x)%32)))
#define NV_FIELD_BITS(val, x) (((val) & NV_FIELD_MASK(x))<<NV_FIELD_SHIFT(x))
#define NV_FIELD_SHIFTMASK(x) (NV_FIELD_MASK(x)<< (NV_FIELD_SHIFT(x)))
/** NV_DRF_DEF - define a new register value.
@ingroup nvrm_drf
@param d register domain (hardware block)
@param r register name
@param f register field
@param c defined value for the field
*/
#define NV_DRF_DEF(d,r,f,c) \
((d##_##r##_0_##f##_##c) << NV_FIELD_SHIFT(d##_##r##_0_##f##_RANGE))
/** NV_DRF_NUM - define a new register value.
@ingroup nvrm_drf
@param d register domain (hardware block)
@param r register name
@param f register field
@param n numeric value for the field
*/
#define NV_DRF_NUM(d,r,f,n) \
(((n)& NV_FIELD_MASK(d##_##r##_0_##f##_RANGE)) << \
NV_FIELD_SHIFT(d##_##r##_0_##f##_RANGE))
/** NV_DRF_VAL - read a field from a register.
@ingroup nvrm_drf
@param d register domain (hardware block)
@param r register name
@param f register field
@param v register value
*/
#define NV_DRF_VAL(d,r,f,v) \
(((v)>> NV_FIELD_SHIFT(d##_##r##_0_##f##_RANGE)) & \
NV_FIELD_MASK(d##_##r##_0_##f##_RANGE))
/** NV_FLD_SET_DRF_NUM - modify a register field.
@ingroup nvrm_drf
@param d register domain (hardware block)
@param r register name
@param f register field
@param n numeric field value
@param v register value
*/
#define NV_FLD_SET_DRF_NUM(d,r,f,n,v) \
(((v) & ~NV_FIELD_SHIFTMASK(d##_##r##_0_##f##_RANGE)) | NV_DRF_NUM(d,r,f,n))
/** NV_FLD_SET_DRF_DEF - modify a register field.
@ingroup nvrm_drf
@param d register domain (hardware block)
@param r register name
@param f register field
@param c defined field value
@param v register value
*/
#define NV_FLD_SET_DRF_DEF(d,r,f,c,v) \
(((v) & ~NV_FIELD_SHIFTMASK(d##_##r##_0_##f##_RANGE)) | \
NV_DRF_DEF(d,r,f,c))
/** NV_RESETVAL - get the reset value for a register.
@ingroup nvrm_drf
@param d register domain (hardware block)
@param r register name
*/
#define NV_RESETVAL(d,r) (d##_##r##_0_RESET_VAL)
/*
* Packet variants.
* NOTE: these are limited to 32-bit or smaller packets
*/
/** NV_PF_DEF - define a new packet value.
@ingroup nvrm_drf
@param p packet name
@param f packet field
@param c defined value for the field
*/
#define NV_PF_DEF(p,f,c) \
((p##_##f##_##c) << NV_FIELD_SHIFT(p##_##f##_RANGE))
/** NV_PF_NUM - define a new packet value.
@ingroup nvrm_drf
@param p packet name
@param f packet field
@param n numeric value for the field
*/
#define NV_PF_NUM(p,f,n) \
(((n)& NV_FIELD_MASK(p##_##f##_RANGE)) << \
NV_FIELD_SHIFT(p##_##f##_RANGE))
/** NV_PF_VAL - read a field from a packet
@ingroup nvrm_drf
@param p packet name
@param f packet field
@param v packet value
*/
#define NV_PF_VAL(p,f,v) \
(((v)>> NV_FIELD_SHIFT(p##_##f##_RANGE)) & \
NV_FIELD_MASK(p##_##f##_RANGE))
/** NV_FLD_SET_PF_NUM - modify a packet field.
@ingroup nvrm_drf
@param p packet name
@param f packet field
@param n numeric field value
@param v packet value
*/
#define NV_FLD_SET_PF_NUM(p,f,n,v) \
(((v) & ~NV_FIELD_SHIFTMASK(p##_##f##_RANGE)) | NV_PF_NUM(p,f,n))
/** NV_FLD_SET_PF_DEF - modify a packet field.
@ingroup nvrm_drf
@param p packet name
@param f packet field
@param c defined field value
@param v packet value
*/
#define NV_FLD_SET_PF_DEF(p,f,c,v) \
(((v) & ~NV_FIELD_SHIFTMASK(p##_##f##_RANGE)) | \
NV_PF_DEF(p,f,c))
#endif // INCLUDED_NVRM_DRF_H
|
