I2cDxe.h

Go to the documentation of this file.

 
#ifndef __I2C_DXE_H__
#define __I2C_DXE_H__
 
#include <Uefi.h>
#include <Library/BaseMemoryLib.h>
#include <Library/DebugLib.h>
#include <Library/DevicePathLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/TimerLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiDriverEntryPoint.h>
#include <Library/UefiLib.h>
 
#include <Protocol/DriverBinding.h>
#include <Protocol/I2cEnumerate.h>
#include <Protocol/I2cHost.h>
#include <Protocol/I2cIo.h>
#include <Protocol/I2cMaster.h>
#include <Protocol/I2cBusConfigurationManagement.h>
#include <Protocol/LoadedImage.h>
 
#define I2C_DEVICE_SIGNATURE   SIGNATURE_32 ('I', '2', 'C', 'D')
#define I2C_HOST_SIGNATURE     SIGNATURE_32 ('I', '2', 'C', 'H')
#define I2C_REQUEST_SIGNATURE  SIGNATURE_32 ('I', '2', 'C', 'R')
 
//
// Synchronize access to the list of requests
//
#define TPL_I2C_SYNC  TPL_NOTIFY
 
//
//  I2C bus context
//
typedef struct {
  EFI_I2C_ENUMERATE_PROTOCOL    *I2cEnumerate;
  EFI_I2C_HOST_PROTOCOL         *I2cHost;
  EFI_HANDLE                    Controller;
  EFI_DEVICE_PATH_PROTOCOL      *ParentDevicePath;
  EFI_HANDLE                    DriverBindingHandle;
} I2C_BUS_CONTEXT;
 
//
// I2C device context
//
typedef struct {
  //
  // Structure identification
  //
  UINT32                      Signature;
 
  //
  // I2c device handle
  //
  EFI_HANDLE                  Handle;
 
  //
  // Upper level API to support the I2C device I/O
  //
  EFI_I2C_IO_PROTOCOL         I2cIo;
 
  //
  // Device path for this device
  //
  EFI_DEVICE_PATH_PROTOCOL    *DevicePath;
 
  //
  // Platform specific data for this device
  //
  CONST EFI_I2C_DEVICE        *I2cDevice;
 
  //
  // Context for the common I/O support including the
  // lower level API to the host controller.
  //
  I2C_BUS_CONTEXT             *I2cBusContext;
} I2C_DEVICE_CONTEXT;
 
#define I2C_DEVICE_CONTEXT_FROM_PROTOCOL(a)  CR (a, I2C_DEVICE_CONTEXT, I2cIo, I2C_DEVICE_SIGNATURE)
 
//
// I2C Request
//
typedef struct {
  //
  // Signature
  //
  UINT32                    Signature;
 
  //
  // Next request in the pending request list
  //
  LIST_ENTRY                Link;
 
  //
  // I2C bus configuration for the operation
  //
  UINTN                     I2cBusConfiguration;
 
  //
  // I2C slave address for the operation
  //
  UINTN                     SlaveAddress;
 
  //
  // Event to set for asynchronous operations, NULL for
  // synchronous operations
  //
  EFI_EVENT                 Event;
 
  //
  // I2C operation description
  //
  EFI_I2C_REQUEST_PACKET    *RequestPacket;
 
  //
  // Optional buffer to receive the I2C operation completion status
  //
  EFI_STATUS                *Status;
} I2C_REQUEST;
 
#define I2C_REQUEST_FROM_ENTRY(a)  CR (a, I2C_REQUEST, Link, I2C_REQUEST_SIGNATURE);
 
//
// I2C host context
//
typedef struct {
  //
  // Structure identification
  //
  UINTN                                            Signature;
 
  //
  // Current I2C bus configuration
  //
  UINTN                                            I2cBusConfiguration;
 
  //
  // I2C bus configuration management event
  //
  EFI_EVENT                                        I2cBusConfigurationEvent;
 
  //
  // I2C operation completion event
  //
  EFI_EVENT                                        I2cEvent;
 
  //
  // I2C operation and I2C bus configuration management status
  //
  EFI_STATUS                                       Status;
 
  //
  // I2C bus configuration management operation pending
  //
  BOOLEAN                                          I2cBusConfigurationManagementPending;
 
  //
  // I2C request list maintained by I2C Host
  //
  LIST_ENTRY                                       RequestList;
 
  //
  // Upper level API
  //
  EFI_I2C_HOST_PROTOCOL                            I2cHost;
 
  //
  // I2C bus configuration management protocol
  //
  EFI_I2C_BUS_CONFIGURATION_MANAGEMENT_PROTOCOL    *I2cBusConfigurationManagement;
 
  //
  // Lower level API for I2C master (controller)
  //
  EFI_I2C_MASTER_PROTOCOL                          *I2cMaster;
} I2C_HOST_CONTEXT;
 
#define I2C_HOST_CONTEXT_FROM_PROTOCOL(a)  CR (a, I2C_HOST_CONTEXT, I2cHost, I2C_HOST_SIGNATURE)
 
//
// Global Variables
//
extern EFI_COMPONENT_NAME_PROTOCOL   gI2cBusComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL  gI2cBusComponentName2;
extern EFI_DRIVER_BINDING_PROTOCOL   gI2cBusDriverBinding;
 
extern EFI_COMPONENT_NAME_PROTOCOL   gI2cHostComponentName;
extern EFI_COMPONENT_NAME2_PROTOCOL  gI2cHostComponentName2;
extern EFI_DRIVER_BINDING_PROTOCOL   gI2cHostDriverBinding;
 
EFI_STATUS
RegisterI2cDevice (
  IN I2C_BUS_CONTEXT           *I2cBus,
  IN EFI_HANDLE                Controller,
  IN EFI_DEVICE_PATH_PROTOCOL  *RemainingDevicePath
  );
 
EFI_STATUS
UnRegisterI2cDevice (
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN  EFI_HANDLE                   Controller,
  IN  EFI_HANDLE                   Handle
  );
 
EFI_STATUS
I2cBusDevicePathAppend (
  IN I2C_DEVICE_CONTEXT  *I2cDeviceContext,
  IN BOOLEAN             BuildControllerNode
  );
 
EFI_STATUS
EFIAPI
I2cBusQueueRequest (
  IN CONST EFI_I2C_IO_PROTOCOL  *This,
  IN UINTN                      SlaveAddressIndex,
  IN EFI_EVENT                  Event               OPTIONAL,
  IN EFI_I2C_REQUEST_PACKET     *RequestPacket,
  OUT EFI_STATUS                *I2cStatus          OPTIONAL
  );
 
EFI_STATUS
EFIAPI
I2cBusDriverSupported (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
I2cBusDriverStart (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
I2cBusDriverStop (
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN  EFI_HANDLE                   Controller,
  IN  UINTN                        NumberOfChildren,
  IN  EFI_HANDLE                   *ChildHandleBuffer
  );
 
EFI_STATUS
EFIAPI
I2cBusComponentNameGetDriverName (
  IN  EFI_COMPONENT_NAME2_PROTOCOL  *This,
  IN  CHAR8                         *Language,
  OUT CHAR16                        **DriverName
  );
 
EFI_STATUS
EFIAPI
I2cBusComponentNameGetControllerName (
  IN  EFI_COMPONENT_NAME2_PROTOCOL  *This,
  IN  EFI_HANDLE                    ControllerHandle,
  IN  EFI_HANDLE                    ChildHandle        OPTIONAL,
  IN  CHAR8                         *Language,
  OUT CHAR16                        **ControllerName
  );
 
EFI_STATUS
EFIAPI
InitializeI2cBus (
  IN EFI_HANDLE        ImageHandle,
  IN EFI_SYSTEM_TABLE  *SystemTable
  );
 
EFI_STATUS
EFIAPI
I2cBusUnload (
  IN EFI_HANDLE  ImageHandle
  );
 
VOID
ReleaseI2cDeviceContext (
  IN I2C_DEVICE_CONTEXT  *I2cDeviceContext
  );
 
EFI_STATUS
I2cHostRequestComplete (
  I2C_HOST_CONTEXT  *I2cHost,
  EFI_STATUS        Status
  );
 
EFI_STATUS
I2cHostRequestEnable (
  I2C_HOST_CONTEXT  *I2cHost
  );
 
EFI_STATUS
EFIAPI
I2cHostDriverSupported (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
I2cHostDriverStart (
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN EFI_HANDLE                   Controller,
  IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath
  );
 
EFI_STATUS
EFIAPI
I2cHostDriverStop (
  IN  EFI_DRIVER_BINDING_PROTOCOL  *This,
  IN  EFI_HANDLE                   Controller,
  IN  UINTN                        NumberOfChildren,
  IN  EFI_HANDLE                   *ChildHandleBuffer
  );
 
EFI_STATUS
EFIAPI
I2cHostComponentNameGetDriverName (
  IN  EFI_COMPONENT_NAME2_PROTOCOL  *This,
  IN  CHAR8                         *Language,
  OUT CHAR16                        **DriverName
  );
 
EFI_STATUS
EFIAPI
I2cHostComponentNameGetControllerName (
  IN  EFI_COMPONENT_NAME2_PROTOCOL  *This,
  IN  EFI_HANDLE                    ControllerHandle,
  IN  EFI_HANDLE                    ChildHandle        OPTIONAL,
  IN  CHAR8                         *Language,
  OUT CHAR16                        **ControllerName
  );
 
VOID
EFIAPI
I2cHostRequestCompleteEvent (
  IN EFI_EVENT  Event,
  IN VOID       *Context
  );
 
VOID
EFIAPI
I2cHostI2cBusConfigurationAvailable (
  IN EFI_EVENT  Event,
  IN VOID       *Context
  );
 
EFI_STATUS
EFIAPI
I2cHostQueueRequest (
  IN CONST EFI_I2C_HOST_PROTOCOL  *This,
  IN UINTN                        I2cBusConfiguration,
  IN UINTN                        SlaveAddress,
  IN EFI_EVENT                    Event            OPTIONAL,
  IN EFI_I2C_REQUEST_PACKET       *RequestPacket,
  OUT EFI_STATUS                  *I2cStatus       OPTIONAL
  );
 
EFI_STATUS
EFIAPI
InitializeI2cHost (
  IN EFI_HANDLE        ImageHandle,
  IN EFI_SYSTEM_TABLE  *SystemTable
  );
 
EFI_STATUS
EFIAPI
I2cHostUnload (
  IN EFI_HANDLE  ImageHandle
  );
 
#endif //  __I2C_DXE_H__