d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
0bc522c2d6
freebsd-dev/sys/dev/ocs_fc/ocs_node.h
Kenneth D. Merry ef270ab1b6 Bring in the Broadcom/Emulex Fibre Channel driver, ocs_fc(4). 
The ocs_fc(4) driver supports the following hardware:

Emulex 16/8G FC GEN 5 HBAS
	LPe15004 FC Host Bus Adapters
	LPe160XX FC Host Bus Adapters

Emulex 32/16G FC GEN 6 HBAS
	LPe3100X FC Host Bus Adapters
	LPe3200X FC Host Bus Adapters

The driver supports target and initiator mode, and also supports FC-Tape.

Note that the driver only currently works on little endian platforms.  It
is only included in the module build for amd64 and i386, and in GENERIC
on amd64 only.

Submitted by:	Ram Kishore Vegesna <ram.vegesna@broadcom.com>
Reviewed by:	mav
MFC after:	5 days
Relnotes:	yes
Sponsored by:	Broadcom
Differential Revision:	https://reviews.freebsd.org/D11423
2018-03-30 15:28:25 +00:00

241 lines
8.4 KiB
C
Raw Blame History

/*-
* Copyright (c) 2017 Broadcom. All rights reserved.
* The term "Broadcom" refers to Broadcom Limited and/or its subsidiaries.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* $FreeBSD$
*/
/**
* @file
* OCS linux driver remote node callback declarations
*/
#if !defined(__OCS_NODE_H__)
#define __OCS_NODE_H__
#define node_sm_trace() \
do { \
if (OCS_LOG_ENABLE_SM_TRACE(node->ocs)) \
ocs_log_info(node->ocs, "[%s] %-20s\n", node->display_name, ocs_sm_event_name(evt)); \
} while (0)
#define node_printf(node, fmt, ...) ocs_log_debug(node->ocs, "[%s] " fmt, node->display_name, ##__VA_ARGS__)
#define std_node_state_decl(...) \
ocs_node_t *node = NULL; \
ocs_t *ocs = NULL; \
node = ctx->app; \
ocs_assert(node, NULL); \
ocs = node->ocs; \
ocs_assert(ocs, NULL); \
if (evt == OCS_EVT_ENTER) { \
ocs_strncpy(node->current_state_name, __func__, sizeof(node->current_state_name)); \
} else if (evt == OCS_EVT_EXIT) { \
ocs_strncpy(node->prev_state_name, node->current_state_name, sizeof(node->prev_state_name)); \
ocs_strncpy(node->current_state_name, "invalid", sizeof(node->current_state_name)); \
} \
node->prev_evt = node->current_evt; \
node->current_evt = evt;
#define OCS_NODEDB_PAUSE_FABRIC_LOGIN (1U << 0)
#define OCS_NODEDB_PAUSE_NAMESERVER (1U << 1)
#define OCS_NODEDB_PAUSE_NEW_NODES (1U << 2)
/**
* @brief Node SM IO Context Callback structure
*
* Structure used as callback argument
*/
struct ocs_node_cb_s {
ocs_io_t *io; /**< SCSI IO for sending response */
int32_t status; /**< completion status */
int32_t ext_status; /**< extended completion status */
ocs_hw_rq_buffer_t *header; /**< completion header buffer */
ocs_hw_rq_buffer_t *payload; /**< completion payload buffers */
ocs_io_t *els; /**< ELS IO object */
};
/**
* @brief hold frames in pending frame list
*
* Unsolicited receive frames are held on the node pending frame list, rather than
* being processed.
*
* @param node pointer to node structure
*
* @return none
*/
static inline void
ocs_node_hold_frames(ocs_node_t *node)
{
ocs_assert(node);
node->hold_frames = TRUE;
}
/**
* @brief accept frames
*
* Unsolicited receive frames processed rather than being held on the node
* pending frame list.
*
* @param node pointer to node structure
*
* @return none
*/
static inline void
ocs_node_accept_frames(ocs_node_t *node)
{
ocs_assert(node);
node->hold_frames = FALSE;
}
extern int32_t ocs_node_create_pool(ocs_t *ocs, uint32_t node_count);
extern void ocs_node_free_pool(ocs_t *ocs);
extern ocs_node_t *ocs_node_get_instance(ocs_t *ocs, uint32_t index);
static inline void
ocs_node_lock_init(ocs_node_t *node)
{
ocs_rlock_init(node->ocs, &node->lock, "node rlock");
}
static inline void
ocs_node_lock_free(ocs_node_t *node)
{
ocs_rlock_free(&node->lock);
}
static inline int32_t
ocs_node_lock_try(ocs_node_t *node)
{
return ocs_rlock_try(&node->lock);
}
static inline void
ocs_node_lock(ocs_node_t *node)
{
ocs_rlock_acquire(&node->lock);
}
static inline void
ocs_node_unlock(ocs_node_t *node)
{
ocs_rlock_release(&node->lock);
}
/**
* @brief Node initiator/target enable defines
*
* All combinations of the SLI port (sport) initiator/target enable, and remote
* node initiator/target enable are enumerated.
*
*/
typedef enum {
OCS_NODE_ENABLE_x_TO_x,
OCS_NODE_ENABLE_x_TO_T,
OCS_NODE_ENABLE_x_TO_I,
OCS_NODE_ENABLE_x_TO_IT,
OCS_NODE_ENABLE_T_TO_x,
OCS_NODE_ENABLE_T_TO_T,
OCS_NODE_ENABLE_T_TO_I,
OCS_NODE_ENABLE_T_TO_IT,
OCS_NODE_ENABLE_I_TO_x,
OCS_NODE_ENABLE_I_TO_T,
OCS_NODE_ENABLE_I_TO_I,
OCS_NODE_ENABLE_I_TO_IT,
OCS_NODE_ENABLE_IT_TO_x,
OCS_NODE_ENABLE_IT_TO_T,
OCS_NODE_ENABLE_IT_TO_I,
OCS_NODE_ENABLE_IT_TO_IT,
} ocs_node_enable_e;
static inline ocs_node_enable_e ocs_node_get_enable(ocs_node_t *node)
{
uint32_t retval = 0;
if (node->sport->enable_ini) retval |= (1U << 3);
if (node->sport->enable_tgt) retval |= (1U << 2);
if (node->init) retval |= (1U << 1);
if (node->targ) retval |= (1U << 0);
return (ocs_node_enable_e) retval;
}
typedef void* (*ocs_node_common_func_t)(const char *funcname, ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
extern int32_t node_check_els_req(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg, uint8_t cmd, ocs_node_common_func_t node_common_func, const char *funcname);
extern int32_t node_check_ns_req(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg, uint32_t cmd, ocs_node_common_func_t node_common_func, const char *funcname);
extern int32_t ocs_remote_node_cb(void *arg, ocs_hw_remote_node_event_e event, void *data);
extern int32_t ocs_node_attach(ocs_node_t *node);
extern ocs_node_t *ocs_node_find(ocs_sport_t *sport, uint32_t port_id);
extern ocs_node_t *ocs_node_find_wwpn(ocs_sport_t *sport, uint64_t wwpn);
extern void ocs_node_dump(ocs_t *ocs);
extern ocs_node_t *ocs_node_alloc(ocs_sport_t *sport, uint32_t port_id, uint8_t init, uint8_t targ);
extern int32_t ocs_node_free(ocs_node_t *node);
extern void ocs_node_force_free(ocs_node_t *node);
extern void ocs_node_fcid_display(uint32_t fc_id, char *buffer, uint32_t buffer_length);
extern void ocs_node_update_display_name(ocs_node_t *node);
extern void *__ocs_node_shutdown(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
extern void * __ocs_node_wait_node_free(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
extern void *__ocs_node_wait_els_shutdown(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
extern void *__ocs_node_wait_ios_shutdown(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
extern void ocs_node_save_sparms(ocs_node_t *node, void *payload);
extern void ocs_node_post_event(ocs_node_t *node, ocs_sm_event_t evt, void *arg);
extern void ocs_node_transition(ocs_node_t *node, ocs_sm_function_t state, void *data);
extern void *__ocs_node_common(const char *funcname, ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
extern void ocs_node_initiate_cleanup(ocs_node_t *node);
extern int ocs_ddump_node(ocs_textbuf_t *textbuf, ocs_node_t *node);
extern void ocs_node_build_eui_name(char *buffer, uint32_t buffer_len, uint64_t eui_name);
extern uint64_t ocs_node_get_wwpn(ocs_node_t *node);
extern uint64_t ocs_node_get_wwnn(ocs_node_t *node);
extern void ocs_node_abort_all_els(ocs_node_t *node);
extern void ocs_node_pause(ocs_node_t *node, ocs_sm_function_t state);
extern int32_t ocs_node_resume(ocs_node_t *node);
extern void *__ocs_node_paused(ocs_sm_ctx_t *ctx, ocs_sm_event_t evt, void *arg);
extern int ocs_node_active_ios_empty(ocs_node_t *node);
extern void ocs_node_send_ls_io_cleanup(ocs_node_t *node);
extern int32_t ocs_node_recv_link_services_frame(ocs_node_t *node, ocs_hw_sequence_t *seq);
extern int32_t ocs_node_recv_abts_frame(ocs_node_t *node, ocs_hw_sequence_t *seq);
extern int32_t ocs_node_recv_els_frame(ocs_node_t *node, ocs_hw_sequence_t *seq);
extern int32_t ocs_node_recv_ct_frame(ocs_node_t *node, ocs_hw_sequence_t *seq);
extern int32_t ocs_node_recv_fcp_cmd(ocs_node_t *node, ocs_hw_sequence_t *seq);
extern int32_t ocs_node_recv_bls_no_sit(ocs_node_t *node, ocs_hw_sequence_t *seq);
#endif
Reference in New Issue View Git Blame Copy Permalink