README.txt revision 12855:588919e0e4aa 
1
2TLM-2.0 unit tests
3==================
4
5Dir: tests/tlm/
6SubDirs:
7         bus/
8         bus_dmi/
9         cancel_all/
10         common/
11         endian_conv/
12         multi_sockets/
13         nb2b_adapter/
14         p2p/
15         static_extensions/
16         update_original/
17
18Files: README.txt
19
20
21Comments
22========
23
24Running the tests:
25------------------
26
27See the main README and README_windows.txt files.
28
29
30The tests:
31----------
32
33All tests are build using a set of models that can be found in the subdirectory
34common/include/models. For a description of the models see the README.txt in 
35that subdirectory.
36
37The test themselves can be found in the following subdirectories:
38bus/ : 
39      test system using a TLM2 compliant AT bus model and a combination of
40      LT and AT targets and initiators, with and without temporal decoupling. 
41      
42bus_dmi/ : 
43      test system using a similar system as in the bus/ test but now with DMI
44      support added for the LT initiators and targets.
45      
46cancel_all/ :
47      Tests the cancel_all() methods of the two PEQs, peq_with_cb_and_phase and peq_with_get.
48      Along the way, it also tests the basic operation of each PEQ.
49    
50endian_conv/ :
51      unit test for the endianness conversion ftions, there is only a build for
52      linux provided, the C++ test performs a single conversion, there is a 
53      python script using the program to do a more extensive test     
54      
55multi_sockets/ :
56      test system using a TLM2 compliant AT busmodel using a single socket to
57      bind all targets and initiators to, in combination with LT and AT
58      initiators and targets. This test also uses instance specific extentions
59      in the generic payload
60      
61nb2b_adapter/ :
62      Primarily a regression test for a bug in the nb2b adapter of the simple_target_socket.
63      Tests the operation of the nb2b adapter, and also exercises the peq_with_cb_and_phase
64      and the instance_specific_extension.
65      
66p2p/ :
67  BaseSocketLT/ :
68  	simple point to point test for LT initiator and target
69  CoreDecoupling/
70  	simple test for using the LT initiator with temporal decoupling
71  EndEventLT/
72  	??
73  HierarchicalSocket/
74    	tests sockets on hierachical modules
75  RegisterSocketProcessLT/
76  	simple test for initiator and target using callback registry in sockets
77  SimpleAT/
78  	simple point to point test for AT initiator and target using GP
79	AT phases and TLM_ACCEPTED
80  SimpleAT_TA/
81  	simple point to point test for AT initiator and target using GP
82	AT phases and TLM_UPDATED
83
84static_extentions/ :
85	contains 3 unit tests to verify the GP extention mechanism
86
87update_original/ :
88      Tests the deep_copy_from() and update_original_from() methods of tlm_generic_payload. 
89      Along the way, it also tests the use of byte enables for read and write commands.
90