README.txt
1TLM-1.0 header files
2====================
3
4Dir: include/tlm_core/tlm_1/
5
6SubDirs: tlm_analysis/
7 tlm_req_rsp/
8
9Files: README.txt
10
11
12Comments
13========
14
15User code should only #include the tlm or tlm.h header file in the include/
16directory and avoid including any of the include files in this directory
17directly. All objects defined in this file hierarchy are in the tlm namespace.
18
19The header files are organizated, by subdirectory, as follows:
20
21
22tlm_analysis/
23--------------
24
25This contains the analysis interfaces, ports, and fifos. These files were not
26part of the original TLM-1.0 release, but have been grouped with TLM-1.0 in this
27release of TLM-2.0
28
29Files:
30 tlm_analysis.h (includes the other header files in this directory )
31 tlm_analysis_fifo.h (defines tlm_analysis_fifo )
32 tlm_analysis_if.h (defines tlm_analysis_if and tlm_delayed_analysis_if )
33 tlm_analysis_port.h (defines tlm_analysis_port )
34 tlm_analysis_triple.h (defines tlm_analysis_triple )
35 tlm_write_if.h (defines tlm_write_if and tlm_delayed_write_if )
36
37
38tlm_req_rsp/
39------------
40
41This provides support for TLM modeling based on a request/response pair that
42are passed by value. This is the original TLM 1.0 standard, with the addition
43of an overloading of the blocking transport method with pass-by-reference arguments.
44
45Files:
46 tlm_req_rsp.h (includes the key header files from the other directories)
47
48 tlm_1_interfaces/
49 tlm_core_ifs.h (defines the TLM 1.0 core interfaces:
50 tlm_transport_if
51 tlm_blocking_get_if
52 tlm_blocking_put_if
53 tlm_nonblocking_get_if
54 tlm_nonblocking_put_if
55 tlm_get_if
56 tlm_put_if
57 tlm_blocking_peek_if
58 tlm_nonblocking_peek_if
59 tlm_peek_if
60 tlm_blocking_get_peek_if
61 tlm_nonblocking_get_peek_if
62 tlm_get_peek_if )
63 tlm_fifo_ifs.h ( defines the TLM1.0 fifo interfaces:
64 tlm_fifo_debug_if
65 tlm_fifo_put_if
66 tlm_fifo_get_if
67 tlm_fifo_config_size_if )
68 tlm_master_slave_ifs.h ( defines the TLM1.0 master slave interfaces:
69 tlm_blocking_master_if
70 tlm_blocking_slave_if
71 tlm_nonblocking_master_if
72 tlm_nonblocking_slave_if
73 tlm_master_if
74 tlm_slave_if )
75 tlm_tag.h ( defines tlm_tag )
76
77 tlm_ports/
78 tlm_nonblocking_port.h (defines tlm_nonblocking_put_port,
79 tlm_nonblocking_get_port and
80 tlm_nonblocking_peek_port )
81 tlm_event_finder.h (defines tlm_event_finder_t )
82
83 tlm_channels/
84 tlm_fifo/
85 tlm_fifo.h (defines tlm_fifo, includes the other files )
86 tlm_fifo_peek.h (defines peek and poke interfaces for tlm_fifo )
87 tlm_fifo_put_get.h (defines put and get interfaces for tlm_fifo )
88 tlm_fifo_resize.h (defines expand, reduce, bound and unbound
89 interfaces for tlm_fifo )
90 circular_buffer.h (defines circular buffer used by tlm_fifo )
91 tlm_req_rsp_channels/
92 tlm_req_rsp_channels.h (defines tlm_req_rsp_channel and
93 tlm_transport_channel )
94 tlm_put_get_imp.h (contains implementatins used by the channels)
95
96 tlm_adapters/
97 tlm_adapters.h (defines transport_to_master and tlm_slave_to_transport)
98