| 1 |
19 |
jeremybenn |
/* sched.h -- Abstract entities header file handling job scheduler
|
| 2 |
|
|
|
| 3 |
|
|
Copyright (C) 2001 Marko Mlinar, markom@opencores.org
|
| 4 |
|
|
Copyright (C) 2005 György `nog' Jeney, nog@sdf.lonestar.org
|
| 5 |
|
|
Copyright (C) 2008 Embecosm Limited
|
| 6 |
|
|
|
| 7 |
|
|
Contributor Jeremy Bennett <jeremy.bennett@embecosm.com>
|
| 8 |
|
|
|
| 9 |
|
|
This file is part of Or1ksim, the OpenRISC 1000 Architectural Simulator.
|
| 10 |
|
|
|
| 11 |
|
|
This program is free software; you can redistribute it and/or modify it
|
| 12 |
|
|
under the terms of the GNU General Public License as published by the Free
|
| 13 |
|
|
Software Foundation; either version 3 of the License, or (at your option)
|
| 14 |
|
|
any later version.
|
| 15 |
|
|
|
| 16 |
|
|
This program is distributed in the hope that it will be useful, but WITHOUT
|
| 17 |
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
| 18 |
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
| 19 |
|
|
more details.
|
| 20 |
|
|
|
| 21 |
|
|
You should have received a copy of the GNU General Public License along
|
| 22 |
|
|
with this program. If not, see <http://www.gnu.org/licenses/>. */
|
| 23 |
|
|
|
| 24 |
|
|
/* This program is commented throughout in a fashion suitable for processing
|
| 25 |
|
|
with Doxygen. */
|
| 26 |
|
|
|
| 27 |
|
|
|
| 28 |
|
|
#ifndef _SCHED_H_
|
| 29 |
|
|
#define _SCHED_H_
|
| 30 |
|
|
|
| 31 |
|
|
/*! Macro to add a job to the scheduler */
|
| 32 |
|
|
#define SCHED_ADD(job_func, job_param, job_time) sched_add(job_func, job_param, job_time, #job_func)
|
| 33 |
|
|
|
| 34 |
|
|
/*! Macro to remove a job from the scheduler */
|
| 35 |
|
|
#define SCHED_FIND_REMOVE(f, p) sched_find_remove(f, p)
|
| 36 |
|
|
|
| 37 |
|
|
/*! Structure for holding one job entry */
|
| 38 |
|
|
struct sched_entry
|
| 39 |
|
|
{
|
| 40 |
|
|
int32_t time; /* Clock cycles before job starts */
|
| 41 |
|
|
void *param; /* Parameter to pass to the function */
|
| 42 |
|
|
void (*func) (void *); /* Function to call when time reaches 0 */
|
| 43 |
|
|
struct sched_entry *next;
|
| 44 |
|
|
};
|
| 45 |
|
|
|
| 46 |
|
|
/*! Heap of jobs */
|
| 47 |
|
|
struct scheduler_struct
|
| 48 |
|
|
{
|
| 49 |
|
|
struct sched_entry *free_job_queue;
|
| 50 |
|
|
struct sched_entry *job_queue;
|
| 51 |
|
|
};
|
| 52 |
|
|
|
| 53 |
|
|
/* Global data structures for external use */
|
| 54 |
|
|
extern struct scheduler_struct scheduler;
|
| 55 |
|
|
|
| 56 |
|
|
/* Function prototypes for external use */
|
| 57 |
|
|
extern void sched_init ();
|
| 58 |
|
|
extern void sched_reset ();
|
| 59 |
|
|
extern void sched_next_insn (void (*func) (void *),
|
| 60 |
|
|
void *dat);
|
| 61 |
|
|
extern void sched_find_remove (void (*job_func) (void *),
|
| 62 |
|
|
void *dat);
|
| 63 |
|
|
extern void sched_add (void (*job_func) (void *),
|
| 64 |
|
|
void *job_param,
|
| 65 |
|
|
int32_t job_time,
|
| 66 |
|
|
const char *func);
|
| 67 |
|
|
extern void do_scheduler ();
|
| 68 |
|
|
|
| 69 |
|
|
#endif /* _SCHED_H_ */
|
