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