├── data.img ├── Source └── EFI │ └── HelloWorld.txt ├── bootsect.com ├── scorpion.jpg ├── BootSectImage ├── GnuGenBootSector ├── .gitignore ├── CreateImg.sh ├── README.md ├── README_CN.md ├── RD.inf ├── AddBootOption.h ├── RD.h ├── RDMain.c ├── RDBlockIo.c └── LICENSE /data.img: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Error996/Scorpion/HEAD/data.img -------------------------------------------------------------------------------- /Source/EFI/HelloWorld.txt: -------------------------------------------------------------------------------- 1 | AnyThing in here~! 2 | Good Luck 3 | By D1ves 4 | -------------------------------------------------------------------------------- /bootsect.com: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Error996/Scorpion/HEAD/bootsect.com -------------------------------------------------------------------------------- /scorpion.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Error996/Scorpion/HEAD/scorpion.jpg -------------------------------------------------------------------------------- /BootSectImage: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Error996/Scorpion/HEAD/BootSectImage -------------------------------------------------------------------------------- /GnuGenBootSector: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Error996/Scorpion/HEAD/GnuGenBootSector -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /CreateImg.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | rm ./data.img 3 | export EFI_BOOT_MEDIA=./data.img 4 | echo "Start to create file boot disk ..." 5 | dd bs=1024 count=1440 if=/dev/zero of=$EFI_BOOT_MEDIA 6 | mkfs.msdos -F 12 $EFI_BOOT_MEDIA 7 | mcopy -i $EFI_BOOT_MEDIA -/ ./Source/* ::/ 8 | mdir -i $EFI_BOOT_MEDIA -s :: 9 | ## Linux version of GenBootSector has not pass build yet. 10 | ./GnuGenBootSector -i $EFI_BOOT_MEDIA -o $EFI_BOOT_MEDIA.bs0 11 | cp ./bootsect.com $EFI_BOOT_MEDIA.bs1 12 | ./BootSectImage -g $EFI_BOOT_MEDIA.bs0 $EFI_BOOT_MEDIA.bs1 13 | ./GnuGenBootSector -o $EFI_BOOT_MEDIA -i $EFI_BOOT_MEDIA.bs1 14 | rm $EFI_BOOT_MEDIA.bs[0-1] 15 | rm IMG.c 16 | xxd -i $EFI_BOOT_MEDIA > IMG.c 17 | 18 | echo Done. 19 | 20 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Scorpion 2 | English | [简体中文](https://github.com/d1ves/Scorpion/blob/master/README_CN.md) 3 | ![avatar](https://raw.githubusercontent.com/d1ves/Scropion/master/scorpion.jpg) 4 | 5 | A Toy/Tool To Package AnyThing into bios 6 | 7 | Base On RamDisk and [UDK2018](https://github.com/tianocore/edk2/tree/UDK2018) 8 | 9 | Work Good on Ami/Phoenix Motherboard 10 | 11 | The Logo was cpoy From TV series [scorpion](https://en.wikipedia.org/wiki/Scorpion_(TV_series)) 12 | 13 | For the newbie,Try this virtual machine(Scorpion.7z)： 14 | 15 | [Download Me](https://d1ves.cowtransfer.com/s/2d4001eb3a704c) 16 | 17 | [Download Me 2(danwan)](http://animity.org:5000/sharing/lG6OaT7xp) 18 | 19 | Linux Password：1234 20 | 21 | -------------------------------------------------------------------------------- /README_CN.md: -------------------------------------------------------------------------------- 1 | # Scorpion 2 | 简体中文 | [English](https://github.com/d1ves/Scorpion/blob/master/README.md) 3 | ![avatar](https://raw.githubusercontent.com/d1ves/Scropion/master/scorpion.jpg) 4 | 5 | 一个可以把任意文件包到bios里的玩具/工具 6 | 7 | 基于RamDisk和[UDK2018](https://github.com/tianocore/edk2/tree/UDK2018) 8 | 9 | 支持INTEL和AMD的主板，包括AMI和Phoenix，不限于x86，已测试可用于ARM！ 10 | 11 | Logo是抄的电视剧 [scorpion](https://en.wikipedia.org/wiki/Scorpion_(TV_series))的 12 | 13 | 新手可以用以下虚拟机，已经集成好编译环境(Scorpion.7z)： 14 | 15 | [下载地址](https://d1ves.cowtransfer.com/s/2d4001eb3a704c) 16 | 17 | [分流下载地址(感谢蛋总）](http://animity.org:5000/sharing/lG6OaT7xp) 18 | 19 | [分流下载地址(感谢老中医,提取码dxjg)](https://pan.xunlei.com/s/VMS2F2D2Sp03QEDKRrzeBAEmA1) 20 | 21 | Linux Password：1234 22 | 23 | 已知BUG：部分主板刷完需要重启两次 24 | -------------------------------------------------------------------------------- /RD.inf: -------------------------------------------------------------------------------- 1 | [Defines] 2 | INF_VERSION = 0x00010005 3 | BASE_NAME = Scorpion 4 | FILE_GUID = 99a59ca7-13d4-4650-9389-6f1ed44ec4b9 5 | VERSION_STRING = 1.0 6 | MODULE_TYPE = DXE_DRIVER 7 | ENTRY_POINT = RDEntryPoint 8 | 9 | [Sources] 10 | #Add Start By Lundy 11 | AddBootOption.h 12 | #Add End By Lundy 13 | RD.h 14 | RDMain.c 15 | RDBlockIo.c 16 | IMG.c 17 | 18 | [Packages] 19 | MdePkg/MdePkg.dec 20 | MdeModulePkg/MdeModulePkg.dec 21 | ShellPkg/ShellPkg.dec 22 | 23 | [LibraryClasses] 24 | IoLib 25 | PcdLib 26 | BaseLib 27 | UefiLib 28 | PrintLib 29 | BaseMemoryLib 30 | MemoryAllocationLib 31 | UefiBootServicesTableLib 32 | UefiRuntimeServicesTableLib 33 | UefiDriverEntryPoint 34 | DevicePathLib 35 | DxeServicesLib 36 | #Add Start By Lundy 37 | # ReportStatusCodeLib 38 | DebugLib 39 | UefiBootManagerLib 40 | PlatformBootManagerLib 41 | #Add End By Lundy 42 | 43 | [Protocols] 44 | gEfiRamDiskProtocolGuid ## PRODUCES 45 | gEfiDevicePathProtocolGuid ## PRODUCES 46 | gEfiBlockIoProtocolGuid ## PRODUCES 47 | gEfiBlockIo2ProtocolGuid ## PRODUCES 48 | gEfiSimpleFileSystemProtocolGuid ## SOMETIMES_CONSUMES 49 | 50 | [Guids] 51 | gEfiVirtualDiskGuid ## SOMETIMES_CONSUMES ## GUID 52 | #Add Start By Lundy 53 | gEfiGlobalVariableGuid 54 | gEfiEventReadyToBootGuid 55 | #Add End By Lundy 56 | 57 | 58 | [Depex] 59 | TRUE 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | -------------------------------------------------------------------------------- /AddBootOption.h: -------------------------------------------------------------------------------- 1 | #ifndef _ADD_BOOT_OPTION_H_ 2 | #define _ADD_BOOT_OPTION_H_ 3 | #include 4 | #include 5 | #include 6 | #include 7 | //#include 8 | #include 9 | 10 | #include 11 | #include 12 | #include 13 | #include 14 | 15 | #include 16 | #include 17 | #include 18 | #include 19 | #include 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | 29 | #include 30 | #include 31 | #include 32 | #include 33 | 34 | #include 35 | 36 | 37 | 38 | VOID 39 | EFIAPI 40 | LundyAddRamDisk( 41 | IN EFI_EVENT Event, 42 | IN VOID *Context 43 | ); 44 | 45 | BOOLEAN 46 | IsVirtualDiskNew ( 47 | IN VOID *DevPath 48 | ); 49 | 50 | 51 | EFI_DEVICE_PATH_PROTOCOL * 52 | EFIAPI 53 | LundyAppendNew ( 54 | IN EFI_DEVICE_PATH_PROTOCOL *InDevicePath, 55 | IN CONST CHAR16 *FileName 56 | ); 57 | 58 | 59 | UINTN 60 | RegisterRamDiskBootOption ( 61 | EFI_DEVICE_PATH_PROTOCOL *RamDp, 62 | CHAR16 *Description, 63 | UINTN Position, 64 | BOOLEAN IsBootCategory 65 | ); 66 | 67 | #endif -------------------------------------------------------------------------------- /RD.h: -------------------------------------------------------------------------------- 1 | #ifndef _RAM_DISK_MAIN_H_ 2 | #define _RAM_DISK_MAIN_H_ 3 | #include 4 | #include 5 | #include 6 | #include 7 | #include 8 | #include 9 | #include 10 | #include 11 | #include 12 | #include 13 | #include 14 | #include 15 | #include 16 | #include 17 | #include 18 | #include 19 | #include 20 | #include 21 | 22 | #ifndef RAM_DISK_BLOCK_SIZE 23 | #define RAM_DISK_BLOCK_SIZE 512 24 | #endif 25 | // 26 | // maintains a list of registered RAM disks. 27 | // The struct contains the list entry and the information of each RAM 28 | // disk 29 | // 30 | typedef struct { 31 | UINTN Signature; 32 | 33 | EFI_HANDLE Handle; 34 | 35 | EFI_BLOCK_IO_PROTOCOL BlockIo; 36 | EFI_BLOCK_IO2_PROTOCOL BlockIo2; 37 | EFI_BLOCK_IO_MEDIA Media; 38 | EFI_DEVICE_PATH_PROTOCOL *DevicePath; 39 | 40 | UINT64 StartingAddr; 41 | UINT64 Size; 42 | EFI_GUID TypeGuid; 43 | UINT16 InstanceNumber; 44 | 45 | LIST_ENTRY ThisInstance; 46 | } RAM_DISK_PRIVATE_DATA; 47 | 48 | #define RAM_DISK_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('R', 'D', 'S', 'K') 49 | #define RAM_DISK_PRIVATE_FROM_BLKIO(a) CR (a, RAM_DISK_PRIVATE_DATA, BlockIo, RAM_DISK_PRIVATE_DATA_SIGNATURE) 50 | #define RAM_DISK_PRIVATE_FROM_BLKIO2(a) CR (a, RAM_DISK_PRIVATE_DATA, BlockIo2, RAM_DISK_PRIVATE_DATA_SIGNATURE) 51 | #define RAM_DISK_PRIVATE_FROM_THIS(a) CR (a, RAM_DISK_PRIVATE_DATA, ThisInstance, RAM_DISK_PRIVATE_DATA_SIGNATURE) 52 | #define EFI_LIST_FOR_EACH(Entry, ListHead) \ 53 | for(Entry = (ListHead)->ForwardLink; Entry != (ListHead); Entry = Entry->ForwardLink) 54 | 55 | // 56 | // Iterate through the double linked list. This is delete-safe. 57 | // Do not touch NextEntry 58 | // 59 | #define EFI_LIST_FOR_EACH_SAFE(Entry, NextEntry, ListHead) \ 60 | for(Entry = (ListHead)->ForwardLink, NextEntry = Entry->ForwardLink;\ 61 | Entry != (ListHead); Entry = NextEntry, NextEntry = Entry->ForwardLink) 62 | 63 | /** 64 | Initialize the BlockIO protocol of a RAM disk device. 65 | 66 | @param[in] PrivateData Points to RAM disk private data. 67 | 68 | **/ 69 | VOID 70 | RamDiskInitBlockIo ( 71 | IN RAM_DISK_PRIVATE_DATA *PrivateData 72 | ); 73 | 74 | /** 75 | Reset the Block Device. 76 | 77 | @param[in] This Indicates a pointer to the calling context. 78 | @param[in] ExtendedVerification 79 | Driver may perform diagnostics on reset. 80 | 81 | @retval EFI_SUCCESS The device was reset. 82 | @retval EFI_DEVICE_ERROR The device is not functioning properly and 83 | could not be reset. 84 | 85 | **/ 86 | EFI_STATUS 87 | EFIAPI 88 | RamDiskBlkIoReset ( 89 | IN EFI_BLOCK_IO_PROTOCOL *This, 90 | IN BOOLEAN ExtendedVerification 91 | ); 92 | 93 | /** 94 | Read BufferSize bytes from Lba into Buffer. 95 | 96 | @param[in] This Indicates a pointer to the calling context. 97 | @param[in] MediaId Id of the media, changes every time the media is 98 | replaced. 99 | @param[in] Lba The starting Logical Block Address to read from. 100 | @param[in] BufferSize Size of Buffer, must be a multiple of device block 101 | size. 102 | @param[out] Buffer A pointer to the destination buffer for the data. 103 | The caller is responsible for either having 104 | implicit or explicit ownership of the buffer. 105 | 106 | @retval EFI_SUCCESS The data was read correctly from the device. 107 | @retval EFI_DEVICE_ERROR The device reported an error while performing 108 | the read. 109 | @retval EFI_NO_MEDIA There is no media in the device. 110 | @retval EFI_MEDIA_CHANGED The MediaId does not matched the current 111 | device. 112 | @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block 113 | size of the device. 114 | @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not 115 | valid, or the buffer is not on proper alignment. 116 | 117 | **/ 118 | EFI_STATUS 119 | EFIAPI 120 | RamDiskBlkIoReadBlocks ( 121 | IN EFI_BLOCK_IO_PROTOCOL *This, 122 | IN UINT32 MediaId, 123 | IN EFI_LBA Lba, 124 | IN UINTN BufferSize, 125 | OUT VOID *Buffer 126 | ); 127 | 128 | /** 129 | Write BufferSize bytes from Lba into Buffer. 130 | 131 | @param[in] This Indicates a pointer to the calling context. 132 | @param[in] MediaId The media ID that the write request is for. 133 | @param[in] Lba The starting logical block address to be written. 134 | The caller is responsible for writing to only 135 | legitimate locations. 136 | @param[in] BufferSize Size of Buffer, must be a multiple of device block 137 | size. 138 | @param[in] Buffer A pointer to the source buffer for the data. 139 | 140 | @retval EFI_SUCCESS The data was written correctly to the device. 141 | @retval EFI_WRITE_PROTECTED The device can not be written to. 142 | @retval EFI_DEVICE_ERROR The device reported an error while performing 143 | the write. 144 | @retval EFI_NO_MEDIA There is no media in the device. 145 | @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current 146 | device. 147 | @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block 148 | size of the device. 149 | @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not 150 | valid, or the buffer is not on proper alignment. 151 | 152 | **/ 153 | EFI_STATUS 154 | EFIAPI 155 | RamDiskBlkIoWriteBlocks ( 156 | IN EFI_BLOCK_IO_PROTOCOL *This, 157 | IN UINT32 MediaId, 158 | IN EFI_LBA Lba, 159 | IN UINTN BufferSize, 160 | IN VOID *Buffer 161 | ); 162 | 163 | /** 164 | Flush the Block Device. 165 | 166 | @param[in] This Indicates a pointer to the calling context. 167 | 168 | @retval EFI_SUCCESS All outstanding data was written to the device. 169 | @retval EFI_DEVICE_ERROR The device reported an error while writting 170 | back the data 171 | @retval EFI_NO_MEDIA There is no media in the device. 172 | 173 | **/ 174 | EFI_STATUS 175 | EFIAPI 176 | RamDiskBlkIoFlushBlocks ( 177 | IN EFI_BLOCK_IO_PROTOCOL *This 178 | ); 179 | 180 | /** 181 | Resets the block device hardware. 182 | 183 | @param[in] This The pointer of EFI_BLOCK_IO2_PROTOCOL. 184 | @param[in] ExtendedVerification The flag about if extend verificate. 185 | 186 | @retval EFI_SUCCESS The device was reset. 187 | @retval EFI_DEVICE_ERROR The block device is not functioning correctly 188 | and could not be reset. 189 | 190 | **/ 191 | EFI_STATUS 192 | EFIAPI 193 | RamDiskBlkIo2Reset ( 194 | IN EFI_BLOCK_IO2_PROTOCOL *This, 195 | IN BOOLEAN ExtendedVerification 196 | ); 197 | 198 | /** 199 | Reads the requested number of blocks from the device. 200 | 201 | @param[in] This Indicates a pointer to the calling context. 202 | @param[in] MediaId The media ID that the read request is for. 203 | @param[in] Lba The starting logical block address to read 204 | from on the device. 205 | @param[in, out] Token A pointer to the token associated with the 206 | transaction. 207 | @param[in] BufferSize The size of the Buffer in bytes. This must be 208 | a multiple of the intrinsic block size of the 209 | device. 210 | @param[out] Buffer A pointer to the destination buffer for the 211 | data. The caller is responsible for either 212 | having implicit or explicit ownership of the 213 | buffer. 214 | 215 | @retval EFI_SUCCESS The read request was queued if Token->Event 216 | is not NULL. The data was read correctly from 217 | the device if the Token->Event is NULL. 218 | @retval EFI_DEVICE_ERROR The device reported an error while attempting 219 | to perform the read operation. 220 | @retval EFI_NO_MEDIA There is no media in the device. 221 | @retval EFI_MEDIA_CHANGED The MediaId is not for the current media. 222 | @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of 223 | the intrinsic block size of the device. 224 | @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not 225 | valid, or the buffer is not on proper 226 | alignment. 227 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a 228 | lack of resources. 229 | 230 | **/ 231 | EFI_STATUS 232 | EFIAPI 233 | RamDiskBlkIo2ReadBlocksEx ( 234 | IN EFI_BLOCK_IO2_PROTOCOL *This, 235 | IN UINT32 MediaId, 236 | IN EFI_LBA Lba, 237 | IN OUT EFI_BLOCK_IO2_TOKEN *Token, 238 | IN UINTN BufferSize, 239 | OUT VOID *Buffer 240 | ); 241 | 242 | /** 243 | Writes a specified number of blocks to the device. 244 | 245 | @param[in] This Indicates a pointer to the calling context. 246 | @param[in] MediaId The media ID that the write request is for. 247 | @param[in] Lba The starting logical block address to be 248 | written. The caller is responsible for 249 | writing to only legitimate locations. 250 | @param[in, out] Token A pointer to the token associated with the 251 | transaction. 252 | @param[in] BufferSize The size in bytes of Buffer. This must be a 253 | multiple of the intrinsic block size of the 254 | device. 255 | @param[in] Buffer A pointer to the source buffer for the data. 256 | 257 | @retval EFI_SUCCESS The write request was queued if Event is not 258 | NULL. The data was written correctly to the 259 | device if the Event is NULL. 260 | @retval EFI_WRITE_PROTECTED The device cannot be written to. 261 | @retval EFI_NO_MEDIA There is no media in the device. 262 | @retval EFI_MEDIA_CHANGED The MediaId is not for the current media. 263 | @retval EFI_DEVICE_ERROR The device reported an error while attempting 264 | to perform the write operation. 265 | @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of 266 | the intrinsic block size of the device. 267 | @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not 268 | valid, or the buffer is not on proper 269 | alignment. 270 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a 271 | lack of resources. 272 | 273 | **/ 274 | EFI_STATUS 275 | EFIAPI 276 | RamDiskBlkIo2WriteBlocksEx ( 277 | IN EFI_BLOCK_IO2_PROTOCOL *This, 278 | IN UINT32 MediaId, 279 | IN EFI_LBA Lba, 280 | IN OUT EFI_BLOCK_IO2_TOKEN *Token, 281 | IN UINTN BufferSize, 282 | IN VOID *Buffer 283 | ); 284 | 285 | /** 286 | Flushes all modified data to a physical block device. 287 | 288 | @param[in] This Indicates a pointer to the calling context. 289 | @param[in, out] Token A pointer to the token associated with the 290 | transaction. 291 | 292 | @retval EFI_SUCCESS The flush request was queued if Event is not 293 | NULL. All outstanding data was written 294 | correctly to the device if the Event is NULL. 295 | @retval EFI_DEVICE_ERROR The device reported an error while attempting 296 | to write data. 297 | @retval EFI_WRITE_PROTECTED The device cannot be written to. 298 | @retval EFI_NO_MEDIA There is no media in the device. 299 | @retval EFI_MEDIA_CHANGED The MediaId is not for the current media. 300 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a 301 | lack of resources. 302 | 303 | **/ 304 | EFI_STATUS 305 | EFIAPI 306 | RamDiskBlkIo2FlushBlocksEx ( 307 | IN EFI_BLOCK_IO2_PROTOCOL *This, 308 | IN OUT EFI_BLOCK_IO2_TOKEN *Token 309 | ); 310 | #endif 311 | -------------------------------------------------------------------------------- /RDMain.c: -------------------------------------------------------------------------------- 1 | #include "RD.h" 2 | //Add Start By Lundy 3 | #include "AddBootOption.h" 4 | #define EFI_VIRTUAL_DISK_FILE_NAME L"\\EFI\\OC\\OpenCore.efi" 5 | 6 | #define NEW_BOOT_OPTION_NAME L"Scorpion" 7 | //Add End By Lundy 8 | extern unsigned char __data_img[]; 9 | 10 | extern unsigned int __data_img_len; 11 | // 12 | // Handle for the EFI_RAM_DISK_PROTOCOL instance 13 | // 14 | EFI_HANDLE mRamDiskHandle = NULL; 15 | 16 | // 17 | // RamDiskDxe driver maintains a list of registered RAM disks. 18 | // 19 | LIST_ENTRY RegisteredRamDisks; 20 | 21 | 22 | RAM_DISK_PRIVATE_DATA mRamDiskPrivateDataTemplate = { 23 | RAM_DISK_PRIVATE_DATA_SIGNATURE, 24 | NULL 25 | }; 26 | 27 | MEDIA_RAM_DISK_DEVICE_PATH mRamDiskDeviceNodeTemplate = { 28 | { 29 | MEDIA_DEVICE_PATH, 30 | MEDIA_RAM_DISK_DP, 31 | { 32 | (UINT8) (sizeof (MEDIA_RAM_DISK_DEVICE_PATH)), 33 | (UINT8) ((sizeof (MEDIA_RAM_DISK_DEVICE_PATH)) >> 8) 34 | } 35 | } 36 | }; 37 | 38 | 39 | /** 40 | Initialize the RAM disk device node. 41 | 42 | @param[in] PrivateData Points to RAM disk private data. 43 | @param[in, out] RamDiskDevNode Points to the RAM disk device node. 44 | 45 | **/ 46 | VOID 47 | RamDiskInitDeviceNode ( 48 | IN RAM_DISK_PRIVATE_DATA *PrivateData, 49 | IN OUT MEDIA_RAM_DISK_DEVICE_PATH *RamDiskDevNode 50 | ) 51 | { 52 | WriteUnaligned64 ( 53 | (UINT64 *) &(RamDiskDevNode->StartingAddr[0]), 54 | (UINT64) PrivateData->StartingAddr 55 | ); 56 | WriteUnaligned64 ( 57 | (UINT64 *) &(RamDiskDevNode->EndingAddr[0]), 58 | (UINT64) PrivateData->StartingAddr + PrivateData->Size - 1 59 | ); 60 | CopyGuid (&RamDiskDevNode->TypeGuid, &PrivateData->TypeGuid); 61 | RamDiskDevNode->Instance = PrivateData->InstanceNumber; 62 | } 63 | 64 | 65 | /** 66 | Register a RAM disk with specified address, size and type. 67 | 68 | @param[in] RamDiskBase The base address of registered RAM disk. 69 | @param[in] RamDiskSize The size of registered RAM disk. 70 | @param[in] RamDiskType The type of registered RAM disk. The GUID can be 71 | any of the values defined in section 9.3.6.9, or a 72 | vendor defined GUID. 73 | @param[in] ParentDevicePath 74 | Pointer to the parent device path. If there is no 75 | parent device path then ParentDevicePath is NULL. 76 | @param[out] DevicePath On return, points to a pointer to the device path 77 | of the RAM disk device. 78 | If ParentDevicePath is not NULL, the returned 79 | DevicePath is created by appending a RAM disk node 80 | to the parent device path. If ParentDevicePath is 81 | NULL, the returned DevicePath is a RAM disk device 82 | path without appending. This function is 83 | responsible for allocating the buffer DevicePath 84 | with the boot service AllocatePool(). 85 | 86 | @retval EFI_SUCCESS The RAM disk is registered successfully. 87 | @retval EFI_INVALID_PARAMETER DevicePath or RamDiskType is NULL. 88 | RamDiskSize is 0. 89 | @retval EFI_ALREADY_STARTED A Device Path Protocol instance to be created 90 | is already present in the handle database. 91 | @retval EFI_OUT_OF_RESOURCES The RAM disk register operation fails due to 92 | resource limitation. 93 | 94 | **/ 95 | EFI_STATUS 96 | EFIAPI 97 | RamDiskRegister ( 98 | IN UINT64 RamDiskBase, 99 | IN UINT64 RamDiskSize, 100 | IN EFI_GUID *RamDiskType, 101 | IN EFI_DEVICE_PATH *ParentDevicePath OPTIONAL, 102 | OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath 103 | ) 104 | { 105 | EFI_STATUS Status; 106 | RAM_DISK_PRIVATE_DATA *PrivateData; 107 | RAM_DISK_PRIVATE_DATA *RegisteredPrivateData; 108 | MEDIA_RAM_DISK_DEVICE_PATH *RamDiskDevNode; 109 | UINTN DevicePathSize; 110 | LIST_ENTRY *Entry; 111 | 112 | if ((0 == RamDiskSize) || (NULL == RamDiskType) || (NULL == DevicePath)) { 113 | return EFI_INVALID_PARAMETER; 114 | } 115 | 116 | // 117 | // Add check to prevent data read across the memory boundary 118 | // 119 | if (RamDiskBase + RamDiskSize > ((UINTN) -1) - RAM_DISK_BLOCK_SIZE + 1) { 120 | return EFI_INVALID_PARAMETER; 121 | } 122 | 123 | RamDiskDevNode = NULL; 124 | 125 | // 126 | // Create a new RAM disk instance and initialize its private data 127 | // 128 | PrivateData = AllocateCopyPool ( 129 | sizeof (RAM_DISK_PRIVATE_DATA), 130 | &mRamDiskPrivateDataTemplate 131 | ); 132 | if (NULL == PrivateData) { 133 | return EFI_OUT_OF_RESOURCES; 134 | } 135 | 136 | PrivateData->StartingAddr = RamDiskBase; 137 | PrivateData->Size = RamDiskSize; 138 | CopyGuid (&PrivateData->TypeGuid, RamDiskType); 139 | InitializeListHead (&PrivateData->ThisInstance); 140 | 141 | // 142 | // Generate device path information for the registered RAM disk 143 | // 144 | RamDiskDevNode = AllocateCopyPool ( 145 | sizeof (MEDIA_RAM_DISK_DEVICE_PATH), 146 | &mRamDiskDeviceNodeTemplate 147 | ); 148 | if (NULL == RamDiskDevNode) { 149 | Status = EFI_OUT_OF_RESOURCES; 150 | goto ErrorExit; 151 | } 152 | 153 | RamDiskInitDeviceNode (PrivateData, RamDiskDevNode); 154 | 155 | *DevicePath = AppendDevicePathNode ( 156 | ParentDevicePath, 157 | (EFI_DEVICE_PATH_PROTOCOL *) RamDiskDevNode 158 | ); 159 | if (NULL == *DevicePath) { 160 | Status = EFI_OUT_OF_RESOURCES; 161 | goto ErrorExit; 162 | } 163 | 164 | PrivateData->DevicePath = *DevicePath; 165 | 166 | // 167 | // Check whether the created device path is already present in the handle 168 | // database 169 | // 170 | if (!IsListEmpty(&RegisteredRamDisks)) { 171 | DevicePathSize = GetDevicePathSize (PrivateData->DevicePath); 172 | 173 | EFI_LIST_FOR_EACH (Entry, &RegisteredRamDisks) { 174 | RegisteredPrivateData = RAM_DISK_PRIVATE_FROM_THIS (Entry); 175 | if (DevicePathSize == GetDevicePathSize (RegisteredPrivateData->DevicePath)) { 176 | // 177 | // Compare device path 178 | // 179 | if ((CompareMem ( 180 | PrivateData->DevicePath, 181 | RegisteredPrivateData->DevicePath, 182 | DevicePathSize)) == 0) { 183 | *DevicePath = NULL; 184 | Status = EFI_ALREADY_STARTED; 185 | goto ErrorExit; 186 | } 187 | } 188 | } 189 | } 190 | 191 | // 192 | // Fill Block IO protocol informations for the RAM disk 193 | // 194 | RamDiskInitBlockIo (PrivateData); 195 | 196 | // 197 | // Install EFI_DEVICE_PATH_PROTOCOL & EFI_BLOCK_IO(2)_PROTOCOL on a new 198 | // handle 199 | // 200 | Status = gBS->InstallMultipleProtocolInterfaces ( 201 | &PrivateData->Handle, 202 | &gEfiBlockIoProtocolGuid, 203 | &PrivateData->BlockIo, 204 | &gEfiBlockIo2ProtocolGuid, 205 | &PrivateData->BlockIo2, 206 | &gEfiDevicePathProtocolGuid, 207 | PrivateData->DevicePath, 208 | NULL 209 | ); 210 | if (EFI_ERROR (Status)) { 211 | goto ErrorExit; 212 | } 213 | 214 | // 215 | // Insert the newly created one to the registered RAM disk list 216 | // 217 | InsertTailList (&RegisteredRamDisks, &PrivateData->ThisInstance); 218 | 219 | gBS->ConnectController (PrivateData->Handle, NULL, NULL, TRUE); 220 | 221 | FreePool (RamDiskDevNode); 222 | 223 | return EFI_SUCCESS; 224 | 225 | ErrorExit: 226 | if (RamDiskDevNode != NULL) { 227 | FreePool (RamDiskDevNode); 228 | } 229 | 230 | if (PrivateData != NULL) { 231 | if (PrivateData->DevicePath) { 232 | FreePool (PrivateData->DevicePath); 233 | } 234 | 235 | FreePool (PrivateData); 236 | } 237 | 238 | return Status; 239 | } 240 | 241 | 242 | //************************************************************************************** 243 | //Add Start By Lundy 244 | VOID 245 | EFIAPI 246 | LundyAddRamDisk( 247 | IN EFI_EVENT Event, 248 | IN VOID *Context 249 | ) 250 | { 251 | EFI_HANDLE *FileSystemHandles; 252 | UINTN NumberFileSystemHandles; 253 | UINTN Index; 254 | EFI_DEVICE_PATH_PROTOCOL *InDevicePath; 255 | BOOLEAN flag; 256 | //CHAR16 *DevPathStr; 257 | 258 | UINTN BootOptionCount; 259 | EFI_BOOT_MANAGER_LOAD_OPTION *BootOptions; 260 | //UINTN Index; 261 | //UINTN OptionNumber; 262 | 263 | //Print(L"LundyAddRamDisk Start\n"); 264 | 265 | BootOptions = EfiBootManagerGetLoadOptions (&BootOptionCount, LoadOptionTypeBoot); 266 | 267 | for (Index = 0; Index < BootOptionCount; Index++) { 268 | if(!StrCmp(NEW_BOOT_OPTION_NAME,BootOptions[Index].Description)){ 269 | EfiBootManagerDeleteLoadOptionVariable (BootOptions[Index].OptionNumber, LoadOptionTypeBoot);; 270 | } 271 | } 272 | 273 | 274 | 275 | gBS->LocateHandleBuffer ( 276 | ByProtocol, 277 | &gEfiSimpleFileSystemProtocolGuid, 278 | NULL, 279 | &NumberFileSystemHandles, 280 | &FileSystemHandles 281 | ); 282 | // for (Index = 0; Index < NumberFileSystemHandles; Index++) { 283 | 284 | // InDevicePath = DevicePathFromHandle (FileSystemHandles[Index]); 285 | // if(IsVirtualDiskNew(InDevicePath)){ 286 | // DevPathStr = ConvertDevicePathToText (InDevicePath, FALSE, FALSE); 287 | // DEBUG ((DEBUG_INFO , "Lundy %s\n", DevPathStr)); 288 | // if(StrlenNew(DevPathStr)>60) 289 | // return; 290 | // } 291 | // } 292 | 293 | for (Index = 0; Index < NumberFileSystemHandles; Index++) { 294 | 295 | InDevicePath = DevicePathFromHandle (FileSystemHandles[Index]); 296 | flag = IsVirtualDiskNew(InDevicePath); 297 | //Print(L"66666 %d\n",flag); 298 | if(flag){ 299 | RegisterRamDiskBootOption(InDevicePath,NEW_BOOT_OPTION_NAME, (UINTN) -1, TRUE); 300 | break; 301 | } 302 | } 303 | } 304 | 305 | 306 | BOOLEAN 307 | IsVirtualDiskNew ( 308 | IN VOID *DevPath 309 | ) 310 | { 311 | MEDIA_RAM_DISK_DEVICE_PATH *RamDisk; 312 | 313 | RamDisk = DevPath; 314 | 315 | if (CompareGuid (&RamDisk->TypeGuid, &gEfiVirtualDiskGuid)) { 316 | return TRUE; 317 | } 318 | return FALSE; 319 | } 320 | 321 | 322 | 323 | EFI_DEVICE_PATH_PROTOCOL * 324 | EFIAPI 325 | LundyAppendNew ( 326 | IN EFI_DEVICE_PATH_PROTOCOL *InDevicePath, 327 | IN CONST CHAR16 *FileName 328 | ) 329 | { 330 | UINTN Size; 331 | FILEPATH_DEVICE_PATH *FilePath; 332 | EFI_DEVICE_PATH_PROTOCOL *DevicePath; 333 | EFI_DEVICE_PATH_PROTOCOL *FileDevicePath; 334 | 335 | DevicePath = NULL; 336 | 337 | Size = StrSize (FileName); 338 | FileDevicePath = AllocatePool (Size + SIZE_OF_FILEPATH_DEVICE_PATH + END_DEVICE_PATH_LENGTH); 339 | if (FileDevicePath != NULL) { 340 | FilePath = (FILEPATH_DEVICE_PATH *) FileDevicePath; 341 | FilePath->Header.Type = MEDIA_DEVICE_PATH; 342 | FilePath->Header.SubType = MEDIA_FILEPATH_DP; 343 | CopyMem (&FilePath->PathName, FileName, Size); 344 | SetDevicePathNodeLength (&FilePath->Header, Size + SIZE_OF_FILEPATH_DEVICE_PATH); 345 | SetDevicePathEndNode (NextDevicePathNode (&FilePath->Header)); 346 | 347 | //if (Device != NULL) { 348 | // DevicePath = DevicePathFromHandle (Device); 349 | //} 350 | 351 | DevicePath = AppendDevicePath (InDevicePath, FileDevicePath); 352 | FreePool (FileDevicePath); 353 | } 354 | 355 | return DevicePath; 356 | } 357 | 358 | 359 | UINTN 360 | RegisterRamDiskBootOption ( 361 | EFI_DEVICE_PATH_PROTOCOL *RamDp, 362 | CHAR16 *Description, 363 | UINTN Position, 364 | BOOLEAN IsBootCategory 365 | ) 366 | { 367 | EFI_STATUS Status; 368 | EFI_BOOT_MANAGER_LOAD_OPTION NewOption; 369 | EFI_DEVICE_PATH_PROTOCOL *DevicePath; 370 | UINTN OptionNumber; 371 | 372 | DevicePath = LundyAppendNew(RamDp,EFI_VIRTUAL_DISK_FILE_NAME); 373 | Status = EfiBootManagerInitializeLoadOption ( 374 | &NewOption, 375 | LoadOptionNumberUnassigned, 376 | LoadOptionTypeBoot, 377 | IsBootCategory ? LOAD_OPTION_ACTIVE : LOAD_OPTION_CATEGORY_APP, 378 | Description, 379 | DevicePath, 380 | NULL, 381 | 0 382 | ); 383 | ASSERT_EFI_ERROR (Status); 384 | FreePool (DevicePath); 385 | 386 | Status = EfiBootManagerAddLoadOptionVariable (&NewOption, Position); 387 | ASSERT_EFI_ERROR (Status); 388 | 389 | OptionNumber = NewOption.OptionNumber; 390 | 391 | EfiBootManagerFreeLoadOption (&NewOption); 392 | 393 | return OptionNumber; 394 | } 395 | //Add End By Lundy 396 | //************************************************************************************** 397 | 398 | 399 | 400 | 401 | 402 | /** 403 | The entry point for RamDisk 404 | 405 | @param[in] ImageHandle The image handle of the driver. 406 | @param[in] SystemTable The system table. 407 | 408 | @retval EFI_SUCCES All the related protocols are installed on 409 | the driver. 410 | 411 | **/ 412 | EFI_STATUS 413 | EFIAPI 414 | RDEntryPoint ( 415 | IN EFI_HANDLE ImageHandle, 416 | IN EFI_SYSTEM_TABLE *SystemTable 417 | ) 418 | { 419 | EFI_STATUS Status; 420 | UINT64 *StartingAddr; 421 | EFI_DEVICE_PATH_PROTOCOL *DevicePath; 422 | //Add Start By Lundy 423 | EFI_EVENT ReadyToBootEvent; 424 | //Add End By Lundy 425 | // 426 | // Initialize the list of registered RAM disks maintained by the driver 427 | // 428 | InitializeListHead (&RegisteredRamDisks); 429 | 430 | // 431 | // Allocate boot service data for this 432 | // 433 | Status = gBS->AllocatePool ( 434 | EfiBootServicesData, 435 | (UINTN)__data_img_len, 436 | (VOID**)&StartingAddr 437 | ); 438 | if (EFI_ERROR (Status)) { 439 | DEBUG ((EFI_D_ERROR, "Allocate Memory Failed\n")); 440 | } 441 | 442 | // 443 | // regesiter ramdisk by data.img.h 444 | // 445 | CopyMem ((UINT8 *)(UINTN)StartingAddr, __data_img, __data_img_len); 446 | Status = RamDiskRegister ( 447 | ((UINT64)(UINTN) StartingAddr), 448 | __data_img_len, 449 | &gEfiVirtualDiskGuid, 450 | NULL, 451 | &DevicePath 452 | ); 453 | if (EFI_ERROR (Status)) { 454 | DEBUG ((EFI_D_ERROR, "Register ramdisk failed\n")); 455 | } 456 | //Add Start By Lundy 457 | Status = gBS->CreateEventEx ( 458 | EVT_NOTIFY_SIGNAL, 459 | TPL_NOTIFY, 460 | LundyAddRamDisk, 461 | NULL, 462 | &gEfiEventReadyToBootGuid, 463 | &ReadyToBootEvent 464 | ); 465 | if (EFI_ERROR (Status)) { 466 | DEBUG ((EFI_D_ERROR, "Create ramdisk failed\n")); 467 | } 468 | //Add End By Lundy 469 | 470 | return EFI_SUCCESS; 471 | 472 | } 473 | 474 | 475 | 476 | 477 | 478 | 479 | 480 | 481 | -------------------------------------------------------------------------------- /RDBlockIo.c: -------------------------------------------------------------------------------- 1 | 2 | 3 | #include "RD.h" 4 | 5 | // 6 | // The EFI_BLOCK_IO_PROTOCOL instances that is installed onto the handle 7 | // for newly registered RAM disks 8 | // 9 | EFI_BLOCK_IO_PROTOCOL mRamDiskBlockIoTemplate = { 10 | EFI_BLOCK_IO_PROTOCOL_REVISION, 11 | (EFI_BLOCK_IO_MEDIA *) 0, 12 | RamDiskBlkIoReset, 13 | RamDiskBlkIoReadBlocks, 14 | RamDiskBlkIoWriteBlocks, 15 | RamDiskBlkIoFlushBlocks 16 | }; 17 | 18 | // 19 | // The EFI_BLOCK_IO_PROTOCOL2 instances that is installed onto the handle 20 | // for newly registered RAM disks 21 | // 22 | EFI_BLOCK_IO2_PROTOCOL mRamDiskBlockIo2Template = { 23 | (EFI_BLOCK_IO_MEDIA *) 0, 24 | RamDiskBlkIo2Reset, 25 | RamDiskBlkIo2ReadBlocksEx, 26 | RamDiskBlkIo2WriteBlocksEx, 27 | RamDiskBlkIo2FlushBlocksEx 28 | }; 29 | 30 | 31 | /** 32 | Initialize the BlockIO & BlockIO2 protocol of a RAM disk device. 33 | 34 | @param[in] PrivateData Points to RAM disk private data. 35 | 36 | **/ 37 | VOID 38 | RamDiskInitBlockIo ( 39 | IN RAM_DISK_PRIVATE_DATA *PrivateData 40 | ) 41 | { 42 | EFI_BLOCK_IO_PROTOCOL *BlockIo; 43 | EFI_BLOCK_IO2_PROTOCOL *BlockIo2; 44 | EFI_BLOCK_IO_MEDIA *Media; 45 | 46 | BlockIo = &PrivateData->BlockIo; 47 | BlockIo2 = &PrivateData->BlockIo2; 48 | Media = &PrivateData->Media; 49 | 50 | CopyMem (BlockIo, &mRamDiskBlockIoTemplate, sizeof (EFI_BLOCK_IO_PROTOCOL)); 51 | CopyMem (BlockIo2, &mRamDiskBlockIo2Template, sizeof (EFI_BLOCK_IO2_PROTOCOL)); 52 | 53 | BlockIo->Media = Media; 54 | BlockIo2->Media = Media; 55 | Media->RemovableMedia = FALSE; 56 | Media->MediaPresent = TRUE; 57 | Media->LogicalPartition = FALSE; 58 | Media->ReadOnly = FALSE; 59 | Media->WriteCaching = FALSE; 60 | Media->BlockSize = RAM_DISK_BLOCK_SIZE; 61 | Media->LastBlock = DivU64x32 ( 62 | PrivateData->Size + RAM_DISK_BLOCK_SIZE - 1, 63 | RAM_DISK_BLOCK_SIZE 64 | ) - 1; 65 | } 66 | 67 | 68 | /** 69 | Reset the Block Device. 70 | 71 | @param This Indicates a pointer to the calling context. 72 | @param ExtendedVerification Driver may perform diagnostics on reset. 73 | 74 | @retval EFI_SUCCESS The device was reset. 75 | @retval EFI_DEVICE_ERROR The device is not functioning properly and could 76 | not be reset. 77 | 78 | **/ 79 | EFI_STATUS 80 | EFIAPI 81 | RamDiskBlkIoReset ( 82 | IN EFI_BLOCK_IO_PROTOCOL *This, 83 | IN BOOLEAN ExtendedVerification 84 | ) 85 | { 86 | return EFI_SUCCESS; 87 | } 88 | 89 | 90 | /** 91 | Read BufferSize bytes from Lba into Buffer. 92 | 93 | @param[in] This Indicates a pointer to the calling context. 94 | @param[in] MediaId Id of the media, changes every time the media is 95 | replaced. 96 | @param[in] Lba The starting Logical Block Address to read from. 97 | @param[in] BufferSize Size of Buffer, must be a multiple of device block 98 | size. 99 | @param[out] Buffer A pointer to the destination buffer for the data. 100 | The caller is responsible for either having 101 | implicit or explicit ownership of the buffer. 102 | 103 | @retval EFI_SUCCESS The data was read correctly from the device. 104 | @retval EFI_DEVICE_ERROR The device reported an error while performing 105 | the read. 106 | @retval EFI_NO_MEDIA There is no media in the device. 107 | @retval EFI_MEDIA_CHANGED The MediaId does not matched the current 108 | device. 109 | @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block 110 | size of the device. 111 | @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not 112 | valid, or the buffer is not on proper alignment. 113 | 114 | **/ 115 | EFI_STATUS 116 | EFIAPI 117 | RamDiskBlkIoReadBlocks ( 118 | IN EFI_BLOCK_IO_PROTOCOL *This, 119 | IN UINT32 MediaId, 120 | IN EFI_LBA Lba, 121 | IN UINTN BufferSize, 122 | OUT VOID *Buffer 123 | ) 124 | { 125 | RAM_DISK_PRIVATE_DATA *PrivateData; 126 | UINTN NumberOfBlocks; 127 | 128 | PrivateData = RAM_DISK_PRIVATE_FROM_BLKIO (This); 129 | 130 | if (MediaId != PrivateData->Media.MediaId) { 131 | return EFI_MEDIA_CHANGED; 132 | } 133 | 134 | if (Buffer == NULL) { 135 | return EFI_INVALID_PARAMETER; 136 | } 137 | 138 | if (BufferSize == 0) { 139 | return EFI_SUCCESS; 140 | } 141 | 142 | if ((BufferSize % PrivateData->Media.BlockSize) != 0) { 143 | return EFI_BAD_BUFFER_SIZE; 144 | } 145 | 146 | if (Lba > PrivateData->Media.LastBlock) { 147 | return EFI_INVALID_PARAMETER; 148 | } 149 | 150 | NumberOfBlocks = BufferSize / PrivateData->Media.BlockSize; 151 | if ((Lba + NumberOfBlocks - 1) > PrivateData->Media.LastBlock) { 152 | return EFI_INVALID_PARAMETER; 153 | } 154 | 155 | CopyMem ( 156 | Buffer, 157 | (VOID *)(UINTN)(PrivateData->StartingAddr + MultU64x32 (Lba, PrivateData->Media.BlockSize)), 158 | BufferSize 159 | ); 160 | 161 | return EFI_SUCCESS; 162 | } 163 | 164 | 165 | /** 166 | Write BufferSize bytes from Lba into Buffer. 167 | 168 | @param[in] This Indicates a pointer to the calling context. 169 | @param[in] MediaId The media ID that the write request is for. 170 | @param[in] Lba The starting logical block address to be written. 171 | The caller is responsible for writing to only 172 | legitimate locations. 173 | @param[in] BufferSize Size of Buffer, must be a multiple of device block 174 | size. 175 | @param[in] Buffer A pointer to the source buffer for the data. 176 | 177 | @retval EFI_SUCCESS The data was written correctly to the device. 178 | @retval EFI_WRITE_PROTECTED The device can not be written to. 179 | @retval EFI_DEVICE_ERROR The device reported an error while performing 180 | the write. 181 | @retval EFI_NO_MEDIA There is no media in the device. 182 | @retval EFI_MEDIA_CHNAGED The MediaId does not matched the current 183 | device. 184 | @retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block 185 | size of the device. 186 | @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not 187 | valid, or the buffer is not on proper alignment. 188 | 189 | **/ 190 | EFI_STATUS 191 | EFIAPI 192 | RamDiskBlkIoWriteBlocks ( 193 | IN EFI_BLOCK_IO_PROTOCOL *This, 194 | IN UINT32 MediaId, 195 | IN EFI_LBA Lba, 196 | IN UINTN BufferSize, 197 | IN VOID *Buffer 198 | ) 199 | { 200 | RAM_DISK_PRIVATE_DATA *PrivateData; 201 | UINTN NumberOfBlocks; 202 | 203 | PrivateData = RAM_DISK_PRIVATE_FROM_BLKIO (This); 204 | 205 | if (MediaId != PrivateData->Media.MediaId) { 206 | return EFI_MEDIA_CHANGED; 207 | } 208 | 209 | if (TRUE == PrivateData->Media.ReadOnly) { 210 | return EFI_WRITE_PROTECTED; 211 | } 212 | 213 | if (Buffer == NULL) { 214 | return EFI_INVALID_PARAMETER; 215 | } 216 | 217 | if (BufferSize == 0) { 218 | return EFI_SUCCESS; 219 | } 220 | 221 | if ((BufferSize % PrivateData->Media.BlockSize) != 0) { 222 | return EFI_BAD_BUFFER_SIZE; 223 | } 224 | 225 | if (Lba > PrivateData->Media.LastBlock) { 226 | return EFI_INVALID_PARAMETER; 227 | } 228 | 229 | NumberOfBlocks = BufferSize / PrivateData->Media.BlockSize; 230 | if ((Lba + NumberOfBlocks - 1) > PrivateData->Media.LastBlock) { 231 | return EFI_INVALID_PARAMETER; 232 | } 233 | 234 | CopyMem ( 235 | (VOID *)(UINTN)(PrivateData->StartingAddr + MultU64x32 (Lba, PrivateData->Media.BlockSize)), 236 | Buffer, 237 | BufferSize 238 | ); 239 | 240 | return EFI_SUCCESS; 241 | } 242 | 243 | 244 | /** 245 | Flush the Block Device. 246 | 247 | @param[in] This Indicates a pointer to the calling context. 248 | 249 | @retval EFI_SUCCESS All outstanding data was written to the device. 250 | @retval EFI_DEVICE_ERROR The device reported an error while writting 251 | back the data 252 | @retval EFI_NO_MEDIA There is no media in the device. 253 | 254 | **/ 255 | EFI_STATUS 256 | EFIAPI 257 | RamDiskBlkIoFlushBlocks ( 258 | IN EFI_BLOCK_IO_PROTOCOL *This 259 | ) 260 | { 261 | return EFI_SUCCESS; 262 | } 263 | 264 | 265 | /** 266 | Resets the block device hardware. 267 | 268 | @param[in] This The pointer of EFI_BLOCK_IO2_PROTOCOL. 269 | @param[in] ExtendedVerification The flag about if extend verificate. 270 | 271 | @retval EFI_SUCCESS The device was reset. 272 | @retval EFI_DEVICE_ERROR The block device is not functioning correctly 273 | and could not be reset. 274 | 275 | **/ 276 | EFI_STATUS 277 | EFIAPI 278 | RamDiskBlkIo2Reset ( 279 | IN EFI_BLOCK_IO2_PROTOCOL *This, 280 | IN BOOLEAN ExtendedVerification 281 | ) 282 | { 283 | return EFI_SUCCESS; 284 | } 285 | 286 | 287 | /** 288 | Reads the requested number of blocks from the device. 289 | 290 | @param[in] This Indicates a pointer to the calling context. 291 | @param[in] MediaId The media ID that the read request is for. 292 | @param[in] Lba The starting logical block address to read 293 | from on the device. 294 | @param[in, out] Token A pointer to the token associated with the 295 | transaction. 296 | @param[in] BufferSize The size of the Buffer in bytes. This must be 297 | a multiple of the intrinsic block size of the 298 | device. 299 | @param[out] Buffer A pointer to the destination buffer for the 300 | data. The caller is responsible for either 301 | having implicit or explicit ownership of the 302 | buffer. 303 | 304 | @retval EFI_SUCCESS The read request was queued if Token->Event 305 | is not NULL. The data was read correctly from 306 | the device if the Token->Event is NULL. 307 | @retval EFI_DEVICE_ERROR The device reported an error while attempting 308 | to perform the read operation. 309 | @retval EFI_NO_MEDIA There is no media in the device. 310 | @retval EFI_MEDIA_CHANGED The MediaId is not for the current media. 311 | @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of 312 | the intrinsic block size of the device. 313 | @retval EFI_INVALID_PARAMETER The read request contains LBAs that are not 314 | valid, or the buffer is not on proper 315 | alignment. 316 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a 317 | lack of resources. 318 | 319 | **/ 320 | EFI_STATUS 321 | EFIAPI 322 | RamDiskBlkIo2ReadBlocksEx ( 323 | IN EFI_BLOCK_IO2_PROTOCOL *This, 324 | IN UINT32 MediaId, 325 | IN EFI_LBA Lba, 326 | IN OUT EFI_BLOCK_IO2_TOKEN *Token, 327 | IN UINTN BufferSize, 328 | OUT VOID *Buffer 329 | ) 330 | { 331 | RAM_DISK_PRIVATE_DATA *PrivateData; 332 | EFI_STATUS Status; 333 | 334 | PrivateData = RAM_DISK_PRIVATE_FROM_BLKIO2 (This); 335 | 336 | Status = RamDiskBlkIoReadBlocks ( 337 | &PrivateData->BlockIo, 338 | MediaId, 339 | Lba, 340 | BufferSize, 341 | Buffer 342 | ); 343 | if (EFI_ERROR (Status)) { 344 | return Status; 345 | } 346 | 347 | // 348 | // If caller's event is given, signal it after the memory read completes. 349 | // 350 | if ((Token != NULL) && (Token->Event != NULL)) { 351 | Token->TransactionStatus = EFI_SUCCESS; 352 | gBS->SignalEvent (Token->Event); 353 | } 354 | 355 | return EFI_SUCCESS; 356 | } 357 | 358 | 359 | /** 360 | Writes a specified number of blocks to the device. 361 | 362 | @param[in] This Indicates a pointer to the calling context. 363 | @param[in] MediaId The media ID that the write request is for. 364 | @param[in] Lba The starting logical block address to be 365 | written. The caller is responsible for 366 | writing to only legitimate locations. 367 | @param[in, out] Token A pointer to the token associated with the 368 | transaction. 369 | @param[in] BufferSize The size in bytes of Buffer. This must be a 370 | multiple of the intrinsic block size of the 371 | device. 372 | @param[in] Buffer A pointer to the source buffer for the data. 373 | 374 | @retval EFI_SUCCESS The write request was queued if Event is not 375 | NULL. The data was written correctly to the 376 | device if the Event is NULL. 377 | @retval EFI_WRITE_PROTECTED The device cannot be written to. 378 | @retval EFI_NO_MEDIA There is no media in the device. 379 | @retval EFI_MEDIA_CHANGED The MediaId is not for the current media. 380 | @retval EFI_DEVICE_ERROR The device reported an error while attempting 381 | to perform the write operation. 382 | @retval EFI_BAD_BUFFER_SIZE The BufferSize parameter is not a multiple of 383 | the intrinsic block size of the device. 384 | @retval EFI_INVALID_PARAMETER The write request contains LBAs that are not 385 | valid, or the buffer is not on proper 386 | alignment. 387 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a 388 | lack of resources. 389 | 390 | **/ 391 | EFI_STATUS 392 | EFIAPI 393 | RamDiskBlkIo2WriteBlocksEx ( 394 | IN EFI_BLOCK_IO2_PROTOCOL *This, 395 | IN UINT32 MediaId, 396 | IN EFI_LBA Lba, 397 | IN OUT EFI_BLOCK_IO2_TOKEN *Token, 398 | IN UINTN BufferSize, 399 | IN VOID *Buffer 400 | ) 401 | { 402 | RAM_DISK_PRIVATE_DATA *PrivateData; 403 | EFI_STATUS Status; 404 | 405 | PrivateData = RAM_DISK_PRIVATE_FROM_BLKIO2 (This); 406 | 407 | Status = RamDiskBlkIoWriteBlocks ( 408 | &PrivateData->BlockIo, 409 | MediaId, 410 | Lba, 411 | BufferSize, 412 | Buffer 413 | ); 414 | if (EFI_ERROR (Status)) { 415 | return Status; 416 | } 417 | 418 | // 419 | // If caller's event is given, signal it after the memory write completes. 420 | // 421 | if ((Token != NULL) && (Token->Event != NULL)) { 422 | Token->TransactionStatus = EFI_SUCCESS; 423 | gBS->SignalEvent (Token->Event); 424 | } 425 | 426 | return EFI_SUCCESS; 427 | } 428 | 429 | 430 | /** 431 | Flushes all modified data to a physical block device. 432 | 433 | @param[in] This Indicates a pointer to the calling context. 434 | @param[in, out] Token A pointer to the token associated with the 435 | transaction. 436 | 437 | @retval EFI_SUCCESS The flush request was queued if Event is not 438 | NULL. All outstanding data was written 439 | correctly to the device if the Event is NULL. 440 | @retval EFI_DEVICE_ERROR The device reported an error while attempting 441 | to write data. 442 | @retval EFI_WRITE_PROTECTED The device cannot be written to. 443 | @retval EFI_NO_MEDIA There is no media in the device. 444 | @retval EFI_MEDIA_CHANGED The MediaId is not for the current media. 445 | @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a 446 | lack of resources. 447 | 448 | **/ 449 | EFI_STATUS 450 | EFIAPI 451 | RamDiskBlkIo2FlushBlocksEx ( 452 | IN EFI_BLOCK_IO2_PROTOCOL *This, 453 | IN OUT EFI_BLOCK_IO2_TOKEN *Token 454 | ) 455 | { 456 | RAM_DISK_PRIVATE_DATA *PrivateData; 457 | 458 | PrivateData = RAM_DISK_PRIVATE_FROM_BLKIO2 (This); 459 | 460 | if (TRUE == PrivateData->Media.ReadOnly) { 461 | return EFI_WRITE_PROTECTED; 462 | } 463 | 464 | // 465 | // If caller's event is given, signal it directly. 466 | // 467 | if ((Token != NULL) && (Token->Event != NULL)) { 468 | Token->TransactionStatus = EFI_SUCCESS; 469 | gBS->SignalEvent (Token->Event); 470 | } 471 | 472 | return EFI_SUCCESS; 473 | } 474 | 475 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------