Received-SPF: pass (google.com: domain of linux-kernel+bounces-170183-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
From: Frank Li <Frank.Li@nxp.com>
To: miquel.raynal@bootlin.com
Cc: Frank.Li@nxp.com,
	alexandre.belloni@bootlin.com,
	conor.culhane@silvaco.com,
	imx@lists.linux.dev,
	linux-i3c@lists.infradead.org,
	linux-kernel@vger.kernel.org
Subject: [PATCH v2 1/3] i3c: Add comment for -EAGAIN in i3c_device_do_priv_xfers()
Date: Mon,  6 May 2024 12:40:07 -0400
Message-Id: <20240506164009.21375-1-Frank.Li@nxp.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
Precedence: bulk
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0:
	=?us-ascii?Q?1EXiCe1j6onSzht7fWx7L8975QyOtm5hQ7ofbnKQcH9bZNQodLAKtQRVsCBx?=
 =?us-ascii?Q?Jzj2a7Wwdcmgc1DLwpKfhfgGO4z/lBwCFBpmuSr8MZyK8dyFF8w5oR77dE5u?=
 =?us-ascii?Q?aNsLMYY/aTGh/7Um6eZCOmyhuv23dmmPEGPnfUaPrtmBM9i7w8OTIMDGdFjr?=
 =?us-ascii?Q?Zw+mkOQyfpc0aeX90RK+ULtVaV/EYAoQPSsuQ5xDk0NOkqpF/UP3RriKeEWe?=
 =?us-ascii?Q?tfgiMmsnFgdHG8tFPmY+/qgyGQjQY5qLxlSMVcHBEkvqi1p4j9kc15kYTpj+?=
 =?us-ascii?Q?GE9IJYMMbXGwrqpA+yq3DBmvbk7UJFj28hw650OWfgJfbn6sYjb7Tc2dPW3X?=
 =?us-ascii?Q?lMFKTy7205kZ1aZH5lo3a2rRdP037EAZ7vlRDS4UUE7VGR3iLUg69he4iuJg?=
 =?us-ascii?Q?N6etcq7CMKApXIMuYVNtXLayOhpGrFmyKXLqsuqWXoQ7Hmx2ZZCumBRvAg/N?=
 =?us-ascii?Q?+KJkQJW24pklkHZKejgzs7eqH4bmF8bpdgxfSQMwC81FcLt9yvoafpzBJbW9?=
 =?us-ascii?Q?ciYbtvpOMXbwrClZc+vGF1ICJSp+JyINCKZIRF2N3D4pFzlcCgyDbixeA3i4?=
 =?us-ascii?Q?0ckIvjODCydurmghwU9dJ4eaYzf88l9ncijOC06aoVKO30a4adIsMb2Eej/m?=
 =?us-ascii?Q?QeplgN94gW2BGBMp+qCEunjHx4Uk1vk6zsYw6DsggRsRzfTNf4dAysic3qgH?=
 =?us-ascii?Q?SLQzsp8Rr+gxj/TkKqqlYOfwaP2vXgzt/dHuq8geJEmRvc1HZCBbtLy/eVRX?=
 =?us-ascii?Q?z0GoCtwBtbjjrDd14Z1Ktg4axMfNRk9QRo/Vnph/IdCNYLdi7qTsoTv+fcI0?=
 =?us-ascii?Q?cJ1D1s2VY+Y1TKLq4i0rBt/p2ML3Er+8FAhYGEvr+4Vyl/ANkJw6cTaOUYsR?=
 =?us-ascii?Q?t61nLUbbCPueMJLZHToKc9nRgPl50imyZV/jjjosMElEZwy+2Fr396fRQ48Q?=
 =?us-ascii?Q?c2flxWkUTk/x/skEmWvZwZB2acfMbBUJ5GePdx95aBBSyFkHSAj1Ebxckqwd?=
 =?us-ascii?Q?KuVK7iKoQNpPd5Z0a4M7MYQU5sxupFBYffNbOFosYUey6bveFhb0Qxi/L/b9?=
 =?us-ascii?Q?fZZlXPVlhYoLQ2HCssI3OeMNjo12OiIFzYUqnt7SrSiyLjtDrzPsALLJdwm4?=
 =?us-ascii?Q?t5BeaMRdiajVkHlHU7SQ+e9vz3LVPsomt2O85FEN3O6FLQxqrs2yb63DvG1a?=
 =?us-ascii?Q?jRB8XlhoJ2eufiSrGYGn6/0R6psfvH4TK2rJNZMRDCXyaD2thY8gOtrnkW49?=
 =?us-ascii?Q?Oq535AOzTBUyTvBEMylgQE0oejl8r8F4bH6/3ufxisEz4DB9EYAVBEiT8DD9?=
 =?us-ascii?Q?1mP+yRgwm/0cHr2irSAwDJ7oBieASrb7ZM7Ai/F97OOq/cm6pDWh2YApfTSk?=
 =?us-ascii?Q?Eshknu+QEx1pvDo2f9X61F0Bfto1T6tRif1KWQsQ2+iNEMAYmhq734BeJd/B?=
 =?us-ascii?Q?NtiElo0HLvv3EmUWvOO2S9Qsjlqz1hS+tQEXmSUOs0gUpNNmIbMG2UpnlpIZ?=
 =?us-ascii?Q?63EuYrjhdA9k4DKhzKcCHqQP44Fv0oEpBLf5EVXMrDWA685XXfKa9NRyq0ip?=
 =?us-ascii?Q?ehQBXmlCJBbtz8FFDNA=3D?=
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 8929be52-c684-45ee-e55a-08dc6deb3b58
X-MS-Exchange-CrossTenant-AuthSource: PAXPR04MB9642.eurprd04.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 May 2024 16:40:26.3023
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 0Spy4mvgeojPZiI6VK1EJ0ClhgcFUUKBFSmmUxCpArIomt0jDm34uLy8EugTmTo34SbmKrlAr9dZXyRDmc82Mg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AS1PR04MB9429

In accordance with I3C spec ver 1.1.1 09-Jun-2021, section: 5.1.2.2.3, if
a target requests hot join (HJ), In-Band Interrupt (IBI), or controller
role request (CRR) during the emission of an I3C address in
i3c_device_do_priv_xfers(), the target may win bus arbitration. In such
cases, it is imperative to notify the I3C client driver and retry
i3c_device_do_priv_xfers() after some delay.

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---

Notes:
    Change from v1 to v2
    - new patch

 drivers/i3c/device.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/drivers/i3c/device.c b/drivers/i3c/device.c
index 1a6a8703dbc3a..b04a55a1337d4 100644
--- a/drivers/i3c/device.c
+++ b/drivers/i3c/device.c
@@ -27,6 +27,10 @@
  * This function can sleep and thus cannot be called in atomic context.
  *
  * Return: 0 in case of success, a negative error core otherwise.
+ *	   -EAGAIN: controller lost address arbitration. Target
+ *		    (IBI, HJ or controller role request) win the bus. Client
+ *		    driver need resend this 'xfers' some time later.
+ *		    See I3C spec ver 1.1.1 09-Jun-2021. Section: 5.1.2.2.3.
  */
 int i3c_device_do_priv_xfers(struct i3c_device *dev,
 			     struct i3c_priv_xfer *xfers,
-- 
2.34.1