The open source GIM-2.0 release

Signed-off-by: Ken Xue <[email protected]>

Author: firstbread

Makefile

@@ -0,0 +1,45 @@
+#
+# Copyright (c) 2014-2017 Advanced Micro Devices, Inc. All rights reserved.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE
+
+GIM_VERSION=1.1.3
+
+LINUXINCLUDE := $(LINUXINCLUDE) -I$(src)/drv/asic_reg
+KBUILD_CFLAGS := $(KBUILD_CFLAGS) -D DRV_VERSION=$(GIM_VERSION)
+
+#KBUILD_CFLAGS += -DCONFIG_GIM_HEARTBEAT_TIMER=y
+#KBUILD_CFLAGS += -DCONFIG_MMIO_QEMU_SECURITY=y
+
+obj-m += gim.o
+gim-objs := drv/gim_drv.o drv/gim_interface.o drv/gim_adapter.o drv/gim_pci.o drv/gim_unwrapper.o drv/gim_gpuiov.o drv/gim_config.o drv/gim_timer.o drv/gim_fb.o drv/gim_debug.o drv/gim_flr.o drv/gim_atom.o drv/gim_atombios.o drv/gim_os_service.o drv/gim_irqmgr.o drv/gim_kcl_os.o drv/gim_pci_config.o drv/gim_kcl_pci.o drv/gim_reset.o drv/gim_dma.o drv/gim_monitor.o drv/gim_monitor_ioctl.o drv/gim_monitor_tonga.o
+
+PWD := $(shell pwd)
+
+ifeq ($(KERNELRELEASE),)
+KERNELDIR ?= /lib/modules/$(shell uname -r)/build
+
+$(info $(KBUILD_CFLAGS))
+all:
+	$(MAKE) -C $(KERNELDIR) M=$(PWD) modules
+
+clean:
+	$(MAKE) -C $(KERNELDIR) M=$(PWD) clean
+endif
+

README.md

@@ -1,7 +1,7 @@
 # GIM
 
 ```javascript
-Copyright (c) 2014-2017 Advanced Micro Devices, Inc. All rights reserved.
+Copyright (c) 2014-2018 Advanced Micro Devices, Inc. All rights reserved.
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
@@ -25,12 +25,14 @@ THE SOFTWARE
  (GPU-IOV Module) is a Linux kernel module for AMD SR-IOV based HW
  Virtualization (MxGPU) product. It can support KVM, open source Xen and
  any other Linux kernel based hypervisors with necessary kernel compatibility
- modification. GIM is reponsible for but not limits to: GPU IOV initialization,
- virtual function configuration and enablement, GPU scheduling for world
- switch, hung detection and virtual function level reset (FLR), PF/VF hand
- shake and other GPU utilities.
+ modification. GIM is reponsible for: 
+ * GPU IOV initialization
+ * Virtual function configuration and enablement
+ * GPU scheduling for world switch
+ * Hang detection and virtual function level reset (FLR)
+ * PF/VF hand shake and other GPU utilities.
 
- Currently only AMD S7150 series are supported.
+ Currently, only AMD S7150 series GPUs are supported.
 
 ## DOCUMENTATION:
  All documents are listed in SRC_ROOT/docs
@@ -40,7 +42,7 @@ THE SOFTWARE
  hypervisor SW(KVM, XEN, QEMU, LIBVIRT) versions are aligned with default
  version of OS.
 
- GIM supports KVM in Ubuntu16.04, and supports XEN in CentOS7.3.
+ GIM supports KVM in Ubuntu 16.04, and supports XEN in CentOS 7.3.
 
  Host OS     | Kernel            | KVM/Xen | QEMU  | libvirt
  ------------|-------------------|---------|-------|--------------
@@ -51,14 +53,13 @@ THE SOFTWARE
 
  Guest OS  |  Distributions                                 
  ----------|-------------------------------------------------
- Linux     |  Ubuntu16.04 LTS 64bit; CentOS7.3 64 bit       
+ Linux     |  Ubuntu 16.04 LTS 64bit; CentOS 7.3 64 bit       
  Windows   |  Win7 64bit; Win10 TH2 64bit                   
 
 
- * The patches for Linux host OS
- For some legacy Linux kernels, there are some issues to enable pci sriov.
- Take Ubuntu 4.4.0-75-generic kernel, there is a patch for iov module under
- SRC_ROOT/patch.
+ * Some legacy Linux kernels have issues with enabling PCI SR-IOV.
+   It is suggested to use Ubuntu 4.4.0-75-generic kernel and apply the patch for 
+   IOV module. The patch file can be found under SRC_ROOT/patch.
 
 ## HOW TO BUILD & INSTALL:
  All driver source codes are under SRC_ROOT/drv.
@@ -67,15 +68,21 @@ THE SOFTWARE
    gim.ko to /lib/modules/$(KERNELRELEASE)/GIM/.
  3. Generally, Just run helper SRC_ROOT/gim.sh in a command terminal also can
    completed build and installation. And gim.sh -help can display usages.
-
+ 4. Blacklist amdgpu and amdkfd and reboot the server. Such as, under Ubuntu, 
+   by adding the following line to the end of file /etc/modprobe.d/blacklist.conf
+   
+   ```
+   blacklist amdgpu
+   blacklist amdkfd
+   ```
 ## HOW TO LOAD:
- 1. Typing command "modprobe gim " in terminal can load gim driver
+ 1. Typing command "modprobe gim" in terminal can load gim driver
  2. Usually, Typing command "lsmod | grep gim " and "lspci | grep AMD" in
    terminal can help to check if gim driver is loaded
 
 ## HOW TO CONFIGURE BUILD:
-  Read this section carefully. New configuration options would be added in
-  each release, and odd problems will turn up if the configuration files are
+  Read this section carefully. New configuration options could be added in
+  each release, and unexpected problems can occur if the configuration files are
   not set up as expected.
 
   * Alternative configuration commands are
@@ -88,10 +95,13 @@ THE SOFTWARE
 
  * Edit configuraiton in Makefile
 
-        GIM is a external kernel driver module. The driver configuration is
-        different from upstream kernel driver. Now, Edit "KBUILD_CFLAGS" in
-        Makefile is preferred to pass the configuraiton to GIM codes.
+        GIM is an external kernel driver module. The driver configuration is
+        different from upstream kernel driver. Editing "KBUILD_CFLAGS" in
+        the Makefile is preferred to pass the configuration to GIM.
 
 ## HISTORY:
  - 1.0 (2017/07/20)
         The original release support AMD S7150 series.
+
+ - 2.0 (2018/9/30)
+        Fix some issues for AMD S7150 series.

docs/environment_setup

@@ -30,10 +30,9 @@ Platform
 
 Host Software
 -------------
-1.Ubuntu16.04 server
+1.Ubuntu 16.04 server
  1.1 OS installation and configuration
-  1.1.1 just install OS step by step by the installation tips,
-  there is no special configure, but remeber to select virtualization choice when install.
+  1.1.1 Select virtualization when installing.
 
  1.2 Hypervisor installation and configuration
   1.2.1 update the software and kernel
@@ -49,18 +48,18 @@ Host Software
   f. apt-get install qt3-dev-tools libqt3-mt-dev
   g. menuconfig (by default)
   1.2.3 patch the kernel for SRIOV support and build kernel
-  a. patch the following patches
-  0001-Added-legacy-endpoint-type-to-sriov-for-ubuntu-4.4.0-75-generic.diff
-  0002-add-pci-io-access-cap-for-ubuntu-4.4.0-75-generic.diff
+  a. Apply the following patches
+  patch < ./patch/0001-Added-legacy-endpoint-type-to-sriov-for-ubuntu-4.4.0-75-generic.diff
+  patch < ./patch/0002-add-pci-io-access-cap-for-ubuntu-4.4.0-75-generic.diff
   b. make-kpkg -j N --initrd --append-to-version=my-very-own-kernel kernel-image kernel-headers to buile kernel
   where N is how many jobs to run in parallel (usually the number of CPUs you have), and my-very-own-kernel is
   a custom string to identify the build
-  1.2.4 install kernel
+  1.2.4 Install kernel
   a. dpkg -i *.deb to install kernel-image and header which are ready after build compelete.
-  1.2.5 configure to blacklist amdgpu driver in host
+  1.2.5 Blacklist amdgpu driver on the host system
   a. add "blacklist amdgpu" in /etc/modprobe.d/blacklist.conf
   b. update-initramfs -u
-  1.2.6 configure to enable iommu
+  1.2.6 Enable IOMMU
   a. edit /etc/default/grub
   change GRUB_CMDLINE_LINUX_DEFAULT="quiet splash" to GRUB_CMDLINE_LINUX_DEFAULT="quiet splash intel_iommu=on" if Intel CPU
   change GRUB_CMDLINE_LINUX_DEFAULT="quiet splash" to GRUB_CMDLINE_LINUX_DEFAULT="quiet splash amd_iommu=on" if AMD CPU

docs/gim_runtime_configuration

@@ -22,8 +22,8 @@
 
 GIM Runtime Configuration
 
-The GIM configuration file /etc/gim_config can be created after first time load
-gim.ko. It can configure runtime GIM behaviors.
+The GIM configuration file /etc/gim_config can be created after loading gim.ko
+for the first time. It can be used to modify options for GIM.
 
 There are 7 options: vf_num, pf_fb, vf_fb, fb_option, sched_interval,
 sched_option, fb_clear.
@@ -136,7 +136,7 @@ sched_option, fb_clear.
 
  sched_option = 1
  All VFs will share HW resoruce equally by almost same time slice in turns. Even
- the VF is stop, the VF still can occupy the HW resource.
+ the VF is stop, the VF still can occupy its HW resource.
 
 7. fb_clear
  Clear the VRAM for VF

drv/Makefile

@@ -19,12 +19,14 @@
 # THE SOFTWARE
 
 obj-m := gim.o
-gim-objs := gim_drv.o gim_interface.o gim_adapter.o gim_pci.o gim_unwrapper.o gim_gpuiov.o gim_file.o gim_config.o gim_timer.o gim_fb.o gim_debug.o gim_flr.o gim_atom.o gim_atombios.o gim_os_service.o gim_irqmgr.o gim_kcl_os.o gim_pci_config.o gim_kcl_pci.o gim_reset.o gim_dma.o
+gim-objs := gim_drv.o gim_interface.o gim_adapter.o gim_pci.o gim_unwrapper.o gim_gpuiov.o gim_config.o gim_timer.o gim_fb.o gim_debug.o gim_flr.o gim_atom.o gim_atombios.o gim_os_service.o gim_irqmgr.o gim_kcl_os.o gim_pci_config.o gim_kcl_pci.o gim_reset.o gim_dma.o gim_monitor.o gim_monitor_ioctl.o gim_monitor_tonga.o
 
-ccflags-y := -O1 -ftree-ter -I$(src)/asic_reg
+LINUXINCLUDE := $(LINUXINCLUDE) -I$(src)/asic_reg
 
 #GIM configuration
 #ccflags-y += -DCONFIG_GIM_HEARTBEAT_TIMER
+#ccflags-y += -D DRV_VERSION=1.0
+#ccflags-y += -DCONFIG_MMIO_QEMU_SECURITY
 
 PWD := $(shell pwd)
 
@@ -39,5 +41,5 @@ clean:
 	$(MAKE) -C $(KERNELDIR) M=$(PWD) clean
 
 install:
-	$(MAKE) -C $(KERNELDIR) M=$(PWD) INSTALL_MOD_DIR=GIM modules_install
+	$(MAKE) -C $(KERNELDIR) M=$(PWD) modules_install
 endif