add comments to function declarations and definitions and updated to match coding...

[mirror_edk2.git] / ShellPkg / Include / ShellBase.h

/** @file\r
  Root include file for Shell Package modules that utilize the SHELL_RETURN type\r
\r
  Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _SHELL_BASE_\r
#define _SHELL_BASE_\r
\r
#define ABS(a) ((a<0)?(-(a)):(a))\r
\r
typedef VOID *SHELL_FILE_HANDLE;\r
\r
#define SHELL_FREE_NON_NULL(Pointer)  \\r
  do {                                \\r
    if ((Pointer) != NULL) {          \\r
      FreePool((Pointer));            \\r
      (Pointer) = NULL;               \\r
    }                                 \\r
  } while(FALSE)\r
\r
typedef enum {\r
///\r
/// The operation completed successfully.\r
///\r
SHELL_SUCCESS               = 0,\r
\r
///\r
/// The image failed to load.\r
///\r
SHELL_LOAD_ERROR            = 1,\r
\r
///\r
/// The parameter was incorrect.\r
///\r
SHELL_INVALID_PARAMETER     = 2,\r
\r
///\r
/// The operation is not supported.\r
///\r
SHELL_UNSUPPORTED           = 3,\r
\r
///\r
/// The buffer was not the proper size for the request.\r
///\r
SHELL_BAD_BUFFER_SIZE       = 4,\r
\r
///\r
/// The buffer was not large enough to hold the requested data.\r
/// The required buffer size is returned in the appropriate\r
/// parameter when this error occurs.\r
///\r
SHELL_BUFFER_TOO_SMALL      = 5,\r
\r
///\r
/// There is no data pending upon return.\r
///\r
SHELL_NOT_READY             = 6,\r
\r
///\r
/// The physical device reported an error while attempting the\r
/// operation.\r
///\r
SHELL_DEVICE_ERROR          = 7,\r
\r
///\r
/// The device cannot be written to.\r
///\r
SHELL_WRITE_PROTECTED       = 8,\r
\r
///\r
/// The resource has run out.\r
///\r
SHELL_OUT_OF_RESOURCES      = 9,\r
\r
///\r
/// An inconsistency was detected on the file system causing the\r
/// operation to fail.\r
///\r
SHELL_VOLUME_CORRUPTED      = 10,\r
\r
///\r
/// There is no more space on the file system.\r
///\r
SHELL_VOLUME_FULL           = 11,\r
\r
///\r
/// The device does not contain any medium to perform the\r
/// operation.\r
///\r
SHELL_NO_MEDIA              = 12,\r
\r
///\r
/// The medium in the device has changed since the last\r
/// access.\r
///\r
SHELL_MEDIA_CHANGED         = 13,\r
\r
///\r
/// The item was not found.\r
///\r
SHELL_NOT_FOUND             = 14,\r
\r
///\r
/// Access was denied.\r
///\r
SHELL_ACCESS_DENIED         = 15,\r
\r
// note the skipping of 16 and 17\r
\r
///\r
/// A timeout time expired.\r
///\r
SHELL_TIMEOUT               = 18,\r
\r
///\r
/// The protocol has not been started.\r
///\r
SHELL_NOT_STARTED           = 19,\r
\r
///\r
/// The protocol has already been started.\r
///\r
SHELL_ALREADY_STARTED       = 20,\r
\r
///\r
/// The operation was aborted.\r
///\r
SHELL_ABORTED               = 21,\r
\r
// note the skipping of 22, 23, and 24\r
\r
///\r
/// A function encountered an internal version that was\r
/// incompatible with a version requested by the caller.\r
///\r
SHELL_INCOMPATIBLE_VERSION  = 25,\r
\r
///\r
/// The function was not performed due to a security violation.\r
///\r
SHELL_SECURITY_VIOLATION    = 26,\r
\r
///\r
/// The function was performed and resulted in an unequal\r
/// comparison..\r
///\r
SHELL_NOT_EQUAL             = 27\r
}SHELL_STATUS;\r
\r
#endif //__SHELL_BASE__