From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1755555AbcEYDrj (ORCPT ); Tue, 24 May 2016 23:47:39 -0400 Received: from mail1.bemta12.messagelabs.com ([216.82.251.16]:15008 "EHLO mail1.bemta12.messagelabs.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1755402AbcEYDq5 (ORCPT ); Tue, 24 May 2016 23:46:57 -0400 X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFtrLIsWRWlGSWpSXmKPExsVywNY2U1dOwTX cYPliLYuFbUtYLC7vmsPmwOTxeZNcAGMUa2ZeUn5FAmvGxYXTWAuua1ZMPHOUpYHxnVIXIyeH kMBuRok7J126GLmA7AOMEiuvzmWBcC4zSpy9cJ8ZwlnHKHFs/0ImCGcLo0Tv211sIP1sAgYSM +/cZQexRQTOs0g8vZULYgsL5Ep8WPWGEcRmEVCVOL/uODOIzSvgJXH+3SewXgkBOYmTxyazgt icQPENDd+YIG7ylHh/u4EVwlaTOHz2EVR9sMSqvUvZIOYISpyc+YQFxGYWkJA4+OIF8wRGwVl IUrOQpBYwMq1i1ChOLSpLLdI1NNNLKspMzyjJTczM0TU0NNLLTS0uTkxPzUlMKtZLzs/dxAgM 1noGBsYdjI3TvQ4xSnIwKYnyHnziEi7El5SfUpmRWJwRX1Sak1p8iFGGg0NJgneBnGu4kGBRa npqRVpmDjBuYNISHDxKIrxvQNK8xQWJucWZ6RCpU4yKUuK8eSAJAZBERmkeXBssVi8xykoJ8z IyMDAI8RSkFuVmlqDKv2IU52BUEub9AjKFJzOvBG76K6DFTECL/b84gywuSURISTUwKhZMn+d /tnyqhM3+q9UROukBGUciS2ZJCm7Xl1d+cd/C4ONzn8ucK3vX5n9g0vtuNJ1LsenXhhPntjVJ TCtcFr5SUUlU+ufuTfqW/RmGZtO+bDj1gzvc/XCq3cWY3sll+h1fzx794BMYdmydzmeL145lA V3HVSX9JSczPWEzijTefOi5YU+XEktxRqKhFnNRcSIArAKVa9ACAAA= X-Env-Sender: David.Kershner@unisys.com X-Msg-Ref: server-8.tower-153.messagelabs.com!1464147993!18510414!16 X-Originating-IP: [192.61.61.105] X-StarScan-Received: X-StarScan-Version: 8.34; banners=-,-,- X-VirusChecked: Checked From: David Kershner To: , , , , , , , , , , , , , , , , , , , , , Subject: [PATCH 18/24] staging: unisys: visorbus: make visorchipset function descriptions more kerneldoc-like Date: Tue, 24 May 2016 23:45:56 -0400 Message-ID: <1464147962-26650-19-git-send-email-david.kershner@unisys.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1464147962-26650-1-git-send-email-david.kershner@unisys.com> References: <1464147962-26650-1-git-send-email-david.kershner@unisys.com> X-OriginalArrivalTime: 25 May 2016 03:46:25.0197 (UTC) FILETIME=[02CE8DD0:01D1B638] MIME-Version: 1.0 Content-Type: text/plain Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org From: David Binder 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 Signed-off-by: David Kershner --- 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