[OpenSPARC-T2-SAM] / obp / obp / arch / sun4v / ds-h.fth

\ ========== Copyright Header Begin ==========================================
\ 
\ Hypervisor Software File: ds-h.fth
\ 
\ Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved.
\ 
\  - Do no alter or remove copyright notices
\ 
\  - Redistribution and use of this software in source and binary forms, with 
\    or without modification, are permitted provided that the following 
\    conditions are met: 
\ 
\  - Redistribution of source code must retain the above copyright notice, 
\    this list of conditions and the following disclaimer.
\ 
\  - Redistribution in binary form must reproduce the above copyright notice,
\    this list of conditions and the following disclaimer in the
\    documentation and/or other materials provided with the distribution. 
\ 
\    Neither the name of Sun Microsystems, Inc. or the names of contributors 
\ may be used to endorse or promote products derived from this software 
\ without specific prior written permission. 
\ 
\     This software is provided "AS IS," without a warranty of any kind. 
\ ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, 
\ INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A 
\ PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN 
\ MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR 
\ ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR 
\ DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN 
\ OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR 
\ FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE 
\ DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, 
\ ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF 
\ SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
\ 
\ You acknowledge that this software is not designed, licensed or
\ intended for use in the design, construction, operation or maintenance of
\ any nuclear facility. 
\ 
\ ========== Copyright Header End ============================================
id: @(#)ds-h.fth 1.2 07/02/12
purpose: 
copyright: Copyright 2007 Sun Microsystems, Inc.  All Rights Reserved
copyright: Use is subject to license terms.

\ FWARC 2006/055

headerless

1 value ds-major		\ these should probably be words backed by
0 value ds-minor		\ buffer: (vectors)

0 value svc-handle

0 value ds-debug?

\ message header
struct
   /l	field >msg-type
   /l	field >payload-len
constant /ds-hdr

\ Openboot is not always able to dynamically allocate packets to match the
\ data being transmitted.  (For example if Solaris has taken control), so we
\ allocate a large buffer

h# 2000 dup /ds-hdr + buffer: ds-pkt-buffer
constant MAX-DS-PAYLOAD

: >payload  	( pkt -- payload-start ) 	/ds-hdr + ;
: payload>pkt	( payload-start -- pkt )	/ds-hdr - ;
: payload-len@  ( size pkt -- )			>payload-len l@  ;
: payload-len!  ( size pkt -- )			>payload-len l!  ;
: msg-type@ 	( type pkt -- )			>msg-type l@  ;
: msg-type! 	( type pkt -- )			>msg-type l!  ;
: pkt-size@ 	( pkt -- pkt-size )		>payload-len l@ /ds-hdr + ;

\ Initiate Connection request
struct
   /w	field >init-major-ver
   /w	field >init-minor-ver
constant /ds-init-req

\ Initition Acknowlegment
struct
   /w	field >init-ack-minor-vers
constant /ds-init-ack

\ Initiation Negative Acknowledgment
struct
   /w	field >init-nack-major-vers
constant /ds-init-nack

\ Register Service payload
struct
   /x	field >reg-svc-handle
   /w	field >reg-major-ver
   /w	field >reg-minor-ver
   0    field >reg-svc-id	\ actually a variable string with max len 1024
constant /ds-reg-req

\ Regiser Acknowledgment
struct
   /x	field >regack-svc-handle
   /w	field >regack-minor-vers
constant /ds-reg-ack

\ Register Negative Acknowledgment
struct
   /x	field >regnack-svc-handle
   /x	field >regnack-status
   /w	field >regnack-major-vers
constant /ds-reg-nack

\ Unregister request
struct
   /x  field >unreg-svc-handle
constant /ds-unreg-req

\ Data packet
struct
   /x  field >data-svc-handle
constant /ds-data

\ Data Error
struct
   /x	field >dsnack-svc-handle
   /x	field >dsnack-status
constant /ds-nack

\ dsnack-status values
1	constant DS-INV-HDL
2	constant DS-TYPE-UNKOWN

\ message types
0 	constant DS-INIT-REQ
1	constant DS-INIT-ACK
2	constant DS-INIT-NACK
3	constant DS-REG-REQ
4	constant DS-REG-ACK
5	constant DS-REG-NACK
6	constant DS-UNREG
7	constant DS-UNREG-ACK
8	constant DS-UNREG-NACK
9	constant DS-DATA

0 	constant DS-CLOSED
1 	constant DS-OPEN
2 	constant DS-ERROR

DS-CLOSED value domain-service-state
Commit	Line	Data
920dae64 AT	1	\ ========== Copyright Header Begin ==========================================
	2	\
	3	\ Hypervisor Software File: ds-h.fth
	4	\
	5	\ Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved.
	6	\
	7	\ - Do no alter or remove copyright notices
	8	\
	9	\ - Redistribution and use of this software in source and binary forms, with
	10	\ or without modification, are permitted provided that the following
	11	\ conditions are met:
	12	\
	13	\ - Redistribution of source code must retain the above copyright notice,
	14	\ this list of conditions and the following disclaimer.
	15	\
	16	\ - Redistribution in binary form must reproduce the above copyright notice,
	17	\ this list of conditions and the following disclaimer in the
	18	\ documentation and/or other materials provided with the distribution.
	19	\
	20	\ Neither the name of Sun Microsystems, Inc. or the names of contributors
	21	\ may be used to endorse or promote products derived from this software
	22	\ without specific prior written permission.
	23	\
	24	\ This software is provided "AS IS," without a warranty of any kind.
	25	\ ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
	26	\ INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
	27	\ PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
	28	\ MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
	29	\ ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
	30	\ DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN
	31	\ OR ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR
	32	\ FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
	33	\ DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
	34	\ ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
	35	\ SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
	36	\
	37	\ You acknowledge that this software is not designed, licensed or
	38	\ intended for use in the design, construction, operation or maintenance of
	39	\ any nuclear facility.
	40	\
	41	\ ========== Copyright Header End ============================================
	42	id: @(#)ds-h.fth 1.2 07/02/12
	43	purpose:
	44	copyright: Copyright 2007 Sun Microsystems, Inc. All Rights Reserved
	45	copyright: Use is subject to license terms.
	46
	47	\ FWARC 2006/055
	48
	49	headerless
	50
	51	1 value ds-major \ these should probably be words backed by
	52	0 value ds-minor \ buffer: (vectors)
	53
	54	0 value svc-handle
	55
	56	0 value ds-debug?
	57
	58	\ message header
	59	struct
	60	/l field >msg-type
	61	/l field >payload-len
	62	constant /ds-hdr
	63
	64	\ Openboot is not always able to dynamically allocate packets to match the
65	\ data being transmitted. (For example if Solaris has taken control), so we
66	\ allocate a large buffer
67
68	h# 2000 dup /ds-hdr + buffer: ds-pkt-buffer
69	constant MAX-DS-PAYLOAD
70
71	: >payload ( pkt -- payload-start ) /ds-hdr + ;
72	: payload>pkt ( payload-start -- pkt ) /ds-hdr - ;
73	: payload-len@ ( size pkt -- ) >payload-len l@ ;
74	: payload-len! ( size pkt -- ) >payload-len l! ;
75	: msg-type@ ( type pkt -- ) >msg-type l@ ;
76	: msg-type! ( type pkt -- ) >msg-type l! ;
77	: pkt-size@ ( pkt -- pkt-size ) >payload-len l@ /ds-hdr + ;
78
79	\ Initiate Connection request
80	struct
81	/w field >init-major-ver
82	/w field >init-minor-ver
83	constant /ds-init-req
84
85	\ Initition Acknowlegment
86	struct
87	/w field >init-ack-minor-vers
88	constant /ds-init-ack
89
90	\ Initiation Negative Acknowledgment
91	struct
92	/w field >init-nack-major-vers
93	constant /ds-init-nack
94
95	\ Register Service payload
96	struct
97	/x field >reg-svc-handle
98	/w field >reg-major-ver
99	/w field >reg-minor-ver
100	0 field >reg-svc-id \ actually a variable string with max len 1024
101	constant /ds-reg-req
102
103	\ Regiser Acknowledgment
104	struct
105	/x field >regack-svc-handle
106	/w field >regack-minor-vers
107	constant /ds-reg-ack
108
109	\ Register Negative Acknowledgment
110	struct
111	/x field >regnack-svc-handle
112	/x field >regnack-status
113	/w field >regnack-major-vers
114	constant /ds-reg-nack
115
116	\ Unregister request
117	struct
118	/x field >unreg-svc-handle
119	constant /ds-unreg-req
120
121	\ Data packet
122	struct
123	/x field >data-svc-handle
124	constant /ds-data
125
126	\ Data Error
127	struct
128	/x field >dsnack-svc-handle
129	/x field >dsnack-status
130	constant /ds-nack
131
132	\ dsnack-status values
133	1 constant DS-INV-HDL
134	2 constant DS-TYPE-UNKOWN
135
136	\ message types
137	0 constant DS-INIT-REQ
138	1 constant DS-INIT-ACK
139	2 constant DS-INIT-NACK
140	3 constant DS-REG-REQ
141	4 constant DS-REG-ACK
142	5 constant DS-REG-NACK
143	6 constant DS-UNREG
144	7 constant DS-UNREG-ACK
145	8 constant DS-UNREG-NACK
146	9 constant DS-DATA
147
148	0 constant DS-CLOSED
149	1 constant DS-OPEN
150	2 constant DS-ERROR
151
152	DS-CLOSED value domain-service-state