gpu: nvgpu: Userspace POSIX support

Add support for compiling nvgpu in a POSIX compliant userspace.
This code adds all of the necessary abstraction interfaces (mostly
stubbed) to enabled extremely limited and basic functionality in
nvgpu.

The goal of this code is to facilitate unit testing of the nvgpu
common core. By doing this in userspace it is much easier to write
tests that rely on very particular states within nvgpu since a user
can very precisely control the state of nvgpu.

JIRA NVGPU-525

Change-Id: I30e95016df14997d951075777e0585f912dc5960
Signed-off-by: Alex Waterman <alexw@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/1683914
GVS: Gerrit_Virtual_Submit
Reviewed-by: Terje Bergstrom <tbergstrom@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>

6 files changed, 181 insertions, 0 deletions

diff --git a/userspace/.gitignore b/userspace/.gitignore
new file mode 100644
index 00000000..d1638636
--- /dev/null
+++ b/userspace/.gitignore
@@ -0,0 +1 @@
+build/
\ No newline at end of file
diff --git a/userspace/Makefile b/userspace/Makefile
new file mode 100644
index 00000000..70e93bad
--- /dev/null
+++ b/userspace/Makefile
@@ -0,0 +1,73 @@
+# Copyright (c) 2018, NVIDIA CORPORATION.  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.
+
+# Turn off suffix rules. They are deprecated.
+.SUFFIXES:
+
+# Full paths. Makes submakefiles easier. That said this make file _must_ be run
+# from <NVGPU>/userspace/.
+TWD=$(CURDIR)
+
+# Top level out dir.
+OUT=$(TWD)/build
+
+# Nvgpu driver code.
+NVGPU_SRC=$(TWD)/../drivers/gpu/nvgpu
+NVGPU_OUT=$(OUT)/libnvgpu
+
+INCLUDES=                       \
+        -I$(NVGPU_SRC)          \
+        -I$(NVGPU_SRC)/include  \
+        -I../include            \
+        -I../include/uapi
+
+CONFIGS=                        \
+        -D__NVGPU_POSIX__
+
+# Compiler, c-flags, etc.
+
+# CC    = clang
+CC      = gcc
+CFLAGS  = -Wall -ggdb  -Werror -fPIC $(INCLUDES) $(CONFIGS)
+LIBS    = -lpthread -pthread
+
+# Source files. We expect $(OBJS) and $(HEADERS) to get filled in here.
+include Makefile.sources
+
+# Linuxy configs. We want these so that we can mirror builds from the actual
+# Linux kernel.
+include Makefile.configs
+
+all: $(OUT)/libnvgpu-drv.so
+
+$(OUT)/libnvgpu-drv.so: $(OBJS)
+        $(CC) -shared -o $(OUT)/libnvgpu-drv.so $(OBJS) -lgcov
+
+# Default build target for all the object files we want to build in userspace.
+$(NVGPU_OUT)/%.o : $(NVGPU_SRC)/%.c $(HEADERS)
+        @if [ ! -d $(dir $@) ] ; then \
+                mkdir -p $(dir $@) ; \
+        fi
+        $(CC) $(CFLAGS) $(configs) -c -o $@ $<
+
+.PHONY: clean
+
+clean:
+        rm -rf $(OUT)
diff --git a/userspace/Makefile.configs b/userspace/Makefile.configs
new file mode 100644
index 00000000..d7e807af
--- /dev/null
+++ b/userspace/Makefile.configs
@@ -0,0 +1,15 @@
+#
+# Define various configs such as VIDMEM, etc. This is a bit annoying since
+# this really should be specific to Linux, but many header files need to
+# be aware of the CONFIG_* defines. As such we replicate some of the configs
+# that we potientially will want enabled in testing.
+#
+
+configs :=
+
+# Enabled configs.
+# None right now!
+
+# Uncomment these to enable the config.
+# configs += -DCONFIG_NVGPU_TRACK_MEM_USAGE=y
+# configs += -DCONFIG_GK20A_VIDMEM
diff --git a/userspace/Makefile.sources b/userspace/Makefile.sources
new file mode 100644
index 00000000..3598c971
--- /dev/null
+++ b/userspace/Makefile.sources
@@ -0,0 +1,34 @@
+# -*- mode: makefile -*-
+#
+# Copyright (c) 2018, NVIDIA CORPORATION.  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.
+
+include ../drivers/gpu/nvgpu/Makefile.sources
+
+OBJS := $(srcs:%.c=$(NVGPU_OUT)/%.o)
+
+
+HEADERS :=      \
+        $(NVGPU_SRC)/include/nvgpu/*.h          \
+        $(NVGPU_SRC)/include/nvgpu/hw/*/*.h     \
+        $(NVGPU_SRC)/gk20a/*.h                  \
+        $(NVGPU_SRC)/gm20b/*.h                  \
+        $(NVGPU_SRC)/gp10b/*.h                  \
+        $(NVGPU_SRC)/gv11b/*.h
diff --git a/userspace/README.txt b/userspace/README.txt
new file mode 100644
index 00000000..2599716a
--- /dev/null
+++ b/userspace/README.txt
@@ -0,0 +1,12 @@
+
+
+                              NVGPU in userspace!
+                              ~~~~~~~~~~~~~~~~~~~
+
+1. Why do this?
+
+    Unit testing. Safety. Code coverage. Etc.
+
+2. Design and implementation
+
+    Hrmm.
diff --git a/userspace/src/Makefile.tmk b/userspace/src/Makefile.tmk
new file mode 100644
index 00000000..f2da773d
--- /dev/null
+++ b/userspace/src/Makefile.tmk
@@ -0,0 +1,46 @@
+################################### tell Emacs this is a -*- makefile-gmake -*-
+#
+# Copyright (c) 2014-2016 NVIDIA CORPORATION.  All Rights Reserved.
+#
+# NVIDIA CORPORATION and its licensors retain all intellectual property
+# and proprietary rights in and to this software, related documentation
+# and any modifications thereto.  Any use, reproduction, disclosure or
+# distribution of this software and related documentation without an express
+# license agreement from NVIDIA CORPORATION is strictly prohibited.
+#
+# tmake for SW Mobile component makefile
+#
+# Component makefile for compiling host submit tests as a part of an umbrella.
+#
+###############################################################################
+
+ifdef NV_COMPONENT_FLAG_NVTEST_EXECUTABLE_SECTION
+include $(NV_BUILD_START_COMPONENT)
+
+NV_COMPONENT_NAME               := nvgpu_unit
+
+NV_COMPONENT_SOURCES            := unit_main.c  \
+                                   nvgpu.c      \
+                                   args.c       \
+                                   io.c         \
+                                   module.c     \
+                                   results.c    \
+                                   exec.c
+
+# The actual userspace nvgpu library.
+NV_COMPONENT_NEEDED_INTERFACE_DIRS := ../../drivers/gpu/nvgpu
+
+NV_COMPONENT_INCLUDES           := ../include                   \
+                                   ../../drivers/gpu/nvgpu      \
+                                   ../../drivers/gpu/nvgpu/include
+
+
+
+include $(NV_BUILD_NVTEST_EXECUTABLE)
+endif
+
+# Local Variables:
+# indent-tabs-mode: t
+# tab-width: 8
+# End:
+# vi: set tabstop=8 noexpandtab: