docs: style fixes

This commit is contained in:
hexkyz 2020-04-26 19:18:49 +01:00
parent 57ac153671
commit 59ea93e9cd
17 changed files with 23 additions and 33 deletions

View file

@ -3,8 +3,8 @@ This module provides methods to intercept services provided by other system modu
## bpc_mitm
bpc_mitm enables intercepting requests to power control services. It currently intercepts:
+ "am" system module (to intercept the Reboot/Power buttons in the overlay menu)
+ "fatal" system module (to simplify payload reboot logic significantly)
+ `am` system module (to intercept the Reboot/Power buttons in the overlay menu)
+ `fatal` system module (to simplify payload reboot logic significantly)
+ Homebrew Loader (to allow homebrew to take advantage of the feature)
## fs_mitm
@ -20,7 +20,7 @@ ns_mitm enables intercepting requests to application control services. It curren
## set_mitm
set_mitm enables intercepting requests to the system settings service. It currently intercepts:
+ "ns" system module and games (to allow for overriding game locales)
+ `ns` system module and games (to allow for overriding game locales)
+ All settings requests
### Firmware Version

View file

@ -1,4 +1,4 @@
# boot
This module is a reimplementation of the Horizon OS's "boot" system module, which is responsible for initializing and configuring hardware.
This module is a reimplementation of the Horizon OS's `boot` system module, which is responsible for initializing and configuring hardware.
Atmosphère's reimplementation displays its own black and white splash screen and battery icons as replacements for the original assets used during display initialization.

View file

@ -1,4 +1,4 @@
# boot2
This module is a reimplementation of the Horizon OS's "boot2" system module, which is responsible for launching all the other necessary system modules.
This module is a reimplementation of the Horizon OS's `boot2` system module, which is responsible for launching all the other necessary system modules.
Atmosphère's reimplementation allows launching user provided system modules from the SD card. See [here](../../features/configurations.md) for more information.

View file

@ -1,4 +1,4 @@
# creport
This module is a reimplementation of the Horizon OS's "creport" system module, which is responsible for managing crash reports.
This module is a reimplementation of the Horizon OS's `creport` system module, which is responsible for managing crash reports.
Atmosphère's reimplementation redirects writing of generated crash reports to the SD card under the folder `/atmosphere/crash_reports/`. It also prevents the automatic uploading of said crash reports.

View file

@ -1,5 +1,5 @@
# dmnt
This module is a reimplementation of the Horizon OS's "dmnt" system module, which provides a debug monitor.
This module is a reimplementation of the Horizon OS's `dmnt` system module, which provides a debug monitor.
## Extensions
Atmosphère implements an extension to provide cheat code functionality.

View file

@ -1,4 +1,4 @@
# eclct.stub
This module is a reimplementation of the Horizon OS's "eclct" system module, which collects error reports.
This module is a reimplementation of the Horizon OS's `eclct` system module, which collects error reports.
Atmosphère's reimplementation is a stub to remove any and all functionality pertaining to error report collection.

View file

@ -1,4 +1,4 @@
# erpt
This module is a reimplementation of the Horizon OS's "erpt" system module, which is responsible for managing error reports.
This module is a reimplementation of the Horizon OS's `erpt` system module, which is responsible for managing error reports.
Atmosphère's reimplementation redirects writing of generated error reports to the SD card under the folder `/atmosphere/erpt_reports/`.

View file

@ -1,4 +1,4 @@
# fatal
This module is a reimplementation of the Horizon OS's "fatal" system module, which is responsible for managing fatal reports.
This module is a reimplementation of the Horizon OS's `fatal` system module, which is responsible for managing fatal reports.
Atmosphère's reimplementation prevents error report creation and draws a custom error screen, showing registers and a backtrace. It also attempts to gather debugging info for any and all crashes and tries to save reports to the SD card under the folder `/atmosphere/fatal_reports/` (if a crash report was not generated).

View file

@ -1,4 +1,4 @@
# jpegdec
This module is a reimplementation of the Horizon OS's "jpegdec" system module, which is responsible for JPEG format decoding.
This module is a reimplementation of the Horizon OS's `jpegdec` system module, which is responsible for JPEG format decoding.
Atmosphère's reimplementation allows two sessions instead of 1, so homebrew can use it for software JPEG decoding in addition to the OS itself.

View file

@ -1,5 +1,5 @@
# loader
This module is a reimplementation of the Horizon OS's "ldr" system module, which is responsible for creating processes from executable NSO images and registering their access control.
This module is a reimplementation of the Horizon OS's `ldr` system module, which is responsible for creating processes from executable NSO images and registering their access control.
## Extensions
Atmosphère extends this module to allow executables to be replaced or patched by files stored on the SD card. Note that a few services are required for SD card access and therefore cannot be replaced or patched in this manner.

View file

@ -1,4 +1,4 @@
# ncm
This module is a reimplementation of the Horizon OS's "ncm" system module, which is responsible content management.
This module is a reimplementation of the Horizon OS's `ncm` system module, which is responsible content management.
Atmosphère's reimplementation is currently opt-in only. See [here](../../features/configurations.md) for more information.

View file

@ -1,2 +1,2 @@
# pgl
This module is a reimplementation of the Horizon OS's "pgl" system module, which is responsible for launching programs.
This module is a reimplementation of the Horizon OS's `pgl` system module, which is responsible for launching programs.

View file

@ -1,5 +1,5 @@
# pm
This module is a reimplementation of the Horizon OS's "pm" system module, which is responsible for tracking running processes on the system, and managing resource limits.
This module is a reimplementation of the Horizon OS's `pm` system module, which is responsible for tracking running processes on the system, and managing resource limits.
## Extensions
Atmosphère extends this module with extra IPC commands and memory restriction changes.

View file

@ -1,5 +1,5 @@
# ro
This module is a reimplementation of the Horizon OS's "ro" system module, which is responsible for loading dynamic libraries.
This module is a reimplementation of the Horizon OS's `ro` system module, which is responsible for loading dynamic libraries.
## Extensions
Atmosphère extends this module to allow libraries to be patched by files stored on the SD card.

View file

@ -1,5 +1,5 @@
# sm
This module is a reimplementation of the Horizon OS's "sm" system module, which is responsible for service management.
This module is a reimplementation of the Horizon OS's `sm` system module, which is responsible for service management.
## Extensions
Atmosphère extends this module with extra IPC commands and new services.

View file

@ -1,2 +1,2 @@
# spl
This module is a reimplementation of the Horizon OS's "spl" system module, which is responsible for providing secure platform services such as cryptographic operations.
This module is a reimplementation of the Horizon OS's `spl` system module, which is responsible for providing secure platform services such as cryptographic operations.

View file

@ -333,9 +333,7 @@ C0TcS5X0
Code type 0xC1 performs saving or restoring of registers.
#### Encoding
```
C10D0Sx0
```
`C10D0Sx0`
+ D: Destination index.
+ S: Source index.
@ -353,9 +351,7 @@ C10D0Sx0
Code type 0xC2 performs saving or restoring of multiple registers using a bitmask.
#### Encoding
```
C2x0XXXX
```
`C2x0XXXX`
+ x: Operand Type, see below.
+ X: 16-bit bitmask, bit i == save or restore register i.
@ -372,9 +368,7 @@ C2x0XXXX
Code type 0xC3 reads or writes a static register with a given register.
#### Encoding
```
C3000XXx
```
`C3000XXx`
+ XX: Static register index, 0x00 to 0x7F for reading or 0x80 to 0xFF for writing.
+ x: Register index.
@ -392,9 +386,7 @@ This reserves an additional 16 opcodes for future use.
Code type 0xFF0 pauses the current process.
#### Encoding
```
FF0?????
```
`FF0?????`
---
@ -402,9 +394,7 @@ FF0?????
Code type 0xFF1 resumes the current process.
#### Encoding
```
FF1?????
```
`FF1?????`
---