aboutsummaryrefslogtreecommitdiffstats
path: root/src/include/scheduler.h
blob: 7d2f95bebd101d609027d712e58cdf6a38ff4812 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/*
    ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio.

    This file is part of ChibiOS/RT.

    ChibiOS/RT is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    ChibiOS/RT is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @addtogroup Scheduler
 * @{
 */

#ifndef _SCHEDULER_H_
#define _SCHEDULER_H_

/** Normal @p chSchReadyI() message. */
#define RDY_OK          0
/** Returned when the thread was made ready because of a timeout. */
#define RDY_TIMEOUT     -1
/** Returned when the thread was made ready because of a reset. */
#define RDY_RESET       -2

/** Pseudo priority used by the ready list header, do not use.*/
#define NOPRIO          0
/** Idle thread priority.*/
#define IDLEPRIO        1
/** Lowest user priority.*/
#define LOWPRIO         2
/** Normal user priority.*/
#define NORMALPRIO      64
/** Highest user priority.*/
#define HIGHPRIO        127
/** Greatest possible priority.*/
#define ABSPRIO         255

/** Infinite time specification for all the syscalls with a timeout
    specification.*/
#define TIME_INFINITE   0

/** The priority of the first thread on the given ready list. */
#define firstprio(rlp)  ((rlp)->p_next->p_prio)

/**
 * Ready list header.
 * @extends ThreadsQueue
 */
typedef struct {
  /** Next @p Thread in the ready list.*/
  Thread                *p_next;
  /** Previous @p Thread in the ready list.*/
  Thread                *p_prev;
  /* End of the fields shared with the ThreadsQueue structure. */
  /** The thread priority.*/
  tprio_t               r_prio;
  /* End of the fields shared with the Thread structure. */
#ifdef CH_USE_ROUNDROBIN
  cnt_t                 r_preempt;
#endif
#ifndef CH_CURRP_REGISTER_CACHE
  /** the currently running thread */
  Thread                *r_current;
#endif
} ReadyList;

extern ReadyList rlist;

/*
 * Scheduler APIs.
 */
#ifdef __cplusplus
extern "C" {
#endif
  void chSchInit(void);
  Thread *chSchReadyI(Thread *tp);
  void chSchGoSleepS(tstate_t newstate);
  msg_t chSchGoSleepTimeoutS(tstate_t newstate, systime_t time);
  void chSchWakeupS(Thread *tp, msg_t msg);
  void chSchDoRescheduleI(void);
  void chSchRescheduleS(void);
  bool_t chSchRescRequiredI(void);
#ifdef __cplusplus
}
#endif

#ifdef CH_CURRP_REGISTER_CACHE
register Thread *currp asm(CH_CURRP_REGISTER_CACHE);
#else
#define currp rlist.r_current
#endif

#endif /* _SCHEDULER_H_ */

/** @} */