[PATCH] docs: i2c: slave-interface: return errno when handle I2C_SLAVE_WRITE_REQUESTED

[PATCH] docs: i2c: slave-interface: return errno when handle I2C_SLAVE_WRITE_REQUESTED

[Quan Nguyen]

In case backend is not ready, ie: fail to wakeup or initialization, on
the returning of the I2C_SLAVE_WRITE_REQUESTED event, bus driver should
aware the backend status and might auto sending NACK on the next
incoming bytes for I2C master to retry.

Signed-off-by: Quan Nguyen <quan@os.amperecomputing.com>
Links:https://lore.kernel.org/linux-arm-kernel/556fa9e1-c54b-8370-4de7-c2d3ec7d6906@os.amperecomputing.com/
---
 Documentation/i2c/slave-interface.rst | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/Documentation/i2c/slave-interface.rst b/Documentation/i2c/slave-interface.rst
index 82ea3e1d6fe4..03b15b21d392 100644
--- a/Documentation/i2c/slave-interface.rst
+++ b/Documentation/i2c/slave-interface.rst
@@ -72,12 +72,15 @@ Event types:
 
   'val': unused
 
-  'ret': always 0
+  'ret': 0 if backend ready, otherwise, returns some errno
 
 Another I2C master wants to write data to us. This event should be sent once
 our own address and the write bit was detected. The data did not arrive yet, so
-there is nothing to process or return. Wakeup or initialization probably needs
-to be done, though.
+there is nothing to process or return. After returning, the bus driver should
+always ack on this address phase. If 'ret' is zero, backend initialization or
+wakeup is done and ready. If 'ret' is an errno, bus driver should aware the
+backend status and might need to nack all next incoming bytes for I2C master to
+retry.
 
 * I2C_SLAVE_READ_REQUESTED (mandatory)
 
-- 
2.35.1

Re: [PATCH] docs: i2c: slave-interface: return errno when handle I2C_SLAVE_WRITE_REQUESTED

[Wolfram Sang]

[-- Attachment #1: Type: text/plain, Size: 699 bytes --]

On Thu, Sep 15, 2022 at 10:54:40AM +0700, Quan Nguyen wrote:
> In case backend is not ready, ie: fail to wakeup or initialization, on
> the returning of the I2C_SLAVE_WRITE_REQUESTED event, bus driver should
> aware the backend status and might auto sending NACK on the next
> incoming bytes for I2C master to retry.
> 
> Signed-off-by: Quan Nguyen <quan@os.amperecomputing.com>
> Links:https://lore.kernel.org/linux-arm-kernel/556fa9e1-c54b-8370-4de7-c2d3ec7d6906@os.amperecomputing.com/

Sorry for the delay. I made some wording more precise and applied it to
for-next. So, we can use it right for next merge window, if needed.

Thank you for suggesting this and for your patience!


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH] docs: i2c: slave-interface: return errno when handle I2C_SLAVE_WRITE_REQUESTED

[Quan Nguyen]

Thank you, Wolfram, for the review and the wording fixes :-)
- Quan

On 29/09/2022 02:41, Wolfram Sang wrote:
> On Thu, Sep 15, 2022 at 10:54:40AM +0700, Quan Nguyen wrote:
>> In case backend is not ready, ie: fail to wakeup or initialization, on
>> the returning of the I2C_SLAVE_WRITE_REQUESTED event, bus driver should
>> aware the backend status and might auto sending NACK on the next
>> incoming bytes for I2C master to retry.
>>
>> Signed-off-by: Quan Nguyen <quan@os.amperecomputing.com>
>> Links:https://lore.kernel.org/linux-arm-kernel/556fa9e1-c54b-8370-4de7-c2d3ec7d6906@os.amperecomputing.com/
> 
> Sorry for the delay. I made some wording more precise and applied it to
> for-next. So, we can use it right for next merge window, if needed.
> 
> Thank you for suggesting this and for your patience!
>