Received-SPF: pass (google.com: domain of linux-kernel+bounces-90870-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.48.161 as permitted sender) client-ip=147.75.48.161;
Received-SPF: Pass (protection.outlook.com: domain of opensynergy.com
 designates 217.66.60.4 as permitted sender) receiver=protection.outlook.com;
 client-ip=217.66.60.4; helo=SR-MAIL-03.open-synergy.com; pr=C
From: Harald Mommer <Harald.Mommer@opensynergy.com>
To: virtio-dev@lists.oasis-open.org,
	Haixu Cui <quic_haixcui@quicinc.com>,
	Mark Brown <broonie@kernel.org>,
	Viresh Kumar <viresh.kumar@linaro.org>,
	linux-spi@vger.kernel.org,
	linux-kernel@vger.kernel.org
Cc: quic_ztu@quicinc.com,
	Matti Moell <Matti.Moell@opensynergy.com>,
	Mikhail Golubev <Mikhail.Golubev@opensynergy.com>
Subject: [PATCH v2 0/3] Virtio SPI Linux driver
Date: Mon,  4 Mar 2024 16:43:39 +0100
Message-Id: <20240304154342.44021-1-Harald.Mommer@opensynergy.com>
Precedence: bulk
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 04 Mar 2024 15:43:53.5232
 (UTC)
X-MS-Exchange-CrossTenant-Network-Message-Id: 7f6c3d2f-ad44-4b1d-c688-08dc3c61e548
X-MS-Exchange-CrossTenant-Id: 800fae25-9b1b-4edc-993d-c939c4e84a64
X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=800fae25-9b1b-4edc-993d-c939c4e84a64;Ip=[217.66.60.4];Helo=[SR-MAIL-03.open-synergy.com]
X-MS-Exchange-CrossTenant-AuthSource:
	AMS0EPF000001A2.eurprd05.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Anonymous
X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem
X-MS-Exchange-Transport-CrossTenantHeadersStamped: FR6P281MB3629
X-TM-AS-ERS: 104.47.11.168-0.0.0.0
X-TMASE-Version: StarCloud-1.3-9.1.1015-28232.000
X-TMASE-Result: 10--12.476900-4.000000
X-TMASE-MatchedRID: GBRRVxh6iep+P9X2YpqgJg0vIxjiU4qa+bMNqByZrThgGncd4UL3wtvg
	EYRNbHS38+Sy0Kb1RsB+bMqzm+sLBtGWdb4fn9mBAszeqtinEnsWRcTK0fEGOb2L79/20sYbS/c
	jG/gfmu8VUYZTT6p1OshYa+kuusm6cE3FwWrm18QLOnhkOkWpfSd8voqopKNvuzAg7efo/wXYHk
	MT0O/LF1UzWEVEXZ/MsXn4SpgL43YBXLfU7YcIf0sfZgIcSmI9YfwVmaD2H4ZwLNL3IuElDR5Wy
	kMoTtfXIdEt8j0U+5Q3JoGmac9XrcgQrXecJrZF0A1Umn1aDodISqO7uCT8S0uJfM58tqmeaftC
	e5kj6T6BK7jsLKFqkSEEB+1mvDOoi0Lxf1aMtgRyCBet3G8bCqgclxRwe1qqKIN+Wah9iR51WON
	HT78wn+0Dx9so3Ua56xA0Ava73nBcOnqpgy+bqxEuOqgkm3/1h7z+gmKKj0oDf6I8jFx+tlmLzQ
	cf60TusLrqnOPE+us0zI7+eiZZ8FIwpoXl+YmJG/hIVZB14aWDJncORRtCoDxhmyH8K1MxfZ0lX
	QE3j4E=
X-TMASE-XGENCLOUD: 914cd6c8-c0af-4979-b93d-6c4a0d9e9547-0-0-200-0
X-TM-Deliver-Signature: 47F24A8628BD228EA66B4C1759F723EC
X-TM-Addin-Auth: 5oZO3qT9/dOUIailRiIfh9Ok/CqAIM18qiBbNU3JWjubatd87ey90S4LUyc
	MXMsJRgLt8Hy4zqghgoTAoHME83xxSxp9ck8ECW/4bYAAvrDFPwg4DtXIiulgljXMlR4hPKQuS6
	jVVXsJuVQGQYD6wKJYaa3AbA56VziSBJQTA+Xp7Lwdlsmz4tGsqXuvUUYkXVivLuiE5ttiC8QHI
	UK/miyXkZJZbqlFLN+rNmAzvxfPkGIyppHoDHObg2i2FnkK5h6M+E7qLHEa6xrIEO7wobs3xgKm
	Z6p4Iy1QXvWerHU=.hoJ3QOGJ08O3lv5Y2R+BtzGFYaSWtjeLhJg1/WRRLFVXU/Mq8yIxOJrS3u
	UHgtainZYFpH8TyVPGfAq0ceCm/qL/8wBd6QXSN9LJx/745v3lBOkHP+A7I/EwB2fG8anoeIqXD
	lpLLwf7IIE2BhaCK6KDOFAE5Jtq97sFsXynbsC79tzA3rZQhgycEdp6Mobf5eU0/CT5fFOv7khR
	l/3/zaXAJ1cPdTYF2sJ3sXFHJblH6R1E+Uwx3H69C2GyXFfT0CklIpyk98j/jCCRis1A/sN4e9E
	pyrzZk3URmZ+mNkth3/KkVU96myiW3YoBcJZQTELwctTYZO2zb1eD8VWgnw==
X-TM-Addin-ProductCode: EMS
DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=opensynergy.com;
	s=TM-DKIM-20210503141657; t=1709567037;
	bh=nSqEmGSaKT1lr7Q/XpmUfpi6lwVLIwXt2MztnVGaHoQ=; l=3357;
	h=From:To:Date;
	b=GQBri/AHzxrSE0TIiSDFvMO4unThtoC4mlg/kgMvmlQTck7zuKilOCLpVxo8SMenE
	 OSisyTCBK0zIiJ3FJT51FpEJs/K9LO0gIyhAl7ZshWczJn4Eh2wRjJsrmTgDmdsxG3
	 LUqlCfcISnWiI4Bq3po6xLcPzOzscX+/kUhdxn80FPN0HephbTPgClU/dHsUWUYmzE
	 h2/FQOqZdmFV9V3xSu1n3wWjPcymbMCjD2XIR64ehdYVsE2atdCzvPhRbL2M5Zd5j5
	 YEo8IxhRlCigjRVwcQIh1sok6IeAbC+bzBkk8c6eCNEptZhpLQxh0lNX6CGWOFzKSL
	 quXRgpvW0Lo9Q==

This is the 2nd non-RFC version of a virtio SPI Linux driver which is
intended to be compliant with the the upcoming virtio specification
version 1.4. The specification can be found in repository
https://github.com/oasis-tcs/virtio-spec.git branch virtio-1.4.

This driver is the direct successor of the 1st non-RFC virtio driver.

Changes between 1st and 2nd virtio SPI driver RFC:

- Update from virtio SPI draft specification V4 to V10.

- Incorporate review comments gotten from the community.

A proposal for a performance enhancement having more than only one SPI
message in flight had to be kept out. The more complicated code would
have caused an unacceptable project risk now.

Changes between 2nd and 3rd virtio SPI driver RFC:

- Order header inclusion alphabetically

- Add Viresh Kumar's "signed-off" to the header files

- Rework virtio_spi_one_transfer()
  - Rework the delays according to Haixu Cui's advise. Delays are now
    handled in a new sub-function virtio_spi_set_delays()
  - Minor change: Re-formulate arguments of sg_init_one()

- Rework virtio_spi_probe()
  - Replace some goto in error paths by return
  - Add spi_unregister_controller() to an error path. Abstained from
    using devm_spi_register_controller() to keep order of
    de-initialization in virtio_spi_remove().
  - Add deletion of vqueue to all error paths taken after the virtqueues
    have been initialized

Changes between 3rd virtio SPI driver RFC and non-RFC driver V1

- Address kernel test robot comment which revealed an actual bug
- Rework some comments in the code addressing review comments
- Remove a TODO comment which has served it's purpose
- Allocate struct virtio_spi_req spi_req only once at startup
- Use callback transfer_one instead of transfer_one_message to simplify
  and shorten code. Due to this rework in the affected function(s) some
  additional changes:
  - Do init_completion() only once at startup, for re-initialization
    now reinit_completion() is used
  - Translate result codes VIRTIO_SPI_PARAM_ERR and VIRTIO_SPI_TRANS_ERR
    to appropriate Linux error codes -EINVAL and -EIO
  
Changes between 1st non-RFC virtio SPI driver and non-RFC driver V2

- Remove some comments stating the obvious
- Remove error trace when devm_spi_alloc_host() failed as this is habit
- Add some blank lines to improve readabilty
- Last TODO comment removed which was used to trigger some discussion.
  Discussion did not take place, most probably the code below is correct
  as it is

- Abstained from replacing "Cannot " by "Failed to " in error messages
  as the wording "Cannot " is frequently used even when "Failed to " has
  the majority. Announced this, heard nothing about this, so added the
  "Reviewed-by" from Viresh Kumar <viresh.kumar@linaro.org> as
  everything else was done.
  
The virtio SPI driver was smoke tested on qemu using OpenSynergy's
proprietary virtio SPI device doing a SPI backend simulation on top of
https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git
branch next/stable (tagged v6.8-rc7). Changes between v1 and v2 are so
small that target test of the adapted version of the driver on Linux 6.5
with target hardware providing a physical SPI backend device was
omitted, there were no code change code paths normally taken.