summaryrefslogtreecommitdiffstats
path: root/src/gallium/drivers/radeon/AMDGPUGenInstrEnums.pl
diff options
context:
space:
mode:
authorTom Stellard <[email protected]>2012-05-09 11:06:48 -0400
committerTom Stellard <[email protected]>2012-05-10 15:41:31 -0400
commitfa63f976522bd4faf19249e8c9ac4d3edda498d9 (patch)
treeaa4faf0c0741d902fb7844fff879a9d5f37696b9 /src/gallium/drivers/radeon/AMDGPUGenInstrEnums.pl
parent92faa21d29b49689ccfff852cfff257fccec514e (diff)
radeon/llvm: Add some comments
Diffstat (limited to 'src/gallium/drivers/radeon/AMDGPUGenInstrEnums.pl')
-rw-r--r--src/gallium/drivers/radeon/AMDGPUGenInstrEnums.pl25
1 files changed, 21 insertions, 4 deletions
diff --git a/src/gallium/drivers/radeon/AMDGPUGenInstrEnums.pl b/src/gallium/drivers/radeon/AMDGPUGenInstrEnums.pl
index c6d43873c08..130eaac72bc 100644
--- a/src/gallium/drivers/radeon/AMDGPUGenInstrEnums.pl
+++ b/src/gallium/drivers/radeon/AMDGPUGenInstrEnums.pl
@@ -1,15 +1,32 @@
-#===-- AMDGPUGenInstrEnums.pl - TODO: Add brief description -------===#
+#===-- AMDGPUGenInstrEnums.pl - Script for generating instruction enums ----===#
#
# The LLVM Compiler Infrastructure
#
# This file is distributed under the University of Illinois Open Source
# License. See LICENSE.TXT for details.
#
-#===----------------------------------------------------------------------===#
+#===-----------------------------------------------------------------------===#
#
-# TODO: Add full description
+# This perl script is used to generate the following files:
#
-#===----------------------------------------------------------------------===#
+# 1. perl AMDGPUGenInstrEnums.pl td > AMDGPUInstrEnums.td
+#
+# This file contains Tablegen constants used for matching hw instructions
+# from R600 and SI with functionally similar AMDIL instruction. It aslo
+# contains definitions of floating point constants like pi (in hex notation)
+# that are used in some of the shader patterns.
+#
+# 2. perl AMDGPUGenInstrEnums.pl h > AMDGPUInstrEnums.h
+#
+# This file contains cpp enums that match the constant values in
+# AMDGPUInstrEnums.td
+#
+# 3. perl AMDGPUGenInstrEnums.pl inc > AMDGPUInstrEnums.include
+#
+# This file contains a function called GetRealAMDILOpcode which maps the
+# constant values defined in AMDGPUInstrEnums.h to the corresponding AMDIL
+# instructions.
+#===-----------------------------------------------------------------------===#
use warnings;
use strict;