]> git.itanic.dy.fi Git - linux-stable/commit
spi: Unify error codes by replacing -ENOTSUPP with -EOPNOTSUPP
authorChia-Lin Kao (AceLan) <acelan.kao@canonical.com>
Wed, 29 Nov 2023 06:43:10 +0000 (14:43 +0800)
committerMark Brown <broonie@kernel.org>
Thu, 30 Nov 2023 12:12:39 +0000 (12:12 +0000)
commitcff49d58f57e5667c10a0db85d7461790bb85cf8
treeb479a24e9a5a2e497a153270fb9b63ff165bd231
parent8e6a43961f24cf841d3c0d199521d0b284d948b9
spi: Unify error codes by replacing -ENOTSUPP with -EOPNOTSUPP

This commit updates the SPI subsystem, particularly affecting "SPI MEM"
drivers and core parts, by replacing the -ENOTSUPP error code with
-EOPNOTSUPP.

The key motivations for this change are as follows:
1. The spi-nor driver currently uses EOPNOTSUPP, whereas calls to spi-mem
might return ENOTSUPP. This update aims to unify the error reporting
within the SPI subsystem for clarity and consistency.

2. The use of ENOTSUPP has been flagged by checkpatch as inappropriate,
mainly being reserved for NFS-related errors. To align with kernel coding
standards and recommendations, this change is being made.

3. By using EOPNOTSUPP, we provide more specific context to the error,
indicating that a particular operation is not supported. This helps
differentiate from the more generic ENOTSUPP error, allowing drivers to
better handle and respond to different error scenarios.

Risks and Considerations:
While this change is primarily intended as a code cleanup and error code
unification, there is a minor risk of breaking user-space applications
that rely on specific return codes for unsupported operations. However,
this risk is considered low, as such use-cases are unlikely to be common
or critical. Nevertheless, developers and users should be aware of this
change, especially if they have scripts or tools that specifically handle
SPI error codes.

This commit does not introduce any functional changes to the SPI subsystem
or the affected drivers.

Signed-off-by: "Chia-Lin Kao (AceLan)" <acelan.kao@canonical.com>
Acked-by: Tudor Ambarus <tudor.ambarus@linaro.org>
Reviewed-by: Mika Westerberg <mika.westerberg@linux.intel.com>
Acked-by: Miquel Raynal <miquel.raynal@bootlin.com>
Acked-by: Michael Walle <michael@walle.cc>
Link: https://lore.kernel.org/r/20231129064311.272422-1-acelan.kao@canonical.com
Signed-off-by: Mark Brown <broonie@kernel.org>
drivers/mtd/nand/spi/core.c
drivers/mtd/spi-nor/core.c
drivers/spi/atmel-quadspi.c
drivers/spi/spi-ath79.c
drivers/spi/spi-bcm-qspi.c
drivers/spi/spi-mem.c
drivers/spi/spi-npcm-fiu.c
drivers/spi/spi-ti-qspi.c
drivers/spi/spi-wpcm-fiu.c
include/linux/spi/spi-mem.h