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 "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
47#define IBMVSCSI_MAX_REQUESTS_DEFAULT 100
48
49/* ------------------------------------------------------------
50 * Data Structures
51 */
52/* an RPA command/response transport queue */
53struct crq_queue {
54	struct viosrp_crq *msgs;
55	int size, cur;
56	dma_addr_t msg_token;
57	spinlock_t lock;
58};
59
60/* a unit of work for the hosting partition */
61struct srp_event_struct {
62	union viosrp_iu *xfer_iu;
63	struct scsi_cmnd *cmnd;
64	struct list_head list;
65	void (*done) (struct srp_event_struct *);
66	struct viosrp_crq crq;
67	struct ibmvscsi_host_data *hostdata;
68	atomic_t free;
69	union viosrp_iu iu;
70	void (*cmnd_done) (struct scsi_cmnd *);
71	struct completion comp;
72	union viosrp_iu *sync_srp;
73	struct srp_direct_buf *ext_list;
74	dma_addr_t ext_list_token;
75};
76
77/* a pool of event structs for use */
78struct event_pool {
79	struct srp_event_struct *events;
80	u32 size;
81	int next;
82	union viosrp_iu *iu_storage;
83	dma_addr_t iu_token;
84};
85
86/* all driver data associated with a host adapter */
87struct ibmvscsi_host_data {
88	atomic_t request_limit;
89	struct device *dev;
90	struct event_pool pool;
91	struct crq_queue queue;
92	struct tasklet_struct srp_task;
93	struct list_head sent;
94	struct Scsi_Host *host;
95	struct mad_adapter_info_data madapter_info;
96};
97
98/* routines for managing a command/response queue */
99int ibmvscsi_init_crq_queue(struct crq_queue *queue,
100			    struct ibmvscsi_host_data *hostdata,
101			    int max_requests);
102void ibmvscsi_release_crq_queue(struct crq_queue *queue,
103				struct ibmvscsi_host_data *hostdata,
104				int max_requests);
105int ibmvscsi_reset_crq_queue(struct crq_queue *queue,
106			      struct ibmvscsi_host_data *hostdata);
107
108int ibmvscsi_reenable_crq_queue(struct crq_queue *queue,
109				struct ibmvscsi_host_data *hostdata);
110
111void ibmvscsi_handle_crq(struct viosrp_crq *crq,
112			 struct ibmvscsi_host_data *hostdata);
113int ibmvscsi_send_crq(struct ibmvscsi_host_data *hostdata,
114		      u64 word1, u64 word2);
115
116#endif				/* IBMVSCSI_H */
117