AWECore 8.C.1 API Document
ProxyIDs.h
Go to the documentation of this file.
1 
6 /****************************************************************************
7  *
8  * Command IDs
9  * -----------
10  *
11  ****************************************************************************
12  * ProxyIDs.h
13  ****************************************************************************
14  *
15  * Description: Message command ID list
16  *
17  * Copyright: (c) 2020 DSP Concepts, Inc. All rights reserved.
18  * 3235 Kifer Road
19  * Santa Clara, CA 95054
20  *
21  * Note: This file parsed using comma delimiters. Do not use commas in comments.
22  *
23  ***************************************************************************/
24 #ifndef PROXYIDS_H_INCLUDED
25 #define PROXYIDS_H_INCLUDED
26 
30 typedef enum
31 {
33  PFID_Undefined, /* = 0 */
34 
36  PFID_SetCall, /* = 1 */
37 
39  PFID_GetCall, /* = 2 */
40 
41  // Hole id=3
42 
44  PFID_GetClassType = 4, /* = 4 */
45 
47  PFID_GetPinType, /* = 5 */
48 
51 
53  PFID_BindIOToWire, /* = 7 */
54 
56  PFID_FetchValue, /* = 8 */
57 
59  PFID_SetValue, /* = 9 */
60 
62  PFID_GetHeapCount, /* = 10 */
63 
65  PFID_GetHeapSize, /* = 11 */
66 
68  PFID_Destroy, /* = 12 */
69 
71  PFID_GetCIModuleCount, /* = 13 */
72 
74  PFID_GetCIModuleInfo, /* = 14 */
75 
78 
81 
83  PFID_SetWire, /* = 17 */
84 
86  PFID_GetWire, /* = 18 */
87 
89  PFID_SetModuleState, /* = 19 */
90 
92  PFID_GetModuleState, /* = 20 */
93 
95  PFID_PumpModule, /* = 21 */
96 
98  PFID_ClassLayout_Process, /* = 22 */
99 
101  PFID_GetFirstObject, /* = 23 */
102 
104  PFID_GetNextObject, /* = 24 */
105 
107  PFID_GetFirstIO, /* = 25 */
108 
110  PFID_GetNextIO, /* = 26 */
111 
113  PFID_StartAudio, /* = 27 */
114 
116  PFID_StopAudio, /* = 28 */
117 
119  PFID_FetchValues, /* = 29 */
120 
122  PFID_SetValues, /* = 30 */
123 
125  PFID_GetSizeofInt, /* = 31 */
126 
128  PFID_GetFirstFile, /* = 32 */
129 
131  PFID_GetNextFile, /* = 33 */
132 
134  PFID_OpenFile, /* = 34 */
135 
137  PFID_ReadFile, /* = 35 */
138 
140  PFID_WriteFile, /* = 36 */
141 
143  PFID_CloseFile, /* = 37 */
144 
146  PFID_DeleteFile, /* = 38 */
147 
149  PFID_ExecuteFile, /* = 39 */
150 
152  PFID_EraseFlash, /* = 40 */
153 
155  PFID_GetTargetInfo, /* = 41 */
156 
158  PFID_GetFileSystemInfo, /* = 42 */
159 
161  PFID_GetProfileValues, /* = 43 */
162 
164  PFID_FileSystemReset, /* = 44 */
165 
167  PFID_GetObjectByIndex, /* = 45 */
168 
170  PFID_GetObjectByID, /* = 46 */
171 
173  PFID_AddModuleToLayout, /* = 47 */
174 
176  PFID_SetValueCall, /* = 48 */
177 
179  PFID_UpdateFirmware, /* = 49 */
180 
182  PFID_FlashReadOpen = 50, /* = 50 */
183 
185  PFID_FlashRead, /* = 51 */
186 
187  // Hole Id=52-53
188 
189  /* Command ID to tick for deferred execution. */
190  PFID_Tick = 54, /* = 54 */
191 
192  /* Enables or disables address translation. */
193  PFID_EnableAddressTranslation, /* = 55 */
194 
196  PFID_AllocateHeaps, /* = 56 */
197 
199  PFID_DestroyHeaps, /* = 57 */
200 
202  PFID_WritePumpRead, /* = 58 */
203 
205  PFID_SetID, /* = 59 */
206 
208  PFID_SetValueSetCall, /* = 60 */
209 
211  PFID_SetValuesSetCall, /* = 61 */
212 
214  PFID_GetCallFetchValue, /* = 62 */
215 
217  PFID_GetCallFetchValues, /* = 63 */
218 
219  // Hole id=64-76
220 
222  PFID_SetPointer = 77, /* = 77 */
223 
224  // Hole id=78-80
225 
227  PFID_CreateLookupTable = 81, /* = 81 */
228 
230  PFID_UpdateLookupTable, /* = 82 */
231 
233  PFID_PumpLayout, /* = 83 */
234 
236  PFID_DerefPointer, /* = 84 */
237 
239  PFID_GetWireType, /* = 85 */
240 
242  PFID_SetInstanceID, /* = 86 */
243 
245  PFID_Get_Flash_Erase_Time, /* = 87 */
246 
249 
252 
254  PFID_Set_Baud_Rate, /* = 90 */
255 
257  PFID_Lock_DSP, /* = 91 */
258 
260  PFID_Reboot_Target, /* = 92 */
261 
263  PFID_DestroyAll, /* = 93 */
264 
266  PFID_GetFirstCore, /* = 94 */
267 
269  PFID_GetNextCore, /* = 95 */
270 
272  PFID_StartAudioNonSMP, /* = 96 */
273 
275  PFID_GetCores, /* = 97 */
276 
278  PFID_FetchValues_float, /* = 98 */
279 
282 
284  PFID_SetValues_float, /* = 100 */
285 
287  PFID_SetValuesSetCall_float, /* = 101 */
288 
290  PFID_FetchValue_float, /* = 102 */
291 
293  PFID_GetCallFetchValue_float, /* = 103 */
294 
296  PFID_SetValue_float, /* = 104 */
297 
299  PFID_SetValueSetCall_float, /* = 105 */
300 
302  PFID_SetValuesPartial, /* = 106 */
303 
305  PFID_SetValuesPartial_float, /* = 107 */
306 
307  // Hole id=108
308 
310  PFID_SetCores = 109, /* = 109 */
311 
312  // Hole id=110-111
313 
315  PFID_DestroyOnly = 112, /* = 112 */
316 
318  PFID_CheckMemory, /* = 113 */
319 
321  PFID_AWBChunk, /* = 114 */
322 
324  PFID_Comment, /* = 115 */
326  PFID_StartAudio2, /* = 116 */
327 
329  PFID_StopAudio2, /* = 117 */
330 
332  PFID_GetFirstRoute, /* = 118 */
333 
335  PFID_GetNextRoute, /* = 119 */
336 
338  PFID_GetValueHandle, /* = 120 */
339 
341  PFID_SetValueHandle, /* = 121 */
342 
344  PFID_GetStatusHandle, /* = 122 */
345 
347  PFID_SetStatusHandle, /* = 123 */
348 
350  PFID_GetValueHandleMask, /* = 124 */
351 
353  PFID_SetValueHandleMask, /* = 125 */
354 
356  PFID_GetExtendedInfo, /* = 126 */
357 
359  PFID_GetCores2, /* = 127 */
360 
361  PFID_GetInstanceTable = 127, /* = 127 */
362 
364  PFID_CreateWireBufferPool = 128, /* = 128 */
365 
367  PFID_CreateWireInBufferPool = 129, /* = 129 */
368 
369 } tProxyFuncID;
370 
371 #endif /* !PROXYIDS_H_INCLUDED */
372 
PFID_GetCores2
@ PFID_GetCores2
Function ID for GetCores().
Definition: ProxyIDs.h:376
PFID_FetchValues_float
@ PFID_FetchValues_float
Function ID for awe_fwFetchValue() as float.
Definition: ProxyIDs.h:295
PFID_GetHeapCount
@ PFID_GetHeapCount
Function ID for awe_fwGetHeapCount().
Definition: ProxyIDs.h:79
PFID_FlashReadOpen
@ PFID_FlashReadOpen
Command ID for FlashContent Read() awe_fwSetCall().
Definition: ProxyIDs.h:199
PFID_GetNextObject
@ PFID_GetNextObject
Function ID for awe_fwGetNextObject().
Definition: ProxyIDs.h:121
PFID_GetCallFetchValue_float
@ PFID_GetCallFetchValue_float
Function ID for awe_GetCall() as float followed by awe_fwFetchValue().
Definition: ProxyIDs.h:310
PFID_GetCallFetchValues
@ PFID_GetCallFetchValues
Function ID for awe_GetCall() followed by awe_fwFetchValues().
Definition: ProxyIDs.h:234
PFID_AllocateHeaps
@ PFID_AllocateHeaps
Allocate framework heaps.
Definition: ProxyIDs.h:213
PFID_SetPointer
@ PFID_SetPointer
Function ID for awe_fwSetPointer().
Definition: ProxyIDs.h:239
tProxyFuncID
tProxyFuncID
Enumeration of Proxy function IDs.
Definition: ProxyIDs.h:31
PFID_StopAudio
@ PFID_StopAudio
Function ID for StopAudio().
Definition: ProxyIDs.h:133
PFID_GetStatusHandle
@ PFID_GetStatusHandle
Get module status by handle.
Definition: ProxyIDs.h:361
PFID_GetFileSystemInfo
@ PFID_GetFileSystemInfo
Function ID for awe_GetFileSystemInfo().
Definition: ProxyIDs.h:175
PFID_SetValueHandle
@ PFID_SetValueHandle
Set value(s) by handle.
Definition: ProxyIDs.h:358
PFID_DeleteFile
@ PFID_DeleteFile
Function ID for awe_DeleteFile().
Definition: ProxyIDs.h:163
PFID_GetCall
@ PFID_GetCall
Function ID for awe_fwGetCall().
Definition: ProxyIDs.h:56
PFID_AddModuleToLayout
@ PFID_AddModuleToLayout
Function ID for awe_fwAddModuleToLayout().
Definition: ProxyIDs.h:190
PFID_GetModuleState
@ PFID_GetModuleState
Function ID for awe_fwGetModuleState().
Definition: ProxyIDs.h:109
PFID_GetClassType
@ PFID_GetClassType
Function ID for awe_fwGetClassType().
Definition: ProxyIDs.h:61
PFID_FileSystemReset
@ PFID_FileSystemReset
Function ID for awe_FileSystemReset().
Definition: ProxyIDs.h:181
PFID_GetFirstCore
@ PFID_GetFirstCore
Function ID for report first core.
Definition: ProxyIDs.h:283
PFID_StopAudio2
@ PFID_StopAudio2
Stop audio without callback.
Definition: ProxyIDs.h:346
PFID_Query_Flash_Erase_Complete
@ PFID_Query_Flash_Erase_Complete
Function ID for awe_fwGetQueryFlashEraseComplete().
Definition: ProxyIDs.h:265
PFID_WriteFile
@ PFID_WriteFile
Function ID for awe_WriteFile().
Definition: ProxyIDs.h:157
PFID_SetValues_float
@ PFID_SetValues_float
Function ID for awe_fwSetValue() as float.
Definition: ProxyIDs.h:301
PFID_GetFirstFile
@ PFID_GetFirstFile
Function ID for awe_GetFirstFile().
Definition: ProxyIDs.h:145
PFID_Query_Supported_Baud_Rates
@ PFID_Query_Supported_Baud_Rates
Function ID for awe_fwGetBaudRates().
Definition: ProxyIDs.h:268
PFID_GetCIModuleCount
@ PFID_GetCIModuleCount
Function ID for awe_fwGetCIModuleCount().
Definition: ProxyIDs.h:88
PFID_Reboot_Target
@ PFID_Reboot_Target
Function ID for reboot().
Definition: ProxyIDs.h:277
PFID_CloseFile
@ PFID_CloseFile
Function ID for awe_CloseFile().
Definition: ProxyIDs.h:160
PFID_SetValueSetCall_float
@ PFID_SetValueSetCall_float
Function ID for awe_fwSetValue() followed by awe_fwSetCall.
Definition: ProxyIDs.h:316
PFID_GetHeapSize
@ PFID_GetHeapSize
Function ID for awe_fwGetHeapSize().
Definition: ProxyIDs.h:82
PFID_Comment
@ PFID_Comment
Generate a comment on command line.
Definition: ProxyIDs.h:341
PFID_GetSizeofInt
@ PFID_GetSizeofInt
Function ID for awe_fwGetSizeofInt().
Definition: ProxyIDs.h:142
PFID_CheckMemory
@ PFID_CheckMemory
Special for target integrity bchecks.
Definition: ProxyIDs.h:335
PFID_AWBChunk
@ PFID_AWBChunk
Special for target integrity bchecks.
Definition: ProxyIDs.h:338
PFID_SetValueCall
@ PFID_SetValueCall
Function ID for awe_fwSetValue() awe_fwSetCall().
Definition: ProxyIDs.h:193
PFID_OpenFile
@ PFID_OpenFile
Function ID for awe_OpenFile().
Definition: ProxyIDs.h:151
PFID_UpdateLookupTable
@ PFID_UpdateLookupTable
Function ID for awe_fwSUpdateLookupTable().
Definition: ProxyIDs.h:247
PFID_SetStatusHandle
@ PFID_SetStatusHandle
Set module status by handle.
Definition: ProxyIDs.h:364
PFID_Set_Baud_Rate
@ PFID_Set_Baud_Rate
Function ID for awe_fwSetBaudRate().
Definition: ProxyIDs.h:271
PFID_GetCallFetchValues_float
@ PFID_GetCallFetchValues_float
Function ID for awe_GetCall() as float followed by awe_fwFetchValue().
Definition: ProxyIDs.h:298
PFID_ClassLayout_Constructor
@ PFID_ClassLayout_Constructor
Function ID for ClassLayout_Constructor().
Definition: ProxyIDs.h:97
PFID_FetchValue_float
@ PFID_FetchValue_float
Function ID for awe_fwFetchValue() as float.
Definition: ProxyIDs.h:307
PFID_GetPinType
@ PFID_GetPinType
Function ID for awe_fwGetPinType().
Definition: ProxyIDs.h:64
PFID_DestroyOnly
@ PFID_DestroyOnly
Function ID for destroy without stop.
Definition: ProxyIDs.h:332
PFID_SetValuesPartial
@ PFID_SetValuesPartial
Function ID for awe_fwSetValue().
Definition: ProxyIDs.h:319
PFID_ClassLayout_Process
@ PFID_ClassLayout_Process
Function ID for ClassLayout_Process().
Definition: ProxyIDs.h:115
PFID_Undefined
@ PFID_Undefined
Undefined ID - zero.
Definition: ProxyIDs.h:50
PFID_SetValue
@ PFID_SetValue
Function ID for awe_fwSetValue().
Definition: ProxyIDs.h:76
PFID_GetFirstRoute
@ PFID_GetFirstRoute
Get the first IPC route.
Definition: ProxyIDs.h:349
PFID_GetObjectByIndex
@ PFID_GetObjectByIndex
Function ID for awe_fwGetNextObject().
Definition: ProxyIDs.h:184
PFID_GetWireType
@ PFID_GetWireType
Function ID for awe_fwGetWireType().
Definition: ProxyIDs.h:256
PFID_DestroyAll
@ PFID_DestroyAll
Function ID for awe_fwDestroyAll().
Definition: ProxyIDs.h:280
PFID_FetchValue
@ PFID_FetchValue
Function ID for awe_fwFetchValue().
Definition: ProxyIDs.h:73
PFID_StartAudio
@ PFID_StartAudio
Function ID for StartAudio().
Definition: ProxyIDs.h:130
PFID_SetValueHandleMask
@ PFID_SetValueHandleMask
Set value(s) by handle and mask.
Definition: ProxyIDs.h:370
PFID_UpdateFirmware
@ PFID_UpdateFirmware
Command ID for update firmware() awe_fwSetCall().
Definition: ProxyIDs.h:196
PFID_GetNextIO
@ PFID_GetNextIO
Function ID for awe_fwGetNextIO().
Definition: ProxyIDs.h:127
PFID_GetExtendedInfo
@ PFID_GetExtendedInfo
Get extended target info.
Definition: ProxyIDs.h:373
PFID_SetValuesSetCall_float
@ PFID_SetValuesSetCall_float
Function ID for awe_fwSetValues() as float followed by awe_fwSetCall.
Definition: ProxyIDs.h:304
PFID_BindIOToWire
@ PFID_BindIOToWire
Function ID for BindIOToWire().
Definition: ProxyIDs.h:70
PFID_CreateWireInBufferPool
@ PFID_CreateWireInBufferPool
Function ID for awe_fwCreateWireInBufferPool().
Definition: ProxyIDs.h:384
PFID_SetID
@ PFID_SetID
Set an object's ID.
Definition: ProxyIDs.h:222
PFID_GetValueHandleMask
@ PFID_GetValueHandleMask
Get value(s) by handle and mask.
Definition: ProxyIDs.h:367
PFID_PumpModule
@ PFID_PumpModule
Function ID for awe_fwPumpModule().
Definition: ProxyIDs.h:112
PFID_GetProfileValues
@ PFID_GetProfileValues
Function ID for awe_fwGetProfileValues().
Definition: ProxyIDs.h:178
PFID_Lock_DSP
@ PFID_Lock_DSP
Command to forcefully corrupt DMA and lock DSP.
Definition: ProxyIDs.h:274
PFID_ClassWire_Constructor
@ PFID_ClassWire_Constructor
Function ID for ClassWire_Constructor().
Definition: ProxyIDs.h:67
PFID_ReadFile
@ PFID_ReadFile
Function ID for awe_ReadFile().
Definition: ProxyIDs.h:154
PFID_SetModuleState
@ PFID_SetModuleState
Function ID for awe_fwSetModuleState().
Definition: ProxyIDs.h:106
PFID_CreateLookupTable
@ PFID_CreateLookupTable
Function ID for awe_fwcreateLookupTable().
Definition: ProxyIDs.h:244
PFID_GetCores
@ PFID_GetCores
Function ID for GetCores().
Definition: ProxyIDs.h:292
PFID_WritePumpRead
@ PFID_WritePumpRead
Single message write-pump-read combo.
Definition: ProxyIDs.h:219
PFID_GetCallFetchValue
@ PFID_GetCallFetchValue
Function ID for awe_GetCall() followed by awe_fwFetchValue().
Definition: ProxyIDs.h:231
PFID_PumpLayout
@ PFID_PumpLayout
Function ID for awe_fwPumpLayout().
Definition: ProxyIDs.h:250
PFID_FetchValues
@ PFID_FetchValues
Function ID for awe_fwFetchValue().
Definition: ProxyIDs.h:136
PFID_SetCall
@ PFID_SetCall
Function ID for awe_fwSetCall().
Definition: ProxyIDs.h:53
PFID_StartAudioNonSMP
@ PFID_StartAudioNonSMP
Function ID for StartAudio().
Definition: ProxyIDs.h:289
PFID_FlashRead
@ PFID_FlashRead
Command ID for FlashContent Read() awe_fwSetCall().
Definition: ProxyIDs.h:202
PFID_SetInstanceID
@ PFID_SetInstanceID
Function ID for awe_fwSetInstanceID().
Definition: ProxyIDs.h:259
PFID_SetValuesSetCall
@ PFID_SetValuesSetCall
Function ID for awe_fwSetValues() followed by awe_fwSetCall.
Definition: ProxyIDs.h:228
PFID_Get_Flash_Erase_Time
@ PFID_Get_Flash_Erase_Time
Function ID for awe_fwGetFlashEraseTime().
Definition: ProxyIDs.h:262
PFID_GetTargetInfo
@ PFID_GetTargetInfo
Function ID for awe_GetTargetInfo().
Definition: ProxyIDs.h:172
PFID_GetFirstIO
@ PFID_GetFirstIO
Function ID for awe_fwGetFirstIO().
Definition: ProxyIDs.h:124
PFID_ClassModule_Constructor
@ PFID_ClassModule_Constructor
Function ID for ClassModule_Constructor().
Definition: ProxyIDs.h:94
PFID_Destroy
@ PFID_Destroy
Function ID for awe_fwDestroy().
Definition: ProxyIDs.h:85
PFID_GetWire
@ PFID_GetWire
Function ID for awe_fwGetWire().
Definition: ProxyIDs.h:103
PFID_GetNextRoute
@ PFID_GetNextRoute
Get the next IPC route.
Definition: ProxyIDs.h:352
PFID_DerefPointer
@ PFID_DerefPointer
Function ID for awe_fwDerefPointer().
Definition: ProxyIDs.h:253
PFID_SetValueSetCall
@ PFID_SetValueSetCall
Function ID for awe_fwSetValue() followed by awe_fwSetCall.
Definition: ProxyIDs.h:225
PFID_GetObjectByID
@ PFID_GetObjectByID
Function ID for awe_fwGetObjectByID().
Definition: ProxyIDs.h:187
PFID_StartAudio2
@ PFID_StartAudio2
Start audio without callback.
Definition: ProxyIDs.h:343
PFID_GetNextFile
@ PFID_GetNextFile
Function ID for awe_GetNextFile().
Definition: ProxyIDs.h:148
PFID_SetWire
@ PFID_SetWire
Function ID for awe_fwSetWire().
Definition: ProxyIDs.h:100
PFID_GetFirstObject
@ PFID_GetFirstObject
Function ID for awe_fwGetFirstObject().
Definition: ProxyIDs.h:118
PFID_DestroyHeaps
@ PFID_DestroyHeaps
Destroy framework heaps.
Definition: ProxyIDs.h:216
PFID_GetCIModuleInfo
@ PFID_GetCIModuleInfo
Function ID for awe_fwGetCIModuleInfo().
Definition: ProxyIDs.h:91
PFID_SetValuesPartial_float
@ PFID_SetValuesPartial_float
Function ID for awe_fwSetValue() as float.
Definition: ProxyIDs.h:322
PFID_ExecuteFile
@ PFID_ExecuteFile
Function ID for awe_ExecuteFile().
Definition: ProxyIDs.h:166
PFID_SetValues
@ PFID_SetValues
Function ID for awe_fwSetValue().
Definition: ProxyIDs.h:139
PFID_EraseFlash
@ PFID_EraseFlash
Function ID for awe_EraseFlash().
Definition: ProxyIDs.h:169
PFID_GetNextCore
@ PFID_GetNextCore
Function ID for report next core.
Definition: ProxyIDs.h:286
PFID_SetValue_float
@ PFID_SetValue_float
Function ID for awe_fwSetValue() as float.
Definition: ProxyIDs.h:313
PFID_GetValueHandle
@ PFID_GetValueHandle
Get value(s) by handle.
Definition: ProxyIDs.h:355
PFID_CreateWireBufferPool
@ PFID_CreateWireBufferPool
Function ID for awe_fwCreateWireBufferPool().
Definition: ProxyIDs.h:381
PFID_SetCores
@ PFID_SetCores
Function ID for GetCores().
Definition: ProxyIDs.h:327