mirrors/unleashed-firmware
1
Fork 0
mirror of https://github.com/DarkFlippers/unleashed-firmware.git synced 2025-12-12 04:34:43 +04:00
Code Issues Activity

Documentation: update and cleanup (#3934)

Browse Source 
* Developers Docs editing

* Logo underline removed

The underline has been removed when hovering over the logo.

* proofread docs

* application -> app in several files

---------

Co-authored-by: knrn64 <25254561+knrn64@users.noreply.github.com>
Co-authored-by: あく <alleteam@gmail.com>
This commit is contained in:
Ruslan Nadyrshin
2024-10-08 15:27:16 +04:00
committed by GitHub
parent 0eaad8bf64
commit 41c35cd59e
33 changed files with 247 additions and 228 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
documentation/FuriHalBus.md
View File

@@ -5,7 +5,7 @@
On system startup, most of the peripheral devices are under reset and not clocked by default. This is done to reduce power consumption and to guarantee that the device will always be in the same state before use.
Some crucial peripherals are enabled right away by the system, others must be explicitly enabled by the user code.
**NOTE:** Here and afterwards the word *"system"* refers to any code belonging to the operating system, hardware drivers or built-in applications.
**NOTE:** Here and afterwards, the word *"system"* refers to any code belonging to the operating system, hardware drivers or built-in apps.
To **ENABLE** a peripheral, call `furi_hal_bus_enable()`. At the time of the call, the peripheral in question MUST be disabled, otherwise a crash will occur to indicate improper use. This means that any given peripheral cannot be enabled twice or more without disabling it first.
@@ -24,7 +24,7 @@ Built-in peripherals are divided into three categories:
Below is the list of peripherals that are enabled by the system. The user code must NEVER attempt to disable them. If a corresponding API is provided, the user code must employ it in order to access the peripheral.
*Table 1* - Peripherals enabled by the system
*Table 1* — Peripherals enabled by the system
| Peripheral | Enabled at |
| :-----------: | :-----------------------: |
@@ -49,7 +49,7 @@ Below is the list of peripherals that are enabled and disabled by the system. Th
When not using the API, these peripherals MUST be enabled by the user code and then disabled when not needed anymore.
*Table 2* - Peripherals enabled and disabled by the system
*Table 2* — Peripherals enabled and disabled by the system
| Peripheral | API header file |
| :-----------: | :-------------------: |
@@ -69,7 +69,7 @@ Below is the list of peripherals that are not enabled by default and MUST be ena
Note that some of these peripherals may also be used by the system to implement its certain features.
The system will take over any given peripheral only when the respective feature is in use.
*Table 3* - Peripherals enabled and disabled by user
*Table 3* — Peripherals enabled and disabled by user
| Peripheral | System | Purpose |
| :-----------: | :-------: | ------------------------------------- |
@@ -93,7 +93,7 @@ The DMA1,2 peripherals are a special case in that they have multiple independent
Below is the list of DMA channels and their usage by the system.
*Table 4* - DMA channels
*Table 4* — DMA channels
| DMA | Channel | System | Purpose |
| :---: | :-------: | :-------: | ------------------------- |