[media] demux.h: Convert TS filter type into enum
authorMauro Carvalho Chehab <mchehab@osg.samsung.com>
Thu, 8 Oct 2015 20:21:48 +0000 (17:21 -0300)
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>
Sat, 10 Oct 2015 13:29:07 +0000 (10:29 -0300)
The usage of #define at the kABI is fine, but it doesn't
allow adding a proper description. As those defines deserve
a proper documentation, let's convert them into an enum and
document them at device-drivers DocBook.

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

index 576e30fc5c1884a07917747225e834455e456cfb..98bff5cc4ff4e05b87ec9043399eddf729d40b82 100644 (file)
  * TS packet reception
  */
 
-/* TS filter type for set() */
-
-#define TS_PACKET       1   /*
-                            * send TS packets (188 bytes) to callback
-                            * (default)
-                            */
-
-#define        TS_PAYLOAD_ONLY 2   /*
-                            * in case TS_PACKET is set, only send the TS
-                            * payload (<=184 bytes per packet) to callback
-                            */
-
-#define TS_DECODER      4   /*
-                            * send stream to built-in decoder (if present)
-                            */
-
-#define TS_DEMUX        8   /*
-                            * in case TS_PACKET is set, send the TS to
-                            * the demux device, not to the dvr device
-                            */
+/**
+ * enum ts_filter_type - filter type bitmap for dmx_ts_feed.set()
+ *
+ * @TS_PACKET:         Send TS packets (188 bytes) to callback (default).
+ * @TS_PAYLOAD_ONLY:   In case TS_PACKET is set, only send the TS payload
+ *                     (<=184 bytes per packet) to callback
+ * @TS_DECODER:                Send stream to built-in decoder (if present).
+ * @TS_DEMUX:          In case TS_PACKET is set, send the TS to the demux
+ *                     device, not to the dvr device
+ */
+enum ts_filter_type {
+       TS_PACKET = 1,
+       TS_PAYLOAD_ONLY = 2,
+       TS_DECODER = 4,
+       TS_DEMUX = 8,
+};
 
 /**
  * struct dmx_ts_feed - Structure that contains a TS feed filter