include/gbl_efi_debug_protocol.h

/*
 * Copyright (C) 2025 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, embodiment or
 * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0 OR BSD-2-Clause-Patent
 *
 * This file is dual-licensed under Apache 2.0 and BSD-2-Clause-Patent.
 * You may choose to use this file under the terms of either:
 *  (a) the Apache License, Version 2.0, or
 *  (b) the BSD 2-Clause Patent License.
 *
 * Unless you expressly elect the BSD-2-Clause-Patent terms, the Apache-2.0
 * license terms apply by default.
 */

#ifndef __GBL_EFI_DEBUG_PROTOCOL_H__
#define __GBL_EFI_DEBUG_PROTOCOL_H__

#include <gbl_efi_common.h>

static const uint64_t GBL_EFI_DEBUG_PROTOCOL_REVISION = GBL_PROTOCOL_REVISION(1, 0);

EFI_ENUM(GblEfiDebugErrorTag, uint64_t, GBL_EFI_DEBUG_ERROR_TAG_ASSERTION_ERROR,
         GBL_EFI_DEBUG_ERROR_TAG_PARTITION, GBL_EFI_DEBUG_ERROR_TAG_LOAD_IMAGE,
         GBL_EFI_DEBUG_ERROR_TAG_BOOT_ERROR);

typedef struct GblEfiDebugProtocol {
  uint64_t revision;

  efi_status_t (*fatal_error)(struct GblEfiDebugProtocol* self,
                           /* in */ const void* frame_ptr,
                           /* in */ GblEfiDebugErrorTag tag);
} GblEfiDebugProtocol;

#endif  // __GBL_EFI_DEBUG_PROTOCOL_H__ */