SystemC: sysc/kernel/sc_wait.h Source File

00001 /*****************************************************************************
00002 
00003   The following code is derived, directly or indirectly, from the SystemC
00004   source code Copyright (c) 1996-2014 by all Contributors.
00005   All Rights reserved.
00006 
00007   The contents of this file are subject to the restrictions and limitations
00008   set forth in the SystemC Open Source License (the "License");
00009   You may not use this file except in compliance with such restrictions and
00010   limitations. You may obtain instructions on how to receive a copy of the
00011   License at http://www.accellera.org/. Software distributed by Contributors
00012   under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF
00013   ANY KIND, either express or implied. See the License for the specific
00014   language governing rights and limitations under the License.
00015 
00016  *****************************************************************************/
00017 
00018 /*****************************************************************************
00019 
00020   sc_wait.h -- Wait() and related functions.
00021 
00022   Original Author: Stan Y. Liao, Synopsys, Inc.
00023                    Martin Janssen, Synopsys, Inc.
00024 
00025   CHANGE LOG AT THE END OF THE FILE
00026  *****************************************************************************/
00027 
00028 #ifndef SC_WAIT_H
00029 #define SC_WAIT_H
00030 
00031 
00032 #include "sysc/kernel/sc_simcontext.h"
00033 
00034 namespace sc_core {
00035 
00036 class sc_event;
00037 class sc_event_and_list;
00038 class sc_event_or_list;
00039 class sc_simcontext;
00040 
00041 extern sc_simcontext* sc_get_curr_simcontext();
00042 
00043 // static sensitivity for SC_THREADs and SC_CTHREADs
00044 
00049 // 06/12/2015 GL: modified for the OoO simulation
00050 extern
00051 void
00052 wait( int,
00053       sc_simcontext* = sc_get_curr_simcontext() );
00054 
00055 
00056 // dynamic sensitivity for SC_THREADs and SC_CTHREADs
00057 
00062 // 06/12/2015 GL: modified for the OoO simulation
00063 extern
00064 void
00065 wait( const sc_event&,
00066       int,
00067       sc_simcontext* = sc_get_curr_simcontext() );
00068 
00073 // 06/12/2015 GL: modified for the OoO simulation
00074 extern
00075 void
00076 wait( const sc_event_or_list&,
00077       int,
00078       sc_simcontext* = sc_get_curr_simcontext() );
00079 
00084 // 06/12/2015 GL: modified for the OoO simulation
00085 extern
00086 void
00087 wait( const sc_event_and_list&,
00088       int,
00089       sc_simcontext* = sc_get_curr_simcontext() );
00090 
00095 // 06/12/2015 GL: modified for the OoO simulation
00096 extern
00097 void
00098 wait( const sc_time&,
00099       int,
00100       sc_simcontext* = sc_get_curr_simcontext() );
00101 
00106 // 06/12/2015 GL: modified for the OoO simulation
00107 inline
00108 void
00109 wait( double v, sc_time_unit tu,
00110       int seg_id,
00111       sc_simcontext* simc = sc_get_curr_simcontext() )
00112 {
00113     wait( sc_time( v, tu, simc ), seg_id, simc );
00114 }
00115 
00120 // 06/12/2015 GL: modified for the OoO simulation
00121 extern
00122 void
00123 wait( const sc_time&,
00124       const sc_event&,
00125       int,
00126       sc_simcontext* = sc_get_curr_simcontext() );
00127 
00132 // 06/12/2015 GL: modified for the OoO simulation
00133 inline
00134 void
00135 wait( double v, sc_time_unit tu,
00136       const sc_event& e,
00137       int seg_id,
00138       sc_simcontext* simc = sc_get_curr_simcontext() )
00139 {
00140     wait( sc_time( v, tu, simc ), e, seg_id, simc );
00141 }
00142 
00147 // 06/12/2015 GL: modified for the OoO simulation
00148 extern
00149 void
00150 wait( const sc_time&,
00151       const sc_event_or_list&,
00152       int,
00153       sc_simcontext* = sc_get_curr_simcontext() );
00154 
00159 // 06/12/2015 GL: modified for the OoO simulation
00160 inline
00161 void
00162 wait( double v, sc_time_unit tu,
00163       const sc_event_or_list& el,
00164       int seg_id,
00165       sc_simcontext* simc = sc_get_curr_simcontext() )
00166 {
00167     wait( sc_time( v, tu, simc ), el, seg_id, simc );
00168 }
00169 
00174 // 06/12/2015 GL: modified for the OoO simulation
00175 extern
00176 void
00177 wait( const sc_time&,
00178       const sc_event_and_list&,
00179       int,
00180       sc_simcontext* = sc_get_curr_simcontext() );
00181 
00186 // 06/12/2015 GL: modified for the OoO simulation
00187 inline
00188 void
00189 wait( double v, sc_time_unit tu,
00190       const sc_event_and_list& el,
00191       int seg_id,
00192       sc_simcontext* simc = sc_get_curr_simcontext() )
00193 {
00194     wait( sc_time( v, tu, simc ), el, seg_id, simc );
00195 }
00196 
00197 
00198 // static sensitivity for SC_METHODs
00199 
00204 // 06/12/2015 GL: modified for the OoO simulation
00205 extern
00206 void
00207 next_trigger( int,
00208               sc_simcontext* = sc_get_curr_simcontext() );
00209 
00210 
00211 // dynamic sensitivity for SC_METHODs
00212 
00217 // 06/12/2015 GL: modified for the OoO simulation
00218 extern
00219 void
00220 next_trigger( const sc_event&,
00221               int,
00222               sc_simcontext* = sc_get_curr_simcontext() );
00223 
00228 // 06/12/2015 GL: modified for the OoO simulation
00229 extern
00230 void
00231 next_trigger( const sc_event_or_list&,
00232               int,
00233               sc_simcontext* = sc_get_curr_simcontext() );
00234 
00239 // 06/12/2015 GL: modified for the OoO simulation
00240 extern
00241 void
00242 next_trigger( const sc_event_and_list&,
00243               int,
00244               sc_simcontext* = sc_get_curr_simcontext() );
00245 
00250 // 06/12/2015 GL: modified for the OoO simulation
00251 extern
00252 void
00253 next_trigger( const sc_time&,
00254               int,
00255               sc_simcontext* = sc_get_curr_simcontext() );
00256 
00261 // 06/12/2015 GL: modified for the OoO simulation
00262 inline
00263 void
00264 next_trigger( double v, sc_time_unit tu,
00265               int seg_id,
00266               sc_simcontext* simc = sc_get_curr_simcontext() )
00267 {
00268     next_trigger( sc_time( v, tu, simc ), seg_id, simc );
00269 }
00270 
00275 // 06/12/2015 GL: modified for the OoO simulation
00276 extern
00277 void
00278 next_trigger( const sc_time&,
00279               const sc_event&,
00280               int,
00281               sc_simcontext* = sc_get_curr_simcontext() );
00282 
00287 // 06/12/2015 GL: modified for the OoO simulation
00288 inline
00289 void
00290 next_trigger( double v, sc_time_unit tu,
00291               const sc_event& e,
00292               int seg_id,
00293               sc_simcontext* simc = sc_get_curr_simcontext() )
00294 {
00295     next_trigger( sc_time( v, tu, simc ), e, seg_id, simc );
00296 }
00297 
00302 // 06/12/2015 GL: modified for the OoO simulation
00303 extern
00304 void
00305 next_trigger( const sc_time&,
00306               const sc_event_or_list&,
00307               int,
00308               sc_simcontext* = sc_get_curr_simcontext() );
00309 
00314 // 06/12/2015 GL: modified for the OoO simulation
00315 inline
00316 void
00317 next_trigger( double v, sc_time_unit tu,
00318               const sc_event_or_list& el,
00319               int seg_id,
00320               sc_simcontext* simc = sc_get_curr_simcontext() )
00321 {
00322     next_trigger( sc_time( v, tu, simc ), el, seg_id, simc );
00323 }
00324 
00329 // 06/12/2015 GL: modified for the OoO simulation
00330 extern
00331 void
00332 next_trigger( const sc_time&,
00333               const sc_event_and_list&,
00334               int,
00335               sc_simcontext* = sc_get_curr_simcontext() );
00336 
00341 // 06/12/2015 GL: modified for the OoO simulation
00342 inline
00343 void
00344 next_trigger( double v, sc_time_unit tu,
00345               const sc_event_and_list& el,
00346               int seg_id,
00347               sc_simcontext* simc = sc_get_curr_simcontext() )
00348 {
00349     next_trigger( sc_time( v, tu, simc ), el, seg_id, simc );
00350 }
00351 
00352 
00353 // for SC_METHODs and SC_THREADs and SC_CTHREADs
00354 
00355 extern
00356 bool
00357 timed_out( sc_simcontext* = sc_get_curr_simcontext() );
00358 
00359 // misc.
00360 
00361 extern
00362 void
00363 sc_set_location( const char*,
00364                  int,
00365                  sc_simcontext* = sc_get_curr_simcontext() );
00366 
00367 } // namespace sc_core
00368 
00369 /*
00370 $Log: sc_wait.h,v $
00371 Revision 1.6  2011/08/26 20:46:11  acg
00372  Andy Goodrich: moved the modification log to the end of the file to
00373  eliminate source line number skew when check-ins are done.
00374 
00375 Revision 1.5  2011/02/18 20:27:14  acg
00376  Andy Goodrich: Updated Copyrights.
00377 
00378 Revision 1.4  2011/02/13 21:47:38  acg
00379  Andy Goodrich: update copyright notice.
00380 
00381 Revision 1.3  2011/01/18 20:10:45  acg
00382  Andy Goodrich: changes for IEEE1666_2011 semantics.
00383 
00384 Revision 1.2  2008/05/22 17:06:27  acg
00385  Andy Goodrich: updated copyright notice to include 2008.
00386 
00387 Revision 1.1.1.1  2006/12/15 20:20:05  acg
00388 SystemC 2.3
00389 
00390 Revision 1.2  2006/01/03 23:18:45  acg
00391 Changed copyright to include 2006.
00392 
00393 Revision 1.1.1.1  2005/12/19 23:16:44  acg
00394 First check in of SystemC 2.1 into its own archive.
00395 
00396 Revision 1.10  2005/07/30 03:45:05  acg
00397 Changes from 2.1, including changes for sc_process_handle.
00398 
00399 Revision 1.9  2005/04/04 00:16:08  acg
00400 Changes for directory name change to sys from systemc.
00401 Changes for sc_string going to std::string.
00402 Changes for sc_pvector going to std::vector.
00403 Changes for reference pools for bit and part selections.
00404 Changes for const sc_concatref support.
00405 
00406 Revision 1.6  2004/10/13 18:13:22  acg
00407 sc_ver.h - updated version number. sc_wait.h remove inclusion of
00408 sysc/kernel/sc_event.h because it is not necessary.
00409 
00410 Revision 1.5  2004/09/27 20:49:10  acg
00411 Andy Goodrich, Forte Design Systems, Inc.
00412    - Added a $Log comment so that CVS checkin comments appear in the
00413         checkout source.
00414 
00415 */
00416 
00417 #endif
00418 
00419 // Taf!