xref: /onnv-gate/usr/src/uts/sun4u/starcat/sys/sckm_msg.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	_SYS_SCKM_MSG_H
28*0Sstevel@tonic-gate #define	_SYS_SCKM_MSG_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifdef	__cplusplus
33*0Sstevel@tonic-gate extern "C" {
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate /*
37*0Sstevel@tonic-gate  * This header file describes the format of the IOSRAM mailbox messages
38*0Sstevel@tonic-gate  * exchanged between the sckmr driver on a Starcat Domain and the
39*0Sstevel@tonic-gate  * Starcat System Controller.
40*0Sstevel@tonic-gate  */
41*0Sstevel@tonic-gate 
42*0Sstevel@tonic-gate #include <sys/types.h>
43*0Sstevel@tonic-gate 
44*0Sstevel@tonic-gate /*
45*0Sstevel@tonic-gate  * MBOXSC_MSG_EVENT or MBOXSC_MSG_REQUEST message header.
46*0Sstevel@tonic-gate  */
47*0Sstevel@tonic-gate typedef struct sckm_mbox_req_hdr {
48*0Sstevel@tonic-gate 	uint32_t sckm_version;		/* protocol version */
49*0Sstevel@tonic-gate 	uint32_t reserved;
50*0Sstevel@tonic-gate } sckm_mbox_req_hdr_t;
51*0Sstevel@tonic-gate 
52*0Sstevel@tonic-gate /*
53*0Sstevel@tonic-gate  * MBOXSC_MSG_REPLY message header
54*0Sstevel@tonic-gate  */
55*0Sstevel@tonic-gate typedef struct sckm_mbox_rep_hdr {
56*0Sstevel@tonic-gate 	uint32_t sckm_version;		/* protocol version */
57*0Sstevel@tonic-gate 	uint32_t status;		/* error code */
58*0Sstevel@tonic-gate 	uint32_t sadb_msg_errno;	/* PF_KEY errno, if applicable */
59*0Sstevel@tonic-gate 	uint32_t sadb_msg_version;	/* PF_KEY version, if applicable */
60*0Sstevel@tonic-gate } sckm_mbox_rep_hdr_t;
61*0Sstevel@tonic-gate 
62*0Sstevel@tonic-gate /*
63*0Sstevel@tonic-gate  * Version of this current protocol.
64*0Sstevel@tonic-gate  */
65*0Sstevel@tonic-gate #define	SCKM_PROTOCOL_VERSION	1
66*0Sstevel@tonic-gate 
67*0Sstevel@tonic-gate /*
68*0Sstevel@tonic-gate  * Keys for SC to Domain and Domain to SC mailboxes
69*0Sstevel@tonic-gate  */
70*0Sstevel@tonic-gate #define	KEY_SCKD	0x53434b44	/* SC to Domain mailbox */
71*0Sstevel@tonic-gate #define	KEY_KDSC	0x4b445343	/* Domain to SC mailbox */
72*0Sstevel@tonic-gate 
73*0Sstevel@tonic-gate /*
74*0Sstevel@tonic-gate  * Max data size, in bytes, for IOSRAM mailboxes
75*0Sstevel@tonic-gate  */
76*0Sstevel@tonic-gate #define	SCKM_SCKD_MAXDATA	1024
77*0Sstevel@tonic-gate #define	SCKM_KDSC_MAXDATA	1024
78*0Sstevel@tonic-gate 
79*0Sstevel@tonic-gate /*
80*0Sstevel@tonic-gate  * Message types.
81*0Sstevel@tonic-gate  */
82*0Sstevel@tonic-gate #define	SCKM_MSG_SADB		0x1	/* SADB message		SC<->D */
83*0Sstevel@tonic-gate 
84*0Sstevel@tonic-gate /*
85*0Sstevel@tonic-gate  * Values for sckm_msg_rep_hdr status field.
86*0Sstevel@tonic-gate  */
87*0Sstevel@tonic-gate #define	SCKM_SUCCESS		0x0	/* Operation succeeded */
88*0Sstevel@tonic-gate #define	SCKM_ERR_VERSION	0x1	/* Unexpected version */
89*0Sstevel@tonic-gate #define	SCKM_ERR_SADB_PFKEY	0x2	/* PF_KEY returned an error */
90*0Sstevel@tonic-gate #define	SCKM_ERR_SADB_MSG	0x3	/* bad SADB msg detect by driver */
91*0Sstevel@tonic-gate #define	SCKM_ERR_DAEMON		0x4	/* Error communicating with daemon */
92*0Sstevel@tonic-gate #define	SCKM_ERR_BAD_CMD	0x5	/* unknown command */
93*0Sstevel@tonic-gate #define	SCKM_ERR_SADB_VERSION	0x6	/* bad SADB version */
94*0Sstevel@tonic-gate #define	SCKM_ERR_SADB_TIMEOUT	0x7	/* no response from key engine */
95*0Sstevel@tonic-gate #define	SCKM_ERR_SADB_BAD_TYPE	0x8	/* bad SADB msg type */
96*0Sstevel@tonic-gate 
97*0Sstevel@tonic-gate #ifdef	__cplusplus
98*0Sstevel@tonic-gate }
99*0Sstevel@tonic-gate #endif
100*0Sstevel@tonic-gate 
101*0Sstevel@tonic-gate #endif /* _SYS_SCKM_MSG_H */
102