Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,41 @@
# Introduction

Welcome to the Universal Payload project. The goal of this project is to define an interface between a first stage platform initialization bootloader and a second stage payload.
Welcome to the Universal Scalable Firmware project. The goal of this project is to define an interface between a first stage platform initialization bootloader and a second stage payload.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we limiting the scope to Bootloader/Payload interface only? I think the name is more broad.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. With new name, the scope should also be changed. Let me check to get the new scope and update this patch.


## Specification

The interface specification is at
https://universalpayload.github.io/documentation/
https://universalscalablefirmware.github.io/documentation/

The specification source is maintained in restructured text format and is available at
https://github.com/universalpayload/documentation
https://github.com/UniversalScalableFirmware/documentation

## Sandboxes

A few example implementations of the Universal Payload specification are available.
A few example implementations of the Universal Scalable Firmware payload specification are available.

### Slim Bootloader

An POC implementation of Slim Bootloader conforming to the Universal Payload specification
https://github.com/universalpayload/slimbootloader/tree/universal_payload
An POC implementation of Slim Bootloader conforming to the Universal Scalable Firmware Payload specification
https://github.com/UniversalScalableFirmware/slimbootloader/tree/universal_payload

### coreboot

An POC implementation of coreboot conforming to the Universal Payload specification
https://github.com/universalpayload/coreboot/tree/universal_payload
An POC implementation of coreboot conforming to the Universal Scalable Firmware Payload specification
https://github.com/UniversalScalableFirmware/coreboot/tree/universal_payload

### UEFI Payload

An POC implementation of UEFI Payload conforming to universal payload specification.
https://github.com/universalpayload/edk2/tree/universal_payload
An POC implementation of UEFI Payload conforming to Universal Scalable Firmware Payload specification.
https://github.com/UniversalScalableFirmware/edk2/tree/universal_payload

### Linux Payload

An POC implementation of Linux Payload containing necessary patches to build a basic Linux payload conforming to the universal payload specification.
https://github.com/universalpayload/linuxpayload
An POC implementation of Linux Payload containing necessary patches to build a basic Linux payload conforming to the Universal Scalable Firmware Payload specification.
https://github.com/UniversalScalableFirmware/linuxpayload

### Tools

The pack_payload.py tool can be used to pack a normal payload image into the universal payload image format
The pack_payload.py tool can be used to pack a normal payload image into the Universal Scalable Firmware Payload image format
The clone_and_build_sbl_with_uefipayload.py tool could clone and build SBL + UEFI payload to have a quick try.
https://github.com/universalpayload/tools
https://github.com/UniversalScalableFirmware/tools