3  * IBM ASM Service Processor Device Driver
 
   5  * This program is free software; you can redistribute it and/or modify
 
   6  * it under the terms of the GNU General Public License as published by
 
   7  * the Free Software Foundation; either version 2 of the License, or
 
   8  * (at your option) any later version.
 
  10  * This program is distributed in the hope that it will be useful,
 
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
  13  * GNU General Public License for more details.
 
  15  * You should have received a copy of the GNU General Public License
 
  16  * along with this program; if not, write to the Free Software
 
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
  19  * Copyright (C) IBM Corporation, 2004
 
  21  * Author: Max Asböck <amax@us.ibm.com> 
 
  23  * This driver is based on code originally written by Pete Reynolds 
 
  29  * The ASM device driver does the following things:
 
  31  * 1) When loaded it sends a message to the service processor,
 
  32  * indicating that an OS is * running. This causes the service processor
 
  33  * to send periodic heartbeats to the OS. 
 
  35  * 2) Answers the periodic heartbeats sent by the service processor.
 
  36  * Failure to do so would result in system reboot.
 
  38  * 3) Acts as a pass through for dot commands sent from user applications.
 
  39  * The interface for this is the ibmasmfs file system. 
 
  41  * 4) Allows user applications to register for event notification. Events
 
  42  * are sent to the driver through interrupts. They can be read from user
 
  43  * space through the ibmasmfs file system.
 
  45  * 5) Allows user space applications to send heartbeats to the service
 
  46  * processor (aka reverse heartbeats). Again this happens through ibmasmfs.
 
  48  * 6) Handles remote mouse and keyboard event interrupts and makes them
 
  49  * available to user applications through ibmasmfs.
 
  53 #include <linux/pci.h>
 
  54 #include <linux/init.h>
 
  60 module_param(ibmasm_debug, int , S_IRUGO | S_IWUSR);
 
  61 MODULE_PARM_DESC(ibmasm_debug, " Set debug mode on or off");
 
  64 static int __devinit ibmasm_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
 
  67         struct service_processor *sp;
 
  69         if ((result = pci_enable_device(pdev))) {
 
  70                 dev_err(&pdev->dev, "Failed to enable PCI device\n");
 
  73         if ((result = pci_request_regions(pdev, DRIVER_NAME))) {
 
  74                 dev_err(&pdev->dev, "Failed to allocate PCI resources\n");
 
  77         /* vnc client won't work without bus-mastering */
 
  80         sp = kmalloc(sizeof(struct service_processor), GFP_KERNEL);
 
  82                 dev_err(&pdev->dev, "Failed to allocate memory\n");
 
  86         memset(sp, 0, sizeof(struct service_processor));
 
  88         sp->lock = SPIN_LOCK_UNLOCKED;
 
  89         INIT_LIST_HEAD(&sp->command_queue);
 
  91         pci_set_drvdata(pdev, (void *)sp);
 
  93         sp->number = pdev->bus->number;
 
  94         snprintf(sp->dirname, IBMASM_NAME_SIZE, "%d", sp->number);
 
  95         snprintf(sp->devname, IBMASM_NAME_SIZE, "%s%d", DRIVER_NAME, sp->number);
 
  97         if (ibmasm_event_buffer_init(sp)) {
 
  98                 dev_err(sp->dev, "Failed to allocate event buffer\n");
 
  99                 goto error_eventbuffer;
 
 102         if (ibmasm_heartbeat_init(sp)) {
 
 103                 dev_err(sp->dev, "Failed to allocate heartbeat command\n");
 
 104                 goto error_heartbeat;
 
 108         sp->base_address = ioremap(pci_resource_start(pdev, 0), 
 
 109                                         pci_resource_len(pdev, 0));
 
 110         if (sp->base_address == 0) {
 
 111                 dev_err(sp->dev, "Failed to ioremap pci memory\n");
 
 116         result = request_irq(sp->irq, ibmasm_interrupt_handler, SA_SHIRQ, sp->devname, (void*)sp);
 
 118                 dev_err(sp->dev, "Failed to register interrupt handler\n");
 
 119                 goto error_request_irq;
 
 122         enable_sp_interrupts(sp->base_address);
 
 124         result = ibmasm_init_remote_input_dev(sp);
 
 126                 dev_err(sp->dev, "Failed to initialize remote queue\n");
 
 127                 goto error_send_message;
 
 130         result = ibmasm_send_driver_vpd(sp);
 
 132                 dev_err(sp->dev, "Failed to send driver VPD to service processor\n");
 
 133                 goto error_send_message;
 
 135         result = ibmasm_send_os_state(sp, SYSTEM_STATE_OS_UP);
 
 137                 dev_err(sp->dev, "Failed to send OS state to service processor\n");
 
 138                 goto error_send_message;
 
 142         ibmasm_register_uart(sp);
 
 147         disable_sp_interrupts(sp->base_address);
 
 148         ibmasm_free_remote_input_dev(sp);
 
 149         free_irq(sp->irq, (void *)sp);
 
 151         iounmap(sp->base_address);
 
 153         ibmasm_heartbeat_exit(sp);
 
 155         ibmasm_event_buffer_exit(sp);
 
 157         pci_set_drvdata(pdev, NULL);
 
 160         pci_release_regions(pdev);
 
 162         pci_disable_device(pdev);
 
 167 static void __devexit ibmasm_remove_one(struct pci_dev *pdev)
 
 169         struct service_processor *sp = (struct service_processor *)pci_get_drvdata(pdev);
 
 171         dbg("Unregistering UART\n");
 
 172         ibmasm_unregister_uart(sp);
 
 173         dbg("Sending OS down message\n");
 
 174         if (ibmasm_send_os_state(sp, SYSTEM_STATE_OS_DOWN))
 
 175                 err("failed to get repsonse to 'Send OS State' command\n");
 
 176         dbg("Disabling heartbeats\n");
 
 177         ibmasm_heartbeat_exit(sp);
 
 178         dbg("Disabling interrupts\n");
 
 179         disable_sp_interrupts(sp->base_address);
 
 180         dbg("Freeing SP irq\n");
 
 181         free_irq(sp->irq, (void *)sp);
 
 182         dbg("Cleaning up\n");
 
 183         ibmasm_free_remote_input_dev(sp);
 
 184         iounmap(sp->base_address);
 
 185         ibmasm_event_buffer_exit(sp);
 
 186         pci_set_drvdata(pdev, NULL);
 
 188         pci_release_regions(pdev);
 
 189         pci_disable_device(pdev);
 
 192 static struct pci_device_id ibmasm_pci_table[] =
 
 194         { PCI_DEVICE(VENDORID_IBM, DEVICEID_RSA) },
 
 198 static struct pci_driver ibmasm_driver = {
 
 200         .id_table       = ibmasm_pci_table,
 
 201         .probe          = ibmasm_init_one,
 
 202         .remove         = __devexit_p(ibmasm_remove_one),
 
 205 static void __exit ibmasm_exit (void)
 
 207         ibmasm_unregister_panic_notifier();
 
 208         ibmasmfs_unregister();
 
 209         pci_unregister_driver(&ibmasm_driver);
 
 210         info(DRIVER_DESC " version " DRIVER_VERSION " unloaded");
 
 213 static int __init ibmasm_init(void)
 
 217         result = ibmasmfs_register();
 
 219                 err("Failed to register ibmasmfs file system");
 
 222         result = pci_register_driver(&ibmasm_driver);
 
 224                 ibmasmfs_unregister();
 
 227         ibmasm_register_panic_notifier();
 
 228         info(DRIVER_DESC " version " DRIVER_VERSION " loaded");
 
 232 module_init(ibmasm_init);
 
 233 module_exit(ibmasm_exit);
 
 235 MODULE_AUTHOR(DRIVER_AUTHOR);
 
 236 MODULE_DESCRIPTION(DRIVER_DESC);
 
 237 MODULE_LICENSE("GPL");
 
 238 MODULE_DEVICE_TABLE(pci, ibmasm_pci_table);