1 /*
2  * Copyright (C) 2024 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 
18 #ifndef __GBL_EFI_IMAGE_LOADING_PROTOCOL_H__
19 #define __GBL_EFI_IMAGE_LOADING_PROTOCOL_H__
20 
21 #include <stddef.h>
22 #include <uefi/types.h>
23 
24 static constexpr uint64_t GBL_EFI_IMAGE_LOADING_PROTOCOL_REVISION = 0x00010000;
25 
26 #define PARTITION_NAME_LEN_U16 36
27 
28 //******************************************************
29 // GBL reserved image types
30 //******************************************************
31 // Buffer for loading, verifying and fixing up OS images.
32 #define GBL_IMAGE_TYPE_OS_LOAD L"os_load"
33 // Buffer for use as fastboot download buffer.
34 #define GBL_IMAGE_TYPE_FASTBOOT L"fastboot"
35 // Buffer reserved for pvmfw binary and configuration (must be 4KiB-aligned).
36 #define GBL_IMAGE_TYPE_PVMFW_DATA L"pvmfw_data"
37 
38 typedef struct GblEfiImageInfo {
39   char16_t ImageType[PARTITION_NAME_LEN_U16];
40   size_t SizeBytes;
41 } GblEfiImageInfo;
42 
43 typedef struct GblEfiImageBuffer {
44   void* Memory;
45   size_t SizeBytes;
46 } GblEfiImageBuffer;
47 
48 typedef struct GblEfiPartitionName {
49   char16_t StrUtf16[PARTITION_NAME_LEN_U16];
50 } GblEfiPartitionName;
51 
52 typedef struct GblEfiImageLoadingProtocol {
53   uint64_t revision;
54   EfiStatus (*get_buffer)(struct GblEfiImageLoadingProtocol* self,
55                           const GblEfiImageInfo* ImageInfo,
56                           GblEfiImageBuffer* Buffer);
57   EfiStatus (*get_verify_partitions)(struct GblEfiImageLoadingProtocol* self,
58                                      size_t* NumberOfPartitions,
59                                      GblEfiPartitionName* Partitions);
60 } GblEfiImageLoadingProtocol;
61 
62 #endif  //__GBL_EFI_IMAGE_LOADING_PROTOCOL_H__