xref: /illumos-gate/usr/src/lib/sun_fc/common/HBAList.h (revision 55fea89dcaa64928bed4327112404dcb3e07b79f)
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	_HBALIST_H
27*fcf3ce44SJohn Forte #define	_HBALIST_H
28*fcf3ce44SJohn Forte 
29*fcf3ce44SJohn Forte 
30*fcf3ce44SJohn Forte 
31*fcf3ce44SJohn Forte #include "Lockable.h"
32*fcf3ce44SJohn Forte #include "HBA.h"
33*fcf3ce44SJohn Forte #include "Handle.h"
34*fcf3ce44SJohn Forte #include <vector>
35*fcf3ce44SJohn Forte #include <string>
36*fcf3ce44SJohn Forte #include <hbaapi.h>
37*fcf3ce44SJohn Forte 
38*fcf3ce44SJohn Forte /**
39*fcf3ce44SJohn Forte  * @memo	    Singleton class that represents the entire list of HBAs
40*fcf3ce44SJohn Forte  *		    known to the system.
41*fcf3ce44SJohn Forte  *
42*fcf3ce44SJohn Forte  * @doc		    This class and its single instance is used to track
43*fcf3ce44SJohn Forte  *		    all the known HBAs on the system.  This class
44*fcf3ce44SJohn Forte  *		    will gracefully handle dynamic reconfiguration
45*fcf3ce44SJohn Forte  *		    in accordance with the FC-HBA specification.
46*fcf3ce44SJohn Forte  *		    HBA_MAX_PER_LIST represents the maximum number of
47*fcf3ce44SJohn Forte  *		    adapters that are supported by this class.
48*fcf3ce44SJohn Forte  */
49*fcf3ce44SJohn Forte class HBAList : public Lockable{
50*fcf3ce44SJohn Forte public:
51*fcf3ce44SJohn Forte     static HBAList*	    instance();
52*fcf3ce44SJohn Forte     ~HBAList();
53*fcf3ce44SJohn Forte     static const int32_t    HBA_MAX_PER_LIST;
54*fcf3ce44SJohn Forte     HBA_STATUS		    load();
55*fcf3ce44SJohn Forte     HBA_STATUS		    unload();
56*fcf3ce44SJohn Forte     int			    getNumberofAdapters();
57*fcf3ce44SJohn Forte     int			    getNumberofTgtAdapters();
58*fcf3ce44SJohn Forte     std::string		    getHBAName(int index);
59*fcf3ce44SJohn Forte     std::string		    getTgtHBAName(int index);
60*fcf3ce44SJohn Forte     Handle*		    openHBA(std::string name);
61*fcf3ce44SJohn Forte     Handle*		    openTgtHBA(std::string name);
62*fcf3ce44SJohn Forte     Handle*		    openHBA(uint64_t wwn);
63*fcf3ce44SJohn Forte     Handle*		    openTgtHBA(uint64_t wwn);
64*fcf3ce44SJohn Forte     HBA_LIBRARYATTRIBUTES   getVSLAttributes();
65*fcf3ce44SJohn Forte 
66*fcf3ce44SJohn Forte protected:
67*fcf3ce44SJohn Forte     HBAList(); // Singleton
68*fcf3ce44SJohn Forte 
69*fcf3ce44SJohn Forte     // Prevent ambiguity
70*fcf3ce44SJohn Forte     using Lockable::lock;
71*fcf3ce44SJohn Forte     using Lockable::unlock;
72*fcf3ce44SJohn Forte 
73*fcf3ce44SJohn Forte private:
74*fcf3ce44SJohn Forte     static HBAList*	    _instance;
75*fcf3ce44SJohn Forte     std::vector<HBA*>	    hbas;
76*fcf3ce44SJohn Forte     std::vector<HBA*>	    tgthbas;
77*fcf3ce44SJohn Forte };
78*fcf3ce44SJohn Forte 
79*fcf3ce44SJohn Forte #endif /* _HBALIST_H */
80