Received: by 2002:a05:6a10:206:0:0:0:0 with SMTP id 6csp185869pxj; Tue, 15 Jun 2021 23:31:43 -0700 (PDT) X-Google-Smtp-Source: ABdhPJywTk9nJvDEomgP32tQMMYjTOpfxzL8kyrBDjWllYL/2jnRrjaTMSC+pPOlD0AkHFH+aIRk X-Received: by 2002:a17:907:206a:: with SMTP id qp10mr3552542ejb.309.1623825102785; Tue, 15 Jun 2021 23:31:42 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1623825102; cv=none; d=google.com; s=arc-20160816; b=H0rsdC5qxfEfjQWtNbaext6wi0Cesrs0blQRpPy3vEeJwjgUtviiD4Mcw6op7D17Pf A2shewPKEBCF22FOY6FOVHALRkEYxhiPcWiX3VtEy9kFb0FWbYVrXEQmNBbukFZzUftm HbqpGLD6nP1/6iwxLSsHk2rTs5OUKhz4dKXgwF2A+dPfa8LhHCcebaKX4v/bfAjDyDCh PhDnKDtiEuLHnqfIeCNZm1AM5iEPHzrnzV5KzDX2VLghntMN2GgZfixciCFDVN6gL59c zqv5nGhxgz1oUPK6EsXYDpcuXZScCKYhDCTSG/auQHIW1dpXAMfcIFDDDx/ETibMvdRU /k/Q== 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 :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=nVDqEZfRwp1ugWukmpwvHw51BHbdzrTVikWCQ4HwgIg=; b=ZhwrqOKnESTrQglNgPgPFWghIV4oXi4ZBCn/Fg3/QaoXrjkuEw0LNH5behBIpbNWnJ SLw7jDF0h0kNjohT7mgeeFxcJ60NIDasp76bvXVZTxX5C7m2t5wRHhNPkWxYaHsxeDHj tP97w330qxJ4elaVsg78DhqoskgL3R6Frzu+FbJp4maZdj03H0awaRrcIDYiSU9+otHe h+7Ps/eTgIA4g2WdBWr/XUTyoBKu5M9w1WGDUFx2Jy4KnoGvJfGeiKWy8t+RegfcqvxW lqU75PSdsemtOl2cvI7myoHQEVQ0VYPRs8o52mJXuUuVGaLp93b3WUiUsfVmODYGPS8d Td4g== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=L0yXL6NB; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id c14si1430876eds.568.2021.06.15.23.31.20; Tue, 15 Jun 2021 23:31:42 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=L0yXL6NB; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232144AbhFPGbU (ORCPT + 99 others); Wed, 16 Jun 2021 02:31:20 -0400 Received: from mail.kernel.org ([198.145.29.99]:59904 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231636AbhFPG3y (ORCPT ); Wed, 16 Jun 2021 02:29:54 -0400 Received: by mail.kernel.org (Postfix) with ESMTPSA id 6A68061406; Wed, 16 Jun 2021 06:27:48 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1623824868; bh=CrYrSCQ5roiQoHpCpOwAt0vkDKLp+wMs38LNVCryUAc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=L0yXL6NBDkppavsJdAfP66Tqh/HkmjX4k/N8IRfFPp4rYL8Q7SDWKud4JJD3v2BEP Nx0x26pdKsdmQ0MT/S9OKPVncCFeqypf5kYQsv53LDONcECf/UgllhmoTaf3ZEBr5h +vLxRwrx8lqdWLtV6HHbRGBISaOPoFYS2Yz22SiFtbInWYgGHRTKfCX2BcO1UhG4na UINfeibnm9cSxMCBPE6UKiRkyoSUfmR+2qo7nnJcjZYiv0TiDXttyAXnkBksTQuDeb pjxj0+zqRARZrCFhGQeV0bPtNaVPyNcQ6GdSXyHkar7pV860tDRqN8uZPRKqWAsQaW lo1ocqTJ9/KsQ== Received: by mail.kernel.org with local (Exim 4.94.2) (envelope-from ) id 1ltP1e-004kJK-NA; Wed, 16 Jun 2021 08:27:46 +0200 From: Mauro Carvalho Chehab To: Jonathan Corbet , Linux Doc Mailing List Cc: Mauro Carvalho Chehab , linux-kernel@vger.kernel.org Subject: [PATCH v2 16/29] docs: driver-api: usb: avoid using ReST :doc:`foo` markup Date: Wed, 16 Jun 2021 08:27:31 +0200 Message-Id: <2cd2dc3e6bacde587aeb09a3951594cfb0102014.1623824363.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.31.1 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: Mauro Carvalho Chehab Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org The :doc:`foo` tag is auto-generated via automarkup.py. So, use the filename at the sources, instead of :doc:`foo`. Signed-off-by: Mauro Carvalho Chehab --- Documentation/driver-api/usb/dma.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/driver-api/usb/dma.rst b/Documentation/driver-api/usb/dma.rst index 2b3dbd3265b4..d32c27e11b90 100644 --- a/Documentation/driver-api/usb/dma.rst +++ b/Documentation/driver-api/usb/dma.rst @@ -10,7 +10,7 @@ API overview The big picture is that USB drivers can continue to ignore most DMA issues, though they still must provide DMA-ready buffers (see -:doc:`/core-api/dma-api-howto`). That's how they've worked through +Documentation/core-api/dma-api-howto.rst). That's how they've worked through the 2.4 (and earlier) kernels, or they can now be DMA-aware. DMA-aware usb drivers: @@ -60,7 +60,7 @@ and effects like cache-trashing can impose subtle penalties. force a consistent memory access ordering by using memory barriers. It's not using a streaming DMA mapping, so it's good for small transfers on systems where the I/O would otherwise thrash an IOMMU mapping. (See - :doc:`/core-api/dma-api-howto` for definitions of "coherent" and + Documentation/core-api/dma-api-howto.rst for definitions of "coherent" and "streaming" DMA mappings.) Asking for 1/Nth of a page (as well as asking for N pages) is reasonably @@ -91,7 +91,7 @@ Working with existing buffers Existing buffers aren't usable for DMA without first being mapped into the DMA address space of the device. However, most buffers passed to your driver can safely be used with such DMA mapping. (See the first section -of :doc:`/core-api/dma-api-howto`, titled "What memory is DMA-able?") +of Documentation/core-api/dma-api-howto.rst, titled "What memory is DMA-able?") - When you're using scatterlists, you can map everything at once. On some systems, this kicks in an IOMMU and turns the scatterlists into single -- 2.31.1