113516Sgabeblack@google.comTLM-2.0 interoperability layer header files 213516Sgabeblack@google.com=========================================== 313516Sgabeblack@google.com 413516Sgabeblack@google.comDir: include/tlm_core/2/ 513516Sgabeblack@google.com 613516Sgabeblack@google.comSubDirs: interfaces/ 713516Sgabeblack@google.com generic_payload/ 813516Sgabeblack@google.com quantum/ 913516Sgabeblack@google.com sockets 1013516Sgabeblack@google.com 1113516Sgabeblack@google.comFiles: README.txt 1213516Sgabeblack@google.com version.h 1313516Sgabeblack@google.com 1413516Sgabeblack@google.com 1513516Sgabeblack@google.comComments 1613516Sgabeblack@google.com======== 1713516Sgabeblack@google.com 1813516Sgabeblack@google.comUser code should only #include the tlm or tlm.h header file in the include/ 1913516Sgabeblack@google.comdirectory and avoid including any of the include files in this directory 2013516Sgabeblack@google.comdirectly. All objects defined in this file hierarchy are in the tlm namespace. 2113516Sgabeblack@google.com 2213516Sgabeblack@google.comtlm_version.h contains the definitions for the version string and integer values 2313516Sgabeblack@google.com 2413516Sgabeblack@google.comThe header files are organizated, by subdirectory, as follows: 2513516Sgabeblack@google.com 2613516Sgabeblack@google.com 2713516Sgabeblack@google.cominterfaces/ 2813516Sgabeblack@google.com----------------- 2913516Sgabeblack@google.com 3013516Sgabeblack@google.comContains the TLM-2.0 core interfaces 3113516Sgabeblack@google.com 3213516Sgabeblack@google.comFiles: 3313516Sgabeblack@google.com interfaces.h (includes the other header files in this directory ) 3413516Sgabeblack@google.com fw_bw_ifs.h (defines the TLM 2.0 interface API's: 3513516Sgabeblack@google.com tlm_fw_nonblocking_transport_if 3613516Sgabeblack@google.com tlm_bw_nonblocking_transport_if 3713516Sgabeblack@google.com tlm_blocking_transport_if 3813516Sgabeblack@google.com tlm_fw_direct_mem_if 3913516Sgabeblack@google.com tlm_bw_direct_mem_if 4013516Sgabeblack@google.com tlm_transport_dbg_if 4113516Sgabeblack@google.com the enumeration type 4213516Sgabeblack@google.com tlm_sync_enum 4313516Sgabeblack@google.com and the TLM 2.0 standard interfaces using the API's 4413516Sgabeblack@google.com tlm_fw_transport_if 4513516Sgabeblack@google.com tlm_bw_transport_if ) 4613516Sgabeblack@google.com dmi.h (defines tlm_dmi) 4713516Sgabeblack@google.com 4813516Sgabeblack@google.com 4913516Sgabeblack@google.comgeneric_payload/ 5013516Sgabeblack@google.com-------------------- 5113516Sgabeblack@google.com 5213516Sgabeblack@google.comContains the TLM-2.0 generic payload and associated classes and helper functions 5313516Sgabeblack@google.com 5413516Sgabeblack@google.comFiles: 5513516Sgabeblack@google.com generic_payload.h ( includes the other header files in this directory) 5613516Sgabeblack@google.com gp.h (defines the TLM 2.0 generic payload classes: 5713516Sgabeblack@google.com tlm_generic_payload 5813516Sgabeblack@google.com tlm_extension 5913516Sgabeblack@google.com tlm_extension_base 6013516Sgabeblack@google.com tlm_mm_interface 6113516Sgabeblack@google.com and the enumeration types 6213516Sgabeblack@google.com tlm_command 6313516Sgabeblack@google.com tlm_response_status ) 6413516Sgabeblack@google.com array.h (defines array class used by the extention 6513516Sgabeblack@google.com mechanism ) 6613516Sgabeblack@google.com endian_conv.h (defines the implementation for the endianness 6713516Sgabeblack@google.com helper functions: 6813516Sgabeblack@google.com tlm_to_hostendian_generic() 6913516Sgabeblack@google.com tlm_from_hostendian_generic() 7013516Sgabeblack@google.com tlm_to_hostendian_word() 7113516Sgabeblack@google.com tlm_from_hostendian_word() 7213516Sgabeblack@google.com tlm_to_hostendian_aligned() 7313516Sgabeblack@google.com tlm_from_hostendian_aligned() 7413516Sgabeblack@google.com tlm_to_hostendian_single() 7513516Sgabeblack@google.com tlm_from_hostendian_single() ) 7613516Sgabeblack@google.com 7713516Sgabeblack@google.com helpers.h (defines the helper functions to determine the 7813516Sgabeblack@google.com hostendianness: 7913516Sgabeblack@google.com get_host_endianness() 8013516Sgabeblack@google.com host_has_little_endianness() 8113516Sgabeblack@google.com has_host_endianness() 8213516Sgabeblack@google.com and defines the enumeration type: 8313516Sgabeblack@google.com tlm_endianness 8413516Sgabeblack@google.com phase.h (defines tlm_phase as an extendable enum type) 8513516Sgabeblack@google.com 8613516Sgabeblack@google.com 8713516Sgabeblack@google.comsockets/ 8813516Sgabeblack@google.com------------ 8913516Sgabeblack@google.com 9013516Sgabeblack@google.comContains the standard TLM-2.0 initiator and target sockets (which are used as 9113516Sgabeblack@google.comthe base classes for the convenience sockets in tlm_utils) 9213516Sgabeblack@google.com 9313516Sgabeblack@google.comFiles: 9413516Sgabeblack@google.com sockets.h (includes the other header files in this directory) 9513516Sgabeblack@google.com initiator_socket.h (defines the initiator sockets: 9613516Sgabeblack@google.com tlm_initiator_socket_base 9713516Sgabeblack@google.com tlm_initiator_socket_b 9813516Sgabeblack@google.com tlm_initiator_socket 9913516Sgabeblack@google.com target_socket.h (defines the target sockets: 10013516Sgabeblack@google.com tlm_target_socket_base 10113516Sgabeblack@google.com tlm_target_socket_b 10213516Sgabeblack@google.com tlm_target_socket 10313516Sgabeblack@google.com 10413516Sgabeblack@google.com 10513516Sgabeblack@google.comquantum/ 10613516Sgabeblack@google.com------------ 10713516Sgabeblack@google.comThis contains the global quantum. (The quantum keeper is in tlm_utils) 10813516Sgabeblack@google.com 10913516Sgabeblack@google.comFiles: 11013516Sgabeblack@google.com quantum.h ( includes the other header file in this directory ) 11113516Sgabeblack@google.com global_quantum.h ( defines tlm_global_quantum ) 112