2 * arch/ppc64/kernel/viopath.c
4 * iSeries Virtual I/O Message Path code
6 * Authors: Dave Boutcher <boutcher@us.ibm.com>
7 * Ryan Arnold <ryanarn@us.ibm.com>
8 * Colin Devilbiss <devilbis@us.ibm.com>
10 * (C) Copyright 2000-2003 IBM Corporation
12 * This code is used by the iSeries virtual disk, cd,
13 * tape, and console to communicate with OS/400 in another
16 * This program is free software; you can redistribute it and/or
17 * modify it under the terms of the GNU General Public License as
18 * published by the Free Software Foundation; either version 2 of the
19 * License, or (at your option) anyu later version.
21 * This program is distributed in the hope that it will be useful, but
22 * WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
24 * General Public License for more details.
26 * You should have received a copy of the GNU General Public License
27 * along with this program; if not, write to the Free Software Foundation,
28 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
31 #include <linux/module.h>
32 #include <linux/kernel.h>
33 #include <linux/errno.h>
34 #include <linux/vmalloc.h>
35 #include <linux/string.h>
36 #include <linux/proc_fs.h>
37 #include <linux/dma-mapping.h>
38 #include <linux/wait.h>
39 #include <linux/seq_file.h>
40 #include <linux/smp_lock.h>
41 #include <linux/interrupt.h>
43 #include <asm/system.h>
44 #include <asm/uaccess.h>
45 #include <asm/iSeries/HvTypes.h>
46 #include <asm/iSeries/ItExtVpdPanel.h>
47 #include <asm/iSeries/HvLpEvent.h>
48 #include <asm/iSeries/HvLpConfig.h>
49 #include <asm/iSeries/mf.h>
50 #include <asm/iSeries/vio.h>
52 /* Status of the path to each other partition in the system.
53 * This is overkill, since we will only ever establish connections
54 * to our hosting partition and the primary partition on the system.
55 * But this allows for other support in the future.
57 static struct viopathStatus
{
58 int isOpen
; /* Did we open the path? */
59 int isActive
; /* Do we have a mon msg outstanding */
60 int users
[VIO_MAX_SUBTYPES
];
61 HvLpInstanceId mSourceInst
;
62 HvLpInstanceId mTargetInst
;
64 } viopathStatus
[HVMAXARCHITECTEDLPS
];
66 static DEFINE_SPINLOCK(statuslock
);
69 * For each kind of event we allocate a buffer that is
70 * guaranteed not to cross a page boundary
72 static unsigned char event_buffer
[VIO_MAX_SUBTYPES
* 256] __page_aligned
;
73 static atomic_t event_buffer_available
[VIO_MAX_SUBTYPES
];
74 static int event_buffer_initialised
;
76 static void handleMonitorEvent(struct HvLpEvent
*event
);
79 * We use this structure to handle asynchronous responses. The caller
80 * blocks on the semaphore and the handler posts the semaphore. However,
81 * if system_state is not SYSTEM_RUNNING, then wait_atomic is used ...
90 /* Put a sequence number in each mon msg. The value is not
91 * important. Start at something other than 0 just for
92 * readability. wrapping this is ok.
94 static u8 viomonseq
= 22;
96 /* Our hosting logical partition. We get this at startup
97 * time, and different modules access this variable directly.
99 HvLpIndex viopath_hostLp
= HvLpIndexInvalid
;
100 EXPORT_SYMBOL(viopath_hostLp
);
101 HvLpIndex viopath_ourLp
= HvLpIndexInvalid
;
102 EXPORT_SYMBOL(viopath_ourLp
);
104 /* For each kind of incoming event we set a pointer to a
107 static vio_event_handler_t
*vio_handler
[VIO_MAX_SUBTYPES
];
109 #define VIOPATH_KERN_WARN KERN_WARNING "viopath: "
110 #define VIOPATH_KERN_INFO KERN_INFO "viopath: "
112 static int proc_viopath_show(struct seq_file
*m
, void *v
)
118 DECLARE_MUTEX_LOCKED(Semaphore
);
120 buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
123 memset(buf
, 0, PAGE_SIZE
);
125 handle
= dma_map_single(iSeries_vio_dev
, buf
, PAGE_SIZE
,
128 hvrc
= HvCallEvent_signalLpEventFast(viopath_hostLp
,
129 HvLpEvent_Type_VirtualIo
,
130 viomajorsubtype_config
| vioconfigget
,
131 HvLpEvent_AckInd_DoAck
, HvLpEvent_AckType_ImmediateAck
,
132 viopath_sourceinst(viopath_hostLp
),
133 viopath_targetinst(viopath_hostLp
),
134 (u64
)(unsigned long)&Semaphore
, VIOVERSION
<< 16,
135 ((u64
)handle
) << 32, PAGE_SIZE
, 0, 0);
137 if (hvrc
!= HvLpEvent_Rc_Good
)
138 printk(VIOPATH_KERN_WARN
"hv error on op %d\n", (int)hvrc
);
142 vlanMap
= HvLpConfig_getVirtualLanIndexMap();
144 buf
[PAGE_SIZE
-1] = '\0';
145 seq_printf(m
, "%s", buf
);
146 seq_printf(m
, "AVAILABLE_VETH=%x\n", vlanMap
);
147 seq_printf(m
, "SRLNBR=%c%c%c%c%c%c%c\n",
148 e2a(xItExtVpdPanel
.mfgID
[2]),
149 e2a(xItExtVpdPanel
.mfgID
[3]),
150 e2a(xItExtVpdPanel
.systemSerial
[1]),
151 e2a(xItExtVpdPanel
.systemSerial
[2]),
152 e2a(xItExtVpdPanel
.systemSerial
[3]),
153 e2a(xItExtVpdPanel
.systemSerial
[4]),
154 e2a(xItExtVpdPanel
.systemSerial
[5]));
156 dma_unmap_single(iSeries_vio_dev
, handle
, PAGE_SIZE
, DMA_FROM_DEVICE
);
162 static int proc_viopath_open(struct inode
*inode
, struct file
*file
)
164 return single_open(file
, proc_viopath_show
, NULL
);
167 static struct file_operations proc_viopath_operations
= {
168 .open
= proc_viopath_open
,
171 .release
= single_release
,
174 static int __init
vio_proc_init(void)
176 struct proc_dir_entry
*e
;
178 e
= create_proc_entry("iSeries/config", 0, NULL
);
180 e
->proc_fops
= &proc_viopath_operations
;
184 __initcall(vio_proc_init
);
186 /* See if a given LP is active. Allow for invalid lps to be passed in
187 * and just return invalid
189 int viopath_isactive(HvLpIndex lp
)
191 if (lp
== HvLpIndexInvalid
)
193 if (lp
< HVMAXARCHITECTEDLPS
)
194 return viopathStatus
[lp
].isActive
;
198 EXPORT_SYMBOL(viopath_isactive
);
201 * We cache the source and target instance ids for each
204 HvLpInstanceId
viopath_sourceinst(HvLpIndex lp
)
206 return viopathStatus
[lp
].mSourceInst
;
208 EXPORT_SYMBOL(viopath_sourceinst
);
210 HvLpInstanceId
viopath_targetinst(HvLpIndex lp
)
212 return viopathStatus
[lp
].mTargetInst
;
214 EXPORT_SYMBOL(viopath_targetinst
);
217 * Send a monitor message. This is a message with the acknowledge
218 * bit on that the other side will NOT explicitly acknowledge. When
219 * the other side goes down, the hypervisor will acknowledge any
220 * outstanding messages....so we will know when the other side dies.
222 static void sendMonMsg(HvLpIndex remoteLp
)
226 viopathStatus
[remoteLp
].mSourceInst
=
227 HvCallEvent_getSourceLpInstanceId(remoteLp
,
228 HvLpEvent_Type_VirtualIo
);
229 viopathStatus
[remoteLp
].mTargetInst
=
230 HvCallEvent_getTargetLpInstanceId(remoteLp
,
231 HvLpEvent_Type_VirtualIo
);
234 * Deliberately ignore the return code here. if we call this
235 * more than once, we don't care.
237 vio_setHandler(viomajorsubtype_monitor
, handleMonitorEvent
);
239 hvrc
= HvCallEvent_signalLpEventFast(remoteLp
, HvLpEvent_Type_VirtualIo
,
240 viomajorsubtype_monitor
, HvLpEvent_AckInd_DoAck
,
241 HvLpEvent_AckType_DeferredAck
,
242 viopathStatus
[remoteLp
].mSourceInst
,
243 viopathStatus
[remoteLp
].mTargetInst
,
244 viomonseq
++, 0, 0, 0, 0, 0);
246 if (hvrc
== HvLpEvent_Rc_Good
)
247 viopathStatus
[remoteLp
].isActive
= 1;
249 printk(VIOPATH_KERN_WARN
"could not connect to partition %d\n",
251 viopathStatus
[remoteLp
].isActive
= 0;
255 static void handleMonitorEvent(struct HvLpEvent
*event
)
261 * This handler is _also_ called as part of the loop
262 * at the end of this routine, so it must be able to
263 * ignore NULL events...
269 * First see if this is just a normal monitor message from the
272 if (event
->xFlags
.xFunction
== HvLpEvent_Function_Int
) {
273 remoteLp
= event
->xSourceLp
;
274 if (!viopathStatus
[remoteLp
].isActive
)
275 sendMonMsg(remoteLp
);
280 * This path is for an acknowledgement; the other partition
283 remoteLp
= event
->xTargetLp
;
284 if ((event
->xSourceInstanceId
!= viopathStatus
[remoteLp
].mSourceInst
) ||
285 (event
->xTargetInstanceId
!= viopathStatus
[remoteLp
].mTargetInst
)) {
286 printk(VIOPATH_KERN_WARN
"ignoring ack....mismatched instances\n");
290 printk(VIOPATH_KERN_WARN
"partition %d ended\n", remoteLp
);
292 viopathStatus
[remoteLp
].isActive
= 0;
295 * For each active handler, pass them a NULL
296 * message to indicate that the other partition
299 for (i
= 0; i
< VIO_MAX_SUBTYPES
; i
++) {
300 if (vio_handler
[i
] != NULL
)
301 (*vio_handler
[i
])(NULL
);
305 int vio_setHandler(int subtype
, vio_event_handler_t
*beh
)
307 subtype
= subtype
>> VIOMAJOR_SUBTYPE_SHIFT
;
308 if ((subtype
< 0) || (subtype
>= VIO_MAX_SUBTYPES
))
310 if (vio_handler
[subtype
] != NULL
)
312 vio_handler
[subtype
] = beh
;
315 EXPORT_SYMBOL(vio_setHandler
);
317 int vio_clearHandler(int subtype
)
319 subtype
= subtype
>> VIOMAJOR_SUBTYPE_SHIFT
;
320 if ((subtype
< 0) || (subtype
>= VIO_MAX_SUBTYPES
))
322 if (vio_handler
[subtype
] == NULL
)
324 vio_handler
[subtype
] = NULL
;
327 EXPORT_SYMBOL(vio_clearHandler
);
329 static void handleConfig(struct HvLpEvent
*event
)
333 if (event
->xFlags
.xFunction
== HvLpEvent_Function_Int
) {
334 printk(VIOPATH_KERN_WARN
335 "unexpected config request from partition %d",
338 if ((event
->xFlags
.xFunction
== HvLpEvent_Function_Int
) &&
339 (event
->xFlags
.xAckInd
== HvLpEvent_AckInd_DoAck
)) {
340 event
->xRc
= HvLpEvent_Rc_InvalidSubtype
;
341 HvCallEvent_ackLpEvent(event
);
346 up((struct semaphore
*)event
->xCorrelationToken
);
350 * Initialization of the hosting partition
352 void vio_set_hostlp(void)
355 * If this has already been set then we DON'T want to either change
356 * it or re-register the proc file system
358 if (viopath_hostLp
!= HvLpIndexInvalid
)
362 * Figure out our hosting partition. This isn't allowed to change
365 viopath_ourLp
= HvLpConfig_getLpIndex();
366 viopath_hostLp
= HvLpConfig_getHostingLpIndex(viopath_ourLp
);
368 if (viopath_hostLp
!= HvLpIndexInvalid
)
369 vio_setHandler(viomajorsubtype_config
, handleConfig
);
371 EXPORT_SYMBOL(vio_set_hostlp
);
373 static void vio_handleEvent(struct HvLpEvent
*event
, struct pt_regs
*regs
)
376 int subtype
= (event
->xSubtype
& VIOMAJOR_SUBTYPE_MASK
)
377 >> VIOMAJOR_SUBTYPE_SHIFT
;
379 if (event
->xFlags
.xFunction
== HvLpEvent_Function_Int
) {
380 remoteLp
= event
->xSourceLp
;
382 * The isActive is checked because if the hosting partition
383 * went down and came back up it would not be active but it
384 * would have different source and target instances, in which
385 * case we'd want to reset them. This case really protects
386 * against an unauthorized active partition sending interrupts
387 * or acks to this linux partition.
389 if (viopathStatus
[remoteLp
].isActive
390 && (event
->xSourceInstanceId
!=
391 viopathStatus
[remoteLp
].mTargetInst
)) {
392 printk(VIOPATH_KERN_WARN
393 "message from invalid partition. "
394 "int msg rcvd, source inst (%d) doesnt match (%d)\n",
395 viopathStatus
[remoteLp
].mTargetInst
,
396 event
->xSourceInstanceId
);
400 if (viopathStatus
[remoteLp
].isActive
401 && (event
->xTargetInstanceId
!=
402 viopathStatus
[remoteLp
].mSourceInst
)) {
403 printk(VIOPATH_KERN_WARN
404 "message from invalid partition. "
405 "int msg rcvd, target inst (%d) doesnt match (%d)\n",
406 viopathStatus
[remoteLp
].mSourceInst
,
407 event
->xTargetInstanceId
);
411 remoteLp
= event
->xTargetLp
;
412 if (event
->xSourceInstanceId
!=
413 viopathStatus
[remoteLp
].mSourceInst
) {
414 printk(VIOPATH_KERN_WARN
415 "message from invalid partition. "
416 "ack msg rcvd, source inst (%d) doesnt match (%d)\n",
417 viopathStatus
[remoteLp
].mSourceInst
,
418 event
->xSourceInstanceId
);
422 if (event
->xTargetInstanceId
!=
423 viopathStatus
[remoteLp
].mTargetInst
) {
424 printk(VIOPATH_KERN_WARN
425 "message from invalid partition. "
426 "viopath: ack msg rcvd, target inst (%d) doesnt match (%d)\n",
427 viopathStatus
[remoteLp
].mTargetInst
,
428 event
->xTargetInstanceId
);
433 if (vio_handler
[subtype
] == NULL
) {
434 printk(VIOPATH_KERN_WARN
435 "unexpected virtual io event subtype %d from partition %d\n",
436 event
->xSubtype
, remoteLp
);
437 /* No handler. Ack if necessary */
438 if ((event
->xFlags
.xFunction
== HvLpEvent_Function_Int
) &&
439 (event
->xFlags
.xAckInd
== HvLpEvent_AckInd_DoAck
)) {
440 event
->xRc
= HvLpEvent_Rc_InvalidSubtype
;
441 HvCallEvent_ackLpEvent(event
);
446 /* This innocuous little line is where all the real work happens */
447 (*vio_handler
[subtype
])(event
);
450 static void viopath_donealloc(void *parm
, int number
)
452 struct alloc_parms
*parmsp
= parm
;
454 parmsp
->number
= number
;
455 if (parmsp
->used_wait_atomic
)
456 atomic_set(&parmsp
->wait_atomic
, 0);
461 static int allocateEvents(HvLpIndex remoteLp
, int numEvents
)
463 struct alloc_parms parms
;
465 if (system_state
!= SYSTEM_RUNNING
) {
466 parms
.used_wait_atomic
= 1;
467 atomic_set(&parms
.wait_atomic
, 1);
469 parms
.used_wait_atomic
= 0;
470 init_MUTEX_LOCKED(&parms
.sem
);
472 mf_allocate_lp_events(remoteLp
, HvLpEvent_Type_VirtualIo
, 250, /* It would be nice to put a real number here! */
473 numEvents
, &viopath_donealloc
, &parms
);
474 if (system_state
!= SYSTEM_RUNNING
) {
475 while (atomic_read(&parms
.wait_atomic
))
482 int viopath_open(HvLpIndex remoteLp
, int subtype
, int numReq
)
486 int tempNumAllocated
;
488 if ((remoteLp
>= HVMAXARCHITECTEDLPS
) || (remoteLp
== HvLpIndexInvalid
))
491 subtype
= subtype
>> VIOMAJOR_SUBTYPE_SHIFT
;
492 if ((subtype
< 0) || (subtype
>= VIO_MAX_SUBTYPES
))
495 spin_lock_irqsave(&statuslock
, flags
);
497 if (!event_buffer_initialised
) {
498 for (i
= 0; i
< VIO_MAX_SUBTYPES
; i
++)
499 atomic_set(&event_buffer_available
[i
], 1);
500 event_buffer_initialised
= 1;
503 viopathStatus
[remoteLp
].users
[subtype
]++;
505 if (!viopathStatus
[remoteLp
].isOpen
) {
506 viopathStatus
[remoteLp
].isOpen
= 1;
507 HvCallEvent_openLpEventPath(remoteLp
, HvLpEvent_Type_VirtualIo
);
510 * Don't hold the spinlock during an operation that
513 spin_unlock_irqrestore(&statuslock
, flags
);
514 tempNumAllocated
= allocateEvents(remoteLp
, 1);
515 spin_lock_irqsave(&statuslock
, flags
);
517 viopathStatus
[remoteLp
].numberAllocated
+= tempNumAllocated
;
519 if (viopathStatus
[remoteLp
].numberAllocated
== 0) {
520 HvCallEvent_closeLpEventPath(remoteLp
,
521 HvLpEvent_Type_VirtualIo
);
523 spin_unlock_irqrestore(&statuslock
, flags
);
527 viopathStatus
[remoteLp
].mSourceInst
=
528 HvCallEvent_getSourceLpInstanceId(remoteLp
,
529 HvLpEvent_Type_VirtualIo
);
530 viopathStatus
[remoteLp
].mTargetInst
=
531 HvCallEvent_getTargetLpInstanceId(remoteLp
,
532 HvLpEvent_Type_VirtualIo
);
533 HvLpEvent_registerHandler(HvLpEvent_Type_VirtualIo
,
535 sendMonMsg(remoteLp
);
536 printk(VIOPATH_KERN_INFO
"opening connection to partition %d, "
537 "setting sinst %d, tinst %d\n",
538 remoteLp
, viopathStatus
[remoteLp
].mSourceInst
,
539 viopathStatus
[remoteLp
].mTargetInst
);
542 spin_unlock_irqrestore(&statuslock
, flags
);
543 tempNumAllocated
= allocateEvents(remoteLp
, numReq
);
544 spin_lock_irqsave(&statuslock
, flags
);
545 viopathStatus
[remoteLp
].numberAllocated
+= tempNumAllocated
;
546 spin_unlock_irqrestore(&statuslock
, flags
);
550 EXPORT_SYMBOL(viopath_open
);
552 int viopath_close(HvLpIndex remoteLp
, int subtype
, int numReq
)
557 struct alloc_parms parms
;
559 if ((remoteLp
>= HVMAXARCHITECTEDLPS
) || (remoteLp
== HvLpIndexInvalid
))
562 subtype
= subtype
>> VIOMAJOR_SUBTYPE_SHIFT
;
563 if ((subtype
< 0) || (subtype
>= VIO_MAX_SUBTYPES
))
566 spin_lock_irqsave(&statuslock
, flags
);
568 * If the viopath_close somehow gets called before a
569 * viopath_open it could decrement to -1 which is a non
570 * recoverable state so we'll prevent this from
573 if (viopathStatus
[remoteLp
].users
[subtype
] > 0)
574 viopathStatus
[remoteLp
].users
[subtype
]--;
576 spin_unlock_irqrestore(&statuslock
, flags
);
578 parms
.used_wait_atomic
= 0;
579 init_MUTEX_LOCKED(&parms
.sem
);
580 mf_deallocate_lp_events(remoteLp
, HvLpEvent_Type_VirtualIo
,
581 numReq
, &viopath_donealloc
, &parms
);
584 spin_lock_irqsave(&statuslock
, flags
);
585 for (i
= 0, numOpen
= 0; i
< VIO_MAX_SUBTYPES
; i
++)
586 numOpen
+= viopathStatus
[remoteLp
].users
[i
];
588 if ((viopathStatus
[remoteLp
].isOpen
) && (numOpen
== 0)) {
589 printk(VIOPATH_KERN_INFO
"closing connection to partition %d",
592 HvCallEvent_closeLpEventPath(remoteLp
,
593 HvLpEvent_Type_VirtualIo
);
594 viopathStatus
[remoteLp
].isOpen
= 0;
595 viopathStatus
[remoteLp
].isActive
= 0;
597 for (i
= 0; i
< VIO_MAX_SUBTYPES
; i
++)
598 atomic_set(&event_buffer_available
[i
], 0);
599 event_buffer_initialised
= 0;
601 spin_unlock_irqrestore(&statuslock
, flags
);
604 EXPORT_SYMBOL(viopath_close
);
606 void *vio_get_event_buffer(int subtype
)
608 subtype
= subtype
>> VIOMAJOR_SUBTYPE_SHIFT
;
609 if ((subtype
< 0) || (subtype
>= VIO_MAX_SUBTYPES
))
612 if (atomic_dec_if_positive(&event_buffer_available
[subtype
]) == 0)
613 return &event_buffer
[subtype
* 256];
617 EXPORT_SYMBOL(vio_get_event_buffer
);
619 void vio_free_event_buffer(int subtype
, void *buffer
)
621 subtype
= subtype
>> VIOMAJOR_SUBTYPE_SHIFT
;
622 if ((subtype
< 0) || (subtype
>= VIO_MAX_SUBTYPES
)) {
623 printk(VIOPATH_KERN_WARN
624 "unexpected subtype %d freeing event buffer\n", subtype
);
628 if (atomic_read(&event_buffer_available
[subtype
]) != 0) {
629 printk(VIOPATH_KERN_WARN
630 "freeing unallocated event buffer, subtype %d\n",
635 if (buffer
!= &event_buffer
[subtype
* 256]) {
636 printk(VIOPATH_KERN_WARN
637 "freeing invalid event buffer, subtype %d\n", subtype
);
640 atomic_set(&event_buffer_available
[subtype
], 1);
642 EXPORT_SYMBOL(vio_free_event_buffer
);
644 static const struct vio_error_entry vio_no_error
=
645 { 0, 0, "Non-VIO Error" };
646 static const struct vio_error_entry vio_unknown_error
=
647 { 0, EIO
, "Unknown Error" };
649 static const struct vio_error_entry vio_default_errors
[] = {
650 {0x0001, EIO
, "No Connection"},
651 {0x0002, EIO
, "No Receiver"},
652 {0x0003, EIO
, "No Buffer Available"},
653 {0x0004, EBADRQC
, "Invalid Message Type"},
657 const struct vio_error_entry
*vio_lookup_rc(
658 const struct vio_error_entry
*local_table
, u16 rc
)
660 const struct vio_error_entry
*cur
;
663 return &vio_no_error
;
665 for (cur
= local_table
; cur
->rc
; ++cur
)
668 for (cur
= vio_default_errors
; cur
->rc
; ++cur
)
671 return &vio_unknown_error
;
673 EXPORT_SYMBOL(vio_lookup_rc
);