README.txt revision 13516
1TLM-2.0 interoperability layer header files 2=========================================== 3 4Dir: include/tlm_core/2/ 5 6SubDirs: interfaces/ 7 generic_payload/ 8 quantum/ 9 sockets 10 11Files: README.txt 12 version.h 13 14 15Comments 16======== 17 18User code should only #include the tlm or tlm.h header file in the include/ 19directory and avoid including any of the include files in this directory 20directly. All objects defined in this file hierarchy are in the tlm namespace. 21 22tlm_version.h contains the definitions for the version string and integer values 23 24The header files are organizated, by subdirectory, as follows: 25 26 27interfaces/ 28----------------- 29 30Contains the TLM-2.0 core interfaces 31 32Files: 33 interfaces.h (includes the other header files in this directory ) 34 fw_bw_ifs.h (defines the TLM 2.0 interface API's: 35 tlm_fw_nonblocking_transport_if 36 tlm_bw_nonblocking_transport_if 37 tlm_blocking_transport_if 38 tlm_fw_direct_mem_if 39 tlm_bw_direct_mem_if 40 tlm_transport_dbg_if 41 the enumeration type 42 tlm_sync_enum 43 and the TLM 2.0 standard interfaces using the API's 44 tlm_fw_transport_if 45 tlm_bw_transport_if ) 46 dmi.h (defines tlm_dmi) 47 48 49generic_payload/ 50-------------------- 51 52Contains the TLM-2.0 generic payload and associated classes and helper functions 53 54Files: 55 generic_payload.h ( includes the other header files in this directory) 56 gp.h (defines the TLM 2.0 generic payload classes: 57 tlm_generic_payload 58 tlm_extension 59 tlm_extension_base 60 tlm_mm_interface 61 and the enumeration types 62 tlm_command 63 tlm_response_status ) 64 array.h (defines array class used by the extention 65 mechanism ) 66 endian_conv.h (defines the implementation for the endianness 67 helper functions: 68 tlm_to_hostendian_generic() 69 tlm_from_hostendian_generic() 70 tlm_to_hostendian_word() 71 tlm_from_hostendian_word() 72 tlm_to_hostendian_aligned() 73 tlm_from_hostendian_aligned() 74 tlm_to_hostendian_single() 75 tlm_from_hostendian_single() ) 76 77 helpers.h (defines the helper functions to determine the 78 hostendianness: 79 get_host_endianness() 80 host_has_little_endianness() 81 has_host_endianness() 82 and defines the enumeration type: 83 tlm_endianness 84 phase.h (defines tlm_phase as an extendable enum type) 85 86 87sockets/ 88------------ 89 90Contains the standard TLM-2.0 initiator and target sockets (which are used as 91the base classes for the convenience sockets in tlm_utils) 92 93Files: 94 sockets.h (includes the other header files in this directory) 95 initiator_socket.h (defines the initiator sockets: 96 tlm_initiator_socket_base 97 tlm_initiator_socket_b 98 tlm_initiator_socket 99 target_socket.h (defines the target sockets: 100 tlm_target_socket_base 101 tlm_target_socket_b 102 tlm_target_socket 103 104 105quantum/ 106------------ 107This contains the global quantum. (The quantum keeper is in tlm_utils) 108 109Files: 110 quantum.h ( includes the other header file in this directory ) 111 global_quantum.h ( defines tlm_global_quantum ) 112