Added a basic README to the project.
[xeon-phi-kernel-module] / README.md
CommitLineData
4d67cfab
AT
1# Overview #
2
3This repository contains source code for the Intel kernel module distributed
4with MPSS 3.8.6 for the Xeon Phi x100 family (Knights Corner). It has been
5modified for compatibility with newer Linux kernels.
6
7Since this kernel module is tied to a fixed version of the MPSS software
8(v3.8.6) and thus doesn't need to chase a moving target on that end, rather
9than attempt to maintain one codebase for all Linux kernel versions, we instead
10target only a single Linux kernel version at a time. If you desire code
11compatible with older kernel versions, the last working version of the code for
12a given kernel version may be found tagged in git.
13
14
15# Status #
16
17Work in progress. Not yet functional.
18
19Tested on Debian 10.9 (buster) with Linux kernel 4.19.181-1.
20
21
22# Instructions #
23
24
25On Debian, install relevant packages for building a kernel (`build-essential`,
26`linux-headers-*`, etc). Then simply `make clean all` and load the resulting
27kernel module.