Commit Graph

6 Commits

Author SHA1 Message Date
Nicolas Benech
deff8257a1 gpu: nvgpu: doxygen: apply FUSA-related flags
The doxygen config file did not have any defined flags for FUSA.
This patch adds the current known FUSA-related flags.

JIRA NVGPU-1325

Change-Id: I7c4c7cb0f3dd0270b3a020960ced041d0e4dba74
Signed-off-by: Nicolas Benech <nbenech@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/2221172
Tested-by: Rajesh Devaraj <rdevaraj@nvidia.com>
Reviewed-by: Rajesh Devaraj <rdevaraj@nvidia.com>
Reviewed-by: Seema Khowala <seemaj@nvidia.com>
GVS: Gerrit_Virtual_Submit
Reviewed-by: Alex Waterman <alexw@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
2020-12-15 14:10:29 -06:00
Adeel Raza
62c5941a71 gpu: nvgpu: whitelisting doxygen cleanup
Do some doxygen cleanup for the whitelisting macros:
   - Previously doxygen documentation was being generated for the no-op
     whitelisting macros. Enable the NV_IS_COVERITY define in the
     doxygen build. This generates doxygen documentation for the actual
     whitelisting macros.
   - Create a doxygen group for the whitelisting macros. This adds
     additional documentation for the whitelisting macros.
   - Add doxygen line breaks

JIRA NVGPU-3820

Change-Id: Id452147a3a909da7981303d0908f2aff4a2ff86b
Signed-off-by: Adeel Raza <araza@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/2194711
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
2020-12-15 14:05:52 -06:00
Seema Khowala
fac1bc5172 gpu: nvgpu: GENERATE_XML set to YES in doxygen config file
Add Doxygen config needed for breathe

cd $TOP/kernel/nvgpu/drivers/gpu/nvgpu
$ make -f Makefile.doxygen
xml output is generated in ./xml

JIRA NVGPU-3959

Change-Id: Ife00d1768db862b0929c9b681d3f39de61b16bc3
Signed-off-by: Seema Khowala <seemaj@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/2191175
Reviewed-by: Nicolas Benech <nbenech@nvidia.com>
Reviewed-by: Alex Waterman <alexw@nvidia.com>
GVS: Gerrit_Virtual_Submit
Reviewed-by: Vijayakumar Subbu <vsubbu@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
2020-12-15 14:05:52 -06:00
Nicolas Benech
053ddbb365 gpu: nvgpu: add root SWUTS document
This patch adds the main SWUTS document (Software Unit Test
Specification) from which all individual unit SWUTS will be
referenced.

JIRA NVGPU-3943

Change-Id: Ieee23509563cb543d4e8f41be3278679d0b9c4e2
Signed-off-by: Nicolas Benech <nbenech@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/2178798
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
2019-08-26 16:07:15 -07:00
Nicolas Benech
bf939e3ea6 gpu: nvgpu: docs: increase doxygen coverage
This patch updates the doxygen configuration file to provide source
access to all NVGPU source files and various smaller tweaks to improve
readability.

JIRA NVGPU-3801

Change-Id: Ib0493a165f0f35e56941a1c950575b66f8c4dc30
Signed-off-by: Nicolas Benech <nbenech@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/2152443
GVS: Gerrit_Virtual_Submit
Reviewed-by: Alex Waterman <alexw@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
2019-07-17 16:30:38 -07:00
Alex Waterman
2ba44f30c7 gpu: nvgpu: Add doxygen safety profile build
Add a doxygen build to nvgpu. Use the following command from the
drivers/gpu/nvgpu directory:

  $ make -f Makefile.doxygen

This will autogenerate a list of files from the safety profile
architecture and then generate doxygen documentation from said
list of files.

Also add a .gitignore entry for the sources file that gets
generated during the build.

JIRA NVGPU-3544

Change-Id: I2415de631efcc8447c81ace1700ebac8b69a89df
Signed-off-by: Alex Waterman <alexw@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/2131051
Reviewed-by: Seema Khowala <seemaj@nvidia.com>
GVS: Gerrit_Virtual_Submit
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
2019-06-21 11:15:52 -07:00