Staging: Rename FswHfsPlus to OpenHfsPlus

2025-12-08 19:25:01 +00:00 · 2021-01-14 01:46:09 +03:00 · 2021-01-14 01:46:09 +03:00 · 216a7097d9
commit 216a7097d9
parent e3ec2c0575
20 changed files with 48 additions and 34 deletions
--- a/Changelog.md
+++ b/Changelog.md
@ -7,7 +7,7 @@ OpenCore Changelog
 - Relaxed selector dimensions for OpenCanopy
 - Add `MaxBIOSVersion` option to `Generic`
 - Fix MLB verification feature in macrecovery
- Replaced `VBoxHfs` driver with `FswHfsPlus`
+- Replaced `VBoxHfs` driver with `OpenHfsPlus`

 #### v0.6.5
 - Fixed installing OpenDuet on protected volumes
--- a/Docs/BuildDocs.tool
+++ b/Docs/BuildDocs.tool
@ -44,7 +44,7 @@ latexbuild Configuration

 cd Differences || abort "Unable to process annotations"
 rm -f ./*.aux ./*.log ./*.out ./*.pdf ./*.toc
-latexdiff -s ONLYCHANGEDPAGE PreviousConfiguration.tex ../Configuration.tex \
+latexdiff --allow-spaces -s ONLYCHANGEDPAGE PreviousConfiguration.tex ../Configuration.tex \
  > Differences.tex || \
  abort "Unable to differentiate"
 latexbuild Differences -interaction=nonstopmode
--- a/Docs/Configuration.pdf
+++ b/Docs/Configuration.pdf
--- a/Docs/Configuration.tex
+++ b/Docs/Configuration.tex
@ -5446,7 +5446,7 @@ even cause permanent firmware damage. Some of the known drivers are listed below
  have a flawed FAT support implementation that may lead to corrupted filesystems
  on write attempts. Embedding this driver within the firmware may be required in case
  writing to the EFI partition is needed during the boot process. \\
-  \href{https://github.com/acidanthera/audk}{\texttt{NvmExpressDxe}}\textbf{*}
+\href{https://github.com/acidanthera/audk}{\texttt{NvmExpressDxe}}\textbf{*}
 & NVMe support driver from \texttt{MdeModulePkg}. This driver is included in most
  firmware starting with the Broadwell generation. For Haswell and earlier, embedding it
  within the firmware may be more favourable in case a NVMe SSD drive is installed. \\
@ -5464,24 +5464,24 @@ even cause permanent firmware damage. Some of the known drivers are listed below
  older DMG recoveries such as macOS 10.9 using Apple Partitioning Scheme.
  For Sandy Bridge and earlier CPUs \texttt{PartitionDxeLegacy} driver should be
  used due to the lack of \texttt{RDRAND} instruction support. \\
-  \href{https://github.com/acidanthera/audk}{\texttt{Ps2KeyboardDxe}}\textbf{*}
+\href{https://github.com/acidanthera/audk}{\texttt{Ps2KeyboardDxe}}\textbf{*}
 & PS/2 keyboard driver from \texttt{MdeModulePkg}. \texttt{OpenDuetPkg} and some types of firmware
  may not include this driver, but it is necessary for PS/2 keyboard to work.
  Note, unlike \texttt{OpenUsbKbDxe} this driver has no \texttt{AppleKeyMapAggregator}
  support and thus requires \texttt{KeySupport} to be enabled. \\
-  \href{https://github.com/acidanthera/audk}{\texttt{Ps2MouseDxe}}\textbf{*}
+\href{https://github.com/acidanthera/audk}{\texttt{Ps2MouseDxe}}\textbf{*}
 & PS/2 mouse driver from \texttt{MdeModulePkg}. Some very old laptop firmware
  may not include this driver but it is necessary for the touchpad to work
  in UEFI graphical interfaces such as \texttt{OpenCanopy}. \\
-  \href{https://github.com/acidanthera/audk}{\texttt{UsbMouseDxe}}\textbf{*}
-& USB mouse driver from \texttt{MdeModulePkg}. Some virtual machine firmware
-  such as OVMF may not include this driver but it is necessary for the mouse to work
-  in UEFI graphical interfaces such as \texttt{OpenCanopy}. \\
-\href{https://github.com/acidanthera/OpenCorePkg}{\texttt{FswHfsPlus}}
+\href{https://github.com/acidanthera/OpenCorePkg}{\texttt{OpenHfsPlus}}\textbf{*}
 & HFS file system driver with bless support. This driver is an alternative to
  a closed source \texttt{HfsPlus} driver commonly found in Apple firmware. While
  it is feature complete, it is approximately 3~times slower and is yet to undergo
  a security audit. \\
+\href{https://github.com/acidanthera/audk}{\texttt{UsbMouseDxe}}\textbf{*}
+& USB mouse driver from \texttt{MdeModulePkg}. Some virtual machine firmware
+  such as OVMF may not include this driver but it is necessary for the mouse to work
+  in UEFI graphical interfaces such as \texttt{OpenCanopy}. \\
 \href{https://github.com/acidanthera/audk}{\texttt{XhciDxe}}\textbf{*}
 & XHCI USB controller support driver from \texttt{MdeModulePkg}. This driver is
  included in most types of firmware starting with the Sandy Bridge generation. For earlier firmware
--- a/Docs/Differences/Differences.tex
+++ b/Docs/Differences/Differences.tex
@ -1,7 +1,7 @@
 \documentclass[]{article}
 %DIF LATEXDIFF DIFFERENCE FILE
-%DIF DEL PreviousConfiguration.tex   Tue Jan  5 20:10:35 2021
-%DIF ADD ../Configuration.tex        Wed Jan 13 07:35:23 2021
+%DIF DEL PreviousConfiguration.tex   Wed Jan  6 14:43:46 2021
+%DIF ADD ../Configuration.tex        Thu Jan 14 01:38:24 2021

 \usepackage{lmodern}
 \usepackage{amssymb,amsmath}
@ -5507,7 +5507,7 @@ even cause permanent firmware damage. Some of the known drivers are listed below
  have a flawed FAT support implementation that may lead to corrupted filesystems
  on write attempts. Embedding this driver within the firmware may be required in case
  writing to the EFI partition is needed during the boot process. \\
-  \href{https://github.com/acidanthera/audk}{\texttt{NvmExpressDxe}}\textbf{*}
+\href{https://github.com/acidanthera/audk}{\texttt{NvmExpressDxe}}\textbf{*}
 & NVMe support driver from \texttt{MdeModulePkg}. This driver is included in most
  firmware starting with the Broadwell generation. For Haswell and earlier, embedding it
  within the firmware may be more favourable in case a NVMe SSD drive is installed. \\
@ -5525,27 +5525,38 @@ even cause permanent firmware damage. Some of the known drivers are listed below
  older DMG recoveries such as macOS 10.9 using Apple Partitioning Scheme.
  For Sandy Bridge and earlier CPUs \texttt{PartitionDxeLegacy} driver should be
  used due to the lack of \texttt{RDRAND} instruction support. \\
-  \href{https://github.com/acidanthera/audk}{\texttt{Ps2KeyboardDxe}}\textbf{*}
+\href{https://github.com/acidanthera/audk}{\texttt{Ps2KeyboardDxe}}\textbf{*}
 & PS/2 keyboard driver from \texttt{MdeModulePkg}. \texttt{OpenDuetPkg} and some types of firmware
  may not include this driver, but it is necessary for PS/2 keyboard to work.
  Note, unlike \texttt{OpenUsbKbDxe} this driver has no \texttt{AppleKeyMapAggregator}
  support and thus requires \texttt{KeySupport} to be enabled. \\
-  \href{https://github.com/acidanthera/audk}{\texttt{Ps2MouseDxe}}\textbf{*}
+\href{https://github.com/acidanthera/audk}{\texttt{Ps2MouseDxe}}\textbf{*}
 & PS/2 mouse driver from \texttt{MdeModulePkg}. Some very old laptop firmware
  may not include this driver but it is necessary for the touchpad to work
  in UEFI graphical interfaces such as \texttt{OpenCanopy}. \\
-  \href{https://github.com/acidanthera/audk}{\texttt{UsbMouseDxe}}\textbf{*}
-& USB mouse driver from \texttt{MdeModulePkg}. Some virtual machine firmware
+\DIFdelbegin \href{\DIFdel{https://github.com/acidanthera/audk}}%DIFAUXCMD
+%DIFDELCMD < {%%%
+\texttt{\DIFdel{UsbMouseDxe}}%DIFAUXCMD
+\DIFdelend \DIFaddbegin \href{\DIFadd{https://github.com/acidanthera/OpenCorePkg}}{\texttt{\DIFadd{OpenHfsPlus}}\DIFaddend }\textbf{*}
+& \DIFdelbegin \DIFdel{USB mouse driver from }\texttt{\DIFdel{MdeModulePkg}}%DIFAUXCMD
+\DIFdel{. Some virtual machine firmware
  such as OVMF may not include this driver but it is necessary for the mouse to work
-  in UEFI graphical interfaces such as \texttt{OpenCanopy}. \\
-\DIFdelbegin %DIFDELCMD < \href{https://github.com/acidanthera/OpenCorePkg}{\texttt{VBoxHfs}}
+  in UEFI graphical interfaces such as }\texttt{\DIFdel{OpenCanopy}}%DIFAUXCMD
+\DIFdel{. }%DIFDELCMD < \\
 %DIFDELCMD < %%%
-\DIFdelend \DIFaddbegin \href{https://github.com/acidanthera/OpenCorePkg}{\texttt{FswHfsPlus}}
-\DIFaddend & HFS file system driver with bless support. This driver is an alternative to
+\href{https://github.com/acidanthera/OpenCorePkg}{\texttt{\DIFdel{VBoxHfs}}%DIFAUXCMD
+}
+%DIFAUXCMD
+%DIFDELCMD < & %%%
+\DIFdelend HFS file system driver with bless support. This driver is an alternative to
  a closed source \texttt{HfsPlus} driver commonly found in Apple firmware. While
  it is feature complete, it is approximately 3~times slower and is yet to undergo
  a security audit. \\
-\href{https://github.com/acidanthera/audk}{\texttt{XhciDxe}}\textbf{*}
+\DIFaddbegin \href{https://github.com/acidanthera/audk}{\texttt{\DIFadd{UsbMouseDxe}}}\textbf{\DIFadd{*}}
+& \DIFadd{USB mouse driver from }\texttt{\DIFadd{MdeModulePkg}}\DIFadd{. Some virtual machine firmware
+  such as OVMF may not include this driver but it is necessary for the mouse to work
+  in UEFI graphical interfaces such as }\texttt{\DIFadd{OpenCanopy}}\DIFadd{. }\\
+\DIFaddend \href{https://github.com/acidanthera/audk}{\texttt{XhciDxe}}\textbf{*}
 & XHCI USB controller support driver from \texttt{MdeModulePkg}. This driver is
  included in most types of firmware starting with the Sandy Bridge generation. For earlier firmware
  or legacy systems, it may be used to support external USB 3.0 PCI cards.
@ -6804,9 +6815,10 @@ Since it is not always accurate, the latest versions are listed below.
    images are limited to their target model identifiers and have no
    \texttt{-no\_compat\_check} boot argument support. Modified images
    (with \texttt{ACDT} suffix) without model restrictions can be found
-    \DIFdelbegin %DIFDELCMD < \href{https://mega.nz/folder/z5YUhYTb#gA\_IRY5KMuYpnNCg7kR3ug}{here}%%%
-\DIFdelend \DIFaddbegin \href{https://archive.org/details/10.6.7-10j3250-disk-images}{here}
-    \DIFadd{(}\href{https://mega.nz/folder/z5YUhYTb#gA\_IRY5KMuYpnNCg7kR3ug}{MEGA Mirror}\DIFadd{)}\DIFaddend ,
+    \DIFdelbegin \href{\DIFdel{https://mega.nz/folder/z5YUhYTb#gA\_IRY5KMuYpnNCg7kR3ug}}%DIFAUXCMD
+%DIFDELCMD < {%%%
+\DIFdelend \DIFaddbegin \href{\DIFadd{https://archive.org/details/10.6.7-10j3250-disk-images}}{\DIFaddend here}
+    \DIFaddbegin \DIFadd{(}\href{https://mega.nz/folder/z5YUhYTb#gA\_IRY5KMuYpnNCg7kR3ug}{\DIFadd{MEGA Mirror}}\DIFadd{)}\DIFaddend ,
    assuming macOS~10.6 is legally owned. Read \texttt{DIGEST.txt}
    for more details. Note that these are the earliest tested
    versions of macOS~10.6 with OpenCore.
@ -6856,9 +6868,10 @@ hdiutil convert ReadWrite.dmg -format UDZO -o ReadOnly.dmg
    build \texttt{9J3050} (for \texttt{MacBookPro5,3}). Unlike the others,
    this image is not limited to the target model identifiers and can be used
    as is. The original \texttt{9J3050} image can be found
-    \DIFdelbegin %DIFDELCMD < \href{https://mega.nz/folder/inRBTarD#zanf7fUbviwz3WHBU5xpCg}{here}%%%
-\DIFdelend \DIFaddbegin \href{https://archive.org/details/10.5.7-9-j-3050}{here}
-    \DIFadd{(}\href{https://mega.nz/folder/inRBTarD#zanf7fUbviwz3WHBU5xpCg}{MEGA Mirror}\DIFadd{)}\DIFaddend ,
+    \DIFdelbegin \href{\DIFdel{https://mega.nz/folder/inRBTarD#zanf7fUbviwz3WHBU5xpCg}}%DIFAUXCMD
+%DIFDELCMD < {%%%
+\DIFdelend \DIFaddbegin \href{\DIFadd{https://archive.org/details/10.5.7-9-j-3050}}{\DIFaddend here}
+    \DIFaddbegin \DIFadd{(}\href{https://mega.nz/folder/inRBTarD#zanf7fUbviwz3WHBU5xpCg}{\DIFadd{MEGA Mirror}}\DIFadd{)}\DIFaddend ,
    assuming macOS~10.5 is legally owned. Read \texttt{DIGEST.txt}
    for more details. Note that this is the earliest tested
    version of macOS~10.5 with OpenCore.
@ -6877,9 +6890,10 @@ hdiutil convert ReadWrite.dmg -format UDZO -o ReadOnly.dmg
    to their target model identifiers as on newer macOS versions.
    Modified \texttt{8R4088} images (with \texttt{ACDT} suffix) without
    model restrictions can be found
-    \DIFdelbegin %DIFDELCMD < \href{https://mega.nz/folder/D3ASzLzA\#7sjYXE2X09f6aGjol\_C7dg}{here}%%%
-\DIFdelend \DIFaddbegin \href{https://archive.org/details/10.4.10-8-r-4088-acdt}{here}
-    \DIFadd{(}\href{https://mega.nz/folder/D3ASzLzA\#7sjYXE2X09f6aGjol\_C7dg}{MEGA Mirror}\DIFadd{)}\DIFaddend ,
+    \DIFdelbegin \href{\DIFdel{https://mega.nz/folder/D3ASzLzA\#7sjYXE2X09f6aGjol\_C7dg}}%DIFAUXCMD
+%DIFDELCMD < {%%%
+\DIFdelend \DIFaddbegin \href{\DIFadd{https://archive.org/details/10.4.10-8-r-4088-acdt}}{\DIFaddend here}
+    \DIFaddbegin \DIFadd{(}\href{https://mega.nz/folder/D3ASzLzA\#7sjYXE2X09f6aGjol\_C7dg}{\DIFadd{MEGA Mirror}}\DIFadd{)}\DIFaddend ,
    assuming macOS~10.4 is legally owned. Read \texttt{DIGEST.txt}
    for more details. Note that these are the earliest tested
    versions of macOS~10.4 with OpenCore.
--- a/OpenCorePkg.dsc
+++ b/OpenCorePkg.dsc
@ -237,7 +237,7 @@
  OpenCorePkg/Platform/OpenRuntime/OpenRuntime.inf
  OpenCorePkg/Platform/OpenUsbKbDxe/UsbKbDxe.inf
  OpenCorePkg/Staging/AudioDxe/AudioDxe.inf
-  OpenCorePkg/Staging/FswHfsPlus/FswHfsPlus.inf
+  OpenCorePkg/Staging/OpenHfsPlus/OpenHfsPlus.inf
  OpenCorePkg/Tests/AcpiTest/AcpiTest.inf
  OpenCorePkg/Tests/AcpiTest/AcpiTestApp.inf
  OpenCorePkg/Tests/CryptoTest/CryptoTest.inf
--- a/Staging/OpenHfsPlus/OpenHfsPlus.inf
+++ b/Staging/OpenHfsPlus/OpenHfsPlus.inf
@ -16,7 +16,7 @@

 [Defines]
  INF_VERSION    = 0x00010005
-  BASE_NAME      = FswHfsPlus
+  BASE_NAME      = OpenHfsPlus
  FILE_GUID      = F474802F-26BB-4E4F-A923-2FC568E94125
  MODULE_TYPE    = UEFI_DRIVER
  VERSION_STRING = 1.0
--- a/Staging/OpenHfsPlus/fsw_base.h
+++ b/Staging/OpenHfsPlus/fsw_base.h
--- a/Staging/OpenHfsPlus/fsw_core.c
+++ b/Staging/OpenHfsPlus/fsw_core.c
--- a/Staging/OpenHfsPlus/fsw_core.h
+++ b/Staging/OpenHfsPlus/fsw_core.h
--- a/Staging/OpenHfsPlus/fsw_efi.c
+++ b/Staging/OpenHfsPlus/fsw_efi.c
--- a/Staging/OpenHfsPlus/fsw_efi.h
+++ b/Staging/OpenHfsPlus/fsw_efi.h
--- a/Staging/OpenHfsPlus/fsw_efi_base.h
+++ b/Staging/OpenHfsPlus/fsw_efi_base.h
--- a/Staging/OpenHfsPlus/fsw_efi_edk2_base.h
+++ b/Staging/OpenHfsPlus/fsw_efi_edk2_base.h
--- a/Staging/OpenHfsPlus/fsw_efi_lib.c
+++ b/Staging/OpenHfsPlus/fsw_efi_lib.c
--- a/Staging/OpenHfsPlus/fsw_hfsplus.c
+++ b/Staging/OpenHfsPlus/fsw_hfsplus.c
--- a/Staging/OpenHfsPlus/fsw_hfsplus.h
+++ b/Staging/OpenHfsPlus/fsw_hfsplus.h
--- a/Staging/OpenHfsPlus/fsw_lib.c
+++ b/Staging/OpenHfsPlus/fsw_lib.c
--- a/Staging/OpenHfsPlus/fsw_strfunc.h
+++ b/Staging/OpenHfsPlus/fsw_strfunc.h
--- a/Staging/README.md
+++ b/Staging/README.md
@ -1,6 +1,6 @@
 Staging drivers considered experimental and not production ready.

-## FswHfsPlus
+## OpenHfsPlus
 This driver implements HFS+ support with bless extensions.

 ## AudioDxe