summaryrefslogtreecommitdiff
path: root/Core/MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h
diff options
context:
space:
mode:
Diffstat (limited to 'Core/MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h')
-rw-r--r--Core/MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h80
1 files changed, 80 insertions, 0 deletions
diff --git a/Core/MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h b/Core/MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h
new file mode 100644
index 0000000000..00f8078f76
--- /dev/null
+++ b/Core/MdePkg/Library/PeiSmbusLibSmbus2Ppi/InternalSmbusLib.h
@@ -0,0 +1,80 @@
+/** @file
+Internal header file for Smbus library.
+
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
+This program and the accompanying materials
+are licensed and made available under the terms and conditions of the BSD License
+which accompanies this distribution. The full text of the license may be found at
+http://opensource.org/licenses/bsd-license.php
+
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+
+
+**/
+
+#ifndef __INTERNAL_SMBUS_LIB_H_
+#define __INTERNAL_SMBUS_LIB_H_
+
+
+#include <PiPei.h>
+
+#include <Ppi/Smbus2.h>
+
+#include <Library/SmbusLib.h>
+#include <Library/DebugLib.h>
+#include <Library/PeiServicesLib.h>
+#include <Library/BaseMemoryLib.h>
+
+//
+// Declaration for internal functions
+//
+
+/**
+ Gets Smbus PPIs.
+
+ This internal function retrieves Smbus PPI from PPI database.
+
+ @param VOID
+
+ @return The pointer to Smbus PPI.
+
+**/
+EFI_PEI_SMBUS2_PPI *
+InternalGetSmbusPpi (
+ VOID
+ );
+
+/**
+ Executes an SMBus operation to an SMBus controller.
+
+ This function provides a standard way to execute Smbus script
+ as defined in the SmBus Specification. The data can either be of
+ the Length byte, word, or a block of data.
+
+ @param SmbusOperation Signifies which particular SMBus hardware protocol
+ instance that it will use to execute the SMBus transactions.
+ @param SmBusAddress The address that encodes the SMBUS Slave Address,
+ SMBUS Command, SMBUS Data Length, and PEC.
+ @param Length Signifies the number of bytes that this operation will
+ do. The maximum number of bytes can be revision specific
+ and operation specific.
+ @param Buffer Contains the value of data to execute to the SMBus slave
+ device. Not all operations require this argument. The
+ length of this buffer is identified by Length.
+ @param Status Return status for the executed command.
+ This is an optional parameter and may be NULL.
+
+ @return The actual number of bytes that are executed for this operation.
+
+**/
+UINTN
+InternalSmBusExec (
+ IN EFI_SMBUS_OPERATION SmbusOperation,
+ IN UINTN SmBusAddress,
+ IN UINTN Length,
+ IN OUT VOID *Buffer,
+ OUT RETURN_STATUS *Status OPTIONAL
+ );
+
+#endif