Skip to content

Commit 1bd2eeb

Browse files
nicholasbishopphip1611
authored andcommitted
uefi: Add separate changelog file
1 parent 9b64f7b commit 1bd2eeb

File tree

1 file changed

+47
-76
lines changed

1 file changed

+47
-76
lines changed

CHANGELOG.md renamed to uefi/CHANGELOG.md

Lines changed: 47 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
# Changelog
1+
# uefi - [Unreleased]
22

3-
## uefi - [Unreleased]
4-
5-
### Added
3+
## Added
64
- Implemented `Index`, `IndexMut`, `get`, and `get_mut` on `MemoryMap`.
75
- Added `SystemTable::as_ptr`.
86

9-
### Changed
7+
## Changed
108
- We fixed a memory leak in `GraphicsOutput::query_mode`. As a consequence, we
119
had to add `&BootServices` as additional parameter.
1210
- `BootServices::free_pages` and `BootServices::free_pool` are now `unsafe` to
@@ -19,9 +17,9 @@
1917
- `BootServices::{install,reinstall,uninstall}_protocol_interface` now take
2018
`const` interface pointers.
2119

22-
## uefi - 0.25.0 (2023-10-10)
20+
# uefi - 0.25.0 (2023-10-10)
2321

24-
### Changed
22+
## Changed
2523
- MSRV bumped to 1.70.
2624
- `Input::wait_for_key_event` now returns an `Option<Event>`, and is no longer `const`.
2725
- `Protocol::wait_for_input_event` now returns an `Option<Event>`, and is no longer `const`.
@@ -40,13 +38,13 @@
4038
the memory type of memory map.
4139
- Added the `ShellParams` protocol
4240

43-
### Removed
41+
## Removed
4442
- `BootServices::memmove` and `BootServices::set_mem` have been removed, use
4543
standard functions like `core::ptr::copy` and `core::ptr::write_bytes` instead.
4644

47-
## uefi - 0.24.0 (2023-06-20)
45+
# uefi - 0.24.0 (2023-06-20)
4846

49-
### Added
47+
## Added
5048
- `DevicePath::to_boxed`, `DevicePath::to_owned`, and `DevicePath::as_bytes`
5149
- `DevicePathInstance::to_boxed`, `DevicePathInstance::to_owned`, and `DevicePathInstance::as_bytes`
5250
- `DevicePathNode::data`
@@ -55,25 +53,22 @@
5553
potentially-null interfaces without panicking.
5654
- `DevicePath::to_string` and `DevicePathNode::to_string`
5755

58-
### Changed
56+
## Changed
5957
- Renamed `LoadImageSource::FromFilePath` to `LoadImageSource::FromDevicePath`
6058
- The `Deref` and `DerefMut` impls for `ScopedProtocol` will now panic if the
6159
interface pointer is null.
6260

63-
## uefi - 0.23.0 (2023-06-04)
64-
65-
### Changed
61+
# uefi - 0.23.0 (2023-06-04)
6662

63+
## Changed
6764
- Fixed function signature bug in `BootServices::install_configuration_table`.
6865

69-
## uefi - 0.22.0 (2023-06-01)
70-
71-
### Added
66+
# uefi - 0.22.0 (2023-06-01)
7267

68+
## Added
7369
- Added `BootServices::install_configuration_table`.
7470

75-
### Changed
76-
71+
## Changed
7772
- Renamed `FileSystemIOErrorContext` to `IoErrorContext`.
7873
- `ResetType` is now a newtype-enum instead of a Rust enum. Its members now have
7974
upper-case names.
@@ -84,10 +79,9 @@
8479
- `RegularFile::read` now reads in 1 MiB chunks to avoid a bug in some
8580
firmware. This fix also applies to `fs::FileSystem::read`.
8681

87-
## uefi - 0.21.0 (2023-05-15)
88-
89-
### Added
82+
# uefi - 0.21.0 (2023-05-15)
9083

84+
## Added
9185
- There is a new `fs` module that provides a high-level API for file-system
9286
access. The API is close to the `std::fs` module. The module also provides a
9387
`Path` and a `PathBuf` abstraction that is similar to the ones from
@@ -117,8 +111,7 @@
117111
- `MemoryType::BOOT_SERVICES_DATA` for UEFI boot drivers
118112
- `MemoryType::RUNTIME_SERVICES_DATA` for UEFI runtime drivers
119113

120-
### Changed
121-
114+
## Changed
122115
- The `global_allocator` module has been renamed to `allocator`, and is now
123116
available regardless of whether the `global_allocator` feature is enabled. The
124117
`global_allocator` feature now only controls whether `allocator::Allocator` is
@@ -147,13 +140,12 @@
147140
- `GptPartitionAttributes` now has 16 additional `TYPE_SPECIFIC_BIT_<N>`
148141
constants.
149142

150-
## uefi - 0.20.0 (2023-03-19)
143+
# uefi - 0.20.0 (2023-03-19)
151144

152145
As of this release, the UEFI crates work on the stable channel. This requires
153146
Rust 1.68 or higher.
154147

155-
### Added
156-
148+
## Added
157149
- Added the `ComponentName1` and `ComponentName2` protocols. The `ComponentName`
158150
wrapper will automatically select `ComponentName2` if available, and fall back
159151
to `ComponentName1` otherwise.
@@ -164,8 +156,7 @@ Rust 1.68 or higher.
164156
is no sensible way of presenting a useful Debug representation, such as for
165157
Unions.
166158

167-
### Changed
168-
159+
## Changed
169160
- `SystemTable::exit_boot_services` now takes no parameters and handles
170161
the memory map allocation itself. Errors are now treated as
171162
unrecoverable and will cause the system to reset.
@@ -186,25 +177,22 @@ Rust 1.68 or higher.
186177
available since EFI 1.10 (2002).
187178
- `ScopedProtocol::interface` is not public anymore. Use the `Deref` trait.
188179

189-
## uefi - 0.19.1 (2023-02-04)
190-
191-
### Added
180+
# uefi - 0.19.1 (2023-02-04)
192181

182+
## Added
193183
- Added `table::boot::PAGE_SIZE` constant.
194184

195-
### Changed
196-
185+
## Changed
197186
- Fixed several protocol functions so that they work with unsized protocols
198187
(like `DevicePath`): `BootServices::locate_device_path`,
199188
`BootServices::get_handle_for_protocol`, `BootServices::test_protocol`,
200189
`BootServices::find_handles`, and `SearchType::from_proto`.
201190
- Fixed a warning printed when using `uefi` as a dependency: "the following
202191
packages contain code that will be rejected by a future version".
203192

204-
## uefi - 0.19.0 (2023-01-16)
205-
206-
### Added
193+
# uefi - 0.19.0 (2023-01-16)
207194

195+
## Added
208196
- Implementations for the trait `EqStrUntilNul` now allow `?Sized` inputs. This means that
209197
you can write `some_cstr16.eq_str_until_nul("test")` instead of
210198
`some_cstr16.eq_str_until_nul(&"test")` now.
@@ -217,8 +205,7 @@ Rust 1.68 or higher.
217205
integration with error-handling crates. (requires the **unstable** feature)
218206
- Added partial support for the TCG protocols for TPM devices under `uefi::proto::tcg`.
219207

220-
### Changed
221-
208+
## Changed
222209
- `UnalignedSlice` now implements `Clone`, and the `Debug` impl now
223210
prints the elements instead of the internal fields.
224211
- The unstable `negative_impls` feature is no longer required to use this library.
@@ -235,10 +222,9 @@ Rust 1.68 or higher.
235222
- Redundant private field used for padding in `MemoryDescriptor` structure was removed. Now all
236223
fields of this struct are public.
237224

238-
## uefi - 0.18.0 (2022-11-15)
239-
240-
### Added
225+
# uefi - 0.18.0 (2022-11-15)
241226

227+
## Added
242228
- Added `PhysicalAddress` and `VirtualAddress` type aliases.
243229
- Added `Guid::from_bytes` and `Guid::to_bytes`.
244230
- Added `UnalignedSlice` for representing a reference to an unaligned
@@ -257,8 +243,7 @@ Rust 1.68 or higher.
257243
- Added `BootServices::register_protocol_notify`.
258244
- Added `SearchType::ByRegisterNotify`and `ProtocolSearchKey`.
259245

260-
### Changed
261-
246+
## Changed
262247
- Renamed crate feature `alloc` to `global_allocator`.
263248
- Renamed crate feature `exts` to `alloc`.
264249
- Fixed the definition of `AllocateType` so that `MaxAddress` and
@@ -277,8 +262,7 @@ Rust 1.68 or higher.
277262
- `CStr16::from_u16_with_nul_unchecked` and `cstr16!` are now allowed in
278263
`const` contexts.
279264

280-
### Removed
281-
265+
## Removed
282266
- Removed `UnalignedCStr16`; use `UnalignedSlice` instead. An
283267
`UnalignedSlice<u16>` can be converted to a string with `to_cstr16` or
284268
`to_cstring16`.
@@ -290,11 +274,9 @@ Rust 1.68 or higher.
290274
`proto::device_path::acpi::Acpi` and
291275
`proto::device_path::media::HardDrive` instead. `
292276

293-
## uefi - 0.17.0 (2022-09-09)
294-
295-
296-
### Added
277+
# uefi - 0.17.0 (2022-09-09)
297278

279+
## Added
298280
- Added `Deref` and `DerefMut` trait implementations to `ScopedProtocol`.
299281
This eliminates the need to explicitly access the `interface` field,
300282
which is now marked as deprecated.
@@ -321,8 +303,7 @@ Rust 1.68 or higher.
321303
- The `File` trait now knows the methods `is_regular_file` and `is_directory`.
322304
Developers profit from this on the struct `FileHandle`, for example.
323305

324-
### Changed
325-
306+
## Changed
326307
- Marked `BootServices::handle_protocol` as `unsafe`. (This method is
327308
also deprecated -- use `open_protocol_exclusive` or `open_protocol` instead.)
328309
- Deprecated `BootServices::locate_protocol` and marked it `unsafe`. Use
@@ -333,8 +314,7 @@ Rust 1.68 or higher.
333314
additive. It is now a default feature.
334315
- Corrected the name of `BlockIOMedia::is_media_preset` to `is_media_present`.
335316

336-
### Removed
337-
317+
## Removed
338318
- Removed the `exts::allocate_buffer` function. This function could
339319
cause undefined behavior when called with a `Layout` with an alignment
340320
other than 1. A safe alternative is to use
@@ -345,14 +325,12 @@ Rust 1.68 or higher.
345325
can be replaced by calling `status.into()`, or `Result::from(status)`
346326
in cases where the compiler needs a type hint.
347327

348-
## uefi - 0.16.1
349-
350-
### Added
328+
# uefi - 0.16.1
351329

330+
## Added
352331
- Added EFI revision constants to `Revision`.
353332

354-
### Fixed
355-
333+
## Fixed
356334
- The table `Header` struct's `Debug` impl now prints the correct signature.
357335
- The `BootServices::create_event_ex` and
358336
`RuntimeServices::query_variable_info` methods now check the table
@@ -361,17 +339,15 @@ Rust 1.68 or higher.
361339
- Fixed an incorrect pointer cast in the `Rng` protocol that could cause
362340
undefined behavior.
363341

364-
### Changed
365-
342+
## Changed
366343
- Relaxed the version requirements for the `bitflags` and `log`
367344
dependencies to allow earlier patch versions.
368345
- Enabled `doc_auto_cfg` on docs.rs to show badges on items that are
369346
gated behind a feature.
370347

371-
## uefi - 0.16.0 (2022-05-16)
372-
373-
### Added
348+
# uefi - 0.16.0 (2022-05-16)
374349

350+
## Added
375351
- Added `FileHandle::into_directory` and `FileHandle::into_regular_file`.
376352
- Added `TimeParams`, `Time::invalid`, and `Time::is_invalid`.
377353
- Added `RuntimeServices::query_variable_info` and `VariableStorageInfo`.
@@ -385,8 +361,7 @@ Rust 1.68 or higher.
385361
- Included `cstr8` and `cstr16` macros from `uefi-macros` in the prelude.
386362
- Added `DevicePathInstance`, `DevicePathNode`, and `FfiDevicePath`.
387363

388-
### Changed
389-
364+
## Changed
390365
- `Time::new` now takes a single `TimeParams` argument so that date and
391366
time fields can be explicitly named at the call site.
392367
- The file info types now derive `PartialEq` and `Eq`.
@@ -396,14 +371,13 @@ Rust 1.68 or higher.
396371
instances and nodes, respectively.
397372
- The methods of `Revision` are now `const`.
398373

399-
### Fixed
374+
## Fixed
400375

401376
- Fixed undefined behavior in `proto::media::file::File::get_boxed_info`.
402377

403-
## uefi - 0.15.2 (2022-03-15)
404-
405-
### Added
378+
# uefi - 0.15.2 (2022-03-15)
406379

380+
## Added
407381
- Added `PartialEq` impls for `CStr16 == CStr16`, `&CStr16 == CString`,
408382
and `CString == &CStr16`.
409383
- Added `Display` impl for `CString16`.
@@ -425,8 +399,7 @@ Rust 1.68 or higher.
425399
- Added `Output::output_string_lossy`.
426400
- Added `ResultExt::handle_warning`.
427401

428-
### Changed
429-
402+
## Changed
430403
- Updated to the 2021 edition.
431404
- `File::open` now takes the filename as `&CStr16` instead of `&str`,
432405
avoiding an implicit string conversion.
@@ -445,8 +418,7 @@ Rust 1.68 or higher.
445418
`Completion`, so the type behaves more like a regular Rust `Result`
446419
type.
447420

448-
### Removed
449-
421+
## Removed
450422
- Removed `CStr16::as_string` method. Use
451423
[`ToString`](https://doc.rust-lang.org/alloc/string/trait.ToString.html)
452424
instead.
@@ -469,8 +441,7 @@ Rust 1.68 or higher.
469441
`log_warning` method has also been removed, use the new
470442
`ResultExt::handle_warning` method instead.
471443

472-
### Fixed
473-
444+
## Fixed
474445
- Fixed compilation with Rust 1.60 by no longer enabling the
475446
`vec_spare_capacity` feature, which has been stabilized.
476447
- Fixed the header size calculated by `FileInfo::new` and

0 commit comments

Comments
 (0)