ams: docs/build update

Makefile

@@ -13,7 +13,7 @@ ifneq (, $(strip $(shell git status --porcelain 2>/dev/null)))
     AMSREV := $(AMSREV)-dirty
 endif
 
-COMPONENTS := fusee stratosphere mesosphere exosphere thermosphere troposphere libraries
+COMPONENTS := fusee stratosphere mesosphere exosphere emummc thermosphere troposphere libraries
 
 all: $(COMPONENTS)
 	$(eval MAJORVER = $(shell grep 'define ATMOSPHERE_RELEASE_VERSION_MAJOR\b' libraries/libvapours/include/vapours/ams/ams_api_version.h \
@@ -52,6 +52,9 @@ mesosphere: exosphere libraries
 troposphere: stratosphere
 	$(MAKE) -C troposphere all
 
+emummc:
+	$(MAKE) -C emummc all
+
 fusee: exosphere mesosphere stratosphere
 	$(MAKE) -C $@ all
 
@@ -94,6 +97,7 @@ dist-no-debug: all
 	cp config_templates/override_config.ini atmosphere-$(AMSVER)/atmosphere/config_templates/override_config.ini
 	cp config_templates/system_settings.ini atmosphere-$(AMSVER)/atmosphere/config_templates/system_settings.ini
 	cp config_templates/exosphere.ini atmosphere-$(AMSVER)/atmosphere/config_templates/exosphere.ini
+	mkdir config_templates/kip_patches
 	cp -r config_templates/kip_patches atmosphere-$(AMSVER)/atmosphere/kip_patches
 	cp -r config_templates/hbl_html atmosphere-$(AMSVER)/atmosphere/hbl_html
 	mkdir -p atmosphere-$(AMSVER)/stratosphere_romfs/atmosphere/contents/0100000000000008

docs/changelog.md

@@ -1,4 +1,19 @@
 # Changelog
+## 1.0.0
++ `fusee` was completely re-written in C++ to use the same atmosphere-libs APIs as the rest of atmosphere's code.
+  + The rewrite was performed with a big emphasis on ensuring a good boot speed, and generally boot should be much faster than it was previously.
+    + Depending on SD card/environment, boot speed may now be slightly faster than, roughly the same as, or slightly slower than when booting with hekate.
+    + The obvious low-hanging fruit for performance improvements has been picked, so hopefully the improved performance is to everybody's liking.
+  + SD card compatibility was improved: fusee should now have SD card compatibility identical to the official OS driver.
+  + **Please Note**: various components were renamed (fusee-primary.bin -> fusee.bin, fusee-secondary.bin -> package3).
+    + If you use another bootloader (like hekate), you may need to update your configuration to use the new layout.
+  + **Please Note**: BCT.ini no longer exists, nogc configuration has been moved to `/atmosphere/stratosphere.ini`.
+    + If you rely on custom nogc configuration, please be sure to update accordingly.
++ A number of pending changes were made, following the end of the relevant testing periods:
+  + `mesosphere` is no longer opt-out, and stratosphere code will begin depending on its being present/in use.
+  + `NCM` is no longer opt-out.
+  + The cleanup to ease the transition from < 0.19.0 to 0.19.0 has been removed.
++ General system stability improvements to enhance the user's experience.
 ## 0.20.1
 + An issue was fixed that caused severely degraded performance after wake-from-sleep on Mariko hardware.
   + This was due to Mariko MTC resulting in a frequency of 1599.999MHz instead of 1600MHz.

docs/components/fusee.md

@@ -1,22 +1,8 @@
 # fusée
 fusée is a custom bootloader used to start the Atmosphère environment.
-It is divided into three sub-components: fusée-primary, fusée-mtc and fusée-secondary.
 
-fusée is also capable of chainloading other payloads (e.g.: Android).
+## fusée
-
+fusée is the first piece of Atmosphère's code that runs on the hardware.
-fusée's behavior can be configured via the [BCT.ini](../features/configurations.md) file located on the SD card.
-
-## fusée-primary
-fusée-primary is the first piece of Atmosphère's code that runs on the hardware.
 It is distributed as a standalone payload designed to be launched via RCM by abusing the CVE-2018-6242 vulnerability.
 
-This payload is responsible for all the low-level hardware initialization required by the Nintendo Switch, plus the extra task of initializing the SD card and reading the next fusée sub-components from it.
+This payload is responsible for all the low-level hardware initialization required by the Nintendo Switch, setting up the cryptosystem, mounting/emulating the eMMC, injecting/patching system modules, and launching the exosphère component.
-
-## fusée-mtc
-fusée-mtc is an optional, but heavily recommended sub-component that performs DRAM memory training.
-This ensures a proper environment for running the final fusée sub-component.
-
-## fusée-secondary
-fusée-secondary is the last fusée sub-component that runs on the system.
-It is responsible for configuring and bootstrapping the Atmosphère environment by mimicking the Horizon OS's design.
-This includes setting up the cryptosystem, mounting or emulating the eMMC, injecting or patching system modules and launching the exosphère component.

docs/features/configurations.md

@@ -1,21 +1,10 @@
 # Configurations
 Atmosphère provides a variety of customizable configurations to better adjust to users' needs.
 
-## BCT.ini
+## stratosphere.ini
-This is the configuration file used by fusée.
+This is the configuration file used by fusée for configuring user-space system modules.
 This file is located under the `/atmosphere/config/` folder on your SD card and a default template can be found inside the `/atmosphere/config_templates/` folder.
 
-### Adding a Custom Boot Splashscreen
-Atmosphère provides its own default splashscreen which is displayed at boot time. However, this can be replaced at will.
-
-The boot splashscreen must be a BMP file, it must be 720x1280 (1280x720 rotated 90 degrees left/counterclockwise/anti-clockwise) resolution, and be in 32-bit ARGB format. You can use image editing software such as GIMP or Photoshop to export the image in this format.
-
-Add the following lines to BCT.ini and change the value of `custom_splash` to the actual path and filename of your boot splashscreen:
-```
-[stage2]
-custom_splash = /path/to/your/bootlogo.bmp
-```
-
 ### Configuring "nogc" Protection
 "nogc" is a feature provided by fusée-secondary which disables the Nintendo Switch's Game Card reader. Its purpose is to prevent the reader from being updated when the console has been updated, without burning fuses, from a lower firmware version. More specifically, from firmware versions 4.0.0 or 9.0.0 which introduced updates to the Game Card reader's firmware. By default, Atmosphère will protect the Game Card reader automatically, but you are free to change it.
 
@@ -29,32 +18,15 @@ nogc = X
 0 = force-disable nogc, so Atmosphère will always enable the Game Card reader.
 ```
 
-### NCM opt-out
+## Adding a Custom Boot Splashscreen
-Atmosphère provides a reimplementation of the [ncm](../components/modules/ncm.md) system module. If you wish to disable this reimplementation add the following line to the `stratosphere` section:
+Atmosphère provides its own default splashscreen which is displayed at boot time. However, this can be replaced at will.
-```
-[stratosphere]
-disable_ncm = 1
-```
 
-### Logging
+Boot splash screens must be 1280x720 resolution.
-This is an advanced feature aimed at developers trying to debug boot time issues. It enables logging of the fusée stages to be displayed on screen.
 
-Add the following lines to BCT.ini and change the value of `X` according to the following list:
+A script can be found inside the source tree (`/utilities/insert_splash_screen.py`) for inserting a custom splash screen into a release binary.
-```
-[config]
-log_level = X
-```
-```
-0 = NONE
-1 = ERROR
-2 = WARNING
-3 = MANDATORY
-4 = INFO
-5 = DEBUG
-```
 
-A special level is also provided to prevent prefix creation. To use it, do a bitwise OR with this mask:
+To do so, execute the following command on the script:
-`0x100 = NO_PREFIX`
+`python insert_splash_screen.py <path to your splash screen image> <path to /atmosphere/package3 on your SD card>`
 
 ## emummc.ini
 This is the configuration file used for the [emummc](../components/emummc.md) component.