Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix casing #216

Merged
merged 2 commits into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions building/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,64 +6,64 @@ The project consists of the following GitHub submodule repositories.

- [libphoenix](https://github.com/phoenix-rtos/libphoenix.git)

Standard C library. Written from scratch for Phoenix-RTOS
Standard C library. Written from scratch for Phoenix-RTOS.

- [phoenix-rtos-build](https://github.com/phoenix-rtos/phoenix-rtos-build.git)

Building scripts, makefile templates, rules, flags definitions, target selection and
toolchain
toolchain.
- [phoenix-rtos-corelibs](https://github.com/phoenix-rtos/phoenix-rtos-corelibs.git)

Libraries for use in user space.

- [Phoenix-rtos-devices](https://github.com/phoenix-rtos/phoenix-rtos-devices.git)
- [phoenix-rtos-devices](https://github.com/phoenix-rtos/phoenix-rtos-devices.git)

Hardware drivers
Hardware drivers.

- [phoenix-rtos-doc](https://github.com/phoenix-rtos/phoenix-rtos-doc.git)

Documentation
Documentation.

- [phoenix-rtos-filesystems](https://github.com/phoenix-rtos/phoenix-rtos-filesystems.git)

Filesystem drivers.

- [Phoenix-rtos-hostutils](https://github.com/phoenix-rtos/phoenix-rtos-hostutils.git)
- [phoenix-rtos-hostutils](https://github.com/phoenix-rtos/phoenix-rtos-hostutils.git)

Utilities for development PC (e.g. a tool for transferring system binary image to the
target)
target).
- [phoenix-rtos-kernel](https://github.com/phoenix-rtos/phoenix-rtos-kernel.git)

Microkernel repository
Microkernel repository.

- [phoenix-rtos-lwip](https://github.com/phoenix-rtos/phoenix-rtos-lwip.git)

LwIP network stack
LwIP network stack.

- [phoenix-rtos-ports](https://github.com/phoenix-rtos/phoenix-rtos-ports.git)

Linux (and potentially other OSes) applications ported to Phoenix-RTOS
Linux (and potentially other OSes) applications ported to Phoenix-RTOS.

- [phoenix-rtos-posixsrv](https://github.com/phoenix-rtos/phoenix-rtos-posixsrv.git)

POSIX server; user space server that is providing additional POSIX features not
provided by the kernel itself (e.g.
pipes)
pipes).
- [phoenix-rtos-tests](https://github.com/phoenix-rtos/phoenix-rtos-tests.git)

Tests based on our own framework
Tests based on our own framework.

- [phoenix-rtos-usb](https://github.com/phoenix-rtos/phoenix-rtos-usb.git)

USB stack (both host and device)
USB stack (both host and device).

- [phoenix-rtos-utils](https://github.com/phoenix-rtos/phoenix-rtos-utils.git)

System utilities (e.g. native shell psh)
System utilities (e.g. native shell psh).

- [plo](https://github.com/phoenix-rtos/plo.git)

Phoenix-RTOS bootloader
Phoenix-RTOS bootloader.

There are other directories and files directly in `phoenix-rtos-project`.

Expand Down
5 changes: 3 additions & 2 deletions devices/libsdio.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Libsdio
# libsdio

## General description

Libsdio is a static, precompiled library containing a generic SDIO driver which directly controls the platform hardware.
`libsdio` is a static, precompiled library containing a generic SDIO driver
which directly controls the platform hardware.
This driver defines an API providing basic interface control functionality.

## Platform support
Expand Down
18 changes: 9 additions & 9 deletions kernel/hal/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ changed when the kernel is ported to the new hardware architecture.

HAL implements the following functionalities:

* Kernel initialization,
* Basic type definitions,
* Definition of syspage structure,
* Basic synchronization (spinlocks),
* Kernel console,
* String functions (memcpy, memset),
* Exception and interrupt handling,
* kernel initialization,
* basic type definitions,
* definition of syspage structure,
* basic synchronization (spinlocks),
* kernel console,
* string functions (memcpy, memset),
* exception and interrupt handling,
* MMU or MPU management,
* Timer support,
* Context switching.
* timer support,
* context switching.

These functionalities are briefly discussed in this chapter.

Expand Down
10 changes: 5 additions & 5 deletions kernel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ Microkernel is responsible for:

Kernel is divided into five subsystems.

* Hal - hardware abstraction layer
* Lib - common routines
* Vm - virtual memory management
* Proc - process and thread management
* Test - internal tests for kernel subsystems
* hal - hardware abstraction layer
* lib - common routines
* vm - virtual memory management
* proc - process and thread management
* test - internal tests for kernel subsystems

## Kernel source code

Expand Down
12 changes: 6 additions & 6 deletions kernel/proc/scheduler.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ the same priority. A scheduling algorithm is defined as follows:
If a selected thread is a ghost (a thread whose process has ended execution) and has not been executed in a supervisor
mode, it is added to the ghosts list and the reaper thread woke up.
4. For the selected thread, the following actions are performed:
* A global pointer to the current thread is changed to the selected one,
* A pointer to the kernel stack is updated to the stack of a new thread,
* A memory map is changed to the map associated with the thread's process,
* Signal handlers are performed,
* Performance data is saved in a perf unit,
* In the `hal_cpuRestore` pointer to the stack in a context of current thread is updated with a pointer to the stack
* a global pointer to the current thread is changed to the selected one,
* a pointer to the kernel stack is updated to the stack of a new thread,
* a memory map is changed to the map associated with the thread's process,
* signal handlers are performed,
* performance data is saved in a perf unit,
* in the `hal_cpuRestore` pointer to the stack in a context of current thread is updated with a pointer to the stack
of selected thread. When the scheduler finishes work, the context of selected thread restore is performed.
5. The CPU usage is updated for the current and selected thread.
6. At the end of the modification of the `threads_common.spinlock` is cleared.
Expand Down
10 changes: 5 additions & 5 deletions kernel/vm/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,11 +135,11 @@ replaced with paging.

Memory management subsystem provides following functionalities:

* Physical memory allocation,
* Address space allocation (inside memory regions),
* Linear addresses to physical addresses mapping (when paging is available),
* Dynamic, fine-grained kernel memory allocation,
* Objects memory mapping and memory sharing.
* physical memory allocation,
* address space allocation (inside memory regions),
* linear addresses to physical addresses mapping (when paging is available),
* dynamic, fine-grained kernel memory allocation,
* objects memory mapping and memory sharing.

These functions will be briefly discussed and elaborated more in the particular chapters.

Expand Down
2 changes: 1 addition & 1 deletion libc/functions/stdio/rewind.part-impl.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ shall be equivalent to:

`(void) fseek(stream, 0L, SEEK_SET)`

Except that `rewind()` shall also clear the error indicator.
except that `rewind()` shall also clear the error indicator.

Since `rewind()` does not return a value, an application wishing to detect errors should clear `errno`, then call
`rewind()`, and if `errno` is non-zero, assume an error has occurred.
Expand Down
2 changes: 1 addition & 1 deletion libc/functions/stdlib/atoi.part-impl.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The purpose is to convert a string to an integer. The call `atoi(str)` shall be

`(int) strtol(str, (char **)NULL, 10)`

Except that the handling of errors may differ. If the value cannot be represented, the behavior is undefined.
except that the handling of errors may differ. If the value cannot be represented, the behavior is undefined.

## Return value

Expand Down
Loading