annotate llvm/docs/AMDGPU/gfx10_msg.rst @ 150:1d019706d866

LLVM10
author anatofuz
date Thu, 13 Feb 2020 15:10:13 +0900
parents
children c4bab56944e8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 ..
anatofuz
parents:
diff changeset
2 **************************************************
anatofuz
parents:
diff changeset
3 * *
anatofuz
parents:
diff changeset
4 * Automatically generated file, do not edit! *
anatofuz
parents:
diff changeset
5 * *
anatofuz
parents:
diff changeset
6 **************************************************
anatofuz
parents:
diff changeset
7
anatofuz
parents:
diff changeset
8 .. _amdgpu_synid10_msg:
anatofuz
parents:
diff changeset
9
anatofuz
parents:
diff changeset
10 msg
anatofuz
parents:
diff changeset
11 ===========================
anatofuz
parents:
diff changeset
12
anatofuz
parents:
diff changeset
13 A 16-bit message code. The bits of this operand have the following meaning:
anatofuz
parents:
diff changeset
14
anatofuz
parents:
diff changeset
15 ============ =============================== ===============
anatofuz
parents:
diff changeset
16 Bits Description Value Range
anatofuz
parents:
diff changeset
17 ============ =============================== ===============
anatofuz
parents:
diff changeset
18 3:0 Message *type*. 0..15
anatofuz
parents:
diff changeset
19 6:4 Optional *operation*. 0..7
anatofuz
parents:
diff changeset
20 7:7 Unused. \-
anatofuz
parents:
diff changeset
21 9:8 Optional *stream*. 0..3
anatofuz
parents:
diff changeset
22 15:10 Unused. \-
anatofuz
parents:
diff changeset
23 ============ =============================== ===============
anatofuz
parents:
diff changeset
24
anatofuz
parents:
diff changeset
25 This operand may be specified as one of the following:
anatofuz
parents:
diff changeset
26
anatofuz
parents:
diff changeset
27 * An :ref:`integer_number<amdgpu_synid_integer_number>` or an :ref:`absolute_expression<amdgpu_synid_absolute_expression>`. The value must be in the range 0..0xFFFF.
anatofuz
parents:
diff changeset
28 * A *sendmsg* value described below.
anatofuz
parents:
diff changeset
29
anatofuz
parents:
diff changeset
30 ==================================== ====================================================
anatofuz
parents:
diff changeset
31 Sendmsg Value Syntax Description
anatofuz
parents:
diff changeset
32 ==================================== ====================================================
anatofuz
parents:
diff changeset
33 sendmsg(<*type*>) A message identified by its *type*.
anatofuz
parents:
diff changeset
34 sendmsg(<*type*>,<*op*>) A message identified by its *type* and *operation*.
anatofuz
parents:
diff changeset
35 sendmsg(<*type*>,<*op*>,<*stream*>) A message identified by its *type* and *operation*
anatofuz
parents:
diff changeset
36 with a stream *id*.
anatofuz
parents:
diff changeset
37 ==================================== ====================================================
anatofuz
parents:
diff changeset
38
anatofuz
parents:
diff changeset
39 *Type* may be specified using message *name* or message *id*.
anatofuz
parents:
diff changeset
40
anatofuz
parents:
diff changeset
41 *Op* may be specified using operation *name* or operation *id*.
anatofuz
parents:
diff changeset
42
anatofuz
parents:
diff changeset
43 Stream *id* is an integer in the range 0..3.
anatofuz
parents:
diff changeset
44
anatofuz
parents:
diff changeset
45 Numeric values may be specified as positive :ref:`integer numbers<amdgpu_synid_integer_number>`
anatofuz
parents:
diff changeset
46 or :ref:`absolute expressions<amdgpu_synid_absolute_expression>`.
anatofuz
parents:
diff changeset
47
anatofuz
parents:
diff changeset
48 Each message type supports specific operations:
anatofuz
parents:
diff changeset
49
anatofuz
parents:
diff changeset
50 ================= ========== ============================== ============ ==========
anatofuz
parents:
diff changeset
51 Message name Message Id Supported Operations Operation Id Stream Id
anatofuz
parents:
diff changeset
52 ================= ========== ============================== ============ ==========
anatofuz
parents:
diff changeset
53 MSG_INTERRUPT 1 \- \- \-
anatofuz
parents:
diff changeset
54 MSG_GS 2 GS_OP_CUT 1 Optional
anatofuz
parents:
diff changeset
55 \ GS_OP_EMIT 2 Optional
anatofuz
parents:
diff changeset
56 \ GS_OP_EMIT_CUT 3 Optional
anatofuz
parents:
diff changeset
57 MSG_GS_DONE 3 GS_OP_NOP 0 \-
anatofuz
parents:
diff changeset
58 \ GS_OP_CUT 1 Optional
anatofuz
parents:
diff changeset
59 \ GS_OP_EMIT 2 Optional
anatofuz
parents:
diff changeset
60 \ GS_OP_EMIT_CUT 3 Optional
anatofuz
parents:
diff changeset
61 MSG_GS_ALLOC_REQ 9 \- \- \-
anatofuz
parents:
diff changeset
62 MSG_GET_DOORBELL 10 \- \- \-
anatofuz
parents:
diff changeset
63 MSG_SYSMSG 15 SYSMSG_OP_ECC_ERR_INTERRUPT 1 \-
anatofuz
parents:
diff changeset
64 \ SYSMSG_OP_REG_RD 2 \-
anatofuz
parents:
diff changeset
65 \ SYSMSG_OP_HOST_TRAP_ACK 3 \-
anatofuz
parents:
diff changeset
66 \ SYSMSG_OP_TTRACE_PC 4 \-
anatofuz
parents:
diff changeset
67 ================= ========== ============================== ============ ==========
anatofuz
parents:
diff changeset
68
anatofuz
parents:
diff changeset
69 *Sendmsg* arguments are validated depending on how *type* value is specified:
anatofuz
parents:
diff changeset
70
anatofuz
parents:
diff changeset
71 * If message *type* is specified by name, arguments values must satisfy limitations detailed in the table above.
anatofuz
parents:
diff changeset
72 * If message *type* is specified as a number, each argument must not exceed corresponding value range (see the first table).
anatofuz
parents:
diff changeset
73
anatofuz
parents:
diff changeset
74 Examples:
anatofuz
parents:
diff changeset
75
anatofuz
parents:
diff changeset
76 .. parsed-literal::
anatofuz
parents:
diff changeset
77
anatofuz
parents:
diff changeset
78 // numeric message code
anatofuz
parents:
diff changeset
79 msg = 0x10
anatofuz
parents:
diff changeset
80 s_sendmsg 0x12
anatofuz
parents:
diff changeset
81 s_sendmsg msg + 2
anatofuz
parents:
diff changeset
82
anatofuz
parents:
diff changeset
83 // sendmsg with strict arguments validation
anatofuz
parents:
diff changeset
84 s_sendmsg sendmsg(MSG_INTERRUPT)
anatofuz
parents:
diff changeset
85 s_sendmsg sendmsg(MSG_GS, GS_OP_EMIT)
anatofuz
parents:
diff changeset
86 s_sendmsg sendmsg(MSG_GS, 2)
anatofuz
parents:
diff changeset
87 s_sendmsg sendmsg(MSG_GS_DONE, GS_OP_EMIT_CUT, 1)
anatofuz
parents:
diff changeset
88 s_sendmsg sendmsg(MSG_SYSMSG, SYSMSG_OP_TTRACE_PC)
anatofuz
parents:
diff changeset
89 s_sendmsg sendmsg(MSG_GET_DOORBELL)
anatofuz
parents:
diff changeset
90
anatofuz
parents:
diff changeset
91 // sendmsg with validation of value range only
anatofuz
parents:
diff changeset
92 msg = 2
anatofuz
parents:
diff changeset
93 op = 3
anatofuz
parents:
diff changeset
94 stream = 1
anatofuz
parents:
diff changeset
95 s_sendmsg sendmsg(msg, op, stream)
anatofuz
parents:
diff changeset
96 s_sendmsg sendmsg(2, GS_OP_CUT)
anatofuz
parents:
diff changeset
97