From 5be4aed6209963cb26ee5c6171a595c2440f03fd Mon Sep 17 00:00:00 2001 From: Josuah Demangeon Date: Tue, 19 Nov 2024 00:28:59 +0000 Subject: [PATCH] doc: releases: 4.1: add notes/migration guide for video CID rename The video CIDs got changed, and users will be impacted and need to rename some constants. Offer a strategy for finding the new names in the migration guide for the upcoming release. Signed-off-by: Josuah Demangeon --- doc/releases/migration-guide-4.1.rst | 10 ++++++++++ doc/releases/release-notes-4.1.rst | 3 +++ 2 files changed, 13 insertions(+) diff --git a/doc/releases/migration-guide-4.1.rst b/doc/releases/migration-guide-4.1.rst index 5244c8996bf..c2928e77aef 100644 --- a/doc/releases/migration-guide-4.1.rst +++ b/doc/releases/migration-guide-4.1.rst @@ -122,6 +122,16 @@ Stepper Regulator ========= +Video +===== + +* The :file:`include/zephyr/drivers/video-controls.h` got updated to have video controls IDs (CIDs) + matching the definitions in the Linux kernel file ``include/uapi/linux/v4l2-controls.h``. + In most cases, removing the category prefix is enough: ``VIDEO_CID_CAMERA_GAIN`` becomes + ``VIDEO_CID_GAIN``. + The new ``video-controls.h`` source now contains description of each control ID to help + disambiguating. + Bluetooth ********* diff --git a/doc/releases/release-notes-4.1.rst b/doc/releases/release-notes-4.1.rst index 69fdd0864ae..4f788ad03e4 100644 --- a/doc/releases/release-notes-4.1.rst +++ b/doc/releases/release-notes-4.1.rst @@ -191,6 +191,9 @@ Drivers and Sensors * Video + * Changed :file:`include/zephyr/drivers/video-controls.h` to have control IDs (CIDs) matching + those present in the Linux kernel. + * Watchdog * Wi-Fi