1 /* viohs.c: LDOM Virtual I/O handshake helper layer.
3 * Copyright (C) 2007 David S. Miller <davem@davemloft.net>
6 #include <linux/kernel.h>
7 #include <linux/module.h>
8 #include <linux/string.h>
9 #include <linux/delay.h>
10 #include <linux/sched.h>
11 #include <linux/slab.h>
16 int vio_ldc_send(struct vio_driver_state
*vio
, void *data
, int len
)
18 int err
, limit
= 1000;
22 err
= ldc_write(vio
->lp
, data
, len
);
23 if (!err
|| (err
!= -EAGAIN
))
30 EXPORT_SYMBOL(vio_ldc_send
);
32 static int send_ctrl(struct vio_driver_state
*vio
,
33 struct vio_msg_tag
*tag
, int len
)
35 tag
->sid
= vio_send_sid(vio
);
36 return vio_ldc_send(vio
, tag
, len
);
39 static void init_tag(struct vio_msg_tag
*tag
, u8 type
, u8 stype
, u16 stype_env
)
43 tag
->stype_env
= stype_env
;
46 static int send_version(struct vio_driver_state
*vio
, u16 major
, u16 minor
)
48 struct vio_ver_info pkt
;
50 vio
->_local_sid
= (u32
) sched_clock();
52 memset(&pkt
, 0, sizeof(pkt
));
53 init_tag(&pkt
.tag
, VIO_TYPE_CTRL
, VIO_SUBTYPE_INFO
, VIO_VER_INFO
);
56 pkt
.dev_class
= vio
->dev_class
;
58 viodbg(HS
, "SEND VERSION INFO maj[%u] min[%u] devclass[%u]\n",
59 major
, minor
, vio
->dev_class
);
61 return send_ctrl(vio
, &pkt
.tag
, sizeof(pkt
));
64 static int start_handshake(struct vio_driver_state
*vio
)
68 viodbg(HS
, "START HANDSHAKE\n");
70 vio
->hs_state
= VIO_HS_INVALID
;
72 err
= send_version(vio
,
73 vio
->ver_table
[0].major
,
74 vio
->ver_table
[0].minor
);
81 static void flush_rx_dring(struct vio_driver_state
*vio
)
83 struct vio_dring_state
*dr
;
86 BUG_ON(!(vio
->dr_state
& VIO_DR_STATE_RXREG
));
88 dr
= &vio
->drings
[VIO_DRIVER_RX_RING
];
91 BUG_ON(!vio
->desc_buf
);
95 memset(dr
, 0, sizeof(*dr
));
99 void vio_link_state_change(struct vio_driver_state
*vio
, int event
)
101 if (event
== LDC_EVENT_UP
) {
102 vio
->hs_state
= VIO_HS_INVALID
;
104 switch (vio
->dev_class
) {
106 case VDEV_NETWORK_SWITCH
:
107 vio
->dr_state
= (VIO_DR_STATE_TXREQ
|
112 vio
->dr_state
= VIO_DR_STATE_TXREQ
;
114 case VDEV_DISK_SERVER
:
115 vio
->dr_state
= VIO_DR_STATE_RXREQ
;
118 start_handshake(vio
);
119 } else if (event
== LDC_EVENT_RESET
) {
120 vio
->hs_state
= VIO_HS_INVALID
;
122 if (vio
->dr_state
& VIO_DR_STATE_RXREG
)
125 vio
->dr_state
= 0x00;
126 memset(&vio
->ver
, 0, sizeof(vio
->ver
));
128 ldc_disconnect(vio
->lp
);
131 EXPORT_SYMBOL(vio_link_state_change
);
133 static int handshake_failure(struct vio_driver_state
*vio
)
135 struct vio_dring_state
*dr
;
137 /* XXX Put policy here... Perhaps start a timer to fire
138 * XXX in 100 ms, which will bring the link up and retry
142 viodbg(HS
, "HANDSHAKE FAILURE\n");
144 vio
->dr_state
&= ~(VIO_DR_STATE_TXREG
|
147 dr
= &vio
->drings
[VIO_DRIVER_RX_RING
];
148 memset(dr
, 0, sizeof(*dr
));
150 kfree(vio
->desc_buf
);
151 vio
->desc_buf
= NULL
;
152 vio
->desc_buf_len
= 0;
154 vio
->hs_state
= VIO_HS_INVALID
;
159 static int process_unknown(struct vio_driver_state
*vio
, void *arg
)
161 struct vio_msg_tag
*pkt
= arg
;
163 viodbg(HS
, "UNKNOWN CONTROL [%02x:%02x:%04x:%08x]\n",
164 pkt
->type
, pkt
->stype
, pkt
->stype_env
, pkt
->sid
);
166 printk(KERN_ERR
"vio: ID[%lu] Resetting connection.\n",
167 vio
->vdev
->channel_id
);
169 ldc_disconnect(vio
->lp
);
174 static int send_dreg(struct vio_driver_state
*vio
)
176 struct vio_dring_state
*dr
= &vio
->drings
[VIO_DRIVER_TX_RING
];
178 struct vio_dring_register pkt
;
179 char all
[sizeof(struct vio_dring_register
) +
180 (sizeof(struct ldc_trans_cookie
) *
185 memset(&u
, 0, sizeof(u
));
186 init_tag(&u
.pkt
.tag
, VIO_TYPE_CTRL
, VIO_SUBTYPE_INFO
, VIO_DRING_REG
);
187 u
.pkt
.dring_ident
= 0;
188 u
.pkt
.num_descr
= dr
->num_entries
;
189 u
.pkt
.descr_size
= dr
->entry_size
;
190 u
.pkt
.options
= VIO_TX_DRING
;
191 u
.pkt
.num_cookies
= dr
->ncookies
;
193 viodbg(HS
, "SEND DRING_REG INFO ndesc[%u] dsz[%u] opt[0x%x] "
195 u
.pkt
.num_descr
, u
.pkt
.descr_size
, u
.pkt
.options
,
198 for (i
= 0; i
< dr
->ncookies
; i
++) {
199 u
.pkt
.cookies
[i
] = dr
->cookies
[i
];
201 viodbg(HS
, "DRING COOKIE(%d) [%016llx:%016llx]\n",
203 (unsigned long long) u
.pkt
.cookies
[i
].cookie_addr
,
204 (unsigned long long) u
.pkt
.cookies
[i
].cookie_size
);
207 return send_ctrl(vio
, &u
.pkt
.tag
, sizeof(u
));
210 static int send_rdx(struct vio_driver_state
*vio
)
214 memset(&pkt
, 0, sizeof(pkt
));
216 init_tag(&pkt
.tag
, VIO_TYPE_CTRL
, VIO_SUBTYPE_INFO
, VIO_RDX
);
218 viodbg(HS
, "SEND RDX INFO\n");
220 return send_ctrl(vio
, &pkt
.tag
, sizeof(pkt
));
223 static int send_attr(struct vio_driver_state
*vio
)
225 return vio
->ops
->send_attr(vio
);
228 static struct vio_version
*find_by_major(struct vio_driver_state
*vio
,
231 struct vio_version
*ret
= NULL
;
234 for (i
= 0; i
< vio
->ver_table_entries
; i
++) {
235 struct vio_version
*v
= &vio
->ver_table
[i
];
236 if (v
->major
<= major
) {
244 static int process_ver_info(struct vio_driver_state
*vio
,
245 struct vio_ver_info
*pkt
)
247 struct vio_version
*vap
;
250 viodbg(HS
, "GOT VERSION INFO maj[%u] min[%u] devclass[%u]\n",
251 pkt
->major
, pkt
->minor
, pkt
->dev_class
);
253 if (vio
->hs_state
!= VIO_HS_INVALID
) {
254 /* XXX Perhaps invoke start_handshake? XXX */
255 memset(&vio
->ver
, 0, sizeof(vio
->ver
));
256 vio
->hs_state
= VIO_HS_INVALID
;
259 vap
= find_by_major(vio
, pkt
->major
);
261 vio
->_peer_sid
= pkt
->tag
.sid
;
264 pkt
->tag
.stype
= VIO_SUBTYPE_NACK
;
267 viodbg(HS
, "SEND VERSION NACK maj[0] min[0]\n");
268 err
= send_ctrl(vio
, &pkt
->tag
, sizeof(*pkt
));
269 } else if (vap
->major
!= pkt
->major
) {
270 pkt
->tag
.stype
= VIO_SUBTYPE_NACK
;
271 pkt
->major
= vap
->major
;
272 pkt
->minor
= vap
->minor
;
273 viodbg(HS
, "SEND VERSION NACK maj[%u] min[%u]\n",
274 pkt
->major
, pkt
->minor
);
275 err
= send_ctrl(vio
, &pkt
->tag
, sizeof(*pkt
));
277 struct vio_version ver
= {
281 if (ver
.minor
> vap
->minor
)
282 ver
.minor
= vap
->minor
;
283 pkt
->minor
= ver
.minor
;
284 pkt
->tag
.stype
= VIO_SUBTYPE_ACK
;
285 viodbg(HS
, "SEND VERSION ACK maj[%u] min[%u]\n",
286 pkt
->major
, pkt
->minor
);
287 err
= send_ctrl(vio
, &pkt
->tag
, sizeof(*pkt
));
290 vio
->hs_state
= VIO_HS_GOTVERS
;
294 return handshake_failure(vio
);
299 static int process_ver_ack(struct vio_driver_state
*vio
,
300 struct vio_ver_info
*pkt
)
302 viodbg(HS
, "GOT VERSION ACK maj[%u] min[%u] devclass[%u]\n",
303 pkt
->major
, pkt
->minor
, pkt
->dev_class
);
305 if (vio
->hs_state
& VIO_HS_GOTVERS
) {
306 if (vio
->ver
.major
!= pkt
->major
||
307 vio
->ver
.minor
!= pkt
->minor
) {
308 pkt
->tag
.stype
= VIO_SUBTYPE_NACK
;
309 (void) send_ctrl(vio
, &pkt
->tag
, sizeof(*pkt
));
310 return handshake_failure(vio
);
313 vio
->ver
.major
= pkt
->major
;
314 vio
->ver
.minor
= pkt
->minor
;
315 vio
->hs_state
= VIO_HS_GOTVERS
;
318 switch (vio
->dev_class
) {
321 if (send_attr(vio
) < 0)
322 return handshake_failure(vio
);
332 static int process_ver_nack(struct vio_driver_state
*vio
,
333 struct vio_ver_info
*pkt
)
335 struct vio_version
*nver
;
337 viodbg(HS
, "GOT VERSION NACK maj[%u] min[%u] devclass[%u]\n",
338 pkt
->major
, pkt
->minor
, pkt
->dev_class
);
340 if (pkt
->major
== 0 && pkt
->minor
== 0)
341 return handshake_failure(vio
);
342 nver
= find_by_major(vio
, pkt
->major
);
344 return handshake_failure(vio
);
346 if (send_version(vio
, nver
->major
, nver
->minor
) < 0)
347 return handshake_failure(vio
);
352 static int process_ver(struct vio_driver_state
*vio
, struct vio_ver_info
*pkt
)
354 switch (pkt
->tag
.stype
) {
355 case VIO_SUBTYPE_INFO
:
356 return process_ver_info(vio
, pkt
);
358 case VIO_SUBTYPE_ACK
:
359 return process_ver_ack(vio
, pkt
);
361 case VIO_SUBTYPE_NACK
:
362 return process_ver_nack(vio
, pkt
);
365 return handshake_failure(vio
);
369 static int process_attr(struct vio_driver_state
*vio
, void *pkt
)
373 if (!(vio
->hs_state
& VIO_HS_GOTVERS
))
374 return handshake_failure(vio
);
376 err
= vio
->ops
->handle_attr(vio
, pkt
);
378 return handshake_failure(vio
);
380 vio
->hs_state
|= VIO_HS_GOT_ATTR
;
382 if ((vio
->dr_state
& VIO_DR_STATE_TXREQ
) &&
383 !(vio
->hs_state
& VIO_HS_SENT_DREG
)) {
384 if (send_dreg(vio
) < 0)
385 return handshake_failure(vio
);
387 vio
->hs_state
|= VIO_HS_SENT_DREG
;
393 static int all_drings_registered(struct vio_driver_state
*vio
)
395 int need_rx
, need_tx
;
397 need_rx
= (vio
->dr_state
& VIO_DR_STATE_RXREQ
);
398 need_tx
= (vio
->dr_state
& VIO_DR_STATE_TXREQ
);
401 !(vio
->dr_state
& VIO_DR_STATE_RXREG
))
405 !(vio
->dr_state
& VIO_DR_STATE_TXREG
))
411 static int process_dreg_info(struct vio_driver_state
*vio
,
412 struct vio_dring_register
*pkt
)
414 struct vio_dring_state
*dr
;
417 viodbg(HS
, "GOT DRING_REG INFO ident[%llx] "
418 "ndesc[%u] dsz[%u] opt[0x%x] ncookies[%u]\n",
419 (unsigned long long) pkt
->dring_ident
,
420 pkt
->num_descr
, pkt
->descr_size
, pkt
->options
,
423 if (!(vio
->dr_state
& VIO_DR_STATE_RXREQ
))
426 if (vio
->dr_state
& VIO_DR_STATE_RXREG
)
429 BUG_ON(vio
->desc_buf
);
431 vio
->desc_buf
= kzalloc(pkt
->descr_size
, GFP_ATOMIC
);
435 vio
->desc_buf_len
= pkt
->descr_size
;
437 dr
= &vio
->drings
[VIO_DRIVER_RX_RING
];
439 dr
->num_entries
= pkt
->num_descr
;
440 dr
->entry_size
= pkt
->descr_size
;
441 dr
->ncookies
= pkt
->num_cookies
;
442 for (i
= 0; i
< dr
->ncookies
; i
++) {
443 dr
->cookies
[i
] = pkt
->cookies
[i
];
445 viodbg(HS
, "DRING COOKIE(%d) [%016llx:%016llx]\n",
448 pkt
->cookies
[i
].cookie_addr
,
450 pkt
->cookies
[i
].cookie_size
);
453 pkt
->tag
.stype
= VIO_SUBTYPE_ACK
;
454 pkt
->dring_ident
= ++dr
->ident
;
456 viodbg(HS
, "SEND DRING_REG ACK ident[%llx]\n",
457 (unsigned long long) pkt
->dring_ident
);
459 len
= (sizeof(*pkt
) +
460 (dr
->ncookies
* sizeof(struct ldc_trans_cookie
)));
461 if (send_ctrl(vio
, &pkt
->tag
, len
) < 0)
464 vio
->dr_state
|= VIO_DR_STATE_RXREG
;
469 pkt
->tag
.stype
= VIO_SUBTYPE_NACK
;
470 viodbg(HS
, "SEND DRING_REG NACK\n");
471 (void) send_ctrl(vio
, &pkt
->tag
, sizeof(*pkt
));
473 return handshake_failure(vio
);
476 static int process_dreg_ack(struct vio_driver_state
*vio
,
477 struct vio_dring_register
*pkt
)
479 struct vio_dring_state
*dr
;
481 viodbg(HS
, "GOT DRING_REG ACK ident[%llx] "
482 "ndesc[%u] dsz[%u] opt[0x%x] ncookies[%u]\n",
483 (unsigned long long) pkt
->dring_ident
,
484 pkt
->num_descr
, pkt
->descr_size
, pkt
->options
,
487 dr
= &vio
->drings
[VIO_DRIVER_TX_RING
];
489 if (!(vio
->dr_state
& VIO_DR_STATE_TXREQ
))
490 return handshake_failure(vio
);
492 dr
->ident
= pkt
->dring_ident
;
493 vio
->dr_state
|= VIO_DR_STATE_TXREG
;
495 if (all_drings_registered(vio
)) {
496 if (send_rdx(vio
) < 0)
497 return handshake_failure(vio
);
498 vio
->hs_state
= VIO_HS_SENT_RDX
;
503 static int process_dreg_nack(struct vio_driver_state
*vio
,
504 struct vio_dring_register
*pkt
)
506 viodbg(HS
, "GOT DRING_REG NACK ident[%llx] "
507 "ndesc[%u] dsz[%u] opt[0x%x] ncookies[%u]\n",
508 (unsigned long long) pkt
->dring_ident
,
509 pkt
->num_descr
, pkt
->descr_size
, pkt
->options
,
512 return handshake_failure(vio
);
515 static int process_dreg(struct vio_driver_state
*vio
,
516 struct vio_dring_register
*pkt
)
518 if (!(vio
->hs_state
& VIO_HS_GOTVERS
))
519 return handshake_failure(vio
);
521 switch (pkt
->tag
.stype
) {
522 case VIO_SUBTYPE_INFO
:
523 return process_dreg_info(vio
, pkt
);
525 case VIO_SUBTYPE_ACK
:
526 return process_dreg_ack(vio
, pkt
);
528 case VIO_SUBTYPE_NACK
:
529 return process_dreg_nack(vio
, pkt
);
532 return handshake_failure(vio
);
536 static int process_dunreg(struct vio_driver_state
*vio
,
537 struct vio_dring_unregister
*pkt
)
539 struct vio_dring_state
*dr
= &vio
->drings
[VIO_DRIVER_RX_RING
];
541 viodbg(HS
, "GOT DRING_UNREG\n");
543 if (pkt
->dring_ident
!= dr
->ident
)
546 vio
->dr_state
&= ~VIO_DR_STATE_RXREG
;
548 memset(dr
, 0, sizeof(*dr
));
550 kfree(vio
->desc_buf
);
551 vio
->desc_buf
= NULL
;
552 vio
->desc_buf_len
= 0;
557 static int process_rdx_info(struct vio_driver_state
*vio
, struct vio_rdx
*pkt
)
559 viodbg(HS
, "GOT RDX INFO\n");
561 pkt
->tag
.stype
= VIO_SUBTYPE_ACK
;
562 viodbg(HS
, "SEND RDX ACK\n");
563 if (send_ctrl(vio
, &pkt
->tag
, sizeof(*pkt
)) < 0)
564 return handshake_failure(vio
);
566 vio
->hs_state
|= VIO_HS_SENT_RDX_ACK
;
570 static int process_rdx_ack(struct vio_driver_state
*vio
, struct vio_rdx
*pkt
)
572 viodbg(HS
, "GOT RDX ACK\n");
574 if (!(vio
->hs_state
& VIO_HS_SENT_RDX
))
575 return handshake_failure(vio
);
577 vio
->hs_state
|= VIO_HS_GOT_RDX_ACK
;
581 static int process_rdx_nack(struct vio_driver_state
*vio
, struct vio_rdx
*pkt
)
583 viodbg(HS
, "GOT RDX NACK\n");
585 return handshake_failure(vio
);
588 static int process_rdx(struct vio_driver_state
*vio
, struct vio_rdx
*pkt
)
590 if (!all_drings_registered(vio
))
591 handshake_failure(vio
);
593 switch (pkt
->tag
.stype
) {
594 case VIO_SUBTYPE_INFO
:
595 return process_rdx_info(vio
, pkt
);
597 case VIO_SUBTYPE_ACK
:
598 return process_rdx_ack(vio
, pkt
);
600 case VIO_SUBTYPE_NACK
:
601 return process_rdx_nack(vio
, pkt
);
604 return handshake_failure(vio
);
608 int vio_control_pkt_engine(struct vio_driver_state
*vio
, void *pkt
)
610 struct vio_msg_tag
*tag
= pkt
;
611 u8 prev_state
= vio
->hs_state
;
614 switch (tag
->stype_env
) {
616 err
= process_ver(vio
, pkt
);
620 err
= process_attr(vio
, pkt
);
624 err
= process_dreg(vio
, pkt
);
627 case VIO_DRING_UNREG
:
628 err
= process_dunreg(vio
, pkt
);
632 err
= process_rdx(vio
, pkt
);
636 err
= process_unknown(vio
, pkt
);
640 vio
->hs_state
!= prev_state
&&
641 (vio
->hs_state
& VIO_HS_COMPLETE
))
642 vio
->ops
->handshake_complete(vio
);
646 EXPORT_SYMBOL(vio_control_pkt_engine
);
648 void vio_conn_reset(struct vio_driver_state
*vio
)
651 EXPORT_SYMBOL(vio_conn_reset
);
653 /* The issue is that the Solaris virtual disk server just mirrors the
654 * SID values it gets from the client peer. So we work around that
655 * here in vio_{validate,send}_sid() so that the drivers don't need
656 * to be aware of this crap.
658 int vio_validate_sid(struct vio_driver_state
*vio
, struct vio_msg_tag
*tp
)
662 /* Always let VERSION+INFO packets through unchecked, they
663 * define the new SID.
665 if (tp
->type
== VIO_TYPE_CTRL
&&
666 tp
->stype
== VIO_SUBTYPE_INFO
&&
667 tp
->stype_env
== VIO_VER_INFO
)
670 /* Ok, now figure out which SID to use. */
671 switch (vio
->dev_class
) {
673 case VDEV_NETWORK_SWITCH
:
674 case VDEV_DISK_SERVER
:
676 sid
= vio
->_peer_sid
;
680 sid
= vio
->_local_sid
;
686 viodbg(DATA
, "BAD SID tag->sid[%08x] peer_sid[%08x] local_sid[%08x]\n",
687 tp
->sid
, vio
->_peer_sid
, vio
->_local_sid
);
690 EXPORT_SYMBOL(vio_validate_sid
);
692 u32
vio_send_sid(struct vio_driver_state
*vio
)
694 switch (vio
->dev_class
) {
696 case VDEV_NETWORK_SWITCH
:
699 return vio
->_local_sid
;
701 case VDEV_DISK_SERVER
:
702 return vio
->_peer_sid
;
705 EXPORT_SYMBOL(vio_send_sid
);
707 int vio_ldc_alloc(struct vio_driver_state
*vio
,
708 struct ldc_channel_config
*base_cfg
,
711 struct ldc_channel_config cfg
= *base_cfg
;
712 struct ldc_channel
*lp
;
714 cfg
.tx_irq
= vio
->vdev
->tx_irq
;
715 cfg
.rx_irq
= vio
->vdev
->rx_irq
;
717 lp
= ldc_alloc(vio
->vdev
->channel_id
, &cfg
, event_arg
);
725 EXPORT_SYMBOL(vio_ldc_alloc
);
727 void vio_ldc_free(struct vio_driver_state
*vio
)
732 kfree(vio
->desc_buf
);
733 vio
->desc_buf
= NULL
;
734 vio
->desc_buf_len
= 0;
736 EXPORT_SYMBOL(vio_ldc_free
);
738 void vio_port_up(struct vio_driver_state
*vio
)
743 spin_lock_irqsave(&vio
->lock
, flags
);
745 state
= ldc_state(vio
->lp
);
748 if (state
== LDC_STATE_INIT
) {
749 err
= ldc_bind(vio
->lp
, vio
->name
);
751 printk(KERN_WARNING
"%s: Port %lu bind failed, "
753 vio
->name
, vio
->vdev
->channel_id
, err
);
757 err
= ldc_connect(vio
->lp
);
759 printk(KERN_WARNING
"%s: Port %lu connect failed, "
761 vio
->name
, vio
->vdev
->channel_id
, err
);
764 unsigned long expires
= jiffies
+ HZ
;
766 expires
= round_jiffies(expires
);
767 mod_timer(&vio
->timer
, expires
);
770 spin_unlock_irqrestore(&vio
->lock
, flags
);
772 EXPORT_SYMBOL(vio_port_up
);
774 static void vio_port_timer(unsigned long _arg
)
776 struct vio_driver_state
*vio
= (struct vio_driver_state
*) _arg
;
781 int vio_driver_init(struct vio_driver_state
*vio
, struct vio_dev
*vdev
,
782 u8 dev_class
, struct vio_version
*ver_table
,
783 int ver_table_size
, struct vio_driver_ops
*ops
,
788 case VDEV_NETWORK_SWITCH
:
790 case VDEV_DISK_SERVER
:
797 if (!ops
->send_attr
||
799 !ops
->handshake_complete
)
802 if (!ver_table
|| ver_table_size
< 0)
808 spin_lock_init(&vio
->lock
);
812 vio
->dev_class
= dev_class
;
815 vio
->ver_table
= ver_table
;
816 vio
->ver_table_entries
= ver_table_size
;
820 setup_timer(&vio
->timer
, vio_port_timer
, (unsigned long) vio
);
824 EXPORT_SYMBOL(vio_driver_init
);