【UEFI基础】UEFI中的Protocol使用方法

已于 2022-09-23 18:08:06 修改
阅读量5.1k 收藏 20
点赞数 3
分类专栏： UEFI基础知识 文章标签： uefi
于 2018-09-27 14:22:25 首次发布
原文链接：https://blog.csdn.net/lightseed/article/details/4234812
版权


UEFI中的Protocol使用方法


前言

　　启动服务提供了丰富的服务供开发者操作Protocol，我们可以使用Protocol也可以开发Protocol。本文主要介绍如何使用Protocol。
　　使用Protocol一般分为下面三个步骤：
　　　　1. 通过启动服务找出Protocol对象；
　　　　2. 使用这个Protocol提供的服务；
　　　　3. 关闭打开的Protocol
　　可以使用OpenProtocolInformation服务查看打开某个Protocol的所有设备。
　　启动服务，有四种，分别为：OpenProtocol、HandleProtocol、LocateProtocol和LocalHandleBuffer。下面分别介绍它们。


一、OpenProtocol 服务

　　OpenProtocol 用于查询指定的Handle中是否支持指定的Protocol，如果支持，则打开该Protocol，否则返回错误代码。
　　BS（启动时服务）中的OpenProtocol函数原型：

typedef
EFI_STATUS
(EFIAPI *EFI_OPEN_PROTOCOL) (
    IN EFI_HANDLE Handle,
    IN EFI_GUID *Protocol,
    OUT VOID **Interface ,  OPTIONAL
    IN EFI_HANDLE AgentHandle,
    IN EFI_HANDLE ControllerHandle,
    IN UINT32 Attributes
);

返回值：

返回值描述
EFI_SUCCESSThe interface information for the specified protocol was returned.
EFI_UNSUPPORTEDThe device does not support the specified protocol.
EFI_INVALID_PARAMETERHandle is NULL.
EFI_INVALID_PARAMETERProtocol is NULL.
EFI_INVALID_PARAMETERInterface is NULL.
  • Handle：查询次Handle提供的Protocol
  • *Protocol：要打开的Protocol（指向次Protocol GUID的指针）
  • **Interface：返回打开的Protocol的对象
  • AgentHandle：打开此Protocol的Image
  • ControllerHandle：打开此Protocol的控制器

  • Attributes：打开此Protocol的方式

    　　Handle是Protocol的提供者，如果Handle的Protocols链表中有该Protocol，则Protocol对象的指针写到*Interface，并返回EFI_SUCCESS，否则返回EFI_UNSUPPORTED。
    　　如果在驱动中调用OpenProtocol，则ControllerHandle是拥有该驱动的控制器，也就是请求使用这个Protocol的控制器；AgentHandle是拥有该EFI_DRIVER_BINDING_PROTOCOL对象的Handle。EFI_DRIVER_BINDING_PROTOCOL是UEFI驱动开发一定会用到的一个Protocol，它负责驱动的安装与卸载。
    　　如果调用OpenProtocol的是应用程序，那么AgentHandle是该用用程序的Handle，也就是UefiMain的第一个参数，ControllerHandle此时可以忽略。
    　　Attribute值列表：
    　这里写图片描述
    注：截图来源于UEFI Spec 2_6。关于这部分可以查阅UEFI Spec。

OpenHandle示例程序片断：

/// 打开BlockIo
EFI_HANDLE ImageHandle;
EFI_DRIVER_BINDING_PROTOCOL *This;
IN EFI_HADNLE ControllerHandle；
extern EFI_GUID BlockIoProtocolGuid;
EFI_BLOCK_IO_PROTOCOL *BlockIo;
EFI_STATUS Status;
//在应用程序中使用OpenProtocol，一般ControllerHandle会设为NULL
Status = gBS->OpenProtocol(
    ControllerHandle,                     //Handle
    &gEfiBlockIoProtocolGuid,             //Protocol
    &BlockIo,                             //Interface
    ImageHandle,                          //AgentHandle
    NULL,                                 //ControllerHandle
    EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL  //Attribute
)
//在驱动中使用，OpenProtocol， ControllerHandle是控制器的Handle
Status = gBS->OpenProtocol(
    ControllerHandle,                     //Handle
    &gEfiBlockIoProtocolGuid,             //Protocol
    &BlockIo,                             //Interface
    This->DriverBindingHandle,            //AgentHandle
    ControllerHandle,                     //ControllerHandle
    EFI_OPEN_PROTOCOL_GET_PROTOCOL        //Attribute
)
  • ProtocolGuid 是全局变量，变量定义在AutoGen.c 中。AutoGen.c 是由build工具根据 .inf 和 .dec 文件生成的，gEfiBlockIoProtocolGuid是EFI_GUID类型的变量，其EFI_GUID值定义在 .dec中。如果要在应用程序或驱动中使用gEfiBlockIoProtocolGuid，那么必须在 .inf 文件的[Protocols]中声明以便预处理时将其包含在AutoGen.c中。


二、HandleProtocol 服务

　　OpenProtocol功能比较强大，但是使用比较复杂，需要提供Handle和Protocol的GUID，还要提供AgentHandle、ControllerHandle和Attributes。但是开发者大多时候只是想通过Protocol的GUID得到Protocol对象，并不关心打开方式细节。为了方便开发者使用Protocol，启动服务提供了HandleProtocol以简化打开Protocol。
　　HandleProtocol服务的函数原型：

typedef
EFI_STATUS
(EFIAPI *EFI_HANDLE_PROTOCOL) (
    IN EFI_HANDLE Handle,
    IN EFI_GUID *Protocol,
    OUT VOID **Interface
);
返回值描述
EFI_SUCCESSThe interface information for the specified protocol was returned.
EFI_UNSUPPORTEDThe device does not support the specified protocol.
EFI_INVALID_PARAMETERHandle is NULL.
EFI_INVALID_PARAMETERProtocol is NULL.
EFI_INVALID_PARAMETERInterface is NULL.

HandleProtocol 是OpenProtocol的简化版，在调用HandleProtocol时不必再传入AgentHandle、ControllerHandle和Attribute。它的内部其实仍是调用了OpenProtocol。
　　HandleProtocol 的内部实现：

EFI_STATUS
HandleProtocol (
    IN EFI_HANDLE Handle,
    IN EFI_GUID *Protocol,
    OUT VOID **Interface
)
{
    return OpenProtocol (
        Handle,
        Protocol,
        Interface,
        EfiCoreImageHandle,
        NULL,
        EFI_OPEN_PROTOCOL_BY_HANDLE_PROTOCOL
    );
}

HandleProtocol使用示例：

Status = gBS->HandleProtocol(
    ControllerHandle,                     //Handle
    &gEfiBlockIoProtocolGuid,             //Protocol
    &BlockIo,                             //Interface   
)


三、LocateProtocol 服务

　　OpenProtocol和HandleProtocol用于打开指定设备上的某个Protocol，要使用这两个函数，首先要得到这个设备的句柄 。有时开发者并不关心Protocol在哪个设备上，尤其是系统仅有一个该Protocol的实例时。启动服务提供了LocateProtocol（…）服务，它可以从UEFI内核中找到指定Protocol的第一个实例。
　　LocateProtocol服务函数原型：

typedef
EFI_STATUS
(EFIAPI *EFI_LOCATE_PROTOCOL) (
    IN EFI_GUID *Protocol,
    IN VOID *Registration，OPTIONAL
    OUT VOID **Interface
);
返回值描述
EFI_SUCCESSA protocol instance matching Protocol was found and returned in Interface.
EFI_INVALID_PARAMETERInterface is NULL.
EFI_NOT_FOUNDNo protocol instances were found that match Protocol and Registration.

　　UEFI内核中某个Protocol的实例可能不止一个，例如，每个硬盘及每个分区都有一个EFI_DISK_IO_PROTOCOL实例。LocateProtocol顺序搜索HANDLE链表，返回找到的第一个该Protocol的实例。
　　下面的例子用于找出系统中第一个SIMPLE_FILE_SYSTEM_PROTOCOL实例。

EFI_SIMPLE_FILE_SYSTE_PROTOCOL* SimpleFs;
gBS->LocateProtocol(
    gEfiSimpleFileSystemProtocolGuid,
    NULL,
    &SimpleFs
);


四、LocateProtocolBuffer服务

　　前面三种是从设备上找出Protocol的方法。有时候开发者需要找出支持某个Protocol的所有设备，例如找出系统中所有安装了BlockIo的设备。LocateHandle和LocateProtocolBuffer提供这个服务。
　　LocateProtocolBuffer函数原型：

typedef
EFI_STATUS
(EFIAPI *EFI_LOCATE_HANDLE_BUFFER) (
    IN EFI_LOCATE_SEARCH_TYPE SearchType, //查找方式
    IN EFI_GUID *Protocol OPTIONAL,       //指定的Protocol
    IN VOID *SearchKey OPTIONAL,          //PROTOCOL_NOTIFY的类型
    IN OUT UINTN *NoHandles,              //返回找到的HANDLE数量
    OUT EFI_HANDLE **Buffer               //分配Handle数组并返回
);
返回值描述
EFI_SUCCESSThe array of handles was returned.
EFI_NOT_FOUNDNo handles match the search.
EFI_BUFFER_TOO_SMALLThe BufferSize is too small for the result. BufferSize has been updated with the size needed to complete the request.
EFI_INVALID_PARAMETERSearchType is not a member of EFI_LOCATE_SEARCH_TYPE
EFI_INVALID_PARAMETERSearchType is ByRegisterNotify and SearchKey is NULL.
EFI_INVALID_PARAMETERSearchType is ByProtocol and Protocol is NULL.
EFI_INVALID_PARAMETEROne or more matches are found and BufferSize is NULL.
EFI_INVALID_PARAMETERBufferSize is large enough for the result and Buffer is NULL.

　　SearchType有三种：AllHandles用于找出系统中所有的Handle；ByRegisterNotify用于从RegisterProtocolNotify中找出所有匹配SearchKey的Handle；ByProtocol用于从系统Handle数据库中找到支持指定Protocol的HANDLE。
　　SearchType的类型定义：

typedef enum{
    AllHandles,
    ByRegisterNotify,
    ByProtocol
} EFI_LOCATE_SEARCH_TYPE;

LocateHandle服务函数原型：

typedef
EFI_STATUS
(EFIAPI *EFI_LOCATE_HANDLE) (
    IN EFI_LOCATE_SEARCH_TYPE SearchType,
    IN EFI_GUID *Protocol OPTIONAL,
    IN VOID *SearchKey OPTIONAL,
    IN OUT UINTN *BufferSize,
    OUT EFI_HANDLE *Buffer
);
返回值描述
EFI_SUCCESSThe array of handles was returned.
EFI_NOT_FOUNDNo handles match the search.
EFI_BUFFER_TOO_SMALLThe BufferSize is too small for the result. BufferSize has been updated with the size needed to complete the request.
EFI_INVALID_PARAMETERSearchType is not a member of EFI_LOCATE_SEARCH_TYPE
EFI_INVALID_PARAMETERSearchType is ByRegisterNotify and SearchKey is NULL.
EFI_INVALID_PARAMETERSearchType is ByProtocol and Protocol is NULL.
EFI_INVALID_PARAMETEROne or more matches are found and BufferSize is NULL.
EFI_INVALID_PARAMETERBufferSize is large enough for the result and Buffer is NULL.

　　LocateHandle服务与LocateHandleBuffer服务最大的不同是需要调用者负责管理Buffer数组占用的内存。


五、其它Protocol 服务

　　除了Protocol和根据Protocol找出设备这些常用服务，启动服务关于使用Protocol的服务还有ProtocolsPerHandle和OpenProtocolInformation。


1. ProtocolsPerHandle

　　ProtocolsPerHandle用于获取指定设备所支持的所有Protocol。这些Protocol的GUID通过ProtocolBuffer返回给调用者，UEFI负责分配内存给ProtocolBuffer，调动者负责释放该内存。
　　
　　ProtocolsPerHandle函数原型：

typedef
EFI_STATUS
(EFIAPI *EFI_PROTOCOLS_PER_HANDLE) (
    IN EFI_HANDLE Handle,
    OUT EFI_GUID ***ProtocolBuffer,
    OUT UINTN *ProtocolBufferCount
);
返回值描述
EFI_SUCCESSThe list of protocol interface GUIDs installed on Handle was returned in ProtocolBuffer. The number of protocol interface GUIDs was returned in ProtocolBufferCount.
EFI_INVALID_PARAMETERHandle is NULL.
EFI_INVALID_PARAMETERProtocolBuffer is NULL.
EFI_INVALID_PARAMETERProtocolBufferCount is NULL.
EFI_OUT_OF_RESOURCESThere is not enough pool memory to store the results


2. OpenProtocolInformation

　　OpenProtocolInformation用于获得指定设备上指定Protocol的打开信息。

　　OpenProtocolInformation函数原型：

typedef
EFI_STATUS
(EFIAPI *EFI_OPEN_PROTOCOL_INFORMATION) (
    IN EFI_HANDLE Handle,
    IN EFI_GUID *Protocol,
    OUT EFI_OPEN_PROTOCOL_INFORMATION_ENTRY **EntryBuffer,
    OUT UINTN *EntryCount
);
返回值描述
EFI_SUCCESSThe open protocol information was returned in EntryBuffer,and the number of entries was returned EntryCount.
EFI_NOT_FOUNDHandle does not support the protocol specified by Protocol.
EFI_OUT_OF_RESOURCESThere are not enough resources available to allocate EntryBuffer.
//EFI_OPEN_PROTOCOL_INFORMATION_ENTRY数据结构
typedef struct {
    EFI_HANDLE AgentHandle;
    EFI_HANDLE ControllerHandle;
    UINT32 Attributes;
    UINT32 OpenCount;
} EFI_OPEN_PROTOCOL_INFORMATION_ENTRY;

　　Ｈandle是这个设备的句柄，打开的信息存放在PROTOCOL_INTERDACE的OpenList列表中。设备上的同一Protocol可能被打开和关闭很多次。Protocol每一次被成功打开和关闭后都会更新OpenList列表。成功打开后，都会在设备句柄上添加一项EFI_OPEN_PROTOCOL_INFORMATION_ENTRY，若OpenList列表中已经存在一项与当前的（AgentHandle，ControllerHandle，Attributes）完全相同，则该项OpenCount加一。关闭Protocol则将OpenList对应项的OpenCount减一，OpenCount为零时删除对应项。


六、CloseProtocol 服务

　　Protocol使用完毕之后需要通过CloseProtocol关闭打开的Protocol。
　　CloseProtocol函数原型：

typedef
EFI_STATUS
(EFIAPI *EFI_CLOSE_PROTOCOL) (
    IN EFI_HANDLE Handle,
    IN EFI_GUID *Protocol,
    IN EFI_HANDLE AgentHandle,
    IN EFI_HANDLE ControllerHandle
);
返回值描述
EFI_SUCCESSThe protocol instance was closed.
EFI_INVALID_PARAMETERHandle is NULL.
EFI_INVALID_PARAMETERAgentHandle is NULL.
EFI_INVALID_PARAMETERControllerHandle is not NULL and ControllerHandle is NULL.
EFI_INVALID_PARAMETERProtocol is NULL.
EFI_NOT_FOUNDHandle does not support the protocol specified by Protocol.
EFI_NOT_FOUNDThe protocol interface specified by Handle and Protocol is not currently open by AgentHandle and ControllerHandle.

　　通过HandleProtocol和LocateProtocol打开的Protocol因为没有指定AgentHandle，所以无法关闭。如果一定要关闭它，则要调用OpenProtocolInformation（）获得AgentHandle和ControllerHandle，然后再关闭它。


七、总结

　　本部分，不住要讲解了Protocol的使用方法。Protocol提供了一种在UEFI应用程序以及UEFI驱动之间的通信方式。通过Protocol，用户可以使用驱动提供的服务，以及系统提供的其他服务。要熟悉自己使用的Protocol的数据结构。

Alix_sz
关注
专栏目录
UEFI基础——Protocol服务
大猫的博客
10-12 555
Protocol是UEFI中重要概念之一，Protocol在UEFI中的角色相当于UEFI的接口函数。实际上，Proctol是UEFI环境的提供者何使用者之间的一种约定，双方根据这个协定进行通信。
UEFI中的Protocol浅谈
chris_leeYC的专栏
07-27 9172
UEFI中的Protocol 一、Protocol是什么 Protocol是服务器端和客户端之间的一种约定，在软件编程上称为接口，服务器端和客户端通过这个约定信息的互通。服务器端和客户端在UEFI中都是可执行的二进制文件，为了实现这些二进制文件之间的互通，C/S双方共同作出的让步，使用Protocol进行双方的交互。 二、Protocol是干什么的，为什么要有Protocol UEFI的
UEFI基础概念2——Handle和Protocol
最新发布
qq_44807736的博客
09-11 742
句柄是动态分配的，即Handle不是启动时预先分配好的，而是需要的时候由UEFI固件动态创建的。LocateProcotol()：返回第一个与Protocol匹配的Protocol接口的指针，这个函数会查找第一个支持Protocol的设备句柄，并返回该协议的指针。Handle（句柄）是一个或多个协议的集合，Protocol（协议）是由GUID命名的数据结构。使用协议的GUID名称在句柄数据库中注册协议服务，通过使用与协议关联的GUID名称在句柄数据库中查找协议来发现协议服务，以执行查找操作。
UEFI原理与编程（九）：UEFI中的Protocol使用方法
热门推荐
kaliopensourcextu
05-02 2万+
UEFI中的Protocol使用方法前言　　 启动服务提供了丰富的服务供开发者操作Protocol，我们可以使用Protocol也可以开发Protocol。本文主要介绍如何使用Protocol。
Uefi中的Protocol
Wuxin的博客
08-22 709
Protocol通过GUID和相应的访问函数，获取对象的指针，然后使用该指针获得对象所提供的服务，实现所需的功能。
UEFI中的Protocol
tom__mao__的博客
10-26 1204
以下内容为学习《UEFI原理与编程》（戴正华）第四章和第六章的摘要 UEFI是用C语言来实现的，但UEFI中Protocol是作为一种对象来设计和使用。例如： // 通过这个protocol可以控制块设备 struct  _EFI_BLOCK_IO_PROTOCOL{ UINT64 Revision; EFI_BLOCK_IO_MEDIA *Media; EFI_BLOCK_
【UEFI基础】Protocol介绍
jiangwei0512的博客
02-11 1万+
【UEFI基础】Protocol介绍。
UEFI中Protocol的一些介绍
02-15
UEFI中的Protocol介绍 Protocol是UEFI中最重要的概念之一。在UEFI中，Protocol是一种约定，是双方之间的一种协议。但是这种约定是怎么实现的呢？从代码的角度看，Protocol是UEFI定义的结构体，结构体中有成员变量和...
uefi第一个protocol
09-18
"阿巴阿巴"在这里可能是开发者在描述过程中使用的口语化表达，可能表示对UEFI Protocol的初学者状态或者是对知识理解的模糊感。理解UEFI Protocol需要对UEFI环境、C语言编程和EFI编程模型有一定的了解。 总之，...
如何理解UEFI中handle和protocol的概念
12-13 1万+
UEFI中到处都会出现Handle和Protocol这两个概念，这个对于理解UEFI的设计思路还是很重要的，但是翻遍了UEFI spec，并没有给出很清晰的概念。后来干脆去翻源码的定义，立马有种拨云见日的感觉。   基本上，protocol代表的是一种用定义好了的数据结构，每个protocol都有唯一的ID（128bit的GUID，也可以理解为protocl的名字），可以通过这个GUI
UEFI 基础教程 （零） - 目录
技术联盟
08-27 832
UEFI 基础教程 （十八） — UEFI Build Process简单分析。UEFI 基础教程 （十五） — 获取UEFI MemoryMap。UEFI 基础教程 （六）　 　— 　PROTOCOL 简单使用。UEFI 基础教程 （十） 　　— 　FileIO 简单使用。UEFI 基础教程 （一） 　　— 　搭建UEFI开发环境。UEFI 基础教程 （九） 　　—　 EVENT 简单使用。UEFI 基础教程 （七） 　　— 　HOB 简单使用。UEFI 基础教程 （八）　　 — 　PCD 简单使用。..
BIOS/UEFI基础——Protocol介绍
Wang20122013的博客
09-30 2019
简要说明 Protocol是UEFI中的一个重要概念（事实上《UEFI SPEC》中有超过70%的内容都是在讲Protocol），下面简单说明下： 1. 首先，非常重要的一点，Protocol不是什么特殊的东西，它就是一个结构体，比如说下面是一个用于存储设备访问的Protocol： ////// This protocol provides control over block devic...
UEFI——protocol服务详解
学习记录
11-16 2436
UEFI protocol 服务详解
UEFI----EFI_DRIVER_BINDING_PROTOCOL
qq_39565589的博客
10-26 2529
UEFI驱动模型的核心是通过EFI_DRIVER_BINDING_PROTOCOL管理驱动程序。UEFI驱动模型包含两个部分：Efi Driver Binding Protocol和驱动服务本身。 UEFI中所有符合UEFI Driver Model的驱动在模块的入口点，都会去安装EFI_DRIVER_BINDING_PROTOCOL；gBS->ConnectController()会去遍历系统中所有的EFI_DRIVER_BINDING_PROTOCOL，并调用其中的Sup...
UEFI Protocol使用
qq_38012639的博客
04-02 4031
uefi Protocol 的调用方法
UEFI open protocol详解
Helping BIOSer become Awesome!
02-28 7161
openProtocol 用于查询指定的Handle中是否支持指定的Protocol,如果支持，则打开Protocol，否则返回错误代码。下面OpenProtocol服务的函数实现。 CoreOpenProtocol(  IN  EFI_HANDLE  UserHandle,  IN  EFI_GUID  *Protocol,  OUT VIOD     **Interface OPTIO
UEFI Protocol
热爱
04-13 637
1、Protocol是服务器端和客户端之间的一种约定，在软件编程上称为接口，服务器端和客户端通过这个约定信息的互通。2、服务器端和客户端在UEFI中都是可执行的二进制文件。3、为了实现这些二进制文件之间的互通，模块双方共同使Protocol进行双方的交互。
UEFI开发探索42 – Protocol的使用1
02-28 1802
(请保留-> 作者: 罗冰) 虽然一直使用各种Protocol来实现需要的程序功能，但对其背后的原理、实现方法，一直都比较模糊。我奉行的是“先用再说”的实用主义，正好周末有点闲暇，探究一下对Protocol理解模糊的地方。 图1 Protocol的构成 如图为Protocol的结构图，摘自于UEFI Spec 2.8 page 45。 我想弄清楚的问题如下： 1) 如何使用Pr...
uefi中如何利用protocol传参数
09-27
UEFI (Unified Extensible Firmware Interface) 是一种用于替代传统BIOS的新一代固件接口标准。在UEFI中，可以利用protocol来传递参数。 Protocol是UEFI中一种用于设备间通信的接口，它定义了一组函数和数据结构，允许UEFI驱动程序之间相互传递信息。 在UEFI中，利用protocol传递参数的一般步骤如下： 1. 首先，需要确定要使用的protocol类型。UEFI定义了多个常用的protocol，例如Simple Text Input Protocol、Simple Text Output Protocol等。 2. 使用EFI_BOOT_SERVICES中的OpenProtocol函数打开目标protocol。该函数接受protocol的GUID作为参数，并返回一个protocol句柄。 3. 使用EFI_BOOT_SERVICES中的HandleProtocol函数获取protocol的指针。该函数接受protocol的句柄和protocol的GUID作为参数，并返回一个指向protocol的指针。 4. 通过protocol的指针，可以访问其中定义的函数和数据结构，从而传递参数。 请注意，具体的使用方法和参数传递方式可能因不同的protocol而异。需要根据具体的需求和文档来使用和传递参数。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值