Received: by 10.192.165.148 with SMTP id m20csp2874405imm; Mon, 7 May 2018 02:39:37 -0700 (PDT) X-Google-Smtp-Source: AB8JxZpUc8H5a5zl0HhT5ilmbaA8wDHg/YsgSMVbL09wYBSNH6rLBFQVCa57GaLmO4ri0nSGzoGg X-Received: by 2002:a17:902:268:: with SMTP id 95-v6mr12388229plc.386.1525685977446; Mon, 07 May 2018 02:39:37 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1525685977; cv=none; d=google.com; s=arc-20160816; b=VCBOxI8DhRdNpChDYdIWKhJYZekQrpWwl+0ZkauEEgUimpzgDy0AwRUGE2zlLTqg1j A6yhLa1B0DyJ8dnxkglwYZW63C3SYXbKR3lrkyWY1mPE5Cp/6J68/T5CzZKsowrOxKNC EVvvVHfXvMuQxaneiTQibXgLZYGje2zxuvVQzTO4uD7GZsxllU5nosc9S612/I/B/6Nn XT/ac7unhAcVAv6HPZQqicrCpGPL2D/0jb/oarlZP6szT4A2kKfphhp0Zy4hXzFI8TNf QOYBUUKTrxp747f4KFQuQjejFZnl/RQhGHngnbxggX3RmugHgw+flSVRuwzzoNRei0k2 7Xew== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:references:in-reply-to:references :in-reply-to:message-id:date:subject:cc:to:from :arc-authentication-results; bh=L3y9KDdWHl7HoVqoP6VlizsWGlgD+DFh9nwgLjiNFPg=; b=wsxyzzPQg0vplDs9ZYuUmKRCCu3YumJvtvsKPXOsasRY4nciPf+y5TPxKd6e1iZ6SA uj80PbxbVasu6KH9kMRthyvUTk2PRCdZpwL+3+fggr3p4zJcvFasNBU8gu2loX14MUjA tmOxj3ueuqozZJ5814jwq6wuBCuv8o7QOWj6591GdBdh0x6LWWZc9f2UbMxS0Efq7sV8 Rmjb0UNtx4wkLhOEZ69UnsskGWkOZ6KQ7ziw683ucDm8fmTiVDIGaC1YJCtQBc4cDxjW 64TU4ZSpoTdb/TGi9O182+PNIPnrHt1aam8caExiBKVVvyrbkZAWUZhX/011Pq+3SkjL Y19Q== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id l67si22106257pfg.326.2018.05.07.02.39.23; Mon, 07 May 2018 02:39:37 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752147AbeEGJii (ORCPT + 99 others); Mon, 7 May 2018 05:38:38 -0400 Received: from osg.samsung.com ([64.30.133.232]:52363 "EHLO osg.samsung.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752494AbeEGJgI (ORCPT ); Mon, 7 May 2018 05:36:08 -0400 Received: from localhost (localhost [127.0.0.1]) by osg.samsung.com (Postfix) with ESMTP id DFEB723460; Mon, 7 May 2018 02:36:07 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at dev.s-opensource.com X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References" Received: from osg.samsung.com ([127.0.0.1]) by localhost (localhost [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id HlhyMVwoxRdr; Mon, 7 May 2018 02:36:06 -0700 (PDT) Received: from smtp.s-opensource.com (177.41.109.86.dynamic.adsl.gvt.net.br [177.41.109.86]) by osg.samsung.com (Postfix) with ESMTPSA id 5A6E2233E8; Mon, 7 May 2018 02:36:01 -0700 (PDT) Received: from mchehab by smtp.s-opensource.com with local (Exim 4.90_1) (envelope-from ) id 1fFcYo-00087E-O5; Mon, 07 May 2018 06:35:58 -0300 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , "Rafael J. Wysocki" , Len Brown , Pavel Machek , "Luis R. Rodriguez" , Greg Kroah-Hartman , Masanari Iida , linux-pm@vger.kernel.org, Kees Cook Subject: [PATCH 02/18] docs: fix location of request_firmware & friends Date: Mon, 7 May 2018 06:35:38 -0300 Message-Id: <9e40d0b3a085a937b42ec60a3b2409cf820ca713.1525684985.git.mchehab+samsung@kernel.org> X-Mailer: git-send-email 2.17.0 In-Reply-To: References: In-Reply-To: References: Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org commit 5d6d1ddd2730 ("firmware: move firmware loader into its own directory") and other commits renamed the old firmware_class.c file and split it into separate files, but documentation was not changed accordingly, causing Sphinx errors. Change the location accordingly at the documentation files. While here, add a missing entry at request_firmware.rst for release_firmware() function. Fixes: 5d6d1ddd2730 ("firmware: move firmware loader into its own directory") Cc: Kees Cook Cc: Luis R. Rodriguez Cc: Greg Kroah-Hartman Signed-off-by: Mauro Carvalho Chehab --- Documentation/dell_rbu.txt | 4 ++-- .../driver-api/firmware/fallback-mechanisms.rst | 2 +- .../driver-api/firmware/request_firmware.rst | 17 +++++++++++------ Documentation/driver-api/infrastructure.rst | 2 +- Documentation/power/suspend-and-cpuhotplug.txt | 2 +- 5 files changed, 16 insertions(+), 11 deletions(-) diff --git a/Documentation/dell_rbu.txt b/Documentation/dell_rbu.txt index 0fdb6aa2704c..befeff80e7ec 100644 --- a/Documentation/dell_rbu.txt +++ b/Documentation/dell_rbu.txt @@ -121,8 +121,8 @@ read back the image downloaded. .. note:: - This driver requires a patch for firmware_class.c which has the modified - request_firmware_nowait function. + This driver requires a patch for drivers/base/firmware_loader/main.c + which has the modified request_firmware_nowait() function. Also after updating the BIOS image a user mode application needs to execute code which sends the BIOS update request to the BIOS. So on the next reboot diff --git a/Documentation/driver-api/firmware/fallback-mechanisms.rst b/Documentation/driver-api/firmware/fallback-mechanisms.rst index f353783ae0be..7aed31b5a439 100644 --- a/Documentation/driver-api/firmware/fallback-mechanisms.rst +++ b/Documentation/driver-api/firmware/fallback-mechanisms.rst @@ -72,7 +72,7 @@ the firmware requested, and establishes it in the device hierarchy by associating the device used to make the request as the device's parent. The sysfs directory's file attributes are defined and controlled through the new device's class (firmware_class) and group (fw_dev_attr_groups). -This is actually where the original firmware_class.c file name comes from, +This is actually where drivers/base/firmware_loader/fallback.c comes from, as originally the only firmware loading mechanism available was the mechanism we now use as a fallback mechanism. diff --git a/Documentation/driver-api/firmware/request_firmware.rst b/Documentation/driver-api/firmware/request_firmware.rst index cf4516dfbf96..8e34d29ea02d 100644 --- a/Documentation/driver-api/firmware/request_firmware.rst +++ b/Documentation/driver-api/firmware/request_firmware.rst @@ -17,19 +17,24 @@ an error is returned. request_firmware ---------------- -.. kernel-doc:: drivers/base/firmware_class.c +.. kernel-doc:: drivers/base/firmware_loader/main.c :functions: request_firmware request_firmware_direct ----------------------- -.. kernel-doc:: drivers/base/firmware_class.c +.. kernel-doc:: drivers/base/firmware_loader/main.c :functions: request_firmware_direct request_firmware_into_buf ------------------------- -.. kernel-doc:: drivers/base/firmware_class.c +.. kernel-doc:: drivers/base/firmware_loader/main.c :functions: request_firmware_into_buf +release_firmware +---------------- +.. kernel-doc:: drivers/base/firmware_loader/main.c + :functions: release_firmware + Asynchronous firmware requests ============================== @@ -41,7 +46,7 @@ in atomic contexts. request_firmware_nowait ----------------------- -.. kernel-doc:: drivers/base/firmware_class.c +.. kernel-doc:: drivers/base/firmware_loader/main.c :functions: request_firmware_nowait Special optimizations on reboot @@ -54,8 +59,8 @@ this can be done with firmware_request_cache() insted of requesting for the firmare 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/Documentation/driver-api/infrastructure.rst b/Documentation/driver-api/infrastructure.rst index 6d9ff316b608..bee1b9a1702f 100644 --- a/Documentation/driver-api/infrastructure.rst +++ b/Documentation/driver-api/infrastructure.rst @@ -28,7 +28,7 @@ Device Drivers Base .. kernel-doc:: drivers/base/node.c :internal: -.. kernel-doc:: drivers/base/firmware_class.c +.. kernel-doc:: drivers/base/firmware_loader/main.c :export: .. kernel-doc:: drivers/base/transport_class.c diff --git a/Documentation/power/suspend-and-cpuhotplug.txt b/Documentation/power/suspend-and-cpuhotplug.txt index 31abd04b9572..6f55eb960a6d 100644 --- a/Documentation/power/suspend-and-cpuhotplug.txt +++ b/Documentation/power/suspend-and-cpuhotplug.txt @@ -168,7 +168,7 @@ update on the CPUs, as discussed below: [Please bear in mind that the kernel requests the microcode images from userspace, using the request_firmware() function defined in -drivers/base/firmware_class.c] +drivers/base/firmware_loader/main.c] a. When all the CPUs are identical: -- 2.17.0