From 4d67cfaba59f274470c128dfcbb94cca3a172970 Mon Sep 17 00:00:00 2001 From: Aaron Taylor Date: Wed, 28 Apr 2021 01:50:22 -0700 Subject: [PATCH] Added a basic README to the project. --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0d8c40c --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Overview # + +This repository contains source code for the Intel kernel module distributed +with MPSS 3.8.6 for the Xeon Phi x100 family (Knights Corner). It has been +modified for compatibility with newer Linux kernels. + +Since this kernel module is tied to a fixed version of the MPSS software +(v3.8.6) and thus doesn't need to chase a moving target on that end, rather +than attempt to maintain one codebase for all Linux kernel versions, we instead +target only a single Linux kernel version at a time. If you desire code +compatible with older kernel versions, the last working version of the code for +a given kernel version may be found tagged in git. + + +# Status # + +Work in progress. Not yet functional. + +Tested on Debian 10.9 (buster) with Linux kernel 4.19.181-1. + + +# Instructions # + + +On Debian, install relevant packages for building a kernel (`build-essential`, +`linux-headers-*`, etc). Then simply `make clean all` and load the resulting +kernel module. -- 2.20.1