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