Received: by 2002:a05:7412:419a:b0:f3:1519:9f41 with SMTP id i26csp446844rdh; Thu, 23 Nov 2023 08:08:35 -0800 (PST) X-Google-Smtp-Source: AGHT+IFH8PJNrz2DMXBcGAXozR0kApMZb7Mi1sccdtVEx1wVn9ghzioW4NppUkp9gW8ypczr7UNs X-Received: by 2002:a17:90b:33c8:b0:27d:6404:bffc with SMTP id lk8-20020a17090b33c800b0027d6404bffcmr6433252pjb.1.1700755714750; Thu, 23 Nov 2023 08:08:34 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1700755714; cv=none; d=google.com; s=arc-20160816; b=P9zOi+AjA4I8mALMWiTMCeaur2u+1grU1bb/4PI2Qu5Ulx7L+7agxZ/nk4uX3Xha0B hgsyEIwIFlr3YVat6LjYFhJRohMonvxm1gzJwysR7/Xi7Gow7RZmSrUmWN2M1AQb/LQp CKZzxdjSXYeKacH4ZV2dHyoz63KAjngFOm90Sa+51ZO4pBWMHcRDgFdK9HidaN+qezl0 mZNPP5j23A+4bVsUOfr7IkkWizkfp3Thu+dwmi/ait9KWdWanQk66eOhRtIZpvh0O4qZ xA40TZfpAei1LJ0HD851dwt1SuHFJ1AHVeVuind5aOF+NQByvSQZlC2SNHpO9PMb+cs0 x0Bw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=WoI3lRlk1siP5XEqEA8VbXVQlXNyy2eE79v15BctaEA=; fh=mmWtOqody3OUtXB2uay9oq1ehwtkbSKzTcYkeIEJWGI=; b=OeORG5lqev0DGlH9rQhx3WM4Vttkcey5TtCIhuObt9+mRR3MSp9buxqrxH64K9ycSf Bc++b+eqQbgvTEqSZEN6zJQRR9lwz1gQGVhlLByhBXgcjiT7bpUtrOMFgdYXMp7/buob CrOty6Wd6o2K6QO0ww376ZAd4/GxvwQTreUEQsN8eUnwQJfBbi0mAV+Cj30HTyMROWpS tdfu8ff/dwNUEmicgVu4oeRl0iMJpspLZbX6pfVb7DwHlSoP7P9oJnan3romnvWF8fUp aD+xjYfw9dvL6bjezQz8Z26RhrNScT5fbxiNkUcrF7zw1hhYj7tOks1gmk7ptPzXAqGm 5ZUg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b="VA/Z40ir"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:3 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lipwig.vger.email (lipwig.vger.email. [2620:137:e000::3:3]) by mx.google.com with ESMTPS id qe5-20020a17090b4f8500b0026d41496190si2217500pjb.85.2023.11.23.08.08.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 23 Nov 2023 08:08:34 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:3 as permitted sender) client-ip=2620:137:e000::3:3; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b="VA/Z40ir"; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:3 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by lipwig.vger.email (Postfix) with ESMTP id E1CFF8291101; Thu, 23 Nov 2023 08:08:15 -0800 (PST) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.11 at lipwig.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233140AbjKWQHv (ORCPT + 99 others); Thu, 23 Nov 2023 11:07:51 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:53156 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230179AbjKWQHb (ORCPT ); Thu, 23 Nov 2023 11:07:31 -0500 Received: from mail-ej1-x62d.google.com (mail-ej1-x62d.google.com [IPv6:2a00:1450:4864:20::62d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 402D6173F for ; Thu, 23 Nov 2023 08:07:33 -0800 (PST) Received: by mail-ej1-x62d.google.com with SMTP id a640c23a62f3a-a00191363c1so147958366b.0 for ; Thu, 23 Nov 2023 08:07:33 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1700755651; x=1701360451; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=WoI3lRlk1siP5XEqEA8VbXVQlXNyy2eE79v15BctaEA=; b=VA/Z40irgPjcAroKD6uB+LaayTpcyzISuE63/B7rTx9EhQEnRJg5k5sW0VN8WWNdRa sKEKuTZHGDVNAgO6lfsauN0qPL8PW2cqgblHHNi19XpmFEEXTyLDF5OUGrf1Eh3WFv6T JN9Gwi9TpMIMbUtjb8Jp6qSYY+DTCY6iFrGOMo/kt2GddUpqBvMfzgpa0r0eX51bhDn0 ZMd5l16weNh6onJudBkQ9rPbpyPWLLzjsuzv5g7CZpV0zuj2C60Ii8z3fP4ePv0QllRi QJhbS5blOU0oF865SAcjZRAqGB8zhP/YGqy87zL1lcJdMBw9k/YNRWM77vIckcpBu+aE I3og== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1700755651; x=1701360451; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=WoI3lRlk1siP5XEqEA8VbXVQlXNyy2eE79v15BctaEA=; b=fGNYhq3fyO1dl0053OlErGF2OnYwL9BPfYjMiSQruEYA8Mrg/CGTBERJCGnEO400ig 2drX4cr4FNg7hMGPuFQxuJyQeBAB5fbULS4Xye0T0xlNaxnxhDnOO0Fzz2ZPMp7gKPSv 7+1B1UuaZmnE9w+eJuK5GehIzZdCr8UhX52t22uoI2IqL6TtBzZQQ2pk42G0nUO/LBja d3adrsX8nzUYtcMu+zRcdJwJjfgmnLyKaohmGJtpDgGGgKEKq7rxVPTTpbWg9xJE4vMs kviqHoTPN+wsPg/ggOc+ENrUdyhQORA+j8p4D9mFCWFBqd+fxvzbDO7xwwcZDPfdhvZN HBgg== X-Gm-Message-State: AOJu0YzJTHcNOAs4+ANKCLyxWz1UVmXa7WQQYcdo7taenr3tf2gOf6jy nLGxA/6Axz4H2mH2Nj8F0CQbPsGvR3GvlK8jk4o= X-Received: by 2002:a17:907:d38a:b0:9e2:af56:c380 with SMTP id vh10-20020a170907d38a00b009e2af56c380mr5454059ejc.6.1700755651692; Thu, 23 Nov 2023 08:07:31 -0800 (PST) Received: from 1.. ([79.115.63.75]) by smtp.gmail.com with ESMTPSA id h21-20020a1709070b1500b00a0180de2797sm941490ejl.74.2023.11.23.08.07.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 23 Nov 2023 08:07:30 -0800 (PST) From: Tudor Ambarus To: pratyush@kernel.org, michael@walle.cc Cc: linux-mtd@lists.infradead.org, linux-doc@vger.kernel.org, corbet@lwn.net, linux-kernel@vger.kernel.org, Tudor Ambarus Subject: [PATCH 2/2] docs: mtd: spi-nor: drop obsolete info Date: Thu, 23 Nov 2023 18:07:21 +0200 Message-Id: <20231123160721.64561-3-tudor.ambarus@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231123160721.64561-1-tudor.ambarus@linaro.org> References: <20231123160721.64561-1-tudor.ambarus@linaro.org> MIME-Version: 1.0 X-Developer-Signature: v=1; a=openpgp-sha256; l=3053; i=tudor.ambarus@linaro.org; h=from:subject; bh=25OPubX9uzUyfM/XTP0zGdZT9n+Quh1N4wccoUHj8ic=; b=owEBbQGS/pANAwAKAUtVT0eljRTpAcsmYgBlX3i5QFJr2OKH8EvKa+v/4w+Lmao2JCr0Mw7oV /lLZU7/wzqJATMEAAEKAB0WIQQdQirKzw7IbV4d/t9LVU9HpY0U6QUCZV94uQAKCRBLVU9HpY0U 6QCbCAC4SngJRGZ0qeFbmpZ6hInfmNRUbhAEQHkQxqBDDtkD+zPfaHPtRDnzLTVp4wl9ZW+pv50 Uov8OIk5qS4gbc4Z4bJEqhsWZmOSpEV6Vlb7Se2LnRTeY7q0MPjA+Q4XkScUAnFB0EszN0POp5w 3gfs2paYIdVQbg3Nie3Dxomp8hpxgIjDEsjtP91bvES+Taajqgx4JQvOFebwksgWbrOp7r9iMrX s2wMu7w8QDSh9bODQfv8sDI1E3Ou+DKbos9OBejAD7lFPfLLpRsvZ1bKQSAMA5H/PVXrwOBXlmz CZt0aHdVmp+6qwMi1p03b9uGe7yE2Y3dTr2W9ZurmmhwLp22 X-Developer-Key: i=tudor.ambarus@linaro.org; a=openpgp; fpr=280B06FD4CAAD2980C46DDDF4DB1B079AD29CF3D Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-0.9 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lipwig.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (lipwig.vger.email [0.0.0.0]); Thu, 23 Nov 2023 08:08:16 -0800 (PST) The architecture description is obsolete, it no longer applies to the current SPI NOR framework state, remove it. Signed-off-by: Tudor Ambarus --- Documentation/driver-api/mtd/spi-nor.rst | 62 ------------------------ 1 file changed, 62 deletions(-) diff --git a/Documentation/driver-api/mtd/spi-nor.rst b/Documentation/driver-api/mtd/spi-nor.rst index cc8e81e09544..7a8737fe181d 100644 --- a/Documentation/driver-api/mtd/spi-nor.rst +++ b/Documentation/driver-api/mtd/spi-nor.rst @@ -2,68 +2,6 @@ SPI NOR framework ================= -Part I - Why do we need this framework? ---------------------------------------- - -SPI bus controllers (drivers/spi/) only deal with streams of bytes; the bus -controller operates agnostic of the specific device attached. However, some -controllers (such as Freescale's QuadSPI controller) cannot easily handle -arbitrary streams of bytes, but rather are designed specifically for SPI NOR. - -In particular, Freescale's QuadSPI controller must know the NOR commands to -find the right LUT sequence. Unfortunately, the SPI subsystem has no notion of -opcodes, addresses, or data payloads; a SPI controller simply knows to send or -receive bytes (Tx and Rx). Therefore, we must define a new layering scheme under -which the controller driver is aware of the opcodes, addressing, and other -details of the SPI NOR protocol. - -Part II - How does the framework work? --------------------------------------- - -This framework just adds a new layer between the MTD and the SPI bus driver. -With this new layer, the SPI NOR controller driver does not depend on the -m25p80 code anymore. - -Before this framework, the layer is like:: - - MTD - ------------------------ - m25p80 - ------------------------ - SPI bus driver - ------------------------ - SPI NOR chip - -After this framework, the layer is like:: - - MTD - ------------------------ - SPI NOR framework - ------------------------ - m25p80 - ------------------------ - SPI bus driver - ------------------------ - SPI NOR chip - -With the SPI NOR controller driver (Freescale QuadSPI), it looks like:: - - MTD - ------------------------ - SPI NOR framework - ------------------------ - fsl-quadSPI - ------------------------ - SPI NOR chip - -Part III - How can drivers use the framework? ---------------------------------------------- - -The main API is spi_nor_scan(). Before you call the hook, a driver should -initialize the necessary fields for spi_nor{}. Please see -drivers/mtd/spi-nor/spi-nor.c for detail. Please also refer to spi-fsl-qspi.c -when you want to write a new driver for a SPI NOR controller. - How to propose a new flash addition ----------------------------------- -- 2.34.1