bedrockRTOS.github.io/index.html at main · bedrockRTOS/bedrockRTOS.github.io · GitHub

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
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>bedrock[RTOS] — Solid Foundation</title>
  <meta name="description" content="A nanokernel real-time operating system written in pure C. Zero dynamic allocation, tickless design, clean hardware separation." />
  <link rel="preconnect" href="https://fonts.googleapis.com" />
  <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
  <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet" />
  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github-dark.min.css" />
  <link rel="stylesheet" href="style.css" />
</head>
<body>

  <!-- Navigation -->
  <header class="header">
    <nav class="nav container">
      <a href="/" class="nav-logo">bedrock<span>[RTOS]</span></a>
      <ul class="nav-links">
        <li><a href="#philosophy">Philosophy</a></li>
        <li><a href="#specs">Specs</a></li>
        <li><a href="#quickstart">Quick Start</a></li>
        <li><a href="#licenses">License</a></li>
        <li><a href="docs/">Docs</a></li>
        <li><a href="https://github.com/bedrockRTOS/bedrock-core" target="_blank" rel="noopener" class="nav-github">GitHub</a></li>
      </ul>
      <button class="hamburger" id="hamburger" aria-label="Toggle menu">
        <span></span><span></span><span></span>
      </button>
    </nav>
  </header>

  <!-- Hero -->
  <section class="hero">
    <div class="container">
      <h1 class="hero-title">bedrock<span>[RTOS]</span></h1>
      <p class="hero-tagline">Solid Foundation</p>
      <p class="hero-description">
        A nanokernel real-time operating system written in pure C (C11/C17).<br />
        <em>When the foundation is solid, you're free to create.</em>
      </p>
      <div class="hero-actions">
        <a href="https://github.com/bedrockRTOS/bedrock-core" target="_blank" rel="noopener" class="btn btn-primary">
          <svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor"><path d="M12 0C5.374 0 0 5.373 0 12c0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23A11.509 11.509 0 0 1 12 5.803c1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576C20.566 21.797 24 17.3 24 12c0-6.627-5.373-12-12-12z"/></svg>
          View on GitHub
        </a>
        <a href="docs/" class="btn btn-secondary">Documentation</a>
      </div>
    </div>
  </section>

  <!-- Philosophy -->
  <section class="section" id="philosophy">
    <div class="container">
      <h2 class="section-title">Philosophy</h2>
      <p class="section-subtitle">Three core principles that guide every design decision</p>
      <div class="cards">
        <div class="card">
          <div class="card-icon">∅</div>
          <h3>Zero Dynamic Allocation</h3>
          <p>The kernel never calls <code>malloc</code>. All objects — tasks, semaphores, mutexes, queues — come from statically-sized pools determined at compile time. Predictable, no fragmentation.</p>
        </div>
        <div class="card">
          <div class="card-icon">⏱</div>
          <h3>Tickless by Design</h3>
          <p>No periodic timer interrupts. The kernel programs one-shot hardware alarms only when needed, minimizing power consumption and interrupt overhead.</p>
        </div>
        <div class="card">
          <div class="card-icon">⊞</div>
          <h3>Clean Separation</h3>
          <p>Hardware details are strictly isolated in <code>/arch</code> and <code>/boards</code>. The kernel source has zero platform-specific code. Adding a new architecture requires zero kernel changes.</p>
        </div>
      </div>
    </div>
  </section>

  <!-- Specs -->
  <section class="section section-alt" id="specs">
    <div class="container">
      <h2 class="section-title">Technical Specs</h2>
      <p class="section-subtitle">Key characteristics at a glance</p>
      <div class="table-wrapper">
        <table class="specs-table">
          <thead>
            <tr><th>Feature</th><th>Details</th></tr>
          </thead>
          <tbody>
            <tr><td>Language</td><td>Pure C (C11/C17)</td></tr>
            <tr><td>Time</td><td>64-bit microseconds (<code>br_time_t = uint64_t</code>), ~584,000 years range</td></tr>
            <tr><td>Scheduler</td><td>Priority-based preemptive + round-robin at equal priority</td></tr>
            <tr><td>Max tasks</td><td>Configurable via <code>CONFIG_MAX_TASKS</code> (default 16)</td></tr>
            <tr><td>Priorities</td><td>Configurable via <code>CONFIG_NUM_PRIORITIES</code> (default 8)</td></tr>
            <tr><td>IPC</td><td>Semaphores, Mutexes (priority inheritance), Message Queues</td></tr>
            <tr><td>Memory</td><td>Zero malloc in kernel; static pools only</td></tr>
            <tr><td>Timer</td><td>Tickless — one-shot alarms via HAL</td></tr>
          </tbody>
        </table>
      </div>
    </div>
  </section>

  <!-- HAL Interface -->
  <section class="section" id="hal">
    <div class="container">
      <h2 class="section-title">HAL Interface</h2>
      <p class="section-subtitle">The kernel accesses hardware exclusively through three timer functions</p>
      <pre><code class="language-c">void      br_hal_timer_init(void);
br_time_t br_hal_timer_get_us(void);
void      br_hal_timer_set_alarm(br_time_t abs_us);</code></pre>
      <p class="hal-note">Plus interrupt control and context switch primitives defined in <code>include/bedrock/br_hal.h</code>. See <a href="docs/porting-guide.html">Porting Guide</a> for the full HAL specification.</p>
    </div>
  </section>

  <!-- Quick Start -->
  <section class="section section-alt" id="quickstart">
    <div class="container">
      <h2 class="section-title">Quick Start</h2>
      <p class="section-subtitle">Get up and running in minutes</p>

      <div class="steps">
        <div class="step">
          <div class="step-num">1</div>
          <div class="step-content">
            <h3>Prerequisites</h3>
            <ul>
              <li><code>arm-none-eabi-gcc</code> toolchain</li>
              <li><code>qemu-system-arm</code> (for Cortex-M3 emulation)</li>
              <li><a href="https://github.com/z3nnix/chorus" target="_blank" rel="noopener">chorus</a> build system (included as <code>3rd/tools/chorus</code>)</li>
            </ul>
          </div>
        </div>

        <div class="step">
          <div class="step-num">2</div>
          <div class="step-content">
            <h3>Clone &amp; Build</h3>
            <pre><code class="language-bash">git clone --recurse-submodules https://github.com/bedrockRTOS/bedrock-core
cd bedrock-core
chorus</code></pre>
          </div>
        </div>

        <div class="step">
          <div class="step-num">3</div>
          <div class="step-content">
            <h3>Run on QEMU</h3>
            <pre><code class="language-bash">qemu-system-arm -M lm3s6965evb -nographic -kernel bedrock_example.elf</code></pre>
          </div>
        </div>

        <div class="step">
          <div class="step-num">4</div>
          <div class="step-content">
            <h3>Configuration</h3>
            <p>Edit <code>Kconfig</code> values or pass them as <code>-D</code> flags in <code>chorus.build</code> CFLAGS.</p>
            <pre><code class="language-bash">chorus clean</code></pre>
          </div>
        </div>
      </div>

      <p class="quickstart-more">For detailed build options and platform-specific setup, see the <a href="docs/building.html">Building guide</a>.</p>
    </div>
  </section>

  <!-- Licenses -->
  <section class="section" id="licenses">
    <div class="container">
      <h2 class="section-title">Multi-License Model</h2>
      <p class="section-subtitle">Per-directory licensing to maximize flexibility</p>
      <div class="table-wrapper">
        <table class="specs-table">
          <thead>
            <tr><th>Directory</th><th>License</th><th>What it means</th></tr>
          </thead>
          <tbody>
            <tr>
              <td><code>/kernel, /arch, /boards, /include</code></td>
              <td><span class="badge badge-blue">BSD 3-Clause</span></td>
              <td>Use freely in any project</td>
            </tr>
            <tr>
              <td><code>/lib</code></td>
              <td><span class="badge badge-green">LGPL 2.1</span></td>
              <td>Link freely, share modifications to lib itself</td>
            </tr>
            <tr>
              <td><code>/examples</code></td>
              <td><span class="badge badge-orange">GPL 3.0</span></td>
              <td>Reference templates, replace with your own code</td>
            </tr>
            <tr>
              <td><code>/docs</code></td>
              <td><span class="badge badge-purple">CC BY-SA 4.0</span></td>
              <td>Share and adapt with attribution</td>
            </tr>
          </tbody>
        </table>
      </div>
    </div>
  </section>

  <!-- Footer -->
  <footer class="footer">
    <div class="container">
      <div class="footer-content">
        <div class="footer-brand">
          <span class="nav-logo">bedrock<span>[RTOS]</span></span>
          <p>A nanokernel RTOS with solid foundations.</p>
        </div>
        <div class="footer-links">
          <a href="https://github.com/bedrockRTOS/bedrock-core" target="_blank" rel="noopener">GitHub</a>
          <a href="docs/">Docs</a>
          <a href="https://github.com/bedrockRTOS/bedrock-core/blob/main/CONTRIBUTING.md" target="_blank" rel="noopener">Contributing</a>
        </div>
      </div>
      <div class="footer-bottom">
        <p>Author: <strong>AnmiTaliDev</strong> &lt;<a href="mailto:anmitalidev@nuros.org">anmitalidev@nuros.org</a>&gt; · <a href="https://www.gnu.org/licenses/agpl-3.0.html" target="_blank" rel="noopener">AGPL-3.0</a></p>
      </div>
    </div>
  </footer>

  <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
  <script src="script.js"></script>
</body>
</html>