From: David Kershner <david.kershner@unisys.com>
To: <corbet@lwn.net>, <tglx@linutronix.de>, <mingo@redhat.com>,
<hpa@zytor.com>, <david.kershner@unisys.com>,
<gregkh@linuxfoundation.org>, <erik.arfvidson@unisys.com>,
<timothy.sell@unisys.com>, <hofrat@osadl.org>,
<dzickus@redhat.com>, <jes.sorensen@redhat.com>,
<alexander.curtin@unisys.com>, <janani.rvchndrn@gmail.com>,
<sudipm.mukherjee@gmail.com>, <prarit@redhat.com>,
<david.binder@unisys.com>, <nhorman@redhat.com>,
<dan.j.williams@intel.com>, <linux-kernel@vger.kernel.org>,
<linux-doc@vger.kernel.org>,
<driverdev-devel@linuxdriverproject.org>,
<sparmaintainer@unisys.com>
Subject: [PATCH 18/24] staging: unisys: visorbus: make visorchipset function descriptions more kerneldoc-like
Date: Tue, 24 May 2016 23:45:56 -0400 [thread overview]
Message-ID: <1464147962-26650-19-git-send-email-david.kershner@unisys.com> (raw)
In-Reply-To: <1464147962-26650-1-git-send-email-david.kershner@unisys.com>
From: David Binder <david.binder@unisys.com>
Per audit feedback from Thomas Gleixner, function descriptions in
visorchipset.c now utilize a more kerneldoc-like formatting. The affected
comments do not implement other kerneldoc requirements.
Signed-off-by: David Binder <david.binder@unisys.com>
Signed-off-by: David Kershner <david.kershner@unisys.com>
---
drivers/staging/unisys/visorbus/visorchipset.c | 41 +++++++++++++++-----------
1 file changed, 24 insertions(+), 17 deletions(-)
diff --git a/drivers/staging/unisys/visorbus/visorchipset.c b/drivers/staging/unisys/visorbus/visorchipset.c
index 1da980f..189ba40 100644
--- a/drivers/staging/unisys/visorbus/visorchipset.c
+++ b/drivers/staging/unisys/visorbus/visorchipset.c
@@ -1300,7 +1300,8 @@ my_device_destroy(struct controlvm_message *inmsg)
inmsg->hdr.flags.response_expected == 1, 1);
}
-/* When provided with the physical address of the controlvm channel
+/**
+ * When provided with the physical address of the controlvm channel
* (phys_addr), the offset to the payload area we need to manage
* (offset), and the size of this payload area (bytes), fills in the
* controlvm_payload_info struct. Returns true for success or false
@@ -1368,8 +1369,9 @@ initialize_controlvm_payload(void)
&controlvm_payload_info);
}
-/* Send ACTION=online for DEVPATH=/sys/devices/platform/visorchipset.
- * Returns CONTROLVM_RESP_xxx code.
+/**
+ * Send ACTION=online for DEVPATH=/sys/devices/platform/visorchipset.
+ * Returns CONTROLVM_RESP_xxx code.
*/
static int
visorchipset_chipset_ready(void)
@@ -1390,8 +1392,9 @@ visorchipset_chipset_selftest(void)
return CONTROLVM_RESP_SUCCESS;
}
-/* Send ACTION=offline for DEVPATH=/sys/devices/platform/visorchipset.
- * Returns CONTROLVM_RESP_xxx code.
+/**
+ * Send ACTION=offline for DEVPATH=/sys/devices/platform/visorchipset.
+ * Returns CONTROLVM_RESP_xxx code.
*/
static int
visorchipset_chipset_notready(void)
@@ -1433,7 +1436,8 @@ chipset_notready(struct controlvm_message_header *msg_hdr)
controlvm_respond(msg_hdr, rc);
}
-/* This is your "one-stop" shop for grabbing the next message from the
+/**
+ * This is your "one-stop" shop for grabbing the next message from the
* CONTROLVM_QUEUE_EVENT queue in the controlvm channel.
*/
static bool
@@ -1464,7 +1468,7 @@ read_controlvm_event(struct controlvm_message *msg)
#define PARAHOTPLUG_TIMEOUT_MS 2000
-/*
+/**
* Generate unique int to match an outstanding CONTROLVM message with a
* udev script /proc response
*/
@@ -1476,7 +1480,7 @@ parahotplug_next_id(void)
return atomic_inc_return(&id);
}
-/*
+/**
* Returns the time (in jiffies) when a CONTROLVM message on the list
* should expire -- PARAHOTPLUG_TIMEOUT_MS in the future
*/
@@ -1486,7 +1490,7 @@ parahotplug_next_expiration(void)
return jiffies + msecs_to_jiffies(PARAHOTPLUG_TIMEOUT_MS);
}
-/*
+/**
* Create a parahotplug_request, which is basically a wrapper for a
* CONTROLVM_MESSAGE that we can stick on a list
*/
@@ -1506,7 +1510,7 @@ parahotplug_request_create(struct controlvm_message *msg)
return req;
}
-/*
+/**
* Free a parahotplug_request.
*/
static void
@@ -1515,7 +1519,7 @@ parahotplug_request_destroy(struct parahotplug_request *req)
kfree(req);
}
-/*
+/**
* Cause uevent to run the user level script to do the disable/enable
* specified in (the CONTROLVM message in) the specified
* parahotplug_request
@@ -1545,7 +1549,7 @@ parahotplug_request_kickoff(struct parahotplug_request *req)
envp);
}
-/*
+/**
* Remove any request from the list that's been on there too long and
* respond with an error.
*/
@@ -1576,7 +1580,7 @@ parahotplug_process_list(void)
spin_unlock(¶hotplug_request_list_lock);
}
-/*
+/**
* Called from the /proc handler, which means the user script has
* finished the enable/disable. Find the matching identifier, and
* respond to the CONTROLVM message with success.
@@ -1613,7 +1617,7 @@ parahotplug_request_complete(int id, u16 active)
return -EINVAL;
}
-/*
+/**
* Enables or disables a PCI device by kicking off a udev script
*/
static void
@@ -1656,7 +1660,8 @@ parahotplug_process_message(struct controlvm_message *inmsg)
}
}
-/* Process a controlvm message.
+/**
+ * Process a controlvm message.
* Return result:
* false - this function will return false only in the case where the
* controlvm message was NOT processed, but processing must be
@@ -2024,7 +2029,8 @@ device_resume_response(struct visor_device *dev_info, int response)
dev_info->pending_msg_hdr = NULL;
}
-/* The parahotplug/devicedisabled interface gets called by our support script
+/**
+ * The parahotplug/devicedisabled interface gets called by our support script
* when an SR-IOV device has been shut down. The ID is passed to the script
* and then passed back when the device has been removed.
*/
@@ -2041,7 +2047,8 @@ static ssize_t devicedisabled_store(struct device *dev,
return count;
}
-/* The parahotplug/deviceenabled interface gets called by our support script
+/**
+ * The parahotplug/deviceenabled interface gets called by our support script
* when an SR-IOV device has been recovered. The ID is passed to the script
* and then passed back when the device has been brought back up.
*/
--
1.9.1
next prev parent reply other threads:[~2016-05-25 3:47 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-05-25 3:45 [PATCH 00/24] Fixes comments made by tglx, then move visorbus to drivers/virt David Kershner
2016-05-25 3:45 ` [PATCH 01/24] staging: unisys: visorbus: remove unused module parameters David Kershner
2016-05-25 3:45 ` [PATCH 02/24] staging: unisys: visorbus: remove unused struct David Kershner
2016-05-25 3:45 ` [PATCH 03/24] staging: unisys: visorbus: modify format string to match argument David Kershner
2016-05-25 3:45 ` [PATCH 04/24] staging: unisys: visornic: Correct comment spelling mistake David Kershner
2016-05-25 3:45 ` [PATCH 05/24] staging: unisys: include: Remove thread-related enum members David Kershner
2016-05-25 3:45 ` [PATCH 06/24] staging: unisys: visorbus: removed unused periodic_test_workqueue David Kershner
2016-05-25 3:45 ` [PATCH 07/24] staging: unisys: visorinput: remove unnecessary locking David Kershner
2016-05-25 3:45 ` [PATCH 08/24] staging: unisys: visorbus: use kernel timer instead of workqueue David Kershner
2016-05-25 3:45 ` [PATCH 09/24] staging: unisys: visorbus: remove periodic_work.h/.c David Kershner
2016-05-25 3:45 ` [PATCH 10/24] staging: unisys: visorbus: Make visordriver_callback_lock a mutex David Kershner
2016-05-25 3:45 ` [PATCH 11/24] staging: unisys: visorbus: Remove unnecessary EXPORT_SYMBOL statements David Kershner
2016-05-25 3:45 ` [PATCH 12/24] staging: unisys: visorbus: Remove unused functions David Kershner
2016-05-25 3:45 ` [PATCH 13/24] staging: unisys: Remove reference to unused STANDALONE_CLIENT David Kershner
2016-05-25 3:45 ` [PATCH 14/24] staging: unisys: visorbus: vbusdeviceinfo function descriptions more kerneldoc-like David Kershner
2016-05-25 3:45 ` [PATCH 15/24] staging: unisys: visorbus: make " David Kershner
2016-05-25 3:45 ` [PATCH 16/24] staging: unisys: visorbus: make visorbus_private.h " David Kershner
2016-05-25 3:45 ` [PATCH 17/24] staging: unisys: visorbus: make visorchannel " David Kershner
2016-05-25 3:45 ` David Kershner [this message]
2016-05-25 3:45 ` [PATCH 19/24] staging: unisys: visorbus: Move visorbus-unique functions to private header David Kershner
2016-05-25 3:45 ` [PATCH 20/24] staging: unisys: visorbus: Add kerneldoc-style comments for visorbus API David Kershner
2016-05-25 3:45 ` [PATCH 21/24] staging: unisys: Move vbushelper.h to visorbus directory David Kershner
2016-05-25 3:46 ` [PATCH 22/24] include: linux: visorbus: Add visorbus to include/linux directory David Kershner
2016-05-25 3:46 ` [PATCH 23/24] Documentation: Move visorbus documentation from staging to Documentation/ David Kershner
2016-05-25 3:46 ` [PATCH 24/24] drivers: Add visorbus to the drivers directory David Kershner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1464147962-26650-19-git-send-email-david.kershner@unisys.com \
--to=david.kershner@unisys.com \
--cc=alexander.curtin@unisys.com \
--cc=corbet@lwn.net \
--cc=dan.j.williams@intel.com \
--cc=david.binder@unisys.com \
--cc=driverdev-devel@linuxdriverproject.org \
--cc=dzickus@redhat.com \
--cc=erik.arfvidson@unisys.com \
--cc=gregkh@linuxfoundation.org \
--cc=hofrat@osadl.org \
--cc=hpa@zytor.com \
--cc=janani.rvchndrn@gmail.com \
--cc=jes.sorensen@redhat.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mingo@redhat.com \
--cc=nhorman@redhat.com \
--cc=prarit@redhat.com \
--cc=sparmaintainer@unisys.com \
--cc=sudipm.mukherjee@gmail.com \
--cc=tglx@linutronix.de \
--cc=timothy.sell@unisys.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).