From patchwork Wed Dec 17 15:51:11 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ricardo Ribalda Delgado X-Patchwork-Id: 422295 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 6DAF21400DE for ; Thu, 18 Dec 2014 02:51:44 +1100 (AEDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751429AbaLQPvZ (ORCPT ); Wed, 17 Dec 2014 10:51:25 -0500 Received: from mail-la0-f53.google.com ([209.85.215.53]:32916 "EHLO mail-la0-f53.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751392AbaLQPvW (ORCPT ); Wed, 17 Dec 2014 10:51:22 -0500 Received: by mail-la0-f53.google.com with SMTP id gm9so13219604lab.26 for ; Wed, 17 Dec 2014 07:51:21 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=vz4mkHV//bfeo5uFb0eq+rvAJa4l15rSTBbcjKL3LBs=; b=T27eHNmOdjHynFNVf8hix+6GPVceh/gcUhH0PyWNzsYJ2o4Q4aJHfiPYnMmE+tc3hd oLUsJ0c/fcatihgIsryq4J1KwzTydwKjCJLVNi2Tyw21C43b2X4ZQjLgFIbae4j0r8gB Fpj22xadMWQK5sXLfBQ5E6ok53QRIJC8kjVNquG8ISF8DlWLYeNnleKMIiBGNU+Nplu8 /qby5C5/MnkFKiEx+Nbx/LfBzPeTCLiM3jtf4rGm+6h5Akakfm3HmedeV76uulhgLUwu nIgT3RfSFV4wr6DDbTNJwC+Tmzi5w7Rc7cCO/qPiw95mdDB/dzEIt2xLhVp3JQ43PVcV ZTcg== X-Received: by 10.152.22.67 with SMTP id b3mr38736074laf.82.1418831480962; Wed, 17 Dec 2014 07:51:20 -0800 (PST) Received: from neopili.qtec.com (cpe.xe-3-0-1-778.vbrnqe10.dk.customer.tdc.net. [80.197.57.18]) by mx.google.com with ESMTPSA id n4sm1031577lan.39.2014.12.17.07.51.20 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 17 Dec 2014 07:51:20 -0800 (PST) From: Ricardo Ribalda Delgado To: Linus Walleij , Alexandre Courbot , Michal Simek , =?UTF-8?q?S=C3=B6ren=20Brinkmann?= , linux-gpio@vger.kernel.org, linux-kernel@vger.kernel.org Cc: Ricardo Ribalda Delgado Subject: [PATCH v5 4/7] gpio/xilinx: Fix kernel-doc Date: Wed, 17 Dec 2014 16:51:11 +0100 Message-Id: <1418831474-24428-5-git-send-email-ricardo.ribalda@gmail.com> X-Mailer: git-send-email 2.1.3 In-Reply-To: <1418831474-24428-1-git-send-email-ricardo.ribalda@gmail.com> References: <1418831474-24428-1-git-send-email-ricardo.ribalda@gmail.com> Sender: linux-gpio-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-gpio@vger.kernel.org Some documentation were not following the kernel-doc format. Backporting patch from Xilinx git repository. Suggested-by: Michal Simek Acked-by: Michal Simek Acked-by: Alexandre Courbot Signed-off-by: Ricardo Ribalda Delgado --- drivers/gpio/gpio-xilinx.c | 37 +++++++++++++++++++++---------------- 1 file changed, 21 insertions(+), 16 deletions(-) diff --git a/drivers/gpio/gpio-xilinx.c b/drivers/gpio/gpio-xilinx.c index 554060a..9cf4457 100644 --- a/drivers/gpio/gpio-xilinx.c +++ b/drivers/gpio/gpio-xilinx.c @@ -40,11 +40,11 @@ /** * struct xgpio_instance - Stores information about GPIO device - * struct of_mm_gpio_chip mmchip: OF GPIO chip for memory mapped banks - * gpio_state: GPIO state shadow register - * gpio_dir: GPIO direction shadow register - * gpio_lock: Lock used for synchronization - * inited: True if the port has been inited + * @mmchip: OF GPIO chip for memory mapped banks + * @gpio_state: GPIO state shadow register + * @gpio_dir: GPIO direction shadow register + * @gpio_lock: Lock used for synchronization + * @inited: True if the port has been inited */ struct xgpio_instance { struct of_mm_gpio_chip mmchip; @@ -63,8 +63,11 @@ struct xgpio { * @gc: Pointer to gpio_chip device structure. * @gpio: GPIO signal number. * - * This function reads the specified signal of the GPIO device. It returns 0 if - * the signal clear, 1 if signal is set or negative value on error. + * This function reads the specified signal of the GPIO device. + * + * Return: + * 0 if direction of GPIO signals is set as input otherwise it + * returns negative error value. */ static int xgpio_get(struct gpio_chip *gc, unsigned int gpio) { @@ -107,9 +110,9 @@ static void xgpio_set(struct gpio_chip *gc, unsigned int gpio, int val) * @gc: Pointer to gpio_chip device structure. * @gpio: GPIO signal number. * - * This function sets the direction of specified GPIO signal as input. - * It returns 0 if direction of GPIO signals is set as input otherwise it - * returns negative error value. + * Return: + * 0 - if direction of GPIO signals is set as input + * otherwise it returns negative error value. */ static int xgpio_dir_in(struct gpio_chip *gc, unsigned int gpio) { @@ -135,8 +138,10 @@ static int xgpio_dir_in(struct gpio_chip *gc, unsigned int gpio) * @gpio: GPIO signal number. * @val: Value to be written to specified signal. * - * This function sets the direction of specified GPIO signal as output. If all - * GPIO signals of GPIO chip is configured as input then it returns + * This function sets the direction of specified GPIO signal as output. + * + * Return: + * If all GPIO signals of GPIO chip is configured as input then it returns * error otherwise it returns 0. */ static int xgpio_dir_out(struct gpio_chip *gc, unsigned int gpio, int val) @@ -166,7 +171,7 @@ static int xgpio_dir_out(struct gpio_chip *gc, unsigned int gpio, int val) /** * xgpio_save_regs - Set initial values of GPIO pins - * @mm_gc: pointer to memory mapped GPIO chip structure + * @mm_gc: Pointer to memory mapped GPIO chip structure */ static void xgpio_save_regs(struct of_mm_gpio_chip *mm_gc) { @@ -207,9 +212,9 @@ static int xgpio_remove(struct platform_device *pdev) * xgpio_of_probe - Probe method for the GPIO device. * @pdev: pointer to the platform device * - * This function probes the GPIO device in the device tree. It initializes the - * driver data structure. It returns 0, if the driver is bound to the GPIO - * device, or a negative value if there is an error. + * Return: + * It returns 0, if the driver is bound to the GPIO device, or + * a negative value if there is an error. */ static int xgpio_probe(struct platform_device *pdev) {