[PATCH AUTOSEL 6.17-6.6] crypto: sun8i-ce - remove channel timeout field
Sasha Levin
sashal at kernel.org
Sat Oct 25 08:55:08 PDT 2025
From: Ovidiu Panait <ovidiu.panait.oss at gmail.com>
[ Upstream commit 9a23ea1f7558bdd3f8d2b35b1c2e16a2f9bf671e ]
Using the number of bytes in the request as DMA timeout is really
inconsistent, as large requests could possibly set a timeout of
hundreds of seconds.
Remove the per-channel timeout field and use a single, static DMA
timeout of 3 seconds for all requests.
Signed-off-by: Ovidiu Panait <ovidiu.panait.oss at gmail.com>
Tested-by: Corentin LABBE <clabbe.montjoie at gmail.com>
Reviewed-by: Corentin LABBE <clabbe.montjoie at gmail.com>
Signed-off-by: Herbert Xu <herbert at gondor.apana.org.au>
Signed-off-by: Sasha Levin <sashal at kernel.org>
---
LLM Generated explanations, may be completely bogus:
## Analysis Complete
**Backport Status: YES**
## Extensive Analysis
### Executive Summary
This commit fixes a design flaw in the Allwinner sun8i-ce crypto
driver's timeout mechanism that could cause systems to hang for
unreasonably long periods (potentially hundreds of seconds or more) when
processing large cryptographic requests. The fix replaces a dynamic,
size-based timeout with a static 3-second timeout, aligning with
industry best practices for hardware crypto operations.
### Detailed Technical Analysis
#### What the Commit Changes
The commit modifies six files in the sun8i-ce crypto driver:
1. **sun8i-ce.h (lines 109, 196-197):**
- Adds `#define CE_DMA_TIMEOUT_MS 3000` constant
- Removes `int timeout` field from `struct sun8i_ce_flow`
2. **sun8i-ce-core.c (lines 217-221):**
- Changes `msecs_to_jiffies(ce->chanlist[flow].timeout)` to
`msecs_to_jiffies(CE_DMA_TIMEOUT_MS)`
- Updates error message to remove timeout value display
3. **sun8i-ce-cipher.c (line 280):**
- Removes `chan->timeout = areq->cryptlen;` assignment
4. **sun8i-ce-hash.c (line 448):**
- Removes `chan->timeout = areq->nbytes;` assignment
5. **sun8i-ce-prng.c (line 140):**
- Removes `ce->chanlist[flow].timeout = 2000;` assignment
6. **sun8i-ce-trng.c (line 82):**
- Removes `ce->chanlist[flow].timeout = todo;` assignment
#### The Problem Being Fixed
**Historical Context:** The timeout mechanism was present since the
driver's initial introduction in commit 06f751b613296 (2019-11-01). From
the beginning, it used the number of bytes in the request as the timeout
value in milliseconds.
**The Design Flaw:**
- For cipher operations: `timeout = request_length_in_bytes`
milliseconds
- For hash operations: `timeout = request_length_in_bytes` milliseconds
- For PRNG: hardcoded `timeout = 2000` milliseconds
- For TRNG: `timeout = request_length_in_bytes` milliseconds
**Impact Analysis:**
- A 100 KB crypto request would set timeout = 100,000 ms = 100 seconds
- A 1 MB crypto request would set timeout = 1,000,000 ms = 1,000 seconds
≈ 16.7 minutes
- A 10 MB request would timeout after ≈ 2.8 hours
These timeouts are completely unreasonable for hardware cryptographic
operations, which typically complete in milliseconds to a few seconds
even for large requests.
**Real-World Consequences:**
1. If hardware encounters an error (e.g., missing clock, DMA failure),
the system would hang for an extremely long time before detecting the
failure
2. Users would experience unresponsive systems
3. Watchdogs might not trigger within reasonable timeframes
4. System recovery would be significantly delayed
**Evidence from Git History:**
A related bug was documented in commit f81c1d4a6d3f (Add TRNG clock to
the D1 variant):
```
sun8i-ce 3040000.crypto: DMA timeout for TRNG (tm=96) on flow 3
```
This occurred when a required clock wasn't enabled. The timeout was only
96ms (based on a small request), yet even this was sufficient to expose
the hardware issue. A 3-second timeout would have been equally effective
at catching such errors.
#### The Solution
The commit implements a static 3-second timeout for all DMA operations,
which:
1. **Aligns with industry standards:** Comparison with other crypto
drivers:
- STM32 crypto driver: 1000ms timeout
(drivers/crypto/stm32/stm32-cryp.c:1081)
- TI DTHE v2 driver: 2000ms timeout
(drivers/crypto/ti/dthev2-common.h:29)
- Allwinner sun8i-ce: 3000ms timeout (after this patch)
2. **Provides adequate detection:** 3 seconds is more than sufficient
to:
- Detect hardware failures (missing clocks, DMA errors, etc.)
- Allow normal operations to complete
- Prevent indefinite hangs
3. **Simplifies the code:** Removes a struct field and multiple
assignments
#### Code Flow Analysis Using Semcode
**Function: sun8i_ce_run_task()**
(drivers/crypto/allwinner/sun8i-ce/sun8i-ce-core.c:188-283)
- This is the central function where the timeout is applied
- Called by:
- sun8i_ce_cipher_do_one() for cipher operations
- sun8i_ce_hash_run() for hash operations
- sun8i_ce_prng_generate() for PRNG operations
- sun8i_ce_trng_read() for TRNG operations
**Timeout Usage Pattern:**
```c
wait_for_completion_interruptible_timeout(&ce->chanlist[flow].complete,
msecs_to_jiffies(CE_DMA_TIMEOUT_MS)); // Static 3000ms
if (ce->chanlist[flow].status == 0) {
dev_err(ce->dev, "DMA timeout for %s on flow %d\n", name, flow);
err = -EFAULT;
}
```
The timeout guards a completion waiting for a DMA interrupt. If the
interrupt doesn't arrive within 3 seconds, the operation is considered
failed.
#### Risk Assessment
**Potential Risks:**
1. **Legitimate operations > 3 seconds timing out:** EXTREMELY LOW
- Hardware crypto engines on these SoCs operate at 50-300 MHz
- Even multi-megabyte operations complete in < 1 second typically
- The commit has been tested by Corentin LABBE (original driver
author)
- No issues reported in mainline since merge
2. **Small requests with longer waits:** NEUTRAL to POSITIVE
- Previously: 16-byte request = 16ms timeout
- Now: 16-byte request = 3000ms timeout
- Impact: None - small requests complete in microseconds anyway
- Benefit: More consistent timeout behavior
3. **PRNG timeout increase:** POSITIVE
- Previously: hardcoded 2000ms
- Now: 3000ms
- Impact: More generous timeout for PRNG operations
**Benefits:**
1. **Prevents system hangs:** Critical benefit for system stability
2. **Predictable behavior:** All operations have the same timeout
3. **Easier debugging:** Consistent timeout value in error messages
4. **Code simplification:** Removes unnecessary per-channel state
5. **Alignment with best practices:** Matches other crypto drivers
#### Testing and Review
**Quality Indicators:**
- **Tested-by:** Corentin LABBE <clabbe.montjoie at gmail.com> (original
driver maintainer)
- **Reviewed-by:** Corentin LABBE <clabbe.montjoie at gmail.com>
- **Signed-off-by:** Herbert Xu <herbert at gondor.apana.org.au> (crypto
subsystem maintainer)
- **Part of patch series:** Included in a larger cleanup/refactoring
series
- **No reverts:** No revert commits found in git history
- **No follow-up fixes:** No fixes needed after merge
#### Backporting Criteria Evaluation
1. **Does it fix a bug?** ✅ YES
- Fixes a design flaw causing unreasonably long timeouts
- Prevents potential system hangs
2. **Is the fix small and contained?** ✅ YES
- 6 files changed
- Simple removal of assignments and struct field
- No complex logic changes
3. **Does it have clear side effects?** ✅ NO PROBLEMATIC SIDE EFFECTS
- Changes timeout behavior (this is the intent)
- Side effects are beneficial (shorter max timeout)
4. **Does it include major architectural changes?** ✅ NO
- Simple timeout mechanism change
- No architectural impact
5. **Does it touch critical kernel subsystems?** ⚠️ PARTIALLY
- Limited to sun8i-ce crypto driver
- Only affects Allwinner H3/A64/H5/H6/R40/D1 SoCs
- Scoped impact
6. **Is there explicit mention of stable backporting?** ❌ NO
- No "Cc: stable at vger.kernel.org" tag
- No "Fixes:" tag
7. **Does it follow stable tree rules?** ✅ YES
- Important bugfix (prevents hangs)
- Minimal regression risk
- Confined to specific driver
- Well-tested by maintainers
### Comparison with Similar Commits
Looking at the driver's git history, this commit is part of a cleanup
series by Ovidiu Panait that includes:
- Removing boilerplate code
- Improving error handling
- Refactoring for clarity
However, unlike the other commits which are pure cleanups, **this
specific commit fixes a functional issue** (unreasonable timeouts) and
should be considered a bugfix rather than just cleanup.
### Recommendation
**STRONGLY RECOMMEND BACKPORTING** to stable kernel trees for the
following reasons:
1. **Fixes a real problem:** Prevents unreasonably long system hangs
2. **Low regression risk:** 3-second timeout is very generous for
hardware crypto
3. **Well-tested:** Tested and reviewed by driver maintainer
4. **Industry alignment:** Matches timeout patterns in other crypto
drivers
5. **User-visible benefit:** Improves system responsiveness and
reliability
6. **Clean application:** No dependencies on other patches in the series
**Target stable trees:** All stable trees that include the sun8i-ce
driver (4.19+)
**Priority:** Medium-High (reliability improvement, prevents hangs)
drivers/crypto/allwinner/sun8i-ce/sun8i-ce-cipher.c | 1 -
drivers/crypto/allwinner/sun8i-ce/sun8i-ce-core.c | 5 ++---
drivers/crypto/allwinner/sun8i-ce/sun8i-ce-hash.c | 2 --
drivers/crypto/allwinner/sun8i-ce/sun8i-ce-prng.c | 1 -
drivers/crypto/allwinner/sun8i-ce/sun8i-ce-trng.c | 1 -
drivers/crypto/allwinner/sun8i-ce/sun8i-ce.h | 2 +-
6 files changed, 3 insertions(+), 9 deletions(-)
diff --git a/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-cipher.c b/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-cipher.c
index 5663df49dd817..113a1100f2aeb 100644
--- a/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-cipher.c
+++ b/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-cipher.c
@@ -276,7 +276,6 @@ static int sun8i_ce_cipher_prepare(struct crypto_engine *engine, void *async_req
goto theend_sgs;
}
- chan->timeout = areq->cryptlen;
rctx->nr_sgs = ns;
rctx->nr_sgd = nd;
return 0;
diff --git a/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-core.c b/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-core.c
index 658f520cee0ca..79ec172e5c995 100644
--- a/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-core.c
+++ b/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-core.c
@@ -210,11 +210,10 @@ int sun8i_ce_run_task(struct sun8i_ce_dev *ce, int flow, const char *name)
mutex_unlock(&ce->mlock);
wait_for_completion_interruptible_timeout(&ce->chanlist[flow].complete,
- msecs_to_jiffies(ce->chanlist[flow].timeout));
+ msecs_to_jiffies(CE_DMA_TIMEOUT_MS));
if (ce->chanlist[flow].status == 0) {
- dev_err(ce->dev, "DMA timeout for %s (tm=%d) on flow %d\n", name,
- ce->chanlist[flow].timeout, flow);
+ dev_err(ce->dev, "DMA timeout for %s on flow %d\n", name, flow);
err = -EFAULT;
}
/* No need to lock for this read, the channel is locked so
diff --git a/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-hash.c b/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-hash.c
index 13bdfb8a2c627..b26f5427c1e06 100644
--- a/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-hash.c
+++ b/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-hash.c
@@ -446,8 +446,6 @@ int sun8i_ce_hash_run(struct crypto_engine *engine, void *breq)
else
cet->t_dlen = cpu_to_le32(areq->nbytes / 4 + j);
- chan->timeout = areq->nbytes;
-
err = sun8i_ce_run_task(ce, flow, crypto_ahash_alg_name(tfm));
dma_unmap_single(ce->dev, addr_pad, j * 4, DMA_TO_DEVICE);
diff --git a/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-prng.c b/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-prng.c
index 762459867b6c5..d0a1ac66738bf 100644
--- a/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-prng.c
+++ b/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-prng.c
@@ -137,7 +137,6 @@ int sun8i_ce_prng_generate(struct crypto_rng *tfm, const u8 *src,
cet->t_dst[0].addr = desc_addr_val_le32(ce, dma_dst);
cet->t_dst[0].len = cpu_to_le32(todo / 4);
- ce->chanlist[flow].timeout = 2000;
err = sun8i_ce_run_task(ce, 3, "PRNG");
mutex_unlock(&ce->rnglock);
diff --git a/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-trng.c b/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-trng.c
index e1e8bc15202e0..244529bf06162 100644
--- a/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-trng.c
+++ b/drivers/crypto/allwinner/sun8i-ce/sun8i-ce-trng.c
@@ -79,7 +79,6 @@ static int sun8i_ce_trng_read(struct hwrng *rng, void *data, size_t max, bool wa
cet->t_dst[0].addr = desc_addr_val_le32(ce, dma_dst);
cet->t_dst[0].len = cpu_to_le32(todo / 4);
- ce->chanlist[flow].timeout = todo;
err = sun8i_ce_run_task(ce, 3, "TRNG");
mutex_unlock(&ce->rnglock);
diff --git a/drivers/crypto/allwinner/sun8i-ce/sun8i-ce.h b/drivers/crypto/allwinner/sun8i-ce/sun8i-ce.h
index 0f9a890670167..f12c32d1843f2 100644
--- a/drivers/crypto/allwinner/sun8i-ce/sun8i-ce.h
+++ b/drivers/crypto/allwinner/sun8i-ce/sun8i-ce.h
@@ -106,6 +106,7 @@
#define MAX_SG 8
#define CE_MAX_CLOCKS 4
+#define CE_DMA_TIMEOUT_MS 3000
#define MAXFLOW 4
@@ -196,7 +197,6 @@ struct sun8i_ce_flow {
struct completion complete;
int status;
dma_addr_t t_phy;
- int timeout;
struct ce_task *tl;
void *backup_iv;
void *bounce_iv;
--
2.51.0
More information about the linux-arm-kernel
mailing list