EmbeddedPkg: introduce GPIO PPI
authorArd Biesheuvel <ard.biesheuvel@linaro.org>
Wed, 1 Nov 2017 12:54:39 +0000 (12:54 +0000)
committerArd Biesheuvel <ard.biesheuvel@linaro.org>
Sun, 5 Nov 2017 16:18:49 +0000 (16:18 +0000)
Introduce a PPI counterpart of the existing 'embedded GPIO' protocol,
so we can manipulate GPIOs from PEI modules. This allows things like
setting the boot mode based on a DIP switch setting.

Note that the naming is slightly awkward, as there is nothing 'embedded'
about a GPIO, but given that the DXE protocol already resides here and
has the 'embedded' prefix, it makes sense to retain uniformity.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>
Reviewed-by: Leif Lindholm <leif.lindholm@linaro.org>
EmbeddedPkg/EmbeddedPkg.dec
EmbeddedPkg/Include/Ppi/EmbeddedGpio.h [new file with mode: 0644]

index 52482af..cb07d3e 100644 (file)
@@ -86,6 +86,9 @@
   gPlatformGpioProtocolGuid = { 0x52ce9845, 0x5af4, 0x43e2, {0xba, 0xfd, 0x23, 0x08, 0x12, 0x54, 0x7a, 0xc2 }}\r
   gAndroidBootImgProtocolGuid = { 0x9859bb19, 0x407c, 0x4f8b, {0xbc, 0xe1, 0xf8, 0xda, 0x65, 0x65, 0xf4, 0xa5 }}\r
 \r
+[Ppis]\r
+  gEdkiiEmbeddedGpioPpiGuid = { 0x21c3b115, 0x4e0b, 0x470c, { 0x85, 0xc7, 0xe1, 0x05, 0xa5, 0x75, 0xc9, 0x7b }}\r
+\r
 [PcdsFeatureFlag.common]\r
   gEmbeddedTokenSpaceGuid.PcdEmbeddedMacBoot|FALSE|BOOLEAN|0x00000001\r
   gEmbeddedTokenSpaceGuid.PcdEmbeddedDirCmd|TRUE|BOOLEAN|0x00000002\r
diff --git a/EmbeddedPkg/Include/Ppi/EmbeddedGpio.h b/EmbeddedPkg/Include/Ppi/EmbeddedGpio.h
new file mode 100644 (file)
index 0000000..d87c860
--- /dev/null
@@ -0,0 +1,151 @@
+/** @file\r
+\r
+  Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
+  Copyright (c) 2017, Linaro, Ltd. All rights reserved.<BR>\r
+\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 __EMBEDDED_GPIO_PPI_H__\r
+#define __EMBEDDED_GPIO_PPI_H__\r
+\r
+//\r
+// Protocol interface structure\r
+//\r
+typedef struct _EMBEDDED_GPIO_PPI   EMBEDDED_GPIO_PPI;\r
+\r
+//\r
+// Data Types\r
+//\r
+typedef UINTN EMBEDDED_GPIO_PIN;\r
+\r
+#define GPIO(Port, Pin) ((EMBEDDED_GPIO_PIN)(((Port) << (16)) | (Pin)))\r
+#define GPIO_PIN(x)     ((EMBEDDED_GPIO_PIN)(x) & (0xFFFF))\r
+#define GPIO_PORT(x)    ((EMBEDDED_GPIO_PIN)(x) >> (16))\r
+\r
+typedef enum {\r
+  GPIO_MODE_INPUT                 = 0x00,\r
+  GPIO_MODE_OUTPUT_0              = 0x0E,\r
+  GPIO_MODE_OUTPUT_1              = 0x0F,\r
+  GPIO_MODE_SPECIAL_FUNCTION_2    = 0x02,\r
+  GPIO_MODE_SPECIAL_FUNCTION_3    = 0x03,\r
+  GPIO_MODE_SPECIAL_FUNCTION_4    = 0x04,\r
+  GPIO_MODE_SPECIAL_FUNCTION_5    = 0x05,\r
+  GPIO_MODE_SPECIAL_FUNCTION_6    = 0x06,\r
+  GPIO_MODE_SPECIAL_FUNCTION_7    = 0x07\r
+} EMBEDDED_GPIO_MODE;\r
+\r
+typedef enum {\r
+  GPIO_PULL_NONE,\r
+  GPIO_PULL_UP,\r
+  GPIO_PULL_DOWN\r
+} EMBEDDED_GPIO_PULL;\r
+\r
+//\r
+// Function Prototypes\r
+//\r
+\r
+/**\r
+\r
+  Gets the state of a GPIO pin\r
+\r
+  @param This                   Pointer to protocol\r
+  @param Gpio                   Which pin to read\r
+  @param Value                  State of the pin\r
+\r
+  @retval EFI_SUCCESS           GPIO state returned in Value\r
+  @retval EFI_INVALID_PARAMETER Value is NULL\r
+  @retval EFI_NOT_FOUND         Pin does not exit\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EMBEDDED_GPIO_GET) (\r
+  IN  EMBEDDED_GPIO_PPI     *This,\r
+  IN  EMBEDDED_GPIO_PIN     Gpio,\r
+  OUT UINTN                 *Value\r
+  );\r
+\r
+/**\r
+\r
+  Sets the state of a GPIO pin\r
+\r
+  @param This                   Pointer to protocol\r
+  @param Gpio                   Which pin to modify\r
+  @param Mode                   Mode to set\r
+\r
+  @retval EFI_SUCCESS           GPIO set as requested\r
+  @retval EFI_INVALID_PARAMETER Invalid mode\r
+  @retval EFI_NOT_FOUND         Pin does not exit\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EMBEDDED_GPIO_SET) (\r
+  IN EMBEDDED_GPIO_PPI      *This,\r
+  IN EMBEDDED_GPIO_PIN      Gpio,\r
+  IN EMBEDDED_GPIO_MODE     Mode\r
+  );\r
+\r
+\r
+/**\r
+\r
+  Gets the mode (function) of a GPIO pin\r
+\r
+  @param This                   Pointer to protocol\r
+  @param Gpio                   Which pin\r
+  @param Mode                   Pointer to output mode value\r
+\r
+  @retval EFI_SUCCESS           Mode value retrieved\r
+  @retval EFI_INVALID_PARAMETER Mode is NULL\r
+  @retval EFI_NOT_FOUND         Pin does not exit\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EMBEDDED_GPIO_GET_MODE) (\r
+  IN  EMBEDDED_GPIO_PPI     *This,\r
+  IN  EMBEDDED_GPIO_PIN     Gpio,\r
+  OUT EMBEDDED_GPIO_MODE    *Mode\r
+  );\r
+\r
+\r
+/**\r
+\r
+  Sets the pull-up / pull-down resistor of a GPIO pin\r
+\r
+  @param This                   Pointer to PPI\r
+  @param Gpio                   Port/pin index\r
+  @param Pull                   The pullup/pulldown mode to set\r
+\r
+  @retval EFI_SUCCESS           Mode was set\r
+  @retval EFI_NOT_FOUND         Pin does not exist\r
+  @retval EFI_UNSUPPORTED       Action not supported\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *EMBEDDED_GPIO_SET_PULL) (\r
+  IN  EMBEDDED_GPIO_PPI     *This,\r
+  IN  EMBEDDED_GPIO_PIN     Gpio,\r
+  IN  EMBEDDED_GPIO_PULL    Direction\r
+  );\r
+\r
+\r
+struct _EMBEDDED_GPIO_PPI {\r
+  EMBEDDED_GPIO_GET         Get;\r
+  EMBEDDED_GPIO_SET         Set;\r
+  EMBEDDED_GPIO_GET_MODE    GetMode;\r
+  EMBEDDED_GPIO_SET_PULL    SetPull;\r
+};\r
+\r
+extern EFI_GUID gEmbeddedGpioPpiGuid;\r
+\r
+#endif\r