From patchwork Thu Aug 15 12:09:33 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Wolfram Sang X-Patchwork-Id: 819587 Received: from mail.zeus03.de (zeus03.de [194.117.254.33]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 82A781714DB for ; Thu, 15 Aug 2024 12:09:40 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=194.117.254.33 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723723785; cv=none; b=o4fHo6XUaPy+f76U/PQ2hrWpbK+1uJcg6RPPQiDhRr6XxMjfXdlANHz2RzmPmvv+4KUsT9WQX6oIh4R+hZ34yYb0G71k+H93xfUmuug51Cgbt5Vq9K99jsE8ZX7TTeGQgKqUfcQooGUkZQcZTHg6kOaBogBsnQtge5nlNrUsFOg= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723723785; c=relaxed/simple; bh=2MED1jBw+Hc1lSdAWZynFsgB1k7IXozgIvLSzMA1Lts=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=IPaO8dy0GsFSGS9ts7vnAPJRFDDivvxvGERFkZDHfVV+7ETpJbdlxcnISScn0AqI3ED53BvpqXikrYXwsn0IpZRsqwFqdoUODRxOEOELm4O60siL6FBDAGsjgbeor9f6Rm4m+J0jSmTxYP4GZ8vcwI+0WuE7muvGVI8tNNTVsnA= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com; spf=pass smtp.mailfrom=sang-engineering.com; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b=Rhwn/nou; arc=none smtp.client-ip=194.117.254.33 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b="Rhwn/nou" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= sang-engineering.com; h=from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; s=k1; bh=ViA3Mk3fR/Sm00+jfPS2M9yvOzEGe6KD8x0Qw7mz9YU=; b=Rhwn/n ouqeQ0xVKIeuy6RmAsWIkxQ/ZGx0hzum3SIpNSgiev1Zj9VyKYWwZOAwQPg3uirl b5rUzp+gSUdXClHGvg5KEglBzKlPsdj3RiS/rSMg/UMOJifWcR+0EBXQNg5+Bqa3 3HbNKr8FjyOYOwvD0W8Rn3bw6jSagQZMPCGJxnkuZDrCH2uYCEU7voF/H3K9UZIW 15aNNJNLxKCwQ4ejIVltKCAjLJXVQeny/YpOk3dR9g3xnj9hQZRhjXqS5KT666FZ dsaVmbnm2x7ZZqufV5sYgG6VACXEs2IIEgWsh9k4L/VtLv9Z0OpZ4kHkRbI8lVtZ Uuj9Oa7Ij3frCAKQ== Received: (qmail 2281982 invoked from network); 15 Aug 2024 14:09:38 +0200 Received: by mail.zeus03.de with ESMTPSA (TLS_AES_256_GCM_SHA384 encrypted, authenticated); 15 Aug 2024 14:09:38 +0200 X-UD-Smtp-Session: l3s3148p1@VCZ9t7cf7tBehhrc From: Wolfram Sang To: linux-renesas-soc@vger.kernel.org Cc: linux-i2c@vger.kernel.org, devicetree-spec@vger.kernel.org, Wolfram Sang Subject: [PATCH dt-schema 1/3] schemas: i2c: reword descriptions for inclusive language Date: Thu, 15 Aug 2024 14:09:33 +0200 Message-ID: <20240815120935.5871-2-wsa+renesas@sang-engineering.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240815120935.5871-1-wsa+renesas@sang-engineering.com> References: <20240815120935.5871-1-wsa+renesas@sang-engineering.com> Precedence: bulk X-Mailing-List: linux-i2c@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Changing bindings is hard, changing descriptions is easy. Let's start with the low-hanging fruits and use the official I2C terminology (as of specs v7) in the descriptions. Drop a superfluous 'a' from the description of 'reg' for targets. Signed-off-by: Wolfram Sang --- dtschema/schemas/i2c/i2c-controller.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/dtschema/schemas/i2c/i2c-controller.yaml b/dtschema/schemas/i2c/i2c-controller.yaml index 9670082..e475ead 100644 --- a/dtschema/schemas/i2c/i2c-controller.yaml +++ b/dtschema/schemas/i2c/i2c-controller.yaml @@ -99,7 +99,7 @@ properties: multi-master: type: boolean description: - States that there is another master active on this bus. The OS can use + States that there is another controller active on this bus. The OS can use this information to adapt power management to keep the arbitration awake all the time, for example. Can not be combined with 'single-master'. @@ -116,9 +116,9 @@ properties: single-master: type: boolean description: - States that there is no other master active on this bus. The OS can use - this information to detect a stalled bus more reliably, for example. Can - not be combined with 'multi-master'. + States that there is no other controller active on this bus. The OS can + use this information to detect a stalled bus more reliably, for example. + Can not be combined with 'multi-master'. smbus: type: boolean @@ -155,7 +155,7 @@ patternProperties: - minimum: 0xc0000000 maximum: 0xc00003ff description: | - One or many I2C slave addresses. These are usually a 7 bit addresses. + One or many I2C target addresses. These are usually 7 bit addresses. However, flags can be attached to an address. I2C_TEN_BIT_ADDRESS is used to mark a 10 bit address. It is needed to avoid the ambiguity between e.g. a 7 bit address of 0x50 and a 10 bit address of 0x050 @@ -172,7 +172,7 @@ patternProperties: interrupts: description: I2C core will treat "irq" interrupt (or the very first interrupt if - not using interrupt names) as primary interrupt for the slave. + not using interrupt names) as primary interrupt for the target. interrupt-names: anyOf: From patchwork Thu Aug 15 12:09:34 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Wolfram Sang X-Patchwork-Id: 819588 Received: from mail.zeus03.de (zeus03.de [194.117.254.33]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id C69D5178CCF for ; Thu, 15 Aug 2024 12:09:40 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=194.117.254.33 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723723785; cv=none; b=gGuhH/4bIscjYRf/bCF35BxsXDgPj23iEx5GLpBW/vr4JYbA4Z9tWajzrjTHxx6u7V5sVx3UnQr1N+YJIgZNqcOI5xabY4HAM0NT+hrTlcG38UWFIt6ag+KOBz1VzIaTAqq6UmRAlPRiBHAVzQCll4JOlWK9hqTOIzMMdtTsJII= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723723785; c=relaxed/simple; bh=44kl0z06S2x/PWPhuzeYSl3qiUMX8i8lLxTDjQoF3JM=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=mzojSlsPVskjc0k7JCueSInARuZqCZVtDshYwsObiW/nYf/jkm9Qvc+aHuoOzEl0y9qL9LYrLGoYKiqsU6KWQAb4QrI7j7PxC0CNWgL/QynOYLQ693yYLJYwQRqE+bQPGzb87oNszrFecIuwLiSMLcfxuiBRUcWAikdRqZe6P/Y= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com; spf=pass smtp.mailfrom=sang-engineering.com; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b=bVteA/AI; arc=none smtp.client-ip=194.117.254.33 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b="bVteA/AI" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= sang-engineering.com; h=from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; s=k1; bh=/fKIt7Q9Jn3u+qQ0WbuTYmgz3YNwoS3GoG32xXp/zMM=; b=bVteA/ AI8g6hocgM7E2Muya8lZD6hH5wuh5z329k9SbLMxVAOAdCJ67BJXbr+BlfmdvWRW ub0ntK1YfXyUUUNQOkVw5iwK3zqZByRFJPBMRqchQkhj7+M+JrCWbMAsu8rm4H7C QTV4E5k4vcpB3RRYV9t93m/y0+LlM494JkzMKZ/qFa0yWVH9LQOc3cWkTDSmi92J de2c9hsWKv4RrHHm9PJVx4tvFFQzuEN99M8lzP7RQfCf3fiQtODTd3u7Q/83a9WU o010SCBkpJnWrnSfmudXBoh4JGZpABz5m5g0ERYPKBEsS23H5D89thv5rCifesRj XbDBM0RDOAIpNsNg== Received: (qmail 2282006 invoked from network); 15 Aug 2024 14:09:38 +0200 Received: by mail.zeus03.de with ESMTPSA (TLS_AES_256_GCM_SHA384 encrypted, authenticated); 15 Aug 2024 14:09:38 +0200 X-UD-Smtp-Session: l3s3148p1@KouFt7cf+NBehhrc From: Wolfram Sang To: linux-renesas-soc@vger.kernel.org Cc: linux-i2c@vger.kernel.org, devicetree-spec@vger.kernel.org, Wolfram Sang Subject: [PATCH dt-schema 2/3] schemas: i2c: clean up interrupt descriptions for I2C targets Date: Thu, 15 Aug 2024 14:09:34 +0200 Message-ID: <20240815120935.5871-3-wsa+renesas@sang-engineering.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240815120935.5871-1-wsa+renesas@sang-engineering.com> References: <20240815120935.5871-1-wsa+renesas@sang-engineering.com> Precedence: bulk X-Mailing-List: linux-i2c@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Schemas should be OS agnostic, so don't mention what the "I2C core" will do because this only applies to Linux. Also, drop the generic "smbus_alert" naming because this belongs to controllers not targets, so we don't want to describe it here. Signed-off-by: Wolfram Sang --- dtschema/schemas/i2c/i2c-controller.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/dtschema/schemas/i2c/i2c-controller.yaml b/dtschema/schemas/i2c/i2c-controller.yaml index e475ead..7eb6b0f 100644 --- a/dtschema/schemas/i2c/i2c-controller.yaml +++ b/dtschema/schemas/i2c/i2c-controller.yaml @@ -171,8 +171,8 @@ patternProperties: interrupts: description: - I2C core will treat "irq" interrupt (or the very first interrupt if - not using interrupt names) as primary interrupt for the target. + If not using interrupt-names, the first interrupt will be treated as + the primary interrupt for the target. interrupt-names: anyOf: @@ -181,10 +181,10 @@ patternProperties: enum: - irq - wakeup - - smbus_alert description: - Names which are recognized by I2C core, other names are left to - individual bindings. + Generic names are "irq" for the primary interrupt and "wakeup" + for the wakeup interrupt. Other names are left to individual + bindings. wakeup-source: description: From patchwork Thu Aug 15 12:09:35 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Wolfram Sang X-Patchwork-Id: 819840 Received: from mail.zeus03.de (zeus03.de [194.117.254.33]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 1538317A598 for ; Thu, 15 Aug 2024 12:09:41 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=194.117.254.33 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723723785; cv=none; b=NmsWf7N5Dt3ZF2C8vqrzEKsZirGoPinItRmwO5B/d3n6+Do5w5y65tYKKlerFcNq0G4p5h87jnh+JU5RPzTFgyFgjfBZnQ/f18rG1moPwWNwYY949Niz3TYHoczj9U5xPRRiy3qYR9gi3ffjJcZKf/xvp208dwolJDJRinPPX4o= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1723723785; c=relaxed/simple; bh=NfNdMYWEA9SnNDDzCeI08I7NGAbQp29CyqUII+RCRPc=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=ceuANdyT6CDUCYslpfKUxQD5s0+l7J4Wr74fjCeksHQ0dzV2bRqfLMCjDyT595laUsqlOoDANpZWSJ++F6A4yYmGJnn0yyf/q+A5KfAN/ve1xtcnKr8svOG+GDUa9t/miCPCmQTwuRQSVtfuG4FtAF+P+/3l5/dSauKO+3uuYfM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com; spf=pass smtp.mailfrom=sang-engineering.com; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b=PQLC0Dzy; arc=none smtp.client-ip=194.117.254.33 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=sang-engineering.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=sang-engineering.com header.i=@sang-engineering.com header.b="PQLC0Dzy" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= sang-engineering.com; h=from:to:cc:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding; s=k1; bh=09w6kDaqu00DkGye5dLu0ngPbArU6KUpsKaCt+tBKbc=; b=PQLC0D zym0zfnqm3Iridmo+bBbOli2GppghRjLbs9pGZQyAeRKhkEUr19Yz31WSLU5XVqQ lv9cL2kVY0HAVCInHf7D5prM+1mjCluW8xJWMoDRel3Jp0wYQzyb+UuuRXbi/K2I hD/iDiuELdB24twxE+RE6WHgDgeChU3oGNUSOhvhpymOfKk/t9up/cDpEZJFgDti 16gy2t6O6H1REL39eAP6AdEG12Wu8RG4IxuRBS7CTXIAGwGbqN+5Oewb1UieaZKo DopjqEqKqBBGDVm5ZY9fQsXoACw8Gk8sWMETIlHN0amYVroA+VA/ku6Z3sxiyxUB fdeJ4Fo44EJka+tQ== Received: (qmail 2282032 invoked from network); 15 Aug 2024 14:09:39 +0200 Received: by mail.zeus03.de with ESMTPSA (TLS_AES_256_GCM_SHA384 encrypted, authenticated); 15 Aug 2024 14:09:39 +0200 X-UD-Smtp-Session: l3s3148p1@uyKNt7cf+tBehhrc From: Wolfram Sang To: linux-renesas-soc@vger.kernel.org Cc: linux-i2c@vger.kernel.org, devicetree-spec@vger.kernel.org, Wolfram Sang Subject: [PATCH dt-schema 3/3] schemas: i2c: add generic interrupt name for I2C controllers Date: Thu, 15 Aug 2024 14:09:35 +0200 Message-ID: <20240815120935.5871-4-wsa+renesas@sang-engineering.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240815120935.5871-1-wsa+renesas@sang-engineering.com> References: <20240815120935.5871-1-wsa+renesas@sang-engineering.com> Precedence: bulk X-Mailing-List: linux-i2c@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 "smbus_alert" is a generic interrupt name for controllers, so document it. Introduce also "irq" for the primary interrupt. Signed-off-by: Wolfram Sang --- dtschema/schemas/i2c/i2c-controller.yaml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/dtschema/schemas/i2c/i2c-controller.yaml b/dtschema/schemas/i2c/i2c-controller.yaml index 7eb6b0f..da277a2 100644 --- a/dtschema/schemas/i2c/i2c-controller.yaml +++ b/dtschema/schemas/i2c/i2c-controller.yaml @@ -90,6 +90,22 @@ properties: low-pass analog filter). Typical value should be above the normal i2c bus clock frequency (clock-frequency). Specified in Hz. + interrupts: + description: + If not using interrupt-names, the first interrupt will be treated as the + primary interrupt for the controller. + + interrupt-names: + anyOf: + - {} # Any name is allowed. + - items: + enum: + - irq + - smbus_alert + description: + Generic names are "irq" for a primary interrupt and "smbus_alert" for + the SMBusAlert signal. Other names are left to individual bindings. + mctp-controller: type: boolean description: