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
32 /**
33 * @file
34 * OCS FC SLI port (SPORT) exported declarations
35 *
36 */
37
38 #if !defined(__OCS_SPORT_H__)
39 #define __OCS_SPORT_H__
40
41 extern int32_t ocs_port_cb(void *arg, ocs_hw_port_event_e event, void *data);
42 extern ocs_sport_t *ocs_sport_alloc(ocs_domain_t *domain, uint64_t wwpn, uint64_t wwnn, uint32_t fc_id,
43 uint8_t enable_ini, uint8_t enable_tgt);
44 extern void ocs_sport_free(ocs_sport_t *sport);
45 extern void ocs_sport_force_free(ocs_sport_t *sport);
46
47 static inline void
ocs_sport_lock_init(ocs_sport_t * sport)48 ocs_sport_lock_init(ocs_sport_t *sport)
49 {
50 }
51
52 static inline void
ocs_sport_lock_free(ocs_sport_t * sport)53 ocs_sport_lock_free(ocs_sport_t *sport)
54 {
55 }
56
57 static inline int32_t
ocs_sport_lock_try(ocs_sport_t * sport)58 ocs_sport_lock_try(ocs_sport_t *sport)
59 {
60 /* Use the device wide lock */
61 return ocs_device_lock_try(sport->ocs);
62 }
63
64 static inline void
ocs_sport_lock(ocs_sport_t * sport)65 ocs_sport_lock(ocs_sport_t *sport)
66 {
67 /* Use the device wide lock */
68 ocs_device_lock(sport->ocs);
69 }
70
71 static inline void
ocs_sport_unlock(ocs_sport_t * sport)72 ocs_sport_unlock(ocs_sport_t *sport)
73 {
74 /* Use the device wide lock */
75 ocs_device_unlock(sport->ocs);
76 }
77
78 extern ocs_sport_t *ocs_sport_find(ocs_domain_t *domain, uint32_t d_id);
79 extern ocs_sport_t *ocs_sport_find_wwn(ocs_domain_t *domain, uint64_t wwnn, uint64_t wwpn);
80 extern int32_t ocs_sport_attach(ocs_sport_t *sport, uint32_t fc_id);
81
82 extern void *__ocs_sport_allocated(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
83 extern void *__ocs_sport_wait_shutdown(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
84 extern void *__ocs_sport_wait_port_free(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
85 extern void *__ocs_sport_vport_init(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
86 extern void *__ocs_sport_vport_wait_alloc(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
87 extern void *__ocs_sport_vport_allocated(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
88 extern void *__ocs_sport_attached(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
89
90 extern int32_t ocs_vport_start(ocs_domain_t *domain);
91 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);
92 extern int32_t ocs_sport_vport_alloc(ocs_domain_t *domain, ocs_vport_spec_t *vport);
93 extern int32_t ocs_sport_vport_del(ocs_t *ocs, ocs_domain_t *domain, uint64_t wwpn, uint64_t wwnn);
94 extern void ocs_vport_del_all(ocs_t *ocs);
95 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);
96
97 extern int ocs_ddump_sport(ocs_textbuf_t *textbuf, ocs_sport_t *sport);
98
99 /* Node group API */
100 extern int ocs_sparm_cmp(uint8_t *sparms1, uint8_t *sparms2);
101 extern ocs_node_group_dir_t *ocs_node_group_dir_alloc(ocs_sport_t *sport, uint8_t *sparms);
102 extern void ocs_node_group_dir_free(ocs_node_group_dir_t *node_group_dir);
103 extern ocs_node_group_dir_t *ocs_node_group_dir_find(ocs_sport_t *sport, uint8_t *sparms);
104 extern ocs_remote_node_group_t *ocs_remote_node_group_alloc(ocs_node_group_dir_t *node_group_dir);
105 extern void ocs_remote_node_group_free(ocs_remote_node_group_t *node_group);
106 extern int ocs_node_group_init(ocs_node_t *node);
107 extern void ocs_node_group_free(ocs_node_t *node);
108
109 #endif
110