README.txt revision 12027
112027Sjungma@eit.uni-kl.deTLM-2.0 interoperability layer header files 212027Sjungma@eit.uni-kl.de=========================================== 312027Sjungma@eit.uni-kl.de 412027Sjungma@eit.uni-kl.deDir: include/tlm_core/tlm_2/ 512027Sjungma@eit.uni-kl.de 612027Sjungma@eit.uni-kl.deSubDirs: tlm_2_interfaces/ 712027Sjungma@eit.uni-kl.de tlm_generic_payload/ 812027Sjungma@eit.uni-kl.de tlm_quantum/ 912027Sjungma@eit.uni-kl.de tlm_sockets 1012027Sjungma@eit.uni-kl.de 1112027Sjungma@eit.uni-kl.deFiles: README.txt 1212027Sjungma@eit.uni-kl.de tlm_version.h 1312027Sjungma@eit.uni-kl.de 1412027Sjungma@eit.uni-kl.de 1512027Sjungma@eit.uni-kl.deComments 1612027Sjungma@eit.uni-kl.de======== 1712027Sjungma@eit.uni-kl.de 1812027Sjungma@eit.uni-kl.deUser code should only #include the tlm or tlm.h header file in the include/ 1912027Sjungma@eit.uni-kl.dedirectory and avoid including any of the include files in this directory 2012027Sjungma@eit.uni-kl.dedirectly. All objects defined in this file hierarchy are in the tlm namespace. 2112027Sjungma@eit.uni-kl.de 2212027Sjungma@eit.uni-kl.detlm_version.h contains the definitions for the version string and integer values 2312027Sjungma@eit.uni-kl.de 2412027Sjungma@eit.uni-kl.deThe header files are organizated, by subdirectory, as follows: 2512027Sjungma@eit.uni-kl.de 2612027Sjungma@eit.uni-kl.de 2712027Sjungma@eit.uni-kl.detlm_2_interfaces/ 2812027Sjungma@eit.uni-kl.de----------------- 2912027Sjungma@eit.uni-kl.de 3012027Sjungma@eit.uni-kl.deContains the TLM-2.0 core interfaces 3112027Sjungma@eit.uni-kl.de 3212027Sjungma@eit.uni-kl.deFiles: 3312027Sjungma@eit.uni-kl.de tlm_2_interfaces.h (includes the other header files in this directory ) 3412027Sjungma@eit.uni-kl.de tlm_fw_bw_ifs.h (defines the TLM 2.0 interface API's: 3512027Sjungma@eit.uni-kl.de tlm_fw_nonblocking_transport_if 3612027Sjungma@eit.uni-kl.de tlm_bw_nonblocking_transport_if 3712027Sjungma@eit.uni-kl.de tlm_blocking_transport_if 3812027Sjungma@eit.uni-kl.de tlm_fw_direct_mem_if 3912027Sjungma@eit.uni-kl.de tlm_bw_direct_mem_if 4012027Sjungma@eit.uni-kl.de tlm_transport_dbg_if 4112027Sjungma@eit.uni-kl.de the enumeration type 4212027Sjungma@eit.uni-kl.de tlm_sync_enum 4312027Sjungma@eit.uni-kl.de and the TLM 2.0 standard interfaces using the API's 4412027Sjungma@eit.uni-kl.de tlm_fw_transport_if 4512027Sjungma@eit.uni-kl.de tlm_bw_transport_if ) 4612027Sjungma@eit.uni-kl.de tlm_dmi.h (defines tlm_dmi) 4712027Sjungma@eit.uni-kl.de 4812027Sjungma@eit.uni-kl.de 4912027Sjungma@eit.uni-kl.detlm_generic_payload/ 5012027Sjungma@eit.uni-kl.de-------------------- 5112027Sjungma@eit.uni-kl.de 5212027Sjungma@eit.uni-kl.deContains the TLM-2.0 generic payload and associated classes and helper functions 5312027Sjungma@eit.uni-kl.de 5412027Sjungma@eit.uni-kl.deFiles: 5512027Sjungma@eit.uni-kl.de tlm_generic_payload.h ( includes the other header files in this directory) 5612027Sjungma@eit.uni-kl.de tlm_gp.h (defines the TLM 2.0 generic payload classes: 5712027Sjungma@eit.uni-kl.de tlm_generic_payload 5812027Sjungma@eit.uni-kl.de tlm_extension 5912027Sjungma@eit.uni-kl.de tlm_extension_base 6012027Sjungma@eit.uni-kl.de tlm_mm_interface 6112027Sjungma@eit.uni-kl.de and the enumeration types 6212027Sjungma@eit.uni-kl.de tlm_command 6312027Sjungma@eit.uni-kl.de tlm_response_status ) 6412027Sjungma@eit.uni-kl.de tlm_array.h (defines array class used by the extention 6512027Sjungma@eit.uni-kl.de mechanism ) 6612027Sjungma@eit.uni-kl.de tlm_endian_conv.h (defines the implementation for the endianness 6712027Sjungma@eit.uni-kl.de helper functions: 6812027Sjungma@eit.uni-kl.de tlm_to_hostendian_generic() 6912027Sjungma@eit.uni-kl.de tlm_from_hostendian_generic() 7012027Sjungma@eit.uni-kl.de tlm_to_hostendian_word() 7112027Sjungma@eit.uni-kl.de tlm_from_hostendian_word() 7212027Sjungma@eit.uni-kl.de tlm_to_hostendian_aligned() 7312027Sjungma@eit.uni-kl.de tlm_from_hostendian_aligned() 7412027Sjungma@eit.uni-kl.de tlm_to_hostendian_single() 7512027Sjungma@eit.uni-kl.de tlm_from_hostendian_single() ) 7612027Sjungma@eit.uni-kl.de 7712027Sjungma@eit.uni-kl.de tlm_helpers.h (defines the helper functions to determine the 7812027Sjungma@eit.uni-kl.de hostendianness: 7912027Sjungma@eit.uni-kl.de get_host_endianness() 8012027Sjungma@eit.uni-kl.de host_has_little_endianness() 8112027Sjungma@eit.uni-kl.de has_host_endianness() 8212027Sjungma@eit.uni-kl.de and defines the enumeration type: 8312027Sjungma@eit.uni-kl.de tlm_endianness 8412027Sjungma@eit.uni-kl.de tlm_phase.h (defines tlm_phase as an extendable enum type) 8512027Sjungma@eit.uni-kl.de 8612027Sjungma@eit.uni-kl.de 8712027Sjungma@eit.uni-kl.detlm_sockets/ 8812027Sjungma@eit.uni-kl.de------------ 8912027Sjungma@eit.uni-kl.de 9012027Sjungma@eit.uni-kl.deContains the standard TLM-2.0 initiator and target sockets (which are used as 9112027Sjungma@eit.uni-kl.dethe base classes for the convenience sockets in tlm_utils) 9212027Sjungma@eit.uni-kl.de 9312027Sjungma@eit.uni-kl.deFiles: 9412027Sjungma@eit.uni-kl.de tlm_sockets.h (includes the other header files in this directory) 9512027Sjungma@eit.uni-kl.de tlm_initiator_socket.h (defines the initiator sockets: 9612027Sjungma@eit.uni-kl.de tlm_initiator_socket_base 9712027Sjungma@eit.uni-kl.de tlm_initiator_socket_b 9812027Sjungma@eit.uni-kl.de tlm_initiator_socket 9912027Sjungma@eit.uni-kl.de tlm_target_socket.h (defines the target sockets: 10012027Sjungma@eit.uni-kl.de tlm_target_socket_base 10112027Sjungma@eit.uni-kl.de tlm_target_socket_b 10212027Sjungma@eit.uni-kl.de tlm_target_socket 10312027Sjungma@eit.uni-kl.de 10412027Sjungma@eit.uni-kl.de 10512027Sjungma@eit.uni-kl.detlm_quantum/ 10612027Sjungma@eit.uni-kl.de------------ 10712027Sjungma@eit.uni-kl.deThis contains the global quantum. (The quantum keeper is in tlm_utils) 10812027Sjungma@eit.uni-kl.de 10912027Sjungma@eit.uni-kl.deFiles: 11012027Sjungma@eit.uni-kl.de tlm_quantum.h ( includes the other header file in this directory ) 11112027Sjungma@eit.uni-kl.de tlm_global_quantum.h ( defines tlm_global_quantum ) 112