Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/2219564/?format=api
{ "id": 2219564, "url": "http://patchwork.ozlabs.org/api/patches/2219564/?format=api", "web_url": "http://patchwork.ozlabs.org/project/linux-gpio/patch/20260403-doc-gpio-swnodes-v2-1-c705f5897b80@oss.qualcomm.com/", "project": { "id": 42, "url": "http://patchwork.ozlabs.org/api/projects/42/?format=api", "name": "Linux GPIO development", "link_name": "linux-gpio", "list_id": "linux-gpio.vger.kernel.org", "list_email": "linux-gpio@vger.kernel.org", "web_url": "", "scm_url": "", "webscm_url": "", "list_archive_url": "", "list_archive_url_format": "", "commit_url_format": "" }, "msgid": "<20260403-doc-gpio-swnodes-v2-1-c705f5897b80@oss.qualcomm.com>", "list_archive_url": null, "date": "2026-04-03T13:04:55", "name": "[v2] Documentation: gpio: update the preferred method for using software node lookup", "commit_ref": null, "pull_url": null, "state": "new", "archived": false, "hash": "73d466005fad9f5ce97df52d57e1fd77383b7bca", "submitter": { "id": 92196, "url": "http://patchwork.ozlabs.org/api/people/92196/?format=api", "name": "Bartosz Golaszewski", "email": "bartosz.golaszewski@oss.qualcomm.com" }, "delegate": null, "mbox": "http://patchwork.ozlabs.org/project/linux-gpio/patch/20260403-doc-gpio-swnodes-v2-1-c705f5897b80@oss.qualcomm.com/mbox/", "series": [ { "id": 498626, "url": "http://patchwork.ozlabs.org/api/series/498626/?format=api", "web_url": "http://patchwork.ozlabs.org/project/linux-gpio/list/?series=498626", "date": "2026-04-03T13:04:55", "name": "[v2] Documentation: gpio: update the preferred method for using software node lookup", "version": 2, "mbox": "http://patchwork.ozlabs.org/series/498626/mbox/" } ], "comments": "http://patchwork.ozlabs.org/api/patches/2219564/comments/", "check": "pending", "checks": "http://patchwork.ozlabs.org/api/patches/2219564/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "\n <linux-gpio+bounces-34639-incoming=patchwork.ozlabs.org@vger.kernel.org>", "X-Original-To": [ "incoming@patchwork.ozlabs.org", "linux-gpio@vger.kernel.org" ], "Delivered-To": "patchwork-incoming@legolas.ozlabs.org", "Authentication-Results": [ "legolas.ozlabs.org;\n\tdkim=pass (2048-bit key;\n unprotected) header.d=qualcomm.com header.i=@qualcomm.com header.a=rsa-sha256\n header.s=qcppdkim1 header.b=O5ke51P+;\n\tdkim=pass (2048-bit key;\n unprotected) header.d=oss.qualcomm.com header.i=@oss.qualcomm.com\n header.a=rsa-sha256 header.s=google header.b=fadhgIFl;\n\tdkim-atps=neutral", "legolas.ozlabs.org;\n spf=pass (sender SPF authorized) smtp.mailfrom=vger.kernel.org\n (client-ip=2600:3c0a:e001:db::12fc:5321; helo=sea.lore.kernel.org;\n envelope-from=linux-gpio+bounces-34639-incoming=patchwork.ozlabs.org@vger.kernel.org;\n receiver=patchwork.ozlabs.org)", "smtp.subspace.kernel.org;\n\tdkim=pass (2048-bit key) header.d=qualcomm.com header.i=@qualcomm.com\n header.b=\"O5ke51P+\";\n\tdkim=pass (2048-bit key) header.d=oss.qualcomm.com header.i=@oss.qualcomm.com\n header.b=\"fadhgIFl\"", "smtp.subspace.kernel.org;\n arc=none smtp.client-ip=205.220.168.131", "smtp.subspace.kernel.org;\n dmarc=pass (p=reject dis=none) header.from=oss.qualcomm.com", "smtp.subspace.kernel.org;\n spf=pass smtp.mailfrom=oss.qualcomm.com" ], "Received": [ "from sea.lore.kernel.org (sea.lore.kernel.org\n [IPv6:2600:3c0a:e001:db::12fc:5321])\n\t(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n\t key-exchange x25519 server-signature ECDSA (secp384r1) server-digest SHA384)\n\t(No client certificate requested)\n\tby legolas.ozlabs.org (Postfix) with ESMTPS id 4fnJtn1gvNz1yCs\n\tfor <incoming@patchwork.ozlabs.org>; Sat, 04 Apr 2026 00:08:16 +1100 (AEDT)", "from smtp.subspace.kernel.org (conduit.subspace.kernel.org\n [100.90.174.1])\n\tby sea.lore.kernel.org (Postfix) with ESMTP id 6031530238E6\n\tfor <incoming@patchwork.ozlabs.org>; Fri, 3 Apr 2026 13:05:17 +0000 (UTC)", "from localhost.localdomain (localhost.localdomain [127.0.0.1])\n\tby smtp.subspace.kernel.org (Postfix) with ESMTP id 66E483A9632;\n\tFri, 3 Apr 2026 13:05:15 +0000 (UTC)", "from mx0a-0031df01.pphosted.com (mx0a-0031df01.pphosted.com\n [205.220.168.131])\n\t(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))\n\t(No client certificate requested)\n\tby smtp.subspace.kernel.org (Postfix) with ESMTPS id EE62137C93C\n\tfor <linux-gpio@vger.kernel.org>; Fri, 3 Apr 2026 13:05:11 +0000 (UTC)", "from pps.filterd (m0279865.ppops.net [127.0.0.1])\n\tby mx0a-0031df01.pphosted.com (8.18.1.11/8.18.1.11) with ESMTP id\n 633BqAmm3780374\n\tfor <linux-gpio@vger.kernel.org>; Fri, 3 Apr 2026 13:05:11 GMT", "from mail-ua1-f69.google.com (mail-ua1-f69.google.com\n [209.85.222.69])\n\tby mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 4da663hfcu-1\n\t(version=TLSv1.3 cipher=TLS_AES_128_GCM_SHA256 bits=128 verify=NOT)\n\tfor <linux-gpio@vger.kernel.org>; Fri, 03 Apr 2026 13:05:10 +0000 (GMT)", "by mail-ua1-f69.google.com with SMTP id\n a1e0cc1a2514c-948b41f95deso3262182241.0\n for <linux-gpio@vger.kernel.org>;\n Fri, 03 Apr 2026 06:05:10 -0700 (PDT)", "from brgl-qcom.local ([2a01:cb1d:dc:7e00:129d:59e8:f7c9:47ca])\n by smtp.gmail.com with ESMTPSA id\n 5b1f17b1804b1-48899e491afsm18712055e9.17.2026.04.03.06.05.07\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Fri, 03 Apr 2026 06:05:08 -0700 (PDT)" ], "ARC-Seal": "i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116;\n\tt=1775221514; cv=none;\n b=Qw/PRwun0lCrZ4+71FCf2HLdXeRffmywakMHuBEJsqDA6SDTLmtcFY7uRJV8F0hMazMNp7perE0kJYcMzFhSY825YONQVOxRZ+OB2rMOEs81184vV+yCVbPN3QK09VLnkXbQmT062GXQfo8rnEMtWInrJ7KdXnttyjmIhzB6NgU=", "ARC-Message-Signature": "i=1; a=rsa-sha256; d=subspace.kernel.org;\n\ts=arc-20240116; t=1775221514; c=relaxed/simple;\n\tbh=UI0xjgQJRvAoa59/OcrNBMSxM4PXDer91jntNEu7BgE=;\n\th=From:Date:Subject:MIME-Version:Content-Type:Message-Id:To:Cc;\n b=HaTp7pbeLFthZn95RVUvpW4fJxOHlnjwodX3/PRnjxNGQw59cI42kwNA96+Zk1ihKYrL8u4z61REG63JK0iatiQ2WoYnkgHk7G9jbWRmuQjqoS1foXN4gAP1zxjN290QHTzJgaKzZNiZp8zaFSi1yEafXQZige2f1nVRY5NSr6k=", "ARC-Authentication-Results": "i=1; smtp.subspace.kernel.org;\n dmarc=pass (p=reject dis=none) header.from=oss.qualcomm.com;\n spf=pass smtp.mailfrom=oss.qualcomm.com;\n dkim=pass (2048-bit key) header.d=qualcomm.com header.i=@qualcomm.com\n header.b=O5ke51P+;\n dkim=pass (2048-bit key) header.d=oss.qualcomm.com header.i=@oss.qualcomm.com\n header.b=fadhgIFl; arc=none smtp.client-ip=205.220.168.131", "DKIM-Signature": [ "v=1; a=rsa-sha256; c=relaxed/relaxed; d=qualcomm.com; h=\n\tcc:content-transfer-encoding:content-type:date:from:message-id\n\t:mime-version:subject:to; s=qcppdkim1; bh=hzbNjz7s83d1n/RewTAsaz\n\tiotGeaKoaGJzKT+pCY3f4=; b=O5ke51P+/Zwt8BcUFQQ/YqyKoQC1cgPsQ+CQtp\n\td0iRvRDz15mKBrwVNczVrfUlFuja2DTWptkUgS5M0Ksr/5qeDNSv5ZY0muRjAgLx\n\tfMF8E1DwOgn52N0vQWxurbvMdahRLk18O/PfVYBj+AwPvfsP8yA0ONwUhqU1eeWR\n\tPXEYg7efSP9DUbk3c2N1c4rnNuBXXqEcT3qMgUtZojeVT5Svdna6fL/dv2cxH3Sn\n\ts8qfv2KM4+HAqucoVaIP9tgxEp3mqwAVcpxcS0Nam83GOMZG7uRE1cbL8+r4ha6u\n\tXiaVVljxpX9jXz+8RH07+5jEzEPAnNYDg3SPKU3JgPQg2Fag==", "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=oss.qualcomm.com; s=google; t=1775221510; x=1775826310;\n darn=vger.kernel.org;\n h=cc:to:message-id:content-transfer-encoding:mime-version:subject\n :date:from:from:to:cc:subject:date:message-id:reply-to;\n bh=hzbNjz7s83d1n/RewTAsaziotGeaKoaGJzKT+pCY3f4=;\n b=fadhgIFllBk3OYVJ2/grB1Bg0z66R7MNrvjgXoAXRw54zH5gA3q9wl34gH9CdXaeZQ\n Ks92oPkGkRel3Q2leIYSLKvIibWbxFJK7MW6hsz9MKtkp1p3wtOVkQz2KVO68xcjLb/r\n 84PwmiHO54NUlLQ6PpJp1fPsYdJqBaIAFNrTTGsVKbXR0vE+t4fSpioWAm1FJSqn72gi\n g612P2UOYrBkDajnyyjGTfnI951PC73ZVkb7pf/xaTz/eMF4d1chULIFfYx6XSHmCOw/\n Y0EsTLOHnaimdzl/IvdmsiLRzungQB7HbzF1X+4qFU56jC4/67LxXoUUwhHdngmq1s0N\n 6rvg==" ], "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20251104; t=1775221510; x=1775826310;\n h=cc:to:message-id:content-transfer-encoding:mime-version:subject\n :date:from:x-gm-gg:x-gm-message-state:from:to:cc:subject:date\n :message-id:reply-to;\n bh=hzbNjz7s83d1n/RewTAsaziotGeaKoaGJzKT+pCY3f4=;\n b=cJVDQVHvAhBQjjYzfIhEXh+xnysS3aEy64njoP49RsrKw1IP6jXJByjyCvLqHdO5AC\n grLCNrsLE/4PlkR0wmxKlObDrBF6RfUtEJ7Cq43w7jmY0kSQjCJAo+3nHrBliUK6fH8F\n B1kGXgFihaD0zdu8k7vcHT7pF+Cd5uqP/IVCE+qpCm+XBODMxef5JDpgBBxmRgAuKhOx\n a7SXJxTs4/kRcinT9yTKm4TIm/gVPE8nUU1I9EJg7LJEbp5RUH6R4aWrePgNwVuLiYRi\n xIxNTTpQEhhzTI4Rh18C0d4KHflv6pM1nOGyYYQWwlNhGPpWQkdsWQP8lBgTAY6LeH9H\n 4/LQ==", "X-Gm-Message-State": "AOJu0Yw5o7M8lgmU48BENKbCVli9lmJiwia11KCywvOQ7LJeHaZq7mmh\n\tlzXZjz9sIFZ5N1OcuwLpdutxp5w37GVpSPbSYVIG8ZTMPaxjz1Q7G/YhY5Gu9VbHUW6R3AY/BUS\n\tCRdD+q8EJqAWSM+sdxfJ9cfPMg8bFugENi+xhEN7AUAJIMRo5HlsDQInjfD0CMO/Z", "X-Gm-Gg": "AeBDieseqe+zhNX5i/Hfa2OsWoTCSHglsTqKzbbme+cTTWKifkfo85aU8QAVrIBBTD4\n\t+bnTrvYTla+5F4MdPOcT4dV3uKq2uzlXyJ7haAX3LeCEOvzZMPXgbXIqXM4mz2NtcY3gqEQD6ST\n\tuho0VNEs7B/KXmUjPIbQt0ftCih5Ny5wBW2P5guupCQCcthn/VenlG6oIvM3++qsCxJ+9c9QhvH\n\tv29jiKrin6gxG61zpeZ8H2rK7+uXFFB62Eg9qw4AVsbaC4gCkhSqkN7K/90z8XJbvAi2B7CxmZA\n\t5+X0OI98tCUdc84t7U75D5ifVw/MozzpcWQF6UvpjP7JUFKgF5YruT81Nr9PZVV7eG/iHRuO4yK\n\tswaQ4RQbybayxM6DEZNkHJ43vi/lHEqCrX/fmlGshcURTX4lZU/I=", "X-Received": [ "by 2002:a05:6102:5cc1:b0:602:813c:1b24 with SMTP id\n ada2fe7eead31-605a4d35185mr1252613137.7.1775221509686;\n Fri, 03 Apr 2026 06:05:09 -0700 (PDT)", "by 2002:a05:6102:5cc1:b0:602:813c:1b24 with SMTP id\n ada2fe7eead31-605a4d35185mr1252551137.7.1775221509125;\n Fri, 03 Apr 2026 06:05:09 -0700 (PDT)" ], "From": "Bartosz Golaszewski <bartosz.golaszewski@oss.qualcomm.com>", "Date": "Fri, 03 Apr 2026 15:04:55 +0200", "Subject": "[PATCH v2] Documentation: gpio: update the preferred method for\n using software node lookup", "Precedence": "bulk", "X-Mailing-List": "linux-gpio@vger.kernel.org", "List-Id": "<linux-gpio.vger.kernel.org>", "List-Subscribe": "<mailto:linux-gpio+subscribe@vger.kernel.org>", "List-Unsubscribe": "<mailto:linux-gpio+unsubscribe@vger.kernel.org>", "MIME-Version": "1.0", "Content-Type": "text/plain; charset=\"utf-8\"", "Content-Transfer-Encoding": "7bit", "Message-Id": "<20260403-doc-gpio-swnodes-v2-1-c705f5897b80@oss.qualcomm.com>", "X-B4-Tracking": "v=1; b=H4sIAPa6z2kC/32NTQ6CMBCFr0JmbQltlVBX3sOwgP7AJMJgR1FDe\n ncrB3Dzku8l73sbsI/oGc7FBtGvyEhzBnUowI7dPHiBLjOoStWV1lI4smJYkAS/ZnKeRbDauXA\n yfeMs5NkSfcD3rry2mUfkB8XP/rDKX/tHtkohhQ7N0aq6Mcb0F2Iu78/uZmmayhzQppS+f2QYX\n 7cAAAA=", "X-Change-ID": "20260331-doc-gpio-swnodes-fc3ddf59b8dc", "To": "Linus Walleij <linusw@kernel.org>, Bartosz Golaszewski <brgl@kernel.org>,\n Jonathan Corbet <corbet@lwn.net>,\n Shuah Khan <skhan@linuxfoundation.org>,\n Dmitry Torokhov <dmitry.torokhov@gmail.com>", "Cc": "linux-gpio@vger.kernel.org, linux-doc@vger.kernel.org,\n linux-kernel@vger.kernel.org,\n Bartosz Golaszewski <bartosz.golaszewski@oss.qualcomm.com>", "X-Mailer": "b4 0.14.2", "X-Developer-Signature": "v=1; a=openpgp-sha256; l=7564;\n i=bartosz.golaszewski@oss.qualcomm.com; h=from:subject:message-id;\n bh=UI0xjgQJRvAoa59/OcrNBMSxM4PXDer91jntNEu7BgE=;\n b=owEBbQKS/ZANAwAKAQWdLsv/NoTDAcsmYgBpz7r+0nNvSKseR5LPXVC3YVpQBmBpVV5rZuqgI\n Zo6FkrMuLCJAjMEAAEKAB0WIQSR5RMt5bVGHXuiZfwFnS7L/zaEwwUCac+6/gAKCRAFnS7L/zaE\n w/y3EACaUFBplHvkdlLuWxQQEuRJPLQQJtYokvcsnLcpPAW9rTd83B1N8zvYAy6Ge0Qmjkr+Bkn\n 4qE92WreU3dtJvQCBHpk+B+GgHrqCOdqEQtJzh6imbwSnQOkvNGlWmtpmnd5BJOQiXq2dJUdAkK\n ZcSh8mZ7K/iOvt3oBvhZUhDJlvE5P2eNs/OrBw6ktODR18t1L8b7uG/i4Jge/IJxEuaUZ6MJToF\n epYE4iOBRsRi29crVT6BLE7H/4Y8+/WCYFisSgQkiZL8Hjo0KqRdHFc0PZrRSOyyuwWJeyOL3xc\n VQ6N2c06mqN+jFnaZzo/7EEmlbau0szidOjse8wkteszva7hUJSk/wqqh81Es6Zjv3acAc5OJDR\n w9lMG8/S/dIQorMaFk/yU6jnywKgNDN2qLOI1mvupaZZzgUoRbKOAIXfTHdlkSzWsnDVF5JD0vY\n fJPyivTbCc5fLD7b+OnpbnV5FwweOhrN/VVioxDeK5dFDsniYUCk875OWmAgqyg0g++dGiXIaml\n Mfs9b9P8gfbDJXDB8iZXKyfELH2KE5Flbo/5HlUiqQ3Pz/2W06s2xp5N1A8Q1ws5CLTIrZQDFW7\n f7oFVUnnrg+8jS4UwYygSQLyGTv0xqu8s1Tf7tdJ1gy6GeUGNCisOXaCiAV5U1/+iZ9ZB2TEP1B\n iq+7MXtTdvp7UVQ==", "X-Developer-Key": "i=bartosz.golaszewski@oss.qualcomm.com; a=openpgp;\n fpr=169DEB6C0BC3C46013D2C79F11A72EA01471D772", "X-Proofpoint-Spam-Details-Enc": "AW1haW4tMjYwNDAzMDExNiBTYWx0ZWRfX7tS6XwW/9U1n\n t4C4wJCa78lpxTJEXADAsdj4H++d/BskkUeP0Sb09J1now7fUi7HNYIMtaEJB8Sj+JoljLuQlYc\n mRwjiP+8yJbSyq0L6cjBfEu7nkNTvBptyIBtnxAm4L7H0Cy0peArLtY/K4rB215VE54YgLRPuzN\n MFJqLo0czY+rBT3V/zgZv9+tdKO8lItD0j2KzhrweEABTuzgZQ8/HJUHCbcktr2l7SIf9Tiz+EX\n ppgVnj/hbEQgWaPk7UC5cr3P6dnWXfff0mzGZXSgzsHKcKbJfCdxFinlajan8BF+VCwqv9jkoOn\n dcjEXLMzRliVnBm7FukH1xHCUHMqSzFEq0+XNCGc362MKH5gAWj2lSpb5TGoO3aZCvb4WGupAmY\n atqyesN5YkQdoMGAT2G65yc9lhMKU77kEwva8ZGAJ//RnCJTMbyB5bOkVjlB7zj99O3qZIIZDJy\n 4n00ac5ATC8QVvk1Brg==", "X-Proofpoint-GUID": "VHTPDoepR43IkJ02-6-9-tjkTsq79hvl", "X-Proofpoint-ORIG-GUID": "VHTPDoepR43IkJ02-6-9-tjkTsq79hvl", "X-Authority-Analysis": "v=2.4 cv=Acu83nXG c=1 sm=1 tr=0 ts=69cfbb06 cx=c_pps\n a=UbhLPJ621ZpgOD2l3yZY1w==:117 a=VHV1bxSRZQlKidfD:21 a=xqWC_Br6kY4A:10\n a=IkcTkHD0fZMA:10 a=A5OVakUREuEA:10 a=s4-Qcg_JpJYA:10\n a=VkNPw1HP01LnGYTKEx00:22 a=u7WPNUs3qKkmUXheDGA7:22 a=Um2Pa8k9VHT-vaBCBUpS:22\n a=bC-a23v3AAAA:8 a=EUspDBNiAAAA:8 a=jsnql4ADa7X_hVeABskA:9 a=QEXdDO2ut3YA:10\n a=TOPH6uDL9cOC6tEoww4z:22 a=FO4_E8m0qiDe52t0p3_H:22", "X-Proofpoint-Virus-Version": "vendor=baseguard\n engine=ICAP:2.0.293,Aquarius:18.0.1143,Hydra:6.1.51,FMLib:17.12.100.49\n definitions=2026-04-03_04,2026-04-03_01,2025-10-01_01", "X-Proofpoint-Spam-Details": "rule=outbound_notspam policy=outbound score=0\n spamscore=0 suspectscore=0 adultscore=0 clxscore=1015 priorityscore=1501\n phishscore=0 impostorscore=0 bulkscore=0 lowpriorityscore=0 malwarescore=0\n classifier=typeunknown authscore=0 authtc= authcc= route=outbound adjust=0\n reason=mlx scancount=1 engine=8.22.0-2603050001 definitions=main-2604030116" }, "content": "In its current version, the manual for converting of board files from\nusing GPIO lookup tables to software nodes recommends leaving the\nsoftware nodes representing GPIO controllers as \"free-floating\", not\nattached objects and relying on the matching of their names against the\nGPIO controller's name. This is an abuse of the software node API and\nmakes it impossible to create fw_devlinks between GPIO suppliers and\nconsumers in this case. We want to remove this behavior from GPIOLIB and\nto this end, work on converting all existing drivers to using \"attached\"\nsoftware nodes.\n\nExcept for a few corner-cases where board files define consumers\ndepending on GPIO controllers described in firmware - where we need to\nreference a real firmware node from a software node - which requires a\nmore complex approach, most board files can easily be converted to using\npropert firmware node lookup.\n\nUpdate the documentation to recommend attaching the GPIO chip's software\nnodes to the actual platform devices and show how to do it.\n\nSigned-off-by: Bartosz Golaszewski <bartosz.golaszewski@oss.qualcomm.com>\n---\nChanges in v2:\n- Use the new .swnode field of struct platform_device_info in examples\n- Fix whitespaces\n- Link to v1: https://patch.msgid.link/20260331-doc-gpio-swnodes-v1-1-3f84c268999b@oss.qualcomm.com\n---\n Documentation/driver-api/gpio/board.rst | 20 +++++++++++---\n Documentation/driver-api/gpio/legacy-boards.rst | 36 ++++++++++++++++++-------\n 2 files changed, 44 insertions(+), 12 deletions(-)\n\n\n---\nbase-commit: cc13002a9f984d37906e9476f3e532a8cdd126f5\nchange-id: 20260331-doc-gpio-swnodes-fc3ddf59b8dc\n\nBest regards,", "diff": "diff --git a/Documentation/driver-api/gpio/board.rst b/Documentation/driver-api/gpio/board.rst\nindex 0993cac891fb5e4887a1aee6deae273197c6aae1..b306c21481d7c191201d81d228a290a908cc82ab 100644\n--- a/Documentation/driver-api/gpio/board.rst\n+++ b/Documentation/driver-api/gpio/board.rst\n@@ -108,9 +108,8 @@ macro, which ties a software node representing the GPIO controller with\n consumer device. It allows consumers to use regular gpiolib APIs, such as\n gpiod_get(), gpiod_get_optional().\n \n-The software node representing a GPIO controller need not be attached to the\n-GPIO controller device. The only requirement is that the node must be\n-registered and its name must match the GPIO controller's label.\n+The software node representing a GPIO controller must be attached to the\n+GPIO controller device - either as the primary or the secondary firmware node.\n \n For example, here is how to describe a single GPIO-connected LED. This is an\n alternative to using platform_data on legacy systems.\n@@ -153,6 +152,21 @@ alternative to using platform_data on legacy systems.\n \t};\n \tsoftware_node_register_node_group(swnodes);\n \n+\t/*\n+\t * 5. Attach the GPIO controller's software node to the device and\n+\t * register it.\n+\t */\n+\t static void gpio_foo_register(void)\n+\t {\n+\t\tstruct platform_device_info pdev_info = {\n+\t\t\t.name = \"gpio-foo\",\n+\t\t\t.id = PLATFORM_DEVID_NONE,\n+\t\t\t.swnode = &gpio_controller_node\n+\t\t};\n+\n+\t\tplatform_device_register_full(&pdev_info);\n+\t }\n+\n \t// Then register a platform_device for \"leds-gpio\" and associate\n \t// it with &led_device_swnode via .fwnode.\n \ndiff --git a/Documentation/driver-api/gpio/legacy-boards.rst b/Documentation/driver-api/gpio/legacy-boards.rst\nindex 46e3a26dba772e5e5117866b5d202e76c8e2adf2..a9d33bcbb176b5df99838bd03e43ec2ebf4d9db6 100644\n--- a/Documentation/driver-api/gpio/legacy-boards.rst\n+++ b/Documentation/driver-api/gpio/legacy-boards.rst\n@@ -36,12 +36,10 @@ Requirements for GPIO Properties\n When using software nodes to describe GPIO connections, the following\n requirements must be met for the GPIO core to correctly resolve the reference:\n \n-1. **The GPIO controller's software node \"name\" must match the controller's\n- \"label\".** The gpiolib core uses this name to find the corresponding\n- struct gpio_chip at runtime.\n- This software node has to be registered, but need not be attached to the\n- device representing the GPIO controller that is providing the GPIO in\n- question. It may be left as a \"free floating\" node.\n+1. **The GPIO controller's software node must be registered and attached to\n+ the controller's ``struct device`` either as its primary or secondary\n+ firmware node.** The gpiolib core uses the address of the firmware node to\n+ find the corresponding ``struct gpio_chip`` at runtime.\n \n 2. **The GPIO property must be a reference.** The ``PROPERTY_ENTRY_GPIO()``\n macro handles this as it is an alias for ``PROPERTY_ENTRY_REF()``.\n@@ -121,13 +119,21 @@ A typical legacy board file might look like this:\n /* Device registration */\n static int __init myboard_init(void)\n {\n+ \tstruct platform_device_info pdev_info = {\n+ \t\t.name = MYBOARD_GPIO_CONTROLLER,\n+ \t\t.id = PLATFORM_DEVID_NONE,\n+ \t\t.swnode = &gpio_controller_node\n+ \t};\n+\n \tgpiod_add_lookup_table(&myboard_leds_gpios);\n \tgpiod_add_lookup_table(&myboard_buttons_gpios);\n \n+ \tplatform_device_register_full(&pdev_info);\n \tplatform_device_register_data(NULL, \"leds-gpio\", -1,\n \t\t\t\t &myboard_leds_pdata, sizeof(myboard_leds_pdata));\n \tplatform_device_register_data(NULL, \"gpio-keys\", -1,\n- \t\t\t\t &myboard_buttons_pdata, sizeof(myboard_buttons_pdata));\n+ \t\t\t\t &myboard_buttons_pdata,\n+ \t\t\t\t sizeof(myboard_buttons_pdata));\n \n \treturn 0;\n }\n@@ -141,8 +147,7 @@ Step 1: Define the GPIO Controller Node\n ***************************************\n \n First, define a software node that represents the GPIO controller that the\n-LEDs and buttons are connected to. The ``name`` of this node must match the\n-name of the driver for the GPIO controller (e.g., \"gpio-foo\").\n+LEDs and buttons are connected to. The ``name`` of this node is optional.\n \n .. code-block:: c\n \n@@ -257,6 +262,16 @@ software nodes using the ``fwnode`` field in struct platform_device_info.\n \tif (error)\n \t\treturn error;\n \n+ \tmemset(&pdev_info, 0, sizeof(pdev_info));\n+ \tpdev_info.name = MYBOARD_GPIO_CONTROLLER;\n+ \tpdev_info.id = PLATFORM_DEVID_NONE;\n+ \tpdev_info.swnode = &myboard_gpio_controller_node;\n+ \tgpio_pdev = platform_device_register_full(&pdev_info);\n+ \tif (IS_ERR(gpio_pdev)) {\n+ \t\terror = PTR_ERR(gpio_pdev);\n+ \t\tgoto err_unregister_nodes;\n+ \t}\n+\n \tmemset(&pdev_info, 0, sizeof(pdev_info));\n \tpdev_info.name = \"leds-gpio\";\n \tpdev_info.id = PLATFORM_DEVID_NONE;\n@@ -264,6 +279,7 @@ software nodes using the ``fwnode`` field in struct platform_device_info.\n \tleds_pdev = platform_device_register_full(&pdev_info);\n \tif (IS_ERR(leds_pdev)) {\n \t\terror = PTR_ERR(leds_pdev);\n+ \t\tplatform_device_unregister(gpio_pdev);\n \t\tgoto err_unregister_nodes;\n \t}\n \n@@ -274,6 +290,7 @@ software nodes using the ``fwnode`` field in struct platform_device_info.\n \tkeys_pdev = platform_device_register_full(&pdev_info);\n \tif (IS_ERR(keys_pdev)) {\n \t\terror = PTR_ERR(keys_pdev);\n+ \t\tplatform_device_unregister(gpio_pdev);\n \t\tplatform_device_unregister(leds_pdev);\n \t\tgoto err_unregister_nodes;\n \t}\n@@ -289,6 +306,7 @@ software nodes using the ``fwnode`` field in struct platform_device_info.\n {\n \tplatform_device_unregister(keys_pdev);\n \tplatform_device_unregister(leds_pdev);\n+ \tplatform_device_unregister(gpio_pdev);\n \tsoftware_node_unregister_node_group(myboard_swnodes);\n }\n \n", "prefixes": [ "v2" ] }