EmbeddedPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / EmbeddedPkg / Include / Protocol / EmbeddedExternalDevice.h

/** @file\r
\r
  Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __EMBEDDED_EXTERNAL_DEVICE_H__\r
#define __EMBEDDED_EXTERNAL_DEVICE_H__\r
\r
//\r
// Protocol GUID\r
//\r
#define EMBEDDED_EXTERNAL_DEVICE_PROTOCOL_GUID { 0x735F8C64, 0xD696, 0x44D0, { 0xBD, 0xF2, 0x44, 0x7F, 0xD0, 0x5A, 0x54, 0x06 }}\r
\r
//\r
// Protocol interface structure\r
//\r
typedef struct _EMBEDDED_EXTERNAL_DEVICE EMBEDDED_EXTERNAL_DEVICE;\r
\r
//\r
// Function Prototypes\r
//\r
typedef\r
EFI_STATUS\r
(EFIAPI *EMBEDDED_EXTERNAL_DEVICE_READ) (\r
    IN  EMBEDDED_EXTERNAL_DEVICE  *This,\r
    IN  UINTN                       Register,\r
    IN  UINTN                       Length,\r
    OUT VOID                        *Buffer\r
    )\r
/*++\r
\r
Routine Description:\r
\r
  Read a set of contiguous external device registers.\r
\r
Arguments:\r
\r
  This        - pointer to protocol\r
  Offset      - starting register number\r
  Length      - number of bytes to read\r
  Buffer      - destination buffer\r
\r
Returns:\r
\r
  EFI_SUCCESS - registers read successfully\r
\r
--*/\r
;\r
\r
typedef\r
EFI_STATUS\r
(EFIAPI *EMBEDDED_EXTERNAL_DEVICE_WRITE) (\r
    IN EMBEDDED_EXTERNAL_DEVICE *This,\r
    IN UINTN                      Register,\r
    IN UINTN                      Length,\r
    IN VOID                       *Buffer\r
    )\r
/*++\r
\r
Routine Description:\r
\r
  Write to a set of contiguous external device registers.\r
\r
Arguments:\r
\r
  This        - pointer to protocol\r
  Offset      - starting register number\r
  Length      - number of bytes to write\r
  Buffer      - source buffer\r
\r
Returns:\r
\r
  EFI_SUCCESS - registers written successfully\r
\r
--*/\r
;\r
\r
struct _EMBEDDED_EXTERNAL_DEVICE {\r
  EMBEDDED_EXTERNAL_DEVICE_READ      Read;\r
  EMBEDDED_EXTERNAL_DEVICE_WRITE     Write;\r
};\r
\r
extern EFI_GUID gEmbeddedExternalDeviceProtocolGuid;\r
\r
#endif  // __EMBEDDED_EXTERNAL_DEVICE_H__\r