drivers/s390/scsi/zfcp_ccw.c

   1 /*
   2  * This file is part of the zfcp device driver for
   3  * FCP adapters for IBM System z9 and zSeries.
   4  *
   5  * (C) Copyright IBM Corp. 2002, 2006
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2, or (at your option)
  10  * any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  20  */
  21
  22 #include "zfcp_ext.h"
  23
  24 #define ZFCP_LOG_AREA                   ZFCP_LOG_AREA_CONFIG
  25
  26 static int zfcp_ccw_probe(struct ccw_device *);
  27 static void zfcp_ccw_remove(struct ccw_device *);
  28 static int zfcp_ccw_set_online(struct ccw_device *);
  29 static int zfcp_ccw_set_offline(struct ccw_device *);
  30 static int zfcp_ccw_notify(struct ccw_device *, int);
  31 static void zfcp_ccw_shutdown(struct device *);
  32
  33 static struct ccw_device_id zfcp_ccw_device_id[] = {
  34         {CCW_DEVICE_DEVTYPE(ZFCP_CONTROL_UNIT_TYPE,
  35                             ZFCP_CONTROL_UNIT_MODEL,
  36                             ZFCP_DEVICE_TYPE,
  37                             ZFCP_DEVICE_MODEL)},
  38         {CCW_DEVICE_DEVTYPE(ZFCP_CONTROL_UNIT_TYPE,
  39                             ZFCP_CONTROL_UNIT_MODEL,
  40                             ZFCP_DEVICE_TYPE,
  41                             ZFCP_DEVICE_MODEL_PRIV)},
  42         {},
  43 };
  44
  45 static struct ccw_driver zfcp_ccw_driver = {
  46         .owner       = THIS_MODULE,
  47         .name        = ZFCP_NAME,
  48         .ids         = zfcp_ccw_device_id,
  49         .probe       = zfcp_ccw_probe,
  50         .remove      = zfcp_ccw_remove,
  51         .set_online  = zfcp_ccw_set_online,
  52         .set_offline = zfcp_ccw_set_offline,
  53         .notify      = zfcp_ccw_notify,
  54         .driver      = {
  55                 .shutdown = zfcp_ccw_shutdown,
  56         },
  57 };
  58
  59 MODULE_DEVICE_TABLE(ccw, zfcp_ccw_device_id);
  60
  61 /**
  62  * zfcp_ccw_probe - probe function of zfcp driver
  63  * @ccw_device: pointer to belonging ccw device
  64  *
  65  * This function gets called by the common i/o layer and sets up the initial
  66  * data structures for each fcp adapter, which was detected by the system.
  67  * Also the sysfs files for this adapter will be created by this function.
  68  * In addition the nameserver port will be added to the ports of the adapter
  69  * and its sysfs representation will be created too.
  70  */
  71 static int
  72 zfcp_ccw_probe(struct ccw_device *ccw_device)
  73 {
  74         struct zfcp_adapter *adapter;
  75         int retval = 0;
  76
  77         down(&zfcp_data.config_sema);
  78         adapter = zfcp_adapter_enqueue(ccw_device);
  79         if (!adapter)
  80                 retval = -EINVAL;
  81         else
  82                 ZFCP_LOG_DEBUG("Probed adapter %s\n",
  83                                zfcp_get_busid_by_adapter(adapter));
  84         up(&zfcp_data.config_sema);
  85         return retval;
  86 }
  87
  88 /**
  89  * zfcp_ccw_remove - remove function of zfcp driver
  90  * @ccw_device: pointer to belonging ccw device
  91  *
  92  * This function gets called by the common i/o layer and removes an adapter
  93  * from the system. Task of this function is to get rid of all units and
  94  * ports that belong to this adapter. And in addition all resources of this
  95  * adapter will be freed too.
  96  */
  97 static void
  98 zfcp_ccw_remove(struct ccw_device *ccw_device)
  99 {
 100         struct zfcp_adapter *adapter;
 101         struct zfcp_port *port, *p;
 102         struct zfcp_unit *unit, *u;
 103
 104         ccw_device_set_offline(ccw_device);
 105         down(&zfcp_data.config_sema);
 106         adapter = dev_get_drvdata(&ccw_device->dev);
 107
 108         ZFCP_LOG_DEBUG("Removing adapter %s\n",
 109                        zfcp_get_busid_by_adapter(adapter));
 110         write_lock_irq(&zfcp_data.config_lock);
 111         list_for_each_entry_safe(port, p, &adapter->port_list_head, list) {
 112                 list_for_each_entry_safe(unit, u, &port->unit_list_head, list) {
 113                         list_move(&unit->list, &port->unit_remove_lh);
 114                         atomic_set_mask(ZFCP_STATUS_COMMON_REMOVE,
 115                                         &unit->status);
 116                 }
 117                 list_move(&port->list, &adapter->port_remove_lh);
 118                 atomic_set_mask(ZFCP_STATUS_COMMON_REMOVE, &port->status);
 119         }
 120         atomic_set_mask(ZFCP_STATUS_COMMON_REMOVE, &adapter->status);
 121         write_unlock_irq(&zfcp_data.config_lock);
 122
 123         list_for_each_entry_safe(port, p, &adapter->port_remove_lh, list) {
 124                 list_for_each_entry_safe(unit, u, &port->unit_remove_lh, list) {
 125                         zfcp_unit_dequeue(unit);
 126                 }
 127                 zfcp_port_dequeue(port);
 128         }
 129         zfcp_adapter_wait(adapter);
 130         zfcp_adapter_dequeue(adapter);
 131
 132         up(&zfcp_data.config_sema);
 133 }
 134
 135 /**
 136  * zfcp_ccw_set_online - set_online function of zfcp driver
 137  * @ccw_device: pointer to belonging ccw device
 138  *
 139  * This function gets called by the common i/o layer and sets an adapter
 140  * into state online. Setting an fcp device online means that it will be
 141  * registered with the SCSI stack, that the QDIO queues will be set up
 142  * and that the adapter will be opened (asynchronously).
 143  */
 144 static int
 145 zfcp_ccw_set_online(struct ccw_device *ccw_device)
 146 {
 147         struct zfcp_adapter *adapter;
 148         int retval;
 149
 150         down(&zfcp_data.config_sema);
 151         adapter = dev_get_drvdata(&ccw_device->dev);
 152
 153         retval = zfcp_adapter_debug_register(adapter);
 154         if (retval)
 155                 goto out;
 156         retval = zfcp_erp_thread_setup(adapter);
 157         if (retval) {
 158                 ZFCP_LOG_INFO("error: start of error recovery thread for "
 159                               "adapter %s failed\n",
 160                               zfcp_get_busid_by_adapter(adapter));
 161                 goto out_erp_thread;
 162         }
 163
 164         retval = zfcp_adapter_scsi_register(adapter);
 165         if (retval)
 166                 goto out_scsi_register;
 167
 168         /* initialize request counter */
 169         BUG_ON(!zfcp_reqlist_isempty(adapter));
 170         adapter->req_no = 0;
 171
 172         zfcp_erp_modify_adapter_status(adapter, ZFCP_STATUS_COMMON_RUNNING,
 173                                        ZFCP_SET);
 174         zfcp_erp_adapter_reopen(adapter, ZFCP_STATUS_COMMON_ERP_FAILED);
 175         zfcp_erp_wait(adapter);
 176         goto out;
 177
 178  out_scsi_register:
 179         zfcp_erp_thread_kill(adapter);
 180  out_erp_thread:
 181         zfcp_adapter_debug_unregister(adapter);
 182  out:
 183         up(&zfcp_data.config_sema);
 184         return retval;
 185 }
 186
 187 /**
 188  * zfcp_ccw_set_offline - set_offline function of zfcp driver
 189  * @ccw_device: pointer to belonging ccw device
 190  *
 191  * This function gets called by the common i/o layer and sets an adapter
 192  * into state offline. Setting an fcp device offline means that it will be
 193  * unregistered from the SCSI stack and that the adapter will be shut down
 194  * asynchronously.
 195  */
 196 static int
 197 zfcp_ccw_set_offline(struct ccw_device *ccw_device)
 198 {
 199         struct zfcp_adapter *adapter;
 200
 201         down(&zfcp_data.config_sema);
 202         adapter = dev_get_drvdata(&ccw_device->dev);
 203         zfcp_erp_adapter_shutdown(adapter, 0);
 204         zfcp_erp_wait(adapter);
 205         zfcp_adapter_scsi_unregister(adapter);
 206         zfcp_erp_thread_kill(adapter);
 207         zfcp_adapter_debug_unregister(adapter);
 208         up(&zfcp_data.config_sema);
 209         return 0;
 210 }
 211
 212 /**
 213  * zfcp_ccw_notify
 214  * @ccw_device: pointer to belonging ccw device
 215  * @event: indicates if adapter was detached or attached
 216  *
 217  * This function gets called by the common i/o layer if an adapter has gone
 218  * or reappeared.
 219  */
 220 static int
 221 zfcp_ccw_notify(struct ccw_device *ccw_device, int event)
 222 {
 223         struct zfcp_adapter *adapter;
 224
 225         down(&zfcp_data.config_sema);
 226         adapter = dev_get_drvdata(&ccw_device->dev);
 227         switch (event) {
 228         case CIO_GONE:
 229                 ZFCP_LOG_NORMAL("adapter %s: device gone\n",
 230                                 zfcp_get_busid_by_adapter(adapter));
 231                 debug_text_event(adapter->erp_dbf,1,"dev_gone");
 232                 zfcp_erp_adapter_shutdown(adapter, 0);
 233                 break;
 234         case CIO_NO_PATH:
 235                 ZFCP_LOG_NORMAL("adapter %s: no path\n",
 236                                 zfcp_get_busid_by_adapter(adapter));
 237                 debug_text_event(adapter->erp_dbf,1,"no_path");
 238                 zfcp_erp_adapter_shutdown(adapter, 0);
 239                 break;
 240         case CIO_OPER:
 241                 ZFCP_LOG_NORMAL("adapter %s: operational again\n",
 242                                 zfcp_get_busid_by_adapter(adapter));
 243                 debug_text_event(adapter->erp_dbf,1,"dev_oper");
 244                 zfcp_erp_modify_adapter_status(adapter,
 245                                                ZFCP_STATUS_COMMON_RUNNING,
 246                                                ZFCP_SET);
 247                 zfcp_erp_adapter_reopen(adapter,
 248                                         ZFCP_STATUS_COMMON_ERP_FAILED);
 249                 break;
 250         }
 251         zfcp_erp_wait(adapter);
 252         up(&zfcp_data.config_sema);
 253         return 1;
 254 }
 255
 256 /**
 257  * zfcp_ccw_register - ccw register function
 258  *
 259  * Registers the driver at the common i/o layer. This function will be called
 260  * at module load time/system start.
 261  */
 262 int __init
 263 zfcp_ccw_register(void)
 264 {
 265         int retval;
 266
 267         retval = ccw_driver_register(&zfcp_ccw_driver);
 268         if (retval)
 269                 goto out;
 270         retval = zfcp_sysfs_driver_create_files(&zfcp_ccw_driver.driver);
 271         if (retval)
 272                 ccw_driver_unregister(&zfcp_ccw_driver);
 273  out:
 274         return retval;
 275 }
 276
 277 /**
 278  * zfcp_ccw_unregister - ccw unregister function
 279  *
 280  * Unregisters the driver from common i/o layer. Function will be called at
 281  * module unload/system shutdown.
 282  */
 283 void __exit
 284 zfcp_ccw_unregister(void)
 285 {
 286         zfcp_sysfs_driver_remove_files(&zfcp_ccw_driver.driver);
 287         ccw_driver_unregister(&zfcp_ccw_driver);
 288 }
 289
 290 /**
 291  * zfcp_ccw_shutdown - gets called on reboot/shutdown
 292  *
 293  * Makes sure that QDIO queues are down when the system gets stopped.
 294  */
 295 static void
 296 zfcp_ccw_shutdown(struct device *dev)
 297 {
 298         struct zfcp_adapter *adapter;
 299
 300         down(&zfcp_data.config_sema);
 301         adapter = dev_get_drvdata(dev);
 302         zfcp_erp_adapter_shutdown(adapter, 0);
 303         zfcp_erp_wait(adapter);
 304         up(&zfcp_data.config_sema);
 305 }
 306
 307 #undef ZFCP_LOG_AREA