Skip to content

Commit 3ca40f0

Browse files
mxu9jyao1
authored andcommitted
Refactor the ide_test_ini.md
With more test categories (PCIE-IDE & CXL-IDE & CXL-TSP) added, the ide_test_ini.md is needed to be refactored to make it clearer and easier to understand. Signed-off-by: Min Xu <[email protected]>
1 parent 48c7b74 commit 3ca40f0

File tree

1 file changed

+49
-4
lines changed

1 file changed

+49
-4
lines changed

doc/ide_test_ini.md

Lines changed: 49 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,21 @@ EntryName=EntryValue
4949
|------|------|------|------|------|
5050
|port_y|dev/func string||M|For example 00.0. **y** in [1, 16]|
5151

52+
**TEE-IO Device Validation Utility** supports multiple test categories.
53+
- [PCIE-IDE Test](../doc/ide_test/)
54+
- [CXL-IDE Test](../doc/cxl_ide_test/)
55+
56+
Settings of **Topology** / **Configuration** / **TestSuite** are different.
57+
58+
- [PCIE-IDE Section settings](#pcie-ide-section-settings)
59+
- [CXL-IDE Section settings](#cxl-ide-section-settings)
60+
61+
### PCIE-IDE Section settings
5262
[Topology_x]
5363
|Entry|Value|Default|Mandatory|Comment|
5464
|------|------|------|------|------|
5565
|type|string||M|available values are: **selective_ide, link_ide, selective_and_link_ide**|
56-
|connection|string||M|available values are: **direct, switch, peer2peer**|
66+
|connection|string||M|available values are: **direct, switch**|
5767
|bus|hex||M|The bus which rootport is connected to. For example 0x1a|
5868
|path1|string||M|rootport_x to endpoint_y. Each ports are separated by ‘,’. For example: rootport_1,switch_1:port_1-port_2,endpoint_2|
5969
|path2|string||O|rootport_x to endpoint_y. Each ports are separated by ‘,’. For example: rootport_1,switch_1:port_1-port_3,endpoint_3. <br/>**Note: path2 is only available in the connection of peer2peer**|
@@ -63,25 +73,60 @@ EntryName=EntryValue
6373
|Entry|Value|Default|Mandatory|Comment|
6474
|------|------|------|------|------|
6575
|type|string||M|available values are **selective_ide, link_ide, selective_and_link_ide**|
66-
|category|string|pcie-ide|O|Test category. Available values are: **pcie-ide**|
76+
|category|string|pcie-ide|O|must be **pcie-ide**|
6777
|default|0/1|1|O||
6878
|switch|0/1|0|O||
6979
|partial_header_encryption|0/1|0|O||
7080
|pcrc|0/1|0|O||
7181
|aggregation|0/1|0|O||
7282
|selective_ide_for_configuration|0/1|0|O||
7383
|tee_limited_stream|0/1|0|O||
74-
|cxl_get_key|0/1|0|O|Generate keys by IDEKM GET_KEY when setting up CXL.memcache IDE Stream.|
7584

7685
[TestSuite_x]
7786
|Entry|Value|Default|Mandatory|Comment|
7887
|------|------|------|------|------|
7988
|type|string||M|available values are: **selective_ide, link_ide, selective_and_link_ide**|
80-
|category|string|pcie-ide|O|Test category. Available values are: **pcie-ide**|
89+
|category|string|pcie-ide|O|must be **pcie-ide**|
8190
|topology|number||M|Topology_x|
8291
|configuration|number||M|Configuration_x|
8392
|query|string||O|numbers separated by comma.<br> For example **1,2** means Cases1 and Cases2 in [Query.md](../doc/ide_test/IdeKmTestCase/1.Query.md)|
8493
|KeyProg|string||O|numbers separated by comma.<br> For example **1,2** means Cases1 and Cases2 in [keyProg.md](../doc/ide_test/IdeKmTestCase/2.keyProg.md)|
8594
|KSetGo|string||O|numbers separated by comma.<br> For example **1,2** means Cases1 and Cases2 in [KSetGo.md](../doc/ide_test/IdeKmTestCase/3.KSetGo.md)|
8695
|KSetStop|string||O|numbers separated by comma.<br> For example **1,2** means Cases1 and Cases2 in [KSetStop.md](../doc/ide_test/IdeKmTestCase/4.KSetStop.md)|
8796
|SpdmSession|string||O|numbers separated by comma.<br> For example **1,2** means Cases1 and Cases2 in [SpdmSession.md](../doc/ide_test/IdeKmTestCase/5.SpdmSession.md)|
97+
98+
### CXL-IDE Section settings
99+
[Topology_x]
100+
|Entry|Value|Default|Mandatory|Comment|
101+
|------|------|------|------|------|
102+
|type|string||M|must be **link_ide**|
103+
|connection|string||M|available values are: **direct, switch**|
104+
|bus|hex||M|The bus which rootport is connected to. For example 0x1a|
105+
|path1|string||M|rootport_x to endpoint_y. Each ports are separated by ‘,’. For example: rootport_1,switch_1:port_1-port_2,endpoint_2|
106+
|path2|string||O|rootport_x to endpoint_y. Each ports are separated by ‘,’. For example: rootport_1,switch_1:port_1-port_3,endpoint_3. <br/>**Note: path2 is only available in the connection of peer2peer**|
107+
|stream_id|number|0|O|it shall always be **0**|
108+
109+
[Configration_x]
110+
|Entry|Value|Default|Mandatory|Comment|
111+
|------|------|------|------|------|
112+
|type|string||M|must be **link_ide**|
113+
|category|string||M|must be **cxl-ide**|
114+
|default|0/1|1|O||
115+
|pcrc|0/1|0|O||
116+
|ide_stop|0/1|0|O||
117+
|skid_mode|0/1|0|O||
118+
|containment_mode|0/1|0|O||
119+
|cxl_get_key|0/1|0|O|Generate keys by IDEKM GET_KEY when setting up CXL.memcache IDE Stream.|
120+
121+
[TestSuite_x]
122+
|Entry|Value|Default|Mandatory|Comment|
123+
|------|------|------|------|------|
124+
|type|string||M|must be **link_ide**|
125+
|category|string||M|must be **cxl-ide**|
126+
|topology|number||M|Topology_x|
127+
|configuration|number||M|Configuration_x|
128+
|query|string||O|numbers separated by comma.<br> For example **1,2** means Cases1 and Cases2 in [CxlQuery.md](../doc/cxl_ide_test/CxlIdeKmTestCase/1.CxlQuery.md)|
129+
|KeyProg|string||O|numbers separated by comma.<br> For example **1,2** means Cases1 and Cases2 in [CxlKeyProg.md](../doc/cxl_ide_test/CxlIdeKmTestCase/2.CxlKeyProg.md)|
130+
|KSetGo|string||O|numbers separated by comma.<br> For example **1** means Cases1 in [CxlKSetGo.md](../doc/cxl_ide_test/CxlIdeKmTestCase/3.CxlKSetGo.md)|
131+
|KSetStop|string||O|numbers separated by comma.<br> For example **1** means Cases1 in [CxlKSetStop.md](../doc/cxl_ide_test/CxlIdeKmTestCase/4.CxlKSetStop.md)|
132+
|GetKey|string||O|numbers separated by comma.<br> For example **1** means Cases1 in [CxlGetKey.md](../doc/cxl_ide_test/CxlIdeKmTestCase/5.CxlGetKey.md)|

0 commit comments

Comments
 (0)