Commit | Line | Data |
---|---|---|
81eb669b DC |
1 | /* Cypress West Bridge API header file (cyaserr.h) |
2 | ## =========================== | |
3 | ## Copyright (C) 2010 Cypress Semiconductor | |
4 | ## | |
5 | ## This program is free software; you can redistribute it and/or | |
6 | ## modify it under the terms of the GNU General Public License | |
7 | ## as published by the Free Software Foundation; either version 2 | |
8 | ## of the License, or (at your option) any later version. | |
9 | ## | |
10 | ## This program is distributed in the hope that it will be useful, | |
11 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | ## GNU General Public License for more details. | |
14 | ## | |
15 | ## You should have received a copy of the GNU General Public License | |
16 | ## along with this program; if not, write to the Free Software | |
17 | ## Foundation, Inc., 51 Franklin Street | |
18 | ## Fifth Floor, Boston, MA 02110-1301, USA. | |
19 | ## =========================== | |
20 | */ | |
21 | ||
22 | #ifndef _INCLUDED_CYASERR_H_ | |
23 | #define _INCLUDED_CYASERR_H_ | |
24 | ||
25 | /*@@West Bridge Errors | |
26 | Summary | |
27 | This section lists the error codes for West Bridge. | |
28 | ||
29 | */ | |
30 | ||
31 | /* Summary | |
32 | The function completed sucessfully | |
33 | */ | |
34 | #define CY_AS_ERROR_SUCCESS (0) | |
35 | ||
36 | /* Summary | |
37 | A function trying to acquire a resource was unable to do so. | |
38 | ||
39 | Description | |
40 | This code indicates that a resource that the API was trying to claim | |
41 | could not be claimed. | |
42 | ||
43 | See Also | |
44 | * CyAsMiscAcquireResource | |
45 | * CyAsStorageClaim | |
46 | */ | |
47 | #define CY_AS_ERROR_NOT_ACQUIRED (1) | |
48 | ||
49 | /* Summary | |
50 | A function trying to acquire a resource was unable to do so. | |
51 | ||
52 | Description | |
53 | The West Bridge API provides the capability to assign the storage media to | |
54 | either the West Bridge device or the USB port. This error indicates the | |
55 | P port was trying to release a storage media and was not able to do | |
56 | so. This generally means it was not owned by the P port processor. | |
57 | ||
58 | See Also | |
59 | * CyAsStorageRelease | |
60 | */ | |
61 | #define CY_AS_ERROR_NOT_RELEASED (2) | |
62 | ||
63 | /* Summary | |
64 | The West Bridge firmware is not loaded. | |
65 | ||
66 | Description | |
67 | Most of the API functions that are part of the West Bridge API rely on | |
68 | firmware running on the West Bridge device. This error code is | |
69 | returned when one of these functions is called and the firmware has | |
70 | not yet been loaded. | |
71 | ||
72 | See Also | |
73 | * CyAsMiscGetFirmwareVersion | |
74 | * CyAsMiscReset | |
75 | * CyAsMiscAcquireResource | |
76 | * CyAsMiscReleaseResource | |
77 | * CyAsMiscSetTraceLevel | |
78 | * CyAsStorageStart | |
79 | * CyAsStorageStop | |
80 | * CyAsStorageRegisterCallback | |
81 | * CyAsStorageClaim | |
82 | * CyAsStorageRelease | |
83 | * CyAsStorageQueryMedia | |
84 | * CyAsStorageQueryDevice | |
85 | * CyAsStorageQueryUnit | |
86 | * CyAsStorageRead | |
87 | * CyAsStorageWrite | |
88 | * CyAsStorageReadAsync | |
89 | * CyAsStorageWriteAsync | |
90 | */ | |
91 | #define CY_AS_ERROR_NO_FIRMWARE (3) | |
92 | ||
93 | /* Summary | |
94 | A timeout occurred waiting on a response from the West Bridge device | |
95 | ||
96 | Description | |
97 | When requests are made of the West Bridge device, a response is expected | |
98 | within a given timeframe. If a response is not recevied within the | |
99 | given timeframe, a timeout error occurs. | |
100 | */ | |
101 | #define CY_AS_ERROR_TIMEOUT (4) | |
102 | ||
103 | /* Summary | |
104 | A request to download firmware was made while not in the CONFIG mode | |
105 | ||
106 | Description | |
107 | Firmware is downloaded via the CyAsMiscDownloadFirmware() function. This | |
108 | function can only be called while in the CONFIG mode. This error indicates | |
109 | that the CyAsMiscDownloadFirmware() call was made while not in the CONFIG | |
110 | mode. | |
111 | ||
112 | See Also | |
113 | * CyAsMiscDownloadFirmware | |
114 | */ | |
115 | #define CY_AS_ERROR_NOT_IN_CONFIG_MODE (5) | |
116 | ||
117 | /* Summary | |
118 | This error is returned if the firmware size specified is too invalid. | |
119 | ||
120 | Description | |
121 | If the size of the firmware to be downloaded into West Bridge is | |
122 | invalid, this error is issued. Invalid firmware sizes are those | |
123 | greater than 24K or a size of zero. | |
124 | ||
125 | See Also | |
126 | * CyAsMiscDownloadFirmare | |
127 | */ | |
128 | #define CY_AS_ERROR_INVALID_SIZE (6) | |
129 | ||
130 | /* Summary | |
131 | This error is returned if a request is made to acquire a resource that has | |
132 | already been acquired. | |
133 | ||
134 | Description | |
135 | This error is returned if a request is made to acquire a resource that has | |
136 | already been acquired. | |
137 | ||
138 | See Also | |
139 | * CyAsMiscAcquireResource | |
140 | * CyAsMiscReleaseResource | |
141 | */ | |
142 | #define CY_AS_ERROR_RESOURCE_ALREADY_OWNED (7) | |
143 | ||
144 | /* Summary | |
145 | This error is returned if a request is made to release a resource that has | |
146 | not previously been acquired. | |
147 | ||
148 | Description | |
149 | This error is returned if a request is made to release a resource that has | |
150 | not previously been acquired. | |
151 | ||
152 | See Also | |
153 | * CyAsMiscAcquireResource | |
154 | * CyAsMiscReleaseResource | |
155 | */ | |
156 | #define CY_AS_ERROR_RESOURCE_NOT_OWNED (8) | |
157 | ||
158 | /* Summary | |
159 | This error is returned when a request is made for a media that | |
160 | does not exist | |
161 | ||
162 | Description | |
163 | This error is returned when a request is made that references | |
164 | a storage media that does not exist. This error is returned | |
165 | when the storage media is not present in the current system, | |
166 | or if the media value given is not valid. | |
167 | ||
168 | See Also | |
169 | * CyAsMiscSetTraceLevel | |
170 | * CyAsStorageClaim | |
171 | * CyAsStorageRelease | |
172 | * CyAsStorageRead | |
173 | * CyAsStorageWrite | |
174 | * CyAsStorageReadAsync | |
175 | * CyAsStorageWriteAsync | |
176 | */ | |
177 | #define CY_AS_ERROR_NO_SUCH_MEDIA (9) | |
178 | ||
179 | /* Summary | |
180 | This error is returned when a request is made for a device | |
181 | that does not exist | |
182 | ||
183 | Description | |
184 | This error is returned when a request is made that references a | |
185 | storage device that does not exist. This error is returned when | |
186 | the device index is not present in the current system, or if the | |
187 | device index exceeds 15. | |
188 | ||
189 | See Also | |
190 | * CyAsMiscSetTraceLevel | |
191 | * CyAsStorageQueryDevice | |
192 | * CyAsStorageRead | |
193 | * CyAsStorageWrite | |
194 | * CyAsStorageReadAsync | |
195 | * CyAsStorageWriteAsync | |
196 | */ | |
197 | #define CY_AS_ERROR_NO_SUCH_DEVICE (10) | |
198 | ||
199 | /* Summary | |
200 | This error is returned when a request is made for a unit that | |
201 | does not exist | |
202 | ||
203 | Description | |
204 | This error is returned when a request is made that references | |
205 | a storage unit that does not exist. This error is returned | |
206 | when the unit index is not present in the current system, or | |
207 | if the unit index exceeds 255. | |
208 | ||
209 | See Also | |
210 | * CyAsMiscSetTraceLevel | |
211 | * CyAsStorageQueryDevice | |
212 | * CyAsStorageQueryUnit | |
213 | * CyAsStorageRead | |
214 | * CyAsStorageWrite | |
215 | * CyAsStorageReadAsync | |
216 | * CyAsStorageWriteAsync | |
217 | */ | |
218 | #define CY_AS_ERROR_NO_SUCH_UNIT (11) | |
219 | ||
220 | /* Summary | |
221 | This error is returned when a request is made for a block that | |
222 | does not exist | |
223 | ||
224 | Description | |
225 | This error is returned when a request is made that references | |
226 | a storage block that does not exist. This error is returned | |
227 | when the block address reference an address beyond the end of | |
228 | the unit selected. | |
229 | ||
230 | See Also | |
231 | * CyAsStorageRead | |
232 | * CyAsStorageWrite | |
233 | * CyAsStorageReadAsync | |
234 | * CyAsStorageWriteAsync | |
235 | */ | |
236 | #define CY_AS_ERROR_INVALID_BLOCK (12) | |
237 | ||
238 | /* Summary | |
239 | This error is returned when an invalid trace level is set. | |
240 | ||
241 | Description | |
242 | This error is returned when the trace level request is greater | |
243 | than three. | |
244 | ||
245 | See Also | |
246 | * CyAsMiscSetTraceLevel | |
247 | */ | |
248 | #define CY_AS_ERROR_INVALID_TRACE_LEVEL (13) | |
249 | ||
250 | /* Summary | |
251 | This error is returned when West Bridge is already in the standby state | |
252 | and an attempt is made to put West Bridge into this state again. | |
253 | ||
254 | Description | |
255 | This error is returned when West Bridge is already in the standby state | |
256 | and an attempt is made to put West Bridge into this state again. | |
257 | ||
258 | See Also | |
259 | * CyAsMiscEnterStandby | |
260 | */ | |
261 | #define CY_AS_ERROR_ALREADY_STANDBY (14) | |
262 | ||
263 | /* Summary | |
264 | This error is returned when the API needs to set a pin on the | |
265 | West Bridge device, but this is not supported by the underlying HAL | |
266 | layer. | |
267 | ||
268 | Description | |
269 | This error is returned when the API needs to set a pin on the | |
270 | West Bridge device, but this is not supported by the underlying HAL | |
271 | layer. | |
272 | ||
273 | See Also | |
274 | * CyAsMiscEnterStandby | |
275 | * CyAsMiscLeaveStandby | |
276 | */ | |
277 | #define CY_AS_ERROR_SETTING_WAKEUP_PIN (15) | |
278 | ||
279 | /* Summary | |
280 | This error is returned when a module is being started that has | |
281 | already been started. | |
282 | ||
283 | Description | |
284 | This error is returned when a module is being started and that module | |
285 | has already been started. This error does not occur with the | |
286 | CyAsStorageStart() or CyAsUsbStart() functions as the storage and | |
287 | USB modules are reference counted. | |
288 | ||
289 | Note | |
290 | At the current time, this error is returned by module internal to | |
291 | the API but not returned by any of the API functions. | |
292 | */ | |
293 | #define CY_AS_ERROR_ALREADY_RUNNING (16) | |
294 | ||
295 | /* Summary | |
296 | This error is returned when a module is being stopped that has | |
297 | already been stopped. | |
298 | ||
299 | Description | |
300 | This error is returned when a module is being stopped and that module | |
301 | has already been stopped. This error does not occur with the | |
302 | CyAsStorageStop() or CyAsUsbStop() functions as the storage and USB | |
303 | modules are reference counted. | |
304 | ||
305 | Note | |
306 | At the current time, this error is returned by module internal to | |
307 | the API but not returned by any of the API functions. | |
308 | */ | |
309 | ||
310 | #define CY_AS_ERROR_NOT_RUNNING (17) | |
311 | ||
312 | /* Summary | |
313 | This error is returned when the caller tries to claim a media that | |
314 | has already been claimed. | |
315 | ||
316 | Description | |
317 | This error is returned when the caller tries to claim a media that | |
318 | has already been claimed. | |
319 | ||
320 | See Also | |
321 | * CyAsStorageClaim | |
322 | */ | |
323 | #define CY_AS_ERROR_MEDIA_ALREADY_CLAIMED (18) | |
324 | ||
325 | /* Summary | |
326 | This error is returned when the caller tries to release a media that has | |
327 | already been released. | |
328 | ||
329 | Description | |
330 | This error is returned when the caller tries to release a media that has | |
331 | already been released. | |
332 | ||
333 | See Also | |
334 | * CyAsStorageRelease | |
335 | */ | |
336 | #define CY_AS_ERROR_MEDIA_NOT_CLAIMED (19) | |
337 | ||
338 | /* Summary | |
339 | This error is returned when canceling trying to cancel an asynchronous | |
340 | operation when an async operation is not pending. | |
341 | ||
342 | Description | |
343 | This error is returned when a call is made to a function to cancel an | |
344 | asynchronous operation and there is no asynchronous operation pending. | |
345 | ||
346 | See Also | |
347 | * CyAsStorageCancelAsync | |
348 | * CyAsUsbCancelAsync | |
349 | */ | |
350 | #define CY_AS_ERROR_NO_OPERATION_PENDING (20) | |
351 | ||
352 | /* Summary | |
353 | This error is returned when an invalid endpoint number is provided to | |
354 | an API call. | |
355 | ||
356 | Description | |
357 | This error is returned when an invalid endpoint number is specified in | |
358 | an API call. The endpoint number may be invalid because it is greater | |
359 | than 15, or because it was a reference to an endpoint that is invalid | |
360 | for West Bridge (2, 4, 6, or 8). | |
361 | ||
362 | See Also | |
363 | * CyAsUsbSetEndPointConfig | |
364 | * CyAsUsbGetEndPointConfig | |
365 | * CyAsUsbReadData | |
366 | * CyAsUsbWriteData | |
367 | * CyAsUsbReadDataAsync | |
368 | * CyAsUsbWriteDataAsync | |
369 | * CyAsUsbSetStall | |
370 | * CyAsUsbGetStall | |
371 | */ | |
372 | #define CY_AS_ERROR_INVALID_ENDPOINT (21) | |
373 | ||
374 | /* Summary | |
375 | This error is returned when an invalid descriptor type | |
376 | is specified in an API call. | |
377 | ||
378 | Description | |
379 | This error is returned when an invalid descriptor type | |
380 | is specified in an API call. | |
381 | ||
382 | See Also | |
383 | * CyAsUsbSetDescriptor | |
384 | * CyAsUsbGetDescriptor | |
385 | */ | |
386 | #define CY_AS_ERROR_INVALID_DESCRIPTOR (22) | |
387 | ||
388 | /* Summary | |
389 | This error is returned when an invalid descriptor index | |
390 | is specified in an API call. | |
391 | ||
392 | Description | |
393 | This error is returned when an invalid descriptor index | |
394 | is specified in an API call. | |
395 | ||
396 | See Also | |
397 | * CyAsUsbSetDescriptor | |
398 | * CyAsUsbGetDescriptor | |
399 | */ | |
400 | #define CY_AS_ERROR_BAD_INDEX (23) | |
401 | ||
402 | /* Summary | |
403 | This error is returned if trying to set a USB descriptor | |
404 | when in the P port enumeration mode. | |
405 | ||
406 | Description | |
407 | This error is returned if trying to set a USB descriptor | |
408 | when in the P port enumeration mode. | |
409 | ||
410 | See Also | |
411 | * CyAsUsbSetDescriptor | |
412 | * CyAsUsbGetDescriptor | |
413 | */ | |
414 | #define CY_AS_ERROR_BAD_ENUMERATION_MODE (24) | |
415 | ||
416 | /* Summary | |
417 | This error is returned when the endpoint configuration specified | |
418 | is not valid. | |
419 | ||
420 | Description | |
421 | This error is returned when the endpoint configuration specified | |
422 | is not valid. | |
423 | ||
424 | See Also | |
425 | * CyAsUsbSetDescriptor | |
426 | * CyAsUsbGetDescriptor | |
427 | * CyAsUsbCommitConfig | |
428 | */ | |
429 | #define CY_AS_ERROR_INVALID_CONFIGURATION (25) | |
430 | ||
431 | /* Summary | |
432 | This error is returned when the API cannot verify it is connected | |
433 | to an West Bridge device. | |
434 | ||
435 | Description | |
436 | When the API is initialized, the API tries to read the ID register from | |
437 | the West Bridge device. The value from this ID register should match the | |
438 | value expected before communications with West Bridge are established. This | |
439 | error means that the contents of the ID register cannot be verified. | |
440 | ||
441 | See Also | |
442 | * CyAsMiscConfigureDevice | |
443 | */ | |
444 | #define CY_AS_ERROR_NO_ANTIOCH (26) | |
445 | ||
446 | /* Summary | |
447 | This error is returned when an API function is called and | |
448 | CyAsMiscConfigureDevice has not been called to configure West Bridge | |
449 | for the current environment. | |
450 | ||
451 | Description | |
452 | This error is returned when an API function is called and | |
453 | CyAsMiscConfigureDevice has not been called to configure West Bridge for | |
454 | the current environment. | |
455 | ||
456 | See Also | |
457 | * Almost all API function | |
458 | */ | |
459 | #define CY_AS_ERROR_NOT_CONFIGURED (27) | |
460 | ||
461 | /* Summary | |
462 | This error is returned when West Bridge cannot allocate memory required for | |
463 | internal API operations. | |
464 | ||
465 | Description | |
466 | This error is returned when West Bridge cannot allocate memory required for | |
467 | internal API operations. | |
468 | ||
469 | See Also | |
470 | * Almost all API functoins | |
471 | */ | |
472 | #define CY_AS_ERROR_OUT_OF_MEMORY (28) | |
473 | ||
474 | /* Summary | |
475 | This error is returned when a module is being started that has | |
476 | already been started. | |
477 | ||
478 | Description | |
479 | This error is returned when a module is being started and that module | |
480 | has already been started. This error does not occur with the | |
481 | CyAsStorageStart() or CyAsUsbStart() functions as the storage and | |
482 | USB modules are reference counted. | |
483 | ||
484 | Note | |
485 | At the current time, this error is returned by module internal to the API but | |
486 | not returned by any of the API functions. | |
487 | */ | |
488 | #define CY_AS_ERROR_NESTED_SLEEP (29) | |
489 | ||
490 | /* Summary | |
491 | This error is returned when an operation is attempted on an endpoint that has | |
492 | been disabled. | |
493 | ||
494 | Description | |
495 | This error is returned when an operation is attempted on an endpoint that has | |
496 | been disabled. | |
497 | ||
498 | See Also | |
499 | * CyAsUsbReadData | |
500 | * CyAsUsbWriteData | |
501 | * CyAsUsbReadDataAsync | |
502 | * CyAsUsbWriteDataAsync | |
503 | */ | |
504 | #define CY_AS_ERROR_ENDPOINT_DISABLED (30) | |
505 | ||
506 | /* Summary | |
507 | This error is returned when a call is made to an API function when | |
508 | the device is in standby. | |
509 | ||
510 | Description | |
511 | When the West Bridge device is in standby, the only two API functions that | |
512 | can be called are CyAsMiscInStandby() and CyAsMiscLeaveStandby(). | |
513 | Calling any other API function will result in this error. | |
514 | ||
515 | See Also | |
516 | */ | |
517 | #define CY_AS_ERROR_IN_STANDBY (31) | |
518 | ||
519 | /* Summary | |
520 | This error is returned when an API call is made with an invalid handle value. | |
521 | ||
522 | Description | |
523 | This error is returned when an API call is made with an invalid handle value. | |
524 | ||
525 | See Also | |
526 | */ | |
527 | #define CY_AS_ERROR_INVALID_HANDLE (32) | |
528 | ||
529 | /* Summary | |
530 | This error is returned when an invalid response is returned from | |
531 | the West Bridge device. | |
532 | ||
533 | Description | |
534 | Many of the API calls result in requests made to the West Bridge | |
535 | device. This error occurs when the response from West Bridge is | |
536 | invalid and generally indicates that the West Bridge device | |
537 | should be reset. | |
538 | ||
539 | See Also | |
540 | */ | |
541 | #define CY_AS_ERROR_INVALID_RESPONSE (33) | |
542 | ||
543 | /* Summary | |
544 | This error is returned from the callback function for any asynchronous | |
545 | read or write request that is canceled. | |
546 | ||
547 | Description | |
548 | When asynchronous requests are canceled, this error is passed to the | |
549 | callback function associated with the request to indicate that the | |
550 | request has been canceled | |
551 | ||
552 | See Also | |
553 | * CyAsStorageReadAsync | |
554 | * CyAsStorageWriteAsync | |
555 | * CyAsUsbReadDataAsync | |
556 | * CyAsUsbWriteDataAsync | |
557 | * CyAsStorageCancelAsync | |
558 | * CyAsUsbCancelAsync | |
559 | */ | |
560 | #define CY_AS_ERROR_CANCELED (34) | |
561 | ||
562 | /* Summary | |
563 | This error is returned when the call to create sleep channel fails | |
564 | in the HAL layer. | |
565 | ||
566 | Description | |
567 | This error is returned when the call to create sleep channel fails | |
568 | in the HAL layer. | |
569 | ||
570 | See Also | |
571 | * CyAsMiscConfigureDevice | |
572 | */ | |
573 | #define CY_AS_ERROR_CREATE_SLEEP_CHANNEL_FAILED (35) | |
574 | ||
575 | /* Summary | |
576 | This error is returned when the call to CyAsMiscLeaveStandby | |
577 | is made and the device is not in standby. | |
578 | ||
579 | Description | |
580 | This error is returned when the call to CyAsMiscLeaveStandby | |
581 | is made and the device is not in standby. | |
582 | ||
583 | See Also | |
584 | */ | |
585 | #define CY_AS_ERROR_NOT_IN_STANDBY (36) | |
586 | ||
587 | /* Summary | |
588 | This error is returned when the call to destroy sleep channel fails | |
589 | in the HAL layer. | |
590 | ||
591 | Description | |
592 | This error is returned when the call to destroy sleep channel fails | |
593 | in the HAL layer. | |
594 | ||
595 | See Also | |
596 | * CyAsMiscDestroyDevice | |
597 | */ | |
598 | #define CY_AS_ERROR_DESTROY_SLEEP_CHANNEL_FAILED (37) | |
599 | ||
600 | /* Summary | |
601 | This error is returned when an invalid resource is specified to a call | |
602 | to CyAsMiscAcquireResource() or CyAsMiscReleaseResource() | |
603 | ||
604 | Description | |
605 | This error is returned when an invalid resource is specified to a call | |
606 | to CyAsMiscAcquireResource() or CyAsMiscReleaseResource() | |
607 | ||
608 | See Also | |
609 | * CyAsMiscAcquireResource | |
610 | * CyAsMiscReleaseResource | |
611 | */ | |
612 | #define CY_AS_ERROR_INVALID_RESOURCE (38) | |
613 | ||
614 | /* Summary | |
615 | This error occurs when an operation is requested on an endpoint that has | |
616 | a currently pending async operation. | |
617 | ||
618 | Description | |
619 | There can only be a single asynchronous pending operation on a given | |
620 | endpoint and while the operation is pending on other operation can occur | |
621 | on the endpoint. In addition, the device cannot enter standby while | |
622 | any asynchronous operations are pending. | |
623 | ||
624 | See Also | |
625 | * CyAsStorageReadAsync | |
626 | * CyAsStorageWriteAsync | |
627 | * CyAsUsbReadDataAsync | |
628 | * CyAsUsbWriteDataAsync | |
629 | * CyAsStorageRead | |
630 | * CyAsStorageWrite | |
631 | * CyAsUsbReadData | |
632 | * CyAsUsbWriteData | |
633 | * CyAsMiscEnterStandby | |
634 | */ | |
635 | #define CY_AS_ERROR_ASYNC_PENDING (39) | |
636 | ||
637 | /* Summary | |
638 | This error is returned when a call to CyAsStorageCancelAsync() or | |
639 | CyAsUsbCancelAsync() is made when no asynchronous request is pending. | |
640 | ||
641 | Description | |
642 | This error is returned when a call to CyAsStorageCancelAsync() or | |
643 | CyAsUsbCancelAsync() is made when no asynchronous request is pending. | |
644 | ||
645 | See Also | |
646 | * CyAsStorageCancelAsync | |
647 | * CyAsUsbCancelAsync | |
648 | */ | |
649 | #define CY_AS_ERROR_ASYNC_NOT_PENDING (40) | |
650 | ||
651 | /* Summary | |
652 | This error is returned when a request is made to put the West Bridge device | |
653 | into standby mode while the USB stack is still active. | |
654 | ||
655 | Description | |
656 | This error is returned when a request is made to put the West Bridge device | |
657 | into standby mode while the USB stack is still active. You must call the | |
658 | function CyAsUsbStop() in order to shut down the USB stack in order to go | |
659 | into the standby mode. | |
660 | ||
661 | See Also | |
662 | * CyAsMiscEnterStandby | |
663 | */ | |
664 | #define CY_AS_ERROR_USB_RUNNING (41) | |
665 | ||
666 | /* Summary | |
667 | A request for in the wrong direction was issued on an endpoint. | |
668 | ||
669 | Description | |
670 | This error is returned when a write is attempted on an OUT endpoint or | |
671 | a read is attempted on an IN endpoint. | |
672 | ||
673 | See Also | |
674 | * CyAsUsbReadData | |
675 | * CyAsUsbWriteData | |
676 | * CyAsUsbReadDataAsync | |
677 | * CyAsUsbWriteDataAsync | |
678 | */ | |
679 | #define CY_AS_ERROR_USB_BAD_DIRECTION (42) | |
680 | ||
681 | /* Summary | |
682 | An invalid request was received | |
683 | ||
684 | Description | |
685 | This error is isused if an invalid request is issued. | |
686 | */ | |
687 | #define CY_AS_ERROR_INVALID_REQUEST (43) | |
688 | ||
689 | /* Summary | |
690 | An ACK request was requested while no setup packet was pending. | |
691 | ||
692 | Description | |
693 | This error is issued if CyAsUsbAckSetupPacket() is called when no | |
694 | setup packet is pending. | |
695 | */ | |
696 | #define CY_AS_ERROR_NO_SETUP_PACKET_PENDING (44) | |
697 | ||
698 | /* Summary | |
699 | A call was made to a API function that cannot be called from a callback. | |
700 | ||
701 | Description | |
702 | Only asynchronous functions can be called from within West Bridge callbacks. | |
703 | This error results when an invalid function is called from a callback. | |
704 | */ | |
705 | #define CY_AS_ERROR_INVALID_IN_CALLBACK (45) | |
706 | ||
707 | /* Summary | |
708 | A call was made to CyAsUsbSetEndPointConfig() before | |
709 | CyAsUsbSetPhysicalConfiguration() was called. | |
710 | ||
711 | Description | |
712 | When logical endpoints are configured, you must define the physical | |
713 | endpoint for the logical endpoint being configured. Therefore | |
714 | CyAsUsbSetPhysicalConfiguration() must be called to define the | |
715 | physical endpoints before calling CyAsUsbSetEndPointConfig(). | |
716 | */ | |
717 | #define CY_AS_ERROR_ENDPOINT_CONFIG_NOT_SET (46) | |
718 | ||
719 | /* Summary | |
720 | The physical endpoint referenced is not valid in the current physical | |
721 | configuration | |
722 | ||
723 | Description | |
724 | When logical endpoints are configured, you must define the physical | |
725 | endpoint for the logical endpoint being configured. Given the | |
726 | current physical configuration, the physical endpoint referenced | |
727 | is not valid. | |
728 | */ | |
729 | #define CY_AS_ERROR_INVALID_PHYSICAL_ENDPOINT (47) | |
730 | ||
731 | /* Summary | |
732 | The data supplied to the CyAsMiscDownloadFirmware() call is not | |
733 | aligned on a WORD (16 bit) boundary. | |
734 | ||
735 | Description | |
736 | Many systems have problems with the transfer of data a word at a | |
737 | time when the data is not word aligned. For this reason, we | |
738 | require that the firmware image be aligned on a word boundary and | |
739 | be an even number of bytes. This error is returned if these | |
740 | conditions are not met. | |
741 | */ | |
742 | #define CY_AS_ERROR_ALIGNMENT_ERROR (48) | |
743 | ||
744 | /* Summary | |
745 | A call was made to destroy the West Bridge device, but the USB | |
746 | stack or the storage stack was will running. | |
747 | ||
748 | Description | |
749 | Before calling CyAsMiscDestroyDevice to destroy an West Bridge | |
750 | device created via a call to CyAsMiscCreateDevice, the USB and | |
751 | STORAGE stacks much be stopped via calls to CyAsUsbStop and | |
752 | CyAsStorageStop. This error indicates that one of these two | |
753 | stacks have not been stopped. | |
754 | */ | |
755 | #define CY_AS_ERROR_STILL_RUNNING (49) | |
756 | ||
757 | /* Summary | |
758 | A call was made to the API for a function that is not yet supported. | |
759 | ||
760 | Description | |
761 | There are calls that are not yet supported that may be called through | |
762 | the API. This is done to maintain compatibility in the future with | |
763 | the API. This error is returned if you are asking for a capability | |
764 | that does not yet exist. | |
765 | */ | |
766 | #define CY_AS_ERROR_NOT_YET_SUPPORTED (50) | |
767 | ||
768 | /* Summary | |
769 | A NULL callback was provided where a non-NULL callback was required | |
770 | ||
771 | Description | |
772 | When async IO function are called, a callback is required to indicate | |
773 | that the IO has completed. This callback must be non-NULL. | |
774 | */ | |
775 | #define CY_AS_ERROR_NULL_CALLBACK (51) | |
776 | ||
777 | /* Summary | |
778 | This error is returned when a request is made to put the West Bridge device | |
779 | into standby mode while the storage stack is still active. | |
780 | ||
781 | Description | |
782 | This error is returned when a request is made to put the West Bridge device | |
783 | into standby mode while the storage stack is still active. You must call the | |
784 | function CyAsStorageStop() in order to shut down the storage stack in order | |
785 | to go into the standby mode. | |
786 | ||
787 | See Also | |
788 | * CyAsMiscEnterStandby | |
789 | */ | |
790 | #define CY_AS_ERROR_STORAGE_RUNNING (52) | |
791 | ||
792 | /* Summary | |
793 | This error is returned when an operation is attempted that cannot be | |
794 | completed while the USB stack is connected to a USB host. | |
795 | ||
796 | Description | |
797 | This error is returned when an operation is attempted that cannot be | |
798 | completed while the USB stack is connected to a USB host. In order | |
799 | to sucessfully complete the desired operation, CyAsUsbDisconnect() | |
800 | must be called to disconnect from the host. | |
801 | */ | |
802 | #define CY_AS_ERROR_USB_CONNECTED (53) | |
803 | ||
804 | /* Summary | |
805 | This error is returned when a USB disconnect is attempted and the | |
806 | West Bridge device is not connected. | |
807 | ||
808 | Description | |
809 | This error is returned when a USB disconnect is attempted and the | |
810 | West Bridge device is not connected. | |
811 | */ | |
812 | #define CY_AS_ERROR_USB_NOT_CONNECTED (54) | |
813 | ||
814 | /* Summary | |
815 | This error is returned when an P2S storage operation attempted | |
816 | and data could not be read or written to the storage media. | |
817 | ||
818 | Description | |
819 | This error is returned when an P2S storage operation attempted | |
820 | and data could not be read or written to the storage media. If | |
821 | this error is recevied then a retry can be done. | |
822 | */ | |
823 | #define CY_AS_ERROR_MEDIA_ACCESS_FAILURE (55) | |
824 | ||
825 | /* Summary | |
826 | This error is returned when an P2S storage operation attempted | |
827 | and the media is write protected. | |
828 | ||
829 | Description | |
830 | This error is returned when an P2S storage operation attempted | |
831 | and the media is write protected. | |
832 | */ | |
833 | #define CY_AS_ERROR_MEDIA_WRITE_PROTECTED (56) | |
834 | ||
835 | /* Summary | |
836 | This error is returned when an attempt is made to cancel a request | |
837 | that has already been sent to the West Bridge. | |
838 | ||
839 | Description | |
840 | It is not possible to cancel an asynchronous storage read/write | |
841 | operation after the actual data transfer with the West Bridge | |
842 | has started. This error is returned if CyAsStorageCancelAsync | |
843 | is called to cancel such a request. | |
844 | */ | |
845 | #define CY_AS_ERROR_OPERATION_IN_TRANSIT (57) | |
846 | ||
847 | /* Summary | |
848 | This error is returned when an invalid parameter is passed to | |
849 | one of the APIs. | |
850 | ||
851 | Description | |
852 | Some of the West Bridge APIs are applicable to only specific | |
853 | media types, devices etc. This error code is returned when a | |
854 | API is called with an invalid parameter type. | |
855 | */ | |
856 | #define CY_AS_ERROR_INVALID_PARAMETER (58) | |
857 | ||
858 | /* Summary | |
859 | This error is returned if an API is not supported in the current setup. | |
860 | ||
861 | Description | |
862 | Some of the West Bridge APIs work only with specific device types | |
863 | or firmware images. This error is returned when such APIs are called | |
864 | when the current device or firmware does not support the invoked API | |
865 | function. | |
866 | */ | |
867 | #define CY_AS_ERROR_NOT_SUPPORTED (59) | |
868 | ||
869 | /* Summary | |
870 | This error is returned when a call is made to one of the Storage or | |
871 | USB APIs while the device is in suspend mode. | |
872 | ||
873 | Description | |
874 | This error is returned when a call is made to one of the storage or | |
875 | USB APIs while the device is in suspend mode. | |
876 | */ | |
877 | #define CY_AS_ERROR_IN_SUSPEND (60) | |
878 | ||
879 | /* Summary | |
880 | This error is returned when the call to CyAsMiscLeaveSuspend | |
881 | is made and the device is not in suspend mode. | |
882 | ||
883 | Description | |
884 | This error is returned when the call to CyAsMiscLeaveSuspend | |
885 | is made and the device is not in suspend mode. | |
886 | */ | |
887 | #define CY_AS_ERROR_NOT_IN_SUSPEND (61) | |
888 | ||
889 | /* Summary | |
890 | This error is returned when a command that is disabled by USB is called. | |
891 | ||
892 | Description | |
893 | The remote wakeup capability should be exercised only if enabled by the | |
894 | USB host. This error is returned when the CyAsUsbSignalRemoteWakeup API | |
895 | is called when the feature has not been enabled by the USB host. | |
896 | */ | |
897 | #define CY_AS_ERROR_FEATURE_NOT_ENABLED (62) | |
898 | ||
899 | /* Summary | |
900 | This error is returned when an Async storage read or write is called before a | |
901 | query device call is issued. | |
902 | ||
903 | Description | |
904 | In order for the SDK to properly set up a DMA the block size of a given media | |
905 | needs to be known. This is done by making a call to CyAsStorageQueryDevice. | |
906 | This call only needs to be made once per device. If this call is not issued | |
907 | before an Async read or write is issued this error code is returned. | |
908 | */ | |
909 | #define CY_AS_ERROR_QUERY_DEVICE_NEEDED (63) | |
910 | ||
911 | /* Summary | |
912 | This error is returned when a call is made to USB or STORAGE Start or | |
913 | Stop before a prior Start or Stop has finished. | |
914 | ||
915 | Description | |
916 | The USB and STORAGE start and stop functions can only be called if a | |
917 | prior start or stop function call has fully completed. This means when | |
918 | an async EX call is made you must wait until the callback for that call | |
919 | has been completed before calling start or stop again. | |
920 | */ | |
921 | #define CY_AS_ERROR_STARTSTOP_PENDING (64) | |
922 | ||
923 | /* Summary | |
924 | This error is returned when a request is made for a bus that does not exist | |
925 | ||
926 | Description | |
927 | This error is returned when a request is made that references a bus | |
928 | number that does not exist. This error is returned when the bus number | |
929 | is not present in the current system, or if the bus number given is not | |
930 | valid. | |
931 | ||
932 | See Also | |
933 | * CyAsMiscSetTraceLevel | |
934 | * CyAsStorageClaim | |
935 | * CyAsStorageRelease | |
936 | * CyAsStorageRead | |
937 | * CyAsStorageWrite | |
938 | * CyAsStorageReadAsync | |
939 | * CyAsStorageWriteAsync | |
940 | */ | |
941 | #define CY_AS_ERROR_NO_SUCH_BUS (65) | |
942 | ||
943 | /* Summary | |
944 | This error is returned when the bus corresponding to a media type cannot | |
945 | be resolved. | |
946 | ||
947 | Description | |
948 | In some S-Port configurations, the same media type may be supported on | |
949 | multiple buses. In this case, it is not possible to resolve the target | |
950 | address based on the media type. This error indicates that only | |
951 | bus-based addressing is supported in a particular run-time | |
952 | configuration. | |
953 | ||
954 | See Also | |
955 | * CyAsMediaType | |
956 | * CyAsBusNumber_t | |
957 | */ | |
958 | #define CY_AS_ERROR_ADDRESS_RESOLUTION_ERROR (66) | |
959 | ||
960 | /* Summary | |
961 | This error is returned when an invalid command is passed to the | |
962 | CyAsStorageSDIOSync() function. | |
963 | ||
964 | Description | |
965 | This error indiactes an unknown Command type was passed to the SDIO | |
966 | command handler function. | |
967 | */ | |
968 | ||
969 | #define CY_AS_ERROR_INVALID_COMMAND (67) | |
970 | ||
971 | ||
972 | /* Summary | |
973 | This error is returned when an invalid function /uninitialized | |
974 | function is passed to an SDIO function. | |
975 | ||
976 | Description | |
977 | This error indiactes an unknown/uninitialized function number was | |
978 | passed to a SDIO function. | |
979 | */ | |
980 | #define CY_AS_ERROR_INVALID_FUNCTION (68) | |
981 | ||
982 | /* Summary | |
983 | This error is returned when an invalid block size is passed to | |
984 | CyAsSdioSetBlocksize(). | |
985 | ||
986 | Description | |
987 | This error is returned when an invalid block size (greater than | |
988 | maximum block size supported) is passed to CyAsSdioSetBlocksize(). | |
989 | */ | |
990 | ||
991 | #define CY_AS_ERROR_INVALID_BLOCKSIZE (69) | |
992 | ||
993 | /* Summary | |
994 | This error is returned when an tuple requested is not found. | |
995 | ||
996 | Description | |
997 | This error is returned when an tuple requested is not found. | |
998 | */ | |
999 | #define CY_AS_ERROR_TUPLE_NOT_FOUND (70) | |
1000 | ||
1001 | /* Summary | |
1002 | This error is returned when an extended IO operation to an SDIO function is | |
1003 | Aborted. | |
1004 | Description | |
1005 | This error is returned when an extended IO operation to an SDIO function is | |
1006 | Aborted. */ | |
1007 | #define CY_AS_ERROR_IO_ABORTED (71) | |
1008 | ||
1009 | /* Summary | |
1010 | This error is returned when an extended IO operation to an SDIO function is | |
1011 | Suspended. | |
1012 | Description | |
1013 | This error is returned when an extended IO operation to an SDIO function is | |
1014 | Suspended. */ | |
1015 | #define CY_AS_ERROR_IO_SUSPENDED (72) | |
1016 | ||
1017 | /* Summary | |
1018 | This error is returned when IO is attempted to a Suspended SDIO function. | |
1019 | Description | |
1020 | This error is returned when IO is attempted to a Suspended SDIO function. */ | |
1021 | #define CY_AS_ERROR_FUNCTION_SUSPENDED (73) | |
1022 | ||
1023 | /* Summary | |
1024 | This error is returned if an MTP function is called before MTPStart | |
1025 | has completed. | |
1026 | Description | |
1027 | This error is returned if an MTP function is called before MTPStart | |
1028 | has completed. | |
1029 | */ | |
1030 | #define CY_AS_ERROR_MTP_NOT_STARTED (74) | |
1031 | ||
1032 | /* Summary | |
1033 | This error is returned by API functions that are not valid in MTP | |
1034 | mode (CyAsStorageClaim for example) | |
1035 | Description | |
1036 | This error is returned by API functions that are not valid in MTP | |
1037 | mode (CyAsStorageClaim for example) | |
1038 | */ | |
1039 | #define CY_AS_ERROR_NOT_VALID_IN_MTP (75) | |
1040 | ||
1041 | /* Summary | |
1042 | This error is returned when an attempt is made to partition a | |
1043 | storage device that is already partitioned. | |
1044 | ||
1045 | Description | |
1046 | This error is returned when an attempt is made to partition a | |
1047 | storage device that is already partitioned. | |
1048 | */ | |
1049 | #define CY_AS_ERROR_ALREADY_PARTITIONED (76) | |
1050 | ||
1051 | /* Summary | |
1052 | This error is returned when a call is made to | |
1053 | CyAsUsbSelectMSPartitions after CyAsUsbSetEnumConfig is called. | |
1054 | ||
1055 | Description | |
1056 | This error is returned when a call is made to | |
1057 | CyAsUsbSelectMSPartitions after CyAsUsbSetEnumConfig is called. | |
1058 | */ | |
1059 | #define CY_AS_ERROR_INVALID_CALL_SEQUENCE (77) | |
1060 | ||
1061 | /* Summary | |
1062 | This error is returned when a StorageWrite opperation is attempted | |
1063 | during an ongoing MTP transfer. | |
1064 | Description | |
1065 | This error is returned when a StorageWrite opperation is attempted | |
1066 | during an ongoing MTP transfer. A MTP transfer is initiated by a | |
1067 | call to CyAsMTPInitSendObject or CyAsMTPInitGetObject and is not | |
1068 | finished until the CyAsMTPSendObjectComplete or | |
1069 | CyAsMTPGetObjectComplete event is generated. | |
1070 | */ | |
1071 | #define CY_AS_ERROR_NOT_VALID_DURING_MTP (78) | |
1072 | ||
1073 | /* Summary | |
1074 | This error is returned when a StorageRead or StorageWrite is | |
1075 | attempted while a UsbRead or UsbWrite on a Turbo endpoint (2 or 6) is | |
1076 | pending, or visa versa. | |
1077 | Description | |
1078 | When there is a pending usb read or write on a turbo endpoint (2 or 6) | |
1079 | a storage read or write call may not be performed. Similarly when there | |
1080 | is a pending storage read or write a usb read or write may not be | |
1081 | performed on a turbo endpoint (2 or 6). | |
1082 | */ | |
1083 | #define CY_AS_ERROR_STORAGE_EP_TURBO_EP_CONFLICT (79) | |
1084 | ||
1085 | /* Summary | |
1086 | This error is returned when processor requests to reserve greater | |
1087 | number of zones than available for proc booting via lna firmware. | |
1088 | ||
1089 | Description | |
1090 | Astoria does not allocate any nand zones for the processor in this case. | |
1091 | */ | |
1092 | #define CY_AS_ERROR_EXCEEDED_NUM_ZONES_AVAIL (80) | |
1093 | ||
1094 | #endif /* _INCLUDED_CYASERR_H_ */ |