Vlv2TbltDevicePkg/Include/Protocol/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 Revision History
  23
  24 **/
  25
  26 #ifndef _EFI_SPEAKER_H
  27 #define _EFI_SPEAKER_H
  28
  29 //
  30 // Global Id for Speaker Interface
  31 //
  32 #define EFI_SPEAKER_INTERFACE_PROTOCOL_GUID \
  33   { \
  34     0x400b4476, 0x3081, 0x11d6, 0x87, 0xed, 0x00, 0x06, 0x29, 0x45, 0xc3, 0xb9 \
  35   }
  36
  37 typedef struct _EFI_SPEAKER_IF_PROTOCOL  EFI_SPEAKER_IF_PROTOCOL;
  38
  39 //
  40 // Beep Code
  41 //
  42 typedef
  43 EFI_STATUS
  44 (EFIAPI *EFI_GENERATE_BEEP) (
  45   IN EFI_SPEAKER_IF_PROTOCOL                * This,
  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 EFI_SPEAKER_IF_PROTOCOL               * This,
  58   IN     UINT16                            Frequency
  59   );
  60
  61 //
  62 // Protocol definition
  63 //
  64 struct _EFI_SPEAKER_IF_PROTOCOL {
  65   EFI_SPEAKER_SET_FREQUENCY SetSpeakerToneFrequency;
  66   EFI_GENERATE_BEEP         GenerateBeep;
  67 } ;
  68
  69 extern EFI_GUID gEfiSpeakerInterfaceProtocolGuid;
  70 #endif