[deliverable/linux.git] / drivers / s390 / scsi / zfcp_ccw.c

/*
 * This file is part of the zfcp device driver for
 * FCP adapters for IBM System z9 and zSeries.
 *
 * (C) Copyright IBM Corp. 2002, 2006
 *
 * 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; 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., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include "zfcp_ext.h"

#define ZFCP_LOG_AREA                   ZFCP_LOG_AREA_CONFIG

static int zfcp_ccw_probe(struct ccw_device *);
static void zfcp_ccw_remove(struct ccw_device *);
static int zfcp_ccw_set_online(struct ccw_device *);
static int zfcp_ccw_set_offline(struct ccw_device *);
static int zfcp_ccw_notify(struct ccw_device *, int);
static void zfcp_ccw_shutdown(struct device *);

static struct ccw_device_id zfcp_ccw_device_id[] = {
	{CCW_DEVICE_DEVTYPE(ZFCP_CONTROL_UNIT_TYPE,
			    ZFCP_CONTROL_UNIT_MODEL,
			    ZFCP_DEVICE_TYPE,
			    ZFCP_DEVICE_MODEL)},
	{CCW_DEVICE_DEVTYPE(ZFCP_CONTROL_UNIT_TYPE,
			    ZFCP_CONTROL_UNIT_MODEL,
			    ZFCP_DEVICE_TYPE,
			    ZFCP_DEVICE_MODEL_PRIV)},
	{},
};

static struct ccw_driver zfcp_ccw_driver = {
	.owner       = THIS_MODULE,
	.name        = ZFCP_NAME,
	.ids         = zfcp_ccw_device_id,
	.probe       = zfcp_ccw_probe,
	.remove      = zfcp_ccw_remove,
	.set_online  = zfcp_ccw_set_online,
	.set_offline = zfcp_ccw_set_offline,
	.notify      = zfcp_ccw_notify,
	.driver      = {
		.shutdown = zfcp_ccw_shutdown,
	},
};

MODULE_DEVICE_TABLE(ccw, zfcp_ccw_device_id);

/**
 * zfcp_ccw_probe - probe function of zfcp driver
 * @ccw_device: pointer to belonging ccw device
 *
 * This function gets called by the common i/o layer and sets up the initial
 * data structures for each fcp adapter, which was detected by the system.
 * Also the sysfs files for this adapter will be created by this function.
 * In addition the nameserver port will be added to the ports of the adapter
 * and its sysfs representation will be created too.
 */
static int
zfcp_ccw_probe(struct ccw_device *ccw_device)
{
	struct zfcp_adapter *adapter;
	int retval = 0;

	down(&zfcp_data.config_sema);
	adapter = zfcp_adapter_enqueue(ccw_device);
	if (!adapter)
		retval = -EINVAL;
	else
		ZFCP_LOG_DEBUG("Probed adapter %s\n",
			       zfcp_get_busid_by_adapter(adapter));
	up(&zfcp_data.config_sema);
	return retval;
}

/**
 * zfcp_ccw_remove - remove function of zfcp driver
 * @ccw_device: pointer to belonging ccw device
 *
 * This function gets called by the common i/o layer and removes an adapter
 * from the system. Task of this function is to get rid of all units and
 * ports that belong to this adapter. And in addition all resources of this
 * adapter will be freed too.
 */
static void
zfcp_ccw_remove(struct ccw_device *ccw_device)
{
	struct zfcp_adapter *adapter;
	struct zfcp_port *port, *p;
	struct zfcp_unit *unit, *u;

	ccw_device_set_offline(ccw_device);
	down(&zfcp_data.config_sema);
	adapter = dev_get_drvdata(&ccw_device->dev);

	ZFCP_LOG_DEBUG("Removing adapter %s\n",
		       zfcp_get_busid_by_adapter(adapter));
	write_lock_irq(&zfcp_data.config_lock);
	list_for_each_entry_safe(port, p, &adapter->port_list_head, list) {
		list_for_each_entry_safe(unit, u, &port->unit_list_head, list) {
			list_move(&unit->list, &port->unit_remove_lh);
			atomic_set_mask(ZFCP_STATUS_COMMON_REMOVE,
					&unit->status);
		}
		list_move(&port->list, &adapter->port_remove_lh);
		atomic_set_mask(ZFCP_STATUS_COMMON_REMOVE, &port->status);
	}
	atomic_set_mask(ZFCP_STATUS_COMMON_REMOVE, &adapter->status);
	write_unlock_irq(&zfcp_data.config_lock);

	list_for_each_entry_safe(port, p, &adapter->port_remove_lh, list) {
		list_for_each_entry_safe(unit, u, &port->unit_remove_lh, list) {
			zfcp_unit_dequeue(unit);
		}
		zfcp_port_dequeue(port);
	}
	zfcp_adapter_wait(adapter);
	zfcp_adapter_dequeue(adapter);

	up(&zfcp_data.config_sema);
}

/**
 * zfcp_ccw_set_online - set_online function of zfcp driver
 * @ccw_device: pointer to belonging ccw device
 *
 * This function gets called by the common i/o layer and sets an adapter
 * into state online. Setting an fcp device online means that it will be
 * registered with the SCSI stack, that the QDIO queues will be set up
 * and that the adapter will be opened (asynchronously).
 */
static int
zfcp_ccw_set_online(struct ccw_device *ccw_device)
{
	struct zfcp_adapter *adapter;
	int retval;

	down(&zfcp_data.config_sema);
	adapter = dev_get_drvdata(&ccw_device->dev);

	retval = zfcp_adapter_debug_register(adapter);
	if (retval)
		goto out;
	retval = zfcp_erp_thread_setup(adapter);
	if (retval) {
		ZFCP_LOG_INFO("error: start of error recovery thread for "
			      "adapter %s failed\n",
			      zfcp_get_busid_by_adapter(adapter));
		goto out_erp_thread;
	}

	retval = zfcp_adapter_scsi_register(adapter);
	if (retval)
		goto out_scsi_register;
	zfcp_erp_modify_adapter_status(adapter, ZFCP_STATUS_COMMON_RUNNING,
				       ZFCP_SET);
	zfcp_erp_adapter_reopen(adapter, ZFCP_STATUS_COMMON_ERP_FAILED);
	zfcp_erp_wait(adapter);
	goto out;

 out_scsi_register:
	zfcp_erp_thread_kill(adapter);
 out_erp_thread:
	zfcp_adapter_debug_unregister(adapter);
 out:
	up(&zfcp_data.config_sema);
	return retval;
}

/**
 * zfcp_ccw_set_offline - set_offline function of zfcp driver
 * @ccw_device: pointer to belonging ccw device
 *
 * This function gets called by the common i/o layer and sets an adapter
 * into state offline. Setting an fcp device offline means that it will be
 * unregistered from the SCSI stack and that the adapter will be shut down
 * asynchronously.
 */
static int
zfcp_ccw_set_offline(struct ccw_device *ccw_device)
{
	struct zfcp_adapter *adapter;

	down(&zfcp_data.config_sema);
	adapter = dev_get_drvdata(&ccw_device->dev);
	zfcp_erp_adapter_shutdown(adapter, 0);
	zfcp_erp_wait(adapter);
	zfcp_adapter_scsi_unregister(adapter);
	zfcp_erp_thread_kill(adapter);
	zfcp_adapter_debug_unregister(adapter);
	up(&zfcp_data.config_sema);
	return 0;
}

/**
 * zfcp_ccw_notify
 * @ccw_device: pointer to belonging ccw device
 * @event: indicates if adapter was detached or attached
 *
 * This function gets called by the common i/o layer if an adapter has gone
 * or reappeared.
 */
static int
zfcp_ccw_notify(struct ccw_device *ccw_device, int event)
{
	struct zfcp_adapter *adapter;

	down(&zfcp_data.config_sema);
	adapter = dev_get_drvdata(&ccw_device->dev);
	switch (event) {
	case CIO_GONE:
		ZFCP_LOG_NORMAL("adapter %s: device gone\n",
				zfcp_get_busid_by_adapter(adapter));
		debug_text_event(adapter->erp_dbf,1,"dev_gone");
		zfcp_erp_adapter_shutdown(adapter, 0);
		break;
	case CIO_NO_PATH:
		ZFCP_LOG_NORMAL("adapter %s: no path\n",
				zfcp_get_busid_by_adapter(adapter));
		debug_text_event(adapter->erp_dbf,1,"no_path");
		zfcp_erp_adapter_shutdown(adapter, 0);
		break;
	case CIO_OPER:
		ZFCP_LOG_NORMAL("adapter %s: operational again\n",
				zfcp_get_busid_by_adapter(adapter));
		debug_text_event(adapter->erp_dbf,1,"dev_oper");
		zfcp_erp_modify_adapter_status(adapter,
					       ZFCP_STATUS_COMMON_RUNNING,
					       ZFCP_SET);
		zfcp_erp_adapter_reopen(adapter,
					ZFCP_STATUS_COMMON_ERP_FAILED);
		break;
	}
	zfcp_erp_wait(adapter);
	up(&zfcp_data.config_sema);
	return 1;
}

/**
 * zfcp_ccw_register - ccw register function
 *
 * Registers the driver at the common i/o layer. This function will be called
 * at module load time/system start.
 */
int __init
zfcp_ccw_register(void)
{
	int retval;

	retval = ccw_driver_register(&zfcp_ccw_driver);
	if (retval)
		goto out;
	retval = zfcp_sysfs_driver_create_files(&zfcp_ccw_driver.driver);
	if (retval)
		ccw_driver_unregister(&zfcp_ccw_driver);
 out:
	return retval;
}

/**
 * zfcp_ccw_unregister - ccw unregister function
 *
 * Unregisters the driver from common i/o layer. Function will be called at
 * module unload/system shutdown.
 */
void __exit
zfcp_ccw_unregister(void)
{
	zfcp_sysfs_driver_remove_files(&zfcp_ccw_driver.driver);
	ccw_driver_unregister(&zfcp_ccw_driver);
}

/**
 * zfcp_ccw_shutdown - gets called on reboot/shutdown
 *
 * Makes sure that QDIO queues are down when the system gets stopped.
 */
static void
zfcp_ccw_shutdown(struct device *dev)
{
	struct zfcp_adapter *adapter;

	down(&zfcp_data.config_sema);
	adapter = dev_get_drvdata(dev);
	zfcp_erp_adapter_shutdown(adapter, 0);
	zfcp_erp_wait(adapter);
	up(&zfcp_data.config_sema);
}

#undef ZFCP_LOG_AREA
Commit	Line	Data
1da177e4	1	/*
4a9d2d8b AH	2	* This file is part of the zfcp device driver for
4a9d2d8b AH	3	* FCP adapters for IBM System z9 and zSeries.
1da177e4	4	*
4a9d2d8b	5	* (C) Copyright IBM Corp. 2002, 2006
1da177e4 LT	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
1da177e4 LT	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	zfcp_erp_modify_adapter_status(adapter, ZFCP_STATUS_COMMON_RUNNING,
168	ZFCP_SET);
169	zfcp_erp_adapter_reopen(adapter, ZFCP_STATUS_COMMON_ERP_FAILED);
170	zfcp_erp_wait(adapter);
171	goto out;
172
173	out_scsi_register:
174	zfcp_erp_thread_kill(adapter);
175	out_erp_thread:
176	zfcp_adapter_debug_unregister(adapter);
177	out:
178	up(&zfcp_data.config_sema);
179	return retval;
180	}
181
182	/**
183	* zfcp_ccw_set_offline - set_offline function of zfcp driver
184	* @ccw_device: pointer to belonging ccw device
185	*
186	* This function gets called by the common i/o layer and sets an adapter
187	* into state offline. Setting an fcp device offline means that it will be
188	* unregistered from the SCSI stack and that the adapter will be shut down
189	* asynchronously.
190	*/
191	static int
192	zfcp_ccw_set_offline(struct ccw_device *ccw_device)
193	{
194	struct zfcp_adapter *adapter;
195
196	down(&zfcp_data.config_sema);
197	adapter = dev_get_drvdata(&ccw_device->dev);
198	zfcp_erp_adapter_shutdown(adapter, 0);
199	zfcp_erp_wait(adapter);
200	zfcp_adapter_scsi_unregister(adapter);
201	zfcp_erp_thread_kill(adapter);
202	zfcp_adapter_debug_unregister(adapter);
203	up(&zfcp_data.config_sema);
204	return 0;
205	}
206
207	/**
208	* zfcp_ccw_notify
209	* @ccw_device: pointer to belonging ccw device
210	* @event: indicates if adapter was detached or attached
211	*
212	* This function gets called by the common i/o layer if an adapter has gone
213	* or reappeared.
214	*/
215	static int
216	zfcp_ccw_notify(struct ccw_device *ccw_device, int event)
217	{
218	struct zfcp_adapter *adapter;
219
220	down(&zfcp_data.config_sema);
221	adapter = dev_get_drvdata(&ccw_device->dev);
222	switch (event) {
223	case CIO_GONE:
224	ZFCP_LOG_NORMAL("adapter %s: device gone\n",
225	zfcp_get_busid_by_adapter(adapter));
226	debug_text_event(adapter->erp_dbf,1,"dev_gone");
227	zfcp_erp_adapter_shutdown(adapter, 0);
228	break;
229	case CIO_NO_PATH:
230	ZFCP_LOG_NORMAL("adapter %s: no path\n",
231	zfcp_get_busid_by_adapter(adapter));
232	debug_text_event(adapter->erp_dbf,1,"no_path");
233	zfcp_erp_adapter_shutdown(adapter, 0);
234	break;
235	case CIO_OPER:
236	ZFCP_LOG_NORMAL("adapter %s: operational again\n",
237	zfcp_get_busid_by_adapter(adapter));
238	debug_text_event(adapter->erp_dbf,1,"dev_oper");
239	zfcp_erp_modify_adapter_status(adapter,
240	ZFCP_STATUS_COMMON_RUNNING,
241	ZFCP_SET);
242	zfcp_erp_adapter_reopen(adapter,
243	ZFCP_STATUS_COMMON_ERP_FAILED);
244	break;
245	}
246	zfcp_erp_wait(adapter);
247	up(&zfcp_data.config_sema);
248	return 1;
249	}
250
251	/**
252	* zfcp_ccw_register - ccw register function
253	*
254	* Registers the driver at the common i/o layer. This function will be called
255	* at module load time/system start.
256	*/
257	int __init
258	zfcp_ccw_register(void)
259	{
260	int retval;
261
262	retval = ccw_driver_register(&zfcp_ccw_driver);
263	if (retval)
264	goto out;
265	retval = zfcp_sysfs_driver_create_files(&zfcp_ccw_driver.driver);
266	if (retval)
267	ccw_driver_unregister(&zfcp_ccw_driver);
268	out:
269	return retval;
270	}
271
272	/**
273	* zfcp_ccw_unregister - ccw unregister function
274	*
275	* Unregisters the driver from common i/o layer. Function will be called at
276	* module unload/system shutdown.
277	*/
278	void __exit
279	zfcp_ccw_unregister(void)
280	{
281	zfcp_sysfs_driver_remove_files(&zfcp_ccw_driver.driver);
282	ccw_driver_unregister(&zfcp_ccw_driver);
283	}
284
285	/**
286	* zfcp_ccw_shutdown - gets called on reboot/shutdown
287	*
288	* Makes sure that QDIO queues are down when the system gets stopped.
289	*/
290	static void
291	zfcp_ccw_shutdown(struct device *dev)
292	{
293	struct zfcp_adapter *adapter;
294
295	down(&zfcp_data.config_sema);
296	adapter = dev_get_drvdata(dev);
297	zfcp_erp_adapter_shutdown(adapter, 0);
298	zfcp_erp_wait(adapter);
299	up(&zfcp_data.config_sema);
300	}
301
302	#undef ZFCP_LOG_AREA