zephyr/samples/drivers/i2s/litex
Gerard Marull-Paretas c7b5b3c419 samples: migrate includes to contain <zephyr/...> prefix
In order to bring consistency in-tree, migrate all samples to the use
the new prefix <zephyr/...>. Note that the conversion has been scripted:

```python
from pathlib import Path
import re

EXTENSIONS = ("c", "h", "cpp", "rst")

for p in Path(".").glob("samples/**/*"):
    if not p.is_file() or p.suffix and p.suffix[1:] not in EXTENSIONS:
        continue

    content = ""
    with open(p) as f:
        for line in f:
            m = re.match(r"^(.*)#include <(.*)>(.*)$", line)
            if (m and
                not m.group(2).startswith("zephyr/") and
                (Path(".") / "include" / "zephyr" / m.group(2)).exists()):
                content += (
                    m.group(1) +
                    "#include <zephyr/" + m.group(2) +">" +
                    m.group(3) + "\n"
                )
            else:
                content += line

    with open(p, "w") as f:
        f.write(content)
```

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-05-06 11:29:59 +02:00
..
src samples: migrate includes to contain <zephyr/...> prefix 2022-05-06 11:29:59 +02:00
CMakeLists.txt
prj.conf
README.rst
sample.yaml

.. _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.