jsm_driver.c

Go to the documentation of this file.

/************************************************************************
 * Copyright 2003 Digi International (www.digi.com)
 *
 * Copyright (C) 2004 IBM Corporation. All rights reserved.
 *
 * 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, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED; 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.
 *
 * Contact Information:
 * Scott H Kilau <[email protected]>
 * Wendy Xiong   <[email protected]>
 *
 *
 ***********************************************************************/
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/slab.h>

#include "jsm.h"

MODULE_AUTHOR("Digi International, http://www.digi.com");
MODULE_DESCRIPTION("Driver for the Digi International "
           "Neo PCI based product line");
MODULE_LICENSE("GPL");
MODULE_SUPPORTED_DEVICE("jsm");

#define JSM_DRIVER_NAME "jsm"
#define NR_PORTS    32
#define JSM_MINOR_START 0

struct uart_driver jsm_uart_driver = {
    .owner      = THIS_MODULE,
    .driver_name    = JSM_DRIVER_NAME,
    .dev_name   = "ttyn",
    .major      = 0,
    .minor      = JSM_MINOR_START,
    .nr     = NR_PORTS,
};

static pci_ers_result_t jsm_io_error_detected(struct pci_dev *pdev,
                                       pci_channel_state_t state);
static pci_ers_result_t jsm_io_slot_reset(struct pci_dev *pdev);
static void jsm_io_resume(struct pci_dev *pdev);

static const struct pci_error_handlers jsm_err_handler = {
    .error_detected = jsm_io_error_detected,
    .slot_reset = jsm_io_slot_reset,
    .resume = jsm_io_resume,
};

int jsm_debug;
module_param(jsm_debug, int, 0);
MODULE_PARM_DESC(jsm_debug, "Driver debugging level");

static int __devinit jsm_probe_one(struct pci_dev *pdev, const struct pci_device_id *ent)
{
    int rc = 0;
    struct jsm_board *brd;
    static int adapter_count = 0;

    rc = pci_enable_device(pdev);
    if (rc) {
        dev_err(&pdev->dev, "Device enable FAILED\n");
        goto out;
    }

    rc = pci_request_regions(pdev, "jsm");
    if (rc) {
        dev_err(&pdev->dev, "pci_request_region FAILED\n");
        goto out_disable_device;
    }

    brd = kzalloc(sizeof(struct jsm_board), GFP_KERNEL);
    if (!brd) {
        dev_err(&pdev->dev,
            "memory allocation for board structure failed\n");
        rc = -ENOMEM;
        goto out_release_regions;
    }

    /* store the info for the board we've found */
    brd->boardnum = adapter_count++;
    brd->pci_dev = pdev;
    if (pdev->device == PCIE_DEVICE_ID_NEO_4_IBM)
        brd->maxports = 4;
    else if (pdev->device == PCI_DEVICE_ID_DIGI_NEO_8)
        brd->maxports = 8;
    else
        brd->maxports = 2;

    spin_lock_init(&brd->bd_intr_lock);

    /* store which revision we have */
    brd->rev = pdev->revision;

    brd->irq = pdev->irq;

    jsm_printk(INIT, INFO, &brd->pci_dev,
        "jsm_found_board - NEO adapter\n");

    /* get the PCI Base Address Registers */
    brd->membase    = pci_resource_start(pdev, 0);
    brd->membase_end = pci_resource_end(pdev, 0);

    if (brd->membase & 1)
        brd->membase &= ~3;
    else
        brd->membase &= ~15;

    /* Assign the board_ops struct */
    brd->bd_ops = &jsm_neo_ops;

    brd->bd_uart_offset = 0x200;
    brd->bd_dividend = 921600;

    brd->re_map_membase = ioremap(brd->membase, pci_resource_len(pdev, 0));
    if (!brd->re_map_membase) {
        dev_err(&pdev->dev,
            "card has no PCI Memory resources, "
            "failing board.\n");
        rc = -ENOMEM;
        goto out_kfree_brd;
    }

    rc = request_irq(brd->irq, brd->bd_ops->intr,
            IRQF_SHARED, "JSM", brd);
    if (rc) {
        printk(KERN_WARNING "Failed to hook IRQ %d\n",brd->irq);
        goto out_iounmap;
    }

    rc = jsm_tty_init(brd);
    if (rc < 0) {
        dev_err(&pdev->dev, "Can't init tty devices (%d)\n", rc);
        rc = -ENXIO;
        goto out_free_irq;
    }

    rc = jsm_uart_port_init(brd);
    if (rc < 0) {
        /* XXX: leaking all resources from jsm_tty_init here! */
        dev_err(&pdev->dev, "Can't init uart port (%d)\n", rc);
        rc = -ENXIO;
        goto out_free_irq;
    }

    /* Log the information about the board */
    dev_info(&pdev->dev, "board %d: Digi Neo (rev %d), irq %d\n",
            adapter_count, brd->rev, brd->irq);

    pci_set_drvdata(pdev, brd);
    pci_save_state(pdev);

    return 0;
 out_free_irq:
    jsm_remove_uart_port(brd);
    free_irq(brd->irq, brd);
 out_iounmap:
    iounmap(brd->re_map_membase);
 out_kfree_brd:
    kfree(brd);
 out_release_regions:
    pci_release_regions(pdev);
 out_disable_device:
    pci_disable_device(pdev);
 out:
    return rc;
}

static void __devexit jsm_remove_one(struct pci_dev *pdev)
{
    struct jsm_board *brd = pci_get_drvdata(pdev);
    int i = 0;

    jsm_remove_uart_port(brd);

    free_irq(brd->irq, brd);
    iounmap(brd->re_map_membase);

    /* Free all allocated channels structs */
    for (i = 0; i < brd->maxports; i++) {
        if (brd->channels[i]) {
            kfree(brd->channels[i]->ch_rqueue);
            kfree(brd->channels[i]->ch_equeue);
            kfree(brd->channels[i]);
        }
    }

    pci_release_regions(pdev);
    pci_disable_device(pdev);
    kfree(brd);
}

static struct pci_device_id jsm_pci_tbl[] = {
    { PCI_DEVICE(PCI_VENDOR_ID_DIGI, PCI_DEVICE_ID_NEO_2DB9), 0, 0, 0 },
    { PCI_DEVICE(PCI_VENDOR_ID_DIGI, PCI_DEVICE_ID_NEO_2DB9PRI), 0, 0, 1 },
    { PCI_DEVICE(PCI_VENDOR_ID_DIGI, PCI_DEVICE_ID_NEO_2RJ45), 0, 0, 2 },
    { PCI_DEVICE(PCI_VENDOR_ID_DIGI, PCI_DEVICE_ID_NEO_2RJ45PRI), 0, 0, 3 },
    { PCI_DEVICE(PCI_VENDOR_ID_DIGI, PCIE_DEVICE_ID_NEO_4_IBM), 0, 0, 4 },
    { PCI_DEVICE(PCI_VENDOR_ID_DIGI, PCI_DEVICE_ID_DIGI_NEO_8), 0, 0, 5 },
    { 0, }
};
MODULE_DEVICE_TABLE(pci, jsm_pci_tbl);

static struct pci_driver jsm_driver = {
    .name       = "jsm",
    .id_table   = jsm_pci_tbl,
    .probe      = jsm_probe_one,
    .remove     = __devexit_p(jsm_remove_one),
    .err_handler    = &jsm_err_handler,
};

static pci_ers_result_t jsm_io_error_detected(struct pci_dev *pdev,
                    pci_channel_state_t state)
{
    struct jsm_board *brd = pci_get_drvdata(pdev);

    jsm_remove_uart_port(brd);

    return PCI_ERS_RESULT_NEED_RESET;
}

static pci_ers_result_t jsm_io_slot_reset(struct pci_dev *pdev)
{
    int rc;

    rc = pci_enable_device(pdev);

    if (rc)
        return PCI_ERS_RESULT_DISCONNECT;

    pci_set_master(pdev);

    return PCI_ERS_RESULT_RECOVERED;
}

static void jsm_io_resume(struct pci_dev *pdev)
{
    struct jsm_board *brd = pci_get_drvdata(pdev);

    pci_restore_state(pdev);
    pci_save_state(pdev);

    jsm_uart_port_init(brd);
}

static int __init jsm_init_module(void)
{
    int rc;

    rc = uart_register_driver(&jsm_uart_driver);
    if (!rc) {
        rc = pci_register_driver(&jsm_driver);
        if (rc)
            uart_unregister_driver(&jsm_uart_driver);
    }
    return rc;
}

static void __exit jsm_exit_module(void)
{
    pci_unregister_driver(&jsm_driver);
    uart_unregister_driver(&jsm_uart_driver);
}

module_init(jsm_init_module);
module_exit(jsm_exit_module);