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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
/*
* Copyright (c) 2008-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_NVBOOTARGS_H
#define INCLUDED_NVBOOTARGS_H
/**
* This defines the basic bootarg structure and keys for use with
* NvOsBootArgGet and NvOsBootArgSet.
*/
#include "nvcommon.h"
/**
* The maximum number of memory handles that may be preserved across the
* bootloader-to-OS transition. @see NvRmBootArg_PreservedMemHandle.
*/
#define NV_BOOTARGS_MAX_PRESERVED_MEMHANDLES 3
#if defined(__cplusplus)
extern "C"
{
#endif
/* accessor for various boot arg classes, see NvOsBootArg* */
typedef enum
{
NvBootArgKey_Rm = 0x1,
NvBootArgKey_Display,
NvBootArgKey_Framebuffer,
NvBootArgKey_ChipShmoo,
NvBootArgKey_ChipShmooPhys,
NvBootArgKey_Carveout,
NvBootArgKey_WarmBoot,
NvBootArgKey_PreservedMemHandle_0 = 0x10000,
NvBootArgKey_PreservedMemHandle_Num = (NvBootArgKey_PreservedMemHandle_0 +
NV_BOOTARGS_MAX_PRESERVED_MEMHANDLES),
NvBootArgKey_Force32 = 0x7FFFFFFF,
} NvBootArgKey;
/**
* Resource Manager boot args.
*
* Nothing here yet.
*/
typedef struct NvBootArgsRmRec
{
NvU32 reserved;
} NvBootArgsRm;
/**
* Carveout boot args, which define the physical memory location of the GPU
* carved-out memory region(s).
*/
typedef struct NvBootArgsCarveoutRec
{
NvUPtr base;
NvU32 size;
} NvBootArgsCarveout;
/**
* Warmbootloader boot args. This structure only contains
* a mem handle key to preserve the warm bootloader
* across the bootloader->os transition
*/
typedef struct NvBootArgsWarmbootRec
{
/* The key used for accessing the preserved memory handle */
NvU32 MemHandleKey;
} NvBootArgsWarmboot;
/**
* PreservedMemHandle boot args, indexed by PreservedMemHandle_0 + n.
* All values n from 0 to the first value which does not return NvSuccess will
* be quered at RM initialization in the OS environment. If present, a new
* memory handle for the physical region specified will be created.
* This allows physical memory allocations (e.g., for framebuffers) to persist
* between the bootloader and operating system. Only carveout and IRAM
* allocations may be preserved with this interface.
*/
typedef struct NvBootArgsPreservedMemHandleRec
{
NvUPtr Address;
NvU32 Size;
} NvBootArgsPreservedMemHandle;
/**
* Display boot args, indexed by NvBootArgKey_Display.
*
* The bootloader may have a splash screen. This will flag which controller
* and device was used for the splash screen so the device will not be
* reinitialized (which causes visual artifacts).
*/
typedef struct NvBootArgsDisplayRec
{
/* which controller is initialized */
NvU32 Controller;
/* index into the ODM device list of the boot display device */
NvU32 DisplayDeviceIndex;
/* set to NV_TRUE if the display has been initialized */
NvBool bEnabled;
} NvBootArgsDisplay;
/**
* Framebuffer boot args, indexed by NvBootArgKey_Framebuffer
*
* A framebuffer may be shared between the bootloader and the
* operating system display driver. When this key is present,
* a preserved memory handle for the framebuffer must also
* be present, to ensure that no display corruption occurs
* during the transition.
*/
typedef struct NvBootArgsFramebufferRec
{
/* The key used for accessing the preserved memory handle */
NvU32 MemHandleKey;
/* Total memory size of the framebuffer */
NvU32 Size;
/* Color format of the framebuffer, cast to a U32 */
NvU32 ColorFormat;
/* Width of the framebuffer, in pixels */
NvU16 Width;
/* Height of each surface in the framebuffer, in pixels */
NvU16 Height;
/* Pitch of a framebuffer scanline, in bytes */
NvU16 Pitch;
/* Surface layout of the framebuffer, cast to a U8 */
NvU8 SurfaceLayout;
/* Number of contiguous surfaces of the same height in the
* framebuffer, if multi-buffering. Each surface is
* assumed to begin at Pitch * Height bytes from the
* previous surface. */
NvU8 NumSurfaces;
/* Flags for future expandability.
* Current allowable flags are:
* zero - default
* NV_BOOT_ARGS_FB_FLAG_TEARING_EFFECT - use a tearing effect signal in
* combination with a trigger from the display software to generate
* a frame of pixels for the display device.
*/
NvU32 Flags;
#define NVBOOTARG_FB_FLAG_TEARING_EFFECT (0x1)
} NvBootArgsFramebuffer;
/**
* Chip chatcterization shmoo data indexed by NvBootArgKey_ChipShmoo
*/
typedef struct NvBootArgsChipShmooRec
{
// The key used for accessing the preserved memory handle of packed
// charcterization tables
NvU32 MemHandleKey;
// Offset and size of each unit in the packed buffer
NvU32 CoreShmooVoltagesListOffset;
NvU32 CoreShmooVoltagesListSize;
NvU32 CoreScaledLimitsListOffset;
NvU32 CoreScaledLimitsListSize;
NvU32 OscDoublerListOffset;
NvU32 OscDoublerListSize;
NvU32 SKUedLimitsOffset;
NvU32 SKUedLimitsSize;
NvU32 CpuShmooVoltagesListOffset;
NvU32 CpuShmooVoltagesListSize;
NvU32 CpuScaledLimitsOffset;
NvU32 CpuScaledLimitsSize;
// Misc charcterization settings
NvU16 CoreCorner;
NvU16 CpuCorner;
NvU32 Dqsib;
NvU32 SvopLowVoltage;
NvU32 SvopLowSetting;
NvU32 SvopHighSetting;
} NvBootArgsChipShmoo;
/**
* Chip chatcterization shmoo data indexed by NvBootArgKey_ChipShmooPhys
*/
typedef struct NvBootArgsChipShmooPhysRec
{
NvU32 PhysShmooPtr;
NvU32 Size;
} NvBootArgsChipShmooPhys;
#define NVBOOTARG_NUM_PRESERVED_HANDLES \
(NvBootArgKey_PreservedMemHandle_Num - NvBootArgKey_PreservedMemHandle_0)
/**
* OS-agnostic bootarg structure.
*/
typedef struct NvBootArgsRec
{
NvBootArgsRm RmArgs;
NvBootArgsDisplay DisplayArgs;
NvBootArgsFramebuffer FramebufferArgs;
NvBootArgsChipShmoo ChipShmooArgs;
NvBootArgsChipShmooPhys ChipShmooPhysArgs;
NvBootArgsWarmboot WarmbootArgs;
NvBootArgsPreservedMemHandle MemHandleArgs[NVBOOTARG_NUM_PRESERVED_HANDLES];
} NvBootArgs;
#if defined(__cplusplus)
}
#endif
#endif // INCLUDED_NVBOOTARGS_H
|
