]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/Kms.h
MdePkg: Clean up source files
[mirror_edk2.git] / MdePkg / Include / Protocol / Kms.h
index 1d2dcc64f8ed75136c72b04ee0490b0db65288b4..57b006e10d4a51d79f302d762b224b75e7189e0c 100644 (file)
@@ -8,7 +8,7 @@
   server over the network, or to a Hardware Security Module (HSM) attached to the system it\r
   runs on, or anything else that is capable of providing the key management service.\r
 \r
-  Copyright (c) 2011 - 2017, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2011 - 2018, Intel Corporation. All rights reserved.<BR>\r
   This program and the accompanying materials are licensed and made available under\r
   the terms and conditions of the BSD License that accompanies this distribution.\r
   The full text of the license may be found at\r
@@ -373,7 +373,7 @@ EFI_STATUS
 \r
   @param[in]      This              Pointer to the EFI_KMS_PROTOCOL instance.\r
   @param[in]      Client            Pointer to a valid EFI_KMS_CLIENT_INFO structure.\r
-  @param[in, out] ClientDataSize    Pointer to the size, in bytes, of an arbitrary block of \r
+  @param[in, out] ClientDataSize    Pointer to the size, in bytes, of an arbitrary block of\r
                                     data specified by the ClientData parameter. This\r
                                     parameter may be NULL, in which case the ClientData\r
                                     parameter will be ignored and no data will be\r
@@ -388,11 +388,11 @@ EFI_STATUS
                                     which will be zero if no data is returned from the KMS.\r
   @param[in, out] ClientData        Pointer to a pointer to an arbitrary block of data of\r
                                     *ClientDataSize that is to be passed directly to the\r
-                                    KMS if it supports the use of client data. This \r
-                                    parameter may be NULL if and only if the \r
+                                    KMS if it supports the use of client data. This\r
+                                    parameter may be NULL if and only if the\r
                                     ClientDataSize parameter is also NULL. Upon return to\r
-                                    the caller, *ClientData points to a block of data of \r
-                                    *ClientDataSize that was returned from the KMS. \r
+                                    the caller, *ClientData points to a block of data of\r
+                                    *ClientDataSize that was returned from the KMS.\r
                                     If the returned value for *ClientDataSize is zero,\r
                                     then the returned value for *ClientData must be NULL\r
                                     and should be ignored by the caller. The KMS protocol\r
@@ -418,7 +418,7 @@ EFI_STATUS
   IN EFI_KMS_CLIENT_INFO        *Client,\r
   IN OUT UINTN                  *ClientDataSize OPTIONAL,\r
   IN OUT VOID                   **ClientData OPTIONAL\r
-  ); \r
+  );\r
 \r
 /**\r
   Request that the KMS generate one or more new keys and associate them with key identifiers.\r
@@ -454,7 +454,7 @@ EFI_STATUS
                                      type and must be freed by the caller when it is no longer\r
                                      needed. Also, the KeyStatus field must reflect the result\r
                                      of the request relative to that key.\r
-  @param[in, out] ClientDataSize     Pointer to the size, in bytes, of an arbitrary block of \r
+  @param[in, out] ClientDataSize     Pointer to the size, in bytes, of an arbitrary block of\r
                                      data specified by the ClientData parameter. This\r
                                      parameter may be NULL, in which case the ClientData\r
                                      parameter will be ignored and no data will be\r
@@ -469,11 +469,11 @@ EFI_STATUS
                                      which will be zero if no data is returned from the KMS.\r
   @param[in, out] ClientData         Pointer to a pointer to an arbitrary block of data of\r
                                      *ClientDataSize that is to be passed directly to the\r
-                                     KMS if it supports the use of client data. This \r
-                                     parameter may be NULL if and only if the \r
+                                     KMS if it supports the use of client data. This\r
+                                     parameter may be NULL if and only if the\r
                                      ClientDataSize parameter is also NULL. Upon return to\r
-                                     the caller, *ClientData points to a block of data of \r
-                                     *ClientDataSize that was returned from the KMS. \r
+                                     the caller, *ClientData points to a block of data of\r
+                                     *ClientDataSize that was returned from the KMS.\r
                                      If the returned value for *ClientDataSize is zero,\r
                                      then the returned value for *ClientData must be NULL\r
                                      and should be ignored by the caller. The KMS protocol\r
@@ -535,12 +535,12 @@ EFI_STATUS
                                      On output, the KeyIdentifierSize and KeyIdentifier fields\r
                                      will be unchanged, while the KeyFormat and KeyValue\r
                                      fields will be updated values associated with this key\r
-                                     identifier. Memory for the KeyValue field will be \r
+                                     identifier. Memory for the KeyValue field will be\r
                                      allocated with the BOOT_SERVICES_DATA type and\r
                                      must be freed by the caller when it is no longer needed.\r
                                      Also, the KeyStatus field will reflect the result of the\r
                                      request relative to the individual key descriptor.\r
-  @param[in, out] ClientDataSize     Pointer to the size, in bytes, of an arbitrary block of \r
+  @param[in, out] ClientDataSize     Pointer to the size, in bytes, of an arbitrary block of\r
                                      data specified by the ClientData parameter. This\r
                                      parameter may be NULL, in which case the ClientData\r
                                      parameter will be ignored and no data will be\r
@@ -555,11 +555,11 @@ EFI_STATUS
                                      which will be zero if no data is returned from the KMS.\r
   @param[in, out] ClientData         Pointer to a pointer to an arbitrary block of data of\r
                                      *ClientDataSize that is to be passed directly to the\r
-                                     KMS if it supports the use of client data. This \r
-                                     parameter may be NULL if and only if the \r
+                                     KMS if it supports the use of client data. This\r
+                                     parameter may be NULL if and only if the\r
                                      ClientDataSize parameter is also NULL. Upon return to\r
-                                     the caller, *ClientData points to a block of data of \r
-                                     *ClientDataSize that was returned from the KMS. \r
+                                     the caller, *ClientData points to a block of data of\r
+                                     *ClientDataSize that was returned from the KMS.\r
                                      If the returned value for *ClientDataSize is zero,\r
                                      then the returned value for *ClientData must be NULL\r
                                      and should be ignored by the caller. The KMS protocol\r
@@ -626,7 +626,7 @@ EFI_STATUS
                                      consistent values to be associated with the given KeyId.\r
                                      On return, the KeyStatus field will reflect the result\r
                                      of the operation for each key request.\r
-  @param[in, out] ClientDataSize     Pointer to the size, in bytes, of an arbitrary block of \r
+  @param[in, out] ClientDataSize     Pointer to the size, in bytes, of an arbitrary block of\r
                                      data specified by the ClientData parameter. This\r
                                      parameter may be NULL, in which case the ClientData\r
                                      parameter will be ignored and no data will be\r
@@ -641,11 +641,11 @@ EFI_STATUS
                                      which will be zero if no data is returned from the KMS.\r
   @param[in, out] ClientData         Pointer to a pointer to an arbitrary block of data of\r
                                      *ClientDataSize that is to be passed directly to the\r
-                                     KMS if it supports the use of client data. This \r
-                                     parameter may be NULL if and only if the \r
+                                     KMS if it supports the use of client data. This\r
+                                     parameter may be NULL if and only if the\r
                                      ClientDataSize parameter is also NULL. Upon return to\r
-                                     the caller, *ClientData points to a block of data of \r
-                                     *ClientDataSize that was returned from the KMS. \r
+                                     the caller, *ClientData points to a block of data of\r
+                                     *ClientDataSize that was returned from the KMS.\r
                                      If the returned value for *ClientDataSize is zero,\r
                                      then the returned value for *ClientData must be NULL\r
                                      and should be ignored by the caller. The KMS protocol\r
@@ -711,7 +711,7 @@ EFI_STATUS
                                      KeyValue fields are ignored, but should be 0.\r
                                      On return, the KeyStatus field will reflect the result\r
                                      of the operation for each key request.\r
-  @param[in, out] ClientDataSize     Pointer to the size, in bytes, of an arbitrary block of \r
+  @param[in, out] ClientDataSize     Pointer to the size, in bytes, of an arbitrary block of\r
                                      data specified by the ClientData parameter. This\r
                                      parameter may be NULL, in which case the ClientData\r
                                      parameter will be ignored and no data will be\r
@@ -726,11 +726,11 @@ EFI_STATUS
                                      which will be zero if no data is returned from the KMS.\r
   @param[in, out] ClientData         Pointer to a pointer to an arbitrary block of data of\r
                                      *ClientDataSize that is to be passed directly to the\r
-                                     KMS if it supports the use of client data. This \r
-                                     parameter may be NULL if and only if the \r
+                                     KMS if it supports the use of client data. This\r
+                                     parameter may be NULL if and only if the\r
                                      ClientDataSize parameter is also NULL. Upon return to\r
-                                     the caller, *ClientData points to a block of data of \r
-                                     *ClientDataSize that was returned from the KMS. \r
+                                     the caller, *ClientData points to a block of data of\r
+                                     *ClientDataSize that was returned from the KMS.\r
                                      If the returned value for *ClientDataSize is zero,\r
                                      then the returned value for *ClientData must be NULL\r
                                      and should be ignored by the caller. The KMS protocol\r
@@ -789,7 +789,7 @@ EFI_STATUS
                                      On input, the fields in the structure should be NULL.\r
                                      On output, the attribute fields will have updated values\r
                                      for attributes associated with this key identifier.\r
-  @param[in, out] ClientDataSize     Pointer to the size, in bytes, of an arbitrary block of \r
+  @param[in, out] ClientDataSize     Pointer to the size, in bytes, of an arbitrary block of\r
                                      data specified by the ClientData parameter. This\r
                                      parameter may be NULL, in which case the ClientData\r
                                      parameter will be ignored and no data will be\r
@@ -804,11 +804,11 @@ EFI_STATUS
                                      which will be zero if no data is returned from the KMS.\r
   @param[in, out] ClientData         Pointer to a pointer to an arbitrary block of data of\r
                                      *ClientDataSize that is to be passed directly to the\r
-                                     KMS if it supports the use of client data. This \r
-                                     parameter may be NULL if and only if the \r
+                                     KMS if it supports the use of client data. This\r
+                                     parameter may be NULL if and only if the\r
                                      ClientDataSize parameter is also NULL. Upon return to\r
-                                     the caller, *ClientData points to a block of data of \r
-                                     *ClientDataSize that was returned from the KMS. \r
+                                     the caller, *ClientData points to a block of data of\r
+                                     *ClientDataSize that was returned from the KMS.\r
                                      If the returned value for *ClientDataSize is zero,\r
                                      then the returned value for *ClientData must be NULL\r
                                      and should be ignored by the caller. The KMS protocol\r
@@ -876,7 +876,7 @@ EFI_STATUS
                                      are completely filled in.\r
                                      On return the KeyAttributeStatus field will reflect the\r
                                      result of the operation for each key attribute request.\r
-  @param[in, out] ClientDataSize     Pointer to the size, in bytes, of an arbitrary block of \r
+  @param[in, out] ClientDataSize     Pointer to the size, in bytes, of an arbitrary block of\r
                                      data specified by the ClientData parameter. This\r
                                      parameter may be NULL, in which case the ClientData\r
                                      parameter will be ignored and no data will be\r
@@ -891,11 +891,11 @@ EFI_STATUS
                                      which will be zero if no data is returned from the KMS.\r
   @param[in, out] ClientData         Pointer to a pointer to an arbitrary block of data of\r
                                      *ClientDataSize that is to be passed directly to the\r
-                                     KMS if it supports the use of client data. This \r
-                                     parameter may be NULL if and only if the \r
+                                     KMS if it supports the use of client data. This\r
+                                     parameter may be NULL if and only if the\r
                                      ClientDataSize parameter is also NULL. Upon return to\r
-                                     the caller, *ClientData points to a block of data of \r
-                                     *ClientDataSize that was returned from the KMS. \r
+                                     the caller, *ClientData points to a block of data of\r
+                                     *ClientDataSize that was returned from the KMS.\r
                                      If the returned value for *ClientDataSize is zero,\r
                                      then the returned value for *ClientData must be NULL\r
                                      and should be ignored by the caller. The KMS protocol\r
@@ -967,7 +967,7 @@ EFI_STATUS
                                      are completely filled in.\r
                                      On return the KeyAttributeStatus field will reflect the\r
                                      result of the operation for each key attribute request.\r
-  @param[in, out] ClientDataSize     Pointer to the size, in bytes, of an arbitrary block of \r
+  @param[in, out] ClientDataSize     Pointer to the size, in bytes, of an arbitrary block of\r
                                      data specified by the ClientData parameter. This\r
                                      parameter may be NULL, in which case the ClientData\r
                                      parameter will be ignored and no data will be\r
@@ -982,11 +982,11 @@ EFI_STATUS
                                      which will be zero if no data is returned from the KMS.\r
   @param[in, out] ClientData         Pointer to a pointer to an arbitrary block of data of\r
                                      *ClientDataSize that is to be passed directly to the\r
-                                     KMS if it supports the use of client data. This \r
-                                     parameter may be NULL if and only if the \r
+                                     KMS if it supports the use of client data. This\r
+                                     parameter may be NULL if and only if the\r
                                      ClientDataSize parameter is also NULL. Upon return to\r
-                                     the caller, *ClientData points to a block of data of \r
-                                     *ClientDataSize that was returned from the KMS. \r
+                                     the caller, *ClientData points to a block of data of\r
+                                     *ClientDataSize that was returned from the KMS.\r
                                      If the returned value for *ClientDataSize is zero,\r
                                      then the returned value for *ClientData must be NULL\r
                                      and should be ignored by the caller. The KMS protocol\r
@@ -1064,7 +1064,7 @@ EFI_STATUS
                                      caller when it is no longer needed. Also, the KeyStatus\r
                                      field of each descriptor will reflect the result of the\r
                                      request relative to that key descriptor.\r
-  @param[in, out] ClientDataSize     Pointer to the size, in bytes, of an arbitrary block of \r
+  @param[in, out] ClientDataSize     Pointer to the size, in bytes, of an arbitrary block of\r
                                      data specified by the ClientData parameter. This\r
                                      parameter may be NULL, in which case the ClientData\r
                                      parameter will be ignored and no data will be\r
@@ -1079,11 +1079,11 @@ EFI_STATUS
                                      which will be zero if no data is returned from the KMS.\r
   @param[in, out] ClientData         Pointer to a pointer to an arbitrary block of data of\r
                                      *ClientDataSize that is to be passed directly to the\r
-                                     KMS if it supports the use of client data. This \r
-                                     parameter may be NULL if and only if the \r
+                                     KMS if it supports the use of client data. This\r
+                                     parameter may be NULL if and only if the\r
                                      ClientDataSize parameter is also NULL. Upon return to\r
-                                     the caller, *ClientData points to a block of data of \r
-                                     *ClientDataSize that was returned from the KMS. \r
+                                     the caller, *ClientData points to a block of data of\r
+                                     *ClientDataSize that was returned from the KMS.\r
                                      If the returned value for *ClientDataSize is zero,\r
                                      then the returned value for *ClientData must be NULL\r
                                      and should be ignored by the caller. The KMS protocol\r