xref: /freebsd/sys/dev/ocs_fc/ocs_sport.h (revision 3eeb75112272ef9ef244a00bc73beef3a146856a)
1 /*-
2  * Copyright (c) 2017 Broadcom. All rights reserved.
3  * The term "Broadcom" refers to Broadcom Limited and/or its subsidiaries.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  *    this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  *    this list of conditions and the following disclaimer in the documentation
13  *    and/or other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  *
31  * $FreeBSD$
32  */
33 
34 /**
35  * @file
36  * OCS FC SLI port (SPORT) exported declarations
37  *
38  */
39 
40 #if !defined(__OCS_SPORT_H__)
41 #define __OCS_SPORT_H__
42 
43 extern int32_t ocs_port_cb(void *arg, ocs_hw_port_event_e event, void *data);
44 extern ocs_sport_t *ocs_sport_alloc(ocs_domain_t *domain, uint64_t wwpn, uint64_t wwnn, uint32_t fc_id,
45 	uint8_t enable_ini, uint8_t enable_tgt);
46 extern void ocs_sport_free(ocs_sport_t *sport);
47 extern void ocs_sport_force_free(ocs_sport_t *sport);
48 
49 static inline void
50 ocs_sport_lock_init(ocs_sport_t *sport)
51 {
52 }
53 
54 static inline void
55 ocs_sport_lock_free(ocs_sport_t *sport)
56 {
57 }
58 
59 static inline int32_t
60 ocs_sport_lock_try(ocs_sport_t *sport)
61 {
62 	/* Use the device wide lock */
63 	return ocs_device_lock_try(sport->ocs);
64 }
65 
66 static inline void
67 ocs_sport_lock(ocs_sport_t *sport)
68 {
69 	/* Use the device wide lock */
70 	ocs_device_lock(sport->ocs);
71 }
72 
73 static inline void
74 ocs_sport_unlock(ocs_sport_t *sport)
75 {
76 	/* Use the device wide lock */
77 	ocs_device_unlock(sport->ocs);
78 }
79 
80 extern ocs_sport_t *ocs_sport_find(ocs_domain_t *domain, uint32_t d_id);
81 extern ocs_sport_t *ocs_sport_find_wwn(ocs_domain_t *domain, uint64_t wwnn, uint64_t wwpn);
82 extern int32_t ocs_sport_attach(ocs_sport_t *sport, uint32_t fc_id);
83 
84 extern void *__ocs_sport_allocated(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
85 extern void *__ocs_sport_wait_shutdown(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
86 extern void *__ocs_sport_wait_port_free(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
87 extern void *__ocs_sport_vport_init(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
88 extern void *__ocs_sport_vport_wait_alloc(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
89 extern void *__ocs_sport_vport_allocated(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
90 extern void *__ocs_sport_attached(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
91 
92 extern int32_t ocs_vport_start(ocs_domain_t *domain);
93 extern int32_t ocs_sport_vport_new(ocs_domain_t *domain, uint64_t wwpn, uint64_t wwnn, uint32_t fc_id, uint8_t ini, uint8_t tgt, void *tgt_data, void *ini_data, uint8_t restore_vport);
94 extern int32_t ocs_sport_vport_alloc(ocs_domain_t *domain, ocs_vport_spec_t *vport);
95 extern int32_t ocs_sport_vport_del(ocs_t *ocs, ocs_domain_t *domain, uint64_t wwpn, uint64_t wwnn);
96 extern void ocs_vport_del_all(ocs_t *ocs);
97 extern int8_t ocs_vport_create_spec(ocs_t *ocs, uint64_t wwnn, uint64_t wwpn, uint32_t fc_id, uint32_t enable_ini, uint32_t enable_tgt, void *tgt_data, void *ini_data);
98 
99 extern int ocs_ddump_sport(ocs_textbuf_t *textbuf, ocs_sport_t *sport);
100 
101 /* Node group API */
102 extern int ocs_sparm_cmp(uint8_t *sparms1, uint8_t *sparms2);
103 extern ocs_node_group_dir_t *ocs_node_group_dir_alloc(ocs_sport_t *sport, uint8_t *sparms);
104 extern void ocs_node_group_dir_free(ocs_node_group_dir_t *node_group_dir);
105 extern ocs_node_group_dir_t *ocs_node_group_dir_find(ocs_sport_t *sport, uint8_t *sparms);
106 extern ocs_remote_node_group_t *ocs_remote_node_group_alloc(ocs_node_group_dir_t *node_group_dir);
107 extern void ocs_remote_node_group_free(ocs_remote_node_group_t *node_group);
108 extern int ocs_node_group_init(ocs_node_t *node);
109 extern void ocs_node_group_free(ocs_node_t *node);
110 
111 
112 
113 #endif
114