[media] media.h: mark alsa struct in media_entity_desc as TODO

The alsa struct in struct media_entity_desc is now marked as deprecated.
However, the alsa struct should remain as it is since it cannot be replaced
by a simple major/minor device node description. The alsa struct was designed
to be used as an alsa card description so V4L2 drivers could use this to expose
the alsa card that they create to carry the captured audio. Such a card is not
just a PCM device, but also needs to contain the alsa subdevice information,
and it may map to multiple devices, e.g. a PCM and a mixer device, such as the
au0828 usb stick creates.

This is exactly as intended and this cannot and should not be replaced by a
simple major/minor.

However, whether this information is in the right form for an ALSA device such
that it can handle udev renaming rules as well is another matter. So mark this
alsa struct as TODO and document the problems involved.

Updated the documentation as well to reflect this and to add the 'major'
and 'minor' field documentation.

Updated the documentation to clearly state that struct dev is to be used for
(sub-)devices that create a single device node. Other devices need their own
structure here.

Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>

diff --git a/Documentation/DocBook/media/v4l/media-ioc-enum-entities.xml b/Documentation/DocBook/media/v4l/media-ioc-enum-entities.xml
index cbf307f21a63fb7e38f3890405a7ad9ee3899a48..5872f8bbf7747efb848daf103b3d70271b18e1c6 100644 (file)
--- a/Documentation/DocBook/media/v4l/media-ioc-enum-entities.xml
+++ b/Documentation/DocBook/media/v4l/media-ioc-enum-entities.xml
@@ -145,7 +145,21 @@
            <entry>struct</entry>
            <entry><structfield>dev</structfield></entry>
            <entry></entry>
-           <entry>Valid for (sub-)devices that create devnodes.</entry>
+           <entry>Valid for (sub-)devices that create a single device node.</entry>
+         </row>
+         <row>
+           <entry></entry>
+           <entry></entry>
+           <entry>__u32</entry>
+           <entry><structfield>major</structfield></entry>
+           <entry>Device node major number.</entry>
+         </row>
+         <row>
+           <entry></entry>
+           <entry></entry>
+           <entry>__u32</entry>
+           <entry><structfield>minor</structfield></entry>
+           <entry>Device node minor number.</entry>
          </row>
          <row>
            <entry></entry>

diff --git a/include/uapi/linux/media.h b/include/uapi/linux/media.h
index 52cc2a6b19b76bd74c13d9dedc615b8e3aad5a94..4e816be3de39b404b3c21b9f27cc8e3b1eb00025 100644 (file)
--- a/include/uapi/linux/media.h
+++ b/include/uapi/linux/media.h
@@ -89,6 +89,27 @@ struct media_entity_desc {
                        __u32 minor;
                } dev;
 
+#if 1
+               /*
+                * TODO: this shouldn't have been added without
+                * actual drivers that use this. When the first real driver
+                * appears that sets this information, special attention
+                * should be given whether this information is 1) enough, and
+                * 2) can deal with udev rules that rename devices. The struct
+                * dev would not be sufficient for this since that does not
+                * contain the subdevice information. In addition, struct dev
+                * can only refer to a single device, and not to multiple (e.g.
+                * pcm and mixer devices).
+                *
+                * So for now mark this as a to do.
+                */
+               struct {
+                       __u32 card;
+                       __u32 device;
+                       __u32 subdevice;
+               } alsa;
+#endif
+
 #if 1
                /*
                 * DEPRECATED: previous node specifications. Kept just to
@@ -106,11 +127,6 @@ struct media_entity_desc {
                        __u32 major;
                        __u32 minor;
                } fb;
-               struct {
-                       __u32 card;
-                       __u32 device;
-                       __u32 subdevice;
-               } alsa;
                int dvb;
 #endif