3 * iSeries Virtual I/O Message Path code
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-2005 IBM Corporation
11 * This code is used by the iSeries virtual disk, cd,
12 * tape, and console to communicate with OS/400 in another
15 * This program is free software; you can redistribute it and/or
16 * modify it under the terms of the GNU General Public License as
17 * published by the Free Software Foundation; either version 2 of the
18 * License, or (at your option) anyu later version.
20 * This program is distributed in the hope that it will be useful, but
21 * WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 * General Public License for more details.
25 * You should have received a copy of the GNU General Public License
26 * along with this program; if not, write to the Free Software Foundation,
27 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 #include <linux/module.h>
31 #include <linux/kernel.h>
32 #include <linux/errno.h>
33 #include <linux/vmalloc.h>
34 #include <linux/string.h>
35 #include <linux/proc_fs.h>
36 #include <linux/dma-mapping.h>
37 #include <linux/wait.h>
38 #include <linux/seq_file.h>
39 #include <linux/interrupt.h>
40 #include <linux/completion.h>
42 #include <asm/system.h>
43 #include <asm/uaccess.h>
45 #include <asm/firmware.h>
46 #include <asm/iseries/hv_types.h>
47 #include <asm/iseries/hv_lp_event.h>
48 #include <asm/iseries/hv_lp_config.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]
73 __attribute__((__aligned__(4096)));
74 static atomic_t event_buffer_available[VIO_MAX_SUBTYPES];
75 static int event_buffer_initialised;
77 static void handleMonitorEvent(struct HvLpEvent *event);
80 * We use this structure to handle asynchronous responses. The caller
81 * blocks on the semaphore and the handler posts the semaphore. However,
82 * if system_state is not SYSTEM_RUNNING, then wait_atomic is used ...
85 struct completion done;
91 /* Put a sequence number in each mon msg. The value is not
92 * important. Start at something other than 0 just for
93 * readability. wrapping this is ok.
95 static u8 viomonseq = 22;
97 /* Our hosting logical partition. We get this at startup
98 * time, and different modules access this variable directly.
100 HvLpIndex viopath_hostLp = HvLpIndexInvalid;
101 EXPORT_SYMBOL(viopath_hostLp);
102 HvLpIndex viopath_ourLp = HvLpIndexInvalid;
103 EXPORT_SYMBOL(viopath_ourLp);
105 /* For each kind of incoming event we set a pointer to a
108 static vio_event_handler_t *vio_handler[VIO_MAX_SUBTYPES];
110 #define VIOPATH_KERN_WARN KERN_WARNING "viopath: "
111 #define VIOPATH_KERN_INFO KERN_INFO "viopath: "
113 static int proc_viopath_show(struct seq_file *m, void *v)
119 DECLARE_COMPLETION(done);
120 struct device_node *node;
123 buf = kzalloc(HW_PAGE_SIZE, GFP_KERNEL);
127 handle = iseries_hv_map(buf, HW_PAGE_SIZE, DMA_FROM_DEVICE);
129 hvrc = HvCallEvent_signalLpEventFast(viopath_hostLp,
130 HvLpEvent_Type_VirtualIo,
131 viomajorsubtype_config | vioconfigget,
132 HvLpEvent_AckInd_DoAck, HvLpEvent_AckType_ImmediateAck,
133 viopath_sourceinst(viopath_hostLp),
134 viopath_targetinst(viopath_hostLp),
135 (u64)(unsigned long)&done, VIOVERSION << 16,
136 ((u64)handle) << 32, HW_PAGE_SIZE, 0, 0);
138 if (hvrc != HvLpEvent_Rc_Good)
139 printk(VIOPATH_KERN_WARN "hv error on op %d\n", (int)hvrc);
141 wait_for_completion(&done);
143 vlanMap = HvLpConfig_getVirtualLanIndexMap();
145 buf[HW_PAGE_SIZE-1] = '\0';
146 seq_printf(m, "%s", buf);
148 iseries_hv_unmap(handle, HW_PAGE_SIZE, DMA_FROM_DEVICE);
151 seq_printf(m, "AVAILABLE_VETH=%x\n", vlanMap);
153 node = of_find_node_by_path("/");
156 sysid = of_get_property(node, "system-id", NULL);
159 seq_printf(m, "SRLNBR=<UNKNOWN>\n");
161 /* Skip "IBM," on front of serial number, see dt.c */
162 seq_printf(m, "SRLNBR=%s\n", sysid + 4);
169 static int proc_viopath_open(struct inode *inode, struct file *file)
171 return single_open(file, proc_viopath_show, NULL);
174 static const struct file_operations proc_viopath_operations = {
175 .open = proc_viopath_open,
178 .release = single_release,
181 static int __init vio_proc_init(void)
183 struct proc_dir_entry *e;
185 if (!firmware_has_feature(FW_FEATURE_ISERIES))
188 e = create_proc_entry("iSeries/config", 0, NULL);
190 e->proc_fops = &proc_viopath_operations;
194 __initcall(vio_proc_init);
196 /* See if a given LP is active. Allow for invalid lps to be passed in
197 * and just return invalid
199 int viopath_isactive(HvLpIndex lp)
201 if (lp == HvLpIndexInvalid)
203 if (lp < HVMAXARCHITECTEDLPS)
204 return viopathStatus[lp].isActive;
208 EXPORT_SYMBOL(viopath_isactive);
211 * We cache the source and target instance ids for each
214 HvLpInstanceId viopath_sourceinst(HvLpIndex lp)
216 return viopathStatus[lp].mSourceInst;
218 EXPORT_SYMBOL(viopath_sourceinst);
220 HvLpInstanceId viopath_targetinst(HvLpIndex lp)
222 return viopathStatus[lp].mTargetInst;
224 EXPORT_SYMBOL(viopath_targetinst);
227 * Send a monitor message. This is a message with the acknowledge
228 * bit on that the other side will NOT explicitly acknowledge. When
229 * the other side goes down, the hypervisor will acknowledge any
230 * outstanding messages....so we will know when the other side dies.
232 static void sendMonMsg(HvLpIndex remoteLp)
236 viopathStatus[remoteLp].mSourceInst =
237 HvCallEvent_getSourceLpInstanceId(remoteLp,
238 HvLpEvent_Type_VirtualIo);
239 viopathStatus[remoteLp].mTargetInst =
240 HvCallEvent_getTargetLpInstanceId(remoteLp,
241 HvLpEvent_Type_VirtualIo);
244 * Deliberately ignore the return code here. if we call this
245 * more than once, we don't care.
247 vio_setHandler(viomajorsubtype_monitor, handleMonitorEvent);
249 hvrc = HvCallEvent_signalLpEventFast(remoteLp, HvLpEvent_Type_VirtualIo,
250 viomajorsubtype_monitor, HvLpEvent_AckInd_DoAck,
251 HvLpEvent_AckType_DeferredAck,
252 viopathStatus[remoteLp].mSourceInst,
253 viopathStatus[remoteLp].mTargetInst,
254 viomonseq++, 0, 0, 0, 0, 0);
256 if (hvrc == HvLpEvent_Rc_Good)
257 viopathStatus[remoteLp].isActive = 1;
259 printk(VIOPATH_KERN_WARN "could not connect to partition %d\n",
261 viopathStatus[remoteLp].isActive = 0;
265 static void handleMonitorEvent(struct HvLpEvent *event)
271 * This handler is _also_ called as part of the loop
272 * at the end of this routine, so it must be able to
273 * ignore NULL events...
279 * First see if this is just a normal monitor message from the
282 if (hvlpevent_is_int(event)) {
283 remoteLp = event->xSourceLp;
284 if (!viopathStatus[remoteLp].isActive)
285 sendMonMsg(remoteLp);
290 * This path is for an acknowledgement; the other partition
293 remoteLp = event->xTargetLp;
294 if ((event->xSourceInstanceId != viopathStatus[remoteLp].mSourceInst) ||
295 (event->xTargetInstanceId != viopathStatus[remoteLp].mTargetInst)) {
296 printk(VIOPATH_KERN_WARN "ignoring ack....mismatched instances\n");
300 printk(VIOPATH_KERN_WARN "partition %d ended\n", remoteLp);
302 viopathStatus[remoteLp].isActive = 0;
305 * For each active handler, pass them a NULL
306 * message to indicate that the other partition
309 for (i = 0; i < VIO_MAX_SUBTYPES; i++) {
310 if (vio_handler[i] != NULL)
311 (*vio_handler[i])(NULL);
315 int vio_setHandler(int subtype, vio_event_handler_t *beh)
317 subtype = subtype >> VIOMAJOR_SUBTYPE_SHIFT;
318 if ((subtype < 0) || (subtype >= VIO_MAX_SUBTYPES))
320 if (vio_handler[subtype] != NULL)
322 vio_handler[subtype] = beh;
325 EXPORT_SYMBOL(vio_setHandler);
327 int vio_clearHandler(int subtype)
329 subtype = subtype >> VIOMAJOR_SUBTYPE_SHIFT;
330 if ((subtype < 0) || (subtype >= VIO_MAX_SUBTYPES))
332 if (vio_handler[subtype] == NULL)
334 vio_handler[subtype] = NULL;
337 EXPORT_SYMBOL(vio_clearHandler);
339 static void handleConfig(struct HvLpEvent *event)
343 if (hvlpevent_is_int(event)) {
344 printk(VIOPATH_KERN_WARN
345 "unexpected config request from partition %d",
348 if (hvlpevent_need_ack(event)) {
349 event->xRc = HvLpEvent_Rc_InvalidSubtype;
350 HvCallEvent_ackLpEvent(event);
355 complete((struct completion *)event->xCorrelationToken);
359 * Initialization of the hosting partition
361 void vio_set_hostlp(void)
364 * If this has already been set then we DON'T want to either change
365 * it or re-register the proc file system
367 if (viopath_hostLp != HvLpIndexInvalid)
371 * Figure out our hosting partition. This isn't allowed to change
374 viopath_ourLp = HvLpConfig_getLpIndex();
375 viopath_hostLp = HvLpConfig_getHostingLpIndex(viopath_ourLp);
377 if (viopath_hostLp != HvLpIndexInvalid)
378 vio_setHandler(viomajorsubtype_config, handleConfig);
380 EXPORT_SYMBOL(vio_set_hostlp);
382 static void vio_handleEvent(struct HvLpEvent *event)
385 int subtype = (event->xSubtype & VIOMAJOR_SUBTYPE_MASK)
386 >> VIOMAJOR_SUBTYPE_SHIFT;
388 if (hvlpevent_is_int(event)) {
389 remoteLp = event->xSourceLp;
391 * The isActive is checked because if the hosting partition
392 * went down and came back up it would not be active but it
393 * would have different source and target instances, in which
394 * case we'd want to reset them. This case really protects
395 * against an unauthorized active partition sending interrupts
396 * or acks to this linux partition.
398 if (viopathStatus[remoteLp].isActive
399 && (event->xSourceInstanceId !=
400 viopathStatus[remoteLp].mTargetInst)) {
401 printk(VIOPATH_KERN_WARN
402 "message from invalid partition. "
403 "int msg rcvd, source inst (%d) doesnt match (%d)\n",
404 viopathStatus[remoteLp].mTargetInst,
405 event->xSourceInstanceId);
409 if (viopathStatus[remoteLp].isActive
410 && (event->xTargetInstanceId !=
411 viopathStatus[remoteLp].mSourceInst)) {
412 printk(VIOPATH_KERN_WARN
413 "message from invalid partition. "
414 "int msg rcvd, target inst (%d) doesnt match (%d)\n",
415 viopathStatus[remoteLp].mSourceInst,
416 event->xTargetInstanceId);
420 remoteLp = event->xTargetLp;
421 if (event->xSourceInstanceId !=
422 viopathStatus[remoteLp].mSourceInst) {
423 printk(VIOPATH_KERN_WARN
424 "message from invalid partition. "
425 "ack msg rcvd, source inst (%d) doesnt match (%d)\n",
426 viopathStatus[remoteLp].mSourceInst,
427 event->xSourceInstanceId);
431 if (event->xTargetInstanceId !=
432 viopathStatus[remoteLp].mTargetInst) {
433 printk(VIOPATH_KERN_WARN
434 "message from invalid partition. "
435 "viopath: ack msg rcvd, target inst (%d) doesnt match (%d)\n",
436 viopathStatus[remoteLp].mTargetInst,
437 event->xTargetInstanceId);
442 if (vio_handler[subtype] == NULL) {
443 printk(VIOPATH_KERN_WARN
444 "unexpected virtual io event subtype %d from partition %d\n",
445 event->xSubtype, remoteLp);
446 /* No handler. Ack if necessary */
447 if (hvlpevent_is_int(event) && hvlpevent_need_ack(event)) {
448 event->xRc = HvLpEvent_Rc_InvalidSubtype;
449 HvCallEvent_ackLpEvent(event);
454 /* This innocuous little line is where all the real work happens */
455 (*vio_handler[subtype])(event);
458 static void viopath_donealloc(void *parm, int number)
460 struct alloc_parms *parmsp = parm;
462 parmsp->number = number;
463 if (parmsp->used_wait_atomic)
464 atomic_set(&parmsp->wait_atomic, 0);
466 complete(&parmsp->done);
469 static int allocateEvents(HvLpIndex remoteLp, int numEvents)
471 struct alloc_parms parms;
473 if (system_state != SYSTEM_RUNNING) {
474 parms.used_wait_atomic = 1;
475 atomic_set(&parms.wait_atomic, 1);
477 parms.used_wait_atomic = 0;
478 init_completion(&parms.done);
480 mf_allocate_lp_events(remoteLp, HvLpEvent_Type_VirtualIo, 250, /* It would be nice to put a real number here! */
481 numEvents, &viopath_donealloc, &parms);
482 if (system_state != SYSTEM_RUNNING) {
483 while (atomic_read(&parms.wait_atomic))
486 wait_for_completion(&parms.done);
490 int viopath_open(HvLpIndex remoteLp, int subtype, int numReq)
494 int tempNumAllocated;
496 if ((remoteLp >= HVMAXARCHITECTEDLPS) || (remoteLp == HvLpIndexInvalid))
499 subtype = subtype >> VIOMAJOR_SUBTYPE_SHIFT;
500 if ((subtype < 0) || (subtype >= VIO_MAX_SUBTYPES))
503 spin_lock_irqsave(&statuslock, flags);
505 if (!event_buffer_initialised) {
506 for (i = 0; i < VIO_MAX_SUBTYPES; i++)
507 atomic_set(&event_buffer_available[i], 1);
508 event_buffer_initialised = 1;
511 viopathStatus[remoteLp].users[subtype]++;
513 if (!viopathStatus[remoteLp].isOpen) {
514 viopathStatus[remoteLp].isOpen = 1;
515 HvCallEvent_openLpEventPath(remoteLp, HvLpEvent_Type_VirtualIo);
518 * Don't hold the spinlock during an operation that
521 spin_unlock_irqrestore(&statuslock, flags);
522 tempNumAllocated = allocateEvents(remoteLp, 1);
523 spin_lock_irqsave(&statuslock, flags);
525 viopathStatus[remoteLp].numberAllocated += tempNumAllocated;
527 if (viopathStatus[remoteLp].numberAllocated == 0) {
528 HvCallEvent_closeLpEventPath(remoteLp,
529 HvLpEvent_Type_VirtualIo);
531 spin_unlock_irqrestore(&statuslock, flags);
535 viopathStatus[remoteLp].mSourceInst =
536 HvCallEvent_getSourceLpInstanceId(remoteLp,
537 HvLpEvent_Type_VirtualIo);
538 viopathStatus[remoteLp].mTargetInst =
539 HvCallEvent_getTargetLpInstanceId(remoteLp,
540 HvLpEvent_Type_VirtualIo);
541 HvLpEvent_registerHandler(HvLpEvent_Type_VirtualIo,
543 sendMonMsg(remoteLp);
544 printk(VIOPATH_KERN_INFO "opening connection to partition %d, "
545 "setting sinst %d, tinst %d\n",
546 remoteLp, viopathStatus[remoteLp].mSourceInst,
547 viopathStatus[remoteLp].mTargetInst);
550 spin_unlock_irqrestore(&statuslock, flags);
551 tempNumAllocated = allocateEvents(remoteLp, numReq);
552 spin_lock_irqsave(&statuslock, flags);
553 viopathStatus[remoteLp].numberAllocated += tempNumAllocated;
554 spin_unlock_irqrestore(&statuslock, flags);
558 EXPORT_SYMBOL(viopath_open);
560 int viopath_close(HvLpIndex remoteLp, int subtype, int numReq)
565 struct alloc_parms parms;
567 if ((remoteLp >= HVMAXARCHITECTEDLPS) || (remoteLp == HvLpIndexInvalid))
570 subtype = subtype >> VIOMAJOR_SUBTYPE_SHIFT;
571 if ((subtype < 0) || (subtype >= VIO_MAX_SUBTYPES))
574 spin_lock_irqsave(&statuslock, flags);
576 * If the viopath_close somehow gets called before a
577 * viopath_open it could decrement to -1 which is a non
578 * recoverable state so we'll prevent this from
581 if (viopathStatus[remoteLp].users[subtype] > 0)
582 viopathStatus[remoteLp].users[subtype]--;
584 spin_unlock_irqrestore(&statuslock, flags);
586 parms.used_wait_atomic = 0;
587 init_completion(&parms.done);
588 mf_deallocate_lp_events(remoteLp, HvLpEvent_Type_VirtualIo,
589 numReq, &viopath_donealloc, &parms);
590 wait_for_completion(&parms.done);
592 spin_lock_irqsave(&statuslock, flags);
593 for (i = 0, numOpen = 0; i < VIO_MAX_SUBTYPES; i++)
594 numOpen += viopathStatus[remoteLp].users[i];
596 if ((viopathStatus[remoteLp].isOpen) && (numOpen == 0)) {
597 printk(VIOPATH_KERN_INFO "closing connection to partition %d\n",
600 HvCallEvent_closeLpEventPath(remoteLp,
601 HvLpEvent_Type_VirtualIo);
602 viopathStatus[remoteLp].isOpen = 0;
603 viopathStatus[remoteLp].isActive = 0;
605 for (i = 0; i < VIO_MAX_SUBTYPES; i++)
606 atomic_set(&event_buffer_available[i], 0);
607 event_buffer_initialised = 0;
609 spin_unlock_irqrestore(&statuslock, flags);
612 EXPORT_SYMBOL(viopath_close);
614 void *vio_get_event_buffer(int subtype)
616 subtype = subtype >> VIOMAJOR_SUBTYPE_SHIFT;
617 if ((subtype < 0) || (subtype >= VIO_MAX_SUBTYPES))
620 if (atomic_dec_if_positive(&event_buffer_available[subtype]) == 0)
621 return &event_buffer[subtype * 256];
625 EXPORT_SYMBOL(vio_get_event_buffer);
627 void vio_free_event_buffer(int subtype, void *buffer)
629 subtype = subtype >> VIOMAJOR_SUBTYPE_SHIFT;
630 if ((subtype < 0) || (subtype >= VIO_MAX_SUBTYPES)) {
631 printk(VIOPATH_KERN_WARN
632 "unexpected subtype %d freeing event buffer\n", subtype);
636 if (atomic_read(&event_buffer_available[subtype]) != 0) {
637 printk(VIOPATH_KERN_WARN
638 "freeing unallocated event buffer, subtype %d\n",
643 if (buffer != &event_buffer[subtype * 256]) {
644 printk(VIOPATH_KERN_WARN
645 "freeing invalid event buffer, subtype %d\n", subtype);
648 atomic_set(&event_buffer_available[subtype], 1);
650 EXPORT_SYMBOL(vio_free_event_buffer);
652 static const struct vio_error_entry vio_no_error =
653 { 0, 0, "Non-VIO Error" };
654 static const struct vio_error_entry vio_unknown_error =
655 { 0, EIO, "Unknown Error" };
657 static const struct vio_error_entry vio_default_errors[] = {
658 {0x0001, EIO, "No Connection"},
659 {0x0002, EIO, "No Receiver"},
660 {0x0003, EIO, "No Buffer Available"},
661 {0x0004, EBADRQC, "Invalid Message Type"},
665 const struct vio_error_entry *vio_lookup_rc(
666 const struct vio_error_entry *local_table, u16 rc)
668 const struct vio_error_entry *cur;
671 return &vio_no_error;
673 for (cur = local_table; cur->rc; ++cur)
676 for (cur = vio_default_errors; cur->rc; ++cur)
679 return &vio_unknown_error;
681 EXPORT_SYMBOL(vio_lookup_rc);