]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/SimplePointer.h
MdePkg/PiPeiCis.h: Change comments of EFI_PEI_RESET2_SYSTEM
[mirror_edk2.git] / MdePkg / Include / Protocol / SimplePointer.h
index 44d640cc70e224948f3046e5f66224121e063caf..2f5a940ff91c5c85e8802074f832414be7728e26 100644 (file)
@@ -3,14 +3,8 @@
 \r
   Abstraction of a very simple pointer device like a mouse or trackball.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
-  All rights reserved. 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
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -78,17 +72,17 @@ typedef struct {
   BOOLEAN RightButton;\r
 } EFI_SIMPLE_POINTER_MODE;\r
 \r
-/**                                                                 \r
+/**\r
   Resets the pointer device hardware.\r
-    \r
+\r
   @param  This                  A pointer to the EFI_SIMPLE_POINTER_PROTOCOL\r
-                                instance.                                   \r
+                                instance.\r
   @param  ExtendedVerification  Indicates that the driver may perform a more exhaustive\r
-                                verification operation of the device during reset.                                       \r
-                                \r
+                                verification operation of the device during reset.\r
+\r
   @retval EFI_SUCCESS           The device was reset.\r
-  @retval EFI_DEVICE_ERROR      The device is not functioning correctly and could not be reset.  \r
-                                   \r
+  @retval EFI_DEVICE_ERROR      The device is not functioning correctly and could not be reset.\r
+\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -97,19 +91,19 @@ EFI_STATUS
   IN BOOLEAN                                ExtendedVerification\r
   );\r
 \r
-/**                                                                 \r
+/**\r
   Retrieves the current state of a pointer device.\r
-    \r
+\r
   @param  This                  A pointer to the EFI_SIMPLE_POINTER_PROTOCOL\r
-                                instance.                                   \r
+                                instance.\r
   @param  State                 A pointer to the state information on the pointer device.\r
-                                \r
+\r
   @retval EFI_SUCCESS           The state of the pointer device was returned in State.\r
   @retval EFI_NOT_READY         The state of the pointer device has not changed since the last call to\r
-                                GetState().                                                           \r
+                                GetState().\r
   @retval EFI_DEVICE_ERROR      A device error occurred while attempting to retrieve the pointer device's\r
-                                current state.                                                           \r
-                                   \r
+                                current state.\r
+\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -119,10 +113,10 @@ EFI_STATUS
   );\r
 \r
 ///\r
-/// The EFI_SIMPLE_POINTER_PROTOCOL provides a set of services for a pointer \r
-/// device that can use used as an input device from an application written \r
-/// to this specification. The services include the ability to reset the \r
-/// pointer device, retrieve get the state of the pointer device, and \r
+/// The EFI_SIMPLE_POINTER_PROTOCOL provides a set of services for a pointer\r
+/// device that can use used as an input device from an application written\r
+/// to this specification. The services include the ability to reset the\r
+/// pointer device, retrieve get the state of the pointer device, and\r
 /// retrieve the capabilities of the pointer device.\r
 ///\r
 struct _EFI_SIMPLE_POINTER_PROTOCOL {\r