pnp: Register implementations of enter/exit config state

Find all the (ramstage) implementations of enter()/exit() functions
for the configuration state, register and call them through the new
struct pnp_mode_ops. As our standard PnP functions are aware of the
pnp_mode_ops, it's not necessary to call enter()/exit() around them
anymore.

Patch generated with the cocci below. It's not perfect. The movement
of the enter()/exit() calls is somehow fragile. So I checked the
remaining calls for sense, and changed some empty lines. Also a
duplicate insertion of pnp_conf_mode_ops had to be removed.
    /* Try to find enter and exit functions by their outb() structure and
       their usage around calls to our standard pnp functions: */
    @ enter_match @
    identifier enter;
    identifier dev;
    type device_t;
    @@
     void enter(device_t dev)
     {
             <...
             outb(..., dev->path.pnp.port);
             ...>
     }

    @ exit_match @
    identifier exit;
    identifier dev;
    type device_t;
    @@
     void exit(device_t dev)
     {
             <...
             outb(..., dev->path.pnp.port);
             ...>
     }

    @ pnp_match @
    identifier op;
    identifier pnp_op =~ "^pnp_((alt_|)enable|(set|enable)_resources)$";
    identifier enter_match.enter, exit_match.exit;
    type device_t;
    identifier dev;
    @@
     void op(device_t dev)
     {
             ...
             enter(dev);
             ...
             pnp_op(dev);
             ...
             exit(dev);
             ...
     }

    /* Now add enter/exit to a pnp_mode_ops structure: */
    @ depends on pnp_match @
    identifier enter_match.enter;
    identifier exit_match.exit;
    identifier ops;
    @@
    +static const struct pnp_mode_ops pnp_conf_mode_ops = {
    +        .enter_conf_mode  = enter,
    +        .exit_conf_mode   = exit,
    +};
    +
     struct device_operations ops = {
             ...,
    +        .ops_pnp_mode     = &pnp_conf_mode_ops,
     };

    /* Match against the new structure as we change the code and the above
       matches might not work anymore: */
    @ mode_match @
    identifier enter, exit, ops;
    @@
     struct pnp_mode_ops ops = {
             .enter_conf_mode  = enter,
             .exit_conf_mode   = exit,
     };

    /* Replace enter()/enter() calls with new standard calls (e.g.
       pnp_enter_conf_mode()): */
    @@
    identifier mode_match.enter;
    expression e;
    @@
    -enter(e)
    +pnp_enter_conf_mode(e)

    @@
    identifier mode_match.exit;
    expression e;
    @@
    -exit(e)
    +pnp_exit_conf_mode(e)

    /* If there are calls to standard PnP functions, (re)move the
       enter()/exit() calls around them: */
    @@
    identifier pnp_op =~ "^pnp_((alt_|)enable|(set|enable)_resources)$";
    expression e;
    @@
    -pnp_enter_conf_mode(e);
     pnp_op(e);
    +pnp_enter_conf_mode(e);
     ...
     pnp_exit_conf_mode(e);

    @@
    identifier pnp_op =~ "^pnp_((alt_|)enable|(set|enable)_resources)$";
    expression e;
    @@
     pnp_enter_conf_mode(e);
     ...
    +pnp_exit_conf_mode(e);
     pnp_op(e);
    -pnp_exit_conf_mode(e);

    @@
    expression e;
    @@
    -pnp_enter_conf_mode(e);
    -pnp_exit_conf_mode(e);

Change-Id: I5c04b0c6a8f01a30bc25fe195797c02e75b6c276
Signed-off-by: Nico Huber <nico.h@gmx.de>
Reviewed-on: http://review.coreboot.org/3482
Tested-by: build bot (Jenkins)
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>

9 files changed, 59 insertions, 57 deletions

diff --git a/src/superio/smsc/kbc1100/superio.c b/src/superio/smsc/kbc1100/superio.c
index a8dad5e3ad..21888994a4 100644
--- a/src/superio/smsc/kbc1100/superio.c
+++ b/src/superio/smsc/kbc1100/superio.c
@@ -46,12 +46,18 @@ struct chip_operations superio_smsc_kbc1100_ops = {
   .enable_dev = enable_dev
 };
 
+static const struct pnp_mode_ops pnp_conf_mode_ops = {
+	.enter_conf_mode  = pnp_enter_conf_state,
+	.exit_conf_mode   = pnp_exit_conf_state,
+};
+
 static struct device_operations ops = {
   .read_resources   = pnp_read_resources,
   .set_resources    = kbc1100_pnp_set_resources,
   .enable_resources = kbc1100_pnp_enable_resources,
   .enable           = kbc1100_pnp_enable,
   .init             = kbc1100_init,
+  .ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 static struct pnp_info pnp_dev_info[] = {
@@ -65,23 +71,17 @@ static void enable_dev(device_t dev)
 
 static void kbc1100_pnp_set_resources(device_t dev)
 {
-  pnp_enter_conf_state(dev);
   pnp_set_resources(dev);
-  pnp_exit_conf_state(dev);
 }
 
 static void kbc1100_pnp_enable_resources(device_t dev)
 {
-  pnp_enter_conf_state(dev);
   pnp_enable_resources(dev);
-  pnp_exit_conf_state(dev);
 }
 
 static void kbc1100_pnp_enable(device_t dev)
 {
-  pnp_enter_conf_state(dev);
   pnp_alt_enable(dev);
-  pnp_exit_conf_state(dev);
 }
 
 static void kbc1100_init(device_t dev)
diff --git a/src/superio/smsc/lpc47b272/superio.c b/src/superio/smsc/lpc47b272/superio.c
index 8217769d71..051b339e35 100644
--- a/src/superio/smsc/lpc47b272/superio.c
+++ b/src/superio/smsc/lpc47b272/superio.c
@@ -51,12 +51,18 @@ struct chip_operations superio_smsc_lpc47b272_ops = {
 	.enable_dev = enable_dev
 };
 
+static const struct pnp_mode_ops pnp_conf_mode_ops = {
+	.enter_conf_mode  = pnp_enter_conf_state,
+	.exit_conf_mode   = pnp_exit_conf_state,
+};
+
 static struct device_operations ops = {
 	.read_resources   = pnp_read_resources,
 	.set_resources    = lpc47b272_pnp_set_resources,
 	.enable_resources = lpc47b272_pnp_enable_resources,
 	.enable           = lpc47b272_pnp_enable,
 	.init             = lpc47b272_init,
+	.ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 static struct pnp_info pnp_dev_info[] = {
@@ -88,23 +94,17 @@ static void enable_dev(device_t dev)
  */
 static void lpc47b272_pnp_set_resources(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_set_resources(dev);
-	pnp_exit_conf_state(dev);
 }
 
 static void lpc47b272_pnp_enable_resources(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_enable_resources(dev);
-	pnp_exit_conf_state(dev);
 }
 
 static void lpc47b272_pnp_enable(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_alt_enable(dev);
-	pnp_exit_conf_state(dev);
 }
 
 /**
diff --git a/src/superio/smsc/lpc47b397/superio.c b/src/superio/smsc/lpc47b397/superio.c
index cc78c36e38..e8c62cdc01 100644
--- a/src/superio/smsc/lpc47b397/superio.c
+++ b/src/superio/smsc/lpc47b397/superio.c
@@ -80,17 +80,14 @@ static void lpc47b397_init(device_t dev)
 
 static void lpc47b397_pnp_set_resources(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_set_resources(dev);
-	/* dump_pnp_device(dev); */
-	pnp_exit_conf_state(dev);
 }
 
 static void lpc47b397_pnp_enable_resources(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_enable_resources(dev);
 
+	pnp_enter_conf_mode(dev);
 	switch(dev->path.pnp.device) {
 	case LPC47B397_HWM:
 		printk(BIOS_DEBUG, "LPC47B397 SensorBus register access enabled\n");
@@ -99,22 +96,26 @@ static void lpc47b397_pnp_enable_resources(device_t dev)
 		break;
 	}
 	/* dump_pnp_device(dev); */
-	pnp_exit_conf_state(dev);
+	pnp_exit_conf_mode(dev);
 }
 
 static void lpc47b397_pnp_enable(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_alt_enable(dev);
-	pnp_exit_conf_state(dev);
 }
 
+static const struct pnp_mode_ops pnp_conf_mode_ops = {
+	.enter_conf_mode  = pnp_enter_conf_state,
+	.exit_conf_mode   = pnp_exit_conf_state,
+};
+
 static struct device_operations ops = {
 	.read_resources   = pnp_read_resources,
 	.set_resources    = lpc47b397_pnp_set_resources,
 	.enable_resources = lpc47b397_pnp_enable_resources,
 	.enable           = lpc47b397_pnp_enable,
 	.init             = lpc47b397_init,
+	.ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 #define HWM_INDEX 0
@@ -174,6 +175,7 @@ static struct device_operations ops_hwm = {
 	.init             = lpc47b397_init,
 	.scan_bus         = scan_static_bus,
 	.ops_smbus_bus    = &lops_smbus_bus,
+	.ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 static struct pnp_info pnp_dev_info[] = {
diff --git a/src/superio/smsc/lpc47m10x/superio.c b/src/superio/smsc/lpc47m10x/superio.c
index d133c47512..0b55110190 100644
--- a/src/superio/smsc/lpc47m10x/superio.c
+++ b/src/superio/smsc/lpc47m10x/superio.c
@@ -50,12 +50,18 @@ struct chip_operations superio_smsc_lpc47m10x_ops = {
 	.enable_dev = enable_dev
 };
 
+static const struct pnp_mode_ops pnp_conf_mode_ops = {
+	.enter_conf_mode  = pnp_enter_conf_state,
+	.exit_conf_mode   = pnp_exit_conf_state,
+};
+
 static struct device_operations ops = {
 	.read_resources   = pnp_read_resources,
 	.set_resources    = lpc47m10x_pnp_set_resources,
 	.enable_resources = lpc47m10x_pnp_enable_resources,
 	.enable           = lpc47m10x_pnp_enable,
 	.init             = lpc47m10x_init,
+	.ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 static struct pnp_info pnp_dev_info[] = {
@@ -87,23 +93,17 @@ static void enable_dev(device_t dev)
  */
 static void lpc47m10x_pnp_set_resources(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_set_resources(dev);
-	pnp_exit_conf_state(dev);
 }
 
 static void lpc47m10x_pnp_enable_resources(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_enable_resources(dev);
-	pnp_exit_conf_state(dev);
 }
 
 static void lpc47m10x_pnp_enable(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_alt_enable(dev);
-	pnp_exit_conf_state(dev);
 }
 
 /**
diff --git a/src/superio/smsc/lpc47m15x/superio.c b/src/superio/smsc/lpc47m15x/superio.c
index 253bfdc09e..bcccb7a636 100644
--- a/src/superio/smsc/lpc47m15x/superio.c
+++ b/src/superio/smsc/lpc47m15x/superio.c
@@ -46,12 +46,18 @@ struct chip_operations superio_smsc_lpc47m15x_ops = {
 	.enable_dev = enable_dev
 };
 
+static const struct pnp_mode_ops pnp_conf_mode_ops = {
+	.enter_conf_mode  = pnp_enter_conf_state,
+	.exit_conf_mode   = pnp_exit_conf_state,
+};
+
 static struct device_operations ops = {
 	.read_resources   = pnp_read_resources,
 	.set_resources    = lpc47m15x_pnp_set_resources,
 	.enable_resources = lpc47m15x_pnp_enable_resources,
 	.enable           = lpc47m15x_pnp_enable,
 	.init             = lpc47m15x_init,
+	.ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 static struct pnp_info pnp_dev_info[] = {
@@ -70,23 +76,17 @@ static void enable_dev(device_t dev)
 
 static void lpc47m15x_pnp_set_resources(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_set_resources(dev);
-	pnp_exit_conf_state(dev);
 }
 
 static void lpc47m15x_pnp_enable_resources(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_enable_resources(dev);
-	pnp_exit_conf_state(dev);
 }
 
 static void lpc47m15x_pnp_enable(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_alt_enable(dev);
-	pnp_exit_conf_state(dev);
 }
 
 static void lpc47m15x_init(device_t dev)
diff --git a/src/superio/smsc/mec1308/superio.c b/src/superio/smsc/mec1308/superio.c
index 0fe473ca6b..d08de2fbc9 100644
--- a/src/superio/smsc/mec1308/superio.c
+++ b/src/superio/smsc/mec1308/superio.c
@@ -45,23 +45,17 @@ static void pnp_exit_conf_state(device_t dev)
 
 static void mec1308_pnp_set_resources(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_set_resources(dev);
-	pnp_exit_conf_state(dev);
 }
 
 static void mec1308_pnp_enable_resources(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_enable_resources(dev);
-	pnp_exit_conf_state(dev);
 }
 
 static void mec1308_pnp_enable(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_alt_enable(dev);
-	pnp_exit_conf_state(dev);
 }
 
 static void mec1308_init(device_t dev)
@@ -82,12 +76,18 @@ static void mec1308_init(device_t dev)
 	}
 }
 
+static const struct pnp_mode_ops pnp_conf_mode_ops = {
+	.enter_conf_mode  = pnp_enter_conf_state,
+	.exit_conf_mode   = pnp_exit_conf_state,
+};
+
 static struct device_operations ops = {
 	.read_resources   = pnp_read_resources,
 	.set_resources    = mec1308_pnp_set_resources,
 	.enable_resources = mec1308_pnp_enable_resources,
 	.enable           = mec1308_pnp_enable,
 	.init             = mec1308_init,
+	.ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 static struct pnp_info pnp_dev_info[] = {
diff --git a/src/superio/smsc/sch4037/superio.c b/src/superio/smsc/sch4037/superio.c
index 9a19033e41..c6daa18d9a 100644
--- a/src/superio/smsc/sch4037/superio.c
+++ b/src/superio/smsc/sch4037/superio.c
@@ -46,12 +46,18 @@ struct chip_operations superio_smsc_sch4037_ops = {
 		.enable_dev = enable_dev,
 };
 
+static const struct pnp_mode_ops pnp_conf_mode_ops = {
+	.enter_conf_mode  = pnp_enter_conf_state,
+	.exit_conf_mode   = pnp_exit_conf_state,
+};
+
 static struct device_operations ops = {
 	.read_resources   = pnp_read_resources,
 	.set_resources    = sch4037_pnp_set_resources,
 	.enable_resources = sch4037_pnp_enable_resources,
 	.enable           = sch4037_pnp_enable,
 	.init             = sch4037_init,
+	.ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 static struct pnp_info pnp_dev_info[] = {
@@ -66,23 +72,17 @@ static void enable_dev(device_t dev)
 
 static void sch4037_pnp_set_resources(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_set_resources(dev);
-	pnp_exit_conf_state(dev);
 }
 
 static void sch4037_pnp_enable_resources(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_enable_resources(dev);
-	pnp_exit_conf_state(dev);
 }
 
 static void sch4037_pnp_enable(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_alt_enable(dev);
-	pnp_exit_conf_state(dev);
 }
 
 static void sch4037_init(device_t dev)
diff --git a/src/superio/smsc/sio1036/superio.c b/src/superio/smsc/sio1036/superio.c
index c25a674832..834fd492f4 100644
--- a/src/superio/smsc/sio1036/superio.c
+++ b/src/superio/smsc/sio1036/superio.c
@@ -46,12 +46,18 @@ struct chip_operations superio_smsc_sio1036_ops = {
 		.enable_dev = enable_dev
 };
 
+static const struct pnp_mode_ops pnp_conf_mode_ops = {
+	.enter_conf_mode  = pnp_enter_conf_state,
+	.exit_conf_mode   = pnp_exit_conf_state,
+};
+
 static struct device_operations ops = {
 	.read_resources   = pnp_read_resources,
 	.set_resources    = sio1036_pnp_set_resources,
 	.enable_resources = sio1036_pnp_enable_resources,
 	.enable           = sio1036_pnp_enable,
 	.init             = sio1036_init,
+	.ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 static struct pnp_info pnp_dev_info[] = {
@@ -65,23 +71,17 @@ static void enable_dev(device_t dev)
 
 static void sio1036_pnp_set_resources(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_set_resources(dev);
-	pnp_exit_conf_state(dev);
 }
 
 static void sio1036_pnp_enable_resources(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_enable_resources(dev);
-	pnp_exit_conf_state(dev);
 }
 
 static void sio1036_pnp_enable(device_t dev)
 {
-	pnp_enter_conf_state(dev);
 	pnp_alt_enable(dev);
-	pnp_exit_conf_state(dev);
 }
 
 static void sio1036_init(device_t dev)
diff --git a/src/superio/smsc/smscsuperio/superio.c b/src/superio/smsc/smscsuperio/superio.c
index cdd223b489..9af67a1c02 100644
--- a/src/superio/smsc/smscsuperio/superio.c
+++ b/src/superio/smsc/smscsuperio/superio.c
@@ -172,17 +172,13 @@ static void smsc_pnp_exit_conf_state(device_t dev)
 /** Wrapper for pnp_set_resources(). */
 static void smsc_pnp_set_resources(device_t dev)
 {
-	smsc_pnp_enter_conf_state(dev);
 	pnp_set_resources(dev);
-	smsc_pnp_exit_conf_state(dev);
 }
 
 /** Wrapper for pnp_enable_resources(). */
 static void smsc_pnp_enable_resources(device_t dev)
 {
-	smsc_pnp_enter_conf_state(dev);
 	pnp_enable_resources(dev);
-	smsc_pnp_exit_conf_state(dev);
 }
 
 /**
@@ -193,9 +189,7 @@ static void smsc_pnp_enable_resources(device_t dev)
  */
 static void smsc_pnp_enable(device_t dev)
 {
-	smsc_pnp_enter_conf_state(dev);
 	pnp_alt_enable(dev);
-	smsc_pnp_exit_conf_state(dev);
 }
 
 /**
@@ -228,6 +222,11 @@ static void smsc_init(device_t dev)
 	}
 }
 
+static const struct pnp_mode_ops pnp_conf_mode_ops = {
+	.enter_conf_mode  = smsc_pnp_enter_conf_state,
+	.exit_conf_mode   = smsc_pnp_exit_conf_state,
+};
+
 /** Standard device operations. */
 static struct device_operations ops = {
 	.read_resources   = pnp_read_resources,
@@ -235,6 +234,7 @@ static struct device_operations ops = {
 	.enable_resources = smsc_pnp_enable_resources,
 	.enable           = smsc_pnp_enable,
 	.init             = smsc_init,
+	.ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 /**
@@ -288,10 +288,10 @@ static void enable_dev(device_t dev)
 
 	if (first_time) {
 		/* Read the device ID and revision of the Super I/O chip. */
-		smsc_pnp_enter_conf_state(dev);
+		pnp_enter_conf_mode(dev);
 		superio_id = pnp_read_config(dev, DEVICE_ID_REG);
 		superio_rev = pnp_read_config(dev, DEVICE_REV_REG);
-		smsc_pnp_exit_conf_state(dev);
+		pnp_exit_conf_mode(dev);
 
 		/* TODO: Error handling? */