Skip to content

drivers: video: samples: improve the video-sw-generator doc #90937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 30, 2025
Merged

drivers: video: samples: improve the video-sw-generator doc #90937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
64c9b91
samples: drivers: video: add DT_HAS_CHOSEN() safeguards
josuah Jun 2, 2025
6dea9d5
samples: drivers: video: capture: remove invalid build instruction
josuah Jun 2, 2025
893ff22
doc: release: mention new video-sw-generator snippet
josuah Jun 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/releases/migration-guide-4.2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -718,6 +718,9 @@ Video
size on a per driver basis. Existing applications will not be broken by this change but can be
simplified as performed in the sample in the commit ``33dcbe37cfd3593e8c6e9cfd218dd31fdd533598``.

* Samples and projects using the :ref:`native simulator <native_sim>` now require specifying the
``--snippet`` :ref:`video-sw-generator <snippet-video-sw-generator>` to build correctly.

Audio
=====

Expand Down
1 change: 1 addition & 0 deletions doc/releases/release-notes-4.2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,7 @@ New APIs and options
* :c:func:`video_api_ctrl_t`
* :c:func:`video_query_ctrl`
* :c:func:`video_print_ctrl`
* :ref:`video-sw-generator <snippet-video-sw-generator>`

* PCIe

Expand Down
8 changes: 0 additions & 8 deletions samples/drivers/video/capture/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,6 @@ using the :ref:`dvp_20pin_ov7670` and :ref:`lcd_par_s035` connected to the board
:goals: build
:compact:

For :ref:`native_sim`, build this sample application with the following commands:

.. zephyr-app-commands::
:zephyr-app: samples/drivers/video/capture
:board: native_sim
:goals: build
:compact:

For testing purpose and without the need of any real video capture and/or display hardwares,
a video software pattern generator is supported by the above build commands without
specifying the shields, and using :ref:`snippet-video-sw-generator`:
Expand Down
4 changes: 4 additions & 0 deletions samples/drivers/video/capture/src/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ LOG_MODULE_REGISTER(main, LOG_LEVEL_DBG);
LOG_MODULE_REGISTER(main, CONFIG_LOG_DEFAULT_LEVEL);
#endif

#if !DT_HAS_CHOSEN(zephyr_camera)
#error No camera chosen in devicetree. Missing "--shield" or "--snippet video-sw-generator" flag?
#endif

#if DT_HAS_CHOSEN(zephyr_display)
static inline int display_setup(const struct device *const display_dev, const uint32_t pixfmt)
{
Expand Down
8 changes: 8 additions & 0 deletions samples/drivers/video/capture_to_lvgl/src/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@

LOG_MODULE_REGISTER(main, CONFIG_LOG_DEFAULT_LEVEL);

#if !DT_HAS_CHOSEN(zephyr_camera)
#error No camera chosen in devicetree. Missing "--shield" or "--snippet video-sw-generator" flag?
#endif

#if !DT_HAS_CHOSEN(zephyr_display)
#error No display chosen in devicetree. Missing "--shield" flag?
#endif

int main(void)
{
struct video_buffer *buffers[2];
Expand Down