1*03831d35Sstevel /*
2*03831d35Sstevel  * CDDL HEADER START
3*03831d35Sstevel  *
4*03831d35Sstevel  * The contents of this file are subject to the terms of the
5*03831d35Sstevel  * Common Development and Distribution License (the "License").
6*03831d35Sstevel  * You may not use this file except in compliance with the License.
7*03831d35Sstevel  *
8*03831d35Sstevel  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9*03831d35Sstevel  * or http://www.opensolaris.org/os/licensing.
10*03831d35Sstevel  * See the License for the specific language governing permissions
11*03831d35Sstevel  * and limitations under the License.
12*03831d35Sstevel  *
13*03831d35Sstevel  * When distributing Covered Code, include this CDDL HEADER in each
14*03831d35Sstevel  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15*03831d35Sstevel  * If applicable, add the following below this CDDL HEADER, with the
16*03831d35Sstevel  * fields enclosed by brackets "[]" replaced with your own identifying
17*03831d35Sstevel  * information: Portions Copyright [yyyy] [name of copyright owner]
18*03831d35Sstevel  *
19*03831d35Sstevel  * CDDL HEADER END
20*03831d35Sstevel  */
21*03831d35Sstevel 
22*03831d35Sstevel /*
23*03831d35Sstevel  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
24*03831d35Sstevel  * Use is subject to license terms.
25*03831d35Sstevel  */
26*03831d35Sstevel 
27*03831d35Sstevel #ifndef __ADM_H__
28*03831d35Sstevel #define	__ADM_H__
29*03831d35Sstevel 
30*03831d35Sstevel #ifdef	__cplusplus
31*03831d35Sstevel extern "C" {
32*03831d35Sstevel #endif
33*03831d35Sstevel 
34*03831d35Sstevel /*
35*03831d35Sstevel  * adm.h: defines and function prototypes for scadm
36*03831d35Sstevel  */
37*03831d35Sstevel 
38*03831d35Sstevel #include <stdio.h>
39*03831d35Sstevel #include <time.h>
40*03831d35Sstevel 
41*03831d35Sstevel #include "librsc.h"
42*03831d35Sstevel 
43*03831d35Sstevel 
44*03831d35Sstevel /* DEFINES */
45*03831d35Sstevel #define	ADM_TIMEOUT		2  /* RX timeout for normal messages */
46*03831d35Sstevel #define	ADM_SEPROM_TIMEOUT	10 /* timeout for messages requiring serial */
47*03831d35Sstevel 				    /* eprom update */
48*03831d35Sstevel #define	ADM_BOOT_INIT_TIMEOUT	1  /* RX timeout for BOOT_INIT message */
49*03831d35Sstevel #define	ADM_BOOT_LOAD_TIMEOUT	10 /* RX timeout for BOOT s-record message */
50*03831d35Sstevel #define	ADM_BOOT_RETRY		5  /* Number of times to retry BOOT messages */
51*03831d35Sstevel #define	ADM_LINE_SIZE		1024 /* Max s-record line size */
52*03831d35Sstevel #define	ADM_BP_BUFF_SIZE	20
53*03831d35Sstevel 
54*03831d35Sstevel /*
55*03831d35Sstevel  * By default, how much of an extended log will be displayed (for character-
56*03831d35Sstevel  * based logs.)
57*03831d35Sstevel  */
58*03831d35Sstevel #define	ADM_DEFAULT_LOG_LENGTH	8192
59*03831d35Sstevel 
60*03831d35Sstevel /* Default number of events we ask ALOM for (for event-based logs.) */
61*03831d35Sstevel #define	DEFAULT_NUM_EVENTS 100
62*03831d35Sstevel 
63*03831d35Sstevel 
64*03831d35Sstevel /* Return values for ADM_Valid_srecord() */
65*03831d35Sstevel #define	SREC_OK			0
66*03831d35Sstevel #define	SREC_ERR_LINE_TOO_BIG	-1
67*03831d35Sstevel #define	SREC_ERR_LINE_TOO_SMALL	-2
68*03831d35Sstevel #define	SREC_ERR_BAD_HEADER	-3
69*03831d35Sstevel #define	SREC_ERR_WRONG_LENGTH	-4
70*03831d35Sstevel #define	SREC_ERR_BAD_CRC	-5
71*03831d35Sstevel 
72*03831d35Sstevel 
73*03831d35Sstevel /* SPEC'S */
74*03831d35Sstevel void  ADM_Init();
75*03831d35Sstevel void  ADM_Cleanup();
76*03831d35Sstevel void  ADM_Exit(int errorCode);
77*03831d35Sstevel 
78*03831d35Sstevel void  ADM_Process_command(int argc, char *argv[]);
79*03831d35Sstevel void  ADM_Process_help();
80*03831d35Sstevel void  ADM_Process_modem_setup();
81*03831d35Sstevel void  ADM_Process_status();
82*03831d35Sstevel void  ADM_Process_send_event(int argc, char *argv[]);
83*03831d35Sstevel void  ADM_Process_date(int argc, char *argv[]);
84*03831d35Sstevel void  ADM_Process_set(int argc, char *argv[]);
85*03831d35Sstevel void  ADM_Process_show(int argc, char *argv[]);
86*03831d35Sstevel void  ADM_Process_reset(int argc, char *argv[]);
87*03831d35Sstevel void  ADM_Process_download(int argc, char *argv[]);
88*03831d35Sstevel void  ADM_Process_useradd(int argc, char *argv[]);
89*03831d35Sstevel void  ADM_Process_userdel(int argc, char *argv[]);
90*03831d35Sstevel void  ADM_Process_usershow(int argc, char *argv[]);
91*03831d35Sstevel void  ADM_Process_userpassword(int argc, char *argv[]);
92*03831d35Sstevel void  ADM_Process_userperm(int argc, char *argv[]);
93*03831d35Sstevel void  ADM_Process_show_network();
94*03831d35Sstevel void  ADM_Process_event_log(int all);
95*03831d35Sstevel void  ADM_Process_console_log(int all);
96*03831d35Sstevel void  ADM_Process_fru_log(int all);
97*03831d35Sstevel 
98*03831d35Sstevel void  ADM_Usage();
99*03831d35Sstevel void  ADM_Callback(bp_msg_t *Message);
100*03831d35Sstevel int   ADM_Valid_srecord(FILE  *FilePtr);
101*03831d35Sstevel int   ADM_Send_file(FILE  *FilePtr);
102*03831d35Sstevel void  ADM_Display_download_error(int cmd, int dat1); /* in send_file.c */
103*03831d35Sstevel 
104*03831d35Sstevel /* rscp_register_bpmsg_cb() must be called before using */
105*03831d35Sstevel /* rscp_send_bpmsg() or ADM_Boot_Recv() */
106*03831d35Sstevel int  ADM_Boot_recv(bp_msg_t *MessagePtr, struct timespec *Timeout);
107*03831d35Sstevel 
108*03831d35Sstevel 
109*03831d35Sstevel /* Wrappers for rscp routines */
110*03831d35Sstevel void ADM_Start();
111*03831d35Sstevel void ADM_Send(rscp_msg_t *msg);
112*03831d35Sstevel int ADM_Send_ret(rscp_msg_t *msg);
113*03831d35Sstevel void ADM_Recv(rscp_msg_t *msg, struct timespec *timeout, int expectType,
114*03831d35Sstevel     int expectSize);
115*03831d35Sstevel void ADM_Free(rscp_msg_t  *msg);
116*03831d35Sstevel 
117*03831d35Sstevel #ifdef	__cplusplus
118*03831d35Sstevel }
119*03831d35Sstevel #endif
120*03831d35Sstevel 
121*03831d35Sstevel #endif /* __ADM_H__ */
122