Skip to content

Commit 5be4aed

Browse files
josuahkartben
authored andcommitted
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 <[email protected]>
1 parent 8c226b9 commit 5be4aed

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

doc/releases/migration-guide-4.1.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,16 @@ Stepper
122122
Regulator
123123
=========
124124

125+
Video
126+
=====
127+
128+
* The :file:`include/zephyr/drivers/video-controls.h` got updated to have video controls IDs (CIDs)
129+
matching the definitions in the Linux kernel file ``include/uapi/linux/v4l2-controls.h``.
130+
In most cases, removing the category prefix is enough: ``VIDEO_CID_CAMERA_GAIN`` becomes
131+
``VIDEO_CID_GAIN``.
132+
The new ``video-controls.h`` source now contains description of each control ID to help
133+
disambiguating.
134+
125135
Bluetooth
126136
*********
127137

doc/releases/release-notes-4.1.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,9 @@ Drivers and Sensors
191191

192192
* Video
193193

194+
* Changed :file:`include/zephyr/drivers/video-controls.h` to have control IDs (CIDs) matching
195+
those present in the Linux kernel.
196+
194197
* Watchdog
195198

196199
* Wi-Fi

0 commit comments

Comments
 (0)