staging: unisys: visorbus: vmcallinterface.h: fixed comment formatting issues

Removed comments from the right side of the lines.

Added kernel-doc like comments and cleaned up the inline comments in the
structures.

Signed-off-by: Sameer Wadgaonkar <sameer.wadgaonkar@unisys.com>
Signed-off-by: David Kershner <david.kershner@unisys.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

diff --git a/drivers/staging/unisys/visorbus/vmcallinterface.h b/drivers/staging/unisys/visorbus/vmcallinterface.h
index cc70e1b16bda37e3fe754c93d2bdce19cf08650c..de6693f83c6b2f709e21294b863e4bc5d20afcfc 100644 (file)
--- a/drivers/staging/unisys/visorbus/vmcallinterface.h
+++ b/drivers/staging/unisys/visorbus/vmcallinterface.h
@@ -1,4 +1,5 @@
-/* Copyright (C) 2010 - 2015 UNISYS CORPORATION
+/*
+ * Copyright (C) 2010 - 2015 UNISYS CORPORATION
  * All rights reserved.
  *
  * This program is free software; you can redistribute it and/or modify it
@@ -15,18 +16,20 @@
 #ifndef __VMCALLINTERFACE_H__
 #define __VMCALLINTERFACE_H__
 
-enum vmcall_monitor_interface_method_tuple { /* VMCALL identification tuples  */
-           /* Note: when a new VMCALL is added:
-            * - the 1st 2 hex digits correspond to one of the
-            *   VMCALL_MONITOR_INTERFACE types and
-            * - the next 2 hex digits are the nth relative instance of within a
-            *   type
-            * E.G. for VMCALL_VIRTPART_RECYCLE_PART,
-            * - the 0x02 identifies it as a VMCALL_VIRTPART type and
-            * - the 0x01 identifies it as the 1st instance of a VMCALL_VIRTPART
-            *   type of VMCALL
-            */
-       /* used by all Guests, not just IO */
+/*
+ * enum vmcall_monitor_interface_method_tuple - VMCALL identification tuples.
+ * @VMCALL_CONTROLVM_ADDR: Used by all guests, not just IO.
+ *
+ * Note: When a new VMCALL is added:
+ * - The 1st 2 hex digits correspond to one of the VMCALL_MONITOR_INTERFACE
+ *   types.
+ * - The next 2 hex digits are the nth relative instance of within a type.
+ * E.G. for VMCALL_VIRTPART_RECYCLE_PART,
+ * - The 0x02 identifies it as a VMCALL_VIRTPART type.
+ * - The 0x01 identifies it as the 1st instance of a VMCALL_VIRTPART type of
+ *   VMCALL.
+ */
+enum vmcall_monitor_interface_method_tuple {
        VMCALL_CONTROLVM_ADDR = 0x0501,
 };
 
@@ -39,16 +42,23 @@ enum vmcall_result {
        VMCALL_RESULT_DEVICE_NOT_READY = 5
 };
 
-/* Structures for IO VMCALLs */
-/* Parameters to VMCALL_CONTROLVM_ADDR interface */
+/*
+ * struct vmcall_io_controlvm_addr_params - Structure for IO VMCALLS. Has
+ *                                         parameters to VMCALL_CONTROLVM_ADDR
+ *                                         interface.
+ * @address:      The Guest-relative physical address of the ControlVm channel.
+ *                This VMCall fills this in with the appropriate address.
+ *                Contents provided by this VMCALL (OUT).
+ * @channel_bytes: The size of the ControlVm channel in bytes This VMCall fills
+ *                this in with the appropriate address. Contents provided by
+ *                this VMCALL (OUT).
+ * @unused:       Unused Bytes in the 64-Bit Aligned Struct.
+ */
 struct vmcall_io_controlvm_addr_params {
-       /* The Guest-relative physical address of the ControlVm channel. */
-       /* This VMCall fills this in with the appropriate address. */
-       u64 address;    /* contents provided by this VMCALL (OUT) */
-       /* the size of the ControlVm channel in bytes This VMCall fills this */
-       /* in with the appropriate address. */
-       u32 channel_bytes;      /* contents provided by this VMCALL (OUT) */
-       u8 unused[4];           /* Unused Bytes in the 64-Bit Aligned Struct */
+       u64 address;
+       u32 channel_bytes;
+       u8 unused[4];
 } __packed;
 
-#endif /* __VMCALLINTERFACE_H__ */
+/* __VMCALLINTERFACE_H__ */
+#endif