Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.33 as permitted sender) client-ip=23.128.96.33;
From:   Javier Carrasco <javier.carrasco@wolfvision.net>
Date:   Wed, 25 Oct 2023 18:21:55 +0200
Subject: [PATCH 2/2] dt-bindings: rtc: nxp,pcf8563: add hiz-output property
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
Message-Id: <20231024-topic-pcf85363_hiz_output-v1-2-50908aff0e52@wolfvision.net>
References: <20231024-topic-pcf85363_hiz_output-v1-0-50908aff0e52@wolfvision.net>
In-Reply-To: <20231024-topic-pcf85363_hiz_output-v1-0-50908aff0e52@wolfvision.net>
To:     Alessandro Zummo <a.zummo@towertech.it>,
        Alexandre Belloni <alexandre.belloni@bootlin.com>,
        Rob Herring <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Conor Dooley <conor+dt@kernel.org>
Cc:     linux-rtc@vger.kernel.org, linux-kernel@vger.kernel.org,
        devicetree@vger.kernel.org,
        Javier Carrasco <javier.carrasco@wolfvision.net>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?TTFMMG92WWNCMUFCK2Q3cUFHQmZ3blhCL2l3ekFzV2x4S3g4UXNwcllCZWt5?=
 =?utf-8?B?aXV1YUdJZ1IwQVFJUTh3S2ZvUGhVL1hjVERpVnIxNEtXL25WU3R3MDdrbnNu?=
 =?utf-8?B?ZEJ2R2ZmdFowdGx1MzhJK21zWkh5L3E4ZkprN3JBZ0JmRng0NTBkd290YkI2?=
 =?utf-8?B?ZWE5TUNsL1VBQTJySnp6eStYV1F2djZuUDhkUlR6elBnaDg5eDdYSzN4RUhw?=
 =?utf-8?B?UER4UmNIUXVSWVE1YTJRMGdTbG0zU3BKNk95UmVEZG5MS2FRcWNWanc3Q3M0?=
 =?utf-8?B?RUdrU2pYWkxBdzZLVlZCdkZUalVNcTVKcDdPRzJ0YVkzV0NPNm5RME0yM0JQ?=
 =?utf-8?B?RWNPNndiLzl2eEpqa0pYUGZDU2RPa3ZveXdZbnI3SkYxaERteDQzalRiZGtY?=
 =?utf-8?B?TEJyWVQ2VE5CYWI3NndJL2Fjbm9ndy9rZUlzMlBPWGcvY213M2NiL1RzM3hz?=
 =?utf-8?B?VjY3WFNPODZUd2FTRllEOG1zQkQvMThueW9ycHBOVUpvN2ZOa3pHTmtsYlZQ?=
 =?utf-8?B?eXFKbFRPemp3S1RrOWY2OTg5NDhxVExWTHFqeUJqSmtlM1JvdE5BdnY4ZzZZ?=
 =?utf-8?B?NzJsUi8vbXlhZnVTcHJld3lGRU05RjVoTFhuOWVzRFhyTnhKb25sb2NkcmZ0?=
 =?utf-8?B?ZjdVZ2FlcmFkS0xqblRDV3ZRdlNzTmY5MXBoaGc3OGdmRWg0bEh3SVpnTGN3?=
 =?utf-8?B?SnRQdGxrbEJJZHdOY0J5VWFWajFJY1JmVHcxWk9IZUlGZ3ptNitpREdJZ0Ry?=
 =?utf-8?B?YmhsR0pkSytITnlUY1pvcjdKVk1VQ1VEbVpzdTRNUjhQK3pVWXVnQnBhcXIy?=
 =?utf-8?B?R3lSa2hScUxMbDZ1NmlzVUM1V2xMektJMGg0MnNZV0Z3dUo5RFVMY0Q3NEto?=
 =?utf-8?B?UGNObCtmVTVCSnVTV2hkSkdqQXhxSWdUSnk0QTRqNnBmTUtDTGtyaE56cVdF?=
 =?utf-8?B?TmkzMVpXamd4U2dXenhFK1ZNS3FQN1dwaXF4RWNpd0FtclZmSGxUWTdJMmJV?=
 =?utf-8?B?TlZwbnlVV0FIcWVmWlkza3Nnd1hwS3l5N0hIbWdGdzdTalJMdStFeW1kSVZ2?=
 =?utf-8?B?Q0UyYzRkc1hWc2g4SWRvQ0RjdXhrRnlxR2hBM05tRlJDU2g4NXBqSmt2cWhv?=
 =?utf-8?B?dDdQVGwyRWVYcHNNTXU5bWZJdjRpZjdRWkxnT3c4eFlMeS9FeHJQSmJMb3N6?=
 =?utf-8?B?TWpNWWJDaGN5RWFobGtuNFk5N0Rpc2dYaFJzRmIzQk1LVTg0VCsvenB0S0VS?=
 =?utf-8?B?ODJuY1lSTXpJUnVPWlk5eWlheGo2Z1pyRUVPemFKTFRHREdJd2taSFhHK1BC?=
 =?utf-8?B?T1hNL1A1Tzhzd1dEdVYxNVc0T3R4ODFrS2ZjdXc2QWd2dmlMd0xGRE1wNnlI?=
 =?utf-8?B?d3hMcVlkbXFBVjJKdWtBaysxRTRSOGJoajkwNEVaZ3lLK1BJVHg4TCtPWWdS?=
 =?utf-8?B?enRUSS9LVVRIMlZqZlYrRkR4VDV3UmJVQUptdmRIV2ZMOG5EeHY1cTIwZEZJ?=
 =?utf-8?B?ZktuU0t0QkNwUXRIT3hnTkVuQnB1bllnbFZsWjVSSXRPakMxUEtkMHBwVGhB?=
 =?utf-8?B?MnM3WVUxTTZHNFpxM096d092ZUNVZzJRcVAxejUxMlROM1J0Sk9JRERNazZt?=
 =?utf-8?B?RDgvZU9qbVpFcXF6cTFma1RVRFV4NEFuMUw5TzYyTTlJeUpZQkEwOGhxVTFj?=
 =?utf-8?B?TWFBcHdCcnFXTDhoUndhUTNhdTlMeHhQVVFPUU9lQzlpbHVqT01CYmhydFVp?=
 =?utf-8?B?MkRQOE1nYnVadG1NdnZsb1F0NSs0R1VGenZsdTFZWDVCcGU1Z3ovQjJla0Mx?=
 =?utf-8?B?SUVKcENPc1lxNW93dS92VnNUOTJFQ2xKa1F2NWMrMTNWR0VJN2RSVk1vVXB5?=
 =?utf-8?B?eGhvTkw4MVgxUTh5SExtZTBESFlCeis1L0VDb3hsSnJxK01pc2RBQ3ArRWp1?=
 =?utf-8?B?c0d1VUg5S2l3VG1KMUoxUnNxQTQ2cUhXWUFTMm5XS3J1OU03R1kyVU5CTTNV?=
 =?utf-8?B?VFRVNHg0OTZzWVhXandIbjJnZktCc2ZjNFozalE2V1J3NWNUdGRmb3NtMVFH?=
 =?utf-8?B?djVwcXRQVXFxWWt3MUpMdFMzWGQ4bzhLaVhQTTlkMVFTRmtjVHJYK0VwUHNO?=
 =?utf-8?B?VWtsMHJoWWt4QzBJVXMyNlRVdXp1V1U0TnNpNVFTc3ptU0lpRFl4Ny8rcHpv?=
 =?utf-8?Q?BVTtQGVr1EKWXWh5PSL6Rmc=3D?=
X-OriginatorOrg: wolfvision.net
X-MS-Exchange-CrossTenant-Network-Message-Id: f41c3f1c-5771-467c-37f9-08dbd576838a
X-MS-Exchange-CrossTenant-AuthSource: VE1PR08MB4974.eurprd08.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 25 Oct 2023 16:21:59.4176
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: e94ec9da-9183-471e-83b3-51baa8eb804f
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: lGXW0xwlcr4hqXWSZn/ltlwsaQeKidBO8R1wrQqvYGb/AeP5chhYB53OarEisTb+02AZO0Od9oz3yMZuAOmjz5WjAzC9CAQkJswSI2dVsV0=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR08MB5376
X-Spam-Status: No, score=-0.8 required=5.0 tests=DKIM_SIGNED,DKIM_VALID,
	DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,
	SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no
	version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lipwig.vger.email
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (lipwig.vger.email [0.0.0.0]); Wed, 25 Oct 2023 09:22:26 -0700 (PDT)

The "hiz-output" property models the RTC output as a high-impedance
(hi-Z) output.

This property is optional and if it is not defined, the output will
either act as an output clock (default mode) or as an interrupt
depending on the configuration set by other properties.

Two modes are defined in case the high-impedance is used: "enabled" and
"sleep". The former disables the RTC output completely while the latter
keeps the RTC output disabled until the system enters in sleep mode.
This option is especially relevant if the output clock is used to feed a
PMU, a PMIC or any other device required to run when the rest of the
system is down. For the sake of completeness, a "disabled" mode has been
added, which acts as if the property was not defined.

Document "hiz-output" as a non-required property.

Signed-off-by: Javier Carrasco <javier.carrasco@wolfvision.net>
---
 Documentation/devicetree/bindings/rtc/nxp,pcf85363.yaml | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/Documentation/devicetree/bindings/rtc/nxp,pcf85363.yaml b/Documentation/devicetree/bindings/rtc/nxp,pcf85363.yaml
index 52aa3e2091e9..4b27a9154191 100644
--- a/Documentation/devicetree/bindings/rtc/nxp,pcf85363.yaml
+++ b/Documentation/devicetree/bindings/rtc/nxp,pcf85363.yaml
@@ -36,6 +36,19 @@ properties:
     enum: [6000, 7000, 12500]
     default: 7000
 
+  hiz-output:
+    description:
+      Use enabled if the output should stay in high-impedance. This
+      mode will mask the output as an interrupt source.
+      Use sleep if the otuput should be only active in sleep mode.
+      This mode is compatible with any other output configuration.
+      The disabled value acts as if the property was not defined.
+    enum:
+      - enabled
+      - sleep
+      - disabled
+    default: disabled
+
   start-year: true
   wakeup-source: true
 
@@ -56,5 +69,6 @@ examples:
             reg = <0x51>;
             #clock-cells = <0>;
             quartz-load-femtofarads = <12500>;
+            hiz-output = "sleep";
         };
     };

-- 
2.39.2