Lines Matching full:is
4 Firmware Volume Protocol if the firmware volume is to be visible to
88 GetVolumeAttributes() function. GetVolumeAttributes() is
90 GetVolumeAttributes() at any EFI_TPL above TPL_NOTIFY is
114 The SetVolumeAttributes() function is used to set configurable
122 is set to the desired value on input. The EFI_FV_LOCK_STATUS bit
124 volume. Rather, once the EFI_FV_LOCK_STATUS bit is set, it
126 SetVolumeAttributes() is callable only from TPL_NOTIFY and
128 TPL_NOTIFY is undefined.
132 @param FvAttributes On input, FvAttributes is a pointer to
137 unsuccessful return, FvAttributes is not
143 EFI_FV_ATTRIBUTES is returned in
147 is set to 1 on input, but the
151 is clear on return from
156 is cleared to 0 on input, but
160 is clear on return from
165 is set to 1 on input, but the
169 is clear on return from
174 is cleared to 0 on input, but
178 is clear on return from
183 is set on input, but the device
185 (FvAttributes:EFI_FV_LOCK_CAP is
190 @retval EFI_ACCESS_DENIED Device is locked and does not
193 is set on return from
208 ReadFile() is used to retrieve any file from a firmware volume
211 as it does the following: It is accessed using the Firmware
212 Volume Protocol. The image that is returned follows the image
214 If the input value of Buffer==NULL, it indicates the caller is
216 file be returned and that there is no output buffer. In this
218 - BufferSize is returned with the size that is required to
222 - The returned value of *AuthenticationStatus is undefined.
224 If the input value of Buffer!=NULL, the output buffer is
226 input value of *Buffer is used to determine if the output
227 buffer is caller allocated or is dynamically allocated by
229 the output buffer is caller allocated. In this case, the input
231 caller-allocated output buffer. If the output buffer is not
232 large enough to contain the entire requested output, it is
233 filled up to the point that the output buffer is exhausted and
234 EFI_WARN_BUFFER_TOO_SMALL is returned, and then BufferSize is
238 output buffer is to be allocated by ReadFile(). In this case,
241 The size of the new buffer is returned in BufferSize and all
243 ReadFile() is callable only from TPL_NOTIFY and below.
244 Behavior of ReadFile() at any EFI_TPL above TPL_NOTIFY is
249 @param NameGuid Pointer to an EFI_GUID, which is the file
270 authentication status is
275 @retval EFI_WARN_BUFFER_TOO_SMALL The buffer is too small to
277 output. The buffer is
278 filled and the output is
288 @retval EFI_ACCESS_DENIED The firmware volume is configured to
307 ReadSection() is used to retrieve a specific section from a file
308 within a firmware volume. The section returned is determined
310 sections found in the specified file. The output buffer is specified by a double indirection
311 of the Buffer parameter. The input value of Buffer is used to
312 determine if the output buffer is caller allocated or is
314 Buffer!=NULL, it indicates that the output buffer is caller
317 the output buffer is not large enough to contain the entire
318 requested output, it is filled up to the point that the output
319 buffer is exhausted and EFI_WARN_BUFFER_TOO_SMALL is returned,
320 and then BufferSize is returned with the size that is required
323 value of *Buffer==NULL, it indicates the output buffer is to
327 the new buffer is returned in *BufferSize and all other output
328 parameters are returned with valid values. ReadSection() is
330 ReadSection() at any EFI_TPL above TPL_NOTIFY is
348 section to return. SectionInstance is
361 status is returned.
367 buffer is too small to
369 output. The buffer is
370 filled and the output is
384 @retval EFI_ACCESS_DENIED The firmware volume is configured to
390 was not found. It is possible the
395 is published.
422 /// Pointer to a GUID, which is the file name to be written.
446 WriteFile() is used to write one or more files to a firmware
447 volume. Each file to be written is described by an
450 array is compatible with the firmware volume. Firmware volume
452 call. Similarly, if the WritePolicy is set to
454 capabilities to ensure EFI_FV_RELIABLE_WRITE is supported by the
459 Deleting a file as part of a multiple file write is not allowed.
462 WriteFile() is callable only from TPL_NOTIFY and below.
463 Behavior of WriteFile() at any EFI_TPL above TPL_NOTIFY is
489 @retval EFI_WRITE_PROTECTED The firmware volume is
522 GetNextFile() is the interface that is used to search a firmware
523 volume for a particular file. It is called successively until
524 the desired file is located or the function returns
527 example, if *FileType is EFI_FV_FILETYPE_DRIVER, only files of
528 this type will be returned in the output. If *FileType is
529 EFI_FV_FILETYPE_ALL, no filtering of file types is done. The Key
530 parameter is used to indicate a starting point of the search. If
531 the buffer *Key is completely initialized to zero, the search
535 implementation specific and no semantic content is implied.
536 GetNextFile() is callable only from TPL_NOTIFY and below.
537 Behavior of GetNextFile() at any EFI_TPL above TPL_NOTIFY is
542 … Key Pointer to a caller-allocated buffer that contains implementation-specific data that is
555 types. If a file is found, the file's type
556 is returned in FileType. *FileType is not
557 modified if no file is found.
560 matching file is found, the file's name is
561 returned in NameGuid. If no matching file is
562 found, *NameGuid is not modified.
566 is found, the file's attributes are returned
567 in Attributes. If no matching file is found,
568 Attributes is not modified. Type
569 EFI_FV_FILE_ATTRIBUTES is defined in
573 matching file is found, the file's size is
574 returned in *Size. If no matching file is found,
575 Size is not modified.
588 @retval EFI_ACCESS_DENIED The firmware volume is configured to
610 EFI_UNSUPPORTED is returned. If the buffer is not large enough
611 to hold the requested structure, EFI_BUFFER_TOO_SMALL is
612 returned and the BufferSize is set to the size of buffer that is
618 instance that is the file handle the requested
619 information is for.
626 both cases, the size is measured in bytes.
629 buffer's type is indicated by InformationType.
634 @retval EFI_UNSUPPORTED The InformationType is not known.
643 @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small to
668 instance that is the file handle the information
669 is for.
677 buffer's type is indicated by InformationType.
681 @retval EFI_UNSUPPORTED The InformationType is not known.
691 @retval EFI_WRITE_PROTECTED The media is read only.
693 @retval EFI_VOLUME_FULL The volume is full.
695 @retval EFI_BAD_BUFFER_SIZE BufferSize is smaller than the
713 /// Firmware Volume Protocol is the interface used by all parts of
719 /// detail is not visible to the consumers of the Firmware Volume