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;
Message-ID: <bf001ece-e981-3a06-53fe-6a8b637d69fe@os.amperecomputing.com>
Date:   Thu, 16 Jun 2022 14:16:14 +0700
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:91.0)
 Gecko/20100101 Thunderbird/91.10.0
Subject: Re: [PATCH v7 3/3] i2c: aspeed: Assert NAK when slave is busy
Content-Language: en-US
To:     Wolfram Sang <wsa@kernel.org>, Corey Minyard <minyard@acm.org>,
        Rob Herring <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski@canonical.com>,
        Joel Stanley <joel@jms.id.au>,
        Andrew Jeffery <andrew@aj.id.au>,
        Brendan Higgins <brendanhiggins@google.com>,
        Benjamin Herrenschmidt <benh@kernel.crashing.org>,
        openipmi-developer@lists.sourceforge.net,
        devicetree@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
        linux-aspeed@lists.ozlabs.org, linux-kernel@vger.kernel.org,
        linux-i2c@vger.kernel.org, openbmc@lists.ozlabs.org,
        Open Source Submission <patches@amperecomputing.com>,
        Phong Vo <phong@os.amperecomputing.com>,
        "Thang Q . Nguyen" <thang@os.amperecomputing.com>
References: <20220422040803.2524940-1-quan@os.amperecomputing.com>
 <20220422040803.2524940-4-quan@os.amperecomputing.com>
 <Yn+9QBoPdH8fMm/m@shikoro>
 <fc422a06-c035-f6e5-231b-74ea6afe8467@os.amperecomputing.com>
 <YqpB8A2uBi+4epHM@shikoro>
From:   Quan Nguyen <quan@os.amperecomputing.com>
In-Reply-To: <YqpB8A2uBi+4epHM@shikoro>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?cHFwV3JXUFUrSDIyelg3QmR2eEdwUlJia3ZYYzJ3T21ROUllay9tTU9hMmpw?=
 =?utf-8?B?N0IzL1M3Mmg3QVludXRPRittUmFDUmdzYU02WmZKNW1PQWZEaFh0c2lrdW1v?=
 =?utf-8?B?VGNRKzBJT2ViRythSkdROHJjalUzYVBRVGZVVU8vMXNnaGhBNDhJWXpvNnpz?=
 =?utf-8?B?Y0UrZm9iTEdrNmZTY1dhWUlPdCsrWGpaRVFodTB3aVl0cEJNelE0L2lZQ0V3?=
 =?utf-8?B?Q09JSFJnb251ZTkzOWUzbnl0Z1J2L0h6Y1FDR1FUVUtIWXArTXgzNmJRUUE1?=
 =?utf-8?B?WjNtbTJFRHJjbXIvTGgxWTFQZ09tcUhMNHgzdUROWmFUdnFpRWtIMUpDL2gr?=
 =?utf-8?B?Y1g3Q01zWFdONG95MWRyNjFDd3FQeTI3eE9IUFVrWVMyaTNseUk5OXV6TTd3?=
 =?utf-8?B?aS80MmxOZnBuVjhXNEJBbjkrTXdsdzRpNmxGZzZIYXZ1ZzZkOEJpZUFHS0Jy?=
 =?utf-8?B?NlErVWFncDVHK05uZnRORE5nOXZXOTBpMTU1YXg2b2RDeDc5WDllUS9lKzZK?=
 =?utf-8?B?WnoyekI2VGRMU0Joa25xV0d4NFk3eGk3U0FYaVJhZjdITnk5OWxBN3JweGly?=
 =?utf-8?B?d3Y2WUh1U2F6Z3VuQ3ZyVHl0RjRzaEdZNTE5djI1R1g2Y0dzNGJhU28xejgr?=
 =?utf-8?B?TmRUOE93Z09pZjZxNEZYUHVEZXllMXVId3VvdG4rZi9tOG54ZENPdk40MUtF?=
 =?utf-8?B?R0FWTUVPN0tQUklqTDN6VVBKaEg4N1BuTHFkOWJqOGdwb2RDTSs1YW5WQlJ0?=
 =?utf-8?B?NTlRRW9wOWtFWFJxT1lGdW9SSjVJTXR6OFRWWlNmY1B2R3h1a0Y0NDhMMzBW?=
 =?utf-8?B?YUVGVXBjRFlaQllQaEF0T1ZSSlhnVUxhSzR3Y3ZhVUNoZ0ZLM2M3R0I2cWl3?=
 =?utf-8?B?czBubEtyTlMweVZtTDlyQi85Umt0c21GYnFhSmQxRkc1NGtyQVVVVnJpYW5j?=
 =?utf-8?B?THd6YU1VelorRm5ya2lTQ0R3MmtzWktIcGdNMzkrdEFodzdqUlJ4RE1aM3dE?=
 =?utf-8?B?NjZDUDBycWJLSXprR1A0eS9VMmRzZzE0RThQakVpTlRhcklEZDkvdVZhelUx?=
 =?utf-8?B?T1I0S2ZyWVpHVjRZRFFwUGRsb0Y1Q3VDcHRaVnRjUThXcklCdnZxRVBOVFo1?=
 =?utf-8?B?NFMvbWFXeUVScWgvZFBJYm5DNUFoblNuL0dWbnhQUlZhazcwVWc5cTV3KzZq?=
 =?utf-8?B?ZllyTkRUZ0RUM2I4bW9xemZDa1dZTnBaZ0J4ejlBaGR4bEpGdU1HU2g0am50?=
 =?utf-8?B?SFNvMk9kenhjQzI2dysvVFh5MTBjWjNjV1hQYmR5c3hzQkZOVFhlK3p5VGFV?=
 =?utf-8?B?RzJHaHE5Q1lXaTRkNHlHeU5EenI0ejM2c0NKb2RyMXpweWdkVEI3QVhvOG9H?=
 =?utf-8?B?V0RYZFVXTHN5TXhGc3RONlk3S1lSWFVOSm5xUXd4cUtXUXE2NG5MTS9GOVBR?=
 =?utf-8?B?angvSnRhOXFRZVZqQU1mTTJvRFVmNEdGZ3RrVER2bXFaMTdPa2lib09Jb0dL?=
 =?utf-8?B?WWlnV0JaRi9LVStQT0hxM3Q3S2h2RWhOVG5ZRUs2YTZwWmFCVThTTTdNTUJW?=
 =?utf-8?B?TnlUczVTbUFSN1FjZWRwa0RxaU0vMUU5VUZLSkFYSEhGM25SL1RWa21RMWxO?=
 =?utf-8?B?UDVTYzhaeUhmQ1l2YUtJbm1ic29NZVRqdFRZdGlFRktZRG5tNGo0MW9PYUxR?=
 =?utf-8?B?QjlLR21HSnZoTlNpY2REb1VXWnVoN04ybDE4Qm5jUlpONlZNT2YrVVdHZGMy?=
 =?utf-8?B?TWxHejJLRUw5ZU1HaW1Zd0E1NkhzTzM0TzBINno5S09WdWVNR3dDQkNXN090?=
 =?utf-8?B?cW50Q3U1TWY5SDRLdHhGUVRHbzJGNG05VE54Y29lblREOS9BVUtSQm5tbVFE?=
 =?utf-8?B?bnU4OTdRZjBSSHpqeWUzTUp4ekRndU12WmVsbXMvY1FCNC9sa0oyaVhyZWNF?=
 =?utf-8?B?UlU2ZFBoTHVBbGJxRFEySlZZUzViVjZkNDNWN3JBRks0dnMySnBDK1QzaXha?=
 =?utf-8?B?MExBMFlaMGJBS0xaWksySmZFVzQ1VGRMMTcwZ2xGWGtrcXljVTZKdEQ1NHNx?=
 =?utf-8?B?d1lybXNkcUwwRTBrSVZBeXVSY0s5djJhTDA3VFBXMWZieUhzcjl2ZmdxaFRE?=
 =?utf-8?B?bm9kRjZFTDhiaXBBQmRXb2U4eFhQaGVtYkFCZk9hRmhsamlrRDQza3Z5RXo0?=
 =?utf-8?B?T1U3SDhhYWlXYk9CNG4zOWVqUkNFL2FuS1R2SCsxaWRaTlVoSkhzSi8xYTZH?=
 =?utf-8?B?cEx0dEx5WUVyMWZoL0lBREJrTmF4NEdzNnJLOFFWSlA2eXlBbkx5RkRSVGNw?=
 =?utf-8?B?bDdFdWc1eTUwL2prRlpmcjU2TXFyNFcwQkd2Sm41VjhZMFB0UGlZemJHaWo0?=
 =?utf-8?Q?NrVUc/9m772Lk8GtWMbGeu0m2utop/AvJY+Kk?=
X-OriginatorOrg: os.amperecomputing.com
X-MS-Exchange-CrossTenant-Network-Message-Id: a29dedac-f596-4d0b-a003-08da4f6823de
X-MS-Exchange-CrossTenant-AuthSource: SJ0PR01MB7282.prod.exchangelabs.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 16 Jun 2022 07:16:32.5987
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3bc2b170-fd94-476d-b0ce-4229bdc904a7
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: qxqhRmebMX/AC/0Fn1mI+ZzAYZlnhubG8y7iDSbhxg/c181s9WJpHwd34HSmDmeg6VaywWNPKKJqJMkCbr/D8zi8Nx1mxfgvqwqlLpOkoRk=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SA0PR01MB6249
X-Spam-Status: No, score=-4.6 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,NICE_REPLY_A,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS,T_SCC_BODY_TEXT_LINE
        autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On 16/06/2022 03:32, Wolfram Sang wrote:
> Hi Quan,
> 
>> When tested with ast2500, it is observed that there's always a
>> I2C_SLAVE_WRITE_REQUESTED comes first then other I2C_SLAVE_WRITE_RECEIVED's
>> follow for all transactions.
> 
> Yes, that's the design of the interface :)
> 
>> In case slave is busy, the NAK will be asserted on the first occurrence of
>> I2C_SLAVE_WRITE_REQUESTED make host to stop the current transaction (host
>> later will retry with other transaction) until slave ready.
>>
>> This behavior is expected as we want host to drop all transactions while
>> slave is busy on working on the response. That is why we choose to assert
>> NAK on the first I2C_SLAVE_WRITE_REQUESTED of the transaction instead of
>> I2C_SLAVE_WRITE_RECEIVED.
> 
>  From Documentation/i2c/slave-interface.rst:
> 
> ===
> 
> About ACK/NACK
> --------------
> 
> It is good behaviour to always ACK the address phase, so the master knows if a
> device is basically present or if it mysteriously disappeared. Using NACK to
> state being busy is troublesome. SMBus demands to always ACK the address phase,
> while the I2C specification is more loose on that. Most I2C controllers also
> automatically ACK when detecting their slave addresses, so there is no option
> to NACK them. For those reasons, this API does not support NACK in the address
> phase.
> 
> ===
> 
> So, the proper design is to NACK on the first received byte. All EEPROMs
> do it this way when they are busy because of erasing a page.
> 

Thanks Wolfram for the review.

On the first occurrence of I2C_SLAVE_WRITE_REQUESTED, the address is 
already received with ACK. So if slave return -EBUSY, the NAK will occur 
on the next Rx byte (on I2C_SLAVE_WRITE_RECEIVED event).

Tested this patch and capture using Saleae tool, it always shows ACK on 
the address and NAK on the first byte follow when slave return -EBUSY, 
ie: the byte follow the address, which is single part read command 
(0x03) in my case.

+ When slave return -EBUSY:
   S-> Aw(ACK)-> RxD(NAK)-> P
       0x10      0x03 (Singlepart read)

+ When slave ready:
   S-> Aw(ACK)-> RxD(ACK)-> Sr-> Ar-> TxD(ACK)-> ... -> TxD(NAK)-> P
       0x10      0x03                 0x07       ...    0xDE

Using the Logic 2 (with Saleae tool) to capture, we could see the log as 
below:

write to 0x10 ack data: 0x03    <= when slave return -EBUSY
write to 0x10 ack data: 0x03    <= when slave return -EBUSY
write to 0x10 ack data: 0x03    <= when slave return -EBUSY
...
write to 0x10 ack data: 0x03    <= when slave return -EBUSY
write to 0x10 ack data: 0x03    <= when slave is ready
read to 0x10 ack data: 0x07 0xF4 0x1D 0x00 0x01 0x00 0x00 0x00 0xDE

Thanks,
- Quan