Skip to content

Commit 3ec3f94

Browse files
committed
initial commit for dasharo naming convention v2
Signed-off-by: Piotr Król <[email protected]>
1 parent c13b3f0 commit 3ec3f94

File tree

2 files changed

+57
-69
lines changed

2 files changed

+57
-69
lines changed

docs/dasharo-naming-convention.md

Lines changed: 29 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,66 @@
11
# Dasharo Product Naming Convention
22

3-
Following documentation is results of [RFC](https://github.com/Dasharo/dasharo-issues/issues/762).
3+
Following documentation is v2 of naming convention following results of
4+
[RFC](https://github.com/Dasharo/dasharo-issues/issues/762).
45

56
## Synopsis
67

78
```plain
8-
Dasharo (firmware_framework[+payload]) [customer_type] Package for
9-
market_segment
9+
Dasharo (framework[+payload]) [edition] Package for [platform]
1010
```
1111

1212
## Description
1313

1414
Dasharo's naming scheme is crafted to convey the essential details of each
1515
firmware package. It includes the base firmware framework, an optional payload,
16-
the targeted market segment, and the customer type. This structure assists in
17-
identifying the most suitable package for specific technological needs, market
18-
segments, and customer categories.
16+
the target `platform`, and the `edition`. This structure helps identify the
17+
most suitable package for `platform`-specific needs and customer categories.
1918

2019
Components of the naming scheme:
2120

22-
```plain
23-
Dasharo (firmware_framework[+payload]) [customer_type] Package for
24-
market_segment
25-
```
26-
27-
- `firmware_framework`: Mandatory. Specifies the base firmware framework used
28-
in the package. Available options:
21+
- `framework`: Mandatory. Specifies the base firmware framework used in the package. Available options:
2922

30-
+ `coreboot` - [Dasharo downstream](https://github.com/Dasharo/coreboot) of
31-
[coreboot](https://coreboot.org) open source project.
32-
+ `UEFI` - [Dasharo downstream](https://github.com/Dasharo/edk2) of
33-
[Tianocore EDK II](https://github.com/tianocore/edk2) reference
34-
implementation of the UEFI Specification.
23+
+ `coreboot` - Dasharo downstream of coreboot open source project.
24+
+ `UEFI` - Dasharo downstream of Tianocore EDK II reference implementation of
25+
the UEFI Specification.
26+
+ `Slim Bootloader` - upstream or downstream version of Slim Bootloader.
3527

3628
- `payload` (optional): Details the additional software loaded by the firmware.
37-
Available options:
29+
Available options:
3830

39-
+ `UEFI` - [Dasharo downstream](https://github.com/Dasharo/edk2) of
40-
[Tianocore EDK II](https://github.com/tianocore/edk2) reference
41-
implementation of the UEFI Specification.
42-
+ `SeaBIOS` - upstream or downstream version of [SeaBIOS](https://www.seabios.org)
43-
+ `Heads` - upstream or downstream version of [Heads](https://github.com/linuxboot/heads/)
31+
+ `UEFI` - Dasharo downstream of EDK II.
32+
+ `SeaBIOS` - upstream or downstream version of SeaBIOS.
33+
+ `Heads` - upstream or downstream version of Heads.
34+
+ `U-Boot` - upstream or downstream version of U-Boot.
4435

4536
The omission of this component implies no additional payload.
4637

47-
- `market_segment`: Indicates the target market segment for the package.
48-
Possible segments:
49-
50-
```plain
51-
Network Appliance/Embedded | Laptop | Desktop | Workstation | Server
52-
```
53-
54-
- `customer_type`: Specifies whether the package is aimed at professional
55-
retail customers or enterprise business customers. Options are:
56-
57-
```plain
58-
Pro | Enterprise
59-
```
38+
- `platform`: Indicates the target platform for the package. Platform is
39+
mandatory in public names. Platform name should follow [supported hardware
40+
list](/variants/overview).
41+
- `edition`: Community | Pro | Enterprise (edition codes: DCP, DPP, DEP)
6042

6143
This naming convention aims to provide clarity and precision, facilitating ease
6244
of understanding across Dasharo's firmware offerings.
6345

6446
## Examples
6547

6648
```plain
67-
Dasharo (coreboot+Heads) Pro Package for Laptop
49+
Dasharo (coreboot+Heads) Pro Package for Novacustom NV4x 12th Gen
6850
```
6951

7052
A package aimed at professional retail customers with laptops, incorporating
7153
coreboot with the Heads payload.
7254

7355
```plain
74-
Dasharo (UEFI) Enterprise Package for Desktop
56+
Dasharo (Slim Bootloader+UEFI) Pro Package for Hardkernel ODROID-H4
57+
```
58+
59+
A package that uses Slim Bootloader with UEFI payload on Hardkernel ODROID-H4.
60+
61+
```plain
62+
Dasharo (UEFI) Enterprise Package for MSI PRO Z690-A
7563
```
7664

77-
A package for enterprise business customers for desktops, employing UEFI with
78-
no additional payload specified.
65+
A package for enterprise business customers for MSI PRO Z690-A, employing UEFI
66+
as framework with no additional payload.

docs/osf-trivia-list/dasharo.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ of the project documentation.
320320

321321
Dasharo Support coming in form of three following packages:
322322

323-
- Dasharo Community Support (DCP) - donation-driven development.
323+
- Dasharo Community Package (DCP) - donation-driven development.
324324
- Dasharo Support Package (DSP) - annual firmware support package.
325325
- Dasharo Enterprise Package (DEP) - custom SLA, corporate, and open roadmap
326326
alignment advisory.
@@ -330,8 +330,8 @@ initiative that leverages the expertise of community members and developers to
330330
improve firmware solutions for a range of hardware models.
331331

332332
Platforms in scope of the program should comply with Dasharo quality criteria,
333-
which we slowly gather in [Dasharo Certification
334-
Program](#what-is-dasharo-certification-program).
333+
which we slowly gather in [Dasharo Certified Firmware
334+
Program](#what-is-dasharo-certified-firmware-program).
335335

336336
3mdeb supports and maintains DCP-approved firmware through Dasharo Support
337337
Package (DSP) and Dasharo Enterprise Package (DEP). These packages offer
@@ -365,34 +365,34 @@ Certification Program providing certain quality criteria including test
365365
results. We always trying to minimize delta, but sometimes it can be up to 5k
366366
SLOC (or more I guess e.g. Talos II coreboot support).
367367

368-
## What is Dasharo Certification Program?
369-
370-
The Dasharo Certification Program (DCP) is a highly specialized certification
371-
program that benchmarks open-source firmware ecosystem deliverables. The
372-
program ensures that firmware is stable, secure, and dependable while aligning
373-
with the Dasharo values. DCP encourages developers to create their version of
374-
Dasharo or contribute to the Dasharo project or coreboot upstream, enabling
375-
them to leverage the power of open-source development to create custom firmware
376-
tailored to their specific needs based on years of Dasharo quality assurance
377-
results. The program's rigorous certification process entails comprehensive
378-
testing in the Dasharo Certification Lab, ensuring that the firmware binary
379-
meets the strict standards established by the program. By aligning with the
380-
Dasharo values, the certification program improves the overall posture of the
381-
open-source firmware ecosystem, making it long-term maintainable, sustainable,
382-
and trustworthy and providing specific service level agreements and warranties
383-
to commercial customers and the community.
384-
385-
## What is DCP-approved firmware?
386-
387-
The Dasharo-certified firmware provides long-term maintenance over ten years
368+
## What is Dasharo Certified Firmware Program?
369+
370+
The Dasharo Certified Firmware (DCF) Program is a highly specialized
371+
certification program that benchmarks open-source firmware ecosystem
372+
deliverables. The program ensures that firmware is stable, secure, and
373+
dependable while aligning with the Dasharo values. DCF encourages developers to
374+
create their version of Dasharo or contribute to the Dasharo project or
375+
coreboot upstream, enabling them to leverage the power of open-source
376+
development to create custom firmware tailored to their specific needs based on
377+
years of Dasharo quality assurance results. The program's rigorous
378+
certification process entails comprehensive testing in the Dasharo
379+
Certification Lab, ensuring that the firmware binary meets the strict standards
380+
established by the program. By aligning with the Dasharo values, the
381+
certification program improves the overall posture of the open-source firmware
382+
ecosystem, making it long-term maintainable, sustainable, and trustworthy and
383+
providing specific service level agreements and warranties to commercial
384+
customers and the community.
385+
386+
## What is DCF-approved firmware?
387+
388+
The Dasharo Certified Firmware provides long-term maintenance over ten years
388389
after the CPU microarchitecture release, which means that OEM, ODM, hardware
389390
vendors, and other companies can rely on the firmware for a long time without
390-
worrying about end-of-life issues. Moreover, DCP-approved firmware vendors must
391-
provide professional support channels to ensure that other business entities
392-
can rely on those channels for long-term support regarding firmware and
393-
software.
391+
worrying about end-of-life issues. Moreover, DCF-approved vendors must provide
392+
professional support channels to ensure that other business entities can rely
393+
on those channels for long-term support regarding firmware and software.
394394

395-
The validation process for DCP firmware is transparent. Test results and bug
395+
The validation process for DCF is transparent. Test results and bug
396396
reports are always publicly available, allowing the community to continually
397397
identify issues and improve the firmware. However, in case of a security
398398
embargo, the results can be kept under a strict but well-defined policy,

0 commit comments

Comments
 (0)