diff --git a/drivers/gpu/nvgpu/doxygen/Doxyfile.safety b/drivers/gpu/nvgpu/doxygen/Doxyfile.safety index 3c344397a..187f282ec 100644 --- a/drivers/gpu/nvgpu/doxygen/Doxyfile.safety +++ b/drivers/gpu/nvgpu/doxygen/Doxyfile.safety @@ -773,6 +773,7 @@ WARN_LOGFILE = @INCLUDE_PATH = doxygen @INCLUDE = Doxyfile.sources.safety +@INCLUDE = ../../../userspace/SWUTS.sources # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/drivers/gpu/nvgpu/include/nvgpu/gk20a.h b/drivers/gpu/nvgpu/include/nvgpu/gk20a.h index 627a26fd5..f76b49c14 100644 --- a/drivers/gpu/nvgpu/include/nvgpu/gk20a.h +++ b/drivers/gpu/nvgpu/include/nvgpu/gk20a.h @@ -41,6 +41,12 @@ * - @ref unit-falcon * - Etc, etc. * + * NVGPU Software Unit Design Documentation + * ======================================== + * + * For each top level unit, a corresponding Unit Test Specification is + * available in the @ref NVGPU-SWUTS + * * nvgpu-driver Level Requirements Table * ===================================== * diff --git a/userspace/SWUTS.h b/userspace/SWUTS.h new file mode 100644 index 000000000..85c86970d --- /dev/null +++ b/userspace/SWUTS.h @@ -0,0 +1,36 @@ +/* + * Copyright (c) 2019, 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. + */ + +/** + * @file + * @page NVGPU-SWUTS + * + * NVGPU Software Unit Test Specifications + * ======================================= + * + * The following pages cover the various unit test specifications needed + * to test the NVGPU driver. + * + * - @ref SWUTS-mm-vm + * + */ + diff --git a/userspace/SWUTS.sources b/userspace/SWUTS.sources new file mode 100644 index 000000000..2b66abf1b --- /dev/null +++ b/userspace/SWUTS.sources @@ -0,0 +1,3 @@ +INPUT += ../../../userspace/SWUTS.h +INPUT += ../../../userspace/units/mm/vm/vm.h +