Message ID | 20230329123425.4177084-1-conor.dooley@microchip.com |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp387781vqo; Wed, 29 Mar 2023 05:53:36 -0700 (PDT) X-Google-Smtp-Source: AKy350bnEG/QS1yyMPJDe4+USqOQxLejBR4DQ3l2wNFGe90gSI4Yb3fV5fNqxoVIT3OYqfh06PLS X-Received: by 2002:a17:906:4bcc:b0:93e:24f6:d7a3 with SMTP id x12-20020a1709064bcc00b0093e24f6d7a3mr18956201ejv.8.1680094415979; Wed, 29 Mar 2023 05:53:35 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1680094415; cv=none; d=google.com; s=arc-20160816; b=q1j7g3HrTBg1DN+FYF5t+JKoIf0i85R3FpRxdnlBR/mTz6PjMczNEPhNnsfd2awTZT HcI6MWYjtkGCtnFJnhdP4XiwVbDNkFdUnCeF3dPTopQSeZ+HeENp8m+jFTwwRzQsSZbK bXVDf0Jp0FMUBvH+WfYeC1F9dyVo0sXQlQkrphYhjuIMQq2+/B1JvBsiqOsjO/C1Bp6Q ZFZmBdBa3EAKA8jURPjQ/5ZrPR5DXmyJtqzkaX/C8u8FERYxejMAf9Aj0XOxuPRgw7EJ ZjEDy97CBLeVLFmjo2ECDL51qG1Nwab5CUM2mmAPLjWBme/mly4KU/RQ+eP3dgSc/7s7 EGCw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=3s1tC7xcEYNvlnnNcc/6ZLHTdgb/tOlIh4DqAyyzFv8=; b=Lypwq9+vu80XFqFmkzNoj6WKLn3HssbiXlaMkcpoKBTm9f5iwc7IMhRt2v42F6LDLf c7TF/rMG7hB3XqI4hyPNZ9h8WSiEnTmhcl6taocq0RY6MqlH5wAog5qXiHyXHm077QqC r0GMTMLfbUdP2WXUWkw9iCgTuFJQIogwvTAxtW28NW1Edd3atYvRuCbQftC805sbiCQd wfV4tW6MnG07G7n9z8droQSE7OUEBmPGGWzs8sMgzdisftOveBiSuhsMboSHcVmM/+HN 7UPYRfLeaxIxtCSNbN4hbcMsuspcgCnaXusfwkrgo2ZkPkTPovDiXmL0NvTaMycnF9Ua Nh0w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@microchip.com header.s=mchp header.b=FFMHuGIL; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=microchip.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id ce23-20020a170906b25700b0092127059e12si33167999ejb.57.2023.03.29.05.53.12; Wed, 29 Mar 2023 05:53:35 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@microchip.com header.s=mchp header.b=FFMHuGIL; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=microchip.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229681AbjC2MfP (ORCPT <rfc822;rua109.linux@gmail.com> + 99 others); Wed, 29 Mar 2023 08:35:15 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44580 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229486AbjC2MfM (ORCPT <rfc822;linux-kernel@vger.kernel.org>); Wed, 29 Mar 2023 08:35:12 -0400 Received: from esa.microchip.iphmx.com (esa.microchip.iphmx.com [68.232.153.233]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 44A414201; Wed, 29 Mar 2023 05:35:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=microchip.com; i=@microchip.com; q=dns/txt; s=mchp; t=1680093305; x=1711629305; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=2l2hmoiUE09lV8CvoAEQLjTkPM9/Sd/B1b4VpgazUKw=; b=FFMHuGILZ9hfaqhmy1i3kJBj52qLKCp3hOxV2SJ/o07krVXEL8nGZpx0 pu8sFLQljqo2/PzN38xhwgpI6GEbn4se4AU9snyAfUMm1lh2B6TFF75zB ZV6IJcEhnBXE/XFWCouYJ2BQgx/lagVQc2i4iLtIu4vXhkDq3Q6+YIktA v9wdfGpRW41z8hrqX6Vb4VT7LDWEhNTKslzXVJzib2byVyKlWVFL8hId7 TZYTtNBUj2g+Gn7rC7RHHTvRrVRzJCQp8HW1z4ey2q3QyJp92+SWKt9Vd 3MtJCX4y1TtNc+qHEl3nj2xV9aX5TyXoX59vBikvRArfiDnVixKP2bRDA w==; X-IronPort-AV: E=Sophos;i="5.98,300,1673938800"; d="scan'208";a="207245760" Received: from unknown (HELO email.microchip.com) ([170.129.1.10]) by esa5.microchip.iphmx.com with ESMTP/TLS/AES256-SHA256; 29 Mar 2023 05:35:04 -0700 Received: from chn-vm-ex01.mchp-main.com (10.10.85.143) by chn-vm-ex02.mchp-main.com (10.10.85.144) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.21; Wed, 29 Mar 2023 05:35:03 -0700 Received: from wendy.microchip.com (10.10.115.15) by chn-vm-ex01.mchp-main.com (10.10.85.143) with Microsoft SMTP Server id 15.1.2507.21 via Frontend Transport; Wed, 29 Mar 2023 05:35:01 -0700 From: Conor Dooley <conor.dooley@microchip.com> To: <corbet@lwn.net> CC: <conor@kernel.org>, <conor.dooley@microchip.com>, Russ Weight <russell.h.weight@intel.com>, Greg Kroah-Hartman <gregkh@linuxfoundation.org>, Tianfei zhang <tianfei.zhang@intel.com>, "Luis Chamberlain" <mcgrof@kernel.org>, <linux-doc@vger.kernel.org>, <linux-kernel@vger.kernel.org> Subject: [PATCH] docs: driver-api: firmware_loader: fix missing argument in usage example Date: Wed, 29 Mar 2023 13:34:26 +0100 Message-ID: <20230329123425.4177084-1-conor.dooley@microchip.com> X-Mailer: git-send-email 2.39.2 MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=1832; i=conor.dooley@microchip.com; h=from:subject; bh=2l2hmoiUE09lV8CvoAEQLjTkPM9/Sd/B1b4VpgazUKw=; b=owGbwMvMwCFWscWwfUFT0iXG02pJDCkqBgHV8VeF9GISglz9q7cxRUhbTowSeSSvJOMefmpLysrd lnc6SlkYxDgYZMUUWRJv97VIrf/jssO55y3MHFYmkCEMXJwCMJHuFkaGDWKBWVX+B8ITZFsOnbAI1v +480H9+yks/kXVrLk6n/adZ2SY49edx3p9U7eB7e4io12LRZQT4zWXyRhImjUtY1BIvcUNAA== X-Developer-Key: i=conor.dooley@microchip.com; a=openpgp; fpr=F9ECA03CF54F12CD01F1655722E2C55B37CF380C Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Spam-Status: No, score=-2.5 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED, RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: <linux-kernel.vger.kernel.org> X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1761706682702508132?= X-GMAIL-MSGID: =?utf-8?q?1761706682702508132?= |
Series |
docs: driver-api: firmware_loader: fix missing argument in usage example
|
|
Commit Message
Conor Dooley
March 29, 2023, 12:34 p.m. UTC
By the time firmware-upload support landed in commit 97730bbb242c
("firmware_loader: Add firmware-upload support"), the arguments for
firmware_upload_register() had changed, and while this is automagically
represented in the kernel doc bits, the usage example was not kept in
sync.
Add the missing argument as per the driver.
Fixes: 97730bbb242c ("firmware_loader: Add firmware-upload support")
Signed-off-by: Conor Dooley <conor.dooley@microchip.com>
---
From skimming the threads adding this stuff, looks like THIS_MODULE was
always needed, so either I'm missing something or the doc stuff wasn't
matching in any of the submitted versions.
CC: Jonathan Corbet <corbet@lwn.net>
CC: Russ Weight <russell.h.weight@intel.com>
CC: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
CC: Tianfei zhang <tianfei.zhang@intel.com>
CC: Luis Chamberlain <mcgrof@kernel.org>
CC: linux-doc@vger.kernel.org
CC: linux-kernel@vger.kernel.org
---
Documentation/driver-api/firmware/fw_upload.rst | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
Comments
On Wed, Mar 29, 2023 at 01:34:26PM +0100, Conor Dooley wrote: > By the time firmware-upload support landed in commit 97730bbb242c > ("firmware_loader: Add firmware-upload support"), the arguments for > firmware_upload_register() had changed, and while this is automagically > represented in the kernel doc bits, the usage example was not kept in > sync. > Add the missing argument as per the driver. > > Fixes: 97730bbb242c ("firmware_loader: Add firmware-upload support") > Signed-off-by: Conor Dooley <conor.dooley@microchip.com> > --- > >From skimming the threads adding this stuff, looks like THIS_MODULE was > always needed, so either I'm missing something or the doc stuff wasn't > matching in any of the submitted versions. > > CC: Jonathan Corbet <corbet@lwn.net> > CC: Russ Weight <russell.h.weight@intel.com> > CC: Greg Kroah-Hartman <gregkh@linuxfoundation.org> > CC: Tianfei zhang <tianfei.zhang@intel.com> > CC: Luis Chamberlain <mcgrof@kernel.org> > CC: linux-doc@vger.kernel.org > CC: linux-kernel@vger.kernel.org > --- > Documentation/driver-api/firmware/fw_upload.rst | 3 ++- > 1 file changed, 2 insertions(+), 1 deletion(-) > > diff --git a/Documentation/driver-api/firmware/fw_upload.rst b/Documentation/driver-api/firmware/fw_upload.rst > index 76922591e446..edf1d0c5e7c3 100644 > --- a/Documentation/driver-api/firmware/fw_upload.rst > +++ b/Documentation/driver-api/firmware/fw_upload.rst > @@ -57,7 +57,8 @@ function calls firmware_upload_unregister() such as:: > len = (truncate) ? truncate - fw_name : strlen(fw_name); > sec->fw_name = kmemdup_nul(fw_name, len, GFP_KERNEL); > > - fwl = firmware_upload_register(sec->dev, sec->fw_name, &m10bmc_ops, sec); > + fwl = firmware_upload_register(THIS_MODULE, sec->dev, sec->fw_name, > + &m10bmc_ops, sec); Good catch. As this touches the firmware documentation, I can take it in my tree, thanks! greg k-h
diff --git a/Documentation/driver-api/firmware/fw_upload.rst b/Documentation/driver-api/firmware/fw_upload.rst index 76922591e446..edf1d0c5e7c3 100644 --- a/Documentation/driver-api/firmware/fw_upload.rst +++ b/Documentation/driver-api/firmware/fw_upload.rst @@ -57,7 +57,8 @@ function calls firmware_upload_unregister() such as:: len = (truncate) ? truncate - fw_name : strlen(fw_name); sec->fw_name = kmemdup_nul(fw_name, len, GFP_KERNEL); - fwl = firmware_upload_register(sec->dev, sec->fw_name, &m10bmc_ops, sec); + fwl = firmware_upload_register(THIS_MODULE, sec->dev, sec->fw_name, + &m10bmc_ops, sec); if (IS_ERR(fwl)) { dev_err(sec->dev, "Firmware Upload driver failed to start\n"); kfree(sec->fw_name);