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: 10358083 X-Patchwork-Delegate: kvalo@adurom.com 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 8175260209 for ; Mon, 23 Apr 2018 20:14:16 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 7129628C2C for ; Mon, 23 Apr 2018 20:14:16 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 655C228C2F; Mon, 23 Apr 2018 20:14:16 +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=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, FREEMAIL_FROM, MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI autolearn=unavailable version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id EE96F28C2C for ; Mon, 23 Apr 2018 20:14:15 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932629AbeDWUON (ORCPT ); Mon, 23 Apr 2018 16:14:13 -0400 Received: from mail-io0-f196.google.com ([209.85.223.196]:32796 "EHLO mail-io0-f196.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932480AbeDWUMQ (ORCPT ); Mon, 23 Apr 2018 16:12:16 -0400 Received: by mail-io0-f196.google.com with SMTP id e78-v6so7429659iod.0; 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=Oi4hUY2+ZroubuRKzvOt/ZhlxUOjYBUoII7vJVR9dF9YWxxsvtCtfHcKg/SleMTnk7 EZyqXv1u/scFaOS/IaFBAZotPlsD4NHAfM/2b1lbZtwI4dE7PaYSPcmfPpuwB8geMr/A /UIBXSUHXaMw/Xqpa4HPPw58zaZgaVTGbVwB1K8GhWZw8nh4annLK3U4ARq8GmgzmxJ9 An5PHCA8cjckQcsPMVvXLJ5YT4IJwXtFqu2jjJsTI0ZjUYvTwMsfHQiluWWB3E2VEnSM rU33gpd0FK7tYeZz0O3UpDdVWDqJ/b8+f0igipGmmxjtPm66JUWmPotf1jmlRDdi3naG 18RA== X-Gm-Message-State: ALQs6tA4L/iL0AAjAZNGJdQ4wnKbqHTpjNLkNrSvjI48IrulaSmDJIKP +6dP3cgMz/QeUziNIp1yTumkxT/0yEo= 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 Cc: andresx7@gmail.com, gregkh@linuxfoundation.org, mcgrof@kernel.org, alexdeucher@gmail.com, christian.koenig@amd.com, kvalo@codeaurora.org, arend.vanspriel@broadcom.com, linux-wireless@vger.kernel.org, ath10k@lists.infradead.org, hdegoede@redhat.com 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> Sender: linux-wireless-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-wireless@vger.kernel.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. *