Re: [RFC][Patch] IBM Real-Time "SMI Free" mode driver -v3

Randy Dunlap
2010-09-23T21:38:54Z

On Tue, 21 Sep 2010 15:46:10 -0700 Vernon Mauery wrote:

> IBM Real-Time "SMI Free" mode driver
>
> Signed-off-by: Vernon Mauery <vernux@us.ibm.com>
>
> diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
> index cff7cc2..16ba6e6 100644
> --- a/drivers/platform/x86/Kconfig
> +++ b/drivers/platform/x86/Kconfig
> @@ -590,4 +590,20 @@ config INTEL_IPS
> functionality. If in doubt, say Y here; it will only load on
> supported platforms.
>
> +config IBM_RTL
> + tristate "Device driver to enable PRTL support"
> + depends on X86 && PCI
> + ---help---
> + Enable support for IBM Preimium Real Time Mode (PRTM).

What is Preimium?

> + This module will allow you the enter and exit PRTM in the BIOS via
> + sysfs on platforms that support this feature. System in PRTM will
> + not recive cpu generated SMIs for recoverable errors. Use of this

receive CPU-generated

> + feature without proper support may void your hardware warrenty.

warranty.

> +
> + If the proper bios support is found the driver will load and create

BIOS

> + /sys/devices/system/ibm_rtl/. The "state" varable will indicate

variable

> + weather or not the BIOS is in PRTM.

whether

> + state = 0 (BIOS SMI's on)
> + state = 1 (BIOS SMI's off)
> +
> endif # X86_PLATFORM_DEVICES

> diff --git a/drivers/platform/x86/ibm_rtl.c b/drivers/platform/x86/ibm_rtl.c
> new file mode 100644
> index 0000000..37bf610
> --- /dev/null
> +++ b/drivers/platform/x86/ibm_rtl.c
> @@ -0,0 +1,352 @@
> +/*
> + * IBM Real-Time Linux driver
> + *
> + * This program is free software; you can redistribute it and/or modify
> + * it under the terms of the GNU General Public License as published by
> + * the Free Software Foundation; either version 2 of the License, or
> + * (at your option) any later version.
> + *
> + * This program is distributed in the hope that it will be useful,
> + * but WITHOUT ANY WARRANTY; without even the implied warranty of
> + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> + * GNU General Public License for more details.
> + *
> + * You should have received a copy of the GNU General Public License
> + * along with this program; if not, write to the Free Software
> + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
> + *
> + * Copyright (C) IBM Corporation, 2010
> + *
> + * Author: Keith Mannthey <kmannth@us.ibm.com>
> + * Vernon Mauery <vernux@us.ibm.com>
> + *
> + */
> +
> +#include <linux/kernel.h>
> +#include <linux/delay.h>
> +#include <linux/module.h>
> +#include <linux/io.h>
> +#include <linux/sysdev.h>
> +#include <linux/dmi.h>
> +#include <asm/bios_ebda.h>
> +#include <linux/mutex.h>

<asm> after all <linux> headers, please.

> +
> +static int force;
> +module_param(force, bool, 0);
> +MODULE_PARM_DESC(force, "Force driver load, ignore DMI data");
> +
> +static int debug;
> +module_param(debug, bool, 0644);
> +MODULE_PARM_DESC(debug, "Show debug output");
> +
> +MODULE_LICENSE("GPL");
> +MODULE_AUTHOR("Keith Mannthey <kmmanth@us.ibm.com>");
> +MODULE_AUTHOR("Vernon Mauery <vernux@us.ibm.com>");
> +
> +enum rtl_addr_type {
> + RTL_ADDR_TYPE_IO = 1,
> + RTL_ADDR_TYPE_MMIO,
> +} __attribute__((packed));
> +
> +enum rtl_cmd_type {
> + RTL_CMD_NOP = 0,
> + RTL_CMD_ENTER_PRTM,
> + RTL_CMD_EXIT_PRTM,
> +} __attribute__((packed));

What does packed do to an enum list?

> +
> +/* The RTL table looks something like: */

Unsure of this?

> +struct ibm_rtl_table {
> + char signature[5];
> + u8 version;
> + u8 rt_status;
> + enum rtl_cmd_type command;
> + u8 command_status;
> + enum rtl_addr_type cmd_address_type;
> + u8 cmd_granularity;
> + u8 cmd_offset;
> + u16 reserve1;
> + u8 cmd_port_address[4]; /* platform dependent address */
> + u8 cmd_port_value[4]; /* platform dependent value */
> +};
> +
> +#define RTL_SIGNATURE (('L'<<24)|('T'<<16)|('R'<<8)|'_')
> +
> +#define ERROR(A, B...) printk(KERN_ERR "ibm-rtl: " A, ##B )
> +#define WARNING(A, B...) printk(KERN_WARNING "ibm-rtl: " A, ##B )
> +#define DEBUG(A, B...) do { \
> + if (debug) \
> + printk(KERN_INFO "ibm-rtl: " A, ##B ); \
> +} while (0)
> +
> +DEFINE_MUTEX(rtl_lock);

static DEFINE_MUTEX(rtl_lock);

> +static struct ibm_rtl_table __iomem *rtl_table = NULL;
> +static void __iomem *ebda_map;
> +static void __iomem *rtl_cmd_iomem_addr = NULL;
> +static u32 rtl_cmd_port_addr;
> +static enum rtl_addr_type rtl_cmd_type;
> +static u8 rtl_cmd_width;

---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***