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;
From:   Oleksii Moisieiev <Oleksii_Moisieiev@epam.com>
To:     "sudeep.holla@arm.com" <sudeep.holla@arm.com>
CC:     Oleksii Moisieiev <Oleksii_Moisieiev@epam.com>,
        Cristian Marussi <cristian.marussi@arm.com>,
        Rob Herring <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Conor Dooley <conor+dt@kernel.org>,
        Linus Walleij <linus.walleij@linaro.org>,
        "linux-arm-kernel@lists.infradead.org" 
        <linux-arm-kernel@lists.infradead.org>,
        "devicetree@vger.kernel.org" <devicetree@vger.kernel.org>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        "linux-gpio@vger.kernel.org" <linux-gpio@vger.kernel.org>
Subject: [PATCH v4 0/4] firmware: arm_scmi: Add SCMI v3.2 pincontrol protocol
 basic support
Thread-Topic: [PATCH v4 0/4] firmware: arm_scmi: Add SCMI v3.2 pincontrol
 protocol basic support
Thread-Index: AQHZyiW4JT1gPXk7akOBuyCkkIz0Cw==
Date:   Tue, 8 Aug 2023 18:25:34 +0000
Message-ID: <cover.1691518313.git.oleksii_moisieiev@epam.com>
Accept-Language: en-US
Content-Language: en-US
x-ms-exchange-antispam-messagedata-chunkcount: 1
x-ms-exchange-antispam-messagedata-0: =?iso-8859-1?Q?tjwQmSLAX5NNgZVRbaTNov1SEOusjDmpF4FvZxN8DrID0V3bvaO6Bqwptf?=
 =?iso-8859-1?Q?72Zan2v+VQcPY0xvXcP0acVPiJU/2EKlZnsmR5U9cerOUXoqP1JGEqyZ5C?=
 =?iso-8859-1?Q?DAr7iS9poNJAiJYofevIqwtYX45/osioxg1tIS6PCwtlWgn7K1y2Wadhnw?=
 =?iso-8859-1?Q?MX+E7d/aLny4n/qGqnXrPmPGNgHBbarTx6ySTfad606aRfH0FraevZj57k?=
 =?iso-8859-1?Q?7vxzB/1IkQAQ5l5VfK68DdMkJ+gIoH9wMksjH2xnAqMIXqVn1roZ5pPY5w?=
 =?iso-8859-1?Q?7XX5zpKuQFClQsex/3OKDzgqfaAJUEJG3Qd3OJYOkAjP2rHINYRpNLdk2B?=
 =?iso-8859-1?Q?hq1Jd6M5IBgy4pvLjRm1IEtoeL97sUo30LJL8sTo6/23X9SS/ZS29FipjB?=
 =?iso-8859-1?Q?NnqKZNKLZB7zTAHzZrWCYYHZNxZV4kz31ed18JKCCPdRr6u39f1p6iBExB?=
 =?iso-8859-1?Q?mMOuJ/t5rDIEqygTwz32Pk+48KsA+PazxVnSA1ElGZFL0gEQt74RqzUWbf?=
 =?iso-8859-1?Q?tgJ9ya73flxFK6sJGUKpon3SS9RWxyqNYXTEY1XcFl9OjHnl0n/Z1Jx3VC?=
 =?iso-8859-1?Q?OtmPemul/NpxD9/CsFGontKkulbAqZdqi8XQk1xUXYJOzNudbcAuEQ3LiN?=
 =?iso-8859-1?Q?18PcM0IIQpz94bUqw+p+eCPFbolAO+0hEeSBSzo2ez106t99QJoYrmTOhh?=
 =?iso-8859-1?Q?6WZT3fkR8ULaYSGIk055iKPws9nRwaWbpo4HhCnXbn/eN/JgJvWhBsHinz?=
 =?iso-8859-1?Q?pyx5JC24/gL+dOdzaf4ohBFAWSzsJPB0WXjqJb8KvEHyxte28Q+dt6sBcA?=
 =?iso-8859-1?Q?Zndm7zl6L9E/YqPvUyAa1y0kwDyVR3a5sU8sLeFQMjnWPqQyCVHcCBxa4/?=
 =?iso-8859-1?Q?2F/E4PPabYknMEKM46tdt/RjVqpMriPEMei08/FHB0NtkhZA+Q7jgjWyUD?=
 =?iso-8859-1?Q?YGOmsTE870bYrxcQ6UJWDtnmTl58uP+dXxGFmzNYgUm6GbsnbbE4z+JQ39?=
 =?iso-8859-1?Q?KHwKzjDUrhOGPuK0xcvqAR9wmntdYjnFeVAVW540qlMziSwcELPMVC4faU?=
 =?iso-8859-1?Q?tj1KWPI7DoyGfv4C/4P+Djf0dE/EIbIUBw57IDpKdkl2mh+wmWEBfYw2bs?=
 =?iso-8859-1?Q?vWjev7tDPOGSFgWR3k2ViasZEKA+oRnpRsxQgmVf/KA7NPNopvlhgnibkt?=
 =?iso-8859-1?Q?nMMqYHpU55o3+VDzLYpSr65MGABk5VDfyGzFGwYR2Gmjr6PnAzCuN1RhzN?=
 =?iso-8859-1?Q?vD7/1Ltlbs/pdD0hNrjzydthzJ8qU9K4FyKma3okisTEMHDM/s+ZR2M6r2?=
 =?iso-8859-1?Q?Q4nj/v/hsa1CVYZ5P9Bj0F0yeVCik2P9NtD5+lfiIQqXG0bpmvqdASw+BB?=
 =?iso-8859-1?Q?ETHrjl91uefB5nQEaPeq2OADaHuqBpbr6G23w7uxZa3uzYlYzwC/V0+YHl?=
 =?iso-8859-1?Q?XDcnxjcjRg1gMgOOAYOk/iTbd9SOfJu2YoxNOSy/jkJ9fUrSfMkAe/SlF3?=
 =?iso-8859-1?Q?62uEc3i4cQvYrM9uu12pBwm4sy2ygu3AY5feDyyjHUrV/lL1BTFltVu5mx?=
 =?iso-8859-1?Q?z1Rm9D0dsBRrI/mM/6Jaj+cVX4Nom2m6T+rYthh1A77VYjPSCGqv6pUcDc?=
 =?iso-8859-1?Q?XzL3BOItGhxhZx+oAE3wQ4q3mJHc2cuATHzLBUOPXFq7+HLBVbDYy5jA?=
 =?iso-8859-1?Q?=3D=3D?=
Content-Type: text/plain; charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-OriginatorOrg: epam.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-AuthSource: PA4PR03MB7136.eurprd03.prod.outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: b0d9789d-62c9-4fdd-68a2-08db983cdb48
X-MS-Exchange-CrossTenant-originalarrivaltime: 08 Aug 2023 18:25:34.7146
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: b41b72d0-4e9f-4c26-8a69-f949f367c91d
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: Z2EumVU+SVekyF40Hwd2+yEN0pn3gGgdAjqm/ptg0opiffJiYSQlaIUX4RmcJf4GYDTz5pq9gKfNqUIU8CMNlCgZPrjzkS1a/pWqOkZw1L0=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: AS4PR03MB8458
X-Proofpoint-ORIG-GUID: O1GjMCwLO89JzjOUSJ9itAbBLffveSyM
X-Proofpoint-GUID: O1GjMCwLO89JzjOUSJ9itAbBLffveSyM
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.267,Aquarius:18.0.957,Hydra:6.0.591,FMLib:17.11.176.26
 definitions=2023-08-08_15,2023-08-08_01,2023-05-22_02
X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 bulkscore=0
 lowpriorityscore=0 phishscore=0 mlxlogscore=999 impostorscore=0 mlxscore=0
 malwarescore=0 suspectscore=0 clxscore=1015 priorityscore=1501
 adultscore=0 spamscore=0 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2306200000 definitions=main-2308080163
X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_LOW,SPF_HELO_NONE,
        SPF_NONE,URIBL_BLOCKED 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

This Patch series is intended to introduce the generic driver for
pin controls over SCMI protocol, provided in the latest beta version of DEN=
0056 [0].

On ARM-based systems, a separate Cortex-M based System Control Processor (S=
CP)
provides control on pins, as well as with power, clocks, reset controllers.=
 In this case,
kernel should use one of the possible transports, described in [0] to acces=
s SCP and
control clocks/power-domains etc. This driver is using SMC transport to com=
municate with SCP via
SCMI protocol and access to the Pin Control Subsystem.

The provided driver consists of 2 parts:
 - firmware/arm_scmi/pinctrl.c - the SCMI pinctrl protocol inmplementation
   responsible for the communication with SCP firmware.

 - drivers/pinctrl/pinctrl-scmi.c - pinctrl driver, which is using pinctrl
  protocol implementation to access all necessary data.

Configuration:
The scmi-pinctrl driver can be configured using DT bindings.
For example:
/ {
	cpu_scp_shm: scp-shmem@0x53FF0000 {
		compatible =3D "arm,scmi-shmem";
		reg =3D <0x0 0x53FF0000 0x0 0x1000>;
	};

	firmware {
		scmi {
			compatible =3D "arm,scmi-smc";
			arm,smc-id =3D <0x82000002>;
			shmem =3D <&cpu_scp_shm>;
			#address-cells =3D <1>;
			#size-cells =3D <0>;

			scmi_pinctrl: protocol@19 {
				reg =3D <0x18>;
				#pinctrl-cells =3D <0>;

				i2c2_pins: i2c2 {
					groups =3D "i2c2_a";
					function =3D "i2c2";
				};
			};
		};
	};
};

&pfc {
	/delete-node/i2c2;
};

So basically, it's enough to move pfc subnode, which configures pin group t=
hat should work through
SCMI protocol to scmi_pinctrl node. The current driver implementation is us=
ing generic pinctrl dt_node
format.

I've tested this driver on the Renesas H3ULCB Kingfisher board with pinctrl=
 driver ported to the
Arm-trusted-firmware. Unfortunately, not all hardware was possible to test =
because the Renesas
pinctrl driver has gaps in pins and groups numeration, when Spec [0] requir=
es pins, groups and
functions numerations to be 0..n without gaps.

Also, sharing link to the ATF pinctrl driver I used for testing:
https://github.com/oleksiimoisieiev/arm-trusted-firmware/tree/pinctrl_rcar_=
m3_up

[0] https://developer.arm.com/documentation/den0056/latest

---
Changes v3 -> v4:
   - Fixed MAINTAINERS file description
   - adjusted pinctrl ops position and callback names
   - add trailing coma in scmi_protocol list
   - removed unneeded pi checks
   - corrected selector check
   - resource allocation refactoring
   - scmi_*_info swap params to generate better code
   - style, add trailing coma in definitions
   - reworked protocol@19 format in device-tree bindings
   - ordered config option and object file alphabetically
   - rephrased PINCTRL_SCMI config description
   - formatting fixes, removed blank lines after get_drvdata call
   - code style adjustments
   - add set_drvdata call
   - removed goto label
   - refactoring of the devm resource management
   - removed pctldev !=3D NULL check
   - fix parameter name in pinconf-group-get
   - probe function refactoring
   - removed unneeded pmx checks

Changes v2 -> v3:
   - update get_name calls as suggested by Cristian Marussi
   - fixing comments
   - refactoring of the dt_bindings according to the comments
Changes v1 -> v2:
   - rebase patches to the latest kernel version
   - use protocol helpers in the pinctrl scmi protocol driver implementatio=
n
   - reworked pinctrl_ops. Removed similar calls to simplify the interface
   - implementation of the .instance_deinit callback to properly clean reso=
urces
   - add description of the pinctrl protocol to the device-tree schema

---
Cristian Marussi (1):
  firmware: arm_scmi: Add optional flags to extended names helper

Oleksii Moisieiev (3):
  firmware: arm_scmi: Add SCMI v3.2 pincontrol protocol basic support
  pinctrl: Implementation of the generic scmi-pinctrl driver
  dt-bindings: firmware: arm,scmi: Add support for pinctrl protocol

 .../bindings/firmware/arm,scmi.yaml           |  53 ++
 MAINTAINERS                                   |   7 +
 drivers/firmware/arm_scmi/Makefile            |   2 +-
 drivers/firmware/arm_scmi/clock.c             |   2 +-
 drivers/firmware/arm_scmi/driver.c            |   9 +-
 drivers/firmware/arm_scmi/perf.c              |   3 +-
 drivers/firmware/arm_scmi/pinctrl.c           | 791 ++++++++++++++++++
 drivers/firmware/arm_scmi/power.c             |   2 +-
 drivers/firmware/arm_scmi/powercap.c          |   2 +-
 drivers/firmware/arm_scmi/protocols.h         |   4 +-
 drivers/firmware/arm_scmi/reset.c             |   3 +-
 drivers/firmware/arm_scmi/sensors.c           |   2 +-
 drivers/firmware/arm_scmi/voltage.c           |   2 +-
 drivers/pinctrl/Kconfig                       |  11 +
 drivers/pinctrl/Makefile                      |   1 +
 drivers/pinctrl/pinctrl-scmi.c                | 442 ++++++++++
 include/linux/scmi_protocol.h                 |  42 +
 17 files changed, 1367 insertions(+), 11 deletions(-)
 create mode 100644 drivers/firmware/arm_scmi/pinctrl.c
 create mode 100644 drivers/pinctrl/pinctrl-scmi.c

--=20
2.25.1