Skip to content

Commit dc8a6a4

Browse files
committed
fix Markdown issues
- reduce headline levels - `markdownlint-cli2 --fix 'src/**/*.md' !src/SUMMARY.md` Signed-off-by: Daniel Maslowski <[email protected]>
1 parent 0bcde4c commit dc8a6a4

File tree

8 files changed

+22
-22
lines changed

8 files changed

+22
-22
lines changed

src/SUMMARY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
- [PSI Spec Introduction](intro.md)
2-
* [Application Processors](application-processors.md)
3-
* [Peripherals](peripherals.md)
2+
- [Application Processors](application-processors.md)
3+
- [Peripherals](peripherals.md)
44
- [Mask ROMs and Loaders](mask-roms-loaders.md)
55
- [Platform Initialization](platform-initialization.md)
66
- [Boot Environments](boot-environments.md)

src/application-processors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Application Processors
1+
# Application Processors
22

33
An _Application Processor_ (AP) is the main processing unit of a system,
44
commonly designed as a _System on Chip_ (SoC). APs are sometimes also considered
@@ -8,7 +8,7 @@ over the years, psi-spec is concerned with the kind of processors that feature a
88
_Memory Management Unit_ (MMU) and DRAM, allowing for many concurrent tasks and
99
processing large amounts of data.
1010

11-
### System on Chip
11+
## System on Chip
1212

1313
An SoC integrates processing units with IO [peripherals](peripherals.md) via
1414
internal system buses and networks, all packaged into one chip.

src/boot-environments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Boot Environments
1+
# Boot Environments
22

33
A _boot environment_ is the hosting system of a _boot loader_.
44

src/intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
## Introduction
1+
# Introduction
22

33
![PSI logo](images/logo.svg)
44

55
The Platform System Interface Specification, or _psi-spec_, is
66
a collection of documents for [hardware and software co-design](
7-
#) from a general perspective.
7+
# ) from a general perspective.
88
It describes how [microprocessors](./application-processors) provide an
99
[environment for booting](boot-environments.md) operating systems or otherwise
1010
bare-metal applications, typically starting from intermediate, rewritable code

src/mask-roms-loaders.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Mask ROMs and Loaders
1+
# Mask ROMs and Loaders
22

33
Many SoCs have initial pieces of code baked into them to bootstrap the system.
44
Some may call them boot ROMs, otherwise known as mask ROMs or Zero Stage Boot
@@ -16,7 +16,7 @@ of such a mechanism, they also have their own software utilities that understand
1616
the respective protocol. With that software, one may read out chip information,
1717
perform MMIO access, transfer data into memory and execute it, set fuses, etc.
1818

19-
### Generic protocols, variants and tools
19+
## Generic protocols, variants and tools
2020

2121
- [USB Device Firmware Upgrade (DFU)](https://www.usb.org/document-library/device-firmware-upgrade-11-new-version-31-aug-2004)
2222
- [STM32](https://www.st.com/resource/en/application_note/an3156-usb-dfu-protocol-used-in-the-stm32-bootloader-stmicroelectronics.pdf)
@@ -26,7 +26,7 @@ perform MMIO access, transfer data into memory and execute it, set fuses, etc.
2626
- [U-Boot documentation on fastboot](https://docs.u-boot.org/en/latest/android/fastboot-protocol.html)
2727
- [fastboot host-side implementation in Rust](https://github.com/platform-system-interface/fastboot)
2828

29-
### Vendor specific protocols and tools
29+
## Vendor specific protocols and tools
3030

3131
- Allwinner: FEL mode, usable with
3232
- [`sunxi-fel`](https://github.com/linux-sunxi/sunxi-tools)

src/peripherals.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Peripherals
1+
# Peripherals
22

33
Systems connect with external hardware components, also known as _peripherals_,
44
using buses and controllers. A controller is a unit driving a bus, such as the

src/platform-initialization.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Platform Initialization
1+
# Platform Initialization
22

33
Booting a rich, virtual memory operating system poses challenges. While modern
44
machines may offer gigabytes or even terabytes of _dynamic random access memory_
@@ -12,7 +12,7 @@ controllers as needed to load and boot an operating system. Due to the high
1212
diversity of hardware, every SoC, SoM and mainboard comes with specific
1313
necessities.
1414

15-
### Boot Flows
15+
## Boot Flows
1616

1717
Since memory and storage parts can be complex, additional firmware and loaders
1818
are implemented in software. They would initialize the platform step by step,
@@ -29,8 +29,8 @@ phase by phase, or stage by stage; projects differ in naming.
2929
| oreboot | mask ROM | boot block | bt0 | main | LinuxBoot | OS |
3030

3131
**Note**:
32-
[oreboot
33-
](https://github.com/oreboot/oreboot/tree/main/Documentation/boot-flow.md) and
32+
[oreboot](https://github.com/oreboot/oreboot/tree/main/Documentation/boot-flow.md)
33+
and
3434
[coreboot](https://doc.coreboot.org/getting_started/architecture.html) do not
3535
implement boot loaders to access external storage themselves. Instead, they
3636
provide options for payloads that could load a final OS or stand for themselves;
@@ -56,16 +56,16 @@ unless ways to circumvent the verification are found. This is also true for many
5656
OEM products in general, where custom firmware is not part of the product
5757
design. I.e., it is [protected against modification](platform-security.md).
5858

59-
### References
59+
## References
6060

61-
#### Arm platforms
61+
### Arm platforms
6262

6363
- [How Arm systems are booted](https://youtu.be/GXFw8SV-51g)
6464
- [U-Boot / Amlogic](https://youtu.be/u0-swEMDFp0)
6565
- Arm secure boot chain on Ampere Altra
66-
* [Armed to boot talk](https://youtu.be/i2IG6Au34xM)
67-
* [Armed to boot blog post](https://blog.cloudflare.com/armed-to-boot/)
66+
- [Armed to boot talk](https://youtu.be/i2IG6Au34xM)
67+
- [Armed to boot blog post](https://blog.cloudflare.com/armed-to-boot/)
6868

69-
#### RISC-V platforms
69+
### RISC-V platforms
7070

71-
**TODO**
71+
TODO

src/platform-security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Platform Security
1+
# Platform Security
22

33
In order to design a secure platform, each and every component in the boot
44
process must be _measured_ and/or _verified_. In addition, the platform in its

0 commit comments

Comments
 (0)