Skip to content

Commit f02cbcd

Browse files
Update links to lib_xcore_math documentation
1 parent 6c9a6c3 commit f02cbcd

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

‎doc/rst/src/custom_filters.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ to convert floating-point coefficients to the required format.
184184

185185
If a second stage is included, it must meet these requirements:
186186

187-
- Implementation: Must be compatible with the 32-bit FIR filter from `lib_xcore_math <https://github.com/xmos/lib_xcore_math>`_,
187+
- Implementation: Must be compatible with the 32-bit FIR filter from `lib_xcore_math <www.xmos.com/libraries/lib_xcore_math>`_,
188188
specifically :c:func:`xs3_filter_fir_s32()` as described in :ref:`stage_2_filter_impl`
189189
- Tap count: Configurable (no fixed constraint)
190190
- Decimation factor: Configurable integer value
@@ -193,7 +193,7 @@ Use the Python helper script ``python/stage2.py`` to convert floating-point coef
193193

194194
**Stage 3 (optional)**
195195

196-
A third stage, if included, must also be compatible with the 32-bit FIR filter from `lib_xcore_math <https://github.com/xmos/lib_xcore_math>`_.
196+
A third stage, if included, must also be compatible with the 32-bit FIR filter from `lib_xcore_math <www.xmos.com/libraries/lib_xcore_math>`_.
197197
It has the same flexibility as stage 2:
198198

199199
- Tap count: Configurable

‎doc/rst/src/decimator_stages.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ to convert a high sample rate stream of (1-bit) PDM samples into a lower sample
1010
rate stream of (32-bit) PCM samples.
1111

1212
The default and most widely used configuration is a two-stage decimation
13-
pipeline, and that two-stage case is the focus of this page. This is shown in
13+
pipeline, and that two-stage case is the focus of this section. This is shown in
1414
:ref:`decimator_stages_simplified`.
1515

1616
.. _decimator_stages_simplified:
@@ -262,7 +262,7 @@ sample rate (the sample rate received by the main application code) is
262262
3.072 MHz / (32*6) = 16 kHz
263263

264264
The second stage filter uses the 32-bit FIR filter implementation from
265-
`lib_xcore_math <https://github.com/xmos/lib_xcore_math>`_. See
265+
`lib_xcore_math <www.xmos.com/libraries/lib_xcore_math>`_. See
266266
``xs3_filter_fir_s32()`` in that library for more implementation details.
267267

268268
The filter state (delay line) consists of as many 32-bit samples as there are taps in the stage-2 filter,
@@ -272,6 +272,6 @@ and requires that many 32-bit words for storage.
272272

273273
If providing stage-2 custom coefficients, they must remain compatible with the underlying
274274
32-bit FIR implementation from
275-
`lib_xcore_math <https://github.com/xmos/lib_xcore_math>`_
275+
`lib_xcore_math <www.xmos.com/libraries/lib_xcore_math>`_
276276
(for example, tap/shift/state configuration must match the ``xs3_filter_fir_s32()`` function requirements).
277277
For details on supplying custom coefficients via configuration structures, see :ref:`custom_filters`.

‎examples/app_par_decimator/src/app_decimator.hpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ class MyTwoStageDecimator
127127
*
128128
* `s2_filter_shr` is the final right-shift applied to the stage 2 filter's
129129
* accumulator prior to output. See
130-
* <a href="https://github.com/xmos/lib_xcore_math">lib_xcore_math's</a>
130+
* <a href="www.xmos.com/libraries/lib_xcore_math">lib_xcore_math's</a>
131131
* documentation of `filter_fir_s32_t` for more details.
132132
*
133133
* @param s1_filter_coef @parblock

0 commit comments

Comments
 (0)