README.txt revision 13511
12623SN/A 210030SAli.Saidi@ARM.comTLM-2.0 standard utilities 38926Sandreas.hansson@arm.com========================== 48926Sandreas.hansson@arm.com 58926Sandreas.hansson@arm.comDir: include/tlm_utils 68926Sandreas.hansson@arm.com 78926Sandreas.hansson@arm.comSubDirs: 88926Sandreas.hansson@arm.com 98926Sandreas.hansson@arm.comFiles: README.txt 108926Sandreas.hansson@arm.com instance_specific_extensions.h 118926Sandreas.hansson@arm.com multi_passthrough_initiator_socket.h 128926Sandreas.hansson@arm.com multi_passthrough_target_socket.h 138926Sandreas.hansson@arm.com multi_socket_bases.h 142623SN/A peq_with_get.h 152623SN/A simple_initiator_socket.h 162623SN/A simple_target_socket.h 172623SN/A peq_with_cb_and_phase.h 182623SN/A passthrough_target_socket.h 192623SN/A tlm_quantumkeeper.h 202623SN/A 212623SN/A 222623SN/AComments 232623SN/A======== 242623SN/A 252623SN/AThis directory contains a number of ease-of-use and convenience implementations 262623SN/Afor the interoperability standard. All objects defined in the header files of 272623SN/Athis directory are contained in the tlm_util namespace. 282623SN/AThere is no tlm_utils.h header files containing all includes in order to avoid 292623SN/Aadditional dependencies for TLM 2.0 302623SN/A 312623SN/AFiles: 322623SN/A simple_initiator_socket.h 332623SN/A version of an initiator socket that has a default implementation of all 342623SN/A interfaces and allows to register an implementation for any of the 352623SN/A interfaces to the socket, either unique interfaces or tagged interfaces 362623SN/A (carrying an additional id) 372623SN/A 382623SN/A simple_target_socket.h 392665Ssaidi@eecs.umich.edu version of a target socket that has a default implementation of all 402665Ssaidi@eecs.umich.edu interfaces and allows to register an implementation for any of the 412623SN/A interfaces to the socket, either unique interfaces or tagged interfaces 422623SN/A (carrying an additional id) 433170Sstever@eecs.umich.edu This socket allows to register only 1 of the transport interfaces 448105Sgblack@eecs.umich.edu (blocking or non-blocking) and implements a conversion in case the 452623SN/A socket is used on the other interface 464040Ssaidi@eecs.umich.edu 479647Sdam.sunwoo@arm.com passthrough_target_socket.h 486658Snate@binkert.org version of a target socket that has a default implementation of all 498229Snate@binkert.org interfaces and allows to register an implementation for any of the 502623SN/A interfaces to the socket. 519443SAndreas.Sandberg@ARM.com 528232Snate@binkert.org multi_passthrough_initiator_socket.h 538232Snate@binkert.org an implementation of a socket that allows to bind multiple targets to the 543348Sbinkertn@umich.edu same initiator socket. Implements a mechanism to allow to identify in the 553348Sbinkertn@umich.edu backward path through which index of the socket the call passed through 568926Sandreas.hansson@arm.com 574762Snate@binkert.org multi_passthrough_target_socket.h 587678Sgblack@eecs.umich.edu an implementation of a socket that allows to bind multiple initiators to 592901Ssaidi@eecs.umich.edu the same target socket. Implements a mechanism to allow to identify in the 608779Sgblack@eecs.umich.edu forward path through which index of the socket the call passed through 612623SN/A 622623SN/A multi_socket_bases.h 632623SN/A contains base class definitions used by the multi_passthrough sockets 642623SN/A 652623SN/A peq_with_get.h 665606Snate@binkert.org payload event queue (PEQ) implementation using a pull interface. 672623SN/A Has a get_next_transaction API that returns the transaction that is 682623SN/A scheduled in the event queue 692623SN/A 702623SN/A peq_with_cb_and_phase.h 712623SN/A another payload event queue, this one with a push interface (callback 722623SN/A mechanism ). Allows to register a callback that will be called whenever 732623SN/A the event in the event queue is triggered, the callback gets transaction 742623SN/A and phase as arguments 752623SN/A 762623SN/A instance_specific_extensions.h 772623SN/A is an implementation for adding extentions in the generic payload that 785336Shines@cs.fsu.edu are specific to an instance along the path of a transaction, to allow that 792623SN/A extentions of the same type can be used by the different blocks along 804873Sstever@eecs.umich.edu the path of the transaction 812623SN/A 822623SN/A tlm_quantumkeeper.h 832623SN/A is an convenience object used to keep track of the local time in 842623SN/A an initiator (how much it has run ahead of the SystemC time), to 852623SN/A synchronize with SystemC time etc. 862623SN/A