Skip to content

Commit 976fe58

Browse files
pamolloypamolloy
authored
Merge aa4652d into c72cc33 
2 parents c72cc33 + aa4652d commit 976fe58

File tree

5 files changed

+114
-61
lines changed

5 files changed

+114
-61
lines changed

‎README.md‎

Lines changed: 5 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,7 @@
1-
# Linux kernel - variant from Analog Devices, Inc.
1+
# ADI Xilinx Linux branch
22

3-
## Table of contents
4-
5-
1. [Description](#description)
6-
2. [How to build](#how-to-build)
7-
3. [Release branches](#release-branches)
8-
4. [Rebased branches](#rebased-branches)
9-
5. [Raspberry Pi branches](#raspberry-pi-branches)
10-
6. [Intel/Altera branches](#intelaltera-branches)
11-
12-
## Description
13-
14-
The Linux kernel in this repository is the [Linux kernel from Xilinx](https://github.com/Xilinx/linux-xlnx) together with drivers & patches applied from Analog Devices.
15-
16-
Details about the drivers that are of interest [and supported] by this repository can be found on the [Analog Devices wiki](https://wiki.analog.com/resources/tools-software/linux-drivers-all). This readme focuses on details specific to how this code is structured/organized, how it was derived, etc.
17-
18-
The current main is based on [xilinx v2024.1](https://github.com/Xilinx/linux-xlnx/tree/xilinx-v2024.1). For details about the merge see commit [d31fa3135dbef8bf186a7c42fd87b3eedd8446e9](https://github.com/analogdevicesinc/linux/commit/d31fa3135dbef8bf186a7c42fd87b3eedd8446e9) ("Merge tag 'xilinx-v2024.1' of https://github.com/Xilinx/linux-xlnx.git"). In this Xilinx release, the current version of upstream Linux is [Linux 6.6](https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tag/?h=v6.6).
19-
20-
For legacy reasons, the [xcomm_zynq](https://github.com/analogdevicesinc/linux/tree/xcomm_zynq) branch is still available and should be in-sync with current master. That branch used to be the old master branch.
21-
22-
## How to build
23-
24-
For build instructions [check the wiki](https://wiki.analog.com/resources/tools-software/linux-drivers-all#building_the_adi_linux_kernel).
25-
26-
## Release branches
27-
28-
All release branches have the [YEAR]\_R[NUM] format. There are some special release branches sometimes (like 2014\_R2\_altera), because it wasn't always possible to match the Linux repo between Xilinx & Intel/Altera.
29-
30-
Each release is matched with a release from the [HDL repo](https://github.com/analogdevicesinc/hdl). The branching name/model for the HDL repo differs a bit from the one in this repo, but the matching should be obvious.
31-
Therefore, each kernel in the release branches is be built using the toolchains from a specific version of Vivado & Quartus.
32-
A matching of these can be found [on the wiki](https://wiki.analog.com/resources/fpga/docs/releases).
33-
Release branches can be built using other GCC toolchains, but in the official SD-card images provided, they will use the toolchains from Vivado/Quartus.
34-
35-
## Rebased branches
36-
37-
Starting with branch [adi-4.9.0](https://github.com/analogdevicesinc/linux/tree/adi-4.9.0) there are rebased branches.
38-
They're typically rebased branches from Xilinx with the ADI patches on top so that it's easier to identify patches that are not yet upstreamed.
39-
40-
For [adi-4.9.0](https://github.com/analogdevicesinc/linux/tree/adi-4.9.0) the base was branch [xlnx_rebase_v4.9](https://github.com/Xilinx/linux-xlnx/tree/xlnx_rebase_v4.9) at commit [d45e196f59364e9f5eafe46027a7d2af349083974](https://github.com/analogdevicesinc/linux/commit/d45e196f59364e9f5eafe46027a7d2af349083974) in the ADI repo and commit [45e196f59364e9f5eafe46027a7d2af349083974](https://github.com/Xilinx/linux-xlnx/commit/45e196f59364e9f5eafe46027a7d2af349083974) in the Xilinx repo. All ADI patches & drivers up to a specific point in time were cherry-picked to that branch from master.
41-
Note that since the `adi-4.9.0` branch is the first rebased branch, it's not particularly the best rebase that could have been done, but it should provide some patches that are somewhat reasonable to take and apply on top of an upstream 4.9 kernel [after some polishing].
42-
43-
The latest rebased branch depends on the current linux version supported in master. At the time of writing it is 5.10 so that [adi-5.10.0](https://github.com/analogdevicesinc/linux/tree/adi-5.10.0) is the latest. Also note that a diff between the latest rebased branch and master (`git diff master adi-5.10.0`) must be NULL.
44-
45-
## Raspberry Pi branches
46-
47-
These provide a kernel that is good to run on a Raspberry Pi board. All the drivers present in the master branch should be automatically cherry-picked into the latest rpi branch.
48-
49-
As in the rebased branches, the latest rpi branch should be in accordance with the current kernel version supported in master. At the time of writing, the kernel version in master is 5.10 so that the correspondent latest rpi branch is [rpi-5.10.y](https://github.com/analogdevicesinc/linux/tree/rpi-5.10.y).
50-
51-
## Intel/Altera branches
52-
53-
Because the kernel versions that Intel/Altera were usually not in sync with Xilinx's, `altera-*` branches were created.
54-
These are [altera_4.0](https://github.com/analogdevicesinc/linux/tree/altera_4.0), [altera_4.4](https://github.com/analogdevicesinc/linux/tree/altera_4.4), [altera_4.6](https://github.com/analogdevicesinc/linux/tree/altera_4.6), [altera_4.9](https://github.com/analogdevicesinc/linux/tree/altera_4.9).
55-
56-
These branches are derived from the [Intel/Altera linux kernel repo](https://github.com/altera-opensource/linux-socfpga), together with some merged versions of old master branches.
57-
58-
The hope is that with the upcoming Linux 4.19, these branches would stop existing, since Intel/Altera seems to keep in sync their kernel version with more recent [non-LTS kernels]. Typically the releases/references that are provided for these boards should already be in the mainline kernel, so these branches should no longer be needed.
3+
This development branch supports ADI devices and peripherals that are
4+
integrated with AMD/Xilinx FPGAs as well as Raspberry Pi boards.
595

6+
See [analogdevicesinc.github.io/linux/](https://analogdevicesinc.github.io/linux/)
7+
for more information about getting started, contributing, etc.

‎docs/conf.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@
2626

2727
# -- External docs configuration ----------------------------------------------
2828

29+
interref_repos = [
30+
'hdl',
31+
]
32+
2933
intersphinx_mapping = {
3034
'upstream': ('https://docs.kernel.org', None),
3135
'b4': ('https://b4.docs.kernel.org/en/latest', None),

docs/user-guide.rst renamed to docs/contribute.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
User guide
2-
==========
1+
Contribution guidelines
2+
=======================
33

44
This page serves the purpose of providing pointers and a brief introduction to
55
contributing to the Linux Kernel, using the tools available as well as wrappers
@@ -138,7 +138,7 @@ When submitting dt-bindings, you must check:
138138
.. shell::
139139

140140
~/linux
141-
$make dt_binding_chec CONFIG_DTC=y DT_CHECKER_FLAGS=-m DT_SCHEMA_FILES="./path/to/.yaml"
141+
$make dt_binding_check CONFIG_DTC=y DT_CHECKER_FLAGS=-m DT_SCHEMA_FILES="./path/to/.yaml"
142142

143143
For warnings and erros and resolve accordingly.
144144

‎docs/getting_started.rst‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
.. _getting_started:
2+
3+
Getting Started
4+
===============
5+
6+
Description
7+
-----------
8+
9+
The Linux kernel in this repository is the
10+
`Linux kernel from Xilinx <https://github.com/Xilinx/linux-xlnx>`__
11+
together with drivers & patches applied from Analog Devices.
12+
13+
Details about the drivers that are of interest and supported by this repository
14+
can be found on the
15+
:dokuwiki:`Analog Devices wiki <resources/tools-software/linux-drivers-all>`.
16+
This readme focuses on details specific to how this code is
17+
structured/organized, how it was derived, etc.
18+
19+
The current main is based on `xilinx v2025.1 <https://github.com/Xilinx/linux-xlnx/tree/xilinx-v2025.1>`__.
20+
For details about the merge see commit
21+
:git-linux:`3b1f15dc5c4d <commit/3b1f15dc5c4de92663059705d6f1cb6fc87d4470+>`
22+
(Merge tag ``xilinx-v2025.1`` of https://github.com/Xilinx/linux-xlnx.git).
23+
In this Xilinx release, the current version of upstream Linux is
24+
`Linux 6.12 <https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tag/?h=v6.12>`__.
25+
26+
How to build
27+
------------
28+
29+
For build instructions
30+
:dokuwiki:`check the wiki <resources/tools-software/linux-drivers-all#building_the_adi_linux_kernel>`.
31+
32+
Release branches
33+
----------------
34+
35+
All release branches have the ``[YEAR]_R[NUM]`` format. There are some special
36+
release branches sometimes (like ``2014_R2_altera``, because it wasn't always
37+
possible to match the Linux repo between Xilinx & Intel/Altera.
38+
39+
Each release is matched with a release from the :git-hdl:`HDL repo </>`. The
40+
branching name/model for the HDL repo differs a bit from the one in this repo,
41+
but the matching should be obvious. Therefore, each kernel in the release
42+
branches is be built using the toolchains from a specific version of Vivado &
43+
Quartus. A matching of these can be found at :external+hdl:ref:`releases`.
44+
Release branches can be built using other GCC toolchains, but in the official
45+
SD-card images provided, they will use the toolchains from Vivado/Quartus.
46+
47+
Rebased branches
48+
----------------
49+
50+
Starting with :git-linux:`adi-4.9.0:` there are rebased branches. They're
51+
typically rebased branches from Xilinx with the ADI patches on top so that it's
52+
easier to identify patches that are not yet upstreamed.
53+
54+
For :git-linux:`adi-4.9.0:` the base was branch
55+
`xlnx_rebase_v4.9 <https://github.com/Xilinx/linux-xlnx/tree/xlnx_rebase_v4.9>`__
56+
at commit
57+
:git-linux:`e5c22c2179cf <commit/e5c22c2179cfbec584d2c540d40a0c3d7a20770c+>`
58+
in the ADI repo and commit
59+
`45e196f59364 <https://github.com/Xilinx/linux-xlnx/commit/45e196f59364e9f5eafe46027a7d2af349083974>`__
60+
in the Xilinx repo. All ADI patches & drivers up to a specific point in time
61+
were cherry-picked to that branch from master. Note that since the
62+
``adi-4.9.0`` branch is the first rebased branch, it's not particularly the
63+
best rebase that could have been done, but it should provide some patches that
64+
are somewhat reasonable to take and apply on top of an upstream 4.9 kernel
65+
after some polishing.
66+
67+
The latest rebased branch depends on the current linux version supported in
68+
master. Also note that a diff between the latest rebased branch and `xlnx-main`
69+
(e.g., ``git diff xlnx-main adi-6.12.0``) must be NULL.
70+
71+
Raspberry Pi branches
72+
---------------------
73+
74+
These provide a kernel that is good to run on a Raspberry Pi board. All the
75+
drivers present in the master branch should be automatically cherry-picked into
76+
the latest rpi branch.
77+
78+
As in the rebased branches, the latest rpi branch should be in accordance with
79+
the current kernel version supported in master.
80+
81+
Intel/Altera branches
82+
---------------------
83+
84+
Because the kernel versions that Intel/Altera were usually not in sync with
85+
Xilinx's, ``altera-*`` branches were created:
86+
87+
- :git-linux:`altera_4.0 <altera_4.0:>`
88+
- :git-linux:`altera_4.4 <altera_4.4:>`
89+
- :git-linux:`altera_4.6 <altera_4.6:>`
90+
- :git-linux:`altera_4.9 <altera_4.9:>`
91+
- :git-linux:`altera_4.14 <altera_4.14:>`
92+
93+
These branches are derived from the
94+
`Intel/Altera linux kernel repo <https://github.com/altera-opensource/linux-socfpga>`__,
95+
together with some merged versions of old master branches.
96+
97+
These branches would stop existing, since Intel/Altera seems to keep in sync
98+
their kernel version with more recent non-LTS kernels. Typically the
99+
releases/references that are provided for these boards should already be in the
100+
mainline kernel, so these branches should no longer be needed.

‎docs/index.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ Linux documentation.
77
.. toctree::
88
:maxdepth: 1
99

10+
getting_started
1011
iio/index
11-
user-guide
12+
contribute
1213
ci
1314

1415
This documentation contains information only about this and the device drivers

0 commit comments

Comments
 (0)