blob: 02197a2b22b9e7fc52c2238f4b2a1f3b76743320 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* ------------------------------------------------------------
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 "viosrp.h"
37
38struct scsi_cmnd;
39struct 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
Robert Jenningsa897ff22007-03-28 12:45:46 -050047#define IBMVSCSI_MAX_REQUESTS_DEFAULT 100
Robert Jennings7912a0a2008-07-24 04:35:27 +100048#define IBMVSCSI_CMDS_PER_LUN_DEFAULT 16
49#define IBMVSCSI_MAX_SECTORS_DEFAULT 256 /* 32 * 8 = default max I/O 32 pages */
Brian King742d25b2007-05-29 15:46:14 -050050#define IBMVSCSI_MAX_CMDS_PER_LUN 64
Robert Jenningsa897ff22007-03-28 12:45:46 -050051
Linus Torvalds1da177e2005-04-16 15:20:36 -070052/* ------------------------------------------------------------
53 * Data Structures
54 */
55/* an RPA command/response transport queue */
56struct crq_queue {
57 struct viosrp_crq *msgs;
58 int size, cur;
59 dma_addr_t msg_token;
60 spinlock_t lock;
61};
62
63/* a unit of work for the hosting partition */
64struct srp_event_struct {
65 union viosrp_iu *xfer_iu;
66 struct scsi_cmnd *cmnd;
67 struct list_head list;
68 void (*done) (struct srp_event_struct *);
69 struct viosrp_crq crq;
70 struct ibmvscsi_host_data *hostdata;
71 atomic_t free;
72 union viosrp_iu iu;
73 void (*cmnd_done) (struct scsi_cmnd *);
74 struct completion comp;
Brian King3d0e91f2007-06-13 17:12:26 -050075 struct timer_list timer;
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 union viosrp_iu *sync_srp;
FUJITA Tomonorief265672006-03-26 03:57:14 +090077 struct srp_direct_buf *ext_list;
James Bottomley4dddbc22005-09-06 17:11:54 -050078 dma_addr_t ext_list_token;
Linus Torvalds1da177e2005-04-16 15:20:36 -070079};
80
81/* a pool of event structs for use */
82struct event_pool {
83 struct srp_event_struct *events;
84 u32 size;
85 int next;
86 union viosrp_iu *iu_storage;
87 dma_addr_t iu_token;
88};
89
90/* all driver data associated with a host adapter */
91struct ibmvscsi_host_data {
92 atomic_t request_limit;
Brian King126c5cc2009-06-08 16:19:08 -050093 int client_migrated;
Brian King0f33ece2010-06-17 13:56:00 -050094 int reset_crq;
95 int reenable_crq;
Linus Torvalds1da177e2005-04-16 15:20:36 -070096 struct device *dev;
97 struct event_pool pool;
98 struct crq_queue queue;
99 struct tasklet_struct srp_task;
100 struct list_head sent;
101 struct Scsi_Host *host;
Brian King0f33ece2010-06-17 13:56:00 -0500102 struct task_struct *work_thread;
103 wait_queue_head_t work_wait_q;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 struct mad_adapter_info_data madapter_info;
Brian King126c5cc2009-06-08 16:19:08 -0500105 struct capabilities caps;
106 dma_addr_t caps_addr;
107 dma_addr_t adapter_info_addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108};
109
110/* routines for managing a command/response queue */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111void ibmvscsi_handle_crq(struct viosrp_crq *crq,
112 struct ibmvscsi_host_data *hostdata);
David Woodhoused3849d52007-09-22 08:29:36 +1000113
114struct ibmvscsi_ops {
115 int (*init_crq_queue)(struct crq_queue *queue,
116 struct ibmvscsi_host_data *hostdata,
117 int max_requests);
118 void (*release_crq_queue)(struct crq_queue *queue,
119 struct ibmvscsi_host_data *hostdata,
120 int max_requests);
121 int (*reset_crq_queue)(struct crq_queue *queue,
122 struct ibmvscsi_host_data *hostdata);
123 int (*reenable_crq_queue)(struct crq_queue *queue,
124 struct ibmvscsi_host_data *hostdata);
125 int (*send_crq)(struct ibmvscsi_host_data *hostdata,
126 u64 word1, u64 word2);
Brian King64355b92010-02-21 10:37:57 -0600127 int (*resume) (struct ibmvscsi_host_data *hostdata);
David Woodhoused3849d52007-09-22 08:29:36 +1000128};
129
130extern struct ibmvscsi_ops iseriesvscsi_ops;
131extern struct ibmvscsi_ops rpavscsi_ops;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
133#endif /* IBMVSCSI_H */