isabella232 / opensystemfirmware

Open Systems Firmware (OSF)

Open System Firmware (OSF)

This repository holds software contributions for OSF.

To make it easy for customers to recreate firmware, ODMs SHALL document where the various components are and how to build a complete firmware image. These documents, instructions, and (e.g.) makefiles SHALL be placed in the repos shown below; however, we do not require that the entirety of (e.g.) the source code be copied into these repos. For example, if an ODM is using coreboot or Linux, source code SHALL be upstreamed to those projects. The OCP repos can then contain configuration files and, almost certainly, a git hash of the version of the software used. Binary artifacts SHOULD be placed in the OCP repos, as well as a link to the source of the binary(ies), and a license document.

Location	Description
[vendor_name]/[product_name]/	Directory of OSF product
[vendor_name]/[product_name]/LICENSE	License for this directory
[vendor_name]/[product_name]/Makefile	Script to build OSF product
[vendor_name]/[product_name]/src/	Directory for source files
[vendor_name]/[product_name]/bin/	Directory for binary files

Optionally, [product_name]/ can have a [product_version]/ subdirectory in case there are multiple versions or revisions of the product's hardware with incompatible firmware.

See Open System Firmware Checklist for submission process.