Vlv2TbltDevicePkg/Include/Ppi/Speaker.h

   1 /*++
   2
   3   Copyright (c) 2004  - 2014, Intel Corporation. All rights reserved.<BR>
   4
   5   This program and the accompanying materials are licensed and made available under
   6   the terms and conditions of the BSD License that accompanies this distribution.
   7   The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php.
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13
  14 Module Name:
  15
  16   Speaker.h
  17
  18 Abstract:
  19
  20   EFI Speaker Interface Protocol
  21
  22
  23
  24 --*/
  25
  26 #ifndef _PEI_SPEAKER_IF_H
  27 #define _PEI_SPEAKER_IF_H
  28
  29 //
  30 // Global ID Speaker Interface
  31 //
  32 #define PEI_SPEAKER_INTERFACE_PPI_GUID \
  33   { \
  34     0x30ac275e, 0xbb30, 0x4b84, 0xa1, 0xcd, 0x0a, 0xf1, 0x32, 0x2c, 0x89, 0xc0 \
  35   }
  36
  37 typedef struct _PEI_SPEAKER_IF_PPI PEI_SPEAKER_IF_PPI;
  38
  39 //
  40 // Beep Code
  41 //
  42 typedef
  43 EFI_STATUS
  44 (EFIAPI *EFI_SPEAKER_GENERATE_BEEP) (
  45   IN CONST EFI_PEI_SERVICES           **PeiServices,
  46   IN UINTN                            NumberOfBeep,
  47   IN UINTN                            BeepDuration,
  48   IN UINTN                            TimeInterval
  49   );
  50
  51 //
  52 // Set Frequency
  53 //
  54 typedef
  55 EFI_STATUS
  56 (EFIAPI *EFI_SPEAKER_SET_FREQUENCY) (
  57   IN CONST EFI_PEI_SERVICES           **PeiServices,
  58   IN UINT16                           Frequency
  59   );
  60
  61 //
  62 // Protocol definition
  63 //
  64 typedef struct _PEI_SPEAKER_IF_PPI {
  65   EFI_SPEAKER_SET_FREQUENCY SetSpeakerToneFrequency;
  66   EFI_SPEAKER_GENERATE_BEEP GenerateBeep;
  67 } PEI_SPEAKER_IF_PPI;
  68
  69 extern EFI_GUID gPeiSpeakerInterfacePpiGuid;
  70 #endif