superio.c

Go to the documentation of this file.

/* SPDX-License-Identifier: GPL-2.0-or-later */
 
/* RAM-based driver for SMSC LPC47N217 Super I/O chip. */
 
#include <arch/io.h>
#include <device/device.h>
#include <device/pnp.h>
#include <console/console.h>
#include <assert.h>
 
#include "lpc47n217.h"
 
/* Forward declarations */
static void enable_dev(struct device *dev);
static void lpc47n217_pnp_set_resources(struct device *dev);
static void lpc47n217_pnp_enable_resources(struct device *dev);
static void lpc47n217_pnp_enable(struct device *dev);
static void lpc47n217_init(struct device *dev);
static void lpc47n217_pnp_set_resource(struct device *dev, struct resource *resource);
static void lpc47n217_pnp_set_iobase(struct device *dev, u16 iobase);
static void lpc47n217_pnp_set_drq(struct device *dev, u8 drq);
static void lpc47n217_pnp_set_irq(struct device *dev, u8 irq);
static void lpc47n217_pnp_set_enable(struct device *dev, int enable);
static void pnp_enter_conf_state(struct device *dev);
static void pnp_exit_conf_state(struct device *dev);
 
struct chip_operations superio_smsc_lpc47n217_ops = {
        CHIP_NAME("SMSC LPC47N217 Super I/O")
        .enable_dev = enable_dev,
};
 
static struct device_operations ops = {
        .read_resources   = pnp_read_resources,
        .set_resources    = lpc47n217_pnp_set_resources,
        .enable_resources = lpc47n217_pnp_enable_resources,
        .enable           = lpc47n217_pnp_enable,
        .init             = lpc47n217_init,
};
 
static struct pnp_info pnp_dev_info[] = {
        { NULL, LPC47N217_PP,   PNP_IO0 | PNP_IRQ0 | PNP_DRQ0, 0x07f8, },
        { NULL, LPC47N217_SP1,  PNP_IO0 | PNP_IRQ0, 0x07f8, },
        { NULL, LPC47N217_SP2,  PNP_IO0 | PNP_IRQ0, 0x07f8, }
};
 
/**
 * Create device structures and allocate resources to devices specified in the
 * pnp_dev_info array (above).
 *
 * @param dev Pointer to structure describing a Super I/O device.
 */
static void enable_dev(struct device *dev)
{
        pnp_enable_devices(dev, &ops, ARRAY_SIZE(pnp_dev_info), pnp_dev_info);
}
 
/**
 * Configure the specified Super I/O device with the resources (I/O space,
 * etc.) that have been allocate for it.
 *
 * NOTE: Cannot use pnp_set_resources() here because it assumes chip
 * support for logical devices, which the LPC47N217 doesn't have.
 *
 * @param dev Pointer to structure describing a Super I/O device.
 */
static void lpc47n217_pnp_set_resources(struct device *dev)
{
        struct resource *res;
 
        pnp_enter_conf_state(dev);
        for (res = dev->resource_list; res; res = res->next)
                lpc47n217_pnp_set_resource(dev, res);
        /* dump_pnp_device(dev); */
        pnp_exit_conf_state(dev);
}
 
/*
 * NOTE: Cannot use pnp_enable_resources() here because it assumes chip
 * support for logical devices, which the LPC47N217 doesn't have.
 */
static void lpc47n217_pnp_enable_resources(struct device *dev)
{
        pnp_enter_conf_state(dev);
        lpc47n217_pnp_set_enable(dev, 1);
        pnp_exit_conf_state(dev);
}
 
/*
 * NOTE: Cannot use pnp_set_enable() here because it assumes chip
 * support for logical devices, which the LPC47N217 doesn't have.
 */
static void lpc47n217_pnp_enable(struct device *dev)
{
        pnp_enter_conf_state(dev);
        lpc47n217_pnp_set_enable(dev, !!dev->enabled);
        pnp_exit_conf_state(dev);
}
 
/**
 * Initialize the specified Super I/O device.
 *
 * Devices other than COM ports are ignored. For COM ports, we configure the
 * baud rate.
 *
 * @param dev Pointer to structure describing a Super I/O device.
 */
static void lpc47n217_init(struct device *dev)
{
        if (!dev->enabled)
                return;
}
 
static void lpc47n217_pnp_set_resource(struct device *dev, struct resource *resource)
{
        if (!(resource->flags & IORESOURCE_ASSIGNED)) {
                printk(BIOS_ERR, "%s %02lx not allocated\n",
                       dev_path(dev), resource->index);
                return;
        }
 
        /* Now store the resource. */
 
        /*
         * NOTE: Cannot use pnp_set_XXX() here because they assume chip
         * support for logical devices, which the LPC47N217 doesn't have.
         */
        if (resource->flags & IORESOURCE_IO) {
                lpc47n217_pnp_set_iobase(dev, resource->base);
        } else if (resource->flags & IORESOURCE_DRQ) {
                lpc47n217_pnp_set_drq(dev, resource->base);
        } else if (resource->flags & IORESOURCE_IRQ) {
                lpc47n217_pnp_set_irq(dev, resource->base);
        } else {
                printk(BIOS_ERR, "%s %02lx unknown resource type\n",
                       dev_path(dev), resource->index);
                return;
        }
        resource->flags |= IORESOURCE_STORED;
 
        report_resource_stored(dev, resource, "");
}
 
static void lpc47n217_pnp_set_iobase(struct device *dev, u16 iobase)
{
        ASSERT(!(iobase & 0x3));
 
        switch (dev->path.pnp.device) {
        case LPC47N217_PP:
                pnp_write_config(dev, 0x23, (iobase >> 2) & 0xff);
                break;
        case LPC47N217_SP1:
                pnp_write_config(dev, 0x24, (iobase >> 2) & 0xff);
                break;
        case LPC47N217_SP2:
                pnp_write_config(dev, 0x25, (iobase >> 2) & 0xff);
                break;
        default:
                BUG();
                break;
        }
}
 
static void lpc47n217_pnp_set_drq(struct device *dev, u8 drq)
{
        const u8 PP_DMA_MASK = 0x0F;
        const u8 PP_DMA_SELECTION_REGISTER = 0x26;
        u8 current_config, new_config;
 
        if (dev->path.pnp.device == LPC47N217_PP) {
                current_config = pnp_read_config(dev,
                                                 PP_DMA_SELECTION_REGISTER);
                ASSERT(!(drq & ~PP_DMA_MASK)); /* DRQ out of range? */
                new_config = (current_config & ~PP_DMA_MASK) | drq;
                pnp_write_config(dev, PP_DMA_SELECTION_REGISTER, new_config);
        } else {
                BUG();
        }
}
 
static void lpc47n217_pnp_set_irq(struct device *dev, u8 irq)
{
        u8 irq_config_register = 0, irq_config_mask = 0;
        u8 current_config, new_config;
 
        switch (dev->path.pnp.device) {
        case LPC47N217_PP:
                irq_config_register = 0x27;
                irq_config_mask = 0x0F;
                break;
        case LPC47N217_SP1:
                irq_config_register = 0x28;
                irq_config_mask = 0xF0;
                irq <<= 4;
                break;
        case LPC47N217_SP2:
                irq_config_register = 0x28;
                irq_config_mask = 0x0F;
                break;
        default:
                BUG();
                return;
        }
 
        ASSERT(!(irq & ~irq_config_mask)); /* IRQ out of range? */
 
        current_config = pnp_read_config(dev, irq_config_register);
        new_config = (current_config & ~irq_config_mask) | irq;
        pnp_write_config(dev, irq_config_register, new_config);
}
 
static void lpc47n217_pnp_set_enable(struct device *dev, int enable)
{
        u8 power_register = 0, power_mask = 0, current_power, new_power;
 
        switch (dev->path.pnp.device) {
        case LPC47N217_PP:
                power_register = 0x01;
                power_mask = 0x04;
                break;
        case LPC47N217_SP1:
                power_register = 0x02;
                power_mask = 0x08;
                break;
        case LPC47N217_SP2:
                power_register = 0x02;
                power_mask = 0x80;
                break;
        default:
                BUG();
                return;
        }
 
        current_power = pnp_read_config(dev, power_register);
        new_power = current_power & ~power_mask; /* Disable by default. */
        if (enable) {
                struct resource* ioport_resource;
                ioport_resource = find_resource(dev, PNP_IDX_IO0);
                lpc47n217_pnp_set_iobase(dev, ioport_resource->base);
                new_power |= power_mask; /* Enable. */
        } else {
                lpc47n217_pnp_set_iobase(dev, 0);
        }
        pnp_write_config(dev, power_register, new_power);
}
 
static void pnp_enter_conf_state(struct device *dev)
{
        outb(0x55, dev->path.pnp.port);
}
 
static void pnp_exit_conf_state(struct device *dev)
{
        outb(0xaa, dev->path.pnp.port);
}