staging: comedi: comedidev.h: use enum for COMEDI_CB_... constants
authorIan Abbott <abbotti@mev.co.uk>
Mon, 21 Sep 2015 17:52:47 +0000 (18:52 +0100)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Tue, 29 Sep 2015 01:25:02 +0000 (03:25 +0200)
The existing constants `COMEDI_CB_EOS` etc. are in the form of macros
and have a bogus kernel-doc comment.  Change them to `enum` constants so
they can be documented properly with kernel-doc.

Signed-off-by: Ian Abbott <abbotti@mev.co.uk>
Reviewed-by: H Hartley Sweeten <hsweeten@visionengravers.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/staging/comedi/comedidev.h

index 097c3d5..76a1b93 100644 (file)
@@ -216,26 +216,27 @@ struct comedi_async {
 };
 
 /**
- * comedi_async callback "events"
+ * enum comedi_cb - &struct comedi_async callback "events"
  * @COMEDI_CB_EOS:             end-of-scan
  * @COMEDI_CB_EOA:             end-of-acquisition/output
  * @COMEDI_CB_BLOCK:           data has arrived, wakes up read() / write()
  * @COMEDI_CB_EOBUF:           DEPRECATED: end of buffer
  * @COMEDI_CB_ERROR:           card error during acquisition
  * @COMEDI_CB_OVERFLOW:                buffer overflow/underflow
- *
  * @COMEDI_CB_ERROR_MASK:      events that indicate an error has occurred
  * @COMEDI_CB_CANCEL_MASK:     events that will cancel an async command
  */
-#define COMEDI_CB_EOS          BIT(0)
-#define COMEDI_CB_EOA          BIT(1)
-#define COMEDI_CB_BLOCK                BIT(2)
-#define COMEDI_CB_EOBUF                BIT(3)
-#define COMEDI_CB_ERROR                BIT(4)
-#define COMEDI_CB_OVERFLOW     BIT(5)
-
-#define COMEDI_CB_ERROR_MASK   (COMEDI_CB_ERROR | COMEDI_CB_OVERFLOW)
-#define COMEDI_CB_CANCEL_MASK  (COMEDI_CB_EOA | COMEDI_CB_ERROR_MASK)
+enum comedi_cb {
+       COMEDI_CB_EOS           = BIT(0),
+       COMEDI_CB_EOA           = BIT(1),
+       COMEDI_CB_BLOCK         = BIT(2),
+       COMEDI_CB_EOBUF         = BIT(3),
+       COMEDI_CB_ERROR         = BIT(4),
+       COMEDI_CB_OVERFLOW      = BIT(5),
+       /* masks */
+       COMEDI_CB_ERROR_MASK    = (COMEDI_CB_ERROR | COMEDI_CB_OVERFLOW),
+       COMEDI_CB_CANCEL_MASK   = (COMEDI_CB_EOA | COMEDI_CB_ERROR_MASK)
+};
 
 struct comedi_driver {
        struct comedi_driver *next;