Received: by 2002:a05:6a10:206:0:0:0:0 with SMTP id 6csp1894047pxj; Sat, 5 Jun 2021 06:21:59 -0700 (PDT) X-Google-Smtp-Source: ABdhPJyejEv7cJQIgNQ+yipBXwi+NdQ8+SYQRaag5DLdw4QKIDBHds8YsvvAjvSaG1o10mB0mC7J X-Received: by 2002:a05:6402:946:: with SMTP id h6mr10299243edz.261.1622899318954; Sat, 05 Jun 2021 06:21:58 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1622899318; cv=none; d=google.com; s=arc-20160816; b=vCuQU2eOhus4rZ2J1pX/Qq0C67pUSLY86gh7UYso0XBtk/t31Vqs89hYAxSlA5wbjv zA6XQbir5Gi4O+9A2HW9JPTqaMPK8NroNwKt3Y95LnLGx8zfAxNyWgePZ3j32LTYji6z XpxuOpLOphGWslB73U6NS9TcsGzacpqsN2HuJsF/8I3f2IVUMzhkT4T4u98xNNZe6+lv v/ZICbGuRVGNkbKJevpHJfhAa8XPBiKYfz/A9hUjw9yVLm15knSdUP4plta3FTBq5LJZ 99o/GxYaZ1V9lLfFmBJqcDpov1/84va8wpKS29w1Su4Zfsn/KOspf2GvlTa4iJpX+XPZ AWgA== 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=QOcLBZJzGoKjBRsxEa1hZnhPg6fiavGQV+fjhl1fT8ismzx8FSJugtHBPWE/sZG/9J apD93eJKJK8heyt4f7+Glrx+j759tMbaQbxymDioRc0U3klv6X29BKx80LajDEao+5Zf lbI3972cNr/YjeVYYP8XJUM5b/qw4pI+bKTl4J+1+TFzc9icV6zHjod4DRF4CeDhvN74 rqawzdAMowExeIw5uVg1kGtXrxza3S499ByFVREonLCzovNQyYcvRHJdHJRod/r16Q0W g6ING4c7R8SC65v0c+mcOwZ/0kHd8lmEgHxh4C9eA9OICkIkHjMS96pVepOeSK0koNop gFrw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=teNbcMpT; 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 qh24si7403998ejb.194.2021.06.05.06.21.36; Sat, 05 Jun 2021 06:21:58 -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=teNbcMpT; 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 S231315AbhFENV1 (ORCPT + 99 others); Sat, 5 Jun 2021 09:21:27 -0400 Received: from mail.kernel.org ([198.145.29.99]:35066 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230106AbhFENU0 (ORCPT ); Sat, 5 Jun 2021 09:20:26 -0400 Received: by mail.kernel.org (Postfix) with ESMTPSA id 01A5E61441; Sat, 5 Jun 2021 13:18:38 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1622899118; bh=CrYrSCQ5roiQoHpCpOwAt0vkDKLp+wMs38LNVCryUAc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=teNbcMpTfKbHLv4mLNa+DsIQE5OouYDF+UxNMhMNtXpEp3InRCJLtJyhyU2xIR/DT jkzP8k0rXVV6qpcMIXbcycXUpiL5RvkDFdfLSP+WvkE8nUk/Z7SwJjB30ObOaXqA+g hK+bHEezXYmeOo0N51bkuM7flG5AXm8hQ7+hh4aLcUWNzdXGTLrkz/OB3ALKXP1Ev+ qvO1cgG67qB5gq6qU/nNnOMSX5JfHGK40sckDhfb4JJHddZOuk8aIfxo+hnnj5r2Cf 5ZrgL4rOASwaFccAusx9CCGtPQOQgaR5gd+or9QY1vcph+yahPAh9HhNWhKwkBuBQk hPgggQx8mcaDQ== Received: by mail.kernel.org with local (Exim 4.94.2) (envelope-from ) id 1lpWCC-008GFl-6V; Sat, 05 Jun 2021 15:18:36 +0200 From: Mauro Carvalho Chehab To: "Jonathan Corbet" , Linux Doc Mailing List Cc: Mauro Carvalho Chehab , linux-kernel@vger.kernel.org Subject: [PATCH 20/34] docs: driver-api: usb: avoid using ReSt :doc:`foo` markup Date: Sat, 5 Jun 2021 15:18:19 +0200 Message-Id: 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