aboutsummaryrefslogtreecommitdiffstats
path: root/src/templates/chcore.c
blob: 84f0b741838638cd0e86abc822789d4c89fb81cc (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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/*
    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 Core
 * @{
 */

#include <ch.h>

/*
 * This file is a template of the system driver functions provided by a port.
 * Some of the following functions may be implemented as macros in chcore.h if
 * the implementer decides that there is an advantage in doing so, as example
 * because performance concerns.
 */

/**
 * Port-related initialization code.
 * @note This function is usually empty.
 */
void sys_init(void){
}

/**
 * Kernel-unlock action. Usually this function just disables interrupts but
 * may perform more actions.
 */
void sys_lock(void) {
}

/**
 * Kernel-unlock action. Usually this function just disables interrupts but
 * may perform more actions.
 */
void sys_unlock(void) {
}

/**
 * Kernel-lock action from an interrupt handler. This function is invoked
 * before invoking I-class APIs from interrupt handlers. The implementation
 * is architecture dependent, in its simplest form it is void.
 */
void sys_lock_from_isr(void) {
}

/**
 * Kernel-unlock action from an interrupt handler. This function is invoked
 * after invoking I-class APIs from interrupt handlers. The implementation
 * is architecture dependent, in its simplest form it is void.
 */
void sys_unlock_from_isr(void) {
}

/**
 * Disables all the interrupt sources.
 * @note Of course non maskable interrupt sources are not included.
 */
void sys_disable_all() {
}

/**
 * Disables the interrupt sources that are not supposed to preempt the kernel.
 */
void sys_disable(void) {
}

/**
 * Enables all the interrupt sources.
 */
void sys_enable(void) {
}

/**
 * Enters an architecture-dependent halt mode. The function is meant to return
 * when an interrupt becomes pending. The simplest implementation is an empty
 * function but this will not take advantage of architecture-specific power
 * saving modes.
 */
void sys_wait_for_interrupt(void) {
}

/**
 * Halts the system. This function is invoked by the operating system when an
 * unrecoverable error is detected (as example because a programming error in
 * the application code that triggers an assertion while in debug mode).
 */
void sys_halt(void) {

  sys_disable_all();
  while (TRUE) {
  }
}

/**
 * Performs a context switch between two threads.
 * @param otp the thread to be switched out
 * @param ntp the thread to be switched in
 */
void sys_switch(Thread *otp, Thread *ntp) {
}

/**
 * Prints a message on the system console.
 * @param msg pointer to the message
 */
void sys_puts(char *msg) {
}

/** @} */