zephyr

History

Benjamin Cabé 1b66353a8d samples: posix: use zephyr:code-sample directive Describe the samples using code-sample directive in preparation for upcoming changes to the Zephyr documentation that will be leveraging the provided description and metadata. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>		2024-08-27 15:13:43 -04:00
..
src	…
CMakeLists.txt	…
Makefile.host	samples: doc: Added/Updated README and Makefile for POSIX samples	2024-01-19 10:32:23 +01:00
README.rst	samples: posix: use zephyr:code-sample directive	2024-08-27 15:13:43 -04:00
prj.conf	samples: Switch from NEWLIB_LIBC to REQUIRES_FULL_LIBC	2023-10-25 08:32:06 +02:00
sample.yaml	hwmv2: Introduce Hardware model version 2 and convert devices	2024-03-02 16:56:33 -05:00

README.rst

.. zephyr:code-sample:: posix-eventfd
   :name: eventfd()

   Use ``eventfd()`` to create a file descriptor for event notification.

Overview
********

This sample application demonstrates using the POSIX eventfd() function to create a file descriptor,
which can be used for event notification. The returned file descriptor is used with write/read calls
and write/read values are output to the console.

Building and Running
********************

This project outputs to the console. It can be built and executed on QEMU as follows:

.. zephyr-app-commands::
   :zephyr-app: samples/posix/eventfd
   :host-os: unix
   :board: qemu_x86
   :goals: run
   :compact:

For comparison, to build directly for your host OS if it is POSIX compliant (for ex. Linux):

.. code-block:: console

   cd samples/posix/eventfd
   make -f Makefile.host

The make output file will be located in samples/posix/eventfd/build.

Sample Output
=============

.. code-block:: console

    Writing 1 to efd
    Writing 2 to efd
    Writing 3 to efd
    Writing 4 to efd
    Completed write loop
    About to read
    Read 10 (0xa) from efd
    Finished