Skip to content

Commit

Permalink
[ext] Update CMSIS module docs
Browse files Browse the repository at this point in the history
  • Loading branch information
calebchalmers committed Aug 18, 2024
1 parent e93be4b commit ab80031
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
4 changes: 2 additions & 2 deletions ext/arm/cmsis.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ We use only use these parts of CMSIS:
via CMSIS-CORE.
- The `modm:cmsis:device` module provides access to the peripherals of the
`modm:target` devices via the vendor's CMSIS implementation.
- The `modm:cmsis:dsp` module provides a basic digital signal processing library
via CMSIS-DSP.
- The `modm:cmsis:dsp` module provides an optimized compute library via
CMSIS-DSP.

[cmsis]: https://developer.arm.com/embedded/cmsis
[overview]: https://developer.arm.com/-/media/Arm%20Developer%20Community/Images/Block%20Diagrams/Cortex%20Microcontroller%20Software%20Interface%20Standard%20-%20CMSIS/CMSIS%20Diagram%20v2.png
14 changes: 8 additions & 6 deletions ext/arm/dsp.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,20 @@
This module provides the CMSIS-DSP library.
Please [see the API documentation][docs] for details.

Note that this module splits up the library into submodule to speed up
Note:
- The library should be accessed through the `arm_math.h` and `arm_math_f16.h`
headers, as these include necessary configuration options.
- This module splits up the library into submodules to speed up
compilation by only including the math functions you really need.
You can enable 16-bit floating point support separately via option.
- You can enable 16-bit floating point support via the option `with_f16`.


## Configuration

You can define your own configuration in the `<arm_math_local.h>` file which
will automatically be included at the *beginning* of the `arm_math_types.h` file
which is included by all CMSIS-DSP source files. This way changes to your
CMSIS-DSP configuration will only affect its source files and not recompile your
whole project.
will automatically be included at the *beginning* of the `arm_math.h` and
`arm_math_f16.h` files. This way changes to your CMSIS-DSP configuration will
only affect its source files and not recompile your whole project.

Example `<arm_math_local.h>` configuration:

Expand Down

0 comments on commit ab80031

Please sign in to comment.