media: dt-bindings: Add bindings for camera modules
Subsystems (2)
PATCH 1/1 media: dt-bindings: Add bindings for camera modules
Add bindings for camera modules to allow telling especially the user space which module is found in the system. Camera modules do not have a device node so this is a property for the camera sensor device node. This allows describing modules that contain a single camera sensor.
---
Hi all,
Here's the patch to give some advance warning for the camera module discussion. The good thing is that it's quite short.
The intent indeed is to address the regular use case where we have a single sensor in a camera module. For cases where we have more, we'll need something else, not based on individual properties. I believe this is still the way to go, to address current issues and for a couple of additional reasons:
- Cameras with more than one sensor tend to be collections of camera modules so this is still relevant in most cases.
- It's much simpler to have a single property than begin having new nodes in DT. In practice such nodes would be a poor fit for DT generally as they have (few or) no functions.
The biggest difficulty is still in module identification. These components tend to be often ignored and the best we have for a module name in that case is random-looking string if even that. Besides DT bindings, we need an additional (git?) tree to describe the modules that have no proper names but it could be also useful for those that do, for instance to include information on lens, field of view, IR filter, photos of the module etc. There is some overlap with what libcamera needs, too.
- Sakari
.../bindings/media/camera-module.yaml | 52 +++++++++++++++++++ .../media/video-interface-devices.yaml | 3 ++ 2 files changed, 55 insertions(+) create mode 100644 Documentation/devicetree/bindings/media/camera-module.yaml
Documentation/devicetree/bindings/media/camera-module.yaml new file +52 -0
@@ -0,0 +1,52 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +# Copyright (C) 2025 Intel Corporation +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/media/camera-module.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Camera modules + +maintainers: + - Sakari Ailus <[email protected]> + +description: | + Camera modules are devices that embed one or more active devices, including + Camera Sensors, Voice Coil Motor (VCM) and possibly a flash LED as well as + other passive devices such as lenses and Ultra-Violet (UV) filters. While the + camera modules themselves have no OF nodes and have generally no module + specific functions, it still does matter for the software stack as a whole + which module the devices are a part of. + + Two properties are used for this, depending on what is known of the module: + + 1. The model of the module is known. In this case the name of the module uses + the format "vendor,model[,version]" where "vendor" is the manufacturer of the + module and "model" the name of the model. The version part is optional. In + such cases the property "camera-module-canonical" will be used. If the vendor + is not known, the "gpio" vendor prefix is used. + + 2. The model of the module is unknown. In this case, the module has an + identifier only, and will be described in detail in the camera module + database. The property "camera-module-casual" is used to denote such modules. + + Before including in this binding documentation, all modules shall also be + documented in add-URL-here. + + All camera modules listed below shall have the name of the sensor as well as + other devices included in the module as DT compatible string mentioned in a + comment after the enumeration, separated by a whitespace (" "). + + Always keep the enumeration alphabetically (1) or numerically (2) sorted. + +properties: + camera-module-canonical: + $ref: /schemas/types.yaml#/definitions/string + enum: + - "dell,0BF122N3" # onnn,ov01a10 + camera-module-casual: + $ref: /schemas/types.yaml#/definitions/uint32 + enum: + - 1 # st,vs6555 + +additionalProperties: true
Documentation/devicetree/bindings/media/video-interface-devices.yaml +3 -0
@@ -10,6 +10,9 @@ maintainers: - Jacopo Mondi <[email protected]> - Sakari Ailus <[email protected]> +allOf: + - $ref: /schemas/media/camera-module.yaml# + properties: flash-leds: $ref: /schemas/types.yaml#/definitions/phandle-array
Signature · 1 line
2.39.5
Quoted 11 lines · Sakari Ailus
Add bindings for camera modules to allow telling especially the user space which module is found in the system. Camera modules do not have a device node so this is a property for the camera sensor device node. This allows describing modules that contain a single camera sensor.
Signed-off-by Sakari Ailus <[email protected]>---
Hi all,Here's the patch to give some advance warning for the camera module discussion. The good thing is that it's quite short.
If you do not expect any review, then mark your patches with RFC or [IGNORE].
<form letter>
Please use scripts/get_maintainers.pl to get a list of necessary people and lists to CC. It might happen, that command when run on an older kernel, gives you outdated entries. Therefore please be sure you base your patches on recent Linux kernel.
Tools like b4 or scripts/get_maintainer.pl provide you proper list of people, so fix your workflow. Tools might also fail if you work on some ancient tree (don't, instead use mainline) or work on fork of kernel (don't, instead use mainline). Just use b4 and everything should be fine, although remember about b4 prep --auto-to-cc if you added new patches to the patchset.
You missed at least devicetree list (maybe more), so this won't be tested by automated tooling. Performing review on untested code might be a waste of time.
Please kindly resend and include all necessary To/Cc entries. </form letter>
Best regards,
Krzysztof
Hi Krzysztof,
Quoted 6 lines · Krzysztof Kozlowski
Quoted 5 lines · Sakari Ailus
Add bindings for camera modules to allow telling especially the user space which module is found in the system. Camera modules do not have a device node so this is a property for the camera sensor device node. This allows describing modules that contain a single camera sensor.
Quoted 8 lines
Quoted 6 lines
Signed-off-by Sakari Ailus <[email protected]>---
Hi all,Here's the patch to give some advance warning for the camera module discussion. The good thing is that it's quite short.
If you do not expect any review, then mark your patches with RFC or [IGNORE].
This was indeed meant to be an RFC: right now we're still discussing the requirements.
Signature · 3 lines
Regards, Sakari Ailus
Hi Sakari,
thanks a lot for the proposal, it will be useful for next week discussion
Quoted 57 lines · Sakari Ailus
Add bindings for camera modules to allow telling especially the user space which module is found in the system. Camera modules do not have a device node so this is a property for the camera sensor device node. This allows describing modules that contain a single camera sensor.
Signed-off-by Sakari Ailus <[email protected]>---
Hi all,Here's the patch to give some advance warning for the camera module discussion. The good thing is that it's quite short.
The intent indeed is to address the regular use case where we have a single sensor in a camera module. For cases where we have more, we'll need something else, not based on individual properties. I believe this is still the way to go, to address current issues and for a couple of additional reasons:
- Cameras with more than one sensor tend to be collections of camera modules so this is still relevant in most cases.
- It's much simpler to have a single property than begin having new nodes in DT. In practice such nodes would be a poor fit for DT generally as they have (few or) no functions.
The biggest difficulty is still in module identification. These components tend to be often ignored and the best we have for a module name in that case is random-looking string if even that. Besides DT bindings, we need an additional (git?) tree to describe the modules that have no proper names but it could be also useful for those that do, for instance to include information on lens, field of view, IR filter, photos of the module etc. There is some overlap with what libcamera needs, too.
- Sakari
.../bindings/media/camera-module.yaml | 52 +++++++++++++++++++ .../media/video-interface-devices.yaml | 3 ++ 2 files changed, 55 insertions(+) create mode 100644 Documentation/devicetree/bindings/media/camera-module.yamlDocumentation/devicetree/bindings/media/camera-module.yaml new file +11
-0@@ -0,0 +1,52 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +# Copyright (C) 2025 Intel Corporation +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/media/camera-module.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Camera modules + +maintainers: + - Sakari Ailus <[email protected]>
Documentation/devicetree/bindings/media/camera-module.yaml line 21
Quoted 10 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +10
-0+ +description: | + Camera modules are devices that embed one or more active devices, including + Camera Sensors, Voice Coil Motor (VCM) and possibly a flash LED as well as + other passive devices such as lenses and Ultra-Violet (UV) filters. While the + camera modules themselves have no OF nodes and have generally no module + specific functions, it still does matter for the software stack as a whole + which module the devices are a part of. + + Two properties are used for this, depending on what is known of the module:
I might have missed a point here.
Documentation/devicetree/bindings/media/camera-module.yaml line 27
Quoted 6 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +6
-0+ + 1. The model of the module is known. In this case the name of the module uses + the format "vendor,model[,version]" where "vendor" is the manufacturer of the + module and "model" the name of the model. The version part is optional. In + such cases the property "camera-module-canonical" will be used. If the vendor + is not known, the "gpio" vendor prefix is used.
So if the module is "known" it will be described using the above specified triplet
(also, why "gpio" ?)
Documentation/devicetree/bindings/media/camera-module.yaml line 31
Quoted 4 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +4
-0+ + 2. The model of the module is unknown. In this case, the module has an + identifier only, and will be described in detail in the camera module + database. The property "camera-module-casual" is used to denote such modules.
If the module is "unknown" it will be identified by a numerical id that points to the camera module database where it is "described in detail". But if an entry is present in the camera module database, then it's not really "unkown", right ?
What is the actual difference between an "unknown" and a "known" module then ?
Documentation/devicetree/bindings/media/camera-module.yaml line 34
Quoted 3 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +3
-0+ + Before including in this binding documentation, all modules shall also be + documented in add-URL-here.
If an entry in the camera module database is a requirement can't we simply point to that entry using a numerical id like you proposed for the "camera-module-casual" property ?
Thanks
j
Quoted 35 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +18
-0+ + All camera modules listed below shall have the name of the sensor as well as + other devices included in the module as DT compatible string mentioned in a + comment after the enumeration, separated by a whitespace (" "). + + Always keep the enumeration alphabetically (1) or numerically (2) sorted. + +properties: + camera-module-canonical: + $ref: /schemas/types.yaml#/definitions/string + enum: + - "dell,0BF122N3" # onnn,ov01a10 + camera-module-casual: + $ref: /schemas/types.yaml#/definitions/uint32 + enum: + - 1 # st,vs6555 + +additionalProperties: trueDocumentation/devicetree/bindings/media/video-interface-devices.yaml +3
-1@@ -10,6 +10,9 @@ maintainers: - Jacopo Mondi <[email protected]> - Sakari Ailus <[email protected]> +allOf: + - $ref: /schemas/media/camera-module.yaml# + properties: flash-leds: $ref: /schemas/types.yaml#/definitions/phandle-array --2.39.5
Hi Jacopo,
Quoted 2 lines · Jacopo Mondi
Hi Sakari,
thanks a lot for the proposal, it will be useful for next week discussion
Thank you for the review!
Quoted 80 lines · Sakari Ailus
Quoted 57 lines
Add bindings for camera modules to allow telling especially the user space which module is found in the system. Camera modules do not have a device node so this is a property for the camera sensor device node. This allows describing modules that contain a single camera sensor.
Signed-off-by Sakari Ailus <[email protected]>---
Hi all,Here's the patch to give some advance warning for the camera module discussion. The good thing is that it's quite short.
The intent indeed is to address the regular use case where we have a single sensor in a camera module. For cases where we have more, we'll need something else, not based on individual properties. I believe this is still the way to go, to address current issues and for a couple of additional reasons:
- Cameras with more than one sensor tend to be collections of camera modules so this is still relevant in most cases.
- It's much simpler to have a single property than begin having new nodes in DT. In practice such nodes would be a poor fit for DT generally as they have (few or) no functions.
The biggest difficulty is still in module identification. These components tend to be often ignored and the best we have for a module name in that case is random-looking string if even that. Besides DT bindings, we need an additional (git?) tree to describe the modules that have no proper names but it could be also useful for those that do, for instance to include information on lens, field of view, IR filter, photos of the module etc. There is some overlap with what libcamera needs, too.
- Sakari
.../bindings/media/camera-module.yaml | 52 +++++++++++++++++++ .../media/video-interface-devices.yaml | 3 ++ 2 files changed, 55 insertions(+) create mode 100644 Documentation/devicetree/bindings/media/camera-module.yamlDocumentation/devicetree/bindings/media/camera-module.yaml new file +11
-0@@ -0,0 +1,52 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +# Copyright (C) 2025 Intel Corporation +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/media/camera-module.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Camera modules + +maintainers: + - Sakari Ailus <[email protected]>Documentation/devicetree/bindings/media/camera-module.yaml line 21
Quoted 10 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +10
-0+ +description: | + Camera modules are devices that embed one or more active devices, including + Camera Sensors, Voice Coil Motor (VCM) and possibly a flash LED as well as + other passive devices such as lenses and Ultra-Violet (UV) filters. While the + camera modules themselves have no OF nodes and have generally no module + specific functions, it still does matter for the software stack as a whole + which module the devices are a part of. + + Two properties are used for this, depending on what is known of the module:I might have missed a point here.
Documentation/devicetree/bindings/media/camera-module.yaml line 27
Quoted 6 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +6
-0+ + 1. The model of the module is known. In this case the name of the module uses + the format "vendor,model[,version]" where "vendor" is the manufacturer of the + module and "model" the name of the model. The version part is optional. In + such cases the property "camera-module-canonical" will be used. If the vendor + is not known, the "gpio" vendor prefix is used.
Quoted 4 lines
So if the module is "known" it will be described using the above specified triplet
(also, why "gpio" ?)
"gpio" is reserved. Another option would be to reserve a name for an unknown vendor. I believe DT maintainers will have an opinion on this.
Quoted 6 lines
Documentation/devicetree/bindings/media/camera-module.yaml line 31
Quoted 5 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +4
-0+ + 2. The model of the module is unknown. In this case, the module has an + identifier only, and will be described in detail in the camera module + database. The property "camera-module-casual" is used to denote such modules.
Quoted 7 lines
If the module is "unknown" it will be identified by a numerical id that points to the camera module database where it is "described in detail". But if an entry is present in the camera module database, then it's not really "unkown", right ?
What is the actual difference between an "unknown" and a "known" module then ?
We could use different terms certainly. I wanted to differentiate here modules the name of which, and hopefully also the manufacturer of which, is known. Otherwise we can just describe it by various other means that are all sub-par compared to having a model and the name of the vendor written on the side of the module.
Quoted 9 lines
Documentation/devicetree/bindings/media/camera-module.yaml line 34
Quoted 5 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +3
-0+ + Before including in this binding documentation, all modules shall also be + documented in add-URL-here.If an entry in the camera module database is a requirement can't we simply point to that entry using a numerical id like you proposed for the "camera-module-casual" property ?
That exactly is the idea.
Quoted 36 lines
Thanks
jQuoted 32 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +18
-0+ + All camera modules listed below shall have the name of the sensor as well as + other devices included in the module as DT compatible string mentioned in a + comment after the enumeration, separated by a whitespace (" "). + + Always keep the enumeration alphabetically (1) or numerically (2) sorted. + +properties: + camera-module-canonical: + $ref: /schemas/types.yaml#/definitions/string + enum: + - "dell,0BF122N3" # onnn,ov01a10 + camera-module-casual: + $ref: /schemas/types.yaml#/definitions/uint32 + enum: + - 1 # st,vs6555 + +additionalProperties: trueDocumentation/devicetree/bindings/media/video-interface-devices.yaml +3
-0@@ -10,6 +10,9 @@ maintainers: - Jacopo Mondi <[email protected]> - Sakari Ailus <[email protected]> +allOf: + - $ref: /schemas/media/camera-module.yaml# + properties: flash-leds: $ref: /schemas/types.yaml#/definitions/phandle-array
Signature · 3 lines
Regards, Sakari Ailus
Hi Sakari
Quoted 88 lines · Sakari Ailus
Hi Jacopo,
Quoted 2 lines · Jacopo Mondi
Hi Sakari,
thanks a lot for the proposal, it will be useful for next week discussionThank you for the review!
Quoted 80 lines · Sakari Ailus
Quoted 57 lines
Add bindings for camera modules to allow telling especially the user space which module is found in the system. Camera modules do not have a device node so this is a property for the camera sensor device node. This allows describing modules that contain a single camera sensor.
Signed-off-by Sakari Ailus <[email protected]>---
Hi all,Here's the patch to give some advance warning for the camera module discussion. The good thing is that it's quite short.
The intent indeed is to address the regular use case where we have a single sensor in a camera module. For cases where we have more, we'll need something else, not based on individual properties. I believe this is still the way to go, to address current issues and for a couple of additional reasons:
- Cameras with more than one sensor tend to be collections of camera modules so this is still relevant in most cases.
- It's much simpler to have a single property than begin having new nodes in DT. In practice such nodes would be a poor fit for DT generally as they have (few or) no functions.
The biggest difficulty is still in module identification. These components tend to be often ignored and the best we have for a module name in that case is random-looking string if even that. Besides DT bindings, we need an additional (git?) tree to describe the modules that have no proper names but it could be also useful for those that do, for instance to include information on lens, field of view, IR filter, photos of the module etc. There is some overlap with what libcamera needs, too.
- Sakari
.../bindings/media/camera-module.yaml | 52 +++++++++++++++++++ .../media/video-interface-devices.yaml | 3 ++ 2 files changed, 55 insertions(+) create mode 100644 Documentation/devicetree/bindings/media/camera-module.yamlDocumentation/devicetree/bindings/media/camera-module.yaml new file +11
-0@@ -0,0 +1,52 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +# Copyright (C) 2025 Intel Corporation +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/media/camera-module.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Camera modules + +maintainers: + - Sakari Ailus <[email protected]>Documentation/devicetree/bindings/media/camera-module.yaml line 21
Quoted 10 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +10
-0+ +description: | + Camera modules are devices that embed one or more active devices, including + Camera Sensors, Voice Coil Motor (VCM) and possibly a flash LED as well as + other passive devices such as lenses and Ultra-Violet (UV) filters. While the + camera modules themselves have no OF nodes and have generally no module + specific functions, it still does matter for the software stack as a whole + which module the devices are a part of. + + Two properties are used for this, depending on what is known of the module:I might have missed a point here.
Quoted 6 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +6
-0+ + 1. The model of the module is known. In this case the name of the module uses + the format "vendor,model[,version]" where "vendor" is the manufacturer of the + module and "model" the name of the model. The version part is optional. In + such cases the property "camera-module-canonical" will be used. If the vendor + is not known, the "gpio" vendor prefix is used.
Quoted 8 lines
Quoted 4 lines
So if the module is "known" it will be described using the above specified triplet
(also, why "gpio" ?)
"gpio" is reserved. Another option would be to reserve a name for an unknown vendor. I believe DT maintainers will have an opinion on this.
I see
Quoted 11 lines
Quoted 11 lines
Documentation/devicetree/bindings/media/camera-module.yaml line 31
Quoted 5 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +4
-0+ + 2. The model of the module is unknown. In this case, the module has an + identifier only, and will be described in detail in the camera module + database. The property "camera-module-casual" is used to denote such modules.If the module is "unknown" it will be identified by a numerical id that points to the camera module database where it is "described in detail". But if an entry is present in the camera module database, then it's not really "unkown", right ?
Quoted 4 lines
Quoted 2 lines
What is the actual difference between an "unknown" and a "known" module then ?
We could use different terms certainly. I wanted to differentiate here
It's certainly not my intention to bikeshed on naming (yet :)
Quoted 11 lines
modules the name of which, and hopefully also the manufacturer of which, is known. Otherwise we can just describe it by various other means that are all sub-par compared to having a model and the name of the vendor written on the side of the module.
Quoted 6 lines
Quoted 5 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +3
-0+ + Before including in this binding documentation, all modules shall also be + documented in add-URL-here.
Quoted 5 lines
Quoted 3 lines
If an entry in the camera module database is a requirement can't we simply point to that entry using a numerical id like you proposed for the "camera-module-casual" property ?
That exactly is the idea.
Ok, so the two properties are not mutually exclusive ?
Because, and that's the thing I'm missing, if you have an entry in a database, that entry will almost certainly contain the vendor and the model name (which in my understanding means that if an entry exists the module is always "known").
Quoted 43 lines
Quoted 31 lines
Thanks
jQuoted 26 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +18
-0+ + All camera modules listed below shall have the name of the sensor as well as + other devices included in the module as DT compatible string mentioned in a + comment after the enumeration, separated by a whitespace (" "). + + Always keep the enumeration alphabetically (1) or numerically (2) sorted. + +properties: + camera-module-canonical: + $ref: /schemas/types.yaml#/definitions/string + enum: + - "dell,0BF122N3" # onnn,ov01a10 + camera-module-casual: + $ref: /schemas/types.yaml#/definitions/uint32 + enum: + - 1 # st,vs6555 + +additionalProperties: trueDocumentation/devicetree/bindings/media/video-interface-devices.yaml +0
-0@@ -10,6 +10,9 @@ maintainers: - Jacopo Mondi <[email protected]> - Sakari Ailus <[email protected]>Quoted 6 lines
Documentation/devicetree/bindings/media/video-interface-devices.yaml maintainers: · line 18
Quoted 6 lines
Documentation/devicetree/bindings/media/video-interface-devices.yaml +3
-0+allOf: + - $ref: /schemas/media/camera-module.yaml# + properties: flash-leds: $ref: /schemas/types.yaml#/definitions/phandle-array--
Regards,Sakari Ailus
Hi Jacopo,
Quoted 131 lines · Jacopo Mondi
Hi Sakari
Quoted 88 lines · Sakari Ailus
Hi Jacopo,
Quoted 2 lines · Jacopo Mondi
Hi Sakari,
thanks a lot for the proposal, it will be useful for next week discussionThank you for the review!
Quoted 80 lines · Sakari Ailus
Quoted 57 lines
Add bindings for camera modules to allow telling especially the user space which module is found in the system. Camera modules do not have a device node so this is a property for the camera sensor device node. This allows describing modules that contain a single camera sensor.
Signed-off-by Sakari Ailus <[email protected]>---
Hi all,Here's the patch to give some advance warning for the camera module discussion. The good thing is that it's quite short.
The intent indeed is to address the regular use case where we have a single sensor in a camera module. For cases where we have more, we'll need something else, not based on individual properties. I believe this is still the way to go, to address current issues and for a couple of additional reasons:
- Cameras with more than one sensor tend to be collections of camera modules so this is still relevant in most cases.
- It's much simpler to have a single property than begin having new nodes in DT. In practice such nodes would be a poor fit for DT generally as they have (few or) no functions.
The biggest difficulty is still in module identification. These components tend to be often ignored and the best we have for a module name in that case is random-looking string if even that. Besides DT bindings, we need an additional (git?) tree to describe the modules that have no proper names but it could be also useful for those that do, for instance to include information on lens, field of view, IR filter, photos of the module etc. There is some overlap with what libcamera needs, too.
- Sakari
.../bindings/media/camera-module.yaml | 52 +++++++++++++++++++ .../media/video-interface-devices.yaml | 3 ++ 2 files changed, 55 insertions(+) create mode 100644 Documentation/devicetree/bindings/media/camera-module.yamlDocumentation/devicetree/bindings/media/camera-module.yaml new file +11
-0@@ -0,0 +1,52 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +# Copyright (C) 2025 Intel Corporation +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/media/camera-module.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Camera modules + +maintainers: + - Sakari Ailus <[email protected]>Documentation/devicetree/bindings/media/camera-module.yaml line 21
Quoted 10 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +10
-0+ +description: | + Camera modules are devices that embed one or more active devices, including + Camera Sensors, Voice Coil Motor (VCM) and possibly a flash LED as well as + other passive devices such as lenses and Ultra-Violet (UV) filters. While the + camera modules themselves have no OF nodes and have generally no module + specific functions, it still does matter for the software stack as a whole + which module the devices are a part of. + + Two properties are used for this, depending on what is known of the module:I might have missed a point here.
Quoted 6 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +6
-0+ + 1. The model of the module is known. In this case the name of the module uses + the format "vendor,model[,version]" where "vendor" is the manufacturer of the + module and "model" the name of the model. The version part is optional. In + such cases the property "camera-module-canonical" will be used. If the vendor + is not known, the "gpio" vendor prefix is used.Quoted 8 lines
Quoted 4 lines
So if the module is "known" it will be described using the above specified triplet
(also, why "gpio" ?)
"gpio" is reserved. Another option would be to reserve a name for an unknown vendor. I believe DT maintainers will have an opinion on this.
I see
Quoted 11 lines
Quoted 11 lines
Documentation/devicetree/bindings/media/camera-module.yaml line 31
Quoted 5 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +4
-0+ + 2. The model of the module is unknown. In this case, the module has an + identifier only, and will be described in detail in the camera module + database. The property "camera-module-casual" is used to denote such modules.If the module is "unknown" it will be identified by a numerical id that points to the camera module database where it is "described in detail". But if an entry is present in the camera module database, then it's not really "unkown", right ?
Quoted 4 lines
Quoted 2 lines
What is the actual difference between an "unknown" and a "known" module then ?
We could use different terms certainly. I wanted to differentiate here
It's certainly not my intention to bikeshed on naming (yet :)
Quoted 11 lines
modules the name of which, and hopefully also the manufacturer of which, is known. Otherwise we can just describe it by various other means that are all sub-par compared to having a model and the name of the vendor written on the side of the module.
Quoted 6 lines
Quoted 5 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +3
-0+ + Before including in this binding documentation, all modules shall also be + documented in add-URL-here.
Quoted 7 lines
Quoted 5 lines
Quoted 3 lines
If an entry in the camera module database is a requirement can't we simply point to that entry using a numerical id like you proposed for the "camera-module-casual" property ?
That exactly is the idea.
Ok, so the two properties are not mutually exclusive ?
Yes, they are. A module can not both have a known name and not have one at the same time.
Quoted 5 lines
Because, and that's the thing I'm missing, if you have an entry in a database, that entry will almost certainly contain the vendor and the model name (which in my understanding means that if an entry exists the module is always "known").
This should actually probably be changed in such a way that the module always needs to be added to the database. There will be more than how to identify such a module there.
Quoted 38 lines
Quoted 38 lines
Quoted 37 lines
Thanks
jQuoted 32 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +18
-0+ + All camera modules listed below shall have the name of the sensor as well as + other devices included in the module as DT compatible string mentioned in a + comment after the enumeration, separated by a whitespace (" "). + + Always keep the enumeration alphabetically (1) or numerically (2) sorted. + +properties: + camera-module-canonical: + $ref: /schemas/types.yaml#/definitions/string + enum: + - "dell,0BF122N3" # onnn,ov01a10 + camera-module-casual: + $ref: /schemas/types.yaml#/definitions/uint32 + enum: + - 1 # st,vs6555 + +additionalProperties: trueDocumentation/devicetree/bindings/media/video-interface-devices.yaml +3
-0@@ -10,6 +10,9 @@ maintainers: - Jacopo Mondi <[email protected]> - Sakari Ailus <[email protected]> +allOf: + - $ref: /schemas/media/camera-module.yaml# + properties: flash-leds: $ref: /schemas/types.yaml#/definitions/phandle-array
Signature · 3 lines
Regards, Sakari Ailus
Hi Sakari,
Quoting Sakari Ailus (2025-05-07 09:13:38)
Quoted 5 lines
Add bindings for camera modules to allow telling especially the user space which module is found in the system. Camera modules do not have a device node so this is a property for the camera sensor device node. This allows describing modules that contain a single camera sensor.
Quoted 7 lines
Signed-off-by Sakari Ailus <[email protected]>---
Hi all,Here's the patch to give some advance warning for the camera module discussion. The good thing is that it's quite short.
Thanks for starting this! Definitely something I would like to see a solution for indeed.
Quoted 13 lines
The intent indeed is to address the regular use case where we have a single sensor in a camera module. For cases where we have more, we'll need something else, not based on individual properties. I believe this is still the way to go, to address current issues and for a couple of additional reasons:
- Cameras with more than one sensor tend to be collections of camera modules so this is still relevant in most cases.
- It's much simpler to have a single property than begin having new nodes in DT. In practice such nodes would be a poor fit for DT generally as they have (few or) no functions.
Quoted 8 lines
The biggest difficulty is still in module identification. These components tend to be often ignored and the best we have for a module name in that case is random-looking string if even that. Besides DT bindings, we need an additional (git?) tree to describe the modules that have no proper names but it could be also useful for those that do, for instance to include information on lens, field of view, IR filter, photos of the module etc. There is some overlap with what libcamera needs, too.
One aspect that jumps to my mind here - is how do we handle variations of modules?
For instance I have two IMX335 modules from Arducam - which are otherwise identical except for different lenses with different field-of-view.
Do we need more properties (later?) to express the different configuration options of the module?
At some point I would love to be able to describe a 'module' as the whole component including a VCM for instance - in a way that can be abstracted as something that could be connected to a 'port' (see [0], [1]) where it would be helpful to be able to group/abstract a movable component and identify the full camera module in a way that doesn't have to be duplicated in every platform configuration that it could be connected.
[0] https://www.konsulko.com/wp-content/uploads/2016/09/portable-device-tree-connector.pdf
[1] https://lore.kernel.org/all/[email protected]/
--
Kieran
Quoted 82 lines
- Sakari
.../bindings/media/camera-module.yaml | 52 +++++++++++++++++++ .../media/video-interface-devices.yaml | 3 ++ 2 files changed, 55 insertions(+) create mode 100644 Documentation/devicetree/bindings/media/camera-module.yamlDocumentation/devicetree/bindings/media/camera-module.yaml new file +52
-0@@ -0,0 +1,52 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +# Copyright (C) 2025 Intel Corporation +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/media/camera-module.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Camera modules + +maintainers: + - Sakari Ailus <[email protected]> + +description: | + Camera modules are devices that embed one or more active devices, including + Camera Sensors, Voice Coil Motor (VCM) and possibly a flash LED as well as + other passive devices such as lenses and Ultra-Violet (UV) filters. While the + camera modules themselves have no OF nodes and have generally no module + specific functions, it still does matter for the software stack as a whole + which module the devices are a part of. + + Two properties are used for this, depending on what is known of the module: + + 1. The model of the module is known. In this case the name of the module uses + the format "vendor,model[,version]" where "vendor" is the manufacturer of the + module and "model" the name of the model. The version part is optional. In + such cases the property "camera-module-canonical" will be used. If the vendor + is not known, the "gpio" vendor prefix is used. + + 2. The model of the module is unknown. In this case, the module has an + identifier only, and will be described in detail in the camera module + database. The property "camera-module-casual" is used to denote such modules. + + Before including in this binding documentation, all modules shall also be + documented in add-URL-here. + + All camera modules listed below shall have the name of the sensor as well as + other devices included in the module as DT compatible string mentioned in a + comment after the enumeration, separated by a whitespace (" "). + + Always keep the enumeration alphabetically (1) or numerically (2) sorted. + +properties: + camera-module-canonical: + $ref: /schemas/types.yaml#/definitions/string + enum: + - "dell,0BF122N3" # onnn,ov01a10 + camera-module-casual: + $ref: /schemas/types.yaml#/definitions/uint32 + enum: + - 1 # st,vs6555 + +additionalProperties: trueDocumentation/devicetree/bindings/media/video-interface-devices.yaml +3
-0@@ -10,6 +10,9 @@ maintainers: - Jacopo Mondi <[email protected]> - Sakari Ailus <[email protected]> +allOf: + - $ref: /schemas/media/camera-module.yaml# + properties: flash-leds: $ref: /schemas/types.yaml#/definitions/phandle-arraySignature · 1 line
2.39.5
Hi Kieran,
Quoted 44 lines · Kieran Bingham
Hi Sakari,
Quoting Sakari Ailus (2025-05-07 09:13:38)
Quoted 5 lines
Add bindings for camera modules to allow telling especially the user space which module is found in the system. Camera modules do not have a device node so this is a property for the camera sensor device node. This allows describing modules that contain a single camera sensor.
Quoted 7 lines
Signed-off-by Sakari Ailus <[email protected]>---
Hi all,Here's the patch to give some advance warning for the camera module discussion. The good thing is that it's quite short.
Thanks for starting this! Definitely something I would like to see a solution for indeed.
Quoted 13 lines
The intent indeed is to address the regular use case where we have a single sensor in a camera module. For cases where we have more, we'll need something else, not based on individual properties. I believe this is still the way to go, to address current issues and for a couple of additional reasons:
- Cameras with more than one sensor tend to be collections of camera modules so this is still relevant in most cases.
- It's much simpler to have a single property than begin having new nodes in DT. In practice such nodes would be a poor fit for DT generally as they have (few or) no functions.
Quoted 8 lines
The biggest difficulty is still in module identification. These components tend to be often ignored and the best we have for a module name in that case is random-looking string if even that. Besides DT bindings, we need an additional (git?) tree to describe the modules that have no proper names but it could be also useful for those that do, for instance to include information on lens, field of view, IR filter, photos of the module etc. There is some overlap with what libcamera needs, too.
One aspect that jumps to my mind here - is how do we handle variations of modules?
Quoted 6 lines
For instance I have two IMX335 modules from Arducam - which are otherwise identical except for different lenses with different field-of-view.
Do we need more properties (later?) to express the different configuration options of the module?
I think I'd document these as two different modules. Arducam SKU identifiers are probably best to be used as models here and I presume SKU is different between your modules?
Quoted 9 lines
At some point I would love to be able to describe a 'module' as the whole component including a VCM for instance - in a way that can be abstracted as something that could be connected to a 'port' (see [0], [1]) where it would be helpful to be able to group/abstract a movable component and identify the full camera module in a way that doesn't have to be duplicated in every platform configuration that it could be connected.
This would likely require having a node for the module, too. It's a heavy-weight solution compared to just a property (or a few).
How commonly do you swap lenses outside R&D in practice?
Quoted 3 lines
[0] https://www.konsulko.com/wp-content/uploads/2016/09/portable-device-tree-connector.pdf
[1] https://lore.kernel.org/all/[email protected]/
Signature · 3 lines
Kind regards, Sakari Ailus
Hi Sakari,
Following up here because I think we already need to distinguish between modules - presumably at the DT/overlay level.
Quoting Sakari Ailus (2025-05-19 12:56:41)
Quoted 68 lines
Hi Kieran,
Quoted 44 lines · Kieran Bingham
Hi Sakari,
Quoting Sakari Ailus (2025-05-07 09:13:38)
Quoted 5 lines
Add bindings for camera modules to allow telling especially the user space which module is found in the system. Camera modules do not have a device node so this is a property for the camera sensor device node. This allows describing modules that contain a single camera sensor.
Quoted 7 lines
Signed-off-by Sakari Ailus <[email protected]>---
Hi all,Here's the patch to give some advance warning for the camera module discussion. The good thing is that it's quite short.
Thanks for starting this! Definitely something I would like to see a solution for indeed.
Quoted 13 lines
The intent indeed is to address the regular use case where we have a single sensor in a camera module. For cases where we have more, we'll need something else, not based on individual properties. I believe this is still the way to go, to address current issues and for a couple of additional reasons:
- Cameras with more than one sensor tend to be collections of camera modules so this is still relevant in most cases.
- It's much simpler to have a single property than begin having new nodes in DT. In practice such nodes would be a poor fit for DT generally as they have (few or) no functions.
Quoted 8 lines
The biggest difficulty is still in module identification. These components tend to be often ignored and the best we have for a module name in that case is random-looking string if even that. Besides DT bindings, we need an additional (git?) tree to describe the modules that have no proper names but it could be also useful for those that do, for instance to include information on lens, field of view, IR filter, photos of the module etc. There is some overlap with what libcamera needs, too.
One aspect that jumps to my mind here - is how do we handle variations of modules?
Quoted 6 lines
For instance I have two IMX335 modules from Arducam - which are otherwise identical except for different lenses with different field-of-view.
Do we need more properties (later?) to express the different configuration options of the module?
I think I'd document these as two different modules. Arducam SKU identifiers are probably best to be used as models here and I presume SKU is different between your modules?
Quoted 9 lines
At some point I would love to be able to describe a 'module' as the whole component including a VCM for instance - in a way that can be abstracted as something that could be connected to a 'port' (see [0], [1]) where it would be helpful to be able to group/abstract a movable component and identify the full camera module in a way that doesn't have to be duplicated in every platform configuration that it could be connected.
Quoted 4 lines
This would likely require having a node for the module, too. It's a heavy-weight solution compared to just a property (or a few).
How commonly do you swap lenses outside R&D in practice?
Hard to determine that - but there are already multiple instances of different vendor modules with the same sensor - but a different lens configuration. I'd like to compare these to see if the common parts could be de-duplciated.
In [2] I've posted two more tuning files for libcamera for the IMX335 and IMX415. Does specifying the vendor and SKU there match what you would expect with this? Or should we make it a direct match on the strings you propose below?
[2] https://lists.libcamera.org/pipermail/libcamera-devel/2025-August/052409.html
Documentation/devicetree/bindings/media/camera-module.yaml line 46
Quoted 3 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +3
-0+ $ref: /schemas/types.yaml#/definitions/string + enum: + - "dell,0BF122N3" # onnn,ov01a10
So I guess for the Arducam modules I've posted this would be
"arducam,B0568"
(Do we expect these to be case sensitive? Or insensitive?)
Quoted 15 lines
Documentation/devicetree/bindings/media/camera-module.yaml new file +4
-0+ camera-module-casual: + $ref: /schemas/types.yaml#/definitions/uint32 + enum: + - 1 # st,vs6555Quoted 6 lines
[0] https://www.konsulko.com/wp-content/uploads/2016/09/portable-device-tree-connector.pdf
[1] https://lore.kernel.org/all/[email protected]/Signature · 3 lines
Kind regards, Sakari Ailus
Quoting Sakari Ailus (2025-05-07 09:13:38)
Quoted 116 lines
Add bindings for camera modules to allow telling especially the user space which module is found in the system. Camera modules do not have a device node so this is a property for the camera sensor device node. This allows describing modules that contain a single camera sensor.
Signed-off-by Sakari Ailus <[email protected]>---
Hi all,Here's the patch to give some advance warning for the camera module discussion. The good thing is that it's quite short.
The intent indeed is to address the regular use case where we have a single sensor in a camera module. For cases where we have more, we'll need something else, not based on individual properties. I believe this is still the way to go, to address current issues and for a couple of additional reasons:
- Cameras with more than one sensor tend to be collections of camera modules so this is still relevant in most cases.
- It's much simpler to have a single property than begin having new nodes in DT. In practice such nodes would be a poor fit for DT generally as they have (few or) no functions.
The biggest difficulty is still in module identification. These components tend to be often ignored and the best we have for a module name in that case is random-looking string if even that. Besides DT bindings, we need an additional (git?) tree to describe the modules that have no proper names but it could be also useful for those that do, for instance to include information on lens, field of view, IR filter, photos of the module etc. There is some overlap with what libcamera needs, too.
- Sakari
.../bindings/media/camera-module.yaml | 52 +++++++++++++++++++ .../media/video-interface-devices.yaml | 3 ++ 2 files changed, 55 insertions(+) create mode 100644 Documentation/devicetree/bindings/media/camera-module.yamlDocumentation/devicetree/bindings/media/camera-module.yaml new file +52
-0@@ -0,0 +1,52 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +# Copyright (C) 2025 Intel Corporation +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/media/camera-module.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Camera modules + +maintainers: + - Sakari Ailus <[email protected]> + +description: | + Camera modules are devices that embed one or more active devices, including + Camera Sensors, Voice Coil Motor (VCM) and possibly a flash LED as well as + other passive devices such as lenses and Ultra-Violet (UV) filters. While the + camera modules themselves have no OF nodes and have generally no module + specific functions, it still does matter for the software stack as a whole + which module the devices are a part of. + + Two properties are used for this, depending on what is known of the module: + + 1. The model of the module is known. In this case the name of the module uses + the format "vendor,model[,version]" where "vendor" is the manufacturer of the + module and "model" the name of the model. The version part is optional. In + such cases the property "camera-module-canonical" will be used. If the vendor + is not known, the "gpio" vendor prefix is used. + + 2. The model of the module is unknown. In this case, the module has an + identifier only, and will be described in detail in the camera module + database. The property "camera-module-casual" is used to denote such modules. + + Before including in this binding documentation, all modules shall also be + documented in add-URL-here. + + All camera modules listed below shall have the name of the sensor as well as + other devices included in the module as DT compatible string mentioned in a + comment after the enumeration, separated by a whitespace (" "). + + Always keep the enumeration alphabetically (1) or numerically (2) sorted. + +properties: + camera-module-canonical: + $ref: /schemas/types.yaml#/definitions/string + enum: + - "dell,0BF122N3" # onnn,ov01a10 + camera-module-casual: + $ref: /schemas/types.yaml#/definitions/uint32 + enum: + - 1 # st,vs6555 + +additionalProperties: trueDocumentation/devicetree/bindings/media/video-interface-devices.yaml +3
-0@@ -10,6 +10,9 @@ maintainers: - Jacopo Mondi <[email protected]> - Sakari Ailus <[email protected]> +allOf: + - $ref: /schemas/media/camera-module.yaml# + properties: flash-leds: $ref: /schemas/types.yaml#/definitions/phandle-arraySignature · 1 line
2.39.5
Hi all,
I think this is a very good idea.
Quoting Sakari Ailus (2025-05-07 09:13:38)
Quoted 18 lines
Add bindings for camera modules to allow telling especially the user space which module is found in the system. Camera modules do not have a device node so this is a property for the camera sensor device node. This allows describing modules that contain a single camera sensor.
Signed-off-by Sakari Ailus <[email protected]>---
Hi all,Here's the patch to give some advance warning for the camera module discussion. The good thing is that it's quite short.
The intent indeed is to address the regular use case where we have a single sensor in a camera module. For cases where we have more, we'll need something else, not based on individual properties. I believe this is still the way to go, to address current issues and for a couple of additional reasons:
Quoted 6 lines
- Cameras with more than one sensor tend to be collections of camera modules so this is still relevant in most cases.
- It's much simpler to have a single property than begin having new nodes in DT. In practice such nodes would be a poor fit for DT generally as they have (few or) no functions.
I'm running into the use case where I have lots of cameras all using the same sensors, but need to be identified as different in user space.
What makes this especially tricky is they run on a hotplug-based system, so I don't think adding the information as properties in device tree alone would solve this in all use cases, although it is definitely a good idea.
For the hotplug use case, I would suggest that we add a kernel API to let drivers report which sensor / module variant is detected, as well as dt properties to let people configure which module is connected ahead of time.
Quoted 8 lines
The biggest difficulty is still in module identification. These components tend to be often ignored and the best we have for a module name in that case is random-looking string if even that. Besides DT bindings, we need an additional (git?) tree to describe the modules that have no proper names but it could be also useful for those that do, for instance to include information on lens, field of view, IR filter, photos of the module etc. There is some overlap with what libcamera needs, too.
I've been looking into adding functionality to support this into libcamera, but it is hard to know which format to use for this. The solution I've partly implemented at the moment is to basically write the name of the sensor and the variant of the module into subdev->entity.name, which has let me tell libcamera to use a camera_sensor_helper for the 'base' camera sensor with the tuning file representing the different configuration for the 'variant', which could be used to account for different lenses etc.
My main question is: what is the current status of this? I think identifying the module in a cleaner, more upstreamable way is definitely what I'd prefer to be doing. If its on the backburner and needs some development time put into it, I'd really like to help get this problem solved.
Best wishes,
Isaac
Quoted 84 lines
- Sakari
.../bindings/media/camera-module.yaml | 52 +++++++++++++++++++ .../media/video-interface-devices.yaml | 3 ++ 2 files changed, 55 insertions(+) create mode 100644 Documentation/devicetree/bindings/media/camera-module.yamlDocumentation/devicetree/bindings/media/camera-module.yaml new file +52
-0@@ -0,0 +1,52 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +# Copyright (C) 2025 Intel Corporation +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/media/camera-module.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Camera modules + +maintainers: + - Sakari Ailus <[email protected]> + +description: | + Camera modules are devices that embed one or more active devices, including + Camera Sensors, Voice Coil Motor (VCM) and possibly a flash LED as well as + other passive devices such as lenses and Ultra-Violet (UV) filters. While the + camera modules themselves have no OF nodes and have generally no module + specific functions, it still does matter for the software stack as a whole + which module the devices are a part of. + + Two properties are used for this, depending on what is known of the module: + + 1. The model of the module is known. In this case the name of the module uses + the format "vendor,model[,version]" where "vendor" is the manufacturer of the + module and "model" the name of the model. The version part is optional. In + such cases the property "camera-module-canonical" will be used. If the vendor + is not known, the "gpio" vendor prefix is used. + + 2. The model of the module is unknown. In this case, the module has an + identifier only, and will be described in detail in the camera module + database. The property "camera-module-casual" is used to denote such modules. + + Before including in this binding documentation, all modules shall also be + documented in add-URL-here. + + All camera modules listed below shall have the name of the sensor as well as + other devices included in the module as DT compatible string mentioned in a + comment after the enumeration, separated by a whitespace (" "). + + Always keep the enumeration alphabetically (1) or numerically (2) sorted. + +properties: + camera-module-canonical: + $ref: /schemas/types.yaml#/definitions/string + enum: + - "dell,0BF122N3" # onnn,ov01a10 + camera-module-casual: + $ref: /schemas/types.yaml#/definitions/uint32 + enum: + - 1 # st,vs6555 + +additionalProperties: trueDocumentation/devicetree/bindings/media/video-interface-devices.yaml +3
-0@@ -10,6 +10,9 @@ maintainers: - Jacopo Mondi <[email protected]> - Sakari Ailus <[email protected]> +allOf: + - $ref: /schemas/media/camera-module.yaml# + properties: flash-leds: $ref: /schemas/types.yaml#/definitions/phandle-arraySignature · 1 line
2.39.5