README.txt revision 13516:315f10e2567b
112841Sgabeblack@google.comTLM-1.0 header files 212841Sgabeblack@google.com==================== 312841Sgabeblack@google.com 412841Sgabeblack@google.comDir: include/tlm_core/1/ 512841Sgabeblack@google.com 612841Sgabeblack@google.comSubDirs: analysis/ 712841Sgabeblack@google.com req_rsp/ 812841Sgabeblack@google.com 912841Sgabeblack@google.comFiles: README.txt 1012841Sgabeblack@google.com 1112841Sgabeblack@google.com 1212841Sgabeblack@google.comComments 1312841Sgabeblack@google.com======== 1412841Sgabeblack@google.com 1512841Sgabeblack@google.comUser code should only #include the tlm or tlm.h header file in the include/ 1612841Sgabeblack@google.comdirectory and avoid including any of the include files in this directory 1712841Sgabeblack@google.comdirectly. All objects defined in this file hierarchy are in the tlm namespace. 1812841Sgabeblack@google.com 1912841Sgabeblack@google.comThe header files are organizated, by subdirectory, as follows: 2012841Sgabeblack@google.com 2112841Sgabeblack@google.com 2212841Sgabeblack@google.comtlm_analysis/ 2312841Sgabeblack@google.com-------------- 2412841Sgabeblack@google.com 2512841Sgabeblack@google.comThis contains the analysis interfaces, ports, and fifos. These files were not 2612841Sgabeblack@google.compart of the original TLM-1.0 release, but have been grouped with TLM-1.0 in this 2712841Sgabeblack@google.comrelease of TLM-2.0 2812841Sgabeblack@google.com 2912841Sgabeblack@google.comFiles: 3012841Sgabeblack@google.com analysis.h (includes the other header files in this directory ) 3112841Sgabeblack@google.com analysis_fifo.h (defines tlm_analysis_fifo ) 3212841Sgabeblack@google.com analysis_if.h (defines tlm_analysis_if and tlm_delayed_analysis_if ) 3312841Sgabeblack@google.com analysis_port.h (defines tlm_analysis_port ) 3412841Sgabeblack@google.com analysis_triple.h (defines tlm_analysis_triple ) 3512841Sgabeblack@google.com write_if.h (defines tlm_write_if and tlm_delayed_write_if ) 3612841Sgabeblack@google.com 3712841Sgabeblack@google.com 3812841Sgabeblack@google.comreq_rsp/ 3912841Sgabeblack@google.com------------ 4012841Sgabeblack@google.com 4112841Sgabeblack@google.comThis provides support for TLM modeling based on a request/response pair that 4212841Sgabeblack@google.comare passed by value. This is the original TLM 1.0 standard, with the addition 4312841Sgabeblack@google.comof an overloading of the blocking transport method with pass-by-reference arguments. 4412841Sgabeblack@google.com 4512841Sgabeblack@google.comFiles: 4612841Sgabeblack@google.com req_rsp.h (includes the key header files from the other directories) 4712841Sgabeblack@google.com 4812841Sgabeblack@google.com interfaces/ 4912841Sgabeblack@google.com core_ifs.h (defines the TLM 1.0 core interfaces: 5012841Sgabeblack@google.com tlm_transport_if 5112841Sgabeblack@google.com tlm_blocking_get_if 5212841Sgabeblack@google.com tlm_blocking_put_if 5312841Sgabeblack@google.com tlm_nonblocking_get_if 5412841Sgabeblack@google.com tlm_nonblocking_put_if 5512841Sgabeblack@google.com tlm_get_if 5612841Sgabeblack@google.com tlm_put_if 5712841Sgabeblack@google.com tlm_blocking_peek_if 5812841Sgabeblack@google.com tlm_nonblocking_peek_if 5912841Sgabeblack@google.com tlm_peek_if 6012841Sgabeblack@google.com tlm_blocking_get_peek_if 6112841Sgabeblack@google.com tlm_nonblocking_get_peek_if 6212841Sgabeblack@google.com tlm_get_peek_if ) 6312841Sgabeblack@google.com fifo_ifs.h ( defines the TLM1.0 fifo interfaces: 6412841Sgabeblack@google.com tlm_fifo_debug_if 6512841Sgabeblack@google.com tlm_fifo_put_if 6612841Sgabeblack@google.com tlm_fifo_get_if 6712841Sgabeblack@google.com tlm_fifo_config_size_if ) 6812841Sgabeblack@google.com master_slave_ifs.h ( defines the TLM1.0 master slave interfaces: 6912841Sgabeblack@google.com tlm_blocking_master_if 7012841Sgabeblack@google.com tlm_blocking_slave_if 7112841Sgabeblack@google.com tlm_nonblocking_master_if 7212841Sgabeblack@google.com tlm_nonblocking_slave_if 7312841Sgabeblack@google.com tlm_master_if 7412841Sgabeblack@google.com tlm_slave_if ) 7512841Sgabeblack@google.com tag.h ( defines tlm_tag ) 7612841Sgabeblack@google.com 7712841Sgabeblack@google.com ports/ 7812841Sgabeblack@google.com nonblocking_port.h (defines tlm_nonblocking_put_port, 7912841Sgabeblack@google.com tlm_nonblocking_get_port and 8012841Sgabeblack@google.com tlm_nonblocking_peek_port ) 8112841Sgabeblack@google.com event_finder.h (defines tlm_event_finder_t ) 8212841Sgabeblack@google.com 8312841Sgabeblack@google.com channels/ 8412841Sgabeblack@google.com fifo/ 8512841Sgabeblack@google.com fifo.h (defines tlm_fifo, includes the other files ) 8612841Sgabeblack@google.com fifo_peek.h (defines peek and poke interfaces for tlm_fifo ) 8712841Sgabeblack@google.com fifo_put_get.h (defines put and get interfaces for tlm_fifo ) 8812841Sgabeblack@google.com fifo_resize.h (defines expand, reduce, bound and unbound 8912841Sgabeblack@google.com interfaces for tlm_fifo ) 9012841Sgabeblack@google.com circular_buffer.h (defines circular buffer used by tlm_fifo ) 9112841Sgabeblack@google.com req_rsp_channels/ 9212841Sgabeblack@google.com req_rsp_channels.h (defines tlm_req_rsp_channel and 9312841Sgabeblack@google.com tlm_transport_channel ) 9412841Sgabeblack@google.com put_get_imp.h (contains implementatins used by the channels) 9512841Sgabeblack@google.com 96 adapters/ 97 adapters.h (defines transport_to_master and tlm_slave_to_transport) 98