xref: /aosp_15_r20/bootable/libbootloader/gbl/libefi_types/defs/protocols/gbl_efi_image_loading_protocol.h (revision 5225e6b173e52d2efc6bcf950c27374fd72adabc)
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 
23 #include "types.h"
24 
25 const uint64_t GBL_EFI_IMAGE_LOADING_PROTOCOL_REVISION = 0x00010000;
26 
27 const size_t PARTITION_NAME_LEN_U16 = 36;
28 
29 typedef struct GblEfiImageInfo {
30   char16_t ImageType[PARTITION_NAME_LEN_U16];
31   size_t SizeBytes;
32 } GblEfiImageInfo;
33 
34 typedef struct GblEfiImageBuffer {
35   void* Memory;
36   size_t SizeBytes;
37 } GblEfiImageBuffer;
38 
39 typedef struct GblEfiPartitionName {
40   char16_t StrUtf16[PARTITION_NAME_LEN_U16];
41 } GblEfiPartitionName;
42 
43 typedef struct GblEfiImageLoadingProtocol {
44   uint64_t revision;
45   EfiStatus (*get_buffer)(struct GblEfiImageLoadingProtocol* self,
46                           const GblEfiImageInfo* ImageInfo,
47                           GblEfiImageBuffer* Buffer);
48   EfiStatus (*get_verify_partitions)(struct GblEfiImageLoadingProtocol* self,
49                                      size_t* NumberOfPartitions,
50                                      GblEfiPartitionName* Partitions);
51 } GblEfiImageLoadingProtocol;
52 
53 #endif  //__GBL_EFI_IMAGE_LOADING_PROTOCOL_H__
54