| 1 | /*
|
|---|
| 2 | * SPDX-FileCopyrightText: 2022 HelenOS Project
|
|---|
| 3 | * SPDX-License-Identifier: CC0-1.0
|
|---|
| 4 | */
|
|---|
| 5 | /* Definitions of modules and its relations for generating Doxygen documentation */
|
|---|
| 6 |
|
|---|
| 7 | /** @defgroup kernel kernel
|
|---|
| 8 | * @brief HelenOS kernel
|
|---|
| 9 | */
|
|---|
| 10 |
|
|---|
| 11 | /** @defgroup kernel_generic_adt Data types
|
|---|
| 12 | * @ingroup kernel
|
|---|
| 13 | */
|
|---|
| 14 |
|
|---|
| 15 | /** @defgroup kernel_generic_console Kernel console
|
|---|
| 16 | * @ingroup others
|
|---|
| 17 | */
|
|---|
| 18 |
|
|---|
| 19 | /** @defgroup kernel_time Time management
|
|---|
| 20 | * @ingroup kernel
|
|---|
| 21 | */
|
|---|
| 22 |
|
|---|
| 23 | /** @defgroup proc Scheduling
|
|---|
| 24 | * @ingroup kernel
|
|---|
| 25 | */
|
|---|
| 26 |
|
|---|
| 27 | /** @defgroup kernel_generic_proc generic
|
|---|
| 28 | * @ingroup proc
|
|---|
| 29 | */
|
|---|
| 30 |
|
|---|
| 31 | /**
|
|---|
| 32 | * @cond abs32le
|
|---|
| 33 | * @defgroup kernel_abs32le_proc abs32le
|
|---|
| 34 | * @ingroup proc
|
|---|
| 35 | * @endcond
|
|---|
| 36 | */
|
|---|
| 37 |
|
|---|
| 38 | /**
|
|---|
| 39 | * @cond amd64
|
|---|
| 40 | * @defgroup kernel_amd64_proc amd64
|
|---|
| 41 | * @ingroup proc
|
|---|
| 42 | * @endcond
|
|---|
| 43 | */
|
|---|
| 44 |
|
|---|
| 45 | /**
|
|---|
| 46 | * @cond arm32
|
|---|
| 47 | * @defgroup kernel_arm32_proc arm32
|
|---|
| 48 | * @ingroup proc
|
|---|
| 49 | * @endcond
|
|---|
| 50 | */
|
|---|
| 51 |
|
|---|
| 52 | /**
|
|---|
| 53 | * @cond arm64
|
|---|
| 54 | * @defgroup kernel_arm64_proc arm64
|
|---|
| 55 | * @ingroup proc
|
|---|
| 56 | * @endcond
|
|---|
| 57 | */
|
|---|
| 58 |
|
|---|
| 59 | /**
|
|---|
| 60 | * @cond ia32
|
|---|
| 61 | * @defgroup kernel_ia32_proc ia32
|
|---|
| 62 | * @ingroup proc
|
|---|
| 63 | * @endcond
|
|---|
| 64 | */
|
|---|
| 65 |
|
|---|
| 66 | /**
|
|---|
| 67 | * @cond ia64
|
|---|
| 68 | * @defgroup kernel_ia64_proc ia64
|
|---|
| 69 | * @ingroup proc
|
|---|
| 70 | * @endcond
|
|---|
| 71 | */
|
|---|
| 72 |
|
|---|
| 73 | /**
|
|---|
| 74 | * @cond mips32
|
|---|
| 75 | * @defgroup kernel_mips32_proc mips32
|
|---|
| 76 | * @ingroup proc
|
|---|
| 77 | * @endcond
|
|---|
| 78 | */
|
|---|
| 79 |
|
|---|
| 80 | /**
|
|---|
| 81 | * @cond ppc32
|
|---|
| 82 | * @defgroup kernel_ppc32_proc ppc32
|
|---|
| 83 | * @ingroup proc
|
|---|
| 84 | * @endcond
|
|---|
| 85 | */
|
|---|
| 86 |
|
|---|
| 87 | /**
|
|---|
| 88 | * @cond riscv64
|
|---|
| 89 | * @defgroup kernel_riscv64_proc riscv64
|
|---|
| 90 | * @ingroup proc
|
|---|
| 91 | * @endcond
|
|---|
| 92 | */
|
|---|
| 93 |
|
|---|
| 94 | /**
|
|---|
| 95 | * @cond sparc64
|
|---|
| 96 | * @defgroup kernel_sparc64_proc sparc64
|
|---|
| 97 | * @ingroup proc
|
|---|
| 98 | * @endcond
|
|---|
| 99 | */
|
|---|
| 100 |
|
|---|
| 101 | /** @defgroup kernel_sync Synchronization
|
|---|
| 102 | * @ingroup kernel
|
|---|
| 103 | */
|
|---|
| 104 |
|
|---|
| 105 | /** @defgroup mm Memory management
|
|---|
| 106 | * @ingroup kernel
|
|---|
| 107 | */
|
|---|
| 108 |
|
|---|
| 109 | /**
|
|---|
| 110 | * @defgroup kernel_generic_mm generic
|
|---|
| 111 | * @ingroup mm
|
|---|
| 112 | */
|
|---|
| 113 |
|
|---|
| 114 | /**
|
|---|
| 115 | * @defgroup kernel_genarch_mm genarch
|
|---|
| 116 | * @ingroup mm
|
|---|
| 117 | */
|
|---|
| 118 |
|
|---|
| 119 | /**
|
|---|
| 120 | * @cond abs32le
|
|---|
| 121 | * @defgroup kernel_abs32le_mm abs32le
|
|---|
| 122 | * @ingroup mm
|
|---|
| 123 | * @endcond
|
|---|
| 124 | */
|
|---|
| 125 |
|
|---|
| 126 | /**
|
|---|
| 127 | * @cond amd64
|
|---|
| 128 | * @defgroup kernel_amd64_mm amd64
|
|---|
| 129 | * @ingroup mm
|
|---|
| 130 | * @endcond
|
|---|
| 131 | */
|
|---|
| 132 |
|
|---|
| 133 | /**
|
|---|
| 134 | * @cond arm32
|
|---|
| 135 | * @defgroup kernel_arm32_mm arm32
|
|---|
| 136 | * @ingroup mm
|
|---|
| 137 | * @endcond
|
|---|
| 138 | */
|
|---|
| 139 |
|
|---|
| 140 | /**
|
|---|
| 141 | * @cond arm64
|
|---|
| 142 | * @defgroup kernel_arm64_mm arm64
|
|---|
| 143 | * @ingroup mm
|
|---|
| 144 | * @endcond
|
|---|
| 145 | */
|
|---|
| 146 |
|
|---|
| 147 | /**
|
|---|
| 148 | * @cond ia32
|
|---|
| 149 | * @defgroup kernel_ia32_mm ia32
|
|---|
| 150 | * @ingroup mm
|
|---|
| 151 | * @endcond
|
|---|
| 152 | */
|
|---|
| 153 |
|
|---|
| 154 | /**
|
|---|
| 155 | * @cond ia64
|
|---|
| 156 | * @defgroup kernel_ia64_mm ia64
|
|---|
| 157 | * @ingroup mm
|
|---|
| 158 | * @endcond
|
|---|
| 159 | */
|
|---|
| 160 |
|
|---|
| 161 | /**
|
|---|
| 162 | * @cond mips32
|
|---|
| 163 | * @defgroup kernel_mips32_mm mips32
|
|---|
| 164 | * @ingroup mm
|
|---|
| 165 | * @endcond
|
|---|
| 166 | */
|
|---|
| 167 |
|
|---|
| 168 | /**
|
|---|
| 169 | * @cond ppc32
|
|---|
| 170 | * @defgroup kernel_ppc32_mm ppc32
|
|---|
| 171 | * @ingroup mm
|
|---|
| 172 | * @endcond
|
|---|
| 173 | */
|
|---|
| 174 |
|
|---|
| 175 | /**
|
|---|
| 176 | * @cond riscv64
|
|---|
| 177 | * @defgroup kernel_riscv64_mm riscv64
|
|---|
| 178 | * @ingroup mm
|
|---|
| 179 | * @endcond
|
|---|
| 180 | */
|
|---|
| 181 |
|
|---|
| 182 | /**
|
|---|
| 183 | * @cond sparc64
|
|---|
| 184 | * @defgroup kernel_sparc64_mm sparc64
|
|---|
| 185 | * @ingroup mm
|
|---|
| 186 | * @endcond
|
|---|
| 187 | */
|
|---|
| 188 |
|
|---|
| 189 | /** @defgroup kernel_generic_ipc IPC
|
|---|
| 190 | * @ingroup kernel
|
|---|
| 191 | */
|
|---|
| 192 |
|
|---|
| 193 | /** @defgroup kernel_generic_kio KIO
|
|---|
| 194 | * @brief Kernel character input/output facility
|
|---|
| 195 | * @ingroup kernel_generic_console
|
|---|
| 196 | */
|
|---|
| 197 |
|
|---|
| 198 | /** @defgroup ddi Device Driver Interface
|
|---|
| 199 | * @ingroup kernel
|
|---|
| 200 | */
|
|---|
| 201 |
|
|---|
| 202 | /**
|
|---|
| 203 | * @defgroup kernel_generic_ddi generic
|
|---|
| 204 | * @ingroup ddi
|
|---|
| 205 | */
|
|---|
| 206 |
|
|---|
| 207 | /**
|
|---|
| 208 | * @cond abs32le
|
|---|
| 209 | * @defgroup kernel_abs32le_ddi abs32le
|
|---|
| 210 | * @ingroup ddi
|
|---|
| 211 | * @endcond
|
|---|
| 212 | */
|
|---|
| 213 |
|
|---|
| 214 | /**
|
|---|
| 215 | * @cond amd64
|
|---|
| 216 | * @defgroup kernel_amd64_ddi amd64
|
|---|
| 217 | * @ingroup ddi
|
|---|
| 218 | * @endcond
|
|---|
| 219 | */
|
|---|
| 220 |
|
|---|
| 221 | /**
|
|---|
| 222 | * @cond arm32
|
|---|
| 223 | * @defgroup kernel_arm32_ddi arm32
|
|---|
| 224 | * @ingroup ddi
|
|---|
| 225 | * @endcond
|
|---|
| 226 | */
|
|---|
| 227 |
|
|---|
| 228 | /**
|
|---|
| 229 | * @cond arm64
|
|---|
| 230 | * @defgroup kernel_arm64_ddi arm64
|
|---|
| 231 | * @ingroup ddi
|
|---|
| 232 | * @endcond
|
|---|
| 233 | */
|
|---|
| 234 |
|
|---|
| 235 | /**
|
|---|
| 236 | * @cond ia32
|
|---|
| 237 | * @defgroup kernel_ia32_ddi ia32
|
|---|
| 238 | * @ingroup ddi
|
|---|
| 239 | * @endcond
|
|---|
| 240 | */
|
|---|
| 241 |
|
|---|
| 242 | /**
|
|---|
| 243 | * @cond ia64
|
|---|
| 244 | * @defgroup kernel_ia64_ddi ia64
|
|---|
| 245 | * @ingroup ddi
|
|---|
| 246 | * @endcond
|
|---|
| 247 | */
|
|---|
| 248 |
|
|---|
| 249 | /**
|
|---|
| 250 | * @cond mips32
|
|---|
| 251 | * @defgroup kernel_mips32_ddi mips32
|
|---|
| 252 | * @ingroup ddi
|
|---|
| 253 | * @endcond
|
|---|
| 254 | */
|
|---|
| 255 |
|
|---|
| 256 | /**
|
|---|
| 257 | * @cond ppc32
|
|---|
| 258 | * @defgroup kernel_ppc32_ddi ppc32
|
|---|
| 259 | * @ingroup ddi
|
|---|
| 260 | * @endcond
|
|---|
| 261 | */
|
|---|
| 262 |
|
|---|
| 263 | /**
|
|---|
| 264 | * @cond riscv64
|
|---|
| 265 | * @defgroup kernel_riscv64_ddi riscv64
|
|---|
| 266 | * @ingroup ddi
|
|---|
| 267 | * @endcond
|
|---|
| 268 | */
|
|---|
| 269 |
|
|---|
| 270 | /**
|
|---|
| 271 | * @cond sparc64
|
|---|
| 272 | * @defgroup kernel_sparc64_ddi sparc64
|
|---|
| 273 | * @ingroup ddi
|
|---|
| 274 | * @endcond
|
|---|
| 275 | */
|
|---|
| 276 |
|
|---|
| 277 | /** @defgroup debug Debugging
|
|---|
| 278 | * @ingroup others
|
|---|
| 279 | */
|
|---|
| 280 |
|
|---|
| 281 | /**
|
|---|
| 282 | * @defgroup kernel_generic_debug generic
|
|---|
| 283 | * @ingroup debug
|
|---|
| 284 | */
|
|---|
| 285 |
|
|---|
| 286 | /**
|
|---|
| 287 | * @cond abs32le
|
|---|
| 288 | * @defgroup kernel_abs32le_debug abs32le
|
|---|
| 289 | * @ingroup debug
|
|---|
| 290 | * @endcond
|
|---|
| 291 | */
|
|---|
| 292 |
|
|---|
| 293 | /**
|
|---|
| 294 | * @cond amd64
|
|---|
| 295 | * @defgroup kernel_amd64_debug ia32/amd64
|
|---|
| 296 | * @ingroup debug
|
|---|
| 297 | * @endcond
|
|---|
| 298 | */
|
|---|
| 299 |
|
|---|
| 300 | /**
|
|---|
| 301 | * @cond arm32
|
|---|
| 302 | * @defgroup kernel_arm32_debug arm32
|
|---|
| 303 | * @ingroup debug
|
|---|
| 304 | * @endcond
|
|---|
| 305 | */
|
|---|
| 306 |
|
|---|
| 307 | /**
|
|---|
| 308 | * @cond arm64
|
|---|
| 309 | * @defgroup kernel_arm64_debug arm64
|
|---|
| 310 | * @ingroup debug
|
|---|
| 311 | * @endcond
|
|---|
| 312 | */
|
|---|
| 313 |
|
|---|
| 314 | /**
|
|---|
| 315 | * @cond ia32
|
|---|
| 316 | * @defgroup kernel_amd64_debug ia32/amd64
|
|---|
| 317 | * @ingroup debug
|
|---|
| 318 | * @endcond
|
|---|
| 319 | */
|
|---|
| 320 |
|
|---|
| 321 | /**
|
|---|
| 322 | * @cond ia64
|
|---|
| 323 | * @defgroup kernel_ia64_debug ia64
|
|---|
| 324 | * @ingroup debug
|
|---|
| 325 | * @endcond
|
|---|
| 326 | */
|
|---|
| 327 |
|
|---|
| 328 | /**
|
|---|
| 329 | * @cond mips32
|
|---|
| 330 | * @defgroup kernel_mips32_debug mips32
|
|---|
| 331 | * @ingroup debug
|
|---|
| 332 | * @endcond
|
|---|
| 333 | */
|
|---|
| 334 |
|
|---|
| 335 | /**
|
|---|
| 336 | * @cond ppc32
|
|---|
| 337 | * @defgroup kernel_ppc32_debug ppc32
|
|---|
| 338 | * @ingroup debug
|
|---|
| 339 | * @endcond
|
|---|
| 340 | */
|
|---|
| 341 |
|
|---|
| 342 | /**
|
|---|
| 343 | * @cond riscv64
|
|---|
| 344 | * @defgroup kernel_riscv64_debug riscv64
|
|---|
| 345 | * @ingroup debug
|
|---|
| 346 | * @endcond
|
|---|
| 347 | */
|
|---|
| 348 |
|
|---|
| 349 | /**
|
|---|
| 350 | * @cond sparc64
|
|---|
| 351 | * @defgroup kernel_sparc64_debug sparc64
|
|---|
| 352 | * @ingroup debug
|
|---|
| 353 | * @endcond
|
|---|
| 354 | */
|
|---|
| 355 |
|
|---|
| 356 | /** @defgroup interrupt Interrupt handling and dispatching
|
|---|
| 357 | * @ingroup kernel
|
|---|
| 358 | */
|
|---|
| 359 | /**
|
|---|
| 360 | * @defgroup kernel_generic_interrupt generic
|
|---|
| 361 | * @ingroup interrupt
|
|---|
| 362 | */
|
|---|
| 363 |
|
|---|
| 364 | /**
|
|---|
| 365 | * @cond abs32le
|
|---|
| 366 | * @defgroup kernel_abs32le_interrupt abs32le
|
|---|
| 367 | * @ingroup interrupt
|
|---|
| 368 | * @endcond
|
|---|
| 369 | */
|
|---|
| 370 |
|
|---|
| 371 | /**
|
|---|
| 372 | * @cond amd64
|
|---|
| 373 | * @defgroup kernel_amd64_interrupt amd64
|
|---|
| 374 | * @ingroup interrupt
|
|---|
| 375 | * @endcond
|
|---|
| 376 | */
|
|---|
| 377 |
|
|---|
| 378 | /**
|
|---|
| 379 | * @cond arm32
|
|---|
| 380 | * @defgroup kernel_arm32_interrupt arm32
|
|---|
| 381 | * @ingroup interrupt
|
|---|
| 382 | * @endcond
|
|---|
| 383 | */
|
|---|
| 384 |
|
|---|
| 385 | /**
|
|---|
| 386 | * @cond arm64
|
|---|
| 387 | * @defgroup kernel_arm64_interrupt arm64
|
|---|
| 388 | * @ingroup interrupt
|
|---|
| 389 | * @endcond
|
|---|
| 390 | */
|
|---|
| 391 |
|
|---|
| 392 | /**
|
|---|
| 393 | * @cond ia32
|
|---|
| 394 | * @defgroup kernel_ia32_interrupt ia32
|
|---|
| 395 | * @ingroup interrupt
|
|---|
| 396 | * @endcond
|
|---|
| 397 | */
|
|---|
| 398 |
|
|---|
| 399 | /**
|
|---|
| 400 | * @cond ia64
|
|---|
| 401 | * @defgroup kernel_ia64_interrupt ia64
|
|---|
| 402 | * @ingroup interrupt
|
|---|
| 403 | * @endcond
|
|---|
| 404 | */
|
|---|
| 405 |
|
|---|
| 406 | /**
|
|---|
| 407 | * @cond mips32
|
|---|
| 408 | * @defgroup kernel_mips32_interrupt mips32
|
|---|
| 409 | * @ingroup interrupt
|
|---|
| 410 | * @endcond
|
|---|
| 411 | */
|
|---|
| 412 |
|
|---|
| 413 | /**
|
|---|
| 414 | * @cond ppc32
|
|---|
| 415 | * @defgroup kernel_ppc32_interrupt ppc32
|
|---|
| 416 | * @ingroup interrupt
|
|---|
| 417 | * @endcond
|
|---|
| 418 | */
|
|---|
| 419 |
|
|---|
| 420 | /**
|
|---|
| 421 | * @cond riscv64
|
|---|
| 422 | * @defgroup kernel_riscv64_interrupt riscv64
|
|---|
| 423 | * @ingroup interrupt
|
|---|
| 424 | * @endcond
|
|---|
| 425 | */
|
|---|
| 426 |
|
|---|
| 427 | /**
|
|---|
| 428 | * @cond sparc64
|
|---|
| 429 | * @defgroup kernel_sparc64_interrupt sparc64
|
|---|
| 430 | * @ingroup interrupt
|
|---|
| 431 | * @endcond
|
|---|
| 432 | */
|
|---|
| 433 |
|
|---|
| 434 | /** @defgroup others Miscellanea
|
|---|
| 435 | * @ingroup kernel
|
|---|
| 436 | */
|
|---|
| 437 |
|
|---|
| 438 | /**
|
|---|
| 439 | * @defgroup kernel_generic generic
|
|---|
| 440 | * @ingroup others
|
|---|
| 441 | */
|
|---|
| 442 |
|
|---|
| 443 | /**
|
|---|
| 444 | * @defgroup kernel_genarch genarch
|
|---|
| 445 | * @ingroup others
|
|---|
| 446 | */
|
|---|
| 447 |
|
|---|
| 448 | /**
|
|---|
| 449 | * @cond abs32le
|
|---|
| 450 | * @defgroup kernel_abs32le abs32le
|
|---|
| 451 | * @ingroup others
|
|---|
| 452 | * @endcond
|
|---|
| 453 | */
|
|---|
| 454 |
|
|---|
| 455 | /**
|
|---|
| 456 | * @cond amd64
|
|---|
| 457 | * @defgroup kernel_amd64 amd64
|
|---|
| 458 | * @ingroup others
|
|---|
| 459 | * @endcond
|
|---|
| 460 | */
|
|---|
| 461 |
|
|---|
| 462 | /**
|
|---|
| 463 | * @cond arm32
|
|---|
| 464 | * @defgroup kernel_arm32 arm32
|
|---|
| 465 | * @ingroup others
|
|---|
| 466 | * @endcond
|
|---|
| 467 | */
|
|---|
| 468 |
|
|---|
| 469 | /**
|
|---|
| 470 | * @cond arm64
|
|---|
| 471 | * @defgroup kernel_arm64 arm64
|
|---|
| 472 | * @ingroup others
|
|---|
| 473 | * @endcond
|
|---|
| 474 | */
|
|---|
| 475 |
|
|---|
| 476 | /**
|
|---|
| 477 | * @cond ia32
|
|---|
| 478 | * @defgroup kernel_ia32 ia32
|
|---|
| 479 | * @ingroup others
|
|---|
| 480 | * @endcond
|
|---|
| 481 | */
|
|---|
| 482 |
|
|---|
| 483 | /**
|
|---|
| 484 | * @cond ia64
|
|---|
| 485 | * @defgroup kernel_ia64 ia64
|
|---|
| 486 | * @ingroup others
|
|---|
| 487 | * @endcond
|
|---|
| 488 | */
|
|---|
| 489 |
|
|---|
| 490 | /**
|
|---|
| 491 | * @cond mips32
|
|---|
| 492 | * @defgroup kernel_mips32 mips32
|
|---|
| 493 | * @ingroup others
|
|---|
| 494 | * @endcond
|
|---|
| 495 | */
|
|---|
| 496 |
|
|---|
| 497 | /**
|
|---|
| 498 | * @cond ppc32
|
|---|
| 499 | * @defgroup kernel_ppc32 ppc32
|
|---|
| 500 | * @ingroup others
|
|---|
| 501 | * @endcond
|
|---|
| 502 | */
|
|---|
| 503 |
|
|---|
| 504 | /**
|
|---|
| 505 | * @cond riscv64
|
|---|
| 506 | * @defgroup kernel_riscv64 riscv64
|
|---|
| 507 | * @ingroup others
|
|---|
| 508 | * @endcond
|
|---|
| 509 | */
|
|---|
| 510 |
|
|---|
| 511 | /**
|
|---|
| 512 | * @cond sparc64
|
|---|
| 513 | * @defgroup kernel_sparc64 sparc64
|
|---|
| 514 | * @ingroup others
|
|---|
| 515 | * @endcond
|
|---|
| 516 | */
|
|---|
