OpenCorePkg/Library/OcAudioLib/OcAudioLib.c

/** @file
  Copyright (C) 2020, vit9696. All rights reserved.

  All rights reserved.

  This program and the accompanying materials
  are licensed and made available under the terms and conditions of the BSD License
  which accompanies this distribution.  The full text of the license may be found at
  http://opensource.org/licenses/bsd-license.php

  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/

#include <Guid/AppleVariable.h>

#include <Library/DebugLib.h>
#include <Library/DevicePathLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/OcAudioLib.h>
#include <Library/OcDriverConnectionLib.h>
#include <Library/OcMiscLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>

#include <Protocol/AppleHda.h>
#include <Protocol/AppleBeepGen.h>
#include <Protocol/AppleVoiceOver.h>

#include "OcAudioInternal.h"

//
// OC audio protocol must come first in this list.
//
STATIC
EFI_GUID *
mAudioProtocols[] = {
  &gOcAudioProtocolGuid,
  &gAppleBeepGenProtocolGuid,
  &gAppleVOAudioProtocolGuid,
  &gAppleHighDefinitionAudioProtocolGuid
};

STATIC
OC_AUDIO_PROTOCOL_PRIVATE
mAudioProtocol = {
  .Signature       = OC_AUDIO_PROTOCOL_PRIVATE_SIGNATURE,
  .AudioIo        = NULL,
  .ProviderAcquire = NULL,
  .ProviderRelease = NULL,
  .ProviderContext = NULL,
  .CurrentBuffer   = NULL,
  .PlaybackEvent   = NULL,
  .PlaybackDelay   = 0,
  .Language        = AppleVoiceOverLanguageEn,
  .OutputIndexMask = 0,
  .Gain            = APPLE_SYSTEM_AUDIO_VOLUME_DB_MIN,
  .OcAudio         = {
    .Revision           = OC_AUDIO_PROTOCOL_REVISION,
    .Connect            = InternalOcAudioConnect,
    .SetProvider        = InternalOcAudioSetProvider,
    .PlayFile           = InternalOcAudioPlayFile,
    .StopPlayback       = InternalOcAudioStopPlayback,
    .SetDelay           = InternalOcAudioSetDelay
  },
  .BeepGen         = {
    .GenBeep            = InternalOcAudioGenBeep,
  },
  .VoiceOver       = {
    .Play               = InternalOcAudioVoiceOverPlay,
    .SetLanguageCode    = InternalOcAudioVoiceOverSetLanguageCode,
    .SetLanguageString  = InternalOcAudioVoiceOverSetLanguageString,
    .GetLanguage        = InternalOcAudioVoiceOverGetLanguage,
  }
};

OC_AUDIO_PROTOCOL *
OcAudioInstallProtocols (
  IN BOOLEAN  Reinstall,
  IN BOOLEAN  DisconnectHda
  )
{
  EFI_STATUS         Status;
  UINTN              Index;
  VOID               *Protocol;
  EFI_HANDLE         NewHandle;

  DEBUG ((DEBUG_INFO, "OCAU: OcAudioInstallProtocols (%u, %u)\n", Reinstall, DisconnectHda));

  if (DisconnectHda) {
    OcDisconnectHdaControllers ();
  }

  if (Reinstall) {
    for (Index = 0; Index < ARRAY_SIZE (mAudioProtocols); ++Index) {
      Status = OcUninstallAllProtocolInstances (mAudioProtocols[Index]);
      if (EFI_ERROR (Status)) {
        DEBUG ((DEBUG_ERROR, "OCAU: Uninstall %g failed: %r\n", mAudioProtocols[Index], Status));
        return NULL;
      }
    }
  } else {
    DEBUG_CODE_BEGIN ();
    for (Index = 0; Index < ARRAY_SIZE (mAudioProtocols); ++Index) {
      Status = gBS->LocateProtocol (
        mAudioProtocols[Index],
        NULL,
        &Protocol
        );
      DEBUG ((DEBUG_INFO, "OCAU: %g protocol - %r\n", mAudioProtocols[Index], Status));
    }
    DEBUG_CODE_END ();
    for (Index = 0; Index < ARRAY_SIZE (mAudioProtocols); ++Index) {
      Status = gBS->LocateProtocol (
        mAudioProtocols[Index],
        NULL,
        &Protocol
        );
      if (!EFI_ERROR (Status)) {
        if (Index == 0) {
          return (OC_AUDIO_PROTOCOL *) Protocol;
        }
        return NULL;
      }
    }
  }

  Status = gBS->CreateEvent (
    0,
    TPL_NOTIFY,
    NULL,
    NULL,
    &mAudioProtocol.PlaybackEvent
    );
  if (EFI_ERROR (Status)) {
    DEBUG ((DEBUG_INFO, "OCAU: Unable to create audio completion event - %r\n", Status));
    return NULL;
  }

  NewHandle = NULL;
  Status = gBS->InstallMultipleProtocolInterfaces (
    &NewHandle,
    &gOcAudioProtocolGuid,
    &mAudioProtocol.OcAudio,
    &gAppleBeepGenProtocolGuid,
    &mAudioProtocol.BeepGen,
    &gAppleVOAudioProtocolGuid,
    &mAudioProtocol.VoiceOver,
    NULL
    );

  if (EFI_ERROR (Status)) {
    gBS->CloseEvent (mAudioProtocol.PlaybackEvent);
    mAudioProtocol.PlaybackEvent = NULL;
    return NULL;
  }

  return &mAudioProtocol.OcAudio;
}

INT8
OcGetAmplifierGain (
  OUT BOOLEAN  *Muted
  )
{
  EFI_STATUS  Status;
  EFI_STATUS  AltStatus;
  UINTN       Size;
  UINT8       Value;
  INT8        DbValue;

  *Muted = FALSE;

  //
  // Check mute initially (only available in raw, amp-specific gain setting).
  //
  Size   = sizeof (Value);
  AltStatus = gRT->GetVariable (
    APPLE_SYSTEM_AUDIO_VOLUME_VARIABLE_NAME,
    &gAppleBootVariableGuid,
    NULL,
    &Size,
    &Value
    );
  if (EFI_ERROR (AltStatus)) {
    Value = 0;
  } else if ((Value & APPLE_SYSTEM_AUDIO_VOLUME_MUTED) != 0) {
    *Muted = TRUE;
    Value &= APPLE_SYSTEM_AUDIO_VOLUME_VOLUME_MASK;
  }

  //
  // If no mute, use dB gain setting (which can be applied to any amp on any codec).
  //
  if (*Muted) {
    //
    // SystemAudioVolumeDB appears not to contain sane values when SystemAudioVolume indicates muted,
    // therefore we have to fall back to default gain value for use with audio assist, which never mutes.
    //
    DbValue = APPLE_SYSTEM_AUDIO_VOLUME_DB_MIN;
    Status = EFI_NOT_STARTED;
  } else {
    *Muted = FALSE;
    Size   = sizeof (DbValue);
    Status = gRT->GetVariable (
      APPLE_SYSTEM_AUDIO_VOLUME_DB_VARIABLE_NAME,
      &gAppleBootVariableGuid,
      NULL,
      &Size,
      &DbValue
      );
    if (EFI_ERROR (Status)) {
      DbValue = OC_AUDIO_DEFAULT_GAIN;
    }
  }

  //
  // Log system saved raw gain for debugging purposes. Value derived later from dB gain should
  // be the same to within about +/- 1, if applied on an amp with the same amp capabilities.
  //
  DEBUG ((
    DEBUG_INFO,
    "OCAU: System amp gain %d dB, saved raw gain 0x%X, system audio mute (for chime) %u  - %r/%r\n",
    DbValue,
    Value,
    *Muted,
    AltStatus,
    Status
    ));

  return DbValue;
}