3 * iSeries Virtual I/O Message Path header
5 * Authors: Dave Boutcher <boutcher@us.ibm.com>
6 * Ryan Arnold <ryanarn@us.ibm.com>
7 * Colin Devilbiss <devilbis@us.ibm.com>
9 * (C) Copyright 2000 IBM Corporation
11 * This header file is used by the iSeries virtual I/O device
12 * drivers. It defines the interfaces to the common functions
13 * (implemented in drivers/char/viopath.h) as well as defining
14 * common functions and structures. Currently (at the time I
15 * wrote this comment) the iSeries virtual I/O device drivers
17 * drivers/block/viodasd.c
18 * drivers/char/viocons.c
19 * drivers/char/viotape.c
20 * drivers/cdrom/viocd.c
22 * The iSeries virtual ethernet support (veth.c) uses a whole
23 * different set of functions.
25 * This program is free software; you can redistribute it and/or
26 * modify it under the terms of the GNU General Public License as
27 * published by the Free Software Foundation; either version 2 of the
28 * License, or (at your option) anyu later version.
30 * This program is distributed in the hope that it will be useful, but
31 * WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
33 * General Public License for more details.
35 * You should have received a copy of the GNU General Public License
36 * along with this program; if not, write to the Free Software Foundation,
37 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
40 #ifndef _ASM_POWERPC_ISERIES_VIO_H
41 #define _ASM_POWERPC_ISERIES_VIO_H
43 #include <asm/iseries/hv_types.h>
44 #include <asm/iseries/hv_lp_event.h>
47 * iSeries virtual I/O events use the subtype field in
48 * HvLpEvent to figure out what kind of vio event is coming
49 * in. We use a table to route these, and this defines
50 * the maximum number of distinct subtypes
52 #define VIO_MAX_SUBTYPES 8
55 struct HvLpEvent event;
62 u64 offset; /* On open, max number of disks */
63 u64 len; /* On open, size of the disk */
64 u32 block_size; /* Only set on open */
65 u32 media_size; /* Only set on open */
73 viocdlockdoor = 0x0005,
74 viocdgetinfo = 0x0006,
78 struct viotapelpevent {
79 struct HvLpEvent event;
107 enum viotapesubtype {
108 viotapeopen = 0x0001,
109 viotapeclose = 0x0002,
110 viotaperead = 0x0003,
111 viotapewrite = 0x0004,
112 viotapegetinfo = 0x0005,
114 viotapegetpos = 0x0007,
115 viotapesetpos = 0x0008,
116 viotapegetstatus = 0x0009
120 * Each subtype can register a handler to process their events.
121 * The handler must have this interface.
123 typedef void (vio_event_handler_t) (struct HvLpEvent * event);
125 extern int viopath_open(HvLpIndex remoteLp, int subtype, int numReq);
126 extern int viopath_close(HvLpIndex remoteLp, int subtype, int numReq);
127 extern int vio_setHandler(int subtype, vio_event_handler_t * beh);
128 extern int vio_clearHandler(int subtype);
129 extern int viopath_isactive(HvLpIndex lp);
130 extern HvLpInstanceId viopath_sourceinst(HvLpIndex lp);
131 extern HvLpInstanceId viopath_targetinst(HvLpIndex lp);
132 extern void vio_set_hostlp(void);
133 extern void *vio_get_event_buffer(int subtype);
134 extern void vio_free_event_buffer(int subtype, void *buffer);
136 extern HvLpIndex viopath_hostLp;
137 extern HvLpIndex viopath_ourLp;
139 #define VIOCHAR_MAX_DATA 200
141 #define VIOMAJOR_SUBTYPE_MASK 0xff00
142 #define VIOMINOR_SUBTYPE_MASK 0x00ff
143 #define VIOMAJOR_SUBTYPE_SHIFT 8
145 #define VIOVERSION 0x0101
148 * This is the general structure for VIO errors; each module should have
149 * a table of them, and each table should be terminated by an entry of
150 * { 0, 0, NULL }. Then, to find a specific error message, a module
151 * should pass its local table and the return code.
153 struct vio_error_entry {
158 extern const struct vio_error_entry *vio_lookup_rc(
159 const struct vio_error_entry *local_table, u16 rc);
162 viomajorsubtype_monitor = 0x0100,
163 viomajorsubtype_blockio = 0x0200,
164 viomajorsubtype_chario = 0x0300,
165 viomajorsubtype_config = 0x0400,
166 viomajorsubtype_cdio = 0x0500,
167 viomajorsubtype_tape = 0x0600,
168 viomajorsubtype_scsi = 0x0700
171 enum vioconfigsubtype {
172 vioconfigget = 0x0001,
177 viorc_noConnection = 0x0001,
178 viorc_noReceiver = 0x0002,
179 viorc_noBufferAvailable = 0x0003,
180 viorc_invalidMessageType = 0x0004,
181 viorc_invalidRange = 0x0201,
182 viorc_invalidToken = 0x0202,
183 viorc_DMAError = 0x0203,
184 viorc_useError = 0x0204,
185 viorc_releaseError = 0x0205,
186 viorc_invalidDisk = 0x0206,
187 viorc_openRejected = 0x0301
191 * The structure of the events that flow between us and OS/400 for chario
192 * events. You can't mess with this unless the OS/400 side changes too.
194 struct viocharlpevent {
195 struct HvLpEvent event;
198 u16 subtype_result_code;
201 u8 data[VIOCHAR_MAX_DATA];
204 #define VIOCHAR_WINDOW 10
206 enum viocharsubtype {
207 viocharopen = 0x0001,
208 viocharclose = 0x0002,
209 viochardata = 0x0003,
211 viocharconfig = 0x0005
218 #endif /* _ASM_POWERPC_ISERIES_VIO_H */