[media] demux.h: Convert MPEG-TS demux caps to an enum
authorMauro Carvalho Chehab <mchehab@osg.samsung.com>
Thu, 8 Oct 2015 20:33:47 +0000 (17:33 -0300)
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>
Sat, 10 Oct 2015 13:29:08 +0000 (10:29 -0300)
While we can't document #defines, documenting enums are
well supported by kernel-doc. So, convert the bitmap defines
into an enum.

Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
drivers/media/dvb-core/demux.h

index 98bff5cc4ff4e05b87ec9043399eddf729d40b82..ccc1f43cb9a9b11767c0eee35aa323f908fee370 100644 (file)
@@ -332,16 +332,20 @@ struct dmx_frontend {
  * MPEG-2 TS Demux
  */
 
-/*
- * Flags OR'ed in the capabilities field of struct dmx_demux.
+/**
+ * enum dmx_demux_caps - MPEG-2 TS Demux capabilities bitmap
+ *
+ * @DMX_TS_FILTERING:          set if TS filtering is supported;
+ * @DMX_SECTION_FILTERING:     set if section filtering is supported;
+ * @DMX_MEMORY_BASED_FILTERING:        set if write() available.
+ *
+ * Those flags are OR'ed in the &dmx_demux.&capabilities field
  */
-
-#define DMX_TS_FILTERING                        1
-#define DMX_PES_FILTERING                       2
-#define DMX_SECTION_FILTERING                   4
-#define DMX_MEMORY_BASED_FILTERING              8    /* write() available */
-#define DMX_CRC_CHECKING                        16
-#define DMX_TS_DESCRAMBLING                     32
+enum dmx_demux_caps {
+       DMX_TS_FILTERING = 1,
+       DMX_SECTION_FILTERING = 4,
+       DMX_MEMORY_BASED_FILTERING = 8,
+};
 
 /*
  * Demux resource type identifier.
@@ -361,7 +365,7 @@ struct dmx_frontend {
  * struct dmx_demux - Structure that contains the demux capabilities and
  *                   callbacks.
  *
- * @capabilities: Bitfield of capability flags
+ * @capabilities: Bitfield of capability flags.
  *
  * @frontend: Front-end connected to the demux
  *
@@ -549,7 +553,7 @@ struct dmx_frontend {
  */
 
 struct dmx_demux {
-       u32 capabilities;
+       enum dmx_demux_caps capabilities;
        struct dmx_frontend *frontend;
        void *priv;
        int (*open)(struct dmx_demux *demux);