README.txt revision 12027
112027Sjungma@eit.uni-kl.deTLM-1.0 header files 212027Sjungma@eit.uni-kl.de==================== 312027Sjungma@eit.uni-kl.de 412027Sjungma@eit.uni-kl.deDir: include/tlm_core/tlm_1/ 512027Sjungma@eit.uni-kl.de 612027Sjungma@eit.uni-kl.deSubDirs: tlm_analysis/ 712027Sjungma@eit.uni-kl.de tlm_req_rsp/ 812027Sjungma@eit.uni-kl.de 912027Sjungma@eit.uni-kl.deFiles: README.txt 1012027Sjungma@eit.uni-kl.de 1112027Sjungma@eit.uni-kl.de 1212027Sjungma@eit.uni-kl.deComments 1312027Sjungma@eit.uni-kl.de======== 1412027Sjungma@eit.uni-kl.de 1512027Sjungma@eit.uni-kl.deUser code should only #include the tlm or tlm.h header file in the include/ 1612027Sjungma@eit.uni-kl.dedirectory and avoid including any of the include files in this directory 1712027Sjungma@eit.uni-kl.dedirectly. All objects defined in this file hierarchy are in the tlm namespace. 1812027Sjungma@eit.uni-kl.de 1912027Sjungma@eit.uni-kl.deThe header files are organizated, by subdirectory, as follows: 2012027Sjungma@eit.uni-kl.de 2112027Sjungma@eit.uni-kl.de 2212027Sjungma@eit.uni-kl.detlm_analysis/ 2312027Sjungma@eit.uni-kl.de-------------- 2412027Sjungma@eit.uni-kl.de 2512027Sjungma@eit.uni-kl.deThis contains the analysis interfaces, ports, and fifos. These files were not 2612027Sjungma@eit.uni-kl.depart of the original TLM-1.0 release, but have been grouped with TLM-1.0 in this 2712027Sjungma@eit.uni-kl.derelease of TLM-2.0 2812027Sjungma@eit.uni-kl.de 2912027Sjungma@eit.uni-kl.deFiles: 3012027Sjungma@eit.uni-kl.de tlm_analysis.h (includes the other header files in this directory ) 3112027Sjungma@eit.uni-kl.de tlm_analysis_fifo.h (defines tlm_analysis_fifo ) 3212027Sjungma@eit.uni-kl.de tlm_analysis_if.h (defines tlm_analysis_if and tlm_delayed_analysis_if ) 3312027Sjungma@eit.uni-kl.de tlm_analysis_port.h (defines tlm_analysis_port ) 3412027Sjungma@eit.uni-kl.de tlm_analysis_triple.h (defines tlm_analysis_triple ) 3512027Sjungma@eit.uni-kl.de tlm_write_if.h (defines tlm_write_if and tlm_delayed_write_if ) 3612027Sjungma@eit.uni-kl.de 3712027Sjungma@eit.uni-kl.de 3812027Sjungma@eit.uni-kl.detlm_req_rsp/ 3912027Sjungma@eit.uni-kl.de------------ 4012027Sjungma@eit.uni-kl.de 4112027Sjungma@eit.uni-kl.deThis provides support for TLM modeling based on a request/response pair that 4212027Sjungma@eit.uni-kl.deare passed by value. This is the original TLM 1.0 standard, with the addition 4312027Sjungma@eit.uni-kl.deof an overloading of the blocking transport method with pass-by-reference arguments. 4412027Sjungma@eit.uni-kl.de 4512027Sjungma@eit.uni-kl.deFiles: 4612027Sjungma@eit.uni-kl.de tlm_req_rsp.h (includes the key header files from the other directories) 4712027Sjungma@eit.uni-kl.de 4812027Sjungma@eit.uni-kl.de tlm_1_interfaces/ 4912027Sjungma@eit.uni-kl.de tlm_core_ifs.h (defines the TLM 1.0 core interfaces: 5012027Sjungma@eit.uni-kl.de tlm_transport_if 5112027Sjungma@eit.uni-kl.de tlm_blocking_get_if 5212027Sjungma@eit.uni-kl.de tlm_blocking_put_if 5312027Sjungma@eit.uni-kl.de tlm_nonblocking_get_if 5412027Sjungma@eit.uni-kl.de tlm_nonblocking_put_if 5512027Sjungma@eit.uni-kl.de tlm_get_if 5612027Sjungma@eit.uni-kl.de tlm_put_if 5712027Sjungma@eit.uni-kl.de tlm_blocking_peek_if 5812027Sjungma@eit.uni-kl.de tlm_nonblocking_peek_if 5912027Sjungma@eit.uni-kl.de tlm_peek_if 6012027Sjungma@eit.uni-kl.de tlm_blocking_get_peek_if 6112027Sjungma@eit.uni-kl.de tlm_nonblocking_get_peek_if 6212027Sjungma@eit.uni-kl.de tlm_get_peek_if ) 6312027Sjungma@eit.uni-kl.de tlm_fifo_ifs.h ( defines the TLM1.0 fifo interfaces: 6412027Sjungma@eit.uni-kl.de tlm_fifo_debug_if 6512027Sjungma@eit.uni-kl.de tlm_fifo_put_if 6612027Sjungma@eit.uni-kl.de tlm_fifo_get_if 6712027Sjungma@eit.uni-kl.de tlm_fifo_config_size_if ) 6812027Sjungma@eit.uni-kl.de tlm_master_slave_ifs.h ( defines the TLM1.0 master slave interfaces: 6912027Sjungma@eit.uni-kl.de tlm_blocking_master_if 7012027Sjungma@eit.uni-kl.de tlm_blocking_slave_if 7112027Sjungma@eit.uni-kl.de tlm_nonblocking_master_if 7212027Sjungma@eit.uni-kl.de tlm_nonblocking_slave_if 7312027Sjungma@eit.uni-kl.de tlm_master_if 7412027Sjungma@eit.uni-kl.de tlm_slave_if ) 7512027Sjungma@eit.uni-kl.de tlm_tag.h ( defines tlm_tag ) 7612027Sjungma@eit.uni-kl.de 7712027Sjungma@eit.uni-kl.de tlm_ports/ 7812027Sjungma@eit.uni-kl.de tlm_nonblocking_port.h (defines tlm_nonblocking_put_port, 7912027Sjungma@eit.uni-kl.de tlm_nonblocking_get_port and 8012027Sjungma@eit.uni-kl.de tlm_nonblocking_peek_port ) 8112027Sjungma@eit.uni-kl.de tlm_event_finder.h (defines tlm_event_finder_t ) 8212027Sjungma@eit.uni-kl.de 8312027Sjungma@eit.uni-kl.de tlm_channels/ 8412027Sjungma@eit.uni-kl.de tlm_fifo/ 8512027Sjungma@eit.uni-kl.de tlm_fifo.h (defines tlm_fifo, includes the other files ) 8612027Sjungma@eit.uni-kl.de tlm_fifo_peek.h (defines peek and poke interfaces for tlm_fifo ) 8712027Sjungma@eit.uni-kl.de tlm_fifo_put_get.h (defines put and get interfaces for tlm_fifo ) 8812027Sjungma@eit.uni-kl.de tlm_fifo_resize.h (defines expand, reduce, bound and unbound 8912027Sjungma@eit.uni-kl.de interfaces for tlm_fifo ) 9012027Sjungma@eit.uni-kl.de circular_buffer.h (defines circular buffer used by tlm_fifo ) 9112027Sjungma@eit.uni-kl.de tlm_req_rsp_channels/ 9212027Sjungma@eit.uni-kl.de tlm_req_rsp_channels.h (defines tlm_req_rsp_channel and 9312027Sjungma@eit.uni-kl.de tlm_transport_channel ) 9412027Sjungma@eit.uni-kl.de tlm_put_get_imp.h (contains implementatins used by the channels) 9512027Sjungma@eit.uni-kl.de 9612027Sjungma@eit.uni-kl.de tlm_adapters/ 9712027Sjungma@eit.uni-kl.de tlm_adapters.h (defines transport_to_master and tlm_slave_to_transport) 98