openEuler Driver Development Specifications

Purpose

The openEuler driver development specifications are formulated to standardize and unify the submission process and mode of developed openEuler drivers and enable drivers on openEuler.

Application Scope

The openEuler driver development specifications apply to the development of openEuler and all released versions.

The versions include but are not limited to the following:

openEuler 20.03 LTS SP3
openEuler 22.03 LTS
openEuler 22.03 LTS SP1

Basic Requirements for Drivers

Objectives of openEuler:

Becomes a platform that accelerates technological innovation, maturity, and application.
Maintains the secure, stable, and reliable kernel with optimal performance boosted by an extensive ecosystem, facilitating quick application in the industry.

Drivers that meet the preceding principles can be submitted to openEuler.

Contributor License Agreement (CLA)

Contributors must sign the CLA before contributing to the openEuler community.

Note: It takes about one week for the CLA to take effect after it is signed.

Driver Requirements

The driver must meet the following requirements:

Have a unique name in the system.
Pass the Kernel Application Binary Interface (kABI) check of the openEuler community.
Provide correct driver version information.
Provide a description of driver module parameters.
Provide required auxiliary tools.
Declare the license information.
It is recommended that the coupling mode between the driver and the OS release be added. For example, directly check the /etc/openEuler-release file or other technical roadmaps, and do not couple the driver with the specific release information.
Provide the driver installation guide in the community repository.

Reference

Bug Catching

Buggy Content

Bug Description

Submit As Issue

It's a little complicated....

I'd like to ask someone.

Just a small problem.

I can fix it online!

Bug Type

Specifications and Common Mistakes

● Misspellings or punctuation mistakes;

● Incorrect links, empty cells, or wrong formats;

● Chinese characters in English context;

● Minor inconsistencies between the UI and descriptions;

● Low writing fluency that does not affect understanding;

● Incorrect version numbers, including software package names and version numbers on the UI.

Usability

● Incorrect or missing key steps;

● Missing prerequisites or precautions;

● Ambiguous figures, tables, or texts;

● Unclear logic, such as missing classifications, items, and steps.

Correctness

● Technical principles, function descriptions, or specifications inconsistent with those of the software;

● Incorrect schematic or architecture diagrams;

● Incorrect commands or command parameters;

● Incorrect code;

● Commands inconsistent with the functions;

● Wrong screenshots.

Risk Warnings

● Lack of risk warnings for operations that may damage the system or important data.

Content Compliance

● Contents that may violate applicable laws and regulations or geo-cultural context-sensitive words and expressions;

● Copyright infringement.

We may contact you through email in regard to the bug fixing solution. You will also be notified through email if you win any prize during the activity.