media: dvb_demux.h: add an enum for DMX_STATE_* and document

kernel-doc allows documenting enums. Also, it makes clearer
about the meaning of each field on structures.

So, convert DMX_STATE_* to an enum.

While here, get rid of the unused DMX_STATE_SET.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

diff --git a/drivers/media/dvb-core/dvb_demux.h b/drivers/media/dvb-core/dvb_demux.h
index 6bc4b27dbff310d44a55383f6f0067914dc43a3a..b24d69b5a20f8a10e0c8d63364d3bc92f858b7b4 100644 (file)
--- a/drivers/media/dvb-core/dvb_demux.h
+++ b/drivers/media/dvb-core/dvb_demux.h
@@ -37,11 +37,22 @@ enum dvb_dmx_filter_type {
        DMX_TYPE_SEC,
 };
 
-#define DMX_STATE_FREE      0
-#define DMX_STATE_ALLOCATED 1
-#define DMX_STATE_SET       2
-#define DMX_STATE_READY     3
-#define DMX_STATE_GO        4
+/**
+ * enum dvb_dmx_state - state machine for a demux filter.
+ *
+ * @DMX_STATE_FREE:            indicates that the filter is freed.
+ * @DMX_STATE_ALLOCATED:       indicates that the filter was allocated
+ *                             to be used.
+ * @DMX_STATE_READY:           indicates that the filter is ready
+ *                             to be used.
+ * @DMX_STATE_GO:              indicates that the filter is running.
+ */
+enum dvb_dmx_state {
+       DMX_STATE_FREE,
+       DMX_STATE_ALLOCATED,
+       DMX_STATE_READY,
+       DMX_STATE_GO,
+};
 
 #define DVB_DEMUX_MASK_MAX 18
 
@@ -58,7 +69,7 @@ struct dvb_demux_filter {
        struct dvb_demux_filter *next;
        struct dvb_demux_feed *feed;
        int index;
-       int state;
+       enum dvb_dmx_state state;
        enum dvb_dmx_filter_type type;
 
        u16 hw_handle;
@@ -81,7 +92,7 @@ struct dvb_demux_feed {
        struct dvb_demux *demux;
        void *priv;
        enum dvb_dmx_filter_type type;
-       int state;
+       enum dvb_dmx_state state;
        u16 pid;
 
        ktime_t timeout;