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>,
        Linus Walleij <linus.walleij@linaro.org>,
        Cristian Marussi <cristian.marussi@arm.com>,
        Peng Fan <peng.fan@oss.nxp.com>,
        Michal Simek <michal.simek@amd.com>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        "linux-arm-kernel@lists.infradead.org" 
        <linux-arm-kernel@lists.infradead.org>,
        "linux-gpio@vger.kernel.org" <linux-gpio@vger.kernel.org>
Subject: [RFC v2 0/2] Introducing generic SCMI pinctrl driver implementation
Thread-Topic: [RFC v2 0/2] Introducing generic SCMI pinctrl driver
 implementation
Thread-Index: AQHZeEK6Mgluo0v6EE2yyMI0Mpfhqw==
Date:   Wed, 26 Apr 2023 13:26:36 +0000
Message-ID: <cover.1682513390.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?dXKIcihAWk8VihgL+2QW7AJjVVQpVzopYytZivGoQpckmjtAs+6zL8LwWA?=
 =?iso-8859-1?Q?44DpwUEp/DSd8wJvdWtUXB3GeGiPtX+f8erH5pXKtp8ItfULCmJoAURt6r?=
 =?iso-8859-1?Q?J7RXSmwdBB8mor3nN/vdrRJ4IHpXV7eEVohbQYxJ/rQTu3KwysZzaobBuS?=
 =?iso-8859-1?Q?PCjetB/UpbtylTXj0I3IcHS92jPayP0lL/G7Pqj4IZsTOfrrN2oiqlkFtS?=
 =?iso-8859-1?Q?qaMSh/SYnpFA26Bc/yyWSANVs9dgywQe7XIKSQ17QaAhxPYeFbFeNFbg+X?=
 =?iso-8859-1?Q?rKEr3BegVc9TrMxVi0oTZqmhyn/yWDuiCQvt/PRs3lqwJh2hdmYFno10DP?=
 =?iso-8859-1?Q?VWLczFXN6/dkuQQHwMSp/5TekdAZ8Kss8KgBLSeFdm/nbgWjvFnJHYGmaU?=
 =?iso-8859-1?Q?6al10vuQwZpeDIhc96P6ddNtJ5lxoV/XCDottSv4cD68Qf4l5jafvv0nPZ?=
 =?iso-8859-1?Q?ApFnt7pMhUVHcAeW+QL9orkgWAP+G+UIVVqaH6E6fBcxlgoThlDdiVkeWp?=
 =?iso-8859-1?Q?NSzQ8uU+1qQ0ykK9s4omGyxyC08kGv+nW+Knh3VwD3Bw49TUKrgPnbl+Gi?=
 =?iso-8859-1?Q?DLVbVWRLJl8KPv9fePp9O6TGlTTXaIVvCng3RLKAtm2c5ICjvQsYYEgnwv?=
 =?iso-8859-1?Q?IfZVEKuNMUMVzmFIciZbAxFb2RZ9wzMt/4LFFu8b1JlkJ/5JLEklmPXU9b?=
 =?iso-8859-1?Q?0pZ7OZJalzLTRi+D6PqzFdIoBG8nc5/Hvupp8Qh5+mk6O9mtgxVvpVbPO1?=
 =?iso-8859-1?Q?TgjlVjYEpfMLAXdBvgNgsHYSK9beVx8q5nVfVrbfwgxyCSX0YzIXdHXLwr?=
 =?iso-8859-1?Q?rNB04WGs5DyFsAczJ8rAlB3QZfUVZzxolb2oT76D9CU+HFyWGs1+0DmLP9?=
 =?iso-8859-1?Q?HLX4W8proFXb8hGTfm1mdpg1K0KSxyMYA9J89gQfL3hmH7BN8gLgRDoQZn?=
 =?iso-8859-1?Q?Zzt6ln+kioIGOKoaRsMkxDkBy1wJuFqSQGI8lXwq1H+6EaE68l8tlkTEj5?=
 =?iso-8859-1?Q?fsgU8OEyaGtcnVcBS1YgzYgmvXR0jLg3rms4pv7iGgbiEHfAY4O5HTt/Ty?=
 =?iso-8859-1?Q?74lcv+nMPoXwGtkDj+QB5W+LhDsE/yDOCLznPww1kO/oSkDQB3IncEIPKI?=
 =?iso-8859-1?Q?2YKKYJsHP6yzkIc39SKVB2KIdzvMTMGGVnLK4hNROl0Crg3f1VFs95+GJN?=
 =?iso-8859-1?Q?mKg0+Y+Wyhvf60Lfs2slS+fDjNH+JwIiON3+q9LaVk+SXH390+wJzOtWYN?=
 =?iso-8859-1?Q?2qEtoZ+3Ju8AAX6KnSbJ6mFLkbO6cdb0unfkDaN/3dVHG5eo1l7cYRJrlE?=
 =?iso-8859-1?Q?VHn5vMMclXPD4/Jje4zRONUlRRc5gH2w7ShVsJCPicP77Prgsv1HHocxnP?=
 =?iso-8859-1?Q?gYgWLCvXqNZGIhe2ryYaAKddbiQgHXdffPOOJKDBPWGG6+Ao9M8oKB32W+?=
 =?iso-8859-1?Q?orcb99o6m6pzuYDmZBIR8RUDDuIMaa6xXK9zpmYHXg4uXH04t+KOBUP2SZ?=
 =?iso-8859-1?Q?HEFTkCfETWiMdnXvSbzciRbQXSfBnRV8OCQVryh+hr+lfSjX6g/iJoeAvY?=
 =?iso-8859-1?Q?bTS5DD0ke5fkkh23g6z+it23MiCoHMVtSrfgRWhZJfJO7R5C4QxdTgA9O2?=
 =?iso-8859-1?Q?OxkXdQxRpShYEyAUaQ+X4qBAv+BYkiNtSfUvdYj7QtCpdRc2raukBHuA?=
 =?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: d741b8b8-23b8-4d96-4671-08db4659dc9a
X-MS-Exchange-CrossTenant-originalarrivaltime: 26 Apr 2023 13:26:37.0065
 (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: 5ofZFrmwZZn4drFhAx9U1X38cO4lR0bpnaoVR9DBRkNQs817/QYSKwOK6l0g6xl9SAZR7UWARx3shSfW/w/BT2veBUVOz/OPbd+IZpWqXU0=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: GV2PR03MB9380
X-Proofpoint-ORIG-GUID: 4p8VgBreDDj7wPdinifTG7mMe2WKJuC_
X-Proofpoint-GUID: 4p8VgBreDDj7wPdinifTG7mMe2WKJuC_
X-Proofpoint-Virus-Version: vendor=baseguard
 engine=ICAP:2.0.254,Aquarius:18.0.942,Hydra:6.0.573,FMLib:17.11.170.22
 definitions=2023-04-26_06,2023-04-26_03,2023-02-09_01
X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 impostorscore=0
 lowpriorityscore=0 clxscore=1015 phishscore=0 adultscore=0 malwarescore=0
 mlxscore=0 spamscore=0 bulkscore=0 priorityscore=1501 suspectscore=0
 mlxlogscore=999 classifier=spam adjust=0 reason=mlx scancount=1
 engine=8.12.0-2303200000 definitions=main-2304260119
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,T_SCC_BODY_TEXT_LINE,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 RFC patch series is intended to introduce the potential 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.

This implementation still reqires some features, such as gpio support, but =
I've posted it as RFC to
start the discussion regarding the driver format.

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

---
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

---
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           |  77 ++
 MAINTAINERS                                   |   7 +
 drivers/firmware/arm_scmi/Makefile            |   3 +-
 drivers/firmware/arm_scmi/driver.c            |   2 +
 drivers/firmware/arm_scmi/pinctrl.c           | 932 ++++++++++++++++++
 drivers/firmware/arm_scmi/protocols.h         |   1 +
 drivers/pinctrl/Kconfig                       |   9 +
 drivers/pinctrl/Makefile                      |   1 +
 drivers/pinctrl/pinctrl-scmi.c                | 578 +++++++++++
 include/linux/scmi_protocol.h                 |  47 +
 10 files changed, 1656 insertions(+), 1 deletion(-)
 create mode 100644 drivers/firmware/arm_scmi/pinctrl.c
 create mode 100644 drivers/pinctrl/pinctrl-scmi.c

--=20
2.25.1