• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 //******************************************************
30 // GBL reserved image types
31 //******************************************************
32 // Buffer for loading, verifying and fixing up OS images.
33 #define GBL_IMAGE_TYPE_OS_LOAD L"os_load"
34 // Buffer for use as fastboot download buffer.
35 #define GBL_IMAGE_TYPE_FASTBOOT L"fastboot"
36 
37 typedef struct GblEfiImageInfo {
38   char16_t ImageType[PARTITION_NAME_LEN_U16];
39   size_t SizeBytes;
40 } GblEfiImageInfo;
41 
42 typedef struct GblEfiImageBuffer {
43   void* Memory;
44   size_t SizeBytes;
45 } GblEfiImageBuffer;
46 
47 typedef struct GblEfiPartitionName {
48   char16_t StrUtf16[PARTITION_NAME_LEN_U16];
49 } GblEfiPartitionName;
50 
51 typedef struct GblEfiImageLoadingProtocol {
52   uint64_t revision;
53   EfiStatus (*get_buffer)(struct GblEfiImageLoadingProtocol* self,
54                           const GblEfiImageInfo* ImageInfo,
55                           GblEfiImageBuffer* Buffer);
56   EfiStatus (*get_verify_partitions)(struct GblEfiImageLoadingProtocol* self,
57                                      size_t* NumberOfPartitions,
58                                      GblEfiPartitionName* Partitions);
59 } GblEfiImageLoadingProtocol;
60 
61 #endif  //__GBL_EFI_IMAGE_LOADING_PROTOCOL_H__
62