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>

8 files changed, 61 insertions, 57 deletions

diff --git a/src/superio/winbond/w83627dhg/superio.c b/src/superio/winbond/w83627dhg/superio.c
index 5310426793..d742112a49 100644
--- a/src/superio/winbond/w83627dhg/superio.c
+++ b/src/superio/winbond/w83627dhg/superio.c
@@ -41,11 +41,11 @@ static void w83627dhg_enable_UR2(device_t dev)
 {
 	u8 reg8;
 
-	pnp_enter_ext_func_mode(dev);
+	pnp_enter_conf_mode(dev);
 	reg8 = pnp_read_config(dev, 0x2c);
 	reg8 |= (0x3);
 	pnp_write_config(dev, 0x2c, reg8); // Set pins 78-85-> UART B
-	pnp_exit_ext_func_mode(dev);
+	pnp_exit_conf_mode(dev);
 }
 
 static void w83627dhg_init(device_t dev)
@@ -67,31 +67,31 @@ static void w83627dhg_init(device_t dev)
 
 static void w83627dhg_pnp_set_resources(device_t dev)
 {
-	pnp_enter_ext_func_mode(dev);
 	pnp_set_resources(dev);
-	pnp_exit_ext_func_mode(dev);
 }
 
 static void w83627dhg_pnp_enable_resources(device_t dev)
 {
-	pnp_enter_ext_func_mode(dev);
 	pnp_enable_resources(dev);
-	pnp_exit_ext_func_mode(dev);
 }
 
 static void w83627dhg_pnp_enable(device_t dev)
 {
-	pnp_enter_ext_func_mode(dev);
 	pnp_alt_enable(dev);
-	pnp_exit_ext_func_mode(dev);
 }
 
+static const struct pnp_mode_ops pnp_conf_mode_ops = {
+	.enter_conf_mode  = pnp_enter_ext_func_mode,
+	.exit_conf_mode   = pnp_exit_ext_func_mode,
+};
+
 static struct device_operations ops = {
 	.read_resources   = pnp_read_resources,
 	.set_resources    = w83627dhg_pnp_set_resources,
 	.enable_resources = w83627dhg_pnp_enable_resources,
 	.enable           = w83627dhg_pnp_enable,
 	.init             = w83627dhg_init,
+	.ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 static struct pnp_info pnp_dev_info[] = {
diff --git a/src/superio/winbond/w83627ehg/superio.c b/src/superio/winbond/w83627ehg/superio.c
index e0eea1b574..a94c4c0030 100644
--- a/src/superio/winbond/w83627ehg/superio.c
+++ b/src/superio/winbond/w83627ehg/superio.c
@@ -72,14 +72,14 @@ static void init_acpi(device_t dev)
 	int power_on = 1;
 
 	get_option(&power_on, "power_on_after_fail");
-	pnp_enter_ext_func_mode(dev);
+	pnp_enter_conf_mode(dev);
 	pnp_set_logical_device(dev);
 	value = pnp_read_config(dev, 0xe4);
 	value &= ~(3 << 5);
 	if (power_on)
 		value |= (1 << 5);
 	pnp_write_config(dev, 0xe4, value);
-	pnp_exit_ext_func_mode(dev);
+	pnp_exit_conf_mode(dev);
 }
 
 static void init_hwm(u16 base)
@@ -129,39 +129,40 @@ static void w83627ehg_init(device_t dev)
 
 static void w83627ehg_pnp_set_resources(device_t dev)
 {
-	pnp_enter_ext_func_mode(dev);
 	pnp_set_resources(dev);
-	pnp_exit_ext_func_mode(dev);
 }
 
 static void w83627ehg_pnp_enable_resources(device_t dev)
 {
-	pnp_enter_ext_func_mode(dev);
 	pnp_enable_resources(dev);
 
+	pnp_enter_conf_mode(dev);
 	switch (dev->path.pnp.device) {
 	case W83627EHG_HWM:
 		printk(BIOS_DEBUG, "W83627EHG HWM SMBus enabled\n");
 		enable_hwm_smbus(dev);
 		break;
 	}
-
-	pnp_exit_ext_func_mode(dev);
+	pnp_exit_conf_mode(dev);
 }
 
 static void w83627ehg_pnp_enable(device_t dev)
 {
-	pnp_enter_ext_func_mode(dev);
 	pnp_alt_enable(dev);
-	pnp_exit_ext_func_mode(dev);
 }
 
+static const struct pnp_mode_ops pnp_conf_mode_ops = {
+	.enter_conf_mode  = pnp_enter_ext_func_mode,
+	.exit_conf_mode   = pnp_exit_ext_func_mode,
+};
+
 static struct device_operations ops = {
 	.read_resources   = pnp_read_resources,
 	.set_resources    = w83627ehg_pnp_set_resources,
 	.enable_resources = w83627ehg_pnp_enable_resources,
 	.enable           = w83627ehg_pnp_enable,
 	.init             = w83627ehg_init,
+	.ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 static struct pnp_info pnp_dev_info[] = {
diff --git a/src/superio/winbond/w83627hf/superio.c b/src/superio/winbond/w83627hf/superio.c
index a117e05b2c..625f149ec7 100644
--- a/src/superio/winbond/w83627hf/superio.c
+++ b/src/superio/winbond/w83627hf/superio.c
@@ -73,14 +73,14 @@ static void init_acpi(device_t dev)
 
 	get_option(&power_on, "power_on_after_fail");
 
-	pnp_enter_ext_func_mode(dev);
+	pnp_enter_conf_mode(dev);
 	pnp_set_logical_device(dev);
 	value = pnp_read_config(dev, 0xE4);
 	value &= ~(3 << 5);
 	if (power_on)
 		value |= (1 << 5);
 	pnp_write_config(dev, 0xE4, value);
-	pnp_exit_ext_func_mode(dev);
+	pnp_exit_conf_mode(dev);
 }
 
 static void init_hwm(u16 base)
@@ -136,37 +136,40 @@ static void w83627hf_init(device_t dev)
 
 static void w83627hf_pnp_set_resources(device_t dev)
 {
-	pnp_enter_ext_func_mode(dev);
 	pnp_set_resources(dev);
-	pnp_exit_ext_func_mode(dev);
 }
 
 static void w83627hf_pnp_enable_resources(device_t dev)
 {
-	pnp_enter_ext_func_mode(dev);
 	pnp_enable_resources(dev);
+
+	pnp_enter_conf_mode(dev);
 	switch(dev->path.pnp.device) {
 	case W83627HF_HWM:
 		printk(BIOS_DEBUG, "W83627HF HWM SMBus enabled\n");
 		enable_hwm_smbus(dev);
 		break;
 	}
-	pnp_exit_ext_func_mode(dev);
+	pnp_exit_conf_mode(dev);
 }
 
 static void w83627hf_pnp_enable(device_t dev)
 {
-	pnp_enter_ext_func_mode(dev);
 	pnp_alt_enable(dev);
-	pnp_exit_ext_func_mode(dev);
 }
 
+static const struct pnp_mode_ops pnp_conf_mode_ops = {
+	.enter_conf_mode  = pnp_enter_ext_func_mode,
+	.exit_conf_mode   = pnp_exit_ext_func_mode,
+};
+
 static struct device_operations ops = {
 	.read_resources   = pnp_read_resources,
 	.set_resources    = w83627hf_pnp_set_resources,
 	.enable_resources = w83627hf_pnp_enable_resources,
 	.enable           = w83627hf_pnp_enable,
 	.init             = w83627hf_init,
+	.ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 static struct pnp_info pnp_dev_info[] = {
diff --git a/src/superio/winbond/w83627thg/superio.c b/src/superio/winbond/w83627thg/superio.c
index 1989fe2a52..70d0c3d8d0 100644
--- a/src/superio/winbond/w83627thg/superio.c
+++ b/src/superio/winbond/w83627thg/superio.c
@@ -57,31 +57,31 @@ static void w83627thg_init(device_t dev)
 
 static void w83627thg_set_resources(device_t dev)
 {
-	w83627thg_enter_ext_func_mode(dev);
 	pnp_set_resources(dev);
-	w83627thg_exit_ext_func_mode(dev);
 }
 
 static void w83627thg_enable_resources(device_t dev)
 {
-	w83627thg_enter_ext_func_mode(dev);
 	pnp_enable_resources(dev);
-	w83627thg_exit_ext_func_mode(dev);
 }
 
 static void w83627thg_enable(device_t dev)
 {
-	w83627thg_enter_ext_func_mode(dev);
 	pnp_enable(dev);
-	w83627thg_exit_ext_func_mode(dev);
 }
 
+static const struct pnp_mode_ops pnp_conf_mode_ops = {
+	.enter_conf_mode  = w83627thg_enter_ext_func_mode,
+	.exit_conf_mode   = w83627thg_exit_ext_func_mode,
+};
+
 static struct device_operations ops = {
 	.read_resources   = pnp_read_resources,
 	.set_resources    = w83627thg_set_resources,
 	.enable_resources = w83627thg_enable_resources,
 	.enable           = w83627thg_enable,
 	.init             = w83627thg_init,
+	.ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 static struct pnp_info pnp_dev_info[] = {
diff --git a/src/superio/winbond/w83627uhg/superio.c b/src/superio/winbond/w83627uhg/superio.c
index b4a4efe494..adae491a32 100644
--- a/src/superio/winbond/w83627uhg/superio.c
+++ b/src/superio/winbond/w83627uhg/superio.c
@@ -60,13 +60,13 @@ static void set_uart_clock_source(device_t dev, u8 uart_clock)
 {
 	u8 value;
 
-	w83627uhg_enter_ext_func_mode(dev);
+	pnp_enter_conf_mode(dev);
 	pnp_set_logical_device(dev);
 	value = pnp_read_config(dev, 0xf0);
 	value &= ~0x03;
 	value |= (uart_clock & 0x03);
 	pnp_write_config(dev, 0xf0, value);
-	w83627uhg_exit_ext_func_mode(dev);
+	pnp_exit_conf_mode(dev);
 }
 
 static void w83627uhg_init(device_t dev)
@@ -103,31 +103,31 @@ static void w83627uhg_init(device_t dev)
 
 static void w83627uhg_set_resources(device_t dev)
 {
-	w83627uhg_enter_ext_func_mode(dev);
 	pnp_set_resources(dev);
-	w83627uhg_exit_ext_func_mode(dev);
 }
 
 static void w83627uhg_enable_resources(device_t dev)
 {
-	w83627uhg_enter_ext_func_mode(dev);
 	pnp_enable_resources(dev);
-	w83627uhg_exit_ext_func_mode(dev);
 }
 
 static void w83627uhg_enable(device_t dev)
 {
-	w83627uhg_enter_ext_func_mode(dev);
 	pnp_enable(dev);
-	w83627uhg_exit_ext_func_mode(dev);
 }
 
+static const struct pnp_mode_ops pnp_conf_mode_ops = {
+	.enter_conf_mode  = w83627uhg_enter_ext_func_mode,
+	.exit_conf_mode   = w83627uhg_exit_ext_func_mode,
+};
+
 static struct device_operations ops = {
 	.read_resources   = pnp_read_resources,
 	.set_resources    = w83627uhg_set_resources,
 	.enable_resources = w83627uhg_enable_resources,
 	.enable           = w83627uhg_enable,
 	.init             = w83627uhg_init,
+	.ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 static struct pnp_info pnp_dev_info[] = {
diff --git a/src/superio/winbond/w83697hf/superio.c b/src/superio/winbond/w83697hf/superio.c
index e3ce7e2818..2dd4f4f8dd 100644
--- a/src/superio/winbond/w83697hf/superio.c
+++ b/src/superio/winbond/w83697hf/superio.c
@@ -83,31 +83,31 @@ static void w83697hf_init(device_t dev)
 
 static void w83697hf_pnp_set_resources(device_t dev)
 {
-	pnp_enter_ext_func_mode(dev);
 	pnp_set_resources(dev);
-	pnp_exit_ext_func_mode(dev);
 }
 
 static void w83697hf_pnp_enable(device_t dev)
 {
-	pnp_enter_ext_func_mode(dev);
 	pnp_alt_enable(dev);
-	pnp_exit_ext_func_mode(dev);
 }
 
 static void w83697hf_pnp_enable_resources(device_t dev)
 {
-	pnp_enter_ext_func_mode(dev);
 	pnp_enable_resources(dev);
-	pnp_exit_ext_func_mode(dev);
 }
 
+static const struct pnp_mode_ops pnp_conf_mode_ops = {
+	.enter_conf_mode  = pnp_enter_ext_func_mode,
+	.exit_conf_mode   = pnp_exit_ext_func_mode,
+};
+
 static struct device_operations ops = {
 	.read_resources   = pnp_read_resources,
 	.set_resources    = w83697hf_pnp_set_resources,
 	.enable_resources = w83697hf_pnp_enable_resources,
 	.enable           = w83697hf_pnp_enable,
 	.init             = w83697hf_init,
+	.ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 static struct pnp_info pnp_dev_info[] = {
diff --git a/src/superio/winbond/w83977f/superio.c b/src/superio/winbond/w83977f/superio.c
index b084b11d97..a88cbe5cc0 100644
--- a/src/superio/winbond/w83977f/superio.c
+++ b/src/superio/winbond/w83977f/superio.c
@@ -56,31 +56,31 @@ static void w83977f_init(device_t dev)
 
 static void w83977f_set_resources(device_t dev)
 {
-	w83977f_enter_ext_func_mode(dev);
 	pnp_set_resources(dev);
-	w83977f_exit_ext_func_mode(dev);
 }
 
 static void w83977f_enable_resources(device_t dev)
 {
-	w83977f_enter_ext_func_mode(dev);
 	pnp_enable_resources(dev);
-	w83977f_exit_ext_func_mode(dev);
 }
 
 static void w83977f_enable(device_t dev)
 {
-	w83977f_enter_ext_func_mode(dev);
 	pnp_enable(dev);
-	w83977f_exit_ext_func_mode(dev);
 }
 
+static const struct pnp_mode_ops pnp_conf_mode_ops = {
+	.enter_conf_mode  = w83977f_enter_ext_func_mode,
+	.exit_conf_mode   = w83977f_exit_ext_func_mode,
+};
+
 static struct device_operations ops = {
 	.read_resources   = pnp_read_resources,
 	.set_resources    = w83977f_set_resources,
 	.enable_resources = w83977f_enable_resources,
 	.enable           = w83977f_enable,
 	.init             = w83977f_init,
+	.ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 static struct pnp_info pnp_dev_info[] = {
diff --git a/src/superio/winbond/w83977tf/superio.c b/src/superio/winbond/w83977tf/superio.c
index 6ae9a6aa9a..30c291717d 100644
--- a/src/superio/winbond/w83977tf/superio.c
+++ b/src/superio/winbond/w83977tf/superio.c
@@ -58,31 +58,31 @@ static void w83977tf_init(device_t dev)
 
 static void w83977tf_set_resources(device_t dev)
 {
-	w83977tf_enter_ext_func_mode(dev);
 	pnp_set_resources(dev);
-	w83977tf_exit_ext_func_mode(dev);
 }
 
 static void w83977tf_enable_resources(device_t dev)
 {
-	w83977tf_enter_ext_func_mode(dev);
 	pnp_enable_resources(dev);
-	w83977tf_exit_ext_func_mode(dev);
 }
 
 static void w83977tf_enable(device_t dev)
 {
-	w83977tf_enter_ext_func_mode(dev);
 	pnp_enable(dev);
-	w83977tf_exit_ext_func_mode(dev);
 }
 
+static const struct pnp_mode_ops pnp_conf_mode_ops = {
+	.enter_conf_mode  = w83977tf_enter_ext_func_mode,
+	.exit_conf_mode   = w83977tf_exit_ext_func_mode,
+};
+
 static struct device_operations ops = {
 	.read_resources   = pnp_read_resources,
 	.set_resources    = w83977tf_set_resources,
 	.enable_resources = w83977tf_enable_resources,
 	.enable           = w83977tf_enable,
 	.init             = w83977tf_init,
+	.ops_pnp_mode     = &pnp_conf_mode_ops,
 };
 
 static struct pnp_info pnp_dev_info[] = {