xref: /openbmc/linux/drivers/scsi/ibmvscsi/ibmvscsi.h (revision 293d5b43)
1 /* ------------------------------------------------------------
2  * ibmvscsi.h
3  * (C) Copyright IBM Corporation 1994, 2003
4  * Authors: Colin DeVilbiss (devilbis@us.ibm.com)
5  *          Santiago Leon (santil@us.ibm.com)
6  *          Dave Boutcher (sleddog@us.ibm.com)
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
21  * USA
22  *
23  * ------------------------------------------------------------
24  * Emulation of a SCSI host adapter for Virtual I/O devices
25  *
26  * This driver allows the Linux SCSI peripheral drivers to directly
27  * access devices in the hosting partition, either on an iSeries
28  * hypervisor system or a converged hypervisor system.
29  */
30 #ifndef IBMVSCSI_H
31 #define IBMVSCSI_H
32 #include <linux/types.h>
33 #include <linux/list.h>
34 #include <linux/completion.h>
35 #include <linux/interrupt.h>
36 #include <scsi/viosrp.h>
37 
38 struct scsi_cmnd;
39 struct Scsi_Host;
40 
41 /* Number of indirect bufs...the list of these has to fit in the
42  * additional data of the srp_cmd struct along with the indirect
43  * descriptor
44  */
45 #define MAX_INDIRECT_BUFS 10
46 
47 #define IBMVSCSI_MAX_REQUESTS_DEFAULT 100
48 #define IBMVSCSI_CMDS_PER_LUN_DEFAULT 16
49 #define IBMVSCSI_MAX_SECTORS_DEFAULT 256 /* 32 * 8 = default max I/O 32 pages */
50 #define IBMVSCSI_MAX_CMDS_PER_LUN 64
51 #define IBMVSCSI_MAX_LUN 32
52 
53 /* ------------------------------------------------------------
54  * Data Structures
55  */
56 /* an RPA command/response transport queue */
57 struct crq_queue {
58 	struct viosrp_crq *msgs;
59 	int size, cur;
60 	dma_addr_t msg_token;
61 	spinlock_t lock;
62 };
63 
64 /* a unit of work for the hosting partition */
65 struct srp_event_struct {
66 	union viosrp_iu *xfer_iu;
67 	struct scsi_cmnd *cmnd;
68 	struct list_head list;
69 	void (*done) (struct srp_event_struct *);
70 	struct viosrp_crq crq;
71 	struct ibmvscsi_host_data *hostdata;
72 	atomic_t free;
73 	union viosrp_iu iu;
74 	void (*cmnd_done) (struct scsi_cmnd *);
75 	struct completion comp;
76 	struct timer_list timer;
77 	union viosrp_iu *sync_srp;
78 	struct srp_direct_buf *ext_list;
79 	dma_addr_t ext_list_token;
80 };
81 
82 /* a pool of event structs for use */
83 struct event_pool {
84 	struct srp_event_struct *events;
85 	u32 size;
86 	int next;
87 	union viosrp_iu *iu_storage;
88 	dma_addr_t iu_token;
89 };
90 
91 /* all driver data associated with a host adapter */
92 struct ibmvscsi_host_data {
93 	atomic_t request_limit;
94 	int client_migrated;
95 	int reset_crq;
96 	int reenable_crq;
97 	struct device *dev;
98 	struct event_pool pool;
99 	struct crq_queue queue;
100 	struct tasklet_struct srp_task;
101 	struct list_head sent;
102 	struct Scsi_Host *host;
103 	struct task_struct *work_thread;
104 	wait_queue_head_t work_wait_q;
105 	struct mad_adapter_info_data madapter_info;
106 	struct capabilities caps;
107 	dma_addr_t caps_addr;
108 	dma_addr_t adapter_info_addr;
109 };
110 
111 #endif				/* IBMVSCSI_H */
112