From patchwork Mon Apr 23 20:11:57 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andres Rodriguez X-Patchwork-Id: 10358055 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 6B08C60225 for ; Mon, 23 Apr 2018 20:13:15 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 5A5A028C29 for ; Mon, 23 Apr 2018 20:13:15 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 4EF8028C2D; Mon, 23 Apr 2018 20:13:15 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.9 required=2.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED, DKIM_SIGNED, DKIM_VALID, FREEMAIL_FROM, MAILING_LIST_MULTI autolearn=ham version=3.3.1 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (using TLSv1.2 with cipher AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 9F39228C29 for ; Mon, 23 Apr 2018 20:13:14 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:MIME-Version:Cc:List-Subscribe: List-Help:List-Post:List-Archive:List-Unsubscribe:List-Id:References: In-Reply-To:Message-Id:Date:Subject:To:From:Reply-To:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Owner; bh=/4+3h7kZBV0mWk0+gXtihZkh5E1ZjFroGhw/7CIAxa8=; b=aXkgLLDirlcZU0U4CxoATeSxLy codW14s3LQE/7U0HT3C4HwGjfdm7QtFzqEdG3R3vcVs1vFQ9NcrSSgKy4aktNQmJCW3srGo2Jg6ha i+pyUhpGFAkRxNzMtn6lSacKi6G/3wIA3iZYroKfG+mSPXqGYDZFx48op4g8ulCVEnV00cZok+ZpF XCSQ+Tl6vLrTmGqjTFa9hdZWpO7vlLAfqE4WkLtITFu/tVLpiv/l8gK8hMnJavGFChGTIwhz6xWBU Yq6e8ZnShw+BghtUMUzK2rwy/j7pAqHB19OXvaOyPWNpF0aFhNiQhfpGsGYtKVbG+8Y00hJ2q10Sj IqE82Y0Q==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.90_1 #2 (Red Hat Linux)) id 1fAhph-00056w-IL; Mon, 23 Apr 2018 20:13:05 +0000 Received: from mail-io0-x243.google.com ([2607:f8b0:4001:c06::243]) by bombadil.infradead.org with esmtps (Exim 4.90_1 #2 (Red Hat Linux)) id 1fAhp5-0004lL-5L for ath10k@lists.infradead.org; Mon, 23 Apr 2018 20:12:33 +0000 Received: by mail-io0-x243.google.com with SMTP id o7-v6so18160008iob.8 for ; Mon, 23 Apr 2018 13:12:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=pFVa8UChjt88Sb1aip39w+x6+lytthy+XOvOofff2QI=; b=eGRzrD6J5T+4HEA3GtF4bRflHQaLSs6oG0X6SYxUENZwpcErClqxzG70JX1SJs9jiK 6zsvOP2g6FM0//O3Ncl88PgMrEKbWFCl3dYE3hvWsLLB9fXAX5Gl6ASajB0Q7rIGLByq 2ZtGREKufm6AK/5T97HJLOyRyb7Xdm12xAOZUluXZstTsPXPM31aIqJmZNHuerEBBOMm XxAt6HUYvysW5/w71pKTbnnSX1MHI8oOAzRn2MY2zjYYH5oo1/Buggg/NKtF5D8EmGIW V1/82o/xeHCgJAzvhvc9O/3gDLcOjV1CyyHYdHARrsa1oro/5zmIGG1irL1XsH6DHc4Z M2/g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=pFVa8UChjt88Sb1aip39w+x6+lytthy+XOvOofff2QI=; b=Tfa6aRcLFO6C5PYpBM0Nmk8gfXAHEE8OxK1AO0QxKiXNb/Tcax/ZQZnt9til5X8rrz 6qJmdRWDMOojXpLe2KjrK5SyvbjfY9dnGQtSRUk5M2HAisYMW9gnsAgz34XXV8GLzF7G hfd/rxJ5qY8FxvTEDW5K0rEJm2HSL3PzQ0VO6IOEI4ET8f0eYYszaWG10l/SE5PXu8QX IuIOoKSBYs4Ew3G9PxgeZPSHhO9PoAOEnVKSPX57esMLsbyE/fH/TyWjJUdAvj8O1zXV C55gpGIK5oQekcWXfTCpvx89aCFvBF/hPuF4Ql2ynx9zmMSDCqTgNW7VsvpCX5eTkmGn y8fw== X-Gm-Message-State: ALQs6tDkHmYBZuc222KBGcWUCXkhaStfQmqQKYt51Q5agecIGvyncKMh VqIeTez7PUgqRrju7G69nNg= X-Google-Smtp-Source: AIpwx4+O0SbKqCDByXi14yFZ4TSvvdp2fOoU0lKaW0scv+LCeWFBVBRlHWBNX2iBexjoyk9OTuGhoQ== X-Received: by 2002:a6b:998d:: with SMTP id b135-v6mr15395547ioe.122.1524514335553; Mon, 23 Apr 2018 13:12:15 -0700 (PDT) Received: from localhost.localdomain (184-175-36-239.dsl.teksavvy.com. [184.175.36.239]) by smtp.gmail.com with ESMTPSA id k130-v6sm1632551itb.0.2018.04.23.13.12.14 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 23 Apr 2018 13:12:14 -0700 (PDT) From: Andres Rodriguez To: linux-kernel@vger.kernel.org Subject: [PATCH 1/9] firmware: some documentation fixes Date: Mon, 23 Apr 2018 16:11:57 -0400 Message-Id: <20180423201205.20533-2-andresx7@gmail.com> X-Mailer: git-send-email 2.14.1 In-Reply-To: <20180423201205.20533-1-andresx7@gmail.com> References: <20180423201205.20533-1-andresx7@gmail.com> X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20180423_131227_254304_C47F3283 X-CRM114-Status: UNSURE ( 9.75 ) X-CRM114-Notice: Please train this message. X-BeenThere: ath10k@lists.infradead.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: arend.vanspriel@broadcom.com, gregkh@linuxfoundation.org, linux-wireless@vger.kernel.org, ath10k@lists.infradead.org, hdegoede@redhat.com, mcgrof@kernel.org, andresx7@gmail.com, alexdeucher@gmail.com, christian.koenig@amd.com, kvalo@codeaurora.org MIME-Version: 1.0 Sender: "ath10k" Errors-To: ath10k-bounces+patchwork-ath10k=patchwork.kernel.org@lists.infradead.org X-Virus-Scanned: ClamAV using ClamSMTP Including: - Fixup outdated kernel-doc paths - Slightly too short title underline - Some typos Signed-off-by: Andres Rodriguez --- Documentation/driver-api/firmware/request_firmware.rst | 16 ++++++++-------- drivers/base/firmware_loader/fallback.c | 4 ++-- drivers/base/firmware_loader/fallback.h | 2 +- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/Documentation/driver-api/firmware/request_firmware.rst b/Documentation/driver-api/firmware/request_firmware.rst index 9305bf4db38e..7632f8807472 100644 --- a/Documentation/driver-api/firmware/request_firmware.rst +++ b/Documentation/driver-api/firmware/request_firmware.rst @@ -17,17 +17,17 @@ an error is returned. firmware_request ---------------- -.. kernel-doc:: drivers/base/firmware_class.c +.. kernel-doc:: drivers/base/firmware_loader/main.c :functions: firmware_request firmware_request_direct ----------------------- -.. kernel-doc:: drivers/base/firmware_class.c +.. kernel-doc:: drivers/base/firmware_loader/main.c :functions: firmware_request_direct firmware_request_into_buf ------------------------- -.. kernel-doc:: drivers/base/firmware_class.c +.. kernel-doc:: drivers/base/firmware_loader/main.c :functions: firmware_request_into_buf Asynchronous firmware requests @@ -41,7 +41,7 @@ in atomic contexts. firmware_request_nowait ----------------------- -.. kernel-doc:: drivers/base/firmware_class.c +.. kernel-doc:: drivers/base/firmware_loader/main.c :functions: firmware_request_nowait Special optimizations on reboot @@ -50,12 +50,12 @@ Special optimizations on reboot Some devices have an optimization in place to enable the firmware to be retained during system reboot. When such optimizations are used the driver author must ensure the firmware is still available on resume from suspend, -this can be done with firmware_request_cache() insted of requesting for the -firmare to be loaded. +this can be done with firmware_request_cache() instead of requesting for the +firmware to be loaded. firmware_request_cache() ------------------------ -.. kernel-doc:: drivers/base/firmware_class.c +------------------------ +.. kernel-doc:: drivers/base/firmware_loader/main.c :functions: firmware_request_cache request firmware API expected driver use diff --git a/drivers/base/firmware_loader/fallback.c b/drivers/base/firmware_loader/fallback.c index 71f529de5243..da97fc26119c 100644 --- a/drivers/base/firmware_loader/fallback.c +++ b/drivers/base/firmware_loader/fallback.c @@ -536,8 +536,8 @@ fw_create_instance(struct firmware *firmware, const char *fw_name, } /** - * fw_load_sysfs_fallback - load a firmware via the syfs fallback mechanism - * @fw_sysfs: firmware syfs information for the firmware to load + * fw_load_sysfs_fallback - load a firmware via the sysfs fallback mechanism + * @fw_sysfs: firmware sysfs information for the firmware to load * @opt_flags: flags of options, FW_OPT_* * @timeout: timeout to wait for the load * diff --git a/drivers/base/firmware_loader/fallback.h b/drivers/base/firmware_loader/fallback.h index dfebc644ed35..f8255670a663 100644 --- a/drivers/base/firmware_loader/fallback.h +++ b/drivers/base/firmware_loader/fallback.h @@ -6,7 +6,7 @@ #include /** - * struct firmware_fallback_config - firmware fallback configuratioon settings + * struct firmware_fallback_config - firmware fallback configuration settings * * Helps describe and fine tune the fallback mechanism. *