Changes between Version 137 and Version 138 of Writing Rules/Tlmt

Timestamp:

Mar 3, 2009, 2:09:42 PM (15 years ago)

Author:

alinevieiramello@…

Comment:

--

Writing Rules/Tlmt

@@ -150 +150 @@
 
 The initiator uses the class '''pdes_local_time''' for managing and interacting with his local time and with the interval between two consecutive null messages.
+The class '''pdes_local_time''' is described in section D.5.
+
+The initiator activity status (used by the temporal filtering, as described in section F) is managed for the class '''pdes_activity_status'''.
+The corresponding access functions are '''set()''' and '''get()'''.
+
+The '''execLoop()''' method, describing the initiator behaviour must be declared as a member function. 
+
+The '''my_initiator''' class contains a member variable '''p_vci_init''', of type '''tlm_utils::simple_initiator_socket''', representing the VCI initiator port. 
+
+It must also define an interface function to handle the VCI response packets.
+
+== D.2) Sending a VCI command packet ==
+
+To send a VCI command packet, the '''execLoop()''' method must use the '''nb_transport_fw()''' method, defined by TLM2.0, 
+that is a member function of the '''p_vci_init''' port. The prototype of this method is the following:
+{{{
+  tlm::tlm_sync_enum nb_transport_fw            
+  ( tlm::tlm_generic_payload &payload,      // payload 
+    tlm::tlm_phase           &phase,        // phase (TLM::BEGIN_REQ)
+    sc_core::sc_time         &time);        // absolute local time
+}}}
+
+The first argument is a pointer to the payload (including the soclib payload extension), 
+the second represents the phase (always set to TLM::BEGIN_REQ for requests), and the third
+argument contains the initiator local time. The return value is not used in this TLM-T implementation.
+
+The '''nb_transport_fw()''' function is non-blocking. 
+To implement a blocking transaction (such as a cache line read, where the processor is stalled during the VCI transaction), 
+the model designer must use the SystemC '''sc_core::wait(x)''' primitive ('''x''' being of type '''sc_core::sc_event'''): 
+the '''execLoop()''' thread is then suspended, and will be reactivated when the response packet is actually received.
+
+== D.3) Receiving a VCI response packet ==
+
+To receive a VCI response packet, an interface function must be defined as a member function of the 
+class '''my_initiator'''. This function (named '''nb_transport_bw()''' in the example), must be linked to
+the '''p_vci_init''' port, and is executed each time a VCI response packet is received on the '''p_vci_init''' port. 
+The function name is not constrained, but the arguments must respect the following prototype:
+{{{
+  tlm::tlm_sync_enum nb_transport_bw              
+  ( tlm::tlm_generic_payload &payload,      // payload
+    tlm::tlm_phase           &phase,        // phase (TLM::BEGIN_RESP)
+    sc_core::sc_time         &time);        // response time
+}}}
+The return value (type tlm::tlm_sync_enum)  is not used in this TLM-T implementation, and must be sytematically set to tlm::TLM_COMPLETED.
+
+== D.4) Initiator Constructor ==
+
+The constructor of the class '''my_initiator''' must initialize all the member variables, including 
+the '''p_vci_init''' port. The '''nb_transport_bw()''' function being executed in the context of the thread sending 
+the response packet, a link between the '''p_vci_init''' port and this interface function must be established. 
+
+The constructor for the '''p_vci_init''' port must be called with the following arguments:
+{{{
+  p_vci_init.register_nb_transport_bw(this, &my_initiator::nb_transport_bw);
+}}}
+
+== D.5) Local Time Representation & Synchronization  ==
+
+The SystemC simulation engine behaves as a cooperative, non-preemptive multi-tasks system. Any thread in the system must stop execution at some point, in order to allow the other threads to execute. Moreover each PDES process must send null message periodically.
+
+To solve this issue, it is necessary to define -for each initiator module- a '''synchronization time quantum''' parameter. This parameter defines 
+the maximum delay between two successive timed messages. When this time quantum is elapsed, the component send a null message,
+and the corresponding thread is descheduled. 
+
+This time quantum mechanism is implemented in the '''pdes_local_time''' class.
+For each initiator, the time quantum value is a parameter defined as a constructor argument.
+The three members methods are... 
 The '''pdes_local_time''' has the following access functions:
 {{{
@@ -162 +229 @@
   bool need_sync();                                  // check if a synchronization is required
 }}}
-
-The initiator activity status (used by the temporal filtering, as described in section F) is managed for the class '''pdes_activity_status'''.
-The corresponding access functions are '''set()''' and '''get()'''.
-{{{
-  bool m_activity_status;                           // the initiator activity status
-  ...
-  pdes_activity_status();                           // constructor
-  void set(bool a);                                 // set the activity status (true if the component is active)
-  bool get();                                       // get the activity state
-}}}
-
-The '''execLoop()''' method, describing the initiator behaviour must be declared as a member function. 
-
-The '''my_initiator''' class contains a member variable '''p_vci_init''', of type '''tlm_utils::simple_initiator_socket''', representing the VCI initiator port. 
-
-It must also define an interface function to handle the VCI response packets.
-
-== D.2) Sending a VCI command packet ==
-
-To send a VCI command packet, the '''execLoop()''' method must use the '''nb_transport_fw()''' method, defined by TLM2.0, 
-that is a member function of the '''p_vci_init''' port. The prototype of this method is the following:
-{{{
-  tlm::tlm_sync_enum nb_transport_fw            
-  ( tlm::tlm_generic_payload &payload,      // payload 
-    tlm::tlm_phase           &phase,        // phase (TLM::BEGIN_REQ)
-    sc_core::sc_time         &time);        // absolute local time
-}}}
-
-The first argument is a pointer to the payload (including the soclib payload extension), 
-the second represents the phase (always set to TLM::BEGIN_REQ for requests), and the third
-argument contains the initiator local time. The return value is not used in this TLM-T implementation.
-
-The '''nb_transport_fw()''' function is non-blocking. 
-To implement a blocking transaction (such as a cache line read, where the processor is stalled during the VCI transaction), 
-the model designer must use the SystemC '''sc_core::wait(x)''' primitive ('''x''' being of type '''sc_core::sc_event'''): 
-the '''execLoop()''' thread is then suspended, and will be reactivated when the response packet is actually received.
-
-== D.3) Receiving a VCI response packet ==
-
-To receive a VCI response packet, an interface function must be defined as a member function of the 
-class '''my_initiator'''. This function (named '''nb_transport_bw()''' in the example), must be linked to
-the '''p_vci_init''' port, and is executed each time a VCI response packet is received on the '''p_vci_init''' port. 
-The function name is not constrained, but the arguments must respect the following prototype:
-{{{
-  tlm::tlm_sync_enum nb_transport_bw              
-  ( tlm::tlm_generic_payload &payload,      // payload
-    tlm::tlm_phase           &phase,        // phase (TLM::BEGIN_RESP)
-    sc_core::sc_time         &time);        // response time
-}}}
-The return value (type tlm::tlm_sync_enum)  is not used in this TLM-T implementation, and must be sytematically set to tlm::TLM_COMPLETED.
-
-== D.4) Initiator Constructor ==
-
-The constructor of the class '''my_initiator''' must initialize all the member variables, including 
-the '''p_vci_init''' port. The '''nb_transport_bw()''' function being executed in the context of the thread sending 
-the response packet, a link between the '''p_vci_init''' port and this interface function must be established. 
-
-The constructor for the '''p_vci_init''' port must be called with the following arguments:
-{{{
-  p_vci_init.register_nb_transport_bw(this, &my_initiator::nb_transport_bw);
-}}}
-
-== D.5) Local Time Representation & Synchronization  ==
-
-The SystemC simulation engine behaves as a cooperative, non-preemptive multi-tasks system. Any thread in the system must stop execution at some point, in order to allow the other threads to execute. Moreover each PDES process must send null message periodically.
-
-To solve this issue, it is necessary to define -for each initiator module- a '''synchronization time quantum''' parameter. This parameter defines 
-the maximum delay between two successive timed messages. When this time quantum is elapsed, the component send a null message,
-and the corresponding thread is descheduled. 
-
-This time quantum mechanism is implemented in the '''pdes_local_time''' class.
-For each initiator, the time quantum value is a parameter defined as a constructor argument.
-The three members methods are... 
-
 
 == D.6) VCI initiator example ==