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/LparData.h>
47 #include <asm/iSeries/HvLpEvent.h>
48 #include <asm/iSeries/HvLpConfig.h>
49 #include <asm/iSeries/HvCallCfg.h>
50 #include <asm/iSeries/mf.h>
51 #include <asm/iSeries/iSeries_proc.h>
52 #include <asm/iSeries/vio.h>
54 /* Status of the path to each other partition in the system.
55 * This is overkill, since we will only ever establish connections
56 * to our hosting partition and the primary partition on the system.
57 * But this allows for other support in the future.
59 static struct viopathStatus
{
60 int isOpen
; /* Did we open the path? */
61 int isActive
; /* Do we have a mon msg outstanding */
62 int users
[VIO_MAX_SUBTYPES
];
63 HvLpInstanceId mSourceInst
;
64 HvLpInstanceId mTargetInst
;
66 } viopathStatus
[HVMAXARCHITECTEDLPS
];
68 static DEFINE_SPINLOCK(statuslock
);
71 * For each kind of event we allocate a buffer that is
72 * guaranteed not to cross a page boundary
74 static unsigned char event_buffer
[VIO_MAX_SUBTYPES
* 256] __page_aligned
;
75 static atomic_t event_buffer_available
[VIO_MAX_SUBTYPES
];
76 static int event_buffer_initialised
;
78 static void handleMonitorEvent(struct HvLpEvent
*event
);
81 * We use this structure to handle asynchronous responses. The caller
82 * blocks on the semaphore and the handler posts the semaphore. However,
83 * if system_state is not SYSTEM_RUNNING, then wait_atomic is used ...
92 /* Put a sequence number in each mon msg. The value is not
93 * important. Start at something other than 0 just for
94 * readability. wrapping this is ok.
96 static u8 viomonseq
= 22;
98 /* Our hosting logical partition. We get this at startup
99 * time, and different modules access this variable directly.
101 HvLpIndex viopath_hostLp
= HvLpIndexInvalid
;
102 EXPORT_SYMBOL(viopath_hostLp
);
103 HvLpIndex viopath_ourLp
= HvLpIndexInvalid
;
104 EXPORT_SYMBOL(viopath_ourLp
);
106 /* For each kind of incoming event we set a pointer to a
109 static vio_event_handler_t
*vio_handler
[VIO_MAX_SUBTYPES
];
111 #define VIOPATH_KERN_WARN KERN_WARNING "viopath: "
112 #define VIOPATH_KERN_INFO KERN_INFO "viopath: "
114 static int proc_viopath_show(struct seq_file
*m
, void *v
)
120 DECLARE_MUTEX_LOCKED(Semaphore
);
122 buf
= kmalloc(PAGE_SIZE
, GFP_KERNEL
);
125 memset(buf
, 0, PAGE_SIZE
);
127 handle
= dma_map_single(iSeries_vio_dev
, buf
, PAGE_SIZE
,
130 hvrc
= HvCallEvent_signalLpEventFast(viopath_hostLp
,
131 HvLpEvent_Type_VirtualIo
,
132 viomajorsubtype_config
| vioconfigget
,
133 HvLpEvent_AckInd_DoAck
, HvLpEvent_AckType_ImmediateAck
,
134 viopath_sourceinst(viopath_hostLp
),
135 viopath_targetinst(viopath_hostLp
),
136 (u64
)(unsigned long)&Semaphore
, VIOVERSION
<< 16,
137 ((u64
)handle
) << 32, PAGE_SIZE
, 0, 0);
139 if (hvrc
!= HvLpEvent_Rc_Good
)
140 printk(VIOPATH_KERN_WARN
"hv error on op %d\n", (int)hvrc
);
144 vlanMap
= HvLpConfig_getVirtualLanIndexMap();
146 buf
[PAGE_SIZE
-1] = '\0';
147 seq_printf(m
, "%s", buf
);
148 seq_printf(m
, "AVAILABLE_VETH=%x\n", vlanMap
);
149 seq_printf(m
, "SRLNBR=%c%c%c%c%c%c%c\n",
150 e2a(xItExtVpdPanel
.mfgID
[2]),
151 e2a(xItExtVpdPanel
.mfgID
[3]),
152 e2a(xItExtVpdPanel
.systemSerial
[1]),
153 e2a(xItExtVpdPanel
.systemSerial
[2]),
154 e2a(xItExtVpdPanel
.systemSerial
[3]),
155 e2a(xItExtVpdPanel
.systemSerial
[4]),
156 e2a(xItExtVpdPanel
.systemSerial
[5]));
158 dma_unmap_single(iSeries_vio_dev
, handle
, PAGE_SIZE
, DMA_FROM_DEVICE
);
164 static int proc_viopath_open(struct inode
*inode
, struct file
*file
)
166 return single_open(file
, proc_viopath_show
, NULL
);
169 static struct file_operations proc_viopath_operations
= {
170 .open
= proc_viopath_open
,
173 .release
= single_release
,
176 static int __init
vio_proc_init(void)
178 struct proc_dir_entry
*e
;
180 e
= create_proc_entry("iSeries/config", 0, NULL
);
182 e
->proc_fops
= &proc_viopath_operations
;
186 __initcall(vio_proc_init
);
188 /* See if a given LP is active. Allow for invalid lps to be passed in
189 * and just return invalid
191 int viopath_isactive(HvLpIndex lp
)
193 if (lp
== HvLpIndexInvalid
)
195 if (lp
< HVMAXARCHITECTEDLPS
)
196 return viopathStatus
[lp
].isActive
;
200 EXPORT_SYMBOL(viopath_isactive
);
203 * We cache the source and target instance ids for each
206 HvLpInstanceId
viopath_sourceinst(HvLpIndex lp
)
208 return viopathStatus
[lp
].mSourceInst
;
210 EXPORT_SYMBOL(viopath_sourceinst
);
212 HvLpInstanceId
viopath_targetinst(HvLpIndex lp
)
214 return viopathStatus
[lp
].mTargetInst
;
216 EXPORT_SYMBOL(viopath_targetinst
);
219 * Send a monitor message. This is a message with the acknowledge
220 * bit on that the other side will NOT explicitly acknowledge. When
221 * the other side goes down, the hypervisor will acknowledge any
222 * outstanding messages....so we will know when the other side dies.
224 static void sendMonMsg(HvLpIndex remoteLp
)
228 viopathStatus
[remoteLp
].mSourceInst
=
229 HvCallEvent_getSourceLpInstanceId(remoteLp
,
230 HvLpEvent_Type_VirtualIo
);
231 viopathStatus
[remoteLp
].mTargetInst
=
232 HvCallEvent_getTargetLpInstanceId(remoteLp
,
233 HvLpEvent_Type_VirtualIo
);
236 * Deliberately ignore the return code here. if we call this
237 * more than once, we don't care.
239 vio_setHandler(viomajorsubtype_monitor
, handleMonitorEvent
);
241 hvrc
= HvCallEvent_signalLpEventFast(remoteLp
, HvLpEvent_Type_VirtualIo
,
242 viomajorsubtype_monitor
, HvLpEvent_AckInd_DoAck
,
243 HvLpEvent_AckType_DeferredAck
,
244 viopathStatus
[remoteLp
].mSourceInst
,
245 viopathStatus
[remoteLp
].mTargetInst
,
246 viomonseq
++, 0, 0, 0, 0, 0);
248 if (hvrc
== HvLpEvent_Rc_Good
)
249 viopathStatus
[remoteLp
].isActive
= 1;
251 printk(VIOPATH_KERN_WARN
"could not connect to partition %d\n",
253 viopathStatus
[remoteLp
].isActive
= 0;
257 static void handleMonitorEvent(struct HvLpEvent
*event
)
263 * This handler is _also_ called as part of the loop
264 * at the end of this routine, so it must be able to
265 * ignore NULL events...
271 * First see if this is just a normal monitor message from the
274 if (event
->xFlags
.xFunction
== HvLpEvent_Function_Int
) {
275 remoteLp
= event
->xSourceLp
;
276 if (!viopathStatus
[remoteLp
].isActive
)
277 sendMonMsg(remoteLp
);
282 * This path is for an acknowledgement; the other partition
285 remoteLp
= event
->xTargetLp
;
286 if ((event
->xSourceInstanceId
!= viopathStatus
[remoteLp
].mSourceInst
) ||
287 (event
->xTargetInstanceId
!= viopathStatus
[remoteLp
].mTargetInst
)) {
288 printk(VIOPATH_KERN_WARN
"ignoring ack....mismatched instances\n");
292 printk(VIOPATH_KERN_WARN
"partition %d ended\n", remoteLp
);
294 viopathStatus
[remoteLp
].isActive
= 0;
297 * For each active handler, pass them a NULL
298 * message to indicate that the other partition
301 for (i
= 0; i
< VIO_MAX_SUBTYPES
; i
++) {
302 if (vio_handler
[i
] != NULL
)
303 (*vio_handler
[i
])(NULL
);
307 int vio_setHandler(int subtype
, vio_event_handler_t
*beh
)
309 subtype
= subtype
>> VIOMAJOR_SUBTYPE_SHIFT
;
310 if ((subtype
< 0) || (subtype
>= VIO_MAX_SUBTYPES
))
312 if (vio_handler
[subtype
] != NULL
)
314 vio_handler
[subtype
] = beh
;
317 EXPORT_SYMBOL(vio_setHandler
);
319 int vio_clearHandler(int subtype
)
321 subtype
= subtype
>> VIOMAJOR_SUBTYPE_SHIFT
;
322 if ((subtype
< 0) || (subtype
>= VIO_MAX_SUBTYPES
))
324 if (vio_handler
[subtype
] == NULL
)
326 vio_handler
[subtype
] = NULL
;
329 EXPORT_SYMBOL(vio_clearHandler
);
331 static void handleConfig(struct HvLpEvent
*event
)
335 if (event
->xFlags
.xFunction
== HvLpEvent_Function_Int
) {
336 printk(VIOPATH_KERN_WARN
337 "unexpected config request from partition %d",
340 if ((event
->xFlags
.xFunction
== HvLpEvent_Function_Int
) &&
341 (event
->xFlags
.xAckInd
== HvLpEvent_AckInd_DoAck
)) {
342 event
->xRc
= HvLpEvent_Rc_InvalidSubtype
;
343 HvCallEvent_ackLpEvent(event
);
348 up((struct semaphore
*)event
->xCorrelationToken
);
352 * Initialization of the hosting partition
354 void vio_set_hostlp(void)
357 * If this has already been set then we DON'T want to either change
358 * it or re-register the proc file system
360 if (viopath_hostLp
!= HvLpIndexInvalid
)
364 * Figure out our hosting partition. This isn't allowed to change
367 viopath_ourLp
= HvLpConfig_getLpIndex();
368 viopath_hostLp
= HvCallCfg_getHostingLpIndex(viopath_ourLp
);
370 if (viopath_hostLp
!= HvLpIndexInvalid
)
371 vio_setHandler(viomajorsubtype_config
, handleConfig
);
373 EXPORT_SYMBOL(vio_set_hostlp
);
375 static void vio_handleEvent(struct HvLpEvent
*event
, struct pt_regs
*regs
)
378 int subtype
= (event
->xSubtype
& VIOMAJOR_SUBTYPE_MASK
)
379 >> VIOMAJOR_SUBTYPE_SHIFT
;
381 if (event
->xFlags
.xFunction
== HvLpEvent_Function_Int
) {
382 remoteLp
= event
->xSourceLp
;
384 * The isActive is checked because if the hosting partition
385 * went down and came back up it would not be active but it
386 * would have different source and target instances, in which
387 * case we'd want to reset them. This case really protects
388 * against an unauthorized active partition sending interrupts
389 * or acks to this linux partition.
391 if (viopathStatus
[remoteLp
].isActive
392 && (event
->xSourceInstanceId
!=
393 viopathStatus
[remoteLp
].mTargetInst
)) {
394 printk(VIOPATH_KERN_WARN
395 "message from invalid partition. "
396 "int msg rcvd, source inst (%d) doesnt match (%d)\n",
397 viopathStatus
[remoteLp
].mTargetInst
,
398 event
->xSourceInstanceId
);
402 if (viopathStatus
[remoteLp
].isActive
403 && (event
->xTargetInstanceId
!=
404 viopathStatus
[remoteLp
].mSourceInst
)) {
405 printk(VIOPATH_KERN_WARN
406 "message from invalid partition. "
407 "int msg rcvd, target inst (%d) doesnt match (%d)\n",
408 viopathStatus
[remoteLp
].mSourceInst
,
409 event
->xTargetInstanceId
);
413 remoteLp
= event
->xTargetLp
;
414 if (event
->xSourceInstanceId
!=
415 viopathStatus
[remoteLp
].mSourceInst
) {
416 printk(VIOPATH_KERN_WARN
417 "message from invalid partition. "
418 "ack msg rcvd, source inst (%d) doesnt match (%d)\n",
419 viopathStatus
[remoteLp
].mSourceInst
,
420 event
->xSourceInstanceId
);
424 if (event
->xTargetInstanceId
!=
425 viopathStatus
[remoteLp
].mTargetInst
) {
426 printk(VIOPATH_KERN_WARN
427 "message from invalid partition. "
428 "viopath: ack msg rcvd, target inst (%d) doesnt match (%d)\n",
429 viopathStatus
[remoteLp
].mTargetInst
,
430 event
->xTargetInstanceId
);
435 if (vio_handler
[subtype
] == NULL
) {
436 printk(VIOPATH_KERN_WARN
437 "unexpected virtual io event subtype %d from partition %d\n",
438 event
->xSubtype
, remoteLp
);
439 /* No handler. Ack if necessary */
440 if ((event
->xFlags
.xFunction
== HvLpEvent_Function_Int
) &&
441 (event
->xFlags
.xAckInd
== HvLpEvent_AckInd_DoAck
)) {
442 event
->xRc
= HvLpEvent_Rc_InvalidSubtype
;
443 HvCallEvent_ackLpEvent(event
);
448 /* This innocuous little line is where all the real work happens */
449 (*vio_handler
[subtype
])(event
);
452 static void viopath_donealloc(void *parm
, int number
)
454 struct alloc_parms
*parmsp
= parm
;
456 parmsp
->number
= number
;
457 if (parmsp
->used_wait_atomic
)
458 atomic_set(&parmsp
->wait_atomic
, 0);
463 static int allocateEvents(HvLpIndex remoteLp
, int numEvents
)
465 struct alloc_parms parms
;
467 if (system_state
!= SYSTEM_RUNNING
) {
468 parms
.used_wait_atomic
= 1;
469 atomic_set(&parms
.wait_atomic
, 1);
471 parms
.used_wait_atomic
= 0;
472 init_MUTEX_LOCKED(&parms
.sem
);
474 mf_allocate_lp_events(remoteLp
, HvLpEvent_Type_VirtualIo
, 250, /* It would be nice to put a real number here! */
475 numEvents
, &viopath_donealloc
, &parms
);
476 if (system_state
!= SYSTEM_RUNNING
) {
477 while (atomic_read(&parms
.wait_atomic
))
484 int viopath_open(HvLpIndex remoteLp
, int subtype
, int numReq
)
488 int tempNumAllocated
;
490 if ((remoteLp
>= HvMaxArchitectedLps
) || (remoteLp
== HvLpIndexInvalid
))
493 subtype
= subtype
>> VIOMAJOR_SUBTYPE_SHIFT
;
494 if ((subtype
< 0) || (subtype
>= VIO_MAX_SUBTYPES
))
497 spin_lock_irqsave(&statuslock
, flags
);
499 if (!event_buffer_initialised
) {
500 for (i
= 0; i
< VIO_MAX_SUBTYPES
; i
++)
501 atomic_set(&event_buffer_available
[i
], 1);
502 event_buffer_initialised
= 1;
505 viopathStatus
[remoteLp
].users
[subtype
]++;
507 if (!viopathStatus
[remoteLp
].isOpen
) {
508 viopathStatus
[remoteLp
].isOpen
= 1;
509 HvCallEvent_openLpEventPath(remoteLp
, HvLpEvent_Type_VirtualIo
);
512 * Don't hold the spinlock during an operation that
515 spin_unlock_irqrestore(&statuslock
, flags
);
516 tempNumAllocated
= allocateEvents(remoteLp
, 1);
517 spin_lock_irqsave(&statuslock
, flags
);
519 viopathStatus
[remoteLp
].numberAllocated
+= tempNumAllocated
;
521 if (viopathStatus
[remoteLp
].numberAllocated
== 0) {
522 HvCallEvent_closeLpEventPath(remoteLp
,
523 HvLpEvent_Type_VirtualIo
);
525 spin_unlock_irqrestore(&statuslock
, flags
);
529 viopathStatus
[remoteLp
].mSourceInst
=
530 HvCallEvent_getSourceLpInstanceId(remoteLp
,
531 HvLpEvent_Type_VirtualIo
);
532 viopathStatus
[remoteLp
].mTargetInst
=
533 HvCallEvent_getTargetLpInstanceId(remoteLp
,
534 HvLpEvent_Type_VirtualIo
);
535 HvLpEvent_registerHandler(HvLpEvent_Type_VirtualIo
,
537 sendMonMsg(remoteLp
);
538 printk(VIOPATH_KERN_INFO
"opening connection to partition %d, "
539 "setting sinst %d, tinst %d\n",
540 remoteLp
, viopathStatus
[remoteLp
].mSourceInst
,
541 viopathStatus
[remoteLp
].mTargetInst
);
544 spin_unlock_irqrestore(&statuslock
, flags
);
545 tempNumAllocated
= allocateEvents(remoteLp
, numReq
);
546 spin_lock_irqsave(&statuslock
, flags
);
547 viopathStatus
[remoteLp
].numberAllocated
+= tempNumAllocated
;
548 spin_unlock_irqrestore(&statuslock
, flags
);
552 EXPORT_SYMBOL(viopath_open
);
554 int viopath_close(HvLpIndex remoteLp
, int subtype
, int numReq
)
559 struct alloc_parms parms
;
561 if ((remoteLp
>= HvMaxArchitectedLps
) || (remoteLp
== HvLpIndexInvalid
))
564 subtype
= subtype
>> VIOMAJOR_SUBTYPE_SHIFT
;
565 if ((subtype
< 0) || (subtype
>= VIO_MAX_SUBTYPES
))
568 spin_lock_irqsave(&statuslock
, flags
);
570 * If the viopath_close somehow gets called before a
571 * viopath_open it could decrement to -1 which is a non
572 * recoverable state so we'll prevent this from
575 if (viopathStatus
[remoteLp
].users
[subtype
] > 0)
576 viopathStatus
[remoteLp
].users
[subtype
]--;
578 spin_unlock_irqrestore(&statuslock
, flags
);
580 parms
.used_wait_atomic
= 0;
581 init_MUTEX_LOCKED(&parms
.sem
);
582 mf_deallocate_lp_events(remoteLp
, HvLpEvent_Type_VirtualIo
,
583 numReq
, &viopath_donealloc
, &parms
);
586 spin_lock_irqsave(&statuslock
, flags
);
587 for (i
= 0, numOpen
= 0; i
< VIO_MAX_SUBTYPES
; i
++)
588 numOpen
+= viopathStatus
[remoteLp
].users
[i
];
590 if ((viopathStatus
[remoteLp
].isOpen
) && (numOpen
== 0)) {
591 printk(VIOPATH_KERN_INFO
"closing connection to partition %d",
594 HvCallEvent_closeLpEventPath(remoteLp
,
595 HvLpEvent_Type_VirtualIo
);
596 viopathStatus
[remoteLp
].isOpen
= 0;
597 viopathStatus
[remoteLp
].isActive
= 0;
599 for (i
= 0; i
< VIO_MAX_SUBTYPES
; i
++)
600 atomic_set(&event_buffer_available
[i
], 0);
601 event_buffer_initialised
= 0;
603 spin_unlock_irqrestore(&statuslock
, flags
);
606 EXPORT_SYMBOL(viopath_close
);
608 void *vio_get_event_buffer(int subtype
)
610 subtype
= subtype
>> VIOMAJOR_SUBTYPE_SHIFT
;
611 if ((subtype
< 0) || (subtype
>= VIO_MAX_SUBTYPES
))
614 if (atomic_dec_if_positive(&event_buffer_available
[subtype
]) == 0)
615 return &event_buffer
[subtype
* 256];
619 EXPORT_SYMBOL(vio_get_event_buffer
);
621 void vio_free_event_buffer(int subtype
, void *buffer
)
623 subtype
= subtype
>> VIOMAJOR_SUBTYPE_SHIFT
;
624 if ((subtype
< 0) || (subtype
>= VIO_MAX_SUBTYPES
)) {
625 printk(VIOPATH_KERN_WARN
626 "unexpected subtype %d freeing event buffer\n", subtype
);
630 if (atomic_read(&event_buffer_available
[subtype
]) != 0) {
631 printk(VIOPATH_KERN_WARN
632 "freeing unallocated event buffer, subtype %d\n",
637 if (buffer
!= &event_buffer
[subtype
* 256]) {
638 printk(VIOPATH_KERN_WARN
639 "freeing invalid event buffer, subtype %d\n", subtype
);
642 atomic_set(&event_buffer_available
[subtype
], 1);
644 EXPORT_SYMBOL(vio_free_event_buffer
);
646 static const struct vio_error_entry vio_no_error
=
647 { 0, 0, "Non-VIO Error" };
648 static const struct vio_error_entry vio_unknown_error
=
649 { 0, EIO
, "Unknown Error" };
651 static const struct vio_error_entry vio_default_errors
[] = {
652 {0x0001, EIO
, "No Connection"},
653 {0x0002, EIO
, "No Receiver"},
654 {0x0003, EIO
, "No Buffer Available"},
655 {0x0004, EBADRQC
, "Invalid Message Type"},
659 const struct vio_error_entry
*vio_lookup_rc(
660 const struct vio_error_entry
*local_table
, u16 rc
)
662 const struct vio_error_entry
*cur
;
665 return &vio_no_error
;
667 for (cur
= local_table
; cur
->rc
; ++cur
)
670 for (cur
= vio_default_errors
; cur
->rc
; ++cur
)
673 return &vio_unknown_error
;
675 EXPORT_SYMBOL(vio_lookup_rc
);