【UEFI】UEFI Shell下带参数的Application

最新推荐文章于 2023-10-26 19:18:44 发布
最新推荐文章于 2023-10-26 19:18:44 发布
阅读量1.8k 收藏 13
点赞数 4
分类专栏： UEFI 文章标签： uefi
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_36536630/article/details/122005162
版权

目录

1.简述

前几天需要写一个发送数据的Application，要在命令后面加几个数据，所以写了一个demo先测试一下Application中加参数的相关函数。
EDK2版本：edk2-stable/202011（所有代码均基于开源代码）

2.代码

#include <Uefi.h>
#include <Library/UefiLib.h>
#include <Library/ShellLib.h>
#include <Library/ShellCommandLib.h>
#include <Library/DebugLib.h>
STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
  {L"-aa", TypeValue},
  {L"-cc", TypeValue},
  {NULL, TypeMax}
  };
  //临时debug用
// typedef struct {
//   LIST_ENTRY     Link;
//   CHAR16         *Name;
//   SHELL_PARAM_TYPE      Type;
//   CHAR16         *Value;
//   UINTN          OriginalPosition;
// } SHELL_PARAM_PACKAGE;
  //临时debug用
/**
  The user Entry Point for Application. The user code starts with this function
  as the real entry point for the application.
  @param[in] ImageHandle    The firmware allocated handle for the EFI image.
  @param[in] SystemTable    A pointer to the EFI System Table.
  @retval EFI_SUCCESS       The entry point is executed successfully.
  @retval other             Some error occurs when executing this entry point.
**/
EFI_STATUS
EFIAPI
UefiMain (
  IN EFI_HANDLE        ImageHandle,
  IN EFI_SYSTEM_TABLE  *SystemTable
  )
{
  Print(L"Hello,this is Entry of UefiMain!\n");
  EFI_STATUS          Status;
  LIST_ENTRY          *Package;
  CHAR16              *ProblemParam;
  // SHELL_STATUS        ShellStatus;
  // UINT8               Level;
  CONST CHAR16        *ParamAA ;  //?????                     
  CONST CHAR16        *ParamCC ;  
  UINT16            intParamAA = 0;        
  UINT16            intParamCC = 0;
  // Level = PcdGet8(PcdShellSupportLevel);
  ProblemParam        = NULL;
  // ShellStatus         = SHELL_SUCCESS;
  //
  // initialize the shell lib (we must be in non-auto-init...)
  //
  Status = ShellInitialize();
  if (EFI_ERROR(Status)) {
    DEBUG ((EFI_D_INFO, "[ZK] !!!ShellInitialize Fail!,Status :%r.\n", Status));
  }
  Status = CommandInit();
  if (EFI_ERROR(Status)) {
    DEBUG ((EFI_D_INFO, "[ZK] !!!CommandInit Fail!,Status :%r.\n", Status));
  }
  //
  // parse the command line
  //
  Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);
//临时debug
  // ParamAA =  ShellCommandLineGetValue(Package, L"-a");
  // LIST_ENTRY     *Node;
  //  for ( Node = GetFirstNode(Package)
  //     ; !IsNull (Package, Node)
  //     ; Node = GetNextNode(Package, Node)
  //     ){
  //       DEBUG ((EFI_D_INFO, "-------------------------------------------------\n"));
  //       DEBUG ((EFI_D_INFO, "((SHELL_PARAM_PACKAGE*)Node)->Name = %s\n",((SHELL_PARAM_PACKAGE*)Node)->Name));
  //       DEBUG ((EFI_D_INFO, "((SHELL_PARAM_PACKAGE*)Node)->Value = %s\n",((SHELL_PARAM_PACKAGE*)Node)->Value));
  //       DEBUG ((EFI_D_INFO, "((SHELL_PARAM_PACKAGE*)Node)->Type = %d\n",((SHELL_PARAM_PACKAGE*)Node)->Type));
  //       // }
  //     }
 
  //   DEBUG ((EFI_D_INFO, "OVER"));
//临时debug

  
  //如果ShellCommandLineParse失败
  if (EFI_ERROR(Status)) {
    DEBUG ((EFI_D_INFO, "[ZK] !!!ShellCommandLineParse Fail!,Status :%r.\n", Status));
  } else {
    if (ShellCommandLineGetFlag(Package, L"-aa")) { //-a
      ParamAA =  ShellCommandLineGetValue(Package, L"-aa");
      if(ParamAA != NULL){
        DEBUG ((EFI_D_INFO, "ParamAA = %s\n", ParamAA));
        intParamAA = (UINT8)ShellStrToUintn(ParamAA);
      }
    }
    if (ShellCommandLineGetFlag(Package, L"-cc")) { //-b
      ParamCC = ShellCommandLineGetValue(Package, L"-cc");
      if(ParamAA != NULL){
        DEBUG ((EFI_D_INFO, "ParamCC = %s\n", ParamCC));
        intParamCC = (UINT8)ShellStrToUintn(ParamCC);
      }
    }
    // free the command line package
    ShellCommandLineFreeVarList (Package);
  }
  Print(L"intParamAA = %d,intParamCC = %d\n",  intParamAA, intParamCC);
  Print(L"-----------------------------------\n");
  // DEBUG ((EFI_D_INFO, "ParamAA = %s\n", ParamAA));
  // DEBUG ((EFI_D_INFO, "ParamCC = %s\n", ParamCC));
  return EFI_SUCCESS;
}

3.重要数据结构和函数解释

3.1数组 ParamList[]

STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
  {L"-aa", TypeValue},
  {L"-cc", TypeValue},
  {NULL, TypeMax}
  };

ParamList[]数组中："-aa"和"-cc"就是我设置的参数，TypeValue 是指形式如："-aa 1"， "-cc 2"，关于TypeValue 的解释可以在<shelllib.h>中看到，其中的注释也写得非常明白：

typedef enum {
  TypeFlag  = 0,    ///< A flag that is present or not present only (IE "-a").
  TypeValue,        ///< A flag that has some data following it with a space (IE "-a 1").
  TypePosition,     ///< Some data that did not follow a parameter (IE "filename.txt").
  TypeStart,        ///< A flag that has variable value appended to the end (IE "-ad", "-afd", "-adf", etc...).
  TypeDoubleValue,  ///< A flag that has 2 space seperated value data following it (IE "-a 1 2").
  TypeMaxValue,     ///< A flag followed by all the command line data before the next flag.
  TypeTimeValue,    ///< A flag that has a time value following it (IE "-a -5:00").
  TypeMax,
} SHELL_PARAM_TYPE;

3.2函数 CommandInit()和ShellInitialize()

两个初始化函数，要把相关库放到inf文件中，dsc文件也要相应做配置

[LibraryClasses]
  UefiApplicationEntryPoint
  UefiLib
  ShellLib
  DebugLib
  HandleParsingLib
  ShellCommandLib
  IpmiBaseLib

其中 HandleParsingLib这个lib我们其实没用到，是包在ShellCommandLib中的，但是在编译过程中一直报HandleParsingLib这个库"not found"的错误，所以我把它也移到这里了。

3.3函数 ShellCommandLineParse()

这个函数用来解析命令行，有一个宏定义:

#define ShellCommandLineParse(CheckList,CheckPackage,ProblemParam,AutoPageBreak) ShellCommandLineParseEx(CheckList,CheckPackage,ProblemParam,AutoPageBreak,FALSE)

所以看一下函数ShellCommandLineParseEx的声明：

EFI_STATUS
EFIAPI
ShellCommandLineParseEx (
  IN CONST SHELL_PARAM_ITEM     *CheckList,
  OUT LIST_ENTRY                **CheckPackage,
  OUT CHAR16                    **ProblemParam OPTIONAL,
  IN BOOLEAN                    AutoPageBreak,
  IN BOOLEAN                    AlwaysAllowNumbers
  )
{
	...
}

看一下这个函数的参数

参数解释
CheckList这个就是3.1中的数组,存储参数的flag
CheckPackage这里面存的是解析出来的参数
CheckPackage将非CheckList数组中的参数保存到此 ,认为是有问题的参数
AutoPageBreakTRUE
AlwaysAllowNumbers宏中定义设置为了False

3.4函数 ShellCommandLineGetFlag()和ShellCommandLineGetValue()

ShellCommandLineGetFlag用来检查是否有你输入的参数，有就返回True,否则就返回False，比如：

if (ShellCommandLineGetFlag(Package, L"-aa"))

就是判断是否有“-aa”这个Flag出现,出现就返回True

ShellCommandLineGetValue()用来获取某个Flag后面的值，如:
ShellCommandLineGetValue(Package, L"-aa")用来获取"-aa"这个Flag后输入的值。

3.5函数 ShellStrToUintn()

ShellStrToUintn()用于string和Uint的类型转换，返回是UINT64的值，程序里强制转换成了UNIT8

intParamCC = (UINT8)ShellStrToUintn(ParamCC);

4.问题与解决

遇到了一个非常坑爹的问题，本来是打算做一个demo，初始的flag就很随意的设置成了"-a"和"-b"，结果一直报错，我就去看了一下解析出来的CheckPackage里面到底是什么，就有了被注释掉的代码。

 typedef struct {
   LIST_ENTRY     Link;
   CHAR16         *Name;
   SHELL_PARAM_TYPE      Type;
   CHAR16         *Value;
   UINTN          OriginalPosition;
 } SHELL_PARAM_PACKAGE;

这个结构体中就是CheckPackage的结构，"Name"就是Flag,"Value"就是Flag后面跟的值。用如下代码输入打印所有CheckPackage里面的东西：

//临时debug
   ParamAA =  ShellCommandLineGetValue(Package, L"-a");
   LIST_ENTRY     *Node;
    for ( Node = GetFirstNode(Package)
       ; !IsNull (Package, Node)
       ; Node = GetNextNode(Package, Node)
       ){
         DEBUG ((EFI_D_INFO, "-------------------------------------------------\n"));
         DEBUG ((EFI_D_INFO, "((SHELL_PARAM_PACKAGE*)Node)->Name = %s\n",((SHELL_PARAM_PACKAGE*)Node)->Name));
         DEBUG ((EFI_D_INFO, "((SHELL_PARAM_PACKAGE*)Node)->Value = %s\n",((SHELL_PARAM_PACKAGE*)Node)->Value));
         DEBUG ((EFI_D_INFO, "((SHELL_PARAM_PACKAGE*)Node)->Type = %d\n",((SHELL_PARAM_PACKAGE*)Node)->Type));
          }
       }
 
     DEBUG ((EFI_D_INFO, "OVER"));
//临时debug

最后输出的的flag和value根本对不上，我就看了一下，在函数ShellCommandLineParse()的最后中看到了如下code：

  //
  // support for AutoPageBreak
  //
  if (AutoPageBreak && ShellCommandLineGetFlag(*CheckPackage, L"-b")) {
    ShellSetPageBreakMode(TRUE);
  }

AutoPageBreak 我设置的是TRUE，而且我用的flag是"-b"，就是这个导致了最后的输出不对。
所以教训就是：AutoPageBreak 设置为TRUE的时候不要用"-b"的flag，否则结果会很惨。无论你数组ParamList[]里面有没有设置"-b"，都会有"-b"这个flag存在。

5.补充

1.对于函数ShellCommandLineParse()的返回值的判断：

Status = ShellCommandLineParse (ParamList, &Package, &ProblemParam, TRUE);
  //如果ShellCommandLineParse失败
  if (EFI_ERROR(Status)) {
    DEBUG ((EFI_D_INFO, "[ZK] !!!ShellCommandLineParse Fail!,Status :%r.\n", Status));
  } else {
…

ShellCommandLineParse() 这个函数针对不同情况有好几个返回值,看一下注释：

@retval EFI_SUCCESS           The operation completed sucessfully.
  @retval EFI_OUT_OF_RESOURCES  A memory allocation failed.
  @retval EFI_INVALID_PARAMETER A parameter was invalid.
  @retval EFI_VOLUME_CORRUPTED  The command line was corrupt.
  @retval EFI_DEVICE_ERROR      The commands contained 2 opposing arguments.  One
                                of the command line arguments was returned in
                                ProblemParam if provided.
  @retval EFI_NOT_FOUND         A argument required a value that was missing.
                                The invalid command line argument was returned in
                                ProblemParam if provided.

建议是针对不同的返回值做判断，特别是@retval EFI_INVALID_PARAMETER这个返回值，如果你输入的flag是数组ParamList[]中没有的，就会返回这一值。比如我的Flag是"-aa","-cc"，但是如果我在shell下面用的时候输入了"-dd"，这时候就会返回VOLUME_CORRUPTED，而且"-dd"以及后面跟的值会进入到ProblemParam 中，从而可以做判断。

2.数组ParamList[]中的类型一定要对，比如我是"-aa 1"这种就要用TypeValue，你如果是"-a",就要用TypeFlag ，如果混用就会出问题。一旦有问题建议用我注释掉的代码中的方法进行debug，可以看到他解析出来的命令到底是什么，再一步一步找问题所在。

3.许多程序都用到了ShellPrintHiiEx()这个函数，我没有用，因为我所有的信息都通过Print和Debug打印出来了，这个函数应该是一个高级打印函数吧。

6.结果

正常输入结果：
图1 正常输出
从下面图中可以看到:
第二个中我没有设置"-b"这个flag，但是输入-b没有报错,这就是上面提到的问题。
第三个中没有我没有设置"-a"这个flag，所以输入-a会报错。
在这里插入图片描述

参考

1.https://blog.csdn.net/Lq19880521/article/details/112294014
2.源码：edk2-202011\edk2\ShellPkg\Library\UefiShellLevel3CommandsLib\Ver.c

ordinary lemon
关注
  • 4
    点赞
  • 踩
  • 13
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
专栏目录
BBSA NSH脚本作业中实现参数动态解析获取
Bladelogic
11-13 220
前面提到过实现NSH参数动态化执行NSH作业http://bladelogic.iteye.com/blog/1709147，但是当获取的参数较多或者参数复杂时就需要较高级的脚本来实现参数的解析。   1. 首先在脚本中增加参数解析功能   #!/bin/sh ################################################ #author:zhangl...
UEFI shell application example
06-28
UEFI shell application pciio
UEFI-一个带参数的shell app 例程
m0_56151582的博客
03-08 306
带参数shell app 例程
UEFI Application
jason的笔记
05-16 4823
UEFI Application是一种EFI_IMAGE_SUBSYSTEM_EFI_APPLICATION类型的EFI Image。os loader 是一种特殊的application，执行完成后不会return或者exit,相反会调用EFI boot service gBS->ExitBootServices()来将控制权从fireware 传递给os。 下面是一个名为HelloWorld
UEFI原理与编程（三）：UEFI工程模块文件-Shell应用程序工程模块
kaliopensourcextu
04-26 6616
UEFI工程模块文件-Shell应用程序工程模块　　 UEFI标准应用程序工程模块不方便处理命令行参数。但是一般在shell中执行的命令都会带有命令行参数。为了解决这个问题，EDK2提供了Shell应用程序工程模块。
UEFI shell － shell app
C学习
05-29 1402
这个UEFI shell app跟我们平时用的C语言的main函数有点像,支持传参数… 写个例子测试下: PATH: edk2/ShellPkg/Application/TestShellApp/TestShellApp.inf ## @file # This is the shell application # # Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR> # # SPDX-Licens
debian9.13系统uefi启动的uefishell
08-17
本篇将详细探讨"debian9.13系统uefi启动的uefishell"这一主题，以及如何解决在安装过程中遇到的启动问题。 首先，UEFI是一种替代传统BIOS的新型固件接口，它提供了更现代、更安全的启动流程，支持更大的磁盘容量和...
UEFI SHELL ISO
03-24
可以从光盘启动的UEFI SHELL. 在Linux下用以下命令制作：genisoimage -e efibootimg -no-emul-boot -J -R -c boot.catalog \ -hide boot.catalog -hide efibootimg -o /tmp/testcdimage.iso .
UEFI SHELL 引导启动文件
04-06
UEFI Shell是UEFI环境中的一种命令行界面，它允许用户执行各种操作，如加载应用程序、管理磁盘、网络通信等，无需进入操作系统。 在UEFI环境下，引导启动过程通常由以下步骤组成： 1. **启动固件**：计算机加电后...
UEFI Shell Specification.rar
09-03
这个压缩包“UEFI Shell Specification.rar”很可能包含了详细的文档，阐述了UEFI Shell的工作原理、命令语法以及如何在UEFI环境下使用Shell。 UEFI Shell是一个基于UEFI标准的命令行工具，它允许用户和开发者在...
UEFI Shell Spec 2.1(pdf)
12-10
UEFI（统一可扩展固件接口）Shell 规范2.1是针对计算机硬件启动过程中的用户界面和命令行工具的一个标准。这个规范定义了一个API（应用程序编程接口），一个命令提示符，以及一系列丰富的命令，旨在增强UEFI Shell的...
EFI和EFI Shell命令简介
热门推荐
没事就写点
01-26 3万+
EFI是ExtensibleFirmware Interface的缩写，是介于平台固件和操作系统之间的一层软件接口。EFI是Intel在1998年开始的一个项目演变而来，而在2005年Intel将EFI 1.10开源并交由Unified EFI开源社区去维护和开发，Intel自己的EFI也就不单独做了，都和开源社区共用一个。现在也通常用EFI来代指UEFI，二者不再有意区分。 EFI Shell
UEFI Shell脚本语法
最新发布
echo_heart_echo_soul的博客
10-26 1153
命令 [参数1] [参数2] #参数为可选项注释 : 脚本内#后面内容标识注释。命令行参数 ： 执行脚本时可以带命令行参数，最多可以带10个参数。在脚本中%n可以获得第n个参数。环境变量 : 在脚本中%var%获得环境变量var的值。脚本返回值 : 脚本结束时可通过Exit命令设置返回值。`exit [/b] [exit-code]` # /b 和 exit-code是可选项`exit /b` #表示退出当前脚本；exit 则退出UEFI shell。
Windows CE .NET 和可扩展固件接口 (EFI)
neo_liukun的专栏
09-02 770
什么是 EFI？ 如果回想一下 DOS 编程的时代，您可能还记得使用软件中断进行 BIOS 调用。PC BIOS 是 PC 硬件的低级别抽象，这种方式提供了从显示 ASCII 字符到 RS-232 I/O 等范围广泛的服务。在此后的十年或更长时间里，在 PC BIOS 的体系结
【UEFI/BIOS】UEFI Shell Command （UEFI Shell 命令）篇目一
weixin_45258382的博客
03-03 1万+
显示系统、I/O寄存器、PCI/PCIe配置空间或设备内存的内容。如果不指定-MMIO/IO/PCI/PCIE，则显示系统主内存（volatile或persistent）。显示SMBIOS信息。显示或修改I/O寄存器、内存内容或PCI/PCIe配置空间。显示PCI设备列表，或PCI功能配置空间和PCIe扩展配置空间。显示系统、I/O寄存器、PCI/PCIe配置空间或设备内存的内容。显示PCI设备列表，或PCI功能配置空间和PCIe扩展配置空间。显示或修改MEM/MMIO/IO/PCI/PCIE地址空间。
UEFI shell控制台向.efi文件传入参数--通过protocol实现
一条咸鱼的博客
08-19 2848
目标 通过控制台传入的参数为：         Argc，传入参数的个数；         Argv，存放参数字符串的字符指针数组。各参数保存为字符串，数组元素为字符串指针； /// Parsed arg list converted more C-like format. /// CHAR16 **Argv; UINTN ...
【UEFI基础】UEFI Shell
jiangwei0512的博客
03-29 2万+
【UEFI基础】UEFI Shell。
UEFI-建立属于自己的Application和library
qq_44224593的博客
09-09 1767
为了能更好的理解code编译过程，我们可以通过学习操作如何进行自建并自用library去更好的理解code的编译过程： 在建立library之前，首先要写一个属于自己的Application，这样才能在Application里面调用到自己的library： （1）. 在edk2的随便一个文件夹下创建一个文件夹，名称则是你的Application的名称，文件夹里面有最基本的文件（.inf和.c）。 （2）.在.c文件中写上最基本的print（helloworld）和print相关的包和库： #incl
命令 shell_编写自己的 Shell 命令（下）
weixin_35779309的博客
01-14 387
有些时候，我们编写的 EFI 程序不希望有人改动，这个时候就可以考虑将程序“藏”到 Shell 中。本文就实验将 RU.EFI 编译到 Shell 中。为了更好的理解本文的方案，最好先阅读理解前介绍过的如何将一个 EFI 程序包含在另外的 EFI中运行的方法【参考1】。具体方法是将下面的代码直接插入上一篇的 lzc.c 中： // // print it... ...
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值