Received: by 2002:a25:31c3:0:0:0:0:0 with SMTP id x186csp917028ybx; Thu, 31 Oct 2019 03:00:47 -0700 (PDT) X-Google-Smtp-Source: APXvYqxeYaFoFKeU3YaNLP8ZNmtJ7KCO49N4CeQ/qMgbg5DsNrBexU5HaX+ic281VJQbIR1A895X X-Received: by 2002:aa7:d8d0:: with SMTP id k16mr4478664eds.14.1572516047084; Thu, 31 Oct 2019 03:00:47 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1572516047; cv=none; d=google.com; s=arc-20160816; b=ev5z1lvck5DaqUuuGwg5BdXRTyalXKBBrg4I/69rIR10yVUpYPgNQvG+tbEeNEZo3V 1TmkfIq4L8SozbXnyO5VXgFhtETLAygY407WULg0GusT0W/6cpXlNeEEyMByCjdAa4YG V/lc4JWIYvo1Visi1BPIdd5o7TR2FgwMPhiuYu70ajbu2Jpys0cG+7Rke2gd4IuDjLl4 xTS+GPX/olq9WYocyzfK6+SWuGo64pXkDoR/2MLm7FxVjcioNFZYWKTGr1vwTY3jyW2k OrTFhjpN0L9i+mUrz6qB2X//DVehkj04knzZELfdAwHlU3T/ZJV67yVY6h+qJ+2iVZui EWlQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from; bh=XT6r9aFsOiiCnPQBSC3aQ9iL5yFAZQ3L59hAlG8BUqI=; b=lJEtvr7L1XfWfMpeXXmvT+2iXE3dFeq6b+o8H6cdTDVXQsRY97vG+DDydbNgl9h1dl RWHsScsEPGLuj5+4rFlYffWocplk0q8m7oQXDPk72BLqgKTfUt5hSZqJPvU9Xvczxm6n m6xebpIqQiV8QypcmrbilAIdy2b1NtmIYXTDj5yXg5Tjr7u5UxZWU1UOc+hfYJ66nGZj wt/2HY2kLzSgeo4QdGeMqw2you1lPE4ewCWTIhCvFKUe8OFo4vh3X6DGMrHL5zZ+xs7o jiVpyyg+EBH7ts28jH63LAhezKM3FKIS45a9ZpgKdXXhfP+QBBTXJqulIGzTV88GXzvC GoUQ== 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 Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id 26si3191598ejx.60.2019.10.31.03.00.21; Thu, 31 Oct 2019 03:00:47 -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 Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726982AbfJaJ7t (ORCPT + 99 others); Thu, 31 Oct 2019 05:59:49 -0400 Received: from mx2.suse.de ([195.135.220.15]:34178 "EHLO mx1.suse.de" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1726864AbfJaJ7s (ORCPT ); Thu, 31 Oct 2019 05:59:48 -0400 X-Virus-Scanned: by amavisd-new at test-mx.suse.de Received: from relay2.suse.de (unknown [195.135.220.254]) by mx1.suse.de (Postfix) with ESMTP id 231A9B12E; Thu, 31 Oct 2019 09:59:47 +0000 (UTC) From: Jiri Slaby To: axboe@kernel.dk Cc: linux-kernel@vger.kernel.org, Jiri Slaby , linux-ide@vger.kernel.org Subject: [PATCH v2 -resend 1/4] ata: Documentation, fix function names Date: Thu, 31 Oct 2019 10:59:43 +0100 Message-Id: <20191031095946.7070-1-jslaby@suse.cz> X-Mailer: git-send-email 2.23.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org ata_qc_prep no longer exists, there are ata_bmdma_qc_prep and ata_bmdma_dumb_qc_prep instead. And most drivers do not use them, so reword the paragraph. ata_qc_issue_prot was renamed to ata_sff_qc_issue. ->tf_load is now ->sff_tf_load. Fix them. And fix spelling supercede -> supersede. Signed-off-by: Jiri Slaby Cc: Jens Axboe Cc: linux-ide@vger.kernel.org --- Documentation/driver-api/libata.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/driver-api/libata.rst b/Documentation/driver-api/libata.rst index 70e180e6b93d..c2ee38098e85 100644 --- a/Documentation/driver-api/libata.rst +++ b/Documentation/driver-api/libata.rst @@ -254,19 +254,19 @@ High-level taskfile hooks int (*qc_issue) (struct ata_queued_cmd *qc); -Higher-level hooks, these two hooks can potentially supercede several of +Higher-level hooks, these two hooks can potentially supersede several of the above taskfile/DMA engine hooks. ``->qc_prep`` is called after the buffers have been DMA-mapped, and is typically used to populate the -hardware's DMA scatter-gather table. Most drivers use the standard -:c:func:`ata_qc_prep` helper function, but more advanced drivers roll their -own. +hardware's DMA scatter-gather table. Some drivers use the standard +:c:func:`ata_bmdma_qc_prep` and :c:func:`ata_bmdma_dumb_qc_prep` helper +functions, but more advanced drivers roll their own. ``->qc_issue`` is used to make a command active, once the hardware and S/G tables have been prepared. IDE BMDMA drivers use the helper function -:c:func:`ata_qc_issue_prot` for taskfile protocol-based dispatch. More +:c:func:`ata_sff_qc_issue` for taskfile protocol-based dispatch. More advanced drivers implement their own ``->qc_issue``. -:c:func:`ata_qc_issue_prot` calls ``->tf_load()``, ``->bmdma_setup()``, and +:c:func:`ata_sff_qc_issue` calls ``->sff_tf_load()``, ``->bmdma_setup()``, and ``->bmdma_start()`` as necessary to initiate a transfer. Exception and probe handling (EH) -- 2.23.0