ahci: Introduce ahci_ignore_port() helper
authorDamien Le Moal <dlemoal@kernel.org>
Mon, 6 Jan 2025 05:14:47 +0000 (14:14 +0900)
committerDamien Le Moal <dlemoal@kernel.org>
Thu, 9 Jan 2025 08:52:17 +0000 (17:52 +0900)
libahci and AHCI drivers may ignore some ports if the port is invalid
(its ID does not correspond to a valid physical port) or if the user
explicitly requested the port to be ignored with the mask_port_map
ahci module parameter. Such port that shall be ignored can be identified
by checking that the bit corresponding to the port ID is not set in the
mask_port_map field of struct ahci_host_priv. E.g. code such as:
"if (!(hpriv->mask_port_map & (1 << portid)))".

Replace all direct use of the mask_port_map field to detect such port
with the new helper inline function ahci_ignore_port() to make the code
more readable/easier to understand.

The comment describing the mask_port_map field of struct ahci_host_priv
is also updated to be more accurate.

Signed-off-by: Damien Le Moal <dlemoal@kernel.org>
Reviewed-by: Niklas Cassel <cassel@kernel.org>
drivers/ata/ahci.h
drivers/ata/ahci_brcm.c
drivers/ata/ahci_ceva.c
drivers/ata/libahci_platform.c

index 8f40f75ba08cff4deca261b1162ee9a0fb91fed6..aea30df50c58166a1b7c0aba392a0a50027d82e0 100644 (file)
@@ -328,7 +328,7 @@ struct ahci_port_priv {
 struct ahci_host_priv {
        /* Input fields */
        unsigned int            flags;          /* AHCI_HFLAG_* */
-       u32                     mask_port_map;  /* mask out particular bits */
+       u32                     mask_port_map;  /* Mask of valid ports */
 
        void __iomem *          mmio;           /* bus-independent mem map */
        u32                     cap;            /* cap to use */
@@ -379,6 +379,17 @@ struct ahci_host_priv {
                                                  int port);
 };
 
+/*
+ * Return true if a port should be ignored because it is excluded from
+ * the host port map.
+ */
+static inline bool ahci_ignore_port(struct ahci_host_priv *hpriv,
+                                   unsigned int portid)
+{
+       return portid >= hpriv->nports ||
+               !(hpriv->mask_port_map & (1 << portid));
+}
+
 extern int ahci_ignore_sss;
 
 extern const struct attribute_group *ahci_shost_groups[];
index 24c471b485ab8b43eca21909ea16cb47a2a95ee1..29be74fedcf01934e436481c66cb8d329284d599 100644 (file)
@@ -288,7 +288,7 @@ static unsigned int brcm_ahci_read_id(struct ata_device *dev,
 
        /* Re-initialize and calibrate the PHY */
        for (i = 0; i < hpriv->nports; i++) {
-               if (!(hpriv->mask_port_map & (1 << i)))
+               if (ahci_ignore_port(hpriv, i))
                        continue;
 
                rc = phy_init(hpriv->phys[i]);
index f2e20ed11ec70f48cb5f2c12812996bb99872aa5..2d6a08c23d6ad5d1d11a7de7fbe2968201d6095a 100644 (file)
@@ -206,7 +206,7 @@ static int ceva_ahci_platform_enable_resources(struct ahci_host_priv *hpriv)
                goto disable_clks;
 
        for (i = 0; i < hpriv->nports; i++) {
-               if (!(hpriv->mask_port_map & (1 << i)))
+               if (ahci_ignore_port(hpriv, i))
                        continue;
 
                rc = phy_init(hpriv->phys[i]);
@@ -218,7 +218,7 @@ static int ceva_ahci_platform_enable_resources(struct ahci_host_priv *hpriv)
        ahci_platform_deassert_rsts(hpriv);
 
        for (i = 0; i < hpriv->nports; i++) {
-               if (!(hpriv->mask_port_map & (1 << i)))
+               if (ahci_ignore_port(hpriv, i))
                        continue;
 
                rc = phy_power_on(hpriv->phys[i]);
index b68777841f7a544b755a16a633b1a2a47b90da08..53b2c7719dc51f864a1579f88f6a97b312f4d955 100644 (file)
@@ -49,7 +49,7 @@ int ahci_platform_enable_phys(struct ahci_host_priv *hpriv)
        int rc, i;
 
        for (i = 0; i < hpriv->nports; i++) {
-               if (!(hpriv->mask_port_map & (1 << i)))
+               if (ahci_ignore_port(hpriv, i))
                        continue;
 
                rc = phy_init(hpriv->phys[i]);
@@ -73,7 +73,7 @@ int ahci_platform_enable_phys(struct ahci_host_priv *hpriv)
 
 disable_phys:
        while (--i >= 0) {
-               if (!(hpriv->mask_port_map & (1 << i)))
+               if (ahci_ignore_port(hpriv, i))
                        continue;
 
                phy_power_off(hpriv->phys[i]);
@@ -94,7 +94,7 @@ void ahci_platform_disable_phys(struct ahci_host_priv *hpriv)
        int i;
 
        for (i = 0; i < hpriv->nports; i++) {
-               if (!(hpriv->mask_port_map & (1 << i)))
+               if (ahci_ignore_port(hpriv, i))
                        continue;
 
                phy_power_off(hpriv->phys[i]);