MdePkg: Change OPTIONAL keyword usage style

[mirror_edk2.git] / MdePkg / Library / UefiDevicePathLib / UefiDevicePathLib.h

/** @file\r
  Definition for Device Path library.\r
\r
Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _UEFI_DEVICE_PATH_LIB_H_\r
#define _UEFI_DEVICE_PATH_LIB_H_\r
#include <Uefi.h>\r
#include <Protocol/DevicePathUtilities.h>\r
#include <Protocol/DebugPort.h>\r
#include <Protocol/DevicePathToText.h>\r
#include <Protocol/DevicePathFromText.h>\r
#include <Guid/PcAnsi.h>\r
#include <Library/DebugLib.h>\r
#include <Library/PrintLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DevicePathLib.h>\r
#include <Library/PcdLib.h>\r
#include <IndustryStandard/Bluetooth.h>\r
\r
#define IS_COMMA(a)                ((a) == L',')\r
#define IS_HYPHEN(a)               ((a) == L'-')\r
#define IS_DOT(a)                  ((a) == L'.')\r
#define IS_LEFT_PARENTH(a)         ((a) == L'(')\r
#define IS_RIGHT_PARENTH(a)        ((a) == L')')\r
#define IS_SLASH(a)                ((a) == L'/')\r
#define IS_NULL(a)                 ((a) == L'\0')\r
\r
\r
//\r
// Private Data structure\r
//\r
typedef struct {\r
  CHAR16  *Str;\r
  UINTN   Count;\r
  UINTN   Capacity;\r
} POOL_PRINT;\r
\r
typedef\r
EFI_DEVICE_PATH_PROTOCOL  *\r
(*DEVICE_PATH_FROM_TEXT) (\r
  IN  CHAR16 *Str\r
  );\r
\r
typedef\r
VOID\r
(*DEVICE_PATH_TO_TEXT) (\r
  IN OUT POOL_PRINT  *Str,\r
  IN VOID            *DevicePath,\r
  IN BOOLEAN         DisplayOnly,\r
  IN BOOLEAN         AllowShortcuts\r
  );\r
\r
typedef struct {\r
  UINT8                Type;\r
  UINT8                SubType;\r
  DEVICE_PATH_TO_TEXT  Function;\r
} DEVICE_PATH_TO_TEXT_TABLE;\r
\r
typedef struct {\r
  UINT8                Type;\r
  CHAR16               *Text;\r
} DEVICE_PATH_TO_TEXT_GENERIC_TABLE;\r
\r
typedef struct {\r
  CHAR16                    *DevicePathNodeText;\r
  DEVICE_PATH_FROM_TEXT     Function;\r
} DEVICE_PATH_FROM_TEXT_TABLE;\r
\r
typedef struct {\r
  BOOLEAN ClassExist;\r
  UINT8   Class;\r
  BOOLEAN SubClassExist;\r
  UINT8   SubClass;\r
} USB_CLASS_TEXT;\r
\r
#define USB_CLASS_AUDIO            1\r
#define USB_CLASS_CDCCONTROL       2\r
#define USB_CLASS_HID              3\r
#define USB_CLASS_IMAGE            6\r
#define USB_CLASS_PRINTER          7\r
#define USB_CLASS_MASS_STORAGE     8\r
#define USB_CLASS_HUB              9\r
#define USB_CLASS_CDCDATA          10\r
#define USB_CLASS_SMART_CARD       11\r
#define USB_CLASS_VIDEO            14\r
#define USB_CLASS_DIAGNOSTIC       220\r
#define USB_CLASS_WIRELESS         224\r
\r
#define USB_CLASS_RESERVE          254\r
#define USB_SUBCLASS_FW_UPDATE     1\r
#define USB_SUBCLASS_IRDA_BRIDGE   2\r
#define USB_SUBCLASS_TEST          3\r
\r
#define RFC_1700_UDP_PROTOCOL      17\r
#define RFC_1700_TCP_PROTOCOL      6\r
\r
#pragma pack(1)\r
\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL  Header;\r
  EFI_GUID                  Guid;\r
  UINT8                     VendorDefinedData[1];\r
} VENDOR_DEFINED_HARDWARE_DEVICE_PATH;\r
\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL  Header;\r
  EFI_GUID                  Guid;\r
  UINT8                     VendorDefinedData[1];\r
} VENDOR_DEFINED_MESSAGING_DEVICE_PATH;\r
\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL  Header;\r
  EFI_GUID                  Guid;\r
  UINT8                     VendorDefinedData[1];\r
} VENDOR_DEFINED_MEDIA_DEVICE_PATH;\r
\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL  Header;\r
  UINT32                    Hid;\r
  UINT32                    Uid;\r
  UINT32                    Cid;\r
  CHAR8                     HidUidCidStr[3];\r
} ACPI_EXTENDED_HID_DEVICE_PATH_WITH_STR;\r
\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL  Header;\r
  UINT16                    NetworkProtocol;\r
  UINT16                    LoginOption;\r
  UINT64                    Lun;\r
  UINT16                    TargetPortalGroupTag;\r
  CHAR8                     TargetName[1];\r
} ISCSI_DEVICE_PATH_WITH_NAME;\r
\r
typedef struct {\r
  EFI_DEVICE_PATH_PROTOCOL  Header;\r
  EFI_GUID                  Guid;\r
  UINT8                     VendorDefinedData[1];\r
} VENDOR_DEVICE_PATH_WITH_DATA;\r
\r
#pragma pack()\r
\r
/**\r
  Returns the size of a device path in bytes.\r
\r
  This function returns the size, in bytes, of the device path data structure\r
  specified by DevicePath including the end of device path node.\r
  If DevicePath is NULL or invalid, then 0 is returned.\r
\r
  @param  DevicePath  A pointer to a device path data structure.\r
\r
  @retval 0           If DevicePath is NULL or invalid.\r
  @retval Others      The size of a device path in bytes.\r
\r
**/\r
UINTN\r
EFIAPI\r
UefiDevicePathLibGetDevicePathSize (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath\r
  );\r
\r
/**\r
  Creates a new copy of an existing device path.\r
\r
  This function allocates space for a new copy of the device path specified by DevicePath.\r
  If DevicePath is NULL, then NULL is returned.  If the memory is successfully\r
  allocated, then the contents of DevicePath are copied to the newly allocated\r
  buffer, and a pointer to that buffer is returned.  Otherwise, NULL is returned.\r
  The memory for the new device path is allocated from EFI boot services memory.\r
  It is the responsibility of the caller to free the memory allocated.\r
\r
  @param  DevicePath    A pointer to a device path data structure.\r
\r
  @retval NULL          DevicePath is NULL or invalid.\r
  @retval Others        A pointer to the duplicated device path.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
UefiDevicePathLibDuplicateDevicePath (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath\r
  );\r
\r
/**\r
  Creates a new device path by appending a second device path to a first device path.\r
\r
  This function creates a new device path by appending a copy of SecondDevicePath\r
  to a copy of FirstDevicePath in a newly allocated buffer.  Only the end-of-device-path\r
  device node from SecondDevicePath is retained. The newly created device path is\r
  returned. If FirstDevicePath is NULL, then it is ignored, and a duplicate of\r
  SecondDevicePath is returned.  If SecondDevicePath is NULL, then it is ignored,\r
  and a duplicate of FirstDevicePath is returned. If both FirstDevicePath and\r
  SecondDevicePath are NULL, then a copy of an end-of-device-path is returned.\r
\r
  If there is not enough memory for the newly allocated buffer, then NULL is returned.\r
  The memory for the new device path is allocated from EFI boot services memory.\r
  It is the responsibility of the caller to free the memory allocated.\r
\r
  @param  FirstDevicePath            A pointer to a device path data structure.\r
  @param  SecondDevicePath           A pointer to a device path data structure.\r
\r
  @retval NULL      If there is not enough memory for the newly allocated buffer.\r
  @retval NULL      If FirstDevicePath or SecondDevicePath is invalid.\r
  @retval Others    A pointer to the new device path if success.\r
                    Or a copy an end-of-device-path if both FirstDevicePath and SecondDevicePath are NULL.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
UefiDevicePathLibAppendDevicePath (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *FirstDevicePath   OPTIONAL,\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *SecondDevicePath  OPTIONAL\r
  );\r
\r
/**\r
  Creates a new path by appending the device node to the device path.\r
\r
  This function creates a new device path by appending a copy of the device node\r
  specified by DevicePathNode to a copy of the device path specified by DevicePath\r
  in an allocated buffer. The end-of-device-path device node is moved after the\r
  end of the appended device node.\r
  If DevicePathNode is NULL then a copy of DevicePath is returned.\r
  If DevicePath is NULL then a copy of DevicePathNode, followed by an end-of-device\r
  path device node is returned.\r
  If both DevicePathNode and DevicePath are NULL then a copy of an end-of-device-path\r
  device node is returned.\r
  If there is not enough memory to allocate space for the new device path, then\r
  NULL is returned.\r
  The memory is allocated from EFI boot services memory. It is the responsibility\r
  of the caller to free the memory allocated.\r
\r
  @param  DevicePath                 A pointer to a device path data structure.\r
  @param  DevicePathNode             A pointer to a single device path node.\r
\r
  @retval NULL      If there is not enough memory for the new device path.\r
  @retval Others    A pointer to the new device path if success.\r
                    A copy of DevicePathNode followed by an end-of-device-path node\r
                    if both FirstDevicePath and SecondDevicePath are NULL.\r
                    A copy of an end-of-device-path node if both FirstDevicePath\r
                    and SecondDevicePath are NULL.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
UefiDevicePathLibAppendDevicePathNode (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath      OPTIONAL,\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePathNode  OPTIONAL\r
  );\r
\r
/**\r
  Creates a new device path by appending the specified device path instance to the specified device\r
  path.\r
\r
  This function creates a new device path by appending a copy of the device path\r
  instance specified by DevicePathInstance to a copy of the device path specified\r
  by DevicePath in a allocated buffer.\r
  The end-of-device-path device node is moved after the end of the appended device\r
  path instance and a new end-of-device-path-instance node is inserted between.\r
  If DevicePath is NULL, then a copy if DevicePathInstance is returned.\r
  If DevicePathInstance is NULL, then NULL is returned.\r
  If DevicePath or DevicePathInstance is invalid, then NULL is returned.\r
  If there is not enough memory to allocate space for the new device path, then\r
  NULL is returned.\r
  The memory is allocated from EFI boot services memory. It is the responsibility\r
  of the caller to free the memory allocated.\r
\r
  @param  DevicePath                 A pointer to a device path data structure.\r
  @param  DevicePathInstance         A pointer to a device path instance.\r
\r
  @return A pointer to the new device path.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
UefiDevicePathLibAppendDevicePathInstance (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath         OPTIONAL,\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePathInstance OPTIONAL\r
  );\r
\r
/**\r
  Creates a copy of the current device path instance and returns a pointer to the next device path\r
  instance.\r
\r
  This function creates a copy of the current device path instance. It also updates\r
  DevicePath to point to the next device path instance in the device path (or NULL\r
  if no more) and updates Size to hold the size of the device path instance copy.\r
  If DevicePath is NULL, then NULL is returned.\r
  If DevicePath points to a invalid device path, then NULL is returned.\r
  If there is not enough memory to allocate space for the new device path, then\r
  NULL is returned.\r
  The memory is allocated from EFI boot services memory. It is the responsibility\r
  of the caller to free the memory allocated.\r
  If Size is NULL, then ASSERT().\r
\r
  @param  DevicePath                 On input, this holds the pointer to the current\r
                                     device path instance. On output, this holds\r
                                     the pointer to the next device path instance\r
                                     or NULL if there are no more device path\r
                                     instances in the device path pointer to a\r
                                     device path data structure.\r
  @param  Size                       On output, this holds the size of the device\r
                                     path instance, in bytes or zero, if DevicePath\r
                                     is NULL.\r
\r
  @return A pointer to the current device path instance.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
UefiDevicePathLibGetNextDevicePathInstance (\r
  IN OUT EFI_DEVICE_PATH_PROTOCOL    **DevicePath,\r
  OUT UINTN                          *Size\r
  );\r
\r
/**\r
  Creates a device node.\r
\r
  This function creates a new device node in a newly allocated buffer of size\r
  NodeLength and initializes the device path node header with NodeType and NodeSubType.\r
  The new device path node is returned.\r
  If NodeLength is smaller than a device path header, then NULL is returned.\r
  If there is not enough memory to allocate space for the new device path, then\r
  NULL is returned.\r
  The memory is allocated from EFI boot services memory. It is the responsibility\r
  of the caller to free the memory allocated.\r
\r
  @param  NodeType                   The device node type for the new device node.\r
  @param  NodeSubType                The device node sub-type for the new device node.\r
  @param  NodeLength                 The length of the new device node.\r
\r
  @return The new device path.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
UefiDevicePathLibCreateDeviceNode (\r
  IN UINT8                           NodeType,\r
  IN UINT8                           NodeSubType,\r
  IN UINT16                          NodeLength\r
  );\r
\r
/**\r
  Determines if a device path is single or multi-instance.\r
\r
  This function returns TRUE if the device path specified by DevicePath is\r
  multi-instance.\r
  Otherwise, FALSE is returned.\r
  If DevicePath is NULL or invalid, then FALSE is returned.\r
\r
  @param  DevicePath                 A pointer to a device path data structure.\r
\r
  @retval  TRUE                      DevicePath is multi-instance.\r
  @retval  FALSE                     DevicePath is not multi-instance, or DevicePath\r
                                     is NULL or invalid.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
UefiDevicePathLibIsDevicePathMultiInstance (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DevicePath\r
  );\r
\r
\r
/**\r
  Converts a device path to its text representation.\r
\r
  @param DevicePath      A Pointer to the device to be converted.\r
  @param DisplayOnly     If DisplayOnly is TRUE, then the shorter text representation\r
                         of the display node is used, where applicable. If DisplayOnly\r
                         is FALSE, then the longer text representation of the display node\r
                         is used.\r
  @param AllowShortcuts  If AllowShortcuts is TRUE, then the shortcut forms of text\r
                         representation for a device node can be used, where applicable.\r
\r
  @return A pointer to the allocated text representation of the device path or\r
          NULL if DeviceNode is NULL or there was insufficient memory.\r
\r
**/\r
CHAR16 *\r
EFIAPI\r
UefiDevicePathLibConvertDevicePathToText (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL   *DevicePath,\r
  IN BOOLEAN                          DisplayOnly,\r
  IN BOOLEAN                          AllowShortcuts\r
  );\r
\r
/**\r
  Converts a device node to its string representation.\r
\r
  @param DeviceNode        A Pointer to the device node to be converted.\r
  @param DisplayOnly       If DisplayOnly is TRUE, then the shorter text representation\r
                           of the display node is used, where applicable. If DisplayOnly\r
                           is FALSE, then the longer text representation of the display node\r
                           is used.\r
  @param AllowShortcuts    If AllowShortcuts is TRUE, then the shortcut forms of text\r
                           representation for a device node can be used, where applicable.\r
\r
  @return A pointer to the allocated text representation of the device node or NULL if DeviceNode\r
          is NULL or there was insufficient memory.\r
\r
**/\r
CHAR16 *\r
EFIAPI\r
UefiDevicePathLibConvertDeviceNodeToText (\r
  IN CONST EFI_DEVICE_PATH_PROTOCOL  *DeviceNode,\r
  IN BOOLEAN                         DisplayOnly,\r
  IN BOOLEAN                         AllowShortcuts\r
  );\r
\r
/**\r
  Convert text to the binary representation of a device node.\r
\r
  @param TextDeviceNode  TextDeviceNode points to the text representation of a device\r
                         node. Conversion starts with the first character and continues\r
                         until the first non-device node character.\r
\r
  @return A pointer to the EFI device node or NULL if TextDeviceNode is NULL or there was\r
          insufficient memory or text unsupported.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
UefiDevicePathLibConvertTextToDeviceNode (\r
  IN CONST CHAR16 *TextDeviceNode\r
  );\r
\r
/**\r
  Convert text to the binary representation of a device path.\r
\r
\r
  @param TextDevicePath  TextDevicePath points to the text representation of a device\r
                         path. Conversion starts with the first character and continues\r
                         until the first non-device node character.\r
\r
  @return A pointer to the allocated device path or NULL if TextDeviceNode is NULL or\r
          there was insufficient memory.\r
\r
**/\r
EFI_DEVICE_PATH_PROTOCOL *\r
EFIAPI\r
UefiDevicePathLibConvertTextToDevicePath (\r
  IN CONST CHAR16 *TextDevicePath\r
  );\r
\r
#endif\r