/* Cypress West Bridge API header file (cyaserr.h)

 ## ===========================

 ##

 ##  Copyright Cypress Semiconductor Corporation, 2006-2009,

 ##  All Rights Reserved

 ##  UNPUBLISHED, LICENSED SOFTWARE.

 ##

 ##  CONFIDENTIAL AND PROPRIETARY INFORMATION

 ##  WHICH IS THE PROPERTY OF CYPRESS.

 ##

 ##  Use of this file is governed

 ##  by the license agreement included in the file

 ##

 ##     <install>/license/license.txt

 ##

 ##  where <install> is the Cypress software

 ##  installation root directory path.

 ##

 ## ===========================

*/

#ifndef _INCLUDED_CYASERR_H_

#define _INCLUDED_CYASERR_H_

/*@@West Bridge Errors

  Summary

  This section lists the error codes for West Bridge.

*/

/* Summary

   The function completed sucessfully

*/

#define CY_AS_ERROR_SUCCESS                                                     (0)

/* Summary

   A function trying to acquire a resource was unable to do so.

   Description

   This code indicates that a resource that the API was trying to claim

   could not be claimed.

   See Also

   * CyAsMiscAcquireResource

   * CyAsStorageClaim

*/

#define CY_AS_ERROR_NOT_ACQUIRED                                                (1)

/* Summary

   A function trying to acquire a resource was unable to do so.

   Description

   The West Bridge API provides the capability to assign the storage media to

   either the West Bridge device or the USB port.  This error indicates the

   P port was trying to release a storage media and was not able to do 

   so.  This generally means it was not owned by the P port processor.

   See Also

   * CyAsStorageRelease

*/

#define CY_AS_ERROR_NOT_RELEASED                                                (2)

/* Summary

   The West Bridge firmware is not loaded.

   Description

   Most of the API functions that are part of the West Bridge API rely on firmware

   running on the West Bridge device.  This error code is returned when one of

   these functions is called and the firmware has not yet been loaded.

   See Also

   * CyAsMiscGetFirmwareVersion

   * CyAsMiscReset

   * CyAsMiscAcquireResource

   * CyAsMiscReleaseResource

   * CyAsMiscSetTraceLevel

   * CyAsStorageStart

   * CyAsStorageStop

   * CyAsStorageRegisterCallback

   * CyAsStorageClaim

   * CyAsStorageRelease

   * CyAsStorageQueryMedia

   * CyAsStorageQueryDevice

   * CyAsStorageQueryUnit

   * CyAsStorageRead

   * CyAsStorageWrite

   * CyAsStorageReadAsync

   * CyAsStorageWriteAsync

*/

#define CY_AS_ERROR_NO_FIRMWARE                                                 (3)

/* Summary

   A timeout occurred waiting on a response from the West Bridge device

   Description

   When requests are made of the West Bridge device, a response is expected

   within a given timeframe.  If a response is not recevied within the

   given timeframe, a timeout error occurs.

*/

#define CY_AS_ERROR_TIMEOUT                                                     (4)

/* Summary

   A request to download firmware was made while not in the CONFIG mode

   Description

   Firmware is downloaded via the CyAsMiscDownloadFirmware() function.  This

   function can only be called while in the CONFIG mode.  This error indicates

   that the CyAsMiscDownloadFirmware() call was made while not in the CONFIG

   mode.

   See Also

   * CyAsMiscDownloadFirmware

*/

#define CY_AS_ERROR_NOT_IN_CONFIG_MODE                                          (5)

/* Summary

   This error is returned if the firmware size specified is too invalid.

   Description

   If the size of the firmware to be downloaded into West Bridge is invalid, this

   error is issued.  Invalid firmware sizes are those greater than 24K or a

   size of zero.

   See Also

   * CyAsMiscDownloadFirmare

*/

#define CY_AS_ERROR_INVALID_SIZE                                                (6)

/* Summary

   This error is returned if a request is made to acquire a resource that has

   already been acquired.

   Description

   This error is returned if a request is made to acquire a resource that has

   already been acquired.

   See Also

   * CyAsMiscAcquireResource

   * CyAsMiscReleaseResource

*/

#define CY_AS_ERROR_RESOURCE_ALREADY_OWNED                                      (7)

/* Summary

   This error is returned if a request is made to release a resource that has

   not previously been acquired.

   Description 

   This error is returned if a request is made to release a resource that has

   not previously been acquired.

   See Also

   * CyAsMiscAcquireResource

   * CyAsMiscReleaseResource

*/

#define CY_AS_ERROR_RESOURCE_NOT_OWNED                                          (8)

/* Summary

   This error is returned when a request is made for a media that does not exist

   Description

   This error is returned when a request is made that references a storage media that

   does not exist.  This error is returned when the storage media is not present in 

   the current system, or if the media value given is not valid.

   See Also

   * CyAsMiscSetTraceLevel

   * CyAsStorageClaim

   * CyAsStorageRelease

   * CyAsStorageRead

   * CyAsStorageWrite

   * CyAsStorageReadAsync

   * CyAsStorageWriteAsync

*/

#define CY_AS_ERROR_NO_SUCH_MEDIA                                               (9)

/* Summary

   This error is returned when a request is made for a device that does not exist

   Description

   This error is returned when a request is made that references a storage device

   that does not exist.  This error is returned when the device index is not present

   in the current system, or if the device index exceeds 15.

   See Also

   * CyAsMiscSetTraceLevel

   * CyAsStorageQueryDevice

   * CyAsStorageRead

   * CyAsStorageWrite

   * CyAsStorageReadAsync

   * CyAsStorageWriteAsync

*/

#define CY_AS_ERROR_NO_SUCH_DEVICE                                              (10)

/* Summary

   This error is returned when a request is made for a unit that does not exist

   Description

   This error is returned when a request is made that references a storage unit

   that does not exist.  This error is returned when the unit index is not present

   in the current system, or if the unit index exceeds 255.

   See Also

   * CyAsMiscSetTraceLevel

   * CyAsStorageQueryDevice

   * CyAsStorageQueryUnit

   * CyAsStorageRead

   * CyAsStorageWrite

   * CyAsStorageReadAsync

   * CyAsStorageWriteAsync

*/

#define CY_AS_ERROR_NO_SUCH_UNIT                                                (11)

/* Summary

   This error is returned when a request is made for a block that does not exist

   Description

   This error is returned when a request is made that references a storage block

   that does not exist.  This error is returned when the block address reference

   an address beyond the end of the unit selected.

   See Also

   * CyAsStorageRead

   * CyAsStorageWrite

   * CyAsStorageReadAsync

   * CyAsStorageWriteAsync

*/

#define CY_AS_ERROR_INVALID_BLOCK                                               (12)

/* Summary

   This error is returned when an invalid trace level is set.

   Description

   This error is returned when the trace level request is greater

   than three.

   See Also

   * CyAsMiscSetTraceLevel

*/

#define CY_AS_ERROR_INVALID_TRACE_LEVEL                                         (13)

/* Summary

   This error is returned when West Bridge is already in the standby state

   and an attempt is made to put West Bridge into this state again.

   Description

   This error is returned when West Bridge is already in the standby state

   and an attempt is made to put West Bridge into this state again.

   See Also

   * CyAsMiscEnterStandby

*/

#define CY_AS_ERROR_ALREADY_STANDBY                                             (14)

/* Summary

   This error is returned when the API needs to set a pin on the

   West Bridge device, but this is not supported by the underlying HAL

   layer.

   Description

   This error is returned when the API needs to set a pin on the

   West Bridge device, but this is not supported by the underlying HAL

   layer.

   See Also

   * CyAsMiscEnterStandby

   * CyAsMiscLeaveStandby

*/

#define CY_AS_ERROR_SETTING_WAKEUP_PIN						(15)

/* Summary

   This error is returned when a module is being started that has

   already been started.

   Description

   This error is returned when a module is being started and that module

   has already been started.  This error does not occur with the CyAsStorageStart()

   or CyAsUsbStart() functions as the storage and USB modules are reference counted.

   Note

   At the current time, this error is returned by module internal to the API but

   not returned by any of the API functions.

*/

#define CY_AS_ERROR_ALREADY_RUNNING                                             (16)

/* Summary

   This error is returned when a module is being stopped that has

   already been stopped.

   Description

   This error is returned when a module is being stopped and that module

   has already been stopped.  This error does not occur with the CyAsStorageStop()

   or CyAsUsbStop() functions as the storage and USB modules are reference counted.

   Note

   At the current time, this error is returned by module internal to the API but

   not returned by any of the API functions.

*/

#define CY_AS_ERROR_NOT_RUNNING                                                 (17)

/* Summary

   This error is returned when the caller tries to claim a media that has already been

   claimed.

   Description

   This error is returned when the caller tries to claim a media that has already been

   claimed.

   See Also

   * CyAsStorageClaim

*/

#define CY_AS_ERROR_MEDIA_ALREADY_CLAIMED                                       (18)

/* Summary

   This error is returned when the caller tries to release a media that has already been

   released.

   Description

   This error is returned when the caller tries to release a media that has already been

   released.

   See Also

   * CyAsStorageRelease

*/

#define CY_AS_ERROR_MEDIA_NOT_CLAIMED                                           (19)

/* Summary

   This error is returned when canceling trying to cancel an asynchronous operation when

   an async operation is not pending.

   Description

   This error is returned when a call is made to a function to cancel an asynchronous operation

   and there is no asynchronous operation pending.

   See Also

   * CyAsStorageCancelAsync

   * CyAsUsbCancelAsync

*/

#define CY_AS_ERROR_NO_OPERATION_PENDING                                        (20)

/* Summary

   This error is returned when an invalid endpoint number is provided to an API call.

   Description

   This error is returned when an invalid endpoint number is specified in an API call.  The

   endpoint number may be invalid because it is greater than 15, or because it was a reference

   to an endpoint that is invalid for West Bridge (2, 4, 6, or 8).

   See Also

   * CyAsUsbSetEndPointConfig

   * CyAsUsbGetEndPointConfig

   * CyAsUsbReadData

   * CyAsUsbWriteData

   * CyAsUsbReadDataAsync

   * CyAsUsbWriteDataAsync

   * CyAsUsbSetStall

   * CyAsUsbGetStall

*/

#define CY_AS_ERROR_INVALID_ENDPOINT                                            (21)

/* Summary

   This error is returned when an invalid descriptor type 

   is specified in an API call.

   Description

   This error is returned when an invalid descriptor type 

   is specified in an API call.

   See Also

   * CyAsUsbSetDescriptor

   * CyAsUsbGetDescriptor

*/

#define CY_AS_ERROR_INVALID_DESCRIPTOR                                          (22)

/* Summary

   This error is returned when an invalid descriptor index 

   is specified in an API call.

   Description

   This error is returned when an invalid descriptor index 

   is specified in an API call.

   See Also

   * CyAsUsbSetDescriptor

   * CyAsUsbGetDescriptor

*/

#define CY_AS_ERROR_BAD_INDEX                                                   (23)

/* Summary

   This error is returned if trying to set a USB descriptor

   when in the P port enumeration mode.

   Description

   This error is returned if trying to set a USB descriptor

   when in the P port enumeration mode.

   See Also

   * CyAsUsbSetDescriptor

   * CyAsUsbGetDescriptor

*/

#define CY_AS_ERROR_BAD_ENUMERATION_MODE                                        (24)

/* Summary

   This error is returned when the endpoint configuration specified

   is not valid.

   Description

   This error is returned when the endpoint configuration specified

   is not valid.

   See Also

   * CyAsUsbSetDescriptor

   * CyAsUsbGetDescriptor

   * CyAsUsbCommitConfig

*/

#define CY_AS_ERROR_INVALID_CONFIGURATION                                       (25)

/* Summary

   This error is returned when the API cannot verify it is connected

   to an West Bridge device.

   Description

   When the API is initialized, the API tries to read the ID register from

   the West Bridge device.  The value from this ID register should match the

   value expected before communications with West Bridge are established.  This

   error means that the contents of the ID register cannot be verified.

   See Also

   * CyAsMiscConfigureDevice

*/

#define CY_AS_ERROR_NO_ANTIOCH                                                  (26)

/* Summary

   This error is returned when an API function is called and CyAsMiscConfigureDevice

   has not been called to configure West Bridge for the current environment.

   Description

   This error is returned when an API function is called and CyAsMiscConfigureDevice

   has not been called to configure West Bridge for the current environment.

   See Also

   * Almost all API function

*/

#define CY_AS_ERROR_NOT_CONFIGURED                                              (27)

/* Summary

   This error is returned when West Bridge cannot allocate memory required for

   internal API operations.

   Description

   This error is returned when West Bridge cannot allocate memory required for

   internal API operations.

   See Also

   * Almost all API functoins

*/

#define CY_AS_ERROR_OUT_OF_MEMORY                                               (28)

/* Summary

   This error is returned when a module is being started that has

   already been started.

   Description

   This error is returned when a module is being started and that module

   has already been started.  This error does not occur with the CyAsStorageStart()

   or CyAsUsbStart() functions as the storage and USB modules are reference counted.

   Note

   At the current time, this error is returned by module internal to the API but

   not returned by any of the API functions.

*/

#define CY_AS_ERROR_NESTED_SLEEP                                                (29)

/* Summary

   This error is returned when an operation is attempted on an endpoint that has

   been disabled.

   Description

   This error is returned when an operation is attempted on an endpoint that has

   been disabled.

   See Also

   * CyAsUsbReadData

   * CyAsUsbWriteData

   * CyAsUsbReadDataAsync

   * CyAsUsbWriteDataAsync

*/

#define CY_AS_ERROR_ENDPOINT_DISABLED                                           (30)

/* Summary

   This error is returned when a call is made to an API function when the device is in

   standby.

   Description

   When the West Bridge device is in standby, the only two API functions that can be called

   are CyAsMiscInStandby() and CyAsMiscLeaveStandby().  Calling any other API function

   will result in this error.

   See Also

*/

#define CY_AS_ERROR_IN_STANDBY                                                  (31)

/* Summary

   This error is returned when an API call is made with an invalid handle value.

   Description

   This error is returned when an API call is made with an invalid handle value.

   See Also

*/

#define CY_AS_ERROR_INVALID_HANDLE                                              (32)

/* Summary

   This error is returned when an invalid response is returned from the West Bridge device.

   Description

   Many of the API calls result in requests made to the West Bridge device.  This error occurs

   when the response from West Bridge is invalid and generally indicates that the West Bridge device

   should be reset.

   See Also

*/

#define CY_AS_ERROR_INVALID_RESPONSE                                            (33)

/* Summary

   This error is returned from the callback function for any asynchronous read or write

   request that is canceled.