Received: by 2002:a25:ad19:0:0:0:0:0 with SMTP id y25csp7711414ybi; Tue, 9 Jul 2019 03:07:38 -0700 (PDT) X-Google-Smtp-Source: APXvYqwNtN67IlAY5vlJBDzsEwRSRM/90pM3mqQGMUZVT7JYjG8q3A1/mbUodZ39xjzZJw2yzi6e X-Received: by 2002:a17:90a:bb01:: with SMTP id u1mr31248024pjr.92.1562666858641; Tue, 09 Jul 2019 03:07:38 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1562666858; cv=none; d=google.com; s=arc-20160816; b=lp4ykj/m7qzLWteMi9YhhURriHvq5SoAqHjzJHjBdBzShQhuzz9oCpORJ+wOrcYfII rWVAAuq7rAclnz2jlA5i1VXzYYfzxrCIjJ/0xHnNzctgcOR3Gg624DO9CwzOCZk9Ym/s NAGd2ht8BSmxglDSA1aVFiMYLJubmZEHu5/G4ve9c+/NR5iGpYEtZh/f7/r0MZNUEw48 ST0NOsY2t26ihIP3MWD0mJTS58KCF1hx1RyUFNRrAnw3WyKyR6rc+MkuIExmqezC7NjL hW4Pe8PpWJs8etSqMbYvWVhttqjdyeVoqvqS1vy5W9HiwF3OIErKGT6oipw2YewGa55Y ooYA== 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=Ec3f9hbIaPBp4WXoLxHRwHg50AfUQGdeA4B14csfxjk=; b=KlgoDXh+icUZkxEC44Jdv2XAgw9T28Ljk7Ufsy8Kt3foLTb4u9Zj2RTpCEpx0yXlEb trfSNboJWEz/DFSiJ3x5wL6/3JOKC0BKlHOoaXHjWS+DWlm+nmQC07w1Zi1iIvOcAFMC Cc/QkO3i033SoeL4LQKE//w1vuZe63qrTeKiFTGjUwuKAWXCtO5G5Y2YNkw48IEli8/F iWlM8H+KD3EaXdj2AzQh+y6X8z+lS94VDUqJJMIDu0SK/h2I5Qp5Uss5xcSYXVDj4SS9 09Q+IztFJKPFERi6M5mjCq0tlyvjv6pralyh/UT7Qr6mMjN6zwjyszf1XLPlOl1vx1QP +Fgw== 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 4si20477848pfo.266.2019.07.09.03.07.22; Tue, 09 Jul 2019 03:07:38 -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 S1726747AbfGIKCH (ORCPT + 99 others); Tue, 9 Jul 2019 06:02:07 -0400 Received: from mx2.suse.de ([195.135.220.15]:48546 "EHLO mx1.suse.de" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1726623AbfGIKCG (ORCPT ); Tue, 9 Jul 2019 06:02:06 -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 96B1CAC2D; Tue, 9 Jul 2019 10:02:05 +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 1/3] ata: Documentation, fix function names Date: Tue, 9 Jul 2019 12:02:01 +0200 Message-Id: <20190709100203.19049-1-jslaby@suse.cz> X-Mailer: git-send-email 2.22.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.22.0