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 * Declare driver's domain handler exported interface 35 */ 36 37 #if !defined(__OCS_DOMAIN_H__) 38 #define __OCS_DOMAIN_H__ 39 extern int32_t ocs_domain_init(ocs_t *ocs, ocs_domain_t *domain); 40 extern ocs_domain_t *ocs_domain_find(ocs_t *ocs, uint64_t fcf_wwn); 41 extern ocs_domain_t *ocs_domain_alloc(ocs_t *ocs, uint64_t fcf_wwn); 42 extern void ocs_domain_free(ocs_domain_t *domain); 43 extern void ocs_domain_force_free(ocs_domain_t *domain); 44 extern void ocs_register_domain_list_empty_cb(ocs_t *ocs, void (*callback)(ocs_t *ocs, void *arg), void *arg); 45 extern uint64_t ocs_get_wwn(ocs_hw_t *hw, ocs_hw_property_e prop); 46 47 static inline void 48 ocs_domain_lock_init(ocs_domain_t *domain) 49 { 50 } 51 52 static inline int32_t 53 ocs_domain_lock_try(ocs_domain_t *domain) 54 { 55 /* Use the device wide lock */ 56 return ocs_device_lock_try(domain->ocs); 57 } 58 59 static inline void 60 ocs_domain_lock(ocs_domain_t *domain) 61 { 62 /* Use the device wide lock */ 63 ocs_device_lock(domain->ocs); 64 } 65 66 static inline void 67 ocs_domain_unlock(ocs_domain_t *domain) 68 { 69 /* Use the device wide lock */ 70 ocs_device_unlock(domain->ocs); 71 } 72 73 extern int32_t ocs_domain_cb(void *arg, ocs_hw_domain_event_e event, void *data); 74 extern void *__ocs_domain_init(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg); 75 extern void *__ocs_domain_wait_alloc(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg); 76 extern void *__ocs_domain_allocated(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg); 77 extern void *__ocs_domain_wait_attach(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg); 78 extern void *__ocs_domain_ready(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg); 79 extern void *__ocs_domain_wait_sports_free(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg); 80 extern void *__ocs_domain_wait_shutdown(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg); 81 extern void *__ocs_domain_wait_domain_lost(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg); 82 83 extern void ocs_domain_save_sparms(ocs_domain_t *domain, void *payload); 84 extern void ocs_domain_attach(ocs_domain_t *domain, uint32_t s_id); 85 extern int ocs_domain_post_event(ocs_domain_t *domain, ocs_sm_event_t, void *); 86 87 extern int ocs_ddump_domain(ocs_textbuf_t *textbuf, ocs_domain_t *domain); 88 extern void __ocs_domain_attach_internal(ocs_domain_t *domain, uint32_t s_id); 89 #endif 90