emlxs_sdapi.h revision 8f23e9fa8abcb5857661066b954e63400d589b65
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan * CDDL HEADER START
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan * The contents of this file are subject to the terms of the
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan * Common Development and Distribution License (the "License").
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan * You may not use this file except in compliance with the License.
8f23e9fa8abcb5857661066b954e63400d589b65Hans Rosenfeld * You can obtain a copy of the license at
8f23e9fa8abcb5857661066b954e63400d589b65Hans Rosenfeld * http://www.opensource.org/licenses/cddl1.txt.
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan * See the License for the specific language governing permissions
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan * and limitations under the License.
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan * When distributing Covered Code, include this CDDL HEADER in each
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan * If applicable, add the following below this CDDL HEADER, with the
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan * fields enclosed by brackets "[]" replaced with your own identifying
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan * information: Portions Copyright [yyyy] [name of copyright owner]
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan * CDDL HEADER END
8f23e9fa8abcb5857661066b954e63400d589b65Hans Rosenfeld * Copyright (c) 2004-2011 Emulex. All rights reserved.
825277341c15b6b0d2c4b8b622ae7b1d2bdc0390Sukumar Swaminathan * Use is subject to license terms.
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan * Although information in this file can be used by app, libdfc or driver,
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan * its purpose is for communication between app and libdfc.
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan * Its content come from the SAN Diag API Specification.
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan/* Define for refering SCSI_IO_LATENCY */
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_IO_LATENCY_MAX_BUCKETS 20 /* Size of array range */
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan/* Masks for ELS Commands */
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_ELS_SUBCATEGORY_PLOGI_RCV 0x01
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_ELS_SUBCATEGORY_ADISC_RCV 0x04
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_ELS_SUBCATEGORY_LSRJT_RCV 0x08
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan/* Masks for Fabric events */
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_FABRIC_SUBCATEGORY_FABRIC_BUSY 0x01
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_FABRIC_SUBCATEGORY_PORT_BUSY 0x02
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_FABRIC_SUBCATEGORY_FCPRDCHKERR 0x04
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan/* Masks for SCSI events */
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_SCSI_SUBCATEGORY_DEVBSY 0x0002
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_SCSI_SUBCATEGORY_CHECKCONDITION 0x0004
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_SCSI_SUBCATEGORY_LUNRESET 0x0008
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_SCSI_SUBCATEGORY_TGTRESET 0x0010
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_SCSI_SUBCATEGORY_BUSRESET 0x0020
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_SCSI_SUBCATEGORY_VARQUEDEPTH 0x0040
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan/* Masks for Board Events */
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_BOARD_SUBCATEGORY_PORTINTERR 0x01
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_BOARD_SUBCATEGORY_LINKATTE 0x02
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan/* Masks for Adapter Events */
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_ADAPTER_SUBCATEGORY_ARRIVAL 0x01
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_ADAPTER_SUBCATEGORY_DEPARTURE 0x02
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan/* Struct to hold SCSI IO Latency statistics per bucket */
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan/* Struct per target for SCSI IO Latency */
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan /* Size of array depends on range size */
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan struct SD_time_stats_v0 sd_time_stats_array[SD_IO_LATENCY_MAX_BUCKETS];
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan/* Return Codes */
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathanextern uint32_t DFC_SD_Get_Granularity(void);
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathanextern int32_t DFC_SD_Set_Bucket(uint16_t type,
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathanextern int32_t DFC_SD_Destroy_Bucket(uint16_t type);
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathanextern int32_t DFC_SD_Get_Bucket(uint16_t type,
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathanextern int32_t DFC_SD_Start_Data_Collection(uint32_t board,
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathanextern int32_t DFC_SD_Stop_Data_Collection(uint32_t board,
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathanextern int32_t DFC_SD_Reset_Data_Collection(uint32_t board,
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathanextern int32_t DFC_SD_Get_Data(uint32_t board,
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_ELS_SUBCATEGORY_VALID_MASK (SD_ELS_SUBCATEGORY_PLOGI_RCV | \
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan SD_ELS_SUBCATEGORY_PRLO_RCV | SD_ELS_SUBCATEGORY_ADISC_RCV | \
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan SD_ELS_SUBCATEGORY_LSRJT_RCV | SD_ELS_SUBCATEGORY_LOGO_RCV | \
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan/* Generic Payload */
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_FABRIC_SUBCATEGORY_VALID_MASK (\
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan SD_FABRIC_SUBCATEGORY_FABRIC_BUSY | SD_FABRIC_SUBCATEGORY_PORT_BUSY | \
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#define SD_SCSI_SUBCATEGORY_VALID_MASK (\
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan SD_SCSI_SUBCATEGORY_QFULL | SD_SCSI_SUBCATEGORY_DEVBSY | \
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan SD_SCSI_SUBCATEGORY_CHECKCONDITION | SD_SCSI_SUBCATEGORY_LUNRESET | \
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan SD_SCSI_SUBCATEGORY_TGTRESET | SD_SCSI_SUBCATEGORY_BUSRESET | \
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan/* Prototype for callback */
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathantypedef void sd_callback(uint32_t board_id,
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan/* Register for event */
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathanextern int32_t DFC_SD_RegisterForEvent(uint32_t board_id,
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan/* Deregister a event */
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathanextern int32_t DFC_SD_unRegisterForEvent(uint32_t board_id,
291a2b48b9adcd7b3666c34e80ba6411929afe7fSukumar Swaminathan#endif /* _EMLXS_SDAPI_H */