xref: /titanic_50/usr/src/lib/sun_fc/common/HBAPort.h (revision fcf3ce441efd61da9bb2884968af01cb7c1452cc)
1*fcf3ce44SJohn Forte /*
2*fcf3ce44SJohn Forte  * CDDL HEADER START
3*fcf3ce44SJohn Forte  *
4*fcf3ce44SJohn Forte  * The contents of this file are subject to the terms of the
5*fcf3ce44SJohn Forte  * Common Development and Distribution License (the "License").
6*fcf3ce44SJohn Forte  * You may not use this file except in compliance with the License.
7*fcf3ce44SJohn Forte  *
8*fcf3ce44SJohn Forte  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9*fcf3ce44SJohn Forte  * or http://www.opensolaris.org/os/licensing.
10*fcf3ce44SJohn Forte  * See the License for the specific language governing permissions
11*fcf3ce44SJohn Forte  * and limitations under the License.
12*fcf3ce44SJohn Forte  *
13*fcf3ce44SJohn Forte  * When distributing Covered Code, include this CDDL HEADER in each
14*fcf3ce44SJohn Forte  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15*fcf3ce44SJohn Forte  * If applicable, add the following below this CDDL HEADER, with the
16*fcf3ce44SJohn Forte  * fields enclosed by brackets "[]" replaced with your own identifying
17*fcf3ce44SJohn Forte  * information: Portions Copyright [yyyy] [name of copyright owner]
18*fcf3ce44SJohn Forte  *
19*fcf3ce44SJohn Forte  * CDDL HEADER END
20*fcf3ce44SJohn Forte  */
21*fcf3ce44SJohn Forte /*
22*fcf3ce44SJohn Forte  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23*fcf3ce44SJohn Forte  * Use is subject to license terms.
24*fcf3ce44SJohn Forte  */
25*fcf3ce44SJohn Forte 
26*fcf3ce44SJohn Forte #ifndef	_HBAPORT_H
27*fcf3ce44SJohn Forte #define	_HBAPORT_H
28*fcf3ce44SJohn Forte 
29*fcf3ce44SJohn Forte 
30*fcf3ce44SJohn Forte 
31*fcf3ce44SJohn Forte #include "Lockable.h"
32*fcf3ce44SJohn Forte #include "HBANPIVPort.h"
33*fcf3ce44SJohn Forte #include <string>
34*fcf3ce44SJohn Forte #include <map>
35*fcf3ce44SJohn Forte #include <vector>
36*fcf3ce44SJohn Forte #include <hbaapi.h>
37*fcf3ce44SJohn Forte #include <hbaapi-sun.h>
38*fcf3ce44SJohn Forte 
39*fcf3ce44SJohn Forte /**
40*fcf3ce44SJohn Forte  * @memo	    Represents a single HBA port
41*fcf3ce44SJohn Forte  *
42*fcf3ce44SJohn Forte  */
43*fcf3ce44SJohn Forte class HBAPort : public Lockable {
44*fcf3ce44SJohn Forte public:
45*fcf3ce44SJohn Forte     HBAPort();
~HBAPort()46*fcf3ce44SJohn Forte     virtual ~HBAPort() {}
47*fcf3ce44SJohn Forte     bool		    operator==(HBAPort &comp);
48*fcf3ce44SJohn Forte     virtual void			validatePresent();
49*fcf3ce44SJohn Forte     virtual std::string			getPath() = 0;
50*fcf3ce44SJohn Forte     virtual uint64_t			getNodeWWN() = 0;
51*fcf3ce44SJohn Forte     virtual uint64_t			getPortWWN() = 0;
52*fcf3ce44SJohn Forte     virtual HBA_PORTATTRIBUTES		getPortAttributes(
53*fcf3ce44SJohn Forte 					    uint64_t &stateChange) = 0;
54*fcf3ce44SJohn Forte     virtual HBA_PORTATTRIBUTES		getDiscoveredAttributes(
55*fcf3ce44SJohn Forte 					    HBA_UINT32 discoveredport,
56*fcf3ce44SJohn Forte 					    uint64_t &stateChange) = 0;
57*fcf3ce44SJohn Forte     virtual HBA_PORTATTRIBUTES		getDiscoveredAttributes(
58*fcf3ce44SJohn Forte 					    uint64_t wwn,
59*fcf3ce44SJohn Forte 					    uint64_t &stateChange) = 0;
60*fcf3ce44SJohn Forte     virtual void	    getTargetMappings(
61*fcf3ce44SJohn Forte 				PHBA_FCPTARGETMAPPINGV2 userMappings) = 0;
62*fcf3ce44SJohn Forte     virtual void	    getRNIDMgmtInfo(PHBA_MGMTINFO info) = 0;
63*fcf3ce44SJohn Forte     virtual void	    sendCTPassThru(void *requestBuffer,
64*fcf3ce44SJohn Forte 				HBA_UINT32 requestSize,
65*fcf3ce44SJohn Forte 				void *responseBuffer,
66*fcf3ce44SJohn Forte 				HBA_UINT32 *responseSize) = 0;
67*fcf3ce44SJohn Forte     virtual void	    sendRLS(uint64_t destWWN,
68*fcf3ce44SJohn Forte 				void *pRspBuffer,
69*fcf3ce44SJohn Forte 				HBA_UINT32 *pRspBufferSize) = 0;
70*fcf3ce44SJohn Forte     virtual void	    sendRPL(uint64_t destWWN,
71*fcf3ce44SJohn Forte 				HBA_UINT32 agent_domain,
72*fcf3ce44SJohn Forte 				HBA_UINT32 port_index,
73*fcf3ce44SJohn Forte 				void *pRspBuffer,
74*fcf3ce44SJohn Forte 				HBA_UINT32 *pRspBufferSize) = 0;
75*fcf3ce44SJohn Forte     virtual void	    sendRPS(uint64_t agentWWN,
76*fcf3ce44SJohn Forte 				HBA_UINT32 agentDomain,
77*fcf3ce44SJohn Forte 				uint64_t objectWWN,
78*fcf3ce44SJohn Forte 				HBA_UINT32 objectPortNum,
79*fcf3ce44SJohn Forte 				void *pRspBuffer,
80*fcf3ce44SJohn Forte 				HBA_UINT32 *pRspBufferSize) = 0;
81*fcf3ce44SJohn Forte     virtual void	    sendSRL(uint64_t destWWN,
82*fcf3ce44SJohn Forte 				HBA_UINT32 agent_domain,
83*fcf3ce44SJohn Forte 				void *pRspBuffer,
84*fcf3ce44SJohn Forte 				HBA_UINT32 *pRspBufferSize) = 0;
85*fcf3ce44SJohn Forte     virtual void	    sendLIRR(uint64_t destWWN,
86*fcf3ce44SJohn Forte 				HBA_UINT8 function,
87*fcf3ce44SJohn Forte 				HBA_UINT8 type,
88*fcf3ce44SJohn Forte 				void *pRspBuffer,
89*fcf3ce44SJohn Forte 				HBA_UINT32 *pRspBufferSize) = 0;
90*fcf3ce44SJohn Forte     virtual void	    sendReportLUNs(uint64_t wwn,
91*fcf3ce44SJohn Forte 				void *responseBuffer, HBA_UINT32 *responseSize,
92*fcf3ce44SJohn Forte 				HBA_UINT8 *scsiStatus,
93*fcf3ce44SJohn Forte 				void *senseBuffer, HBA_UINT32 *senseSize) = 0;
94*fcf3ce44SJohn Forte     virtual void	    sendScsiInquiry(uint64_t wwn, HBA_UINT64 fcLun,
95*fcf3ce44SJohn Forte 				HBA_UINT8 cdb1, HBA_UINT8 cdb2,
96*fcf3ce44SJohn Forte 				void *responseBuffer, HBA_UINT32 *responseSize,
97*fcf3ce44SJohn Forte 				HBA_UINT8 *scsiStatus, void *senseBuffer,
98*fcf3ce44SJohn Forte 				HBA_UINT32 *senseSize) = 0;
99*fcf3ce44SJohn Forte     virtual void	    sendReadCapacity(uint64_t pwwn,
100*fcf3ce44SJohn Forte 				HBA_UINT64 fcLun, void *responseBuffer,
101*fcf3ce44SJohn Forte 				HBA_UINT32 *responseSize, HBA_UINT8 *scsiStatus,
102*fcf3ce44SJohn Forte 				void *senseBuffer, HBA_UINT32 *senseSize) = 0;
103*fcf3ce44SJohn Forte 
104*fcf3ce44SJohn Forte     static const int	    RNID_GENERAL_TOPOLOGY_DATA_FORMAT;
105*fcf3ce44SJohn Forte     virtual void	    sendRNID(uint64_t destwwn, HBA_UINT32 destfcid,
106*fcf3ce44SJohn Forte 				HBA_UINT32 nodeIdDataFormat, void *pRspBuffer,
107*fcf3ce44SJohn Forte 				HBA_UINT32 *RspBufferSize) = 0;
108*fcf3ce44SJohn Forte     virtual void	    setRNID(HBA_MGMTINFO info) = 0;
109*fcf3ce44SJohn Forte 
110*fcf3ce44SJohn Forte     static const uint8_t	HBA_NPIV_PORT_MAX;
111*fcf3ce44SJohn Forte     void			addPort(HBANPIVPort* port);
112*fcf3ce44SJohn Forte     HBANPIVPort*		getPort(uint64_t wwn);
113*fcf3ce44SJohn Forte     HBANPIVPort*		getPortByIndex(int index);
114*fcf3ce44SJohn Forte     virtual HBA_PORTNPIVATTRIBUTES	getPortNPIVAttributes(
115*fcf3ce44SJohn Forte 					    uint64_t &stateChange) = 0;
116*fcf3ce44SJohn Forte     virtual uint32_t			createNPIVPort(
117*fcf3ce44SJohn Forte 					    uint64_t vnodewwn,
118*fcf3ce44SJohn Forte 					    uint64_t vportwwn,
119*fcf3ce44SJohn Forte 					    uint32_t vindex) = 0;
120*fcf3ce44SJohn Forte     virtual uint32_t			deleteNPIVPort(
121*fcf3ce44SJohn Forte 					    uint64_t vportwwn) = 0;
122*fcf3ce44SJohn Forte protected:
123*fcf3ce44SJohn Forte     void		    convertToShortNames(PHBA_FCPTARGETMAPPINGV2 mappings);
124*fcf3ce44SJohn Forte     std::string		    lookupControllerPath(std::string path);
125*fcf3ce44SJohn Forte     std::map<uint64_t, HBANPIVPort*>	npivportsByWWN;
126*fcf3ce44SJohn Forte     std::vector<HBANPIVPort*>		npivportsByIndex;
127*fcf3ce44SJohn Forte };
128*fcf3ce44SJohn Forte 
129*fcf3ce44SJohn Forte 
130*fcf3ce44SJohn Forte #endif /* _HBAPORT_H */
131