├── QEMU_UEFI ├── Mapped_Drive │ ├── patch.nsh │ └── HelloWorld.efi ├── OVMF_CODE.fd ├── OVMF_VARS.fd └── run_qemu.bat ├── Archive ├── SeaChest_EFI.zip └── GoldenKeySecureBoot.zip ├── Examples ├── LOLINSTALL │ ├── Example_Realtek │ │ ├── setup.exe │ │ └── AutoInst.exe │ └── Example_Microsoft │ │ ├── setup.exe │ │ └── x64 │ │ └── setup.exe ├── Signed_UEFI_Shell │ ├── EFI_ROOT_CPSD │ │ └── EFI │ │ │ ├── BOOT │ │ │ └── BootX64.efi │ │ │ └── CPSD │ │ │ └── Bootxsa.efi │ ├── EFI_ROOT_EUROSOFT │ │ └── EFI │ │ │ └── BOOT │ │ │ ├── Bootx64.efi │ │ │ └── esdiags.efi │ └── EFI_ROOT_Example_UEFISHELL_Dell_Latitude_5520 │ │ ├── patch.nsh │ │ ├── HelloWorld.efi │ │ ├── EFI │ │ └── BOOT │ │ │ ├── Bootx64.efi │ │ │ └── esdiags.efi │ │ └── readme.md └── Signed_Bootloader │ ├── Silent_Execution_Example │ ├── ShellX64.efi │ ├── efi │ │ └── boot │ │ │ ├── shdmgr.ef_ │ │ │ └── BOOTX64.EFI │ └── startup.nsh │ └── EFI_NewHorizonDatasys │ └── EFI │ └── BOOT │ ├── shdmgr.ef_ │ └── bootx64.efi ├── SLIDES FINAL DEFCON30 One Bootloader To Load Them All.pdf ├── UnSB ├── README.md ├── UnSB.dec ├── .gitignore ├── UnSB │ ├── UnSB.inf │ ├── UnSB.h │ ├── SimpleTextOutput.h │ ├── DriverBinding.h │ ├── SimpleTextOutput.c │ └── UnSB.c └── UnSB.dsc ├── README.md └── LICENSE /QEMU_UEFI/Mapped_Drive/patch.nsh: -------------------------------------------------------------------------------- 1 | mm 0x3F2c57a8 0xc3c03148 -w 8 -MEM 2 | mm 0x3F2c57e8 0xc3c03148 -w 8 -MEM -------------------------------------------------------------------------------- /QEMU_UEFI/OVMF_CODE.fd: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/QEMU_UEFI/OVMF_CODE.fd -------------------------------------------------------------------------------- /QEMU_UEFI/OVMF_VARS.fd: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/QEMU_UEFI/OVMF_VARS.fd -------------------------------------------------------------------------------- /Archive/SeaChest_EFI.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Archive/SeaChest_EFI.zip -------------------------------------------------------------------------------- /Archive/GoldenKeySecureBoot.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Archive/GoldenKeySecureBoot.zip -------------------------------------------------------------------------------- /QEMU_UEFI/Mapped_Drive/HelloWorld.efi: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/QEMU_UEFI/Mapped_Drive/HelloWorld.efi -------------------------------------------------------------------------------- /Examples/LOLINSTALL/Example_Realtek/setup.exe: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Examples/LOLINSTALL/Example_Realtek/setup.exe -------------------------------------------------------------------------------- /Examples/LOLINSTALL/Example_Microsoft/setup.exe: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Examples/LOLINSTALL/Example_Microsoft/setup.exe -------------------------------------------------------------------------------- /Examples/LOLINSTALL/Example_Realtek/AutoInst.exe: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Examples/LOLINSTALL/Example_Realtek/AutoInst.exe -------------------------------------------------------------------------------- /Examples/LOLINSTALL/Example_Microsoft/x64/setup.exe: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Examples/LOLINSTALL/Example_Microsoft/x64/setup.exe -------------------------------------------------------------------------------- /SLIDES FINAL DEFCON30 One Bootloader To Load Them All.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/SLIDES FINAL DEFCON30 One Bootloader To Load Them All.pdf -------------------------------------------------------------------------------- /UnSB/README.md: -------------------------------------------------------------------------------- 1 | # UnSB 2 | 3 | Un-Secure Boot 4 | 5 | Example code for a UEFI application to patch SecurityArch and Security2Arch protocols. 6 | More information can be found in our talk. 7 | -------------------------------------------------------------------------------- /Examples/Signed_UEFI_Shell/EFI_ROOT_CPSD/EFI/BOOT/BootX64.efi: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Examples/Signed_UEFI_Shell/EFI_ROOT_CPSD/EFI/BOOT/BootX64.efi -------------------------------------------------------------------------------- /Examples/Signed_UEFI_Shell/EFI_ROOT_CPSD/EFI/CPSD/Bootxsa.efi: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Examples/Signed_UEFI_Shell/EFI_ROOT_CPSD/EFI/CPSD/Bootxsa.efi -------------------------------------------------------------------------------- /Examples/Signed_Bootloader/Silent_Execution_Example/ShellX64.efi: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Examples/Signed_Bootloader/Silent_Execution_Example/ShellX64.efi -------------------------------------------------------------------------------- /Examples/Signed_UEFI_Shell/EFI_ROOT_EUROSOFT/EFI/BOOT/Bootx64.efi: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Examples/Signed_UEFI_Shell/EFI_ROOT_EUROSOFT/EFI/BOOT/Bootx64.efi -------------------------------------------------------------------------------- /Examples/Signed_UEFI_Shell/EFI_ROOT_EUROSOFT/EFI/BOOT/esdiags.efi: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Examples/Signed_UEFI_Shell/EFI_ROOT_EUROSOFT/EFI/BOOT/esdiags.efi -------------------------------------------------------------------------------- /Examples/Signed_Bootloader/EFI_NewHorizonDatasys/EFI/BOOT/shdmgr.ef_: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Examples/Signed_Bootloader/EFI_NewHorizonDatasys/EFI/BOOT/shdmgr.ef_ -------------------------------------------------------------------------------- /Examples/Signed_Bootloader/EFI_NewHorizonDatasys/EFI/BOOT/bootx64.efi: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Examples/Signed_Bootloader/EFI_NewHorizonDatasys/EFI/BOOT/bootx64.efi -------------------------------------------------------------------------------- /Examples/Signed_Bootloader/Silent_Execution_Example/efi/boot/shdmgr.ef_: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Examples/Signed_Bootloader/Silent_Execution_Example/efi/boot/shdmgr.ef_ -------------------------------------------------------------------------------- /Examples/Signed_Bootloader/Silent_Execution_Example/efi/boot/BOOTX64.EFI: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Examples/Signed_Bootloader/Silent_Execution_Example/efi/boot/BOOTX64.EFI -------------------------------------------------------------------------------- /Examples/Signed_UEFI_Shell/EFI_ROOT_Example_UEFISHELL_Dell_Latitude_5520/patch.nsh: -------------------------------------------------------------------------------- 1 | echo -off 2 | mm 5F21C610 c3c03148 -w 4 -mem 3 | mm 5F21C650 c3c03148 -w 4 -mem 4 | echo "Patch complete! Execute any unsigned code you'd like!" 5 | echo -on -------------------------------------------------------------------------------- /Examples/Signed_UEFI_Shell/EFI_ROOT_Example_UEFISHELL_Dell_Latitude_5520/HelloWorld.efi: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Examples/Signed_UEFI_Shell/EFI_ROOT_Example_UEFISHELL_Dell_Latitude_5520/HelloWorld.efi -------------------------------------------------------------------------------- /Examples/Signed_UEFI_Shell/EFI_ROOT_Example_UEFISHELL_Dell_Latitude_5520/EFI/BOOT/Bootx64.efi: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Examples/Signed_UEFI_Shell/EFI_ROOT_Example_UEFISHELL_Dell_Latitude_5520/EFI/BOOT/Bootx64.efi -------------------------------------------------------------------------------- /Examples/Signed_UEFI_Shell/EFI_ROOT_Example_UEFISHELL_Dell_Latitude_5520/EFI/BOOT/esdiags.efi: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/HackingThings/OneBootloaderToLoadThemAll/HEAD/Examples/Signed_UEFI_Shell/EFI_ROOT_Example_UEFISHELL_Dell_Latitude_5520/EFI/BOOT/esdiags.efi -------------------------------------------------------------------------------- /QEMU_UEFI/run_qemu.bat: -------------------------------------------------------------------------------- 1 | qemu-system-x86_64 -machine q35 -drive file=OVMF_CODE.fd,if=pflash,format=raw,unit=0,readonly=on -drive file=OVMF_VARS.fd,if=pflash,format=raw,unit=1 -serial mon:stdio -m 1G -net none -vga std -usbdevice tablet -drive file=fat:rw:.\Mapped_Drive,media=disk,if=virtio,format=raw -------------------------------------------------------------------------------- /UnSB/UnSB.dec: -------------------------------------------------------------------------------- 1 | [Defines] 2 | DEC_SPECIFICATION = 1.27 3 | PACKAGE_NAME = UnSB 4 | PACKAGE_GUID = fb0f0f80-9bef-11ec-9b68-000c29890ae5 5 | PACKAGE_VERSION = 1.00 6 | 7 | [Guids.common] 8 | gEfiSecurityPkgTokenSpaceGuid = { 0xd3fb176, 0x9569, 0x4d51, { 0xa3, 0xef, 0x7d, 0x61, 0xc6, 0x4f, 0xea, 0xba }} 9 | 10 | -------------------------------------------------------------------------------- /Examples/Signed_Bootloader/Silent_Execution_Example/startup.nsh: -------------------------------------------------------------------------------- 1 | echo -off 2 | for %i run (0 9) 3 | if exist fs%i:\efi\microsoft\boot\bootmgfw.efi then 4 | fs%i:\efi\microsoft\boot\bootmgfw.efi 5 | endif 6 | endfor 7 | 8 | for %j in A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 9 | if exist fs%j:\efi\microsoft\boot\bootmgfw.efi then 10 | fs%j:\efi\microsoft\boot\bootmgfw.efi 11 | endif 12 | endfor 13 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # OneBootloaderToLoadThemAll 2 | One Bootloader to Load Them All - Research materials, Code , Etc. 3 | 4 | This repository contains as much information as possible to help in understanding the issues we found. 5 | We also included an OVMF image for you to run with QEMU and practice without risking any "live" system. 6 | 7 | ## NOTE! 8 | Playing with bootloaders on your own or any other system can lead to it failing to boot. 9 | 10 | # THIS REPOSITORY AND ITS CONTENTS ARE FOR EDUCATIONAL PURPOSES ONLY. 11 | 12 | -------------------------------------------------------------------------------- /UnSB/.gitignore: -------------------------------------------------------------------------------- 1 | # Prerequisites 2 | *.d 3 | 4 | # Object files 5 | *.o 6 | *.ko 7 | *.obj 8 | *.elf 9 | 10 | # Linker output 11 | *.ilk 12 | *.map 13 | *.exp 14 | 15 | # Precompiled Headers 16 | *.gch 17 | *.pch 18 | 19 | # Libraries 20 | *.lib 21 | *.a 22 | *.la 23 | *.lo 24 | 25 | # Shared objects (inc. Windows DLLs) 26 | *.dll 27 | *.so 28 | *.so.* 29 | *.dylib 30 | 31 | # Executables 32 | *.exe 33 | *.out 34 | *.app 35 | *.i*86 36 | *.x86_64 37 | *.hex 38 | 39 | # Debug files 40 | *.dSYM/ 41 | *.su 42 | *.idb 43 | *.pdb 44 | 45 | # Kernel Module Compile Results 46 | *.mod* 47 | *.cmd 48 | .tmp_versions/ 49 | modules.order 50 | Module.symvers 51 | Mkfile.old 52 | dkms.conf 53 | -------------------------------------------------------------------------------- /Examples/Signed_UEFI_Shell/EFI_ROOT_Example_UEFISHELL_Dell_Latitude_5520/readme.md: -------------------------------------------------------------------------------- 1 | Step 1: 2 | Find the handles for the SecurityArch GUIDS 3 | EFI_SECURITY2_ARCH_PROTOCOL_GUID 4 | 94AB2F58-1438-4EF1-9152-18941A3A0E68 (5F26F170) 5 | EFI_SECURITY_ARCH_PROTOCOL_GUID 6 | A46423E3-4617-49F1-B9FF-D1BFA9115839 (5F26F168) 7 | Dell_Latitude_5520 (after running "dh -v"): 8 | Handle 5A (58F79A98) 9 | A46423E3-4617-49F1-B9FF-D1BFA9115839 (5F26F168) 10 | 94AB2F58-1438-4EF1-9152-18941A3A0E68 (5F26F170) 11 | Step 2: 12 | Find the protocol handler addresses, since they are so close we use the lower address: 13 | fs3:\> dmem 0x58F79A98 10 14 | Memory Address 000000005F264828 10 Bytes 15 | 58F79A98: 10 C6 21 5F 00 00 00 00-50 C6 21 5F 00 00 00 00 *D. _...... _....* 16 | 17 | Step 3: 18 | Patch the handlers using mm: 19 | fs3:\> mm 5F21C610 c3c03148 -w 4 -mem 20 | fs3:\> mm 5F21C650 c3c03148 -w 4 -mem 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /UnSB/UnSB/UnSB.inf: -------------------------------------------------------------------------------- 1 | ## @file 2 | # TODO: Brief Description of UEFI Driver UnSB 3 | # 4 | # TODO: Detailed Description of UEFI Driver UnSB 5 | # 6 | # TODO: Copyright for UEFI Driver UnSB 7 | # 8 | # TODO: License for UEFI Driver UnSB 9 | # 10 | ## 11 | 12 | [Defines] 13 | INF_VERSION = 0x00010005 14 | BASE_NAME = UnSB 15 | FILE_GUID = fb0f0f80-9bef-11ec-9b68-000c29890ae6 16 | MODULE_TYPE = DXE_DRIVER 17 | VERSION_STRING = 1 18 | ENTRY_POINT = UnSBDriverEntryPoint 19 | 20 | [Packages] 21 | MdePkg/MdePkg.dec 22 | MdeModulePkg/MdeModulePkg.dec 23 | SecurityPkg/SecurityPkg.dec 24 | 25 | [Sources] 26 | UnSB.h 27 | UnSB.c 28 | SimpleTextOutput.c 29 | SimpleTextOutput.h 30 | 31 | [LibraryClasses] 32 | UefiDriverEntryPoint 33 | UefiBootServicesTableLib 34 | UefiRuntimeServicesTableLib 35 | MemoryAllocationLib 36 | BaseMemoryLib 37 | BaseLib 38 | PcdLib 39 | SecurityManagementLib 40 | UefiLib 41 | DevicePathLib 42 | DebugLib 43 | 44 | [Protocols] 45 | gEfiDriverBindingProtocolGuid 46 | gEfiSimpleTextOutProtocolGuid 47 | gEfiSecurityArchProtocolGuid ## SOMETIMES_CONSUMES 48 | gEfiSecurity2ArchProtocolGuid ## SOMETIMES_CONSUMES 49 | gEfiSecurityPolicyProtocolGuid 50 | [Depex] 51 | TRUE 52 | 53 | 54 | 55 | 56 | -------------------------------------------------------------------------------- /UnSB/UnSB/UnSB.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | TODO: Brief Description of UEFI Driver UnSB 3 | 4 | TODO: Detailed Description of UEFI Driver UnSB 5 | 6 | TODO: Copyright for UEFI Driver UnSB 7 | 8 | TODO: License for UEFI Driver UnSB 9 | 10 | **/ 11 | 12 | #ifndef __EFI_UN_SB_H__ 13 | #define __EFI_UN_SB_H__ 14 | 15 | #include 16 | #include 17 | 18 | // 19 | // Libraries 20 | // 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | 29 | // 30 | // UEFI Driver Model Protocols 31 | // 32 | #include 33 | 34 | // 35 | // Consumed Protocols 36 | // 37 | #include 38 | 39 | #define EFI_SECURITY_ARCH_PROTOCOL_GUID \ 40 | { 0xA46423E3, 0x4617, 0x49f1, {0xB9, 0xFF, 0xD1, 0xBF, 0xA9, 0x11, 0x58, 0x39 } } 41 | 42 | // 43 | // Produced Protocols 44 | // 45 | #include 46 | 47 | // 48 | // Guids 49 | // 50 | 51 | // 52 | // Driver Version 53 | // 54 | #define UN_SB_VERSION 0x00000000 55 | 56 | // 57 | // Protocol instances 58 | // 59 | extern EFI_DRIVER_BINDING_PROTOCOL gUnSBDriverBinding; 60 | 61 | // 62 | // Include files with function prototypes 63 | // 64 | #include "DriverBinding.h" 65 | #include "SimpleTextOutput.h" 66 | 67 | #endif 68 | -------------------------------------------------------------------------------- /UnSB/UnSB.dsc: -------------------------------------------------------------------------------- 1 | [Defines] 2 | DSC_SPECIFICATION = 1.28 3 | PLATFORM_GUID = fb0f0f80-9bef-11ec-9b68-000c29890ae7 4 | PLATFORM_VERSION = 1.00 5 | PLATFORM_NAME = UnSB 6 | SKUID_IDENTIFIER = DEFAULT 7 | SUPPORTED_ARCHITECTURES = X64 8 | BUILD_TARGETS = DEBUG|RELEASE|NOOPT 9 | 10 | [Components] 11 | UnSB/UnSB/UnSB.inf 12 | 13 | [LibraryClasses] 14 | SecurityManagementLib|MdeModulePkg/Library/DxeSecurityManagementLib/DxeSecurityManagementLib.inf 15 | BaseLib|MdePkg/Library/BaseLib/BaseLib.inf 16 | BaseMemoryLib|MdePkg/Library/BaseMemoryLib/BaseMemoryLib.inf 17 | CacheMaintenanceLib|MdePkg/Library/BaseCacheMaintenanceLib/BaseCacheMaintenanceLib.inf 18 | DebugPrintErrorLevelLib|MdePkg/Library/BaseDebugPrintErrorLevelLib/BaseDebugPrintErrorLevelLib.inf 19 | DevicePathLib|MdePkg/Library/UefiDevicePathLib/UefiDevicePathLib.inf 20 | DxeServicesLib|MdePkg/Library/DxeServicesLib/DxeServicesLib.inf 21 | FileHandleLib|MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.inf 22 | HobLib|MdePkg/Library/DxeHobLib/DxeHobLib.inf 23 | HiiLib|MdeModulePkg/Library/UefiHiiLib/UefiHiiLib.inf 24 | MemoryAllocationLib|MdePkg/Library/UefiMemoryAllocationLib/UefiMemoryAllocationLib.inf 25 | PcdLib|MdePkg/Library/BasePcdLibNull/BasePcdLibNull.inf 26 | PrintLib|MdePkg/Library/BasePrintLib/BasePrintLib.inf 27 | RegisterFilterLib|MdePkg/Library/RegisterFilterLibNull/RegisterFilterLibNull.inf 28 | UefiBootServicesTableLib|MdePkg/Library/UefiBootServicesTableLib/UefiBootServicesTableLib.inf 29 | UefiCpuLib|UefiCpuPkg/Library/BaseUefiCpuLib/BaseUefiCpuLib.inf 30 | UefiHiiServicesLib|MdeModulePkg/Library/UefiHiiServicesLib/UefiHiiServicesLib.inf 31 | UefiLib|MdePkg/Library/UefiLib/UefiLib.inf 32 | UefiRuntimeLib|MdePkg/Library/UefiRuntimeLib/UefiRuntimeLib.inf 33 | UefiRuntimeServicesTableLib|MdePkg/Library/UefiRuntimeServicesTableLib/UefiRuntimeServicesTableLib.inf 34 | IoLib|MdePkg/Library/BaseIoLibIntrinsic/BaseIoLibIntrinsicSev.inf 35 | LocalApicLib|UefiCpuPkg/Library/BaseXApicX2ApicLib/BaseXApicX2ApicLib.inf 36 | TimerLib|MdePkg/Library/BaseTimerLibNullTemplate/BaseTimerLibNullTemplate.inf 37 | ShellCEntryLib|ShellPkg/Library/UefiShellCEntryLib/UefiShellCEntryLib.inf 38 | ShellLib|ShellPkg/Library/UefiShellLib/UefiShellLib.inf 39 | SortLib|MdeModulePkg/Library/UefiSortLib/UefiSortLib.inf 40 | SynchronizationLib|MdePkg/Library/BaseSynchronizationLib/BaseSynchronizationLib.inf 41 | # Use an empty debug library for RELEASE buid. Otherwise, if DEBUG_ON_SERIAL_PORT 42 | # is defined, use serial port-based implementaion, and if not. ConOut-based 43 | # implementation. 44 | !if $(TARGET) == RELEASE 45 | DebugLib|MdePkg/Library/BaseDebugLibNull/BaseDebugLibNull.inf 46 | !else 47 | !ifdef $(DEBUG_ON_SERIAL_PORT) 48 | SerialPortLib|PcAtChipsetPkg/Library/SerialIoLib/SerialIoLib.inf 49 | DebugLib|MdePkg/Library/BaseDebugLibSerialPort/BaseDebugLibSerialPort.inf 50 | !else 51 | DebugLib|MdePkg/Library/UefiDebugLibConOut/UefiDebugLibConOut.inf 52 | !endif 53 | !endif 54 | 55 | [LibraryClasses.common.DXE_RUNTIME_DRIVER, LibraryClasses.common.DXE_DRIVER] 56 | UefiDriverEntryPoint|MdePkg/Library/UefiDriverEntryPoint/UefiDriverEntryPoint.inf 57 | 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /UnSB/UnSB/SimpleTextOutput.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | TODO: Brief Description of UEFI Driver UnSB 3 | 4 | TODO: Detailed Description of UEFI Driver UnSB 5 | 6 | TODO: Copyright for UEFI Driver UnSB 7 | 8 | TODO: License for UEFI Driver UnSB 9 | 10 | **/ 11 | 12 | /** 13 | Reset the text output device hardware and optionaly run diagnostics 14 | 15 | @param This The protocol instance pointer. 16 | @param ExtendedVerification Driver may perform more exhaustive verfication 17 | operation of the device during reset. 18 | 19 | @retval EFI_SUCCESS The text output device was reset. 20 | @retval EFI_DEVICE_ERROR The text output device is not functioning correctly and 21 | could not be reset. 22 | 23 | **/ 24 | EFI_STATUS 25 | EFIAPI 26 | UnSBSimpleTextOutputReset ( 27 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, 28 | IN BOOLEAN ExtendedVerification 29 | ); 30 | 31 | /** 32 | Write a string to the output device. 33 | 34 | @param This The protocol instance pointer. 35 | @param String The NULL-terminated string to be displayed on the output 36 | device(s). All output devices must also support the Unicode 37 | drawing character codes defined in this file. 38 | 39 | @retval EFI_SUCCESS The string was output to the device. 40 | @retval EFI_DEVICE_ERROR The device reported an error while attempting to output 41 | the text. 42 | @retval EFI_UNSUPPORTED The output device's mode is not currently in a 43 | defined text mode. 44 | @retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the 45 | characters in the string could not be 46 | rendered and were skipped. 47 | 48 | **/ 49 | EFI_STATUS 50 | EFIAPI 51 | UnSBSimpleTextOutputOutputString ( 52 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, 53 | IN CHAR16 *String 54 | ); 55 | 56 | /** 57 | Verifies that all characters in a string can be output to the 58 | target device. 59 | 60 | @param This The protocol instance pointer. 61 | @param String The NULL-terminated string to be examined for the output 62 | device(s). 63 | 64 | @retval EFI_SUCCESS The device(s) are capable of rendering the output string. 65 | @retval EFI_UNSUPPORTED Some of the characters in the string cannot be 66 | rendered by one or more of the output devices mapped 67 | by the EFI handle. 68 | 69 | **/ 70 | EFI_STATUS 71 | EFIAPI 72 | UnSBSimpleTextOutputTestString ( 73 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, 74 | IN CHAR16 *String 75 | ); 76 | 77 | /** 78 | Returns information for an available text mode that the output device(s) 79 | supports. 80 | 81 | @param This The protocol instance pointer. 82 | @param ModeNumber The mode number to return information on. 83 | @param Columns Returns the geometry of the text output device for the 84 | requested ModeNumber. 85 | @param Rows Returns the geometry of the text output device for the 86 | requested ModeNumber. 87 | 88 | @retval EFI_SUCCESS The requested mode information was returned. 89 | @retval EFI_DEVICE_ERROR The device had an error and could not complete the request. 90 | @retval EFI_UNSUPPORTED The mode number was not valid. 91 | 92 | **/ 93 | EFI_STATUS 94 | EFIAPI 95 | UnSBSimpleTextOutputQueryMode ( 96 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, 97 | IN UINTN ModeNumber, 98 | OUT UINTN *Columns, 99 | OUT UINTN *Rows 100 | ); 101 | 102 | /** 103 | Sets the output device(s) to a specified mode. 104 | 105 | @param This The protocol instance pointer. 106 | @param ModeNumber The mode number to set. 107 | 108 | @retval EFI_SUCCESS The requested text mode was set. 109 | @retval EFI_DEVICE_ERROR The device had an error and could not complete the request. 110 | @retval EFI_UNSUPPORTED The mode number was not valid. 111 | 112 | **/ 113 | EFI_STATUS 114 | EFIAPI 115 | UnSBSimpleTextOutputSetMode ( 116 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, 117 | IN UINTN ModeNumber 118 | ); 119 | 120 | /** 121 | Sets the background and foreground colors for the OutputString () and 122 | ClearScreen () functions. 123 | 124 | @param This The protocol instance pointer. 125 | @param Attribute The attribute to set. Bits 0..3 are the foreground color, and 126 | bits 4..6 are the background color. All other bits are undefined 127 | and must be zero. The valid Attributes are defined in this file. 128 | 129 | @retval EFI_SUCCESS The attribute was set. 130 | @retval EFI_DEVICE_ERROR The device had an error and could not complete the request. 131 | @retval EFI_UNSUPPORTED The attribute requested is not defined. 132 | 133 | **/ 134 | EFI_STATUS 135 | EFIAPI 136 | UnSBSimpleTextOutputSetAttribute ( 137 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, 138 | IN UINTN Attribute 139 | ); 140 | 141 | /** 142 | Clears the output device(s) display to the currently selected background 143 | color. 144 | 145 | @param This The protocol instance pointer. 146 | 147 | @retval EFI_SUCCESS The operation completed successfully. 148 | @retval EFI_DEVICE_ERROR The device had an error and could not complete the request. 149 | @retval EFI_UNSUPPORTED The output device is not in a valid text mode. 150 | 151 | **/ 152 | EFI_STATUS 153 | EFIAPI 154 | UnSBSimpleTextOutputClearScreen ( 155 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This 156 | ); 157 | 158 | /** 159 | Sets the current coordinates of the cursor position 160 | 161 | @param This The protocol instance pointer. 162 | @param Column The position to set the cursor to. Must be greater than or 163 | equal to zero and less than the number of columns and rows 164 | by QueryMode (). 165 | @param Row The position to set the cursor to. Must be greater than or 166 | equal to zero and less than the number of columns and rows 167 | by QueryMode (). 168 | 169 | @retval EFI_SUCCESS The operation completed successfully. 170 | @retval EFI_DEVICE_ERROR The device had an error and could not complete the request. 171 | @retval EFI_UNSUPPORTED The output device is not in a valid text mode, or the 172 | cursor position is invalid for the current mode. 173 | 174 | **/ 175 | EFI_STATUS 176 | EFIAPI 177 | UnSBSimpleTextOutputSetCursorPosition ( 178 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, 179 | IN UINTN Column, 180 | IN UINTN Row 181 | ); 182 | 183 | /** 184 | Makes the cursor visible or invisible 185 | 186 | @param This The protocol instance pointer. 187 | @param Visible If TRUE, the cursor is set to be visible. If FALSE, the cursor is 188 | set to be invisible. 189 | 190 | @retval EFI_SUCCESS The operation completed successfully. 191 | @retval EFI_DEVICE_ERROR The device had an error and could not complete the 192 | request, or the device does not support changing 193 | the cursor mode. 194 | @retval EFI_UNSUPPORTED The output device is not in a valid text mode. 195 | 196 | **/ 197 | EFI_STATUS 198 | EFIAPI 199 | UnSBSimpleTextOutputEnableCursor ( 200 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, 201 | IN BOOLEAN Visible 202 | ); 203 | -------------------------------------------------------------------------------- /UnSB/UnSB/DriverBinding.h: -------------------------------------------------------------------------------- 1 | /** @file 2 | TODO: Brief Description of UEFI Driver UnSB 3 | 4 | TODO: Detailed Description of UEFI Driver UnSB 5 | 6 | TODO: Copyright for UEFI Driver UnSB 7 | 8 | TODO: License for UEFI Driver UnSB 9 | 10 | **/ 11 | 12 | /** 13 | Tests to see if this driver supports a given controller. If a child device is provided, 14 | it further tests to see if this driver supports creating a handle for the specified child device. 15 | 16 | This function checks to see if the driver specified by This supports the device specified by 17 | ControllerHandle. Drivers will typically use the device path attached to 18 | ControllerHandle and/or the services from the bus I/O abstraction attached to 19 | ControllerHandle to determine if the driver supports ControllerHandle. This function 20 | may be called many times during platform initialization. In order to reduce boot times, the tests 21 | performed by this function must be very small, and take as little time as possible to execute. This 22 | function must not change the state of any hardware devices, and this function must be aware that the 23 | device specified by ControllerHandle may already be managed by the same driver or a 24 | different driver. This function must match its calls to AllocatePages() with FreePages(), 25 | AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). 26 | Because ControllerHandle may have been previously started by the same driver, if a protocol is 27 | already in the opened state, then it must not be closed with CloseProtocol(). This is required 28 | to guarantee the state of ControllerHandle is not modified by this function. 29 | 30 | @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. 31 | @param[in] ControllerHandle The handle of the controller to test. This handle 32 | must support a protocol interface that supplies 33 | an I/O abstraction to the driver. 34 | @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This 35 | parameter is ignored by device drivers, and is optional for bus 36 | drivers. For bus drivers, if this parameter is not NULL, then 37 | the bus driver must determine if the bus controller specified 38 | by ControllerHandle and the child controller specified 39 | by RemainingDevicePath are both supported by this 40 | bus driver. 41 | 42 | @retval EFI_SUCCESS The device specified by ControllerHandle and 43 | RemainingDevicePath is supported by the driver specified by This. 44 | @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and 45 | RemainingDevicePath is already being managed by the driver 46 | specified by This. 47 | @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and 48 | RemainingDevicePath is already being managed by a different 49 | driver or an application that requires exclusive access. 50 | Currently not implemented. 51 | @retval EFI_UNSUPPORTED The device specified by ControllerHandle and 52 | RemainingDevicePath is not supported by the driver specified by This. 53 | **/ 54 | EFI_STATUS 55 | EFIAPI 56 | UnSBDriverBindingSupported ( 57 | IN EFI_DRIVER_BINDING_PROTOCOL *This, 58 | IN EFI_HANDLE ControllerHandle, 59 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL 60 | ); 61 | 62 | /** 63 | Starts a device controller or a bus controller. 64 | 65 | The Start() function is designed to be invoked from the EFI boot service ConnectController(). 66 | As a result, much of the error checking on the parameters to Start() has been moved into this 67 | common boot service. It is legal to call Start() from other locations, 68 | but the following calling restrictions must be followed, or the system behavior will not be deterministic. 69 | 1. ControllerHandle must be a valid EFI_HANDLE. 70 | 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned 71 | EFI_DEVICE_PATH_PROTOCOL. 72 | 3. Prior to calling Start(), the Supported() function for the driver specified by This must 73 | have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS. 74 | 75 | @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. 76 | @param[in] ControllerHandle The handle of the controller to start. This handle 77 | must support a protocol interface that supplies 78 | an I/O abstraction to the driver. 79 | @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This 80 | parameter is ignored by device drivers, and is optional for bus 81 | drivers. For a bus driver, if this parameter is NULL, then handles 82 | for all the children of Controller are created by this driver. 83 | If this parameter is not NULL and the first Device Path Node is 84 | not the End of Device Path Node, then only the handle for the 85 | child device specified by the first Device Path Node of 86 | RemainingDevicePath is created by this driver. 87 | If the first Device Path Node of RemainingDevicePath is 88 | the End of Device Path Node, no child handle is created by this 89 | driver. 90 | 91 | @retval EFI_SUCCESS The device was started. 92 | @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented. 93 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. 94 | @retval Others The driver failded to start the device. 95 | 96 | **/ 97 | EFI_STATUS 98 | EFIAPI 99 | UnSBDriverBindingStart ( 100 | IN EFI_DRIVER_BINDING_PROTOCOL *This, 101 | IN EFI_HANDLE ControllerHandle, 102 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL 103 | ); 104 | 105 | /** 106 | Stops a device controller or a bus controller. 107 | 108 | The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). 109 | As a result, much of the error checking on the parameters to Stop() has been moved 110 | into this common boot service. It is legal to call Stop() from other locations, 111 | but the following calling restrictions must be followed, or the system behavior will not be deterministic. 112 | 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this 113 | same driver's Start() function. 114 | 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid 115 | EFI_HANDLE. In addition, all of these handles must have been created in this driver's 116 | Start() function, and the Start() function must have called OpenProtocol() on 117 | ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER. 118 | 119 | @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. 120 | @param[in] ControllerHandle A handle to the device being stopped. The handle must 121 | support a bus specific I/O protocol for the driver 122 | to use to stop the device. 123 | @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer. 124 | @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL 125 | if NumberOfChildren is 0. 126 | 127 | @retval EFI_SUCCESS The device was stopped. 128 | @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error. 129 | 130 | **/ 131 | EFI_STATUS 132 | EFIAPI 133 | UnSBDriverBindingStop ( 134 | IN EFI_DRIVER_BINDING_PROTOCOL *This, 135 | IN EFI_HANDLE ControllerHandle, 136 | IN UINTN NumberOfChildren, 137 | IN EFI_HANDLE *ChildHandleBuffer OPTIONAL 138 | ); 139 | -------------------------------------------------------------------------------- /UnSB/UnSB/SimpleTextOutput.c: -------------------------------------------------------------------------------- 1 | /** @file 2 | TODO: Brief Description of UEFI Driver UnSB 3 | 4 | TODO: Detailed Description of UEFI Driver UnSB 5 | 6 | TODO: Copyright for UEFI Driver UnSB 7 | 8 | TODO: License for UEFI Driver UnSB 9 | 10 | **/ 11 | 12 | #include "UnSB.h" 13 | 14 | /// 15 | /// Simple Text Output Protocol Mode instance 16 | /// 17 | GLOBAL_REMOVE_IF_UNREFERENCED 18 | EFI_SIMPLE_TEXT_OUTPUT_MODE gUnSBSimpleTextOutputMode = { 19 | 0, // MaxMode 20 | 0, // Mode 21 | EFI_TEXT_ATTR (EFI_WHITE, EFI_BACKGROUND_BLACK), // Attribute 22 | 0, // CursorColumn 23 | 0, // CursorRow 24 | TRUE // CursorVisible 25 | }; 26 | 27 | /// 28 | /// Simple Text Output Protocol instance 29 | /// 30 | GLOBAL_REMOVE_IF_UNREFERENCED 31 | EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL gUnSBSimpleTextOutput = { 32 | UnSBSimpleTextOutputReset, 33 | UnSBSimpleTextOutputOutputString, 34 | UnSBSimpleTextOutputTestString, 35 | UnSBSimpleTextOutputQueryMode, 36 | UnSBSimpleTextOutputSetMode, 37 | UnSBSimpleTextOutputSetAttribute, 38 | UnSBSimpleTextOutputClearScreen, 39 | UnSBSimpleTextOutputSetCursorPosition, 40 | UnSBSimpleTextOutputEnableCursor, 41 | &gUnSBSimpleTextOutputMode 42 | }; 43 | 44 | /** 45 | Reset the text output device hardware and optionaly run diagnostics 46 | 47 | @param This The protocol instance pointer. 48 | @param ExtendedVerification Driver may perform more exhaustive verfication 49 | operation of the device during reset. 50 | 51 | @retval EFI_SUCCESS The text output device was reset. 52 | @retval EFI_DEVICE_ERROR The text output device is not functioning correctly and 53 | could not be reset. 54 | 55 | **/ 56 | EFI_STATUS 57 | EFIAPI 58 | UnSBSimpleTextOutputReset ( 59 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, 60 | IN BOOLEAN ExtendedVerification 61 | ) 62 | { 63 | return EFI_DEVICE_ERROR; 64 | } 65 | 66 | /** 67 | Write a string to the output device. 68 | 69 | @param This The protocol instance pointer. 70 | @param String The NULL-terminated string to be displayed on the output 71 | device(s). All output devices must also support the Unicode 72 | drawing character codes defined in this file. 73 | 74 | @retval EFI_SUCCESS The string was output to the device. 75 | @retval EFI_DEVICE_ERROR The device reported an error while attempting to output 76 | the text. 77 | @retval EFI_UNSUPPORTED The output device's mode is not currently in a 78 | defined text mode. 79 | @retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the 80 | characters in the string could not be 81 | rendered and were skipped. 82 | 83 | **/ 84 | EFI_STATUS 85 | EFIAPI 86 | UnSBSimpleTextOutputOutputString ( 87 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, 88 | IN CHAR16 *String 89 | ) 90 | { 91 | return EFI_UNSUPPORTED; 92 | } 93 | 94 | /** 95 | Verifies that all characters in a string can be output to the 96 | target device. 97 | 98 | @param This The protocol instance pointer. 99 | @param String The NULL-terminated string to be examined for the output 100 | device(s). 101 | 102 | @retval EFI_SUCCESS The device(s) are capable of rendering the output string. 103 | @retval EFI_UNSUPPORTED Some of the characters in the string cannot be 104 | rendered by one or more of the output devices mapped 105 | by the EFI handle. 106 | 107 | **/ 108 | EFI_STATUS 109 | EFIAPI 110 | UnSBSimpleTextOutputTestString ( 111 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, 112 | IN CHAR16 *String 113 | ) 114 | { 115 | return EFI_UNSUPPORTED; 116 | } 117 | 118 | /** 119 | Returns information for an available text mode that the output device(s) 120 | supports. 121 | 122 | @param This The protocol instance pointer. 123 | @param ModeNumber The mode number to return information on. 124 | @param Columns Returns the geometry of the text output device for the 125 | requested ModeNumber. 126 | @param Rows Returns the geometry of the text output device for the 127 | requested ModeNumber. 128 | 129 | @retval EFI_SUCCESS The requested mode information was returned. 130 | @retval EFI_DEVICE_ERROR The device had an error and could not complete the request. 131 | @retval EFI_UNSUPPORTED The mode number was not valid. 132 | 133 | **/ 134 | EFI_STATUS 135 | EFIAPI 136 | UnSBSimpleTextOutputQueryMode ( 137 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, 138 | IN UINTN ModeNumber, 139 | OUT UINTN *Columns, 140 | OUT UINTN *Rows 141 | ) 142 | { 143 | return EFI_UNSUPPORTED; 144 | } 145 | 146 | /** 147 | Sets the output device(s) to a specified mode. 148 | 149 | @param This The protocol instance pointer. 150 | @param ModeNumber The mode number to set. 151 | 152 | @retval EFI_SUCCESS The requested text mode was set. 153 | @retval EFI_DEVICE_ERROR The device had an error and could not complete the request. 154 | @retval EFI_UNSUPPORTED The mode number was not valid. 155 | 156 | **/ 157 | EFI_STATUS 158 | EFIAPI 159 | UnSBSimpleTextOutputSetMode ( 160 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, 161 | IN UINTN ModeNumber 162 | ) 163 | { 164 | return EFI_UNSUPPORTED; 165 | } 166 | 167 | /** 168 | Sets the background and foreground colors for the OutputString () and 169 | ClearScreen () functions. 170 | 171 | @param This The protocol instance pointer. 172 | @param Attribute The attribute to set. Bits 0..3 are the foreground color, and 173 | bits 4..6 are the background color. All other bits are undefined 174 | and must be zero. The valid Attributes are defined in this file. 175 | 176 | @retval EFI_SUCCESS The attribute was set. 177 | @retval EFI_DEVICE_ERROR The device had an error and could not complete the request. 178 | @retval EFI_UNSUPPORTED The attribute requested is not defined. 179 | 180 | **/ 181 | EFI_STATUS 182 | EFIAPI 183 | UnSBSimpleTextOutputSetAttribute ( 184 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, 185 | IN UINTN Attribute 186 | ) 187 | { 188 | return EFI_UNSUPPORTED; 189 | } 190 | 191 | /** 192 | Clears the output device(s) display to the currently selected background 193 | color. 194 | 195 | @param This The protocol instance pointer. 196 | 197 | @retval EFI_SUCCESS The operation completed successfully. 198 | @retval EFI_DEVICE_ERROR The device had an error and could not complete the request. 199 | @retval EFI_UNSUPPORTED The output device is not in a valid text mode. 200 | 201 | **/ 202 | EFI_STATUS 203 | EFIAPI 204 | UnSBSimpleTextOutputClearScreen ( 205 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This 206 | ) 207 | { 208 | return EFI_UNSUPPORTED; 209 | } 210 | 211 | /** 212 | Sets the current coordinates of the cursor position 213 | 214 | @param This The protocol instance pointer. 215 | @param Column The position to set the cursor to. Must be greater than or 216 | equal to zero and less than the number of columns and rows 217 | by QueryMode (). 218 | @param Row The position to set the cursor to. Must be greater than or 219 | equal to zero and less than the number of columns and rows 220 | by QueryMode (). 221 | 222 | @retval EFI_SUCCESS The operation completed successfully. 223 | @retval EFI_DEVICE_ERROR The device had an error and could not complete the request. 224 | @retval EFI_UNSUPPORTED The output device is not in a valid text mode, or the 225 | cursor position is invalid for the current mode. 226 | 227 | **/ 228 | EFI_STATUS 229 | EFIAPI 230 | UnSBSimpleTextOutputSetCursorPosition ( 231 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, 232 | IN UINTN Column, 233 | IN UINTN Row 234 | ) 235 | { 236 | return EFI_UNSUPPORTED; 237 | } 238 | 239 | /** 240 | Makes the cursor visible or invisible 241 | 242 | @param This The protocol instance pointer. 243 | @param Visible If TRUE, the cursor is set to be visible. If FALSE, the cursor is 244 | set to be invisible. 245 | 246 | @retval EFI_SUCCESS The operation completed successfully. 247 | @retval EFI_DEVICE_ERROR The device had an error and could not complete the 248 | request, or the device does not support changing 249 | the cursor mode. 250 | @retval EFI_UNSUPPORTED The output device is not in a valid text mode. 251 | 252 | **/ 253 | EFI_STATUS 254 | EFIAPI 255 | UnSBSimpleTextOutputEnableCursor ( 256 | IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This, 257 | IN BOOLEAN Visible 258 | ) 259 | { 260 | return EFI_UNSUPPORTED; 261 | } 262 | -------------------------------------------------------------------------------- /UnSB/UnSB/UnSB.c: -------------------------------------------------------------------------------- 1 | /** @file 2 | TODO: Brief Description of UEFI Driver UnSB 3 | 4 | TODO: Detailed Description of UEFI Driver UnSB 5 | 6 | TODO: Copyright for UEFI Driver UnSB 7 | 8 | TODO: License for UEFI Driver UnSB 9 | 10 | **/ 11 | 12 | #include "UnSB.h" 13 | #include 14 | #include 15 | #include 16 | #include 17 | #include 18 | #include 19 | #include 20 | #include 21 | #include 22 | #include 23 | 24 | // using code from https://github.com/sa413x/UEFI-Bootloader/blob/master/UefiBootLoader/bootloader.c 25 | EFI_STATUS 26 | LocateFile( 27 | IN CHAR16* ImagePath, 28 | OUT EFI_DEVICE_PATH** DevicePath 29 | ) { 30 | EFI_FILE_IO_INTERFACE* ioDevice; 31 | EFI_FILE_HANDLE handleRoots; 32 | EFI_FILE_HANDLE bootFile; 33 | EFI_HANDLE* handleArray; 34 | EFI_STATUS efiStatus; 35 | UINTN nbHandles; 36 | UINTN i; 37 | 38 | *DevicePath = (EFI_DEVICE_PATH*)NULL; 39 | efiStatus = gBS->LocateHandleBuffer(ByProtocol, &gEfiSimpleFileSystemProtocolGuid, NULL, &nbHandles, &handleArray); 40 | if (EFI_ERROR(efiStatus)) { 41 | return efiStatus; 42 | } 43 | for (i = 0; i < nbHandles; i++) { 44 | efiStatus = gBS->HandleProtocol(handleArray[i], &gEfiSimpleFileSystemProtocolGuid, &ioDevice); 45 | 46 | if (efiStatus != EFI_SUCCESS) { 47 | continue; 48 | } 49 | efiStatus = ioDevice->OpenVolume(ioDevice, &handleRoots); 50 | if (EFI_ERROR(efiStatus)){ 51 | continue; 52 | } 53 | efiStatus = handleRoots->Open(handleRoots, &bootFile, ImagePath, EFI_FILE_MODE_READ, EFI_FILE_READ_ONLY); 54 | if (!EFI_ERROR(efiStatus)) { 55 | handleRoots->Close(bootFile); 56 | *DevicePath = FileDevicePath(handleArray[i], ImagePath); 57 | break; 58 | } 59 | } 60 | return efiStatus; 61 | } 62 | 63 | /// 64 | /// Driver Binding Protocol instance 65 | /// 66 | EFI_DRIVER_BINDING_PROTOCOL gUnSBDriverBinding = { 67 | UnSBDriverBindingSupported, 68 | UnSBDriverBindingStart, 69 | UnSBDriverBindingStop, 70 | UN_SB_VERSION, 71 | NULL, 72 | NULL 73 | }; 74 | 75 | /** 76 | Unloads an image. 77 | 78 | @param ImageHandle Handle that identifies the image to be unloaded. 79 | 80 | @retval EFI_SUCCESS The image has been unloaded. 81 | @retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle. 82 | 83 | **/ 84 | EFI_STATUS 85 | EFIAPI 86 | UnSBUnload ( 87 | IN EFI_HANDLE ImageHandle 88 | ) 89 | { 90 | EFI_STATUS Status; 91 | EFI_HANDLE *HandleBuffer; 92 | UINTN HandleCount; 93 | UINTN Index; 94 | 95 | Status = EFI_SUCCESS; 96 | // 97 | // Retrieve array of all handles in the handle database 98 | // 99 | Status = gBS->LocateHandleBuffer ( 100 | AllHandles, 101 | NULL, 102 | NULL, 103 | &HandleCount, 104 | &HandleBuffer 105 | ); 106 | if (EFI_ERROR (Status)) { 107 | return Status; 108 | } 109 | 110 | // 111 | // Disconnect the current driver from handles in the handle database 112 | // 113 | for (Index = 0; Index < HandleCount; Index++) { 114 | Status = gBS->DisconnectController (HandleBuffer[Index], gImageHandle, NULL); 115 | } 116 | 117 | // 118 | // Free the array of handles 119 | // 120 | FreePool (HandleBuffer); 121 | 122 | // 123 | // Uninstall protocols installed in the driver entry point 124 | // 125 | Status = gBS->UninstallMultipleProtocolInterfaces ( 126 | ImageHandle, 127 | &gEfiDriverBindingProtocolGuid, &gUnSBDriverBinding, 128 | NULL 129 | ); 130 | if (EFI_ERROR (Status)) { 131 | return Status; 132 | } 133 | 134 | // 135 | // Do any additional cleanup that is required for this driver 136 | // 137 | 138 | return EFI_SUCCESS; 139 | } 140 | 141 | /** 142 | This is the declaration of an EFI image entry point. This entry point is 143 | the same for UEFI Applications, UEFI OS Loaders, and UEFI Drivers including 144 | both device drivers and bus drivers. 145 | 146 | @param ImageHandle The firmware allocated handle for the UEFI image. 147 | @param SystemTable A pointer to the EFI System Table. 148 | 149 | @retval EFI_SUCCESS The operation completed successfully. 150 | @retval Others An unexpected error occurred. 151 | **/ 152 | EFI_STATUS 153 | EFIAPI 154 | UnSBDriverEntryPoint ( 155 | IN EFI_HANDLE ImageHandle, 156 | IN EFI_SYSTEM_TABLE *SystemTable 157 | ) 158 | { 159 | EFI_STATUS Status; 160 | 161 | Status = EFI_SUCCESS; 162 | 163 | Status = EfiLibInstallDriverBinding ( 164 | ImageHandle, 165 | SystemTable, 166 | &gUnSBDriverBinding, 167 | ImageHandle 168 | ); 169 | ASSERT_EFI_ERROR (Status); 170 | 171 | EFI_SECURITY_ARCH_PROTOCOL *mSecurity = NULL; 172 | EFI_SECURITY2_ARCH_PROTOCOL *mSecurity2 = NULL; 173 | 174 | if (mSecurity2 == NULL) { 175 | gBS->LocateProtocol (&gEfiSecurity2ArchProtocolGuid, NULL, (void **)&mSecurity2); 176 | } 177 | 178 | if (mSecurity == NULL) { 179 | gBS->LocateProtocol (&gEfiSecurityArchProtocolGuid, NULL, (void **)&mSecurity); 180 | } 181 | 182 | ASSERT (mSecurity2 == NULL || mSecurity != NULL); 183 | 184 | //Patch the handlers and proceed to load the unsigned UEFI Shell efi. 185 | 186 | *((UINT32 *)mSecurity->FileAuthenticationState) = 0xc3c03148; 187 | *((UINT32 *)mSecurity2->FileAuthentication) = 0xc3c03148; 188 | 189 | CHAR16* gShellPath = L"\\ShellX64.efi"; 190 | EFI_DEVICE_PATH* ShellPath; 191 | Status = LocateFile(gShellPath, &ShellPath); 192 | 193 | if (EFI_ERROR(Status)) { 194 | return Status; 195 | } 196 | 197 | Status = gBS->LoadImage(TRUE, ImageHandle, ShellPath, NULL, 0, &ShellPath); 198 | 199 | if (EFI_ERROR(Status)) { 200 | return Status; 201 | } 202 | 203 | Status = gBS->StartImage(ShellPath, (UINTN*)NULL, (CHAR16 * *)NULL); 204 | 205 | if (EFI_ERROR(Status)) { 206 | return Status; 207 | } 208 | 209 | 210 | return Status; 211 | } 212 | 213 | /** 214 | Tests to see if this driver supports a given controller. If a child device is provided, 215 | it further tests to see if this driver supports creating a handle for the specified child device. 216 | 217 | This function checks to see if the driver specified by This supports the device specified by 218 | ControllerHandle. Drivers will typically use the device path attached to 219 | ControllerHandle and/or the services from the bus I/O abstraction attached to 220 | ControllerHandle to determine if the driver supports ControllerHandle. This function 221 | may be called many times during platform initialization. In order to reduce boot times, the tests 222 | performed by this function must be very small, and take as little time as possible to execute. This 223 | function must not change the state of any hardware devices, and this function must be aware that the 224 | device specified by ControllerHandle may already be managed by the same driver or a 225 | different driver. This function must match its calls to AllocatePages() with FreePages(), 226 | AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). 227 | Because ControllerHandle may have been previously started by the same driver, if a protocol is 228 | already in the opened state, then it must not be closed with CloseProtocol(). This is required 229 | to guarantee the state of ControllerHandle is not modified by this function. 230 | 231 | @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. 232 | @param[in] ControllerHandle The handle of the controller to test. This handle 233 | must support a protocol interface that supplies 234 | an I/O abstraction to the driver. 235 | @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This 236 | parameter is ignored by device drivers, and is optional for bus 237 | drivers. For bus drivers, if this parameter is not NULL, then 238 | the bus driver must determine if the bus controller specified 239 | by ControllerHandle and the child controller specified 240 | by RemainingDevicePath are both supported by this 241 | bus driver. 242 | 243 | @retval EFI_SUCCESS The device specified by ControllerHandle and 244 | RemainingDevicePath is supported by the driver specified by This. 245 | @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and 246 | RemainingDevicePath is already being managed by the driver 247 | specified by This. 248 | @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and 249 | RemainingDevicePath is already being managed by a different 250 | driver or an application that requires exclusive access. 251 | Currently not implemented. 252 | @retval EFI_UNSUPPORTED The device specified by ControllerHandle and 253 | RemainingDevicePath is not supported by the driver specified by This. 254 | **/ 255 | EFI_STATUS 256 | EFIAPI 257 | UnSBDriverBindingSupported ( 258 | IN EFI_DRIVER_BINDING_PROTOCOL *This, 259 | IN EFI_HANDLE ControllerHandle, 260 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL 261 | ) 262 | { 263 | return EFI_UNSUPPORTED; 264 | } 265 | 266 | /** 267 | Starts a device controller or a bus controller. 268 | 269 | The Start() function is designed to be invoked from the EFI boot service ConnectController(). 270 | As a result, much of the error checking on the parameters to Start() has been moved into this 271 | common boot service. It is legal to call Start() from other locations, 272 | but the following calling restrictions must be followed, or the system behavior will not be deterministic. 273 | 1. ControllerHandle must be a valid EFI_HANDLE. 274 | 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned 275 | EFI_DEVICE_PATH_PROTOCOL. 276 | 3. Prior to calling Start(), the Supported() function for the driver specified by This must 277 | have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS. 278 | 279 | @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. 280 | @param[in] ControllerHandle The handle of the controller to start. This handle 281 | must support a protocol interface that supplies 282 | an I/O abstraction to the driver. 283 | @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This 284 | parameter is ignored by device drivers, and is optional for bus 285 | drivers. For a bus driver, if this parameter is NULL, then handles 286 | for all the children of Controller are created by this driver. 287 | If this parameter is not NULL and the first Device Path Node is 288 | not the End of Device Path Node, then only the handle for the 289 | child device specified by the first Device Path Node of 290 | RemainingDevicePath is created by this driver. 291 | If the first Device Path Node of RemainingDevicePath is 292 | the End of Device Path Node, no child handle is created by this 293 | driver. 294 | 295 | @retval EFI_SUCCESS The device was started. 296 | @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented. 297 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources. 298 | @retval Others The driver failded to start the device. 299 | 300 | **/ 301 | EFI_STATUS 302 | EFIAPI 303 | UnSBDriverBindingStart ( 304 | IN EFI_DRIVER_BINDING_PROTOCOL *This, 305 | IN EFI_HANDLE ControllerHandle, 306 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL 307 | ) 308 | { 309 | return EFI_UNSUPPORTED; 310 | } 311 | 312 | /** 313 | Stops a device controller or a bus controller. 314 | 315 | The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). 316 | As a result, much of the error checking on the parameters to Stop() has been moved 317 | into this common boot service. It is legal to call Stop() from other locations, 318 | but the following calling restrictions must be followed, or the system behavior will not be deterministic. 319 | 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this 320 | same driver's Start() function. 321 | 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid 322 | EFI_HANDLE. In addition, all of these handles must have been created in this driver's 323 | Start() function, and the Start() function must have called OpenProtocol() on 324 | ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER. 325 | 326 | @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance. 327 | @param[in] ControllerHandle A handle to the device being stopped. The handle must 328 | support a bus specific I/O protocol for the driver 329 | to use to stop the device. 330 | @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer. 331 | @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL 332 | if NumberOfChildren is 0. 333 | 334 | @retval EFI_SUCCESS The device was stopped. 335 | @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error. 336 | 337 | **/ 338 | EFI_STATUS 339 | EFIAPI 340 | UnSBDriverBindingStop ( 341 | IN EFI_DRIVER_BINDING_PROTOCOL *This, 342 | IN EFI_HANDLE ControllerHandle, 343 | IN UINTN NumberOfChildren, 344 | IN EFI_HANDLE *ChildHandleBuffer OPTIONAL 345 | ) 346 | { 347 | return EFI_UNSUPPORTED; 348 | } 349 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------