fix(bitscrambler): example timeout in the bsasm

also added example pytest
2025-01-09 18:44:50 +08:00
parent 97d09e6427
commit 8de8558841
7 changed files with 48 additions and 13 deletions
@@ -193,6 +193,10 @@ Resource allocation and program loading

 In loopback mode, a BitScrambler object is created using :cpp:func:`bitscrambler_loopback_create`. If there is a BitScrambler peripheral matching the requested characteristics, this function will return a handle to it. You can then use :cpp:func:`bitscrambler_load_program` to load a program into it, then call :cpp:func:`bitscrambler_loopback_run` to transform a memory buffer using the loaded program. You can call :cpp:func:`bitscrambler_loopback_run` any number of times; it's also permissible to use :cpp:func:`bitscrambler_load_program` to change programs between calls. Finally, to free the hardware resources and clean up memory, call :cpp:func:`bitscrambler_free`.

+Application Example
+-------------------
+
+* :example:`peripherals/bitscrambler` demonstrates how to use the BitScrambler loopback mode to transform a buffer of data into a different format.

 API Reference
 -------------