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 2004 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_SMC_IF_H 28*7c478bd9Sstevel@tonic-gate #define _SYS_SMC_IF_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 #define _SCIOC ('s' << 8) 37*7c478bd9Sstevel@tonic-gate 38*7c478bd9Sstevel@tonic-gate /* 39*7c478bd9Sstevel@tonic-gate * SMC Driver IOCTL 40*7c478bd9Sstevel@tonic-gate */ 41*7c478bd9Sstevel@tonic-gate #define SCIOC_MSG_SPEC (_SCIOC | 0x04) 42*7c478bd9Sstevel@tonic-gate #define SCIOC_RESERVE_SEQN (_SCIOC | 0x05) 43*7c478bd9Sstevel@tonic-gate #define SCIOC_FREE_SEQN (_SCIOC | 0x06) 44*7c478bd9Sstevel@tonic-gate #define SCIOC_SEND_SYNC_CMD (_SCIOC | 0x07) 45*7c478bd9Sstevel@tonic-gate 46*7c478bd9Sstevel@tonic-gate /* 47*7c478bd9Sstevel@tonic-gate * IOCTLs to facilitate debugging 48*7c478bd9Sstevel@tonic-gate */ 49*7c478bd9Sstevel@tonic-gate #define SCIOC_ECHO_ON_REQ (_SCIOC | 0x08) 50*7c478bd9Sstevel@tonic-gate #define SCIOC_ECHO_OFF_REQ (_SCIOC | 0x09) 51*7c478bd9Sstevel@tonic-gate 52*7c478bd9Sstevel@tonic-gate /* 53*7c478bd9Sstevel@tonic-gate * A response message can be sent from any application 54*7c478bd9Sstevel@tonic-gate * to simulate a condition of watchdog expiry or receiving 55*7c478bd9Sstevel@tonic-gate * async messages 56*7c478bd9Sstevel@tonic-gate */ 57*7c478bd9Sstevel@tonic-gate #define SCIOC_ASYNC_SIM (_SCIOC | 0x0A) 58*7c478bd9Sstevel@tonic-gate 59*7c478bd9Sstevel@tonic-gate #define SC_SUCCESS 0 60*7c478bd9Sstevel@tonic-gate #define SC_FAILURE 1 61*7c478bd9Sstevel@tonic-gate 62*7c478bd9Sstevel@tonic-gate /* 63*7c478bd9Sstevel@tonic-gate * structure definitions 64*7c478bd9Sstevel@tonic-gate */ 65*7c478bd9Sstevel@tonic-gate typedef struct { 66*7c478bd9Sstevel@tonic-gate uint8_t msg_id; 67*7c478bd9Sstevel@tonic-gate uint8_t cmd; 68*7c478bd9Sstevel@tonic-gate uint8_t len; 69*7c478bd9Sstevel@tonic-gate } sc_reqhdr_t; 70*7c478bd9Sstevel@tonic-gate 71*7c478bd9Sstevel@tonic-gate typedef struct { 72*7c478bd9Sstevel@tonic-gate uint8_t msg_id; 73*7c478bd9Sstevel@tonic-gate uint8_t cmd; /* Will be 0 is non-SMC response, e.g. wdog */ 74*7c478bd9Sstevel@tonic-gate uint8_t len; /* Length of message, including header */ 75*7c478bd9Sstevel@tonic-gate uint8_t cc; /* if non-SMC, contains MSG type */ 76*7c478bd9Sstevel@tonic-gate } sc_rsphdr_t; 77*7c478bd9Sstevel@tonic-gate 78*7c478bd9Sstevel@tonic-gate #define SC_SEND_HEADER (sizeof (sc_reqhdr_t)) 79*7c478bd9Sstevel@tonic-gate #define SC_RECV_HEADER (sizeof (sc_rsphdr_t)) 80*7c478bd9Sstevel@tonic-gate 81*7c478bd9Sstevel@tonic-gate #define SC_MSG_MAX_SIZE 0x3E 82*7c478bd9Sstevel@tonic-gate #define SC_SEND_DSIZE (SC_MSG_MAX_SIZE - SC_SEND_HEADER) 83*7c478bd9Sstevel@tonic-gate #define SC_RECV_DSIZE (SC_MSG_MAX_SIZE - SC_RECV_HEADER) 84*7c478bd9Sstevel@tonic-gate 85*7c478bd9Sstevel@tonic-gate #define SMC_CMD_FAILED -1 86*7c478bd9Sstevel@tonic-gate 87*7c478bd9Sstevel@tonic-gate typedef enum { 88*7c478bd9Sstevel@tonic-gate SC_ATTR_SHARED, 89*7c478bd9Sstevel@tonic-gate SC_ATTR_EXCLUSIVE, 90*7c478bd9Sstevel@tonic-gate SC_ATTR_CLEAR, 91*7c478bd9Sstevel@tonic-gate SC_ATTR_CLEARALL 92*7c478bd9Sstevel@tonic-gate } sc_cmd_attr_t; 93*7c478bd9Sstevel@tonic-gate 94*7c478bd9Sstevel@tonic-gate #define MAX_CMDS 16 95*7c478bd9Sstevel@tonic-gate 96*7c478bd9Sstevel@tonic-gate typedef struct { 97*7c478bd9Sstevel@tonic-gate uint8_t attribute; 98*7c478bd9Sstevel@tonic-gate uint8_t args[MAX_CMDS]; 99*7c478bd9Sstevel@tonic-gate } sc_cmdspec_t; 100*7c478bd9Sstevel@tonic-gate 101*7c478bd9Sstevel@tonic-gate #define SC_CMDSPEC_ATTR(CMDSPEC) ((CMDSPEC).attribute) 102*7c478bd9Sstevel@tonic-gate #define SC_CMDSPEC_ARGS(CMDSPEC) ((CMDSPEC).args) 103*7c478bd9Sstevel@tonic-gate 104*7c478bd9Sstevel@tonic-gate /* 105*7c478bd9Sstevel@tonic-gate * Entire SMC Request Message sent down-stream 106*7c478bd9Sstevel@tonic-gate */ 107*7c478bd9Sstevel@tonic-gate typedef struct { 108*7c478bd9Sstevel@tonic-gate sc_reqhdr_t hdr; 109*7c478bd9Sstevel@tonic-gate uchar_t data[SC_SEND_DSIZE]; 110*7c478bd9Sstevel@tonic-gate } sc_reqmsg_t; 111*7c478bd9Sstevel@tonic-gate 112*7c478bd9Sstevel@tonic-gate /* 113*7c478bd9Sstevel@tonic-gate * Entire SMC Response Message forwarded up-stream 114*7c478bd9Sstevel@tonic-gate */ 115*7c478bd9Sstevel@tonic-gate typedef struct { 116*7c478bd9Sstevel@tonic-gate sc_rsphdr_t hdr; 117*7c478bd9Sstevel@tonic-gate uchar_t data[SC_RECV_DSIZE]; 118*7c478bd9Sstevel@tonic-gate } sc_rspmsg_t; 119*7c478bd9Sstevel@tonic-gate 120*7c478bd9Sstevel@tonic-gate #define SC_MSG_HDR(msg) ((msg)->hdr) 121*7c478bd9Sstevel@tonic-gate 122*7c478bd9Sstevel@tonic-gate #define SC_SEND_DLENGTH(msg) (SC_MSG_HDR(msg).len) 123*7c478bd9Sstevel@tonic-gate #define SC_RECV_DLENGTH(msg) (SC_MSG_HDR(msg).len) 124*7c478bd9Sstevel@tonic-gate 125*7c478bd9Sstevel@tonic-gate #define SC_MSG_ID(msg) (SC_MSG_HDR(msg).msg_id) 126*7c478bd9Sstevel@tonic-gate #define SC_MSG_CMD(msg) (SC_MSG_HDR(msg).cmd) 127*7c478bd9Sstevel@tonic-gate #define SC_MSG_LEN(msg) (SC_MSG_HDR(msg).len) 128*7c478bd9Sstevel@tonic-gate #define SC_MSG_CC(msg) (SC_MSG_HDR(msg).cc) 129*7c478bd9Sstevel@tonic-gate #define SC_MSG_DATA(msg) ((msg)->data) 130*7c478bd9Sstevel@tonic-gate 131*7c478bd9Sstevel@tonic-gate /* 132*7c478bd9Sstevel@tonic-gate * IPMB sequence number request structure. Application can 133*7c478bd9Sstevel@tonic-gate * reserve a block of sequence numbers for communicating 134*7c478bd9Sstevel@tonic-gate * with each destination 135*7c478bd9Sstevel@tonic-gate */ 136*7c478bd9Sstevel@tonic-gate #define SC_SEQ_SZ 16 137*7c478bd9Sstevel@tonic-gate typedef struct { 138*7c478bd9Sstevel@tonic-gate uint8_t d_addr; /* Destination micro-controller addr */ 139*7c478bd9Sstevel@tonic-gate int8_t n_seqn; /* Number of seq# requested, max 16, -1 => free all */ 140*7c478bd9Sstevel@tonic-gate uint8_t seq_numbers[SC_SEQ_SZ]; /* Placeholder for seq# */ 141*7c478bd9Sstevel@tonic-gate } sc_seqdesc_t; 142*7c478bd9Sstevel@tonic-gate 143*7c478bd9Sstevel@tonic-gate #define SC_SEQN_DADDR(SEQDESC) ((SEQDESC).d_addr) 144*7c478bd9Sstevel@tonic-gate #define SC_SEQN_COUNT(SEQDESC) ((SEQDESC).n_seqn) 145*7c478bd9Sstevel@tonic-gate #define SC_SEQN_NUMBERS(SEQDESC) ((SEQDESC).seq_numbers) 146*7c478bd9Sstevel@tonic-gate 147*7c478bd9Sstevel@tonic-gate #ifdef __cplusplus 148*7c478bd9Sstevel@tonic-gate } 149*7c478bd9Sstevel@tonic-gate #endif 150*7c478bd9Sstevel@tonic-gate 151*7c478bd9Sstevel@tonic-gate #endif /* _SYS_SMC_IF_H */ 152