drivers/misc/ibmasm/module.c

   1
   2 /*
   3  * IBM ASM Service Processor Device Driver
   4  *
   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.
   9  *
  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.
  14  *
  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.
  18  *
  19  * Copyright (C) IBM Corporation, 2004
  20  *
  21  * Author: Max Asböck <amax@us.ibm.com>
  22  *
  23  * This driver is based on code originally written by Pete Reynolds
  24  * and others.
  25  *
  26  */
  27
  28 /*
  29  * The ASM device driver does the following things:
  30  *
  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.
  34  *
  35  * 2) Answers the periodic heartbeats sent by the service processor.
  36  * Failure to do so would result in system reboot.
  37  *
  38  * 3) Acts as a pass through for dot commands sent from user applications.
  39  * The interface for this is the ibmasmfs file system.
  40  *
  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.
  44  *
  45  * 5) Allows user space applications to send heartbeats to the service
  46  * processor (aka reverse heartbeats). Again this happens through ibmasmfs.
  47  *
  48  * 6) Handles remote mouse and keyboard event interrupts and makes them
  49  * available to user applications through ibmasmfs.
  50  *
  51  */
  52
  53 #include <linux/pci.h>
  54 #include <linux/init.h>
  55 #include <linux/slab.h>
  56 #include "ibmasm.h"
  57 #include "lowlevel.h"
  58 #include "remote.h"
  59
  60 int ibmasm_debug = 0;
  61 module_param(ibmasm_debug, int , S_IRUGO | S_IWUSR);
  62 MODULE_PARM_DESC(ibmasm_debug, " Set debug mode on or off");
  63
  64
  65 static int ibmasm_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
  66 {
  67         int result;
  68         struct service_processor *sp;
  69
  70         if ((result = pci_enable_device(pdev))) {
  71                 dev_err(&pdev->dev, "Failed to enable PCI device\n");
  72                 return result;
  73         }
  74         if ((result = pci_request_regions(pdev, DRIVER_NAME))) {
  75                 dev_err(&pdev->dev, "Failed to allocate PCI resources\n");
  76                 goto error_resources;
  77         }
  78         /* vnc client won't work without bus-mastering */
  79         pci_set_master(pdev);
  80
  81         sp = kzalloc(sizeof(struct service_processor), GFP_KERNEL);
  82         if (sp == NULL) {
  83                 dev_err(&pdev->dev, "Failed to allocate memory\n");
  84                 result = -ENOMEM;
  85                 goto error_kmalloc;
  86         }
  87
  88         spin_lock_init(&sp->lock);
  89         INIT_LIST_HEAD(&sp->command_queue);
  90
  91         pci_set_drvdata(pdev, (void *)sp);
  92         sp->dev = &pdev->dev;
  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);
  96
  97         result = ibmasm_event_buffer_init(sp);
  98         if (result) {
  99                 dev_err(sp->dev, "Failed to allocate event buffer\n");
 100                 goto error_eventbuffer;
 101         }
 102
 103         result = ibmasm_heartbeat_init(sp);
 104         if (result) {
 105                 dev_err(sp->dev, "Failed to allocate heartbeat command\n");
 106                 goto error_heartbeat;
 107         }
 108
 109         sp->irq = pdev->irq;
 110         sp->base_address = pci_ioremap_bar(pdev, 0);
 111         if (!sp->base_address) {
 112                 dev_err(sp->dev, "Failed to ioremap pci memory\n");
 113                 result =  -ENODEV;
 114                 goto error_ioremap;
 115         }
 116
 117         result = request_irq(sp->irq, ibmasm_interrupt_handler, IRQF_SHARED, sp->devname, (void*)sp);
 118         if (result) {
 119                 dev_err(sp->dev, "Failed to register interrupt handler\n");
 120                 goto error_request_irq;
 121         }
 122
 123         enable_sp_interrupts(sp->base_address);
 124
 125         result = ibmasm_init_remote_input_dev(sp);
 126         if (result) {
 127                 dev_err(sp->dev, "Failed to initialize remote queue\n");
 128                 goto error_send_message;
 129         }
 130
 131         result = ibmasm_send_driver_vpd(sp);
 132         if (result) {
 133                 dev_err(sp->dev, "Failed to send driver VPD to service processor\n");
 134                 goto error_send_message;
 135         }
 136         result = ibmasm_send_os_state(sp, SYSTEM_STATE_OS_UP);
 137         if (result) {
 138                 dev_err(sp->dev, "Failed to send OS state to service processor\n");
 139                 goto error_send_message;
 140         }
 141         ibmasmfs_add_sp(sp);
 142
 143         ibmasm_register_uart(sp);
 144
 145         return 0;
 146
 147 error_send_message:
 148         disable_sp_interrupts(sp->base_address);
 149         ibmasm_free_remote_input_dev(sp);
 150         free_irq(sp->irq, (void *)sp);
 151 error_request_irq:
 152         iounmap(sp->base_address);
 153 error_ioremap:
 154         ibmasm_heartbeat_exit(sp);
 155 error_heartbeat:
 156         ibmasm_event_buffer_exit(sp);
 157 error_eventbuffer:
 158         kfree(sp);
 159 error_kmalloc:
 160         pci_release_regions(pdev);
 161 error_resources:
 162         pci_disable_device(pdev);
 163
 164         return result;
 165 }
 166
 167 static void ibmasm_remove_one(struct pci_dev *pdev)
 168 {
 169         struct service_processor *sp = pci_get_drvdata(pdev);
 170
 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 response 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         kfree(sp);
 187         pci_release_regions(pdev);
 188         pci_disable_device(pdev);
 189 }
 190
 191 static struct pci_device_id ibmasm_pci_table[] =
 192 {
 193         { PCI_DEVICE(VENDORID_IBM, DEVICEID_RSA) },
 194         {},
 195 };
 196
 197 static struct pci_driver ibmasm_driver = {
 198         .name           = DRIVER_NAME,
 199         .id_table       = ibmasm_pci_table,
 200         .probe          = ibmasm_init_one,
 201         .remove         = ibmasm_remove_one,
 202 };
 203
 204 static void __exit ibmasm_exit (void)
 205 {
 206         ibmasm_unregister_panic_notifier();
 207         ibmasmfs_unregister();
 208         pci_unregister_driver(&ibmasm_driver);
 209         info(DRIVER_DESC " version " DRIVER_VERSION " unloaded");
 210 }
 211
 212 static int __init ibmasm_init(void)
 213 {
 214         int result = pci_register_driver(&ibmasm_driver);
 215         if (result)
 216                 return result;
 217
 218         result = ibmasmfs_register();
 219         if (result) {
 220                 pci_unregister_driver(&ibmasm_driver);
 221                 err("Failed to register ibmasmfs file system");
 222                 return result;
 223         }
 224
 225         ibmasm_register_panic_notifier();
 226         info(DRIVER_DESC " version " DRIVER_VERSION " loaded");
 227         return 0;
 228 }
 229
 230 module_init(ibmasm_init);
 231 module_exit(ibmasm_exit);
 232
 233 MODULE_AUTHOR(DRIVER_AUTHOR);
 234 MODULE_DESCRIPTION(DRIVER_DESC);
 235 MODULE_LICENSE("GPL");
 236 MODULE_DEVICE_TABLE(pci, ibmasm_pci_table);
 237