/** Do the configuration in an environment without HII. @param[in] Language The language code. @param[in] ForceDefaults TRUE to force defaults, FALSE otherwise. @param[in] DefaultType If ForceDefaults is TRUE, specifies the default type. @param[in] AllChildren TRUE to configure all children, FALSE otherwise. @param[in] ValidateOptions TRUE to validate existing options, FALSE otherwise. @param[in] SetOptions TRUE to set options, FALSE otherwise. @param[in] DriverImageHandle The handle for the driver to configure. @param[in] DeviceHandle The handle of the device being managed by the Driver specified. @param[in] ChildHandle The handle of a child device of the specified device. @retval SHELL_NOT_FOUND A specified handle could not be found. @retval SHELL_INVALID_PARAMETER A parameter has a invalid value. **/ SHELL_STATUS EFIAPI PreHiiDrvCfg ( IN CONST CHAR8 *Language, IN BOOLEAN ForceDefaults, IN UINT32 DefaultType, IN BOOLEAN AllChildren, IN BOOLEAN ValidateOptions, IN BOOLEAN SetOptions, IN EFI_HANDLE DriverImageHandle, IN EFI_HANDLE DeviceHandle, IN EFI_HANDLE ChildHandle ) { EFI_STATUS Status; SHELL_STATUS ShellStatus; UINTN OuterLoopCounter; CHAR8 *BestLanguage; UINTN DriverImageHandleCount; EFI_HANDLE *DriverImageHandleBuffer; UINTN HandleCount; EFI_HANDLE *HandleBuffer; UINTN *HandleType; UINTN LoopCounter; UINTN ChildIndex; UINTN ChildHandleCount; EFI_HANDLE *ChildHandleBuffer; UINTN *ChildHandleType; EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED ActionRequired; EFI_DRIVER_CONFIGURATION_PROTOCOL *DriverConfiguration; BOOLEAN Iso639Language; UINTN HandleIndex1; UINTN HandleIndex2; UINTN HandleIndex3; ShellStatus = SHELL_SUCCESS; if (ChildHandle == NULL && AllChildren) { SetOptions = FALSE; } if (ForceDefaults) { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_FORCE_D), gShellDriver1HiiHandle, DefaultType); } else if (ValidateOptions) { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_VALIDATE), gShellDriver1HiiHandle); } else if (SetOptions) { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_SET), gShellDriver1HiiHandle); } if (DriverImageHandle == 0) { DriverImageHandleBuffer = GetHandleListByProtocolList(CfgGuidList); if (DriverImageHandleBuffer == NULL) { ShellStatus = SHELL_NOT_FOUND; goto Done; } for ( HandleBuffer = DriverImageHandleBuffer, DriverImageHandleCount = 0 ; HandleBuffer != NULL && *HandleBuffer != NULL ; HandleBuffer++,DriverImageHandleCount++); } else { DriverImageHandleCount = 1; // // Allocate buffer to hold the image handle so as to // keep consistent with the above clause // DriverImageHandleBuffer = AllocatePool (sizeof (EFI_HANDLE)); ASSERT (DriverImageHandleBuffer); DriverImageHandleBuffer[0] = DriverImageHandle; } for (OuterLoopCounter = 0; OuterLoopCounter < DriverImageHandleCount; OuterLoopCounter++) { Iso639Language = FALSE; Status = gBS->OpenProtocol ( DriverImageHandleBuffer[OuterLoopCounter], &gEfiDriverConfiguration2ProtocolGuid, (VOID **) &DriverConfiguration, NULL, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL ); if (EFI_ERROR (Status)) { Iso639Language = TRUE; Status = gBS->OpenProtocol ( DriverImageHandleBuffer[OuterLoopCounter], &gEfiDriverConfigurationProtocolGuid, (VOID **) &DriverConfiguration, NULL, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL ); } if (EFI_ERROR (Status)) { // ShellPrintHiiEx( // -1, // -1, // NULL, // STRING_TOKEN (STR_DRVCFG_NOT_SUPPORT), // gShellDriver1HiiHandle, // ConvertHandleToHandleIndex (DriverImageHandleBuffer[OuterLoopCounter]) // ); ShellStatus = SHELL_UNSUPPORTED; continue; } BestLanguage = GetBestLanguage ( DriverConfiguration->SupportedLanguages, Iso639Language, Language!=NULL?Language:"", DriverConfiguration->SupportedLanguages, NULL ); if (BestLanguage == NULL) { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM_VAL), gShellDriver1HiiHandle, L"-l" ); ShellStatus = SHELL_INVALID_PARAMETER; continue; } Status = ParseHandleDatabaseByRelationshipWithType ( DriverImageHandleBuffer[OuterLoopCounter], NULL, &HandleCount, &HandleBuffer, &HandleType ); if (EFI_ERROR (Status)) { continue; } if (SetOptions && DeviceHandle == NULL) { gST->ConOut->ClearScreen (gST->ConOut); Status = DriverConfiguration->SetOptions ( DriverConfiguration, NULL, NULL, BestLanguage, &ActionRequired ); gST->ConOut->ClearScreen (gST->ConOut); ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_ALL_LANG), gShellDriver1HiiHandle, ConvertHandleToHandleIndex (DriverImageHandleBuffer[OuterLoopCounter]), DriverConfiguration->SupportedLanguages ); if (!EFI_ERROR (Status)) { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_OPTIONS_SET), gShellDriver1HiiHandle); for (LoopCounter = 0; LoopCounter < HandleCount; LoopCounter++) { if ((HandleType[LoopCounter] & HR_CONTROLLER_HANDLE) == HR_CONTROLLER_HANDLE) { ShellCmdDriverConfigurationProcessActionRequired ( DriverImageHandleBuffer[OuterLoopCounter], HandleBuffer[LoopCounter], NULL, ActionRequired ); } } } else { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_NOT_SET), gShellDriver1HiiHandle, Status); } continue; } for (LoopCounter = 0; LoopCounter < HandleCount; LoopCounter++) { if ((HandleType[LoopCounter] & HR_CONTROLLER_HANDLE) != HR_CONTROLLER_HANDLE) { continue; } if (DeviceHandle != NULL && DeviceHandle != HandleBuffer[LoopCounter]) { continue; } if (ChildHandle == NULL) { HandleIndex1 = ConvertHandleToHandleIndex (DriverImageHandleBuffer[OuterLoopCounter]); HandleIndex2 = ConvertHandleToHandleIndex (HandleBuffer[LoopCounter]); ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_CTRL_LANG), gShellDriver1HiiHandle, HandleIndex1, HandleIndex2, DriverConfiguration->SupportedLanguages ); if (ForceDefaults) { Status = DriverConfiguration->ForceDefaults ( DriverConfiguration, HandleBuffer[LoopCounter], NULL, DefaultType, &ActionRequired ); if (!EFI_ERROR (Status)) { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_DEF_FORCED), gShellDriver1HiiHandle); ShellCmdDriverConfigurationProcessActionRequired ( DriverImageHandleBuffer[OuterLoopCounter], HandleBuffer[LoopCounter], NULL, ActionRequired ); } else { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_FORCE_FAILED), gShellDriver1HiiHandle, Status); ShellStatus = SHELL_DEVICE_ERROR; } } else if (ValidateOptions) { Status = DriverConfiguration->OptionsValid ( DriverConfiguration, HandleBuffer[LoopCounter], NULL ); if (!EFI_ERROR (Status)) { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_OPTIONS_VALID), gShellDriver1HiiHandle); } else { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_OPTIONS_INV), gShellDriver1HiiHandle, Status); ShellStatus = SHELL_DEVICE_ERROR; } } else if (SetOptions) { gST->ConOut->ClearScreen (gST->ConOut); Status = DriverConfiguration->SetOptions ( DriverConfiguration, HandleBuffer[LoopCounter], NULL, BestLanguage, &ActionRequired ); gST->ConOut->ClearScreen (gST->ConOut); HandleIndex1 = ConvertHandleToHandleIndex (DriverImageHandleBuffer[OuterLoopCounter]); HandleIndex2 = ConvertHandleToHandleIndex (HandleBuffer[LoopCounter]); ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_CTRL_LANG), gShellDriver1HiiHandle, HandleIndex1, HandleIndex2, DriverConfiguration->SupportedLanguages ); if (!EFI_ERROR (Status)) { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_OPTIONS_SET), gShellDriver1HiiHandle); ShellCmdDriverConfigurationProcessActionRequired ( DriverImageHandleBuffer[OuterLoopCounter], HandleBuffer[LoopCounter], NULL, ActionRequired ); } else { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_NOT_SET), gShellDriver1HiiHandle, Status); ShellStatus = SHELL_DEVICE_ERROR; } } else { Print (L"\n"); } } if (ChildHandle == NULL && !AllChildren) { continue; } Status = ParseHandleDatabaseByRelationshipWithType ( DriverImageHandleBuffer[OuterLoopCounter], HandleBuffer[LoopCounter], &ChildHandleCount, &ChildHandleBuffer, &ChildHandleType ); if (EFI_ERROR (Status)) { continue; } for (ChildIndex = 0; ChildIndex < ChildHandleCount; ChildIndex++) { if ((ChildHandleType[ChildIndex] & HR_CHILD_HANDLE) != HR_CHILD_HANDLE) { continue; } if (ChildHandle != NULL && ChildHandle != ChildHandleBuffer[ChildIndex]) { continue; } HandleIndex1 = ConvertHandleToHandleIndex (DriverImageHandleBuffer[OuterLoopCounter]); HandleIndex2 = ConvertHandleToHandleIndex (HandleBuffer[LoopCounter]); HandleIndex3 = ConvertHandleToHandleIndex (ChildHandleBuffer[ChildIndex]); ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_CHILD_LANG), gShellDriver1HiiHandle, HandleIndex1, HandleIndex2, HandleIndex3, DriverConfiguration->SupportedLanguages); if (ForceDefaults) { Status = DriverConfiguration->ForceDefaults ( DriverConfiguration, HandleBuffer[LoopCounter], ChildHandleBuffer[ChildIndex], DefaultType, &ActionRequired ); if (!EFI_ERROR (Status)) { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_DEF_FORCED), gShellDriver1HiiHandle); ShellCmdDriverConfigurationProcessActionRequired ( DriverImageHandleBuffer[OuterLoopCounter], HandleBuffer[LoopCounter], ChildHandleBuffer[ChildIndex], ActionRequired ); } else { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_FORCE_FAILED), gShellDriver1HiiHandle, Status); ShellStatus = SHELL_DEVICE_ERROR; } } else if (ValidateOptions) { Status = DriverConfiguration->OptionsValid ( DriverConfiguration, HandleBuffer[LoopCounter], ChildHandleBuffer[ChildIndex] ); if (!EFI_ERROR (Status)) { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_OPTIONS_VALID), gShellDriver1HiiHandle); } else { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_OPTIONS_INV), gShellDriver1HiiHandle, Status); ShellStatus = SHELL_DEVICE_ERROR; } } else if (SetOptions) { gST->ConOut->ClearScreen (gST->ConOut); Status = DriverConfiguration->SetOptions ( DriverConfiguration, HandleBuffer[LoopCounter], ChildHandleBuffer[ChildIndex], BestLanguage, &ActionRequired ); gST->ConOut->ClearScreen (gST->ConOut); HandleIndex1 = ConvertHandleToHandleIndex (DriverImageHandleBuffer[OuterLoopCounter]); HandleIndex2 = ConvertHandleToHandleIndex (HandleBuffer[LoopCounter]); HandleIndex3 = ConvertHandleToHandleIndex (ChildHandleBuffer[ChildIndex]); ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_CHILD_LANG), gShellDriver1HiiHandle, HandleIndex1, HandleIndex2, HandleIndex3, DriverConfiguration->SupportedLanguages ); if (!EFI_ERROR (Status)) { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_OPTIONS_SET), gShellDriver1HiiHandle); ShellCmdDriverConfigurationProcessActionRequired ( DriverImageHandleBuffer[OuterLoopCounter], HandleBuffer[LoopCounter], ChildHandleBuffer[ChildIndex], ActionRequired ); } else { ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRVCFG_NOT_SET), gShellDriver1HiiHandle, Status); ShellStatus = SHELL_DEVICE_ERROR; } } else { Print (L"\n"); } } FreePool (ChildHandleBuffer); FreePool (ChildHandleType); } FreePool (BestLanguage); FreePool (HandleBuffer); FreePool (HandleType); } if (DriverImageHandle != NULL && DriverImageHandleCount != 0) { FreePool (DriverImageHandleBuffer); } Done: return ShellStatus; }
/** Do the diagnostics call for some set of handles. @param[in] Mode The type of diagnostic test to run. @param[in] Lang The language code to use. @param[in] AllChilds Should the test be on all children. @param[in] DriverHandle The driver handle to test with. @param[in] ControllerHandle The specific controller handle to test. @param[in] ChildHandle The specific child handle to test. @retval EFI_SUCCESS The operation was successful. @retval EFI_INVALID_PARAMETER A parameter had an invalid value. @retval EFI_NOT_FOUND No diagnostic handle could be found. **/ EFI_STATUS EFIAPI DoDiagnostics ( IN CONST DRV_DIAG_TEST_MODE Mode, IN CONST CHAR8 *Lang, IN CONST BOOLEAN AllChilds, IN CONST EFI_HANDLE DriverHandle, IN CONST EFI_HANDLE ControllerHandle, IN CONST EFI_HANDLE ChildHandle ) { EFI_DRIVER_DIAGNOSTICS_PROTOCOL *DriverDiagnostics; EFI_DRIVER_DIAGNOSTICS2_PROTOCOL *DriverDiagnostics2; EFI_HANDLE *DriverHandleList; EFI_HANDLE *ControllerHandleList; EFI_HANDLE *ChildHandleList; EFI_HANDLE *Walker; UINTN DriverHandleListCount; UINTN ControllerHandleListCount; UINTN ChildHandleListCount; UINTN DriverHandleListLoop; UINTN ControllerHandleListLoop; UINTN ChildHandleListLoop; EFI_STATUS Status; EFI_STATUS Status2; EFI_GUID *ErrorType; UINTN OutBufferSize; CHAR16 *OutBuffer; UINTN HandleIndex1; UINTN HandleIndex2; CHAR8 *Language; BOOLEAN Found; if ((ChildHandle != NULL && AllChilds) || (Mode >= TestModeMax)){ return (EFI_INVALID_PARAMETER); } DriverDiagnostics = NULL; DriverDiagnostics2 = NULL; Status = EFI_SUCCESS; Status2 = EFI_SUCCESS; DriverHandleList = NULL; ControllerHandleList = NULL; ChildHandleList = NULL; Language = NULL; OutBuffer = NULL; ErrorType = NULL; DriverHandleListCount = 0; ControllerHandleListCount = 0; ChildHandleListCount = 0; if (DriverHandle != NULL) { DriverHandleList = AllocateZeroPool(2*sizeof(EFI_HANDLE)); ASSERT(DriverHandleList!=NULL); DriverHandleList[0] = DriverHandle; DriverHandleListCount = 1; } else { DriverHandleList = GetHandleListByProtocolList(DiagGuidList); if (DriverHandleList == NULL) { ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROTOCOL_NF), gShellDriver1HiiHandle, L"gEfiDriverDiagnosticsProtocolGuid", &gEfiDriverDiagnosticsProtocolGuid); ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROTOCOL_NF), gShellDriver1HiiHandle, L"gEfiDriverDiagnostics2ProtocolGuid", &gEfiDriverDiagnostics2ProtocolGuid); return (EFI_NOT_FOUND); } for (Walker = DriverHandleList ; Walker != NULL && *Walker != NULL ; DriverHandleListCount++, Walker++); } if (ControllerHandle != NULL) { ControllerHandleList = AllocateZeroPool(2*sizeof(EFI_HANDLE)); ASSERT(ControllerHandleList!=NULL); ControllerHandleList[0] = ControllerHandle; ControllerHandleListCount = 1; } else { ControllerHandleList = NULL; } if (ChildHandle != NULL) { ChildHandleList = AllocateZeroPool(2*sizeof(EFI_HANDLE)); ASSERT(ChildHandleList!=NULL); ChildHandleList[0] = ChildHandle; ChildHandleListCount = 1; } else if (AllChilds) { ChildHandleList = NULL; // // This gets handled in the loop below. // } else { ChildHandleList = NULL; } if (Mode == TestModeList) { ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_DRVDIAG_HEADER), gShellDriver1HiiHandle); } for (DriverHandleListLoop = 0 ; DriverHandleListLoop < DriverHandleListCount ; DriverHandleListLoop++ ){ if (Mode == TestModeList) { ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_DRVDIAG_DRIVER_HEADER), gShellDriver1HiiHandle, ConvertHandleToHandleIndex(DriverHandleList[DriverHandleListLoop])); } if (ControllerHandle == NULL) { PARSE_HANDLE_DATABASE_DEVICES(DriverHandleList[DriverHandleListLoop], &ControllerHandleListCount, &ControllerHandleList); } if (ControllerHandleListCount == 0) { if (Mode == TestModeList) { ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_DRVDIAG_DRIVER_NO_HANDLES), gShellDriver1HiiHandle); } } else { if (Mode == TestModeList) { ShellPrintEx(-1, -1, L"\r\n"); } for (ControllerHandleListLoop = 0 ; ControllerHandleListLoop < ControllerHandleListCount ; ControllerHandleListLoop++ ){ if (AllChilds) { ASSERT(ChildHandleList == NULL); PARSE_HANDLE_DATABASE_MANAGED_CHILDREN( DriverHandleList[DriverHandleListLoop], ControllerHandleList[ControllerHandleListLoop], &ChildHandleListCount, &ChildHandleList); } for (ChildHandleListLoop = 0 ; (ChildHandleListLoop < ChildHandleListCount || ChildHandleList == NULL) ; ChildHandleListLoop++ ){ Found = FALSE; if (Mode != TestModeList) { if (Lang == NULL || Lang[2] == '-') { // // Get the protocol pointer and call the function // Status = gBS->OpenProtocol( DriverHandleList[DriverHandleListLoop], &gEfiDriverDiagnostics2ProtocolGuid, (VOID**)&DriverDiagnostics2, gImageHandle, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL); if (!EFI_ERROR(Status) && (DriverDiagnostics2 != NULL)) { Language = GetBestLanguageForDriver(DriverDiagnostics2->SupportedLanguages, Lang, FALSE); Found = TRUE; Status = DriverDiagnostics2->RunDiagnostics( DriverDiagnostics2, ControllerHandleList[ControllerHandleListLoop], ChildHandleList == NULL?NULL:ChildHandleList[ChildHandleListLoop], (EFI_DRIVER_DIAGNOSTIC_TYPE)Mode, Language, &ErrorType, &OutBufferSize, &OutBuffer); FreePool(Language); } } if (!Found && (Lang == NULL||(Lang!=NULL&&(Lang[2]!='-')))){ Status = gBS->OpenProtocol( DriverHandleList[DriverHandleListLoop], &gEfiDriverDiagnosticsProtocolGuid, (VOID**)&DriverDiagnostics, gImageHandle, NULL, EFI_OPEN_PROTOCOL_GET_PROTOCOL); if (!EFI_ERROR(Status)) { Language = GetBestLanguageForDriver(DriverDiagnostics->SupportedLanguages, Lang, FALSE); Status = DriverDiagnostics->RunDiagnostics( DriverDiagnostics, ControllerHandleList[ControllerHandleListLoop], ChildHandleList == NULL?NULL:ChildHandleList[ChildHandleListLoop], (EFI_DRIVER_DIAGNOSTIC_TYPE)Mode, Language, &ErrorType, &OutBufferSize, &OutBuffer); FreePool(Language); } } if (EFI_ERROR(Status)) { Status2 = Status; } HandleIndex1 = ConvertHandleToHandleIndex(DriverHandleList[DriverHandleListLoop]); HandleIndex2 = ConvertHandleToHandleIndex(ControllerHandleList[ControllerHandleListLoop]); ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_3P_RESULT), gShellDriver1HiiHandle, L"DrvDiag", HandleIndex1, HandleIndex2, ChildHandleList == NULL?0:ConvertHandleToHandleIndex(ChildHandleList[ChildHandleListLoop]), Status); if (OutBuffer!=NULL) { FreePool(OutBuffer); OutBuffer = NULL; } if (ErrorType!=NULL) { FreePool(ErrorType); ErrorType = NULL; } } else { HandleIndex1 = ConvertHandleToHandleIndex(DriverHandleList[DriverHandleListLoop]); HandleIndex2 = ConvertHandleToHandleIndex(ControllerHandleList[ControllerHandleListLoop]); // // Print out the information that this set can be tested // ShellPrintHiiEx( -1, -1, NULL, STRING_TOKEN (STR_DRV_DIAG_ITEM_LINE), gShellDriver1HiiHandle, HandleIndex1, HandleIndex2, ChildHandleList == NULL?0:ConvertHandleToHandleIndex(ChildHandleList[ChildHandleListLoop]) ); } // // If we are doing a single pass with NULL child jump out after a single loop // if (ChildHandleList == NULL) { break; } } if (AllChilds) { SHELL_FREE_NON_NULL(ChildHandleList); ChildHandleList = NULL; ChildHandleListCount = 0; } } if (ControllerHandle == NULL) { SHELL_FREE_NON_NULL(ControllerHandleList); ControllerHandleList = NULL; ControllerHandleListCount = 0; } } } if (DriverHandleList != NULL) { FreePool(DriverHandleList); } if (ControllerHandleList != NULL) { FreePool(ControllerHandleList); } if (ChildHandleList != NULL) { FreePool(ChildHandleList); } return (Status2); }