libseslog.h revision e4f5a11d4a234623168c1558fcdf4341e11769e1
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
*/
#ifndef _LIBSESLOG_H
#define _LIBSESLOG_H
#include <libnvpair.h>
#ifdef __cplusplus
extern "C" {
#endif
/*
* Error definitions
*/
enum {
SES_LOG_FAILED_TO_OPEN_DEVICE, /* Couldn't open dev path */
SES_LOG_FAILED_TO_READ_DEVICE, /* Couldn't read the log data */
SES_LOG_FAILED_NVLIST_PROTOCOL, /* Couldn't add protocol */
SES_LOG_FAILED_NULL_TARGET_PATH, /* Null target path */
SES_LOG_FAILED_BAD_TARGET_PATH, /* Couldn't find valid target path */
SES_LOG_FAILED_MODE_SENSE, /* Mode sense error returned */
SES_LOG_FAILED_MODE_SENSE_OFFSET, /* Offset not correct */
SES_LOG_FAILED_BAD_DATA_LEN, /* Data length not correct */
SES_LOG_FAILED_BAD_CONTENT_LEN, /* Content length not correct */
SES_LOG_FAILED_FORMAT_PAGE_ERROR, /* Device doesn't support page */
SES_LOG_FAILED_SHORT_LOG_PARAM_INIT, /* Log paramter was too short */
SES_LOG_FAILED_SHORT_LOG_PARAM, /* Log paramter was too short */
SES_LOG_FAILED_NV_UNIQUE, /* Couldn't add unique to nvlist */
SES_LOG_FAILED_NV_LOG, /* Couldn't add log to nvlist */
SES_LOG_FAILED_NV_CODE, /* Couldn't add code to nvlist */
SES_LOG_FAILED_NV_SEV, /* Couldn't add sev to nvlist */
SES_LOG_FAILED_NV_ENTRY, /* Couldn't add entry to nvlist */
SES_LOG_FAILED_MODE_SELECT, /* Mode select failed */
SES_LOG_FAILED_NVLIST_CREATE /* Couldn't create a nvlist */
};
/*
* define different levels of log entries that could be returned
*/
#define SES_LOG_LEVEL_NOTICE 0
#define SES_LOG_LEVEL_DEBUG 1
#define SES_LOG_LEVEL_WARNING 2
#define SES_LOG_LEVEL_ERROR 3
#define SES_LOG_LEVEL_FATAL 4
/* Valid size of log entry being returned by expander */
#define SES_LOG_VALID_LOG_SIZE 71
/* Index of where sequence number starts in returned string */
#define SES_LOG_SEQ_NUM_START 27
/* Index of where log level starts in returned string */
#define SES_LOG_LEVEL_START 40
/*
* Error buffer size
*/
#define EBUFF_SZ 256
#define MX_ALLOC_LEN (0xfffc)
/*
* Sense return buffer length
* Arbitrary, could be larger
*/
#define SENSE_BUFF_LEN 32
/*
* 60 seconds
*/
#define DEF_PT_TIMEOUT 60
/*
* Defines for different SCSI cmd paramters
*/
#define MODE_SELECT10_CMDLEN 10
#define MODE10_RESP_HDR_LEN 8
#define MODE_SENSE10_CMDLEN 10
/*
* Defines for nvlist entries
*/
#define ENTRY_PREFIX "entry"
#define ENTRY_SEVERITY "severity"
#define ENTRY_CODE "code"
#define ENTRY_LOG "log"
#define PROTOCOL "protocol"
#define PROTOCOL_TYPE "ses"
/*
* Genesis specific log clear control struct
*/
struct log_clear_control_struct {
unsigned char pageControls;
};
/*
* Struct to contain information needed to read logs
*/
struct ses_log_call_struct {
int number_log_entries; /* num of log entries read, passed back */
int size_of_log_entries; /* Total size of all logs read passed back */
};
/*
* Basic library functions
*/
extern int access_ses_log(struct ses_log_call_struct *);
#ifdef __cplusplus
}
#endif
#endif /* _LIBSESLOG_H */