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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
|
/**
* @file IxNpeDlNpeMgrUtils_p.h
*
* @author Intel Corporation
* @date 18 February 2002
* @brief This file contains the private API for the NpeMgr module.
*
*
* @par
* IXP400 SW Release version 2.0
*
* -- Copyright Notice --
*
* @par
* Copyright 2001-2005, Intel Corporation.
* All rights reserved.
*
* @par
* SPDX-License-Identifier: BSD-3-Clause
* @par
* -- End of Copyright Notice --
*/
/**
* @defgroup IxNpeDlNpeMgrUtils_p IxNpeDlNpeMgrUtils_p
*
* @brief The private API for the IxNpeDl NpeMgr Utils module
*
* @{
*/
#ifndef IXNPEDLNPEMGRUTILS_P_H
#define IXNPEDLNPEMGRUTILS_P_H
/*
* Put the user defined include files required.
*/
#include "IxNpeDl.h"
#include "IxOsalTypes.h"
#include "IxNpeDlNpeMgrEcRegisters_p.h"
/*
* Function Prototypes
*/
/**
* @fn IX_STATUS ixNpeDlNpeMgrInsMemWrite (UINT32 npeBaseAddress,
UINT32 insMemAddress,
UINT32 insMemData,
BOOL verify)
*
* @brief Writes a word to NPE Instruction memory
*
* @param UINT32 [in] npeBaseAddress - Base Address of NPE
* @param UINT32 [in] insMemAddress - NPE instruction memory address to write
* @param UINT32 [in] insMemData - data to write to instruction memory
* @param BOOL [in] verify - if true, verify the memory location is
* written successfully.
*
* This function is used to write a single word of data to a location in NPE
* instruction memory. If the <i>verify</i> option is ON, NpeDl will read back
* from the memory location to verify that it was written successfully
*
* @pre
*
* @post
*
* @return
* - IX_FAIL if verify is true and the memory location was not written
* successfully
* - IX_SUCCESS otherwise
*/
IX_STATUS
ixNpeDlNpeMgrInsMemWrite (UINT32 npeBaseAddress, UINT32 insMemAddress,
UINT32 insMemData, BOOL verify);
/**
* @fn IX_STATUS ixNpeDlNpeMgrDataMemWrite (UINT32 npeBaseAddress,
UINT32 dataMemAddress,
UINT32 dataMemData,
BOOL verify)
*
* @brief Writes a word to NPE Data memory
*
* @param UINT32 [in] npeBaseAddress - Base Address of NPE
* @param UINT32 [in] dataMemAddress - NPE data memory address to write
* @param UINT32 [in] dataMemData - data to write to NPE data memory
* @param BOOL [in] verify - if true, verify the memory location is
* written successfully.
*
* This function is used to write a single word of data to a location in NPE
* data memory. If the <i>verify</i> option is ON, NpeDl will read back from
* the memory location to verify that it was written successfully
*
* @pre
*
* @post
*
* @return
* - IX_FAIL if verify is true and the memory location was not written
* successfully
* - IX_SUCCESS otherwise
*/
IX_STATUS
ixNpeDlNpeMgrDataMemWrite (UINT32 npeBaseAddress, UINT32 dataMemAddress,
UINT32 dataMemData, BOOL verify);
/**
* @fn void ixNpeDlNpeMgrExecAccRegWrite (UINT32 npeBaseAddress,
UINT32 regAddress,
UINT32 regData)
*
* @brief Writes a word to an NPE Execution Access register
*
* @param UINT32 [in] npeBaseAddress - Base Address of NPE
* @param UINT32 [in] regAddress - NPE Execution Access register address
* @param UINT32 [in] regData - data to write to register
*
* This function is used to write a single word of data to an NPE Execution
* Access register.
*
* @pre
*
* @post
*
* @return none
*/
void
ixNpeDlNpeMgrExecAccRegWrite (UINT32 npeBaseAddress, UINT32 regAddress,
UINT32 regData);
/**
* @fn UINT32 ixNpeDlNpeMgrExecAccRegRead (UINT32 npeBaseAddress,
UINT32 regAddress)
*
* @brief Reads the contents of an NPE Execution Access register
*
* @param UINT32 [in] npeBaseAddress - Base Address of NPE
* @param UINT32 [in] regAddress - NPE Execution Access register address
*
* This function is used to read the contents of an NPE Execution
* Access register.
*
* @pre
*
* @post
*
* @return The value read from the Execution Access register
*/
UINT32
ixNpeDlNpeMgrExecAccRegRead (UINT32 npeBaseAddress, UINT32 regAddress);
/**
* @fn void ixNpeDlNpeMgrCommandIssue (UINT32 npeBaseAddress,
UINT32 command)
*
* @brief Issues an NPE Execution Control command
*
* @param UINT32 [in] npeBaseAddress - Base Address of NPE
* @param UINT32 [in] command - Command to issue
*
* This function is used to issue a stand-alone NPE Execution Control command
* (e.g. command to Stop NPE execution)
*
* @pre
*
* @post
*
* @return none
*/
void
ixNpeDlNpeMgrCommandIssue (UINT32 npeBaseAddress, UINT32 command);
/**
* @fn void ixNpeDlNpeMgrDebugInstructionPreExec (UINT32 npeBaseAddress)
*
* @brief Prepare to executes one or more NPE instructions in the Debug
* Execution Stack level.
*
* @param UINT32 [in] npeBaseAddress - Base Address of NPE
*
* This function should be called once before a sequence of calls to
* ixNpeDlNpeMgrDebugInstructionExec().
*
* @pre
*
* @post
* - ixNpeDlNpeMgrDebugInstructionPostExec() should be called to restore
* registers values altered by this function
*
* @return none
*/
void
ixNpeDlNpeMgrDebugInstructionPreExec (UINT32 npeBaseAddress);
/**
* @fn IX_STATUS ixNpeDlNpeMgrDebugInstructionExec (UINT32 npeBaseAddress,
UINT32 npeInstruction,
UINT32 ctxtNum,
UINT32 ldur)
*
* @brief Executes a single instruction on the NPE at the Debug Execution Stack
* level
*
* @param UINT32 [in] npeBaseAddress - Base Address of NPE
* @param UINT32 [in] npeInstruction - Value to write to INSTR (Instruction)
* register
* @param UINT32 [in] ctxtNum - context the instruction will be executed
* in and which context store it may access
* @param UINT32 [in] ldur - Long Immediate Duration, set to non-zero
* to use long-immediate mode instruction
*
* This function is used to execute a single instruction in the NPE pipeline at
* the debug Execution Context Stack level. It won't disturb the state of other
* executing contexts. Its useful for performing NPE operations, such as
* writing to NPE Context Store registers and physical registers, that cannot
* be carried out directly using the Configuration Bus registers. This function
* will return TIMEOUT status if NPE not responding due to NPS is hang / halt.
*
* @pre
* - The NPE should be stopped and in a clean state
* - ixNpeDlNpeMgrDebugInstructionPreExec() should be called once before
* a sequential of 1 or more calls to this function
*
* @post
* - ixNpeDlNpeMgrDebugInstructionPostExec() should be called after
* a sequence of calls to this function
*
* @return
* - IX_NPEDL_CRITICAL_NPE_ERR if execution of instruction failed / timeout
* - IX_SUCCESS otherwise
*/
IX_STATUS
ixNpeDlNpeMgrDebugInstructionExec (UINT32 npeBaseAddress,
UINT32 npeInstruction,
UINT32 ctxtNum, UINT32 ldur);
/**
* @fn void ixNpeDlNpeMgrDebugInstructionPostExec (UINT32 npeBaseAddress)
*
* @brief Clean up after executing one or more NPE instructions in the
* Debug Stack Level
*
* @param UINT32 [in] npeBaseAddress - Base Address of NPE
*
* This function should be called once following a sequence of calls to
* ixNpeDlNpeMgrDebugInstructionExec().
*
* @pre
* - ixNpeDlNpeMgrDebugInstructionPreExec() was called earlier
*
* @post
* - The Instruction Pipeline will cleared
*
* @return none
*/
void
ixNpeDlNpeMgrDebugInstructionPostExec (UINT32 npeBaseAddress);
/**
* @fn IX_STATUS ixNpeDlNpeMgrPhysicalRegWrite (UINT32 npeBaseAddress,
UINT32 regAddr,
UINT32 regValue,
BOOL verify)
*
* @brief Write one of the 32* 32-bit physical registers in the NPE data
* register file
*
* @param UINT32 [in] npeBaseAddress - Base Address of NPE
* @param UINT32 [in] regAddr - number of the physical register (0-31)*
* @param UINT32 [in] regValue - value to write to the physical register
* @param BOOL [in] verify - if true, verify the register is written
* successfully.
*
* This function writes a physical register in the NPE data register file.
* If the <i>verify</i> option is ON, NpeDl will read back the register to
* verify that it was written successfully
* *Note that release 1.0 of this software supports 32 physical
* registers, but 64 may be supported in future versions.
*
* @pre
* - The NPE should be stopped and in a clean state
* - ixNpeDlNpeMgrDebugInstructionPreExec() should be called once before
* a sequential of 1 or more calls to this function
*
* @post
* - Contents of REGMAP Context Store register for Context 0 will be altered
* - ixNpeDlNpeMgrDebugInstructionPostExec() should be called after
* a sequence of calls to this function
*
* @return
* - IX_FAIL if verify is true and the Context Register was not written
* successfully
* - IX_SUCCESS if Context Register was written successfully
* - IX_NPEDL_CRITICAL_NPE_ERR if Context Register was not written
* successfully due to timeout error where NPE is not responding
*/
IX_STATUS
ixNpeDlNpeMgrPhysicalRegWrite (UINT32 npeBaseAddress, UINT32 regAddr,
UINT32 regValue, BOOL verify);
/**
* @fn IX_STATUS ixNpeDlNpeMgrCtxtRegWrite (UINT32 npeBaseAddress,
UINT32 ctxtNum,
IxNpeDlCtxtRegNum ctxtReg,
UINT32 ctxtRegVal,
BOOL verify)
*
* @brief Writes a value to a Context Store register on an NPE
*
* @param UINT32 [in] npeBaseAddress - Base Address of NPE
* @param UINT32 [in] ctxtNum - context store to access
* @param IxNpeDlCtxtRegNum [in] ctxtReg - which Context Store reg to write
* @param UINT32 [in] ctxtRegVal - value to write to the Context Store
* register
* @param BOOL [in] verify - if true, verify the register is
* written successfully.
*
* This function writes the contents of a Context Store register in the NPE
* register file. If the <i>verify</i> option is ON, NpeDl will read back the
* register to verify that it was written successfully
*
* @pre
* - The NPE should be stopped and in a clean state
* - ixNpeDlNpeMgrDebugInstructionPreExec() should be called once before
* a sequential of 1 or more calls to this function
*
* @post
* - ixNpeDlNpeMgrDebugInstructionPostExec() should be called after
* a sequence of calls to this function
*
* @return
* - IX_FAIL if verify is true and the Context Register was not written
* successfully
* - IX_SUCCESS if Context Register was written successfully
* - IX_NPEDL_CRITICAL_NPE_ERR if Context Register was not written
* successfully due to timeout error where NPE is not responding
*/
IX_STATUS
ixNpeDlNpeMgrCtxtRegWrite (UINT32 npeBaseAddress, UINT32 ctxtNum,
IxNpeDlCtxtRegNum ctxtReg, UINT32 ctxtRegVal,
BOOL verify);
/**
* @fn void ixNpeDlNpeMgrUtilsStatsShow (void)
*
* @brief This function will display the statistics of the IxNpeDl NpeMgrUtils
* module
*
* @return none
*/
void
ixNpeDlNpeMgrUtilsStatsShow (void);
/**
* @fn void ixNpeDlNpeMgrUtilsStatsReset (void)
*
* @brief This function will reset the statistics of the IxNpeDl NpeMgrUtils
* module
*
* @return none
*/
void
ixNpeDlNpeMgrUtilsStatsReset (void);
#endif /* IXNPEDLNPEMGRUTILS_P_H */
|
