pinctrl: tegra: xusb: Add note about legacy status

Add a comment about why the call to of_match_node() cannot be replaced
by of_device_get_match_data(). This will hopefully prevent people from
attempting to clean this up in the future.

Signed-off-by: Thierry Reding <treding@nvidia.com>
Link: https://lore.kernel.org/r/20190923095400.GA11084@ulmo
Signed-off-by: Linus Walleij <linus.walleij@linaro.org>

diff --git a/drivers/pinctrl/tegra/pinctrl-tegra-xusb.c b/drivers/pinctrl/tegra/pinctrl-tegra-xusb.c
index 95002e3ecaffc5061b8cf991e0bde713a0fae641..f2fa1f76ebb7e6442d48942bde9bd488f04ae992 100644 (file)
--- a/drivers/pinctrl/tegra/pinctrl-tegra-xusb.c
+++ b/drivers/pinctrl/tegra/pinctrl-tegra-xusb.c
@@ -885,6 +885,12 @@ int tegra_xusb_padctl_legacy_probe(struct platform_device *pdev)
        mutex_init(&padctl->lock);
        padctl->dev = &pdev->dev;
 
+       /*
+        * Note that we can't replace this by of_device_get_match_data()
+        * because we need the separate matching table for this legacy code on
+        * Tegra124. of_device_get_match_data() would attempt to use the table
+        * from the updated driver and fail.
+        */
        match = of_match_node(tegra_xusb_padctl_of_match, pdev->dev.of_node);
        padctl->soc = match->data;