-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
374 lines (331 loc) Β· 14.2 KB
/
index.html
File metadata and controls
374 lines (331 loc) Β· 14.2 KB
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
<!DOCTYPE html><html class="writer-html5" lang="en"><head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="img/favicon.ico">
<title>Synopsis - scmRTOS</title>
<link rel="stylesheet" href="css/theme.css">
<link rel="stylesheet" href="css/theme_extra.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css">
<link href="extra.css" rel="stylesheet">
<script>
// Current page data
var mkdocs_page_name = "Synopsis";
var mkdocs_page_input_path = "en/index.md";
var mkdocs_page_url = null;
</script>
<!--[if lt IE 9]>
<script src="js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
<script>hljs.highlightAll();</script>
<script>
document.addEventListener("DOMContentLoaded", function() {
const selectorDiv = document.createElement("div");
selectorDiv.style.padding = "0.7em 0";
selectorDiv.style.textAlign = "center";
selectorDiv.style.borderBottom = "1px solid #ddd";
selectorDiv.style.marginBottom = "0.7em";
selectorDiv.style.display = "flex";
selectorDiv.style.alignItems = "center";
selectorDiv.style.gap = "10px";
selectorDiv.style.justifyContent = "center";
const select = document.createElement("select");
select.id = "lang-switcher";
select.style.width = "30%";
select.style.padding = "0.1em";
select.style.fontSize = "0.7em";
select.style.borderRadius = "10px";
select.style.textAlign = "center";
select.style.background = "#fff";
//select.style.border = "1px solid #ccc";
const currentLang = "en";
const languages = [
{ code: 'en', name: 'English', prefix: '/' },
{ code: 'ru', name: 'Π ΡΡΡΠΊΠΈΠΉ', prefix: '/ru/' }
];
// get the page path and remove the leading slash
let pagePath = "".replace(/^\//, '');
// remove current lang prefix from the path
const currentLangObj = languages.find(lang => lang.code === currentLang);
if (currentLangObj && currentLangObj.prefix !== '/') {
// remove the leading slash from the prefix for comparison
const langPrefixWithoutSlash = currentLangObj.prefix.replace(/^\//, '');
// if the path starts with the lang prefix, delete it
if (pagePath.startsWith(langPrefixWithoutSlash)) {
pagePath = pagePath.substring(langPrefixWithoutSlash.length);
// remove the possible remaining leading slash
pagePath = pagePath.replace(/^\//, '');
}
}
console.log("Current lang:", currentLang, "page.url raw:", "", "normalized path:", pagePath);
languages.forEach(lang => {
const option = document.createElement("option");
let targetUrl;
// build target URL
if (pagePath === '') {
// main page
targetUrl = lang.prefix === '/' ? '/' : lang.prefix;
// make sure the path ended with a slash
if (!targetUrl.endsWith('/')) {
targetUrl += '/';
}
} else {
// all remaining pages - just combine the prefix and the path
targetUrl = lang.prefix + pagePath;
}
option.value = targetUrl;
option.text = lang.name;
if (lang.code === currentLang) option.selected = true;
select.appendChild(option);
});
const label = document.createElement("div");
label.style.fontSize = "0.8em";
label.style.color = "#fff";
label.style.marginTop = "0.3em";
label.textContent = "Language / Π―Π·ΡΠΊ";
selectorDiv.appendChild(label);
selectorDiv.appendChild(select);
// Insert at top of sidebar
const target = document.querySelector(".wy-side-nav-search");
if (target) {
target.insertBefore(selectorDiv, target.firstChild);
} else {
console.warn("Could not find .wy-side-nav-search for lang selector");
}
select.addEventListener("change", function() {
if (this.value) window.location.href = this.value;
});
});
</script>
<link href="assets/stylesheets/glightbox.min.css" rel="stylesheet"><script src="assets/javascripts/glightbox.min.js"></script><style id="glightbox-style">
html.glightbox-open { overflow: initial; height: 100%; }
.gslide-title { margin-top: 0px; user-select: text; }
.gslide-desc { color: #666; user-select: text; }
.gslide-image img { background: white; }
</style></head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="." class="icon icon-home"> scmRTOS
</a><div role="search">
<form id="rtd-search-form" class="wy-form" action="./search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here">
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption"><span class="caption-text">Intro</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="#">Synopsis</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#about-scmrtos">About scmRTOS</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#features">Features</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#supported-target-platforms">Supported Target Platforms</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="preface/">Preface</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="overview/">Overview</a>
</li>
</ul>
<p class="caption"><span class="caption-text">RTOS Components</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="kernel/">Kernel</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="processes/">Processes</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="ipcs/">Interprocess Communication</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Appendix</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="porting/">Porting</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="debug/">Debugging</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="profiler/">Process Profiling</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="example-job-queue/">Example: Job Queue</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="glossary/">Glossary</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href=".">scmRTOS</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="." class="icon icon-home" aria-label="Docs"></a></li>
<li class="breadcrumb-item">Intro</li>
<li class="breadcrumb-item active">Synopsis</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="synopsis">Synopsis<a class="headerlink" href="#synopsis" title="Permanent link">π</a></h1>
<h2 id="about-scmrtos">About scmRTOS<a class="headerlink" href="#about-scmrtos" title="Permanent link">π</a></h2>
<p><strong>scmRTOS</strong> is compact Real-Time Preemptive Operating System intended for use with Single-Chip Microcontrollers. </p>
<p><strong>scmRTOS</strong> is capable to run on tiny uCs with as small amount of RAM as 512 bytes. The RTOS is written on C++ and supports <a href="#index-supported-targets">various platforms</a>. See next sections and for more details. Additionally, the documentation is also available in <a href="https://github.com/scmrtos/scmrtos-doc/blob/master/scmrtos-en.pdf">PDF format</a>.</p>
<p>Source code can be cloned or downloaded from <a href="https://github.com/scmrtos/scmrtos">Github</a>. There are a <a href="https://github.com/scmrtos/scmrtos-sample-projects">number of sample projects</a> that demonstrates RTOS usage.</p>
<p>Full distribution including RTOS sources, sample projects, documentation, etc available on <a href="https://github.com/scmrtos/scmrtos/releases/">releases page</a>.</p>
<h2 id="features">Features<a class="headerlink" href="#features" title="Permanent link">π</a></h2>
<ul>
<li>
<p>Written entirely on C++.</p>
<ul>
<li>High reliability.</li>
<li>Simplicity and ease-of-use.</li>
</ul>
</li>
<li>
<p>Introduce Extensions mechanism at kernel level.</p>
<ul>
<li>User defined extensions.</li>
<li>Debug features.</li>
</ul>
</li>
<li>
<p>Minimal process switching latency<sup id="fnref:index-1"><a class="footnote-ref" href="#fn:index-1">1</a></sup>.</p>
<ul>
<li>900 ns on Cortex-M4 @ 168 MHz.</li>
<li>1.8 us on Blackfin @ 200 MHz.</li>
<li>2.7 us on Cortex-M3 @ 72 MHz.</li>
<li>700 ns on Cortex-A9 @ 400 MHz (with full FPU context save/restore).</li>
<li>5 us on ARM7 @ 50 MHz.</li>
<li>38-42 us on AVR @ 8 MHz.</li>
<li>45-50 us on MSP430 @ 5 MHz.</li>
<li>18-20 us on STM8 @ 16 MHz.</li>
</ul>
</li>
<li>
<p>Small footprint.</p>
<ul>
<li>From 512 bytes of RAM.</li>
<li>From ~1K code.</li>
</ul>
</li>
</ul>
<h2 id="supported-target-platforms">Supported Target Platforms <span id="index-supported-targets"></span><a class="headerlink" href="#supported-target-platforms" title="Permanent link">π</a></h2>
<p>The following target platforms are supported for now.</p>
<table>
<thead>
<tr>
<th>CPU/MCU</th>
<th style="text-align: center;">GCC</th>
<th style="text-align: center;">EW (IAR)</th>
<th style="text-align: center;">VDSP++ (ADI)</th>
<th style="text-align: center;">CCES (ADI)</th>
</tr>
</thead>
<tbody>
<tr>
<td>MSP430</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
</tr>
<tr>
<td>AVR</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
</tr>
<tr>
<td>ARM7</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
</tr>
<tr>
<td>Cortex-M</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
</tr>
<tr>
<td>Cortex-A</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
</tr>
<tr>
<td>Blackfin</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
</tr>
<tr>
<td>STM8</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
<td style="text-align: center;">β</td>
</tr>
</tbody>
</table>
<p><br>
'β' means toolchain does not support CPU/MCU</p>
<div class="footnote">
<hr>
<ol>
<li id="fn:index-1">
<p>This includes overall control transfer time, not only context switch <a class="footnote-backref" href="#fnref:index-1" title="Jump back to footnote 1 in the text">β©</a></p>
</li>
</ol>
</div>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="preface/" class="btn btn-neutral float-right" title="Preface">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span><a href="preface/" style="color: #fcfcfc">Next Β»</a></span>
</span>
</div>
<script src="js/jquery-3.6.0.min.js"></script>
<script>var base_url = ".";</script>
<script src="js/theme_extra.js"></script>
<script src="js/theme.js"></script>
<script src="extra_js/mathjax.js"></script>
<script src="extra_js/mathjax/tex-mml-chtml.js"></script>
<script src="extra_js/color-symbols.js"></script>
<script src="search/main.js"></script>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<script id="init-glightbox">const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});
</script></body></html>