zephyr/samples/boards/litex/i2s
Carles Cufi 8c748fd005 kernel: Modify the signature of k_mem_slab_free()
Modify the signature of the k_mem_slab_free() function with a new one,
replacing the old void **mem with void *mem as a parameter.

The following function:
void k_mem_slab_free(struct k_mem_slab *slab, void **mem);

has the wrong signature. mem is only used as a regular pointer, so there
is no need to use a double-pointer. The correct signature should be:
void k_mem_slab_free(struct k_mem_slab *slab, void *mem);

The issue with the current signature, although functional, is that it is
extremely confusing. I myself, a veteran Zephyr developer, was confused
by this parameter when looking at it recently.

All in-tree uses of the function have been adapted.

Fixes #61888.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2023-09-03 18:20:59 -04:00
..
src kernel: Modify the signature of k_mem_slab_free() 2023-09-03 18:20:59 -04:00
CMakeLists.txt samples: move litex i2s sample under samples/boards 2023-02-22 05:31:07 -05:00
prj.conf samples: move litex i2s sample under samples/boards 2023-02-22 05:31:07 -05:00
README.rst samples: move litex i2s sample under samples/boards 2023-02-22 05:31:07 -05:00
sample.yaml samples: move litex i2s sample under samples/boards 2023-02-22 05:31:07 -05:00

.. _i2s_litex_example:

#####################
I2S example
#####################

Overview
********

This is a simple I2S audio transceiver example. You can plug any source of music and listen to it.

Audio Format
************

The driver requires and provides Audio data with the following parameters:

* 44100 kHz sample rate
* Signed 24 bit PCM
* Stereo
* Little endian

Building
********

.. code-block::

   mkdir build && cd build
   cmake -DBOARD=litex_vexriscv ..
   make

Known issues
************

It seems that after a few minutes some music delay occurs, this is because the sound driver is not able to send data as fast as it receives it.