Skip to content

Commit b28786b

Browse files
author
Danilo Krummrich
committed
gpu: nova-core: add initial documentation
Add the initial documentation of the Nova project. The initial project documentation consists out of a brief introduction of the project, as well as project guidelines both general and nova-core specific and a task list for nova-core specifically. The task list is divided into tasks for general Rust infrastructure required by the project, tasks regarding GSP enablement and firmware abstraction, general GPU driver tasks as well as tasks related to external API design and test infrastructure. Reviewed-by: Alexandre Courbot <acourbot@nvidia.com> Link: https://lore.kernel.org/r/20250306222336.23482-6-dakr@kernel.org Signed-off-by: Danilo Krummrich <dakr@kernel.org>
1 parent 54e6baf commit b28786b

File tree

6 files changed

+571
-0
lines changed

6 files changed

+571
-0
lines changed

Documentation/gpu/drivers.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ GPU Driver Documentation
2424
panfrost
2525
panthor
2626
zynqmp
27+
nova/index
2728

2829
.. only:: subproject and html
2930

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
.. SPDX-License-Identifier: (GPL-2.0+ OR MIT)
2+
3+
==========
4+
Guidelines
5+
==========
6+
7+
This documents contains the guidelines for nova-core. Additionally, all common
8+
guidelines of the Nova project do apply.
9+
10+
Driver API
11+
==========
12+
13+
One main purpose of nova-core is to implement the abstraction around the
14+
firmware interface of GSP and provide a firmware (version) independent API for
15+
2nd level drivers, such as nova-drm or the vGPU manager VFIO driver.
16+
17+
Therefore, it is not permitted to leak firmware (version) specifics, through the
18+
driver API, to 2nd level drivers.
19+
20+
Acceptance Criteria
21+
===================
22+
23+
- To the extend possible, patches submitted to nova-core must be tested for
24+
regressions with all 2nd level drivers.

0 commit comments

Comments
 (0)