sim/common/hw-events.h

   1 /* Hardware event manager.
   2    Copyright (C) 1998-2018 Free Software Foundation, Inc.
   3    Contributed by Cygnus Support.
   4
   5 This file is part of GDB, the GNU debugger.
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 3 of the License, or
  10 (at your option) any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef HW_EVENTS_H
  21 #define HW_EVENTS_H
  22
  23 /* Event manager customized for hardware models.
  24
  25    This interface is discussed further in sim-events.h. */
  26
  27 struct hw_event;
  28 typedef void (hw_event_callback) (struct hw *me, void *data);
  29
  30 struct hw_event *hw_event_queue_schedule
  31 (struct hw *me,
  32  signed64 delta_time,
  33  hw_event_callback *handler,
  34  void *data);
  35
  36 struct hw_event *hw_event_queue_schedule_tracef
  37 (struct hw *me,
  38  signed64 delta_time,
  39  hw_event_callback *handler,
  40  void *data,
  41  const char *fmt,
  42  ...) __attribute__ ((format (printf, 5, 6)));
  43
  44 struct hw_event *hw_event_queue_schedule_vtracef
  45 (struct hw *me,
  46  signed64 delta_time,
  47  hw_event_callback *handler,
  48  void *data,
  49  const char *fmt,
  50  va_list ap);
  51
  52
  53 void hw_event_queue_deschedule
  54 (struct hw *me,
  55  struct hw_event *event_to_remove);
  56
  57 signed64 hw_event_queue_time
  58 (struct hw *me);
  59
  60 /* Returns the time that remains before the event is raised. */
  61 signed64 hw_event_remain_time
  62 (struct hw *me, struct hw_event *event);
  63
  64 #endif