AWECore 8.B.0 API Document
Errors.h
Go to the documentation of this file.
1 /*******************************************************************************
2 *
3 * Audio Framework
4 * ---------------
5 *
6 ********************************************************************************
7 * Errors.h
8 ********************************************************************************
9 *
10 * Description: AudioWeaver Framework Error Codes
11 *
12 * Copyright: (c) 2018 DSP Concepts, Inc. All rights reserved.
13 * 3235 Kifer Road
14 * Santa Clara, CA 95054
15 *
16 *******************************************************************************/
17 
25 #ifndef _ERRORS_H
26 #define _ERRORS_H
27 
28 
29 
31 #define E_SUCCESS (0)
32 
34 #define E_HEAP_INDEX_RANGE (-1)
35 
37 #define E_MALLOC_SIZE_TOO_BIG (-2)
38 
40 #define E_SCRATCH_ALLOC_SIZE_TOO_BIG (-3)
41 
43 #define E_CONSTRUCTOR_ARGUMENT_COUNT (-4)
44 
46 #define E_CLASS_INDEX_RANGE (-5)
47 
49 #define E_CLASS_NOT_FOUND (-6)
50 
52 #define E_MODULE_ALREADY_OWNED (-7)
53 
55 #define E_ASSIGN_ADDRESS_OUT_OF_RANGE (-8)
56 
58 #define E_MODULE_NOT_WIRE (-9)
59 
61 #define E_INPUTS_MUST_MATCH_OUTPUTS (-10)
62 
64 #define E_INPUTS_MUST_BE_SAME_PINTYPE (-11)
65 
67 #define E_MUST_HAVE_INPUTS (-12)
68 
70 #define E_MUST_HAVE_OUTPUTS (-13)
71 
73 #define E_INPUTS_MUST_MATCH_CORRESPONDING_OUTPUTS (-14)
74 
76 #define E_NOT_MODULE (-15)
77 
79 #define E_INPUT_OUTPUT_COUNT (-16)
80 
82 #define E_PARAMETER_ERROR (-17)
83 
85 #define E_NO_MORE_OBJECTS (-18)
86 
88 #define E_NOT_OBJECT_POINTER (-19)
89 
91 #define E_NOT_INPUT_PIN (-20)
92 
94 #define E_IOPIN_IN_USE (-21)
95 
97 #define E_PIN_TYPES_NOT_COMPATIBLE (-22)
98 
100 #define E_PIN_SIZES_NOT_COMPATIBLE (-23)
101 
103 #define E_NOT_OUTPUT_PIN (-24)
104 
106 #define E_NO_MORE_IOPINS (-25)
107 
109 #define E_NO_LAYOUTS (-26)
110 
112 #define E_MUST_HAVE_ONE_OUTPUT (-27)
113 
115 #define E_OUTPUT_MUST_BE_SINGLE_VALUE (-28)
116 
118 #define E_INCOMPATIBLE_BLOCK_SIZES (-29)
119 
121 #define E_WIRE_INDEX_RANGE (-30)
122 
124 #define E_NO_EVENT_HANDLER (-31)
125 
127 #define E_AUDIO_ALREADY_STARTED (-32)
128 
130 #define E_AUDIO_ALREADY_STOPPED (-33)
131 
133 #define E_COMMUNICATIONS_ERROR (-34)
134 
136 #define E_SALT_OBJECT_NOTFOUND (-35)
137 
139 #define E_SALT_FIELD_RANGE (-36)
140 
142 #define E_SALT_STATE_RANGE (-37)
143 
145 #define E_NOT_IMPLEMENTED_IN_RS232 (-38)
146 
148 #define E_BADPACKET (-39)
149 
151 #define E_BADFILE (-40)
152 
154 #define E_FILENAMELENGTH (-41)
155 
157 #define E_CANTCREATE (-42)
158 
160 #define E_CANTOPEN (-43)
161 
163 #define E_NOSUCHFILE (-44)
164 
166 #define E_IOERROR (-45)
167 
169 #define E_FIND_FIRST_FILE_NOT_CALLED (-46)
170 
172 #define E_NO_MORE_FILES (-47)
173 
175 #define E_BAD_FILENAME (-48)
176 
178 #define E_FILE_ALREADY_OPEN (-49)
179 
181 #define E_FILE_NOT_FOUND (-50)
182 
184 #define E_ILLEGAL_FILE_ATTRIBUTE (-51)
185 
187 #define E_FILE_ALREADY_EXISTS (-52)
188 
190 #define E_NO_OPEN_FILE (-53)
191 
193 #define E_OUT_OF_SPACE (-54)
194 
196 #define E_END_OF_FILE (-55)
197 
199 #define E_ERROR_READING_FLASH_MEMORY (-56)
200 
202 #define E_ERROR_WRITING_FLASH_MEMORY (-57)
203 
205 #define E_ERROR_ERASING_FLASH_MEMORY (-58)
206 
208 #define E_COMMAND_NOT_IMPLEMENTED (-59)
209 
211 #define E_INTERNAL_MODULE_ALLOCATION_FAILURE (-60)
212 
214 #define E_HARDWARE_FAILURE (-61)
215 
217 #define E_REGISTER_INVALID (-62)
218 
220 #define E_REGISTER_BUSY (-63)
221 
223 #define E_REGISTER_NOT_IMPLEMENTED (-64)
224 
226 #define E_REGISTER_READ_ONLY (-65)
227 
229 #define E_NO_HEAP_MEMORY (-66)
230 
232 #define E_ARGUMENT_ERROR (-67)
233 
235 #define E_DUPLICATE_ID (-68)
236 
238 #define E_ID_OUT_OF_RANGE (-69)
239 
241 #define E_READ_ONLY (-70)
242 
244 #define E_BAD_HEAP_POINTER (-71)
245 
247 #define E_HEAPS_ALREADY_INITIALIZED (-72)
248 
250 #define E_HEAPS_NOT_INITIALIZED (-73)
251 
253 #define E_EXCEPTION (-74)
254 
256 #define E_MESSAGE_LENGTH_TOO_LONG (-75)
257 
259 #define E_CRC_ERROR (-76)
260 
262 #define E_UNKNOWN_MESSAGE (-77)
263 
265 #define E_MSG_TIMEOUT (-78)
266 
268 #define E_OBJECT_ID_NOT_FOUND (-79)
269 
271 #define E_PIN_ID_NOT_FOUND (-80)
272 
274 #define E_NOT_OBJECT (-81)
275 
277 #define E_BAD_MEMBER_INDEX (-82)
278 
280 #define E_CLASS_NOT_SUPPORTED (-83)
281 
283 #define E_PUMP_OVERRUN (-84)
284 
286 #define E_NOT_V7 (-85)
287 
289 #define E_NO_FRAMEWORK (-86)
290 
292 #define E_NO_CORE (-87)
293 
295 #define E_IOPIN_TOO_MANY (-88)
296 
298 #define E_WIRE_ALREADY_BOUND (-89)
299 
301 #define E_WIRES_NOT_SPECIFIED (-90)
302 
304 #define E_NOT_CREATED (-91)
305 
307 #define E_ALREADY_CREATED (-92)
308 
310 #define E_AUDIO_NOT_STARTED (-93)
311 
313 #define E_LINKEDLIST_CORRUPT (-94)
314 
316 #define E_MODULE_NOT_INITIALIZED (-95)
317 
319 #define E_INVALID_FILE (-96)
320 
322 #define E_NO_MORE_ROUTES (-97)
323 
325 #define E_PUMP_NO_LAYOUTS (-98)
326 
328 #define E_NULL_PACKET_BUFFER_POINTER (-99)
329 
331 #define E_NULL_REPLY_BUFFER_POINTER (-100)
332 
334 #define E_ZERO_PACKET_BUFFER_LENGTH (-101)
335 
336 // In order to keep all the information about errors in one place the error description
337 // table is declared in this header. However, only one C file should actually instantiate
338 // this. All the other files that include this header should ignore.
339 
340 #ifdef DEFINE_ERROR_STRINGS
341 
342 static const char *s_error_strings[] =
343 {
344  "success", //#define E_SUCCESS (0)
345  "no such heap", //#define E_HEAP_INDEX_RANGE (-1)
346  "heap allocation request too large", //#define E_MALLOC_SIZE_TOO_BIG (-2)
347  "scratch allocation request too large", //#define E_SCRATCH_ALLOC_SIZE_TOO_BIG (-3)
348  "constructor argument count wrong", //#define E_CONSTRUCTOR_ARGUMENT_COUNT (-4)
349  "no such class index", //#define E_CLASS_INDEX_RANGE (-5)
350  "class name not found", //#define E_CLASS_NOT_FOUND (-6)
351  "module already owned by layout", //#define E_MODULE_ALREADY_OWNED (-7)
352  "address out of range", //#define E_ASSIGN_ADDRESS_OUT_OF_RANGE (-8)
353  "module used, wire expected", //#define E_MODULE_NOT_WIRE (-9)
354  "input must match outputs", //#define E_INPUTS_MUST_MATCH_OUTPUTS (-10)
355  "input pintypes don't match", //#define E_INPUTS_MUST_BE_SAME_PINTYPE (-11)
356  "input(s) must be specified", //#define E_MUST_HAVE_INPUTS (-12)
357  "output(s) must be specified", //#define E_MUST_HAVE_OUTPUTS (-13)
358  "inputs must match corresponding outputs", //#define E_INPUTS_MUST_MATCH_CORRESPONDING_OUTPUTS (-14)
359  "not a module", //#define E_NOT_MODULE (-15)
360  "input/output count wrong", //#define E_INPUT_OUTPUT_COUNT (-16)
361  "Parameter error", //#define E_PARAMETER_ERROR (-17)
362  "no more objects found", //#define E_NO_MORE_OBJECTS (-18)
363  "pointer value is invalid", //#define E_NOT_OBJECT_POINTER (-19)
364  "not an input pin", //#define E_NOT_INPUT_PIN (-20)
365  "I/O pin is in use", //#define E_IOPIN_IN_USE (-21)
366  "pin types not compatible", //#define E_PIN_TYPES_NOT_COMPATIBLE (-22)
367  "pin sizes not compatible", //#define E_PIN_SIZES_NOT_COMPATIBLE (-23)
368  "not an output pin", //#define E_NOT_OUTPUT_PIN (-24)
369  "no more pins found", //#define E_NO_MORE_IOPINS (-25)
370  "no layout(s) to pump", //#define E_NO_LAYOUTS (-26)
371  "must have one output", //#define E_MUST_HAVE_ONE_OUTPUT (-27)
372  "output must be single value", //#define E_OUTPUT_MUST_BE_SINGLE_VALUE (-28)
373  "incompatible block sizes", //#define E_INCOMPATIBLE_BLOCK_SIZES (-29)
374  "wire index out of range", //#define E_WIRE_INDEX_RANGE (-30)
375  "module has no event handler", //#define E_NO_EVENT_HANDLER (-31)
376  "audio already started", //#define E_AUDIO_ALREADY_STARTED (-32)
377  "audio already stopped", //#define E_AUDIO_ALREADY_STOPPED (-33)
378  "communications error", //#define E_COMMUNICATIONS_ERROR (-34)
379  "SALT object not found", //#define E_SALT_OBJECT_NOTFOUND (-35)
380  "SALT field range error", //#define E_SALT_FIELD_RANGE (-36)
381  "SALT state range error", //#define E_SALT_STATE_RANGE (-37)
382  "not implemented", //#define E_NOT_IMPLEMENTED_IN_RS232 (-38)
383  "bad packet received", //#define E_BADPACKET (-39)
384  "invalid filename", //#define E_BADFILE (-40)
385  "filename too long", //#define E_FILENAMELENGTH (-41)
386  "file create failed", //#define E_CANTCREATE (-42)
387  "file open failed", //#define E_CANTOPEN (-43)
388  "no such file", //#define E_NOSUCHFILE (-44)
389  "file I/O error", //#define E_IOERROR (-45)
390  "FindNext called without FindFirst", //#define E_FIND_FIRST_FILE_NOT_CALLED (-46)
391  "no more files found", //#define E_NO_MORE_FILES (-47)
392  "bad filename", //#define E_BAD_FILENAME (-48)
393  "file already open", //#define E_FILE_ALREADY_OPEN (-49)
394  "no such file", //#define E_FILE_NOT_FOUND (-50)
395  "illegal file attribute", //#define E_ILLEGAL_FILE_ATTRIBUTE (-51)
396  "file already exists", //#define E_FILE_ALREADY_EXISTS (-52)
397  "no open file", //#define E_NO_OPEN_FILE (-53)
398  "file system full", //#define E_OUT_OF_SPACE (-54)
399  "end of file", //#define E_END_OF_FILE (-55)
400  "FLASH read error", //#define E_ERROR_READING_FLASH_MEMORY (-56)
401  "FLASH write error", //#define E_ERROR_WRITING_FLASH_MEMORY (-57)
402  "FLASH erase error", //#define E_ERROR_ERASING_FLASH_MEMORY (-58)
403  "no such command", //#define E_COMMAND_NOT_IMPLEMENTED (-59)
404  "internal module allocation error", //#define E_INTERNAL_MODULE_ALLOCATION_FAILURE (-60)
405  "hardware failure", //#define E_HARDWARE_FAILURE (-61)
406  "register invalid", //#define E_REGISTER_INVALID (-62)
407  "register busy", //#define E_REGISTER_BUSY (-63)
408  "register not implemented", //#define E_REGISTER_NOT_IMPLEMENTED (-64)
409  "register read only", //#define E_REGISTER_READ_ONLY (-65)
410  "create heap failed", //#define E_NO_HEAP_MEMORY (-66)
411  "invalid argument", //#define E_ARGUMENT_ERROR (-67)
412  "duplicate ID", //#define E_DUPLICATE_ID (-68)
413  "ID out of range", //#define E_ID_OUT_OF_RANGE (-69)
414  "read only", //#define E_READ_ONLY (-70)
415  "bad heap pointer", //#define E_BAD_HEAP_POINTER (-71)
416  "heaps already initialized", //#define E_HEAPS_ALREADY_INITIALIZED (-72)
417  "heaps not initialized", //#define E_HEAPS_NOT_INITIALIZED (-73)
418  "framework exception", //#define E_EXCEPTION (-74)
419  "message too long", //#define E_MESSAGE_LENGTH_TOO_LONG (-75)
420  "CRC error", //#define E_CRC_ERROR (-76)
421  "unimplemented or invalid command ID", //#define E_UNKNOWN_MESSAGE (-77)
422  "message timed out", //#define E_MSG_TIMEOUT (-78)
423  "object ID not found", //#define E_OBJECT_ID_NOT_FOUND (-79)
424  "no such pin", //#define E_PIN_ID_NOT_FOUND (-80)
425  "not an object", //#define E_NOT_OBJECT (-81)
426  "bad member index", //#define E_BAD_MEMBER_INDEX (-82)
427  "not supported", //#define E_CLASS_NOT_SUPPORTED )-83)
428  "audio overrun", //#define E_PUMP_OVERRUN (-84)
429  "not a V7 target", //#define E_NOT_V7 (-85)
430  "no framework", //#define E_NO_FRAMEWORK (-86)
431  "no such core", //#define E_NO_CORE (-87)
432  "too many bound wires", //#define E_IOPIN_TOO_MANY (-88)
433  "wire already bound", //#define E_WIRE_ALREADY_BOUND (-89)
434  "wires must be specified", //#define E_WIRES_NOT_SPECIFIED (-90)
435  "instance not created", //#define E_NOT_CREATED (-91)
436  "instance already created", //#define E_ALREADY_CREATED (-92)
437  "audio not started", //#define E_AUDIO_NOT_STARTED (-93)
438  "linked list corrupted", //#define E_LINKEDLIST_CORRUPT (-94)
439  "module not initialized", //#define E_MODULE_NOT_INITIALIZED (-95)
440  "invalid file content", //#define E_INVALID_FILE (-96)
441  "no more routes", //#define E_NO_MORE_ROUTES (-97)
442  "pump initiated with no layout", //#define E_PUMP_NO_LAYOUTS (-98)
443  "packet buffer Pointer not initialized" //#define E_NULL_PACKET_BUFFER_POINTER (-99)
444  "reply buffer Pointer not initialized" //#define E_NULL_REPLY_BUFFER_POINTER (-100)
445  "packet buffer length is 0" //#define E_ZERO_PACKET_BUFFER_LENGTH (-101)
446 };
447 #endif
448 
449 #endif // _ERRORS_H
450