[mirror_ubuntu-hirsute-kernel.git] / drivers / scsi / ibmvscsi / ibmvscsi.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/* ------------------------------------------------------------
 * ibmvscsi.h
 * (C) Copyright IBM Corporation 1994, 2003
 * Authors: Colin DeVilbiss (devilbis@us.ibm.com)
 *          Santiago Leon (santil@us.ibm.com)
 *          Dave Boutcher (sleddog@us.ibm.com)
 *
 * ------------------------------------------------------------
 * Emulation of a SCSI host adapter for Virtual I/O devices
 *
 * This driver allows the Linux SCSI peripheral drivers to directly
 * access devices in the hosting partition, either on an iSeries
 * hypervisor system or a converged hypervisor system.
 */
#ifndef IBMVSCSI_H
#define IBMVSCSI_H
#include <linux/types.h>
#include <linux/list.h>
#include <linux/completion.h>
#include <linux/interrupt.h>
#include <scsi/viosrp.h>

struct scsi_cmnd;
struct Scsi_Host;

/* Number of indirect bufs...the list of these has to fit in the
 * additional data of the srp_cmd struct along with the indirect
 * descriptor
 */
#define MAX_INDIRECT_BUFS 10

#define IBMVSCSI_MAX_REQUESTS_DEFAULT 100
#define IBMVSCSI_CMDS_PER_LUN_DEFAULT 16
#define IBMVSCSI_MAX_SECTORS_DEFAULT 256 /* 32 * 8 = default max I/O 32 pages */
#define IBMVSCSI_MAX_CMDS_PER_LUN 64
#define IBMVSCSI_MAX_LUN 32

/* ------------------------------------------------------------
 * Data Structures
 */
/* an RPA command/response transport queue */
struct crq_queue {
	struct viosrp_crq *msgs;
	int size, cur;
	dma_addr_t msg_token;
	spinlock_t lock;
};

/* a unit of work for the hosting partition */
struct srp_event_struct {
	union viosrp_iu *xfer_iu;
	struct scsi_cmnd *cmnd;
	struct list_head list;
	void (*done) (struct srp_event_struct *);
	struct viosrp_crq crq;
	struct ibmvscsi_host_data *hostdata;
	atomic_t free;
	union viosrp_iu iu;
	void (*cmnd_done) (struct scsi_cmnd *);
	struct completion comp;
	struct timer_list timer;
	union viosrp_iu *sync_srp;
	struct srp_direct_buf *ext_list;
	dma_addr_t ext_list_token;
};

/* a pool of event structs for use */
struct event_pool {
	struct srp_event_struct *events;
	u32 size;
	int next;
	union viosrp_iu *iu_storage;
	dma_addr_t iu_token;
};

/* all driver data associated with a host adapter */
struct ibmvscsi_host_data {
	struct list_head host_list;
	atomic_t request_limit;
	int client_migrated;
	int reset_crq;
	int reenable_crq;
	struct device *dev;
	struct event_pool pool;
	struct crq_queue queue;
	struct tasklet_struct srp_task;
	struct list_head sent;
	struct Scsi_Host *host;
	struct task_struct *work_thread;
	wait_queue_head_t work_wait_q;
	struct mad_adapter_info_data madapter_info;
	struct capabilities caps;
	dma_addr_t caps_addr;
	dma_addr_t adapter_info_addr;
};

#endif				/* IBMVSCSI_H */
Commit	Line	Data
1a59d1b8	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4 LT	2	/* ------------------------------------------------------------
	3	* ibmvscsi.h
	4	* (C) Copyright IBM Corporation 1994, 2003
	5	* Authors: Colin DeVilbiss (devilbis@us.ibm.com)
	6	* Santiago Leon (santil@us.ibm.com)
	7	* Dave Boutcher (sleddog@us.ibm.com)
	8	*
1da177e4 LT	9	* ------------------------------------------------------------
	10	* Emulation of a SCSI host adapter for Virtual I/O devices
	11	*
	12	* This driver allows the Linux SCSI peripheral drivers to directly
	13	* access devices in the hosting partition, either on an iSeries
	14	* hypervisor system or a converged hypervisor system.
	15	*/
	16	#ifndef IBMVSCSI_H
	17	#define IBMVSCSI_H
	18	#include <linux/types.h>
	19	#include <linux/list.h>
	20	#include <linux/completion.h>
	21	#include <linux/interrupt.h>
88a678bb	22	#include <scsi/viosrp.h>
1da177e4 LT	23
	24	struct scsi_cmnd;
	25	struct Scsi_Host;
	26
	27	/* Number of indirect bufs...the list of these has to fit in the
	28	* additional data of the srp_cmd struct along with the indirect
	29	* descriptor
	30	*/
	31	#define MAX_INDIRECT_BUFS 10
	32
a897ff2a	33	#define IBMVSCSI_MAX_REQUESTS_DEFAULT 100
7912a0ac RJ	34	#define IBMVSCSI_CMDS_PER_LUN_DEFAULT 16
7912a0ac RJ	35	#define IBMVSCSI_MAX_SECTORS_DEFAULT 256 /* 32 * 8 = default max I/O 32 pages */
742d25b8	36	#define IBMVSCSI_MAX_CMDS_PER_LUN 64
3467a146	37	#define IBMVSCSI_MAX_LUN 32
a897ff2a	38
1da177e4 LT	39	/* ------------------------------------------------------------
	40	* Data Structures
	41	*/
	42	/* an RPA command/response transport queue */
	43	struct crq_queue {
	44	struct viosrp_crq *msgs;
	45	int size, cur;
	46	dma_addr_t msg_token;
	47	spinlock_t lock;
	48	};
	49
	50	/* a unit of work for the hosting partition */
	51	struct srp_event_struct {
	52	union viosrp_iu *xfer_iu;
	53	struct scsi_cmnd *cmnd;
	54	struct list_head list;
	55	void (done) (struct srp_event_struct );
	56	struct viosrp_crq crq;
	57	struct ibmvscsi_host_data *hostdata;
	58	atomic_t free;
	59	union viosrp_iu iu;
	60	void (cmnd_done) (struct scsi_cmnd );
	61	struct completion comp;
3d0e91f7	62	struct timer_list timer;
1da177e4	63	union viosrp_iu *sync_srp;
ef265673	64	struct srp_direct_buf *ext_list;
4dddbc26	65	dma_addr_t ext_list_token;
1da177e4 LT	66	};
	67
	68	/* a pool of event structs for use */
	69	struct event_pool {
	70	struct srp_event_struct *events;
	71	u32 size;
	72	int next;
	73	union viosrp_iu *iu_storage;
	74	dma_addr_t iu_token;
	75	};
	76
	77	/* all driver data associated with a host adapter */
	78	struct ibmvscsi_host_data {
32d6e4b6	79	struct list_head host_list;
1da177e4	80	atomic_t request_limit;
126c5cc3	81	int client_migrated;
0f33ece5 BK	82	int reset_crq;
0f33ece5 BK	83	int reenable_crq;
1da177e4 LT	84	struct device *dev;
	85	struct event_pool pool;
	86	struct crq_queue queue;
	87	struct tasklet_struct srp_task;
	88	struct list_head sent;
	89	struct Scsi_Host *host;
0f33ece5 BK	90	struct task_struct *work_thread;
0f33ece5 BK	91	wait_queue_head_t work_wait_q;
1da177e4	92	struct mad_adapter_info_data madapter_info;
126c5cc3 BK	93	struct capabilities caps;
	94	dma_addr_t caps_addr;
	95	dma_addr_t adapter_info_addr;
1da177e4 LT	96	};
1da177e4 LT	97
1da177e4	98	#endif /* IBMVSCSI_H */