2N/A/*
2N/A * CDDL HEADER START
2N/A *
2N/A * The contents of this file are subject to the terms of the
2N/A * Common Development and Distribution License (the "License").
2N/A * You may not use this file except in compliance with the License.
2N/A *
2N/A * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
2N/A * or http://www.opensolaris.org/os/licensing.
2N/A * See the License for the specific language governing permissions
2N/A * and limitations under the License.
2N/A *
2N/A * When distributing Covered Code, include this CDDL HEADER in each
2N/A * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
2N/A * If applicable, add the following below this CDDL HEADER, with the
2N/A * fields enclosed by brackets "[]" replaced with your own identifying
2N/A * information: Portions Copyright [yyyy] [name of copyright owner]
2N/A *
2N/A * CDDL HEADER END
2N/A */
2N/A
2N/A/*
2N/A * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
2N/A * Use is subject to license terms.
2N/A */
2N/A
2N/A
2N/A#ifndef _SUN_SAS_H
2N/A#define _SUN_SAS_H
2N/A
2N/A#ifdef __cplusplus
2N/Aextern "C" {
2N/A#endif
2N/A
2N/A#include <smhbaapi.h>
2N/A#include <vendorsmhbaapi.h>
2N/A#include <sys/types.h>
2N/A#include <sys/stat.h>
2N/A#include <sys/param.h>
2N/A#include <dirent.h>
2N/A#include <fcntl.h>
2N/A#include <stdio.h>
2N/A#include <stdlib.h>
2N/A#include <strings.h>
2N/A#include <string.h>
2N/A#include <limits.h>
2N/A#include <syslog.h>
2N/A#include <thread.h>
2N/A#include <synch.h>
2N/A#include <unistd.h>
2N/A#include <stropts.h>
2N/A#include <libdevinfo.h>
2N/A#include <sys/time.h>
2N/A#include <sys/scsi/generic/commands.h>
2N/A#include <sys/scsi/impl/commands.h>
2N/A#include <sys/scsi/impl/sense.h>
2N/A#include <sys/scsi/generic/inquiry.h>
2N/A#include <sys/scsi/impl/uscsi.h>
2N/A#include <sys/varargs.h>
2N/A#include <sys/varargs.h>
2N/A#include <libsysevent.h>
2N/A
2N/A#ifdef __cplusplus
2N/Aextern "C" {
2N/A#endif
2N/A
2N/A#define VSL_NUMERIC_VERSION 1
2N/A#define VSL_STRING_VERSION "Version 1"
2N/A#define VSL_NAME "Sun T11 SM-HBA Vendor Library for SAS HBAs"
2N/A#define SMHBA_LIBRARY_VERSION1 VSL_NUMERIC_VERSION
2N/A
2N/A/* The /dev links we expose */
2N/A#define DEV_DISK_DIR "/dev/rdsk"
2N/A#define DEV_TAPE_DIR "/dev/rmt"
2N/A#define DEV_ES_DIR "/dev/es"
2N/A#define DEV_CFG_DIR "/dev/cfg"
2N/A#define DEVICES_DIR "/devices"
2N/A#define DEVCTL_SUFFIX ":devctl"
2N/A#define SCSI_SUFFIX ":scsi"
2N/A
2N/A/* To be consistent, when out of memory call this macro routine */
2N/A#define OUT_OF_MEMORY(routine) \
2N/A log(LOG_DEBUG, routine, "Out of memory.")
2N/A
2N/A#define S_FREE(x) (((x) != NULL) ? (free(x), (x) = NULL) : (void *)0)
2N/A
2N/A#define IS_STUB_NODE(s) (di_instance(s) == -1 && \
2N/A di_nodeid(s) == (DI_PROM_NODEID))
2N/A
2N/A/* manf+model+10(char length of UINTMAX)+6(for 2 -'s, NULL & extra 3bytes */
2N/A#define HANDLE_NAME_LENGTH (64 + 256 + 10 + 6)
2N/A#define HANDLE_ERROR 0 /* This is an error condition */
2N/A
2N/A/* Some timing values */
2N/A#define LOCK_SLEEP 1
2N/A#define BUSY_SLEEP 10000 /* 1/100 second */
2N/A#define BUSY_RETRY_TIMER 5000000000 /* Retry for 5 seconds */
2N/A#define STATE_RETRY_TIMER 10000000000 /* Retry for 10 seconds */
2N/A#define HR_SECOND 1000000000
2N/A/* How many times to silently retry, before starting to print warnings */
2N/A#define DEADLOCK_WARNING 10
2N/A
2N/A#define MAX_LUN 4096
2N/A#define REP_LUNS_RSP_SIZE sizeof (rep_luns_rsp_t)+ \
2N/A (sizeof (lun_list_element_t)*(MAX_LUN - 1))
2N/A
2N/A/* misc */
2N/A#define SUN_MICROSYSTEMS "Sun Microsystems, Inc."
2N/A
2N/Amutex_t all_hbas_lock;
2N/Amutex_t open_handles_lock;
2N/Amutex_t log_file_lock;
2N/AHBA_UINT32 hba_count;
2N/AHBA_UINT16 open_handle_index;
2N/A
2N/A
2N/A/* Internal structures that aren't exposed to clients */
2N/Astruct open_handle {
2N/A int adapterIndex;
2N/A HBA_UINT32 handle;
2N/A struct open_handle *next;
2N/A};
2N/A
2N/Astruct sun_sas_hba {
2N/A HBA_UINT32 index; /* Can be sparse */
2N/A struct open_handle *open_handles;
2N/A int fd; /* when open, the FD */
2N/A /* The libdevinfo HBA path (lacking /devices) */
2N/A char device_path[MAXPATHLEN];
2N/A char handle_name[HANDLE_NAME_LENGTH];
2N/A SMHBA_ADAPTERATTRIBUTES adapter_attributes;
2N/A
2N/A /* State tracking */
2N/A boolean_t invalid;
2N/A struct sun_sas_hba *next;
2N/A struct sun_sas_port *first_port;
2N/A};
2N/A
2N/Astruct sun_sas_hba *global_hba_head;
2N/A
2N/Astruct ScsiEntryList {
2N/A SMHBA_SCSIENTRY entry;
2N/A struct ScsiEntryList *next;
2N/A};
2N/A
2N/Astruct phy_info {
2N/A HBA_UINT32 index;
2N/A boolean_t invalid;
2N/A SMHBA_SAS_PHY phy;
2N/A struct phy_info *next;
2N/A};
2N/A
2N/Astruct sun_sas_port {
2N/A HBA_UINT32 index;
2N/A boolean_t invalid;
2N/A
2N/A /* The libdevinfo HBA path (lacking /devices) */
2N/A char device_path[MAXPATHLEN];
2N/A SMHBA_PORTATTRIBUTES port_attributes;
2N/A struct ScsiEntryList *scsiInfo;
2N/A int cntlNumber;
2N/A
2N/A /* The following are used to track the device map */
2N/A int num_devices;
2N/A struct sun_sas_port *first_attached_port; /* Only for HBA port */
2N/A struct phy_info *first_phy; /* Only for HBA port */
2N/A struct sun_sas_port *next;
2N/A};
2N/A
2N/Atypedef struct walkarg {
2N/A char *devpath;
2N/A boolean_t *flag;
2N/A} walkarg_t;
2N/A
2N/Aextern int loadCount;
2N/A
2N/Aextern sysevent_handle_t *gSysEventHandle;
2N/A
2N/A/* External routines */
2N/Aextern HBA_STATUS SMHBA_RegisterLibrary(PSMHBA_ENTRYPOINTS);
2N/Aextern HBA_UINT32 Sun_sasGetVendorLibraryAttributes(SMHBA_LIBRARYATTRIBUTES *);
2N/Aextern HBA_STATUS Sun_sasGetAdapterAttributes(HBA_HANDLE,
2N/A SMHBA_ADAPTERATTRIBUTES *);
2N/Aextern HBA_UINT32 Sun_sasGetNumberOfAdapters();
2N/Aextern HBA_STATUS Sun_sasGetAdapterName(HBA_UINT32, char *);
2N/Aextern HBA_STATUS Sun_sasGetPortType(HBA_HANDLE, HBA_UINT32, HBA_PORTTYPE *);
2N/Aextern HBA_STATUS Sun_sasGetAdapterPortAttributes(HBA_HANDLE, HBA_UINT32,
2N/A SMHBA_PORTATTRIBUTES *);
2N/Aextern HBA_STATUS Sun_sasGetPortAttributesByWWN(HBA_HANDLE, HBA_WWN, HBA_WWN,
2N/A SMHBA_PORTATTRIBUTES *);
2N/Aextern HBA_STATUS Sun_sasGetFCPhyAttributes(HBA_HANDLE, HBA_UINT32, HBA_UINT32,
2N/A SMHBA_FC_PHY *);
2N/Aextern HBA_STATUS Sun_sasGetSASPhyAttributes(HBA_HANDLE, HBA_UINT32,
2N/A HBA_UINT32, SMHBA_SAS_PHY *);
2N/Aextern HBA_STATUS Sun_sasGetProtocolStatistics(HBA_HANDLE, HBA_UINT32,
2N/A HBA_UINT32, SMHBA_PROTOCOLSTATISTICS *);
2N/Aextern HBA_STATUS Sun_sasGetPhyStatistics(HBA_HANDLE, HBA_UINT32,
2N/A HBA_UINT32, SMHBA_PHYSTATISTICS *);
2N/Aextern HBA_STATUS Sun_sasSendSMPPassThru(HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_WWN,
2N/A void *, HBA_UINT32, void *, HBA_UINT32 *);
2N/Aextern HBA_STATUS Sun_sasGetBindingCapability(HBA_HANDLE, HBA_WWN, HBA_WWN,
2N/A SMHBA_BIND_CAPABILITY *);
2N/Aextern HBA_STATUS Sun_sasGetBindingSupport(HBA_HANDLE, HBA_WWN, HBA_WWN,
2N/A SMHBA_BIND_CAPABILITY *);
2N/Aextern HBA_STATUS Sun_sasSetBindingSupport(HBA_HANDLE, HBA_WWN, HBA_WWN,
2N/A SMHBA_BIND_CAPABILITY);
2N/Aextern HBA_STATUS Sun_sasGetTargetMapping(HBA_HANDLE, HBA_WWN, HBA_WWN,
2N/A SMHBA_TARGETMAPPING *);
2N/Aextern HBA_STATUS Sun_sasGetPersistentBinding(HBA_HANDLE, HBA_WWN, HBA_WWN,
2N/A SMHBA_BINDING *);
2N/Aextern HBA_STATUS Sun_sasSetPersistentBinding(HBA_HANDLE, HBA_WWN, HBA_WWN,
2N/A const SMHBA_BINDING *);
2N/Aextern HBA_STATUS Sun_sasRemovePersistentBinding(HBA_HANDLE, HBA_WWN, HBA_WWN,
2N/A const SMHBA_BINDING *);
2N/Aextern HBA_STATUS Sun_sasRemoveAllPersistentBindings(HBA_HANDLE, HBA_WWN,
2N/A HBA_WWN);
2N/Aextern HBA_STATUS Sun_sasGetLUNStatistics(HBA_HANDLE, const HBA_SCSIID *,
2N/A SMHBA_PROTOCOLSTATISTICS *);
2N/Aextern HBA_STATUS Sun_sasRegisterForAdapterAddEvents(void (*)(void *, HBA_WWN,
2N/A HBA_UINT32), void *, HBA_CALLBACKHANDLE *);
2N/Aextern HBA_STATUS Sun_sasRegisterForAdapterEvents(void (*)(void *, HBA_WWN,
2N/A HBA_UINT32), void *, HBA_HANDLE, HBA_CALLBACKHANDLE *);
2N/Aextern HBA_STATUS Sun_sasRegisterForAdapterPortEvents(void (*)(void *, HBA_WWN,
2N/A HBA_UINT32, HBA_UINT32), void *, HBA_HANDLE, HBA_WWN, HBA_UINT32,
2N/A HBA_CALLBACKHANDLE *);
2N/Aextern HBA_STATUS Sun_sasRegisterForAdapterPortStatEvents(void (*)(void *,
2N/A HBA_WWN, HBA_UINT32, HBA_UINT32), void *, HBA_HANDLE, HBA_WWN, HBA_UINT32,
2N/A SMHBA_PROTOCOLSTATISTICS, HBA_UINT32, HBA_CALLBACKHANDLE *);
2N/Aextern HBA_STATUS Sun_sasRegisterForAdapterPhyStatEvents(void (*)(void *,
2N/A HBA_WWN, HBA_UINT32, HBA_UINT32), void *, HBA_HANDLE, HBA_WWN, HBA_UINT32,
2N/A SMHBA_PHYSTATISTICS, HBA_UINT32, HBA_CALLBACKHANDLE *);
2N/Aextern HBA_STATUS Sun_sasRegisterForTargetEvents(void (*)(void *, HBA_WWN,
2N/A HBA_WWN, HBA_WWN, HBA_UINT32), void *, HBA_HANDLE, HBA_WWN, HBA_WWN,
2N/A HBA_WWN, HBA_CALLBACKHANDLE *, HBA_UINT32);
2N/Aextern HBA_STATUS Sun_sasRegisterForLinkEvents(void (*)(void *, HBA_WWN,
2N/A HBA_UINT32, void *, HBA_UINT32), void *, void *, HBA_UINT32, HBA_HANDLE,
2N/A HBA_CALLBACKHANDLE *);
2N/Aextern HBA_STATUS Sun_sasScsiInquiry(HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_WWN,
2N/A SMHBA_SCSILUN, HBA_UINT8, HBA_UINT8, void *, HBA_UINT32 *, HBA_UINT8 *,
2N/A void *, HBA_UINT32 *);
2N/Aextern HBA_STATUS Sun_sasScsiReportLUNs(HBA_HANDLE, HBA_WWN, HBA_WWN,
2N/A HBA_WWN, void *, HBA_UINT32 *, HBA_UINT8 *, void *, HBA_UINT32 *);
2N/Aextern HBA_STATUS Sun_sasScsiReadCapacity(HBA_HANDLE, HBA_WWN, HBA_WWN, HBA_WWN,
2N/A SMHBA_SCSILUN, void *, HBA_UINT32 *, HBA_UINT8 *, void *, HBA_UINT32 *);
2N/Aextern HBA_UINT32 Sun_sasGetVersion();
2N/Aextern HBA_STATUS Sun_sasLoadLibrary();
2N/Aextern HBA_STATUS Sun_sasFreeLibrary();
2N/Aextern HBA_UINT32 Sun_sasGetNumberOfAdapters();
2N/Aextern HBA_UINT32 Sun_sasGetNumberOfPorts(HBA_HANDLE, HBA_UINT32 *);
2N/Aextern HBA_STATUS Sun_sasGetAdapterName(HBA_UINT32, char *);
2N/Aextern HBA_HANDLE Sun_sasOpenAdapter(char *);
2N/Aextern void Sun_sasCloseAdapter(HBA_HANDLE);
2N/Aextern HBA_STATUS Sun_sasGetDiscoveredPortAttributes(HBA_HANDLE, HBA_UINT32,
2N/A HBA_UINT32, SMHBA_PORTATTRIBUTES *);
2N/Aextern HBA_STATUS Sun_sasGetPortAttributesByWWN(HBA_HANDLE, HBA_WWN, HBA_WWN,
2N/A SMHBA_PORTATTRIBUTES *);
2N/Aextern void Sun_sasRefreshInformation(HBA_HANDLE);
2N/Aextern void Sun_sasRefreshAdapterConfiguration(void);
2N/Aextern HBA_STATUS Sun_sasRemoveCallback(HBA_CALLBACKHANDLE);
2N/A
2N/A
2N/A/* Internal routines */
2N/Aextern void log(int, const char *, char *, ...);
2N/Aextern u_longlong_t wwnConversion(uchar_t *wwn);
2N/Aextern HBA_STATUS devtree_attached_devices(di_node_t, struct sun_sas_port *);
2N/Aextern HBA_HANDLE CreateHandle(int);
2N/Aextern int RetrieveIndex(HBA_HANDLE);
2N/Aextern struct open_handle *RetrieveOpenHandle(HBA_HANDLE);
2N/Aextern struct sun_sas_hba *RetrieveHandle(int);
2N/Aextern struct sun_sas_hba *ExtractHandle(int);
2N/Aextern struct sun_sas_hba *Retrieve_Sun_sasHandle(HBA_HANDLE);
2N/Aextern void lock(mutex_t *mp);
2N/Aextern void unlock(mutex_t *mp);
2N/Aextern void reportSense(struct scsi_extended_sense *, const char *);
2N/Aextern HBA_STATUS verifyAdapter(struct sun_sas_hba *hba_ptr);
2N/Aextern HBA_STATUS devtree_get_all_hbas(di_node_t root);
2N/Aextern HBA_STATUS devtree_get_one_hba(di_node_t node);
2N/Aextern HBA_STATUS FreeHBA(struct sun_sas_hba *hba);
2N/Aextern HBA_WWN getFirstAdapterPortWWN(HBA_HANDLE handle);
2N/Aextern HBA_STATUS getPortStateCounter(char *fpPath, HBA_UINT32 *stateCount);
2N/Aextern HBA_STATUS lookupControllerLink(char *path, char *link);
2N/Aextern HBA_STATUS lookupSMPLink(char *path, char *link);
2N/Aextern void convertDevpathToDevlink(PSMHBA_TARGETMAPPING mappings);
2N/Aextern void fillDomainPortWWN(struct sun_sas_port *);
2N/Aextern HBA_STATUS get_phy_info(di_node_t, struct sun_sas_port *);
2N/Aextern HBA_STATUS send_uscsi_cmd(const char *devpath, struct uscsi_cmd *ucmd);
2N/Aextern HBA_STATUS registerSysevent();
2N/Aextern HBA_STATUS validateDomainAddress(struct sun_sas_port *, HBA_WWN);
2N/A
2N/A#ifdef __cplusplus
2N/A}
2N/A#endif
2N/A
2N/A#endif /* _SUN_SAS_H */