diff options
Diffstat (limited to 'arch/arm/mach-tegra/nv/include/nvrm_drf.h')
-rw-r--r-- | arch/arm/mach-tegra/nv/include/nvrm_drf.h | 156 |
1 files changed, 156 insertions, 0 deletions
diff --git a/arch/arm/mach-tegra/nv/include/nvrm_drf.h b/arch/arm/mach-tegra/nv/include/nvrm_drf.h new file mode 100644 index 000000000000..cc5cbe0cb4a3 --- /dev/null +++ b/arch/arm/mach-tegra/nv/include/nvrm_drf.h @@ -0,0 +1,156 @@ +/* + * Copyright (c) 2007-2009 NVIDIA Corporation. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * Neither the name of the NVIDIA Corporation nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + * + */ + +#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) + +#endif // INCLUDED_NVRM_DRF_H |