EmbeddedPkg/Include/Protocol/EmbeddedDevice.h

   1 /** @file
   2   Deal with devices that just exist in memory space.
   3
   4   To follow the EFI driver model you need a root handle to start with. An
   5   EFI driver will have a driver binding protocol (Supported, Start, Stop)
   6   that is used to layer on top of a handle via a gBS->ConnectController.
   7   The first handle has to just be in the system to make that work. For
   8   PCI it is a PCI Root Bridge IO protocol that provides the root.
   9
  10   On an embedded system with MMIO device we need a handle to just
  11   show up. That handle will have this protocol and a device path
  12   protocol on it.
  13
  14   For an ethernet device the device path must contain a MAC address device path
  15   node.
  16
  17   Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
  18
  19   This program and the accompanying materials
  20   are licensed and made available under the terms and conditions of the BSD License
  21   which accompanies this distribution.  The full text of the license may be found at
  22   http://opensource.org/licenses/bsd-license.php
  23
  24   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  25   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  26
  27 **/
  28
  29 #ifndef __EMBEDDED_DEVICE_PROTOCOL_H__
  30 #define __EMBEDDED_DEVICE_PROTOCOL_H__
  31
  32
  33 //
  34 // Protocol GUID
  35 //
  36 // BF4B9D10-13EC-43dd-8880-E90B718F27DE
  37
  38 #define EMBEDDED_DEVICE_PROTOCOL_GUID \
  39   { 0xbf4b9d10, 0x13ec, 0x43dd, { 0x88, 0x80, 0xe9, 0xb, 0x71, 0x8f, 0x27, 0xde } }
  40
  41
  42
  43 typedef struct {
  44   UINT16          VendorId;
  45   UINT16          DeviceId;
  46   UINT16          RevisionId;
  47   UINT16          SubsystemId;
  48   UINT16          SubsystemVendorId;
  49   UINT8           ClassCode[3];
  50   UINT8           HeaderSize;
  51   UINTN           BaseAddress;
  52 } EMBEDDED_DEVICE_PROTOCOL;
  53
  54 extern EFI_GUID gEmbeddedDeviceGuid;
  55
  56 #endif
  57
  58