From patchwork Fri Oct 14 20:27:48 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ivan Bornyakov X-Patchwork-Id: 143 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:4ac7:0:0:0:0:0 with SMTP id y7csp377225wrs; Fri, 14 Oct 2022 14:07:37 -0700 (PDT) X-Google-Smtp-Source: AMsMyM4O+aFDXioZKzPheydlMB/5h2ZsbiHruit6zr0d3U2LcNx2XIynKHTxVa8sHt9SXpmJsLKw X-Received: by 2002:a17:90b:4c92:b0:20b:a13:83c7 with SMTP id my18-20020a17090b4c9200b0020b0a1383c7mr19332183pjb.128.1665781646813; Fri, 14 Oct 2022 14:07:26 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1665781646; cv=none; d=google.com; s=arc-20160816; b=EA3lc1v2S6HhF5aFkeVs77urYcK92l/7f0buT+XC54L1n9JqI9FrKWSz5AcVfJAO6U bXfz+1Knpi+39pPPRbr/Glf+8QH4hSHk+UYC/vaHJAfSNF9faVsBaZVIuE9MWSL49Ec7 pgBVMInBgXTg6uoYU53gECLssZsXqIi1UFkPT/N5sstqSbh5TAp8HTF2t3/pcw8koxHO dzTZoLXwH/UP1+5qr/wikVo0pW1F/wPXh+wOZhvRxMHJ89ul4aGYg9A9uHTNZ+QvM2P7 GsxAHKWZrp2yGOGmNi+pwTdVYqq5zGrtiVF4up8CPf7oBYrrvF+eXjs2NZqY4AGP+8ka OwNA== 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 :message-id:date:subject:cc:to:from:dkim-signature; bh=Xuy3xMm/hFx8vekk/AqY/ejB6UTAdSndtwHepzM06Fc=; b=UbFUdolk3PpnGj28cE6OxdiruBbuMuAQE8NH3lQfXp0lKeIHWCsK6N9IOimNnu1Oj1 agS/P4fySJer7vZMG02BeVrMuXzGzpOGipdQ0uz7OV+qrWHKTWbq8Sh/qU8uXuImIJqj +QXNEz1pStoJUHxcd9emprZbZyKgFLKESEhdz9a5flvDBYTlA3x4sCWIAypSP0QUcZuQ vPABBds7f1bLlp2ZbQ2Tyeuc+1XOdf8rFUL42sJ30jRQwo/CTsbClDY+OcCOCNe/Pmw2 49ZaC1tWVeTqxCuaGtm0GteQjGXhMIw6pfXrNGC4GGinanQ+JYYBS4F48q+x2ZB2vUjn 4dMg== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@metrotek.ru header.s=mail header.b=APR5lPih; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id q10-20020a170902f34a00b00178380f525bsi3270463ple.547.2022.10.14.14.07.14; Fri, 14 Oct 2022 14:07:26 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=fail header.i=@metrotek.ru header.s=mail header.b=APR5lPih; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229704AbiJNU43 (ORCPT + 99 others); Fri, 14 Oct 2022 16:56:29 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42500 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229609AbiJNU41 (ORCPT ); Fri, 14 Oct 2022 16:56:27 -0400 Received: from mail.pr-group.ru (mail.pr-group.ru [178.18.215.3]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 4872B1C493F; Fri, 14 Oct 2022 13:56:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=metrotek.ru; s=mail; h=from:subject:date:message-id:to:cc:mime-version:content-transfer-encoding; bh=O38m3Gmwd1SrCi88XGH7fqSPtTeCobB2G4S90JKS4LE=; b=APR5lPihbmnA7ydWGAq02059QmawuCzALRSf9UBQczYDmjCVySRG1fkH4ivdHFt6U/A6R1LyAMR/C NPIFJRAkS3P31tunb/C5hKKbm8vfVPnqXabrRGFXA+timWXFShOI8Xguh7R3pP/dGhVcMBCxoE6e5+ 0rQ6WgCZbSHPmRDaR/ytI0QYu2T4JwvVDKhQTU5bbfWtUIj5UFZCC7qShejd4/A0Q9rZHBd2xe6goy CcN2Z/jWx9nKnyZBcxMBpdk786VY0CbkOFgieiBS4FQFN0c1NsRyuofq4J7wLbM/0CBRtVFU/OkhSe HN4NBzQYB/pjsUYDpvVgISqobdMyriw== X-Kerio-Anti-Spam: Build: [Engines: 2.16.4.1445, Stamp: 3], Multi: [Enabled, t: (0.000012,0.028393)], BW: [Enabled, t: (0.000030,0.000001)], RTDA: [Enabled, t: (0.109497), Hit: No, Details: v2.42.0; Id: 15.52k3rc.1gfc4h2bg.cfpc; mclb], total: 0(700) X-Spam-Status: No, score=-0.4 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,SPF_PASS, URIBL_BLACK autolearn=no autolearn_force=no version=3.4.6 X-Spam-Level: X-Footer: bWV0cm90ZWsucnU= Received: from localhost.localdomain ([92.100.86.33]) (authenticated user i.bornyakov@metrotek.ru) by mail.pr-group.ru with ESMTPSA (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256 bits)); Fri, 14 Oct 2022 23:56:11 +0300 From: Ivan Bornyakov To: mdf@kernel.org, hao.wu@intel.com, yilun.xu@intel.com, trix@redhat.com, dg@emlix.com, j.zink@pengutronix.de, robh+dt@kernel.org, krzysztof.kozlowski+dt@linaro.org Cc: Ivan Bornyakov , linux-fpga@vger.kernel.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, kernel@pengutronix.de, system@metrotek.ru Subject: [PATCH v18 0/2] Lattice sysCONFIG SPI FPGA manager Date: Fri, 14 Oct 2022 23:27:48 +0300 Message-Id: <20221014202750.20542-1-i.bornyakov@metrotek.ru> X-Mailer: git-send-email 2.37.3 MIME-Version: 1.0 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1746698655595262093?= X-GMAIL-MSGID: =?utf-8?q?1746698655595262093?= Add support to the FPGA manager for programming Lattice ECP5 FPGA over slave SPI sysCONFIG interface. ChangeLog: v1 -> v2: * remove "spi" from compatible string * reword description in dt-bindings doc * add reference to spi-peripheral-props.yaml in dt-binding doc * fix DTS example in dt-bindings doc: 4-spaces indentations, no undersores in node names. v2 -> v3: * fix typo "##size-cells" -> "#size-cells" in dt-bindings example v3 -> v4: * dt-bindings: reword description * dt-bindings: revert props order v4 -> v5: * dt-bindings: remove trailing dot from title * dt-bindings: reword description to avoid driver reference * dt-bindings: add "Reviewed-by: Krzysztof Kozlowski" tag v5 -> v6: * ecp5-spi: lock SPI bus for exclusive usage in ecp5_ops_write_init(), release in ecp5_ops_write_complete() or on error v6 -> v7: * ecp5-spi.c -> lattice-sysconfig-spi.c. Reworked to represent generalized sysCONFIG port with implementations for ECP5 and MachXO2 * lattice,ecp5-fpga-mgr.yaml -> lattice,sysconfig.yaml. Reworked to document both ECP5 and MachXO2 sysCONFIG. * dt-bindings: remove "Reviewed-by: Krzysztof Kozlowski" tag as doc was rewritten by a considerable amount. v7 -> v8: * dt-bindings: move "program-gpios", "init-gpios" and "done-gpios" to top-level properties and disallow them for MachXO2 variant. v8 -> v9: * dt-bindings: "program-gpios", "init-gpios" and "done-gpios" are now optional for both ECP5 and MachXO2 * lattice-sysconfig-spi.c -> sysconfig-spi.c + sysconfig.c + sysconfig.h ** reworked to be one sysCONFIG FPGA Manager rather than two distinct ECP5 and MachXO2 managers ** splitted to port type agnostic sysconfig.c and SPI-specific sysconfig-spi.c ** command transfer function moved to callback for ease of adding another port type, such as I2C v9 -> v10: * split sysconfig_transfer() callback into separate command_write() and command_write_then_read(). There are too many transfers without readback. * add command_write_with_data() callback which performs single transfer of command + data. It's needed for better abstraction of paged bitstream write routine. * move sysconfig_lsc_burst_init() to bitstream_burst_write_init() callback to break dependence of sysconfig.c from sysconfig-spi.c * move sysconfig_lsc_burst_complete() to bitstream_burst_write_complete() callback to break dependence of sysconfig.c from sysconfig-spi.c * add bitstream_burst_write() to abstract fpga_manager_ops->write() from bus type * remove struct spi_device from struct sysconfig_priv, use to_spi_device() * move fpga_manager_ops initialization to sysconfig.c v10 -> v11: * rename sysconfig_lsc_burst_init() to sysconfig_spi_lsc_burst_init() * rename sysconfig_bitstream_burst_write() to sysconfig_spi_bitstream_burst_write() * rename sysconfig_lsc_burst_complete() to sysconfig_spi_lsc_burst_complete() * rename "ecp5-fpga-mgr" to "sysconfig-ecp5" * rename "machxo2-fpga-mgr" to "sysconfig-machxo2" * move spi_max_speed_hz from struct sysconfig_fpga_priv to struct sysconfig_spi_fpga_priv, which is local to sysconfig-spi.c * remove SPI bus unlock on write error form sysconfig_spi_bitstream_burst_write(), call sysconfig_burst_write_complete() on error in sysconfig_bitstream_burst_write() instead. v11 -> v12: * build sysconfig core as separate module to prevent duplication of common code segments across different binaries * rename sysconfig.c to lattice-sysconfig.c * rename sysconfig.h to lattice-sysconfig.h * rename sysconfig-spi.c to lattice-sysconfig-spi.c * rename sysconfig_spi_cmd_write_then_read() to sysconfig_spi_cmd_read() * rename command_write_then_read() callback to command_read() * rename sysconfig_cmd_write_then_read() to sysconfig_cmd_read() * rename sysconfig_spi_lsc_burst_init() to sysconfig_spi_bitstream_burst_init() * rename sysconfig_spi_lsc_burst_complete() to sysconfig_spi_bitstream_burst_complete() * remove excessive !spi check from sysconfig_spi_cmd_write(), sysconfig_spi_cmd_read(), sysconfig_spi_bitstream_burst_init(), sysconfig_spi_bitstream_burst_write() and sysconfig_spi_bitstream_burst_complete() * drop MachXO2 support ** drop struct sysconfig_fpga_priv ** drop paged write ** drop command_write_with_data() and friends ** drop ISC_PROGRAM_DONE routine ** drop refresh from sysconfig_isc_finish() ** sysconfig_isc_erase() only erase SRAM ** drop MachXO2 mentions from DT bindings doc v12 -> v13: * use device_get_match_data() instead of of_device_get_match_data() and drop of_device.h inclusion * in polling routines use time_before(jiffies, timeout) instead of retries count * add usleep_range() to gpio polling routine * check fail status of command in more pronounced way * check definition of sysconfig_priv callbacks at probe * (BIT(23) | BIT(24) | BIT(25)) -> GENMASK(25, 23) v13 -> v14: * return -ETIMEDOUT instead of -EBUSY from sysconfig_poll_busy() to align with sysconfig_poll_gpio() v14 -> v15: * move sysCONFIG commands from stack to heap, as spi-summary doc says: "I/O buffers use the usual Linux rules, and must be DMA-safe. [...] Don't use the stack, or anything that's declared "static"." ** add u8 cmd_tx_buf[4] and u8 cmd_rx_buf[4] to struct sysconfig_priv ** copy commands to cmd_tx_buf before sending to the device ** use cmd_rx_buf for commands readback ** change command_write() and command_read() signatures, as command buffers are now embedded to sysconfig_priv ** combine sysconfig_read_busy() with sysconfig_poll_busy() to avoid same memcpy in the loop v15 -> v16: * revert to v14 * combine command_write() and command_read() to command_transfer() which uses spi_write_then_read() underhood. spi_write_then_read() is dma-safe for on-stack buffers. * in sysconfig_spi_bitstream_burst_init() bounce on-stack buffer with LSC_BITSTREAM_BURST command to the heap. Now everything should be dma-safe. v16 -> v17: * return dev_err_probe() from sysconfig_probe() if devm_gpiod_get_optional() fails v17 -> v18: * use read_poll_timeout() in sysconfig_poll_busy() and sysconfig_poll_gpio() * combine checks for callbacks presence in sysconfig_probe() into one if-statement, add missing check for command_transfer() Ivan Bornyakov (2): fpga: lattice-sysconfig-spi: add Lattice sysCONFIG FPGA manager dt-bindings: fpga: document Lattice sysCONFIG FPGA manager .../bindings/fpga/lattice,sysconfig.yaml | 81 ++++ drivers/fpga/Kconfig | 11 + drivers/fpga/Makefile | 2 + drivers/fpga/lattice-sysconfig-spi.c | 154 +++++++ drivers/fpga/lattice-sysconfig.c | 394 ++++++++++++++++++ drivers/fpga/lattice-sysconfig.h | 39 ++ 6 files changed, 681 insertions(+) create mode 100644 Documentation/devicetree/bindings/fpga/lattice,sysconfig.yaml create mode 100644 drivers/fpga/lattice-sysconfig-spi.c create mode 100644 drivers/fpga/lattice-sysconfig.c create mode 100644 drivers/fpga/lattice-sysconfig.h