On 12/20/19 11:36 PM, James Smart wrote:
> This patch starts the population of the libefc library.
> The library will contain common tasks usable by a target or initiator
> driver. The library will also contain a FC discovery state machine
> interface.
>
> This patch creates the library directory and adds definitions
> for the discovery state machine interface.
>
> Signed-off-by: Ram Vegesna <ram.vegesna@xxxxxxxxxxxx>
> Signed-off-by: James Smart <jsmart2021@xxxxxxxxx>
> ---
> drivers/scsi/elx/libefc/efc_sm.c | 213 +++++++++++++++++++++++++++++++++++++++
> drivers/scsi/elx/libefc/efc_sm.h | 140 +++++++++++++++++++++++++
> 2 files changed, 353 insertions(+)
> create mode 100644 drivers/scsi/elx/libefc/efc_sm.c
> create mode 100644 drivers/scsi/elx/libefc/efc_sm.h
>
> diff --git a/drivers/scsi/elx/libefc/efc_sm.c b/drivers/scsi/elx/libefc/efc_sm.c
> new file mode 100644
> index 000000000000..90e60c0e6638
> --- /dev/null
> +++ b/drivers/scsi/elx/libefc/efc_sm.c
> @@ -0,0 +1,213 @@
> +// SPDX-License-Identifier: GPL-2.0
> +/*
> + * Copyright (C) 2019 Broadcom. All Rights Reserved. The term
> + * “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
> + */
> +
> +/*
> + * Generic state machine framework.
> + */
> +#include "efc.h"
> +#include "efc_sm.h"
> +
> +const char *efc_sm_id[] = {
> + "common",
> + "domain",
> + "login"
> +};
> +
> +/**
> + * efc_sm_post_event() - Post an event to a context.
> + *
> + * @ctx: State machine context
> + * @evt: Event to post
> + * @data: Event-specific data (if any)
> + */
> +int
> +efc_sm_post_event(struct efc_sm_ctx *ctx,
> + enum efc_sm_event evt, void *data)
> +{
> + if (ctx->current_state) {
> + ctx->current_state(ctx, evt, data);
> + return 0;
> + } else {
> + return -1;
> + }
> +}
> +
> +void
> +efc_sm_transition(struct efc_sm_ctx *ctx,
> + void *(*state)(struct efc_sm_ctx *,
> + enum efc_sm_event, void *), void *data)
> +
> +{
> + if (ctx->current_state == state) {
> + efc_sm_post_event(ctx, EFC_EVT_REENTER, data);
> + } else {
> + efc_sm_post_event(ctx, EFC_EVT_EXIT, data);
> + ctx->current_state = state;
> + efc_sm_post_event(ctx, EFC_EVT_ENTER, data);
> + }
> +}
> +
> +void
> +efc_sm_disable(struct efc_sm_ctx *ctx)
> +{
> + ctx->current_state = NULL;
> +}
> +
> +const char *efc_sm_event_name(enum efc_sm_event evt)
> +{
> + switch (evt) {
> + case EFC_EVT_ENTER:
> + return "EFC_EVT_ENTER";
> + case EFC_EVT_REENTER:
> + return "EFC_EVT_REENTER";
> + case EFC_EVT_EXIT:
> + return "EFC_EVT_EXIT";
> + case EFC_EVT_SHUTDOWN:
> + return "EFC_EVT_SHUTDOWN";
> + case EFC_EVT_RESPONSE:
> + return "EFC_EVT_RESPONSE";
> + case EFC_EVT_RESUME:
> + return "EFC_EVT_RESUME";
> + case EFC_EVT_TIMER_EXPIRED:
> + return "EFC_EVT_TIMER_EXPIRED";
> + case EFC_EVT_ERROR:
> + return "EFC_EVT_ERROR";
> + case EFC_EVT_SRRS_ELS_REQ_OK:
> + return "EFC_EVT_SRRS_ELS_REQ_OK";
> + case EFC_EVT_SRRS_ELS_CMPL_OK:
> + return "EFC_EVT_SRRS_ELS_CMPL_OK";
> + case EFC_EVT_SRRS_ELS_REQ_FAIL:
> + return "EFC_EVT_SRRS_ELS_REQ_FAIL";
> + case EFC_EVT_SRRS_ELS_CMPL_FAIL:
> + return "EFC_EVT_SRRS_ELS_CMPL_FAIL";
> + case EFC_EVT_SRRS_ELS_REQ_RJT:
> + return "EFC_EVT_SRRS_ELS_REQ_RJT";
> + case EFC_EVT_NODE_ATTACH_OK:
> + return "EFC_EVT_NODE_ATTACH_OK";
> + case EFC_EVT_NODE_ATTACH_FAIL:
> + return "EFC_EVT_NODE_ATTACH_FAIL";
> + case EFC_EVT_NODE_FREE_OK:
> + return "EFC_EVT_NODE_FREE_OK";
> + case EFC_EVT_ELS_REQ_TIMEOUT:
> + return "EFC_EVT_ELS_REQ_TIMEOUT";
> + case EFC_EVT_ELS_REQ_ABORTED:
> + return "EFC_EVT_ELS_REQ_ABORTED";
> + case EFC_EVT_ABORT_ELS:
> + return "EFC_EVT_ABORT_ELS";
> + case EFC_EVT_ELS_ABORT_CMPL:
> + return "EFC_EVT_ELS_ABORT_CMPL";
> +
> + case EFC_EVT_DOMAIN_FOUND:
> + return "EFC_EVT_DOMAIN_FOUND";
> + case EFC_EVT_DOMAIN_ALLOC_OK:
> + return "EFC_EVT_DOMAIN_ALLOC_OK";
> + case EFC_EVT_DOMAIN_ALLOC_FAIL:
> + return "EFC_EVT_DOMAIN_ALLOC_FAIL";
> + case EFC_EVT_DOMAIN_REQ_ATTACH:
> + return "EFC_EVT_DOMAIN_REQ_ATTACH";
> + case EFC_EVT_DOMAIN_ATTACH_OK:
> + return "EFC_EVT_DOMAIN_ATTACH_OK";
> + case EFC_EVT_DOMAIN_ATTACH_FAIL:
> + return "EFC_EVT_DOMAIN_ATTACH_FAIL";
> + case EFC_EVT_DOMAIN_LOST:
> + return "EFC_EVT_DOMAIN_LOST";
> + case EFC_EVT_DOMAIN_FREE_OK:
> + return "EFC_EVT_DOMAIN_FREE_OK";
> + case EFC_EVT_DOMAIN_FREE_FAIL:
> + return "EFC_EVT_DOMAIN_FREE_FAIL";
> + case EFC_EVT_HW_DOMAIN_REQ_ATTACH:
> + return "EFC_EVT_HW_DOMAIN_REQ_ATTACH";
> + case EFC_EVT_HW_DOMAIN_REQ_FREE:
> + return "EFC_EVT_HW_DOMAIN_REQ_FREE";
> + case EFC_EVT_ALL_CHILD_NODES_FREE:
> + return "EFC_EVT_ALL_CHILD_NODES_FREE";
> +
> + case EFC_EVT_SPORT_ALLOC_OK:
> + return "EFC_EVT_SPORT_ALLOC_OK";
> + case EFC_EVT_SPORT_ALLOC_FAIL:
> + return "EFC_EVT_SPORT_ALLOC_FAIL";
> + case EFC_EVT_SPORT_ATTACH_OK:
> + return "EFC_EVT_SPORT_ATTACH_OK";
> + case EFC_EVT_SPORT_ATTACH_FAIL:
> + return "EFC_EVT_SPORT_ATTACH_FAIL";
> + case EFC_EVT_SPORT_FREE_OK:
> + return "EFC_EVT_SPORT_FREE_OK";
> + case EFC_EVT_SPORT_FREE_FAIL:
> + return "EFC_EVT_SPORT_FREE_FAIL";
> + case EFC_EVT_SPORT_TOPOLOGY_NOTIFY:
> + return "EFC_EVT_SPORT_TOPOLOGY_NOTIFY";
> + case EFC_EVT_HW_PORT_ALLOC_OK:
> + return "EFC_EVT_HW_PORT_ALLOC_OK";
> + case EFC_EVT_HW_PORT_ALLOC_FAIL:
> + return "EFC_EVT_HW_PORT_ALLOC_FAIL";
> + case EFC_EVT_HW_PORT_ATTACH_OK:
> + return "EFC_EVT_HW_PORT_ATTACH_OK";
> + case EFC_EVT_HW_PORT_REQ_ATTACH:
> + return "EFC_EVT_HW_PORT_REQ_ATTACH";
> + case EFC_EVT_HW_PORT_REQ_FREE:
> + return "EFC_EVT_HW_PORT_REQ_FREE";
> + case EFC_EVT_HW_PORT_FREE_OK:
> + return "EFC_EVT_HW_PORT_FREE_OK";
> +
> + case EFC_EVT_NODE_FREE_FAIL:
> + return "EFC_EVT_NODE_FREE_FAIL";
> +
> + case EFC_EVT_ABTS_RCVD:
> + return "EFC_EVT_ABTS_RCVD";
> +
> + case EFC_EVT_NODE_MISSING:
> + return "EFC_EVT_NODE_MISSING";
> + case EFC_EVT_NODE_REFOUND:
> + return "EFC_EVT_NODE_REFOUND";
> + case EFC_EVT_SHUTDOWN_IMPLICIT_LOGO:
> + return "EFC_EVT_SHUTDOWN_IMPLICIT_LOGO";
> + case EFC_EVT_SHUTDOWN_EXPLICIT_LOGO:
> + return "EFC_EVT_SHUTDOWN_EXPLICIT_LOGO";
> +
> + case EFC_EVT_ELS_FRAME:
> + return "EFC_EVT_ELS_FRAME";
> + case EFC_EVT_PLOGI_RCVD:
> + return "EFC_EVT_PLOGI_RCVD";
> + case EFC_EVT_FLOGI_RCVD:
> + return "EFC_EVT_FLOGI_RCVD";
> + case EFC_EVT_LOGO_RCVD:
> + return "EFC_EVT_LOGO_RCVD";
> + case EFC_EVT_PRLI_RCVD:
> + return "EFC_EVT_PRLI_RCVD";
> + case EFC_EVT_PRLO_RCVD:
> + return "EFC_EVT_PRLO_RCVD";
> + case EFC_EVT_PDISC_RCVD:
> + return "EFC_EVT_PDISC_RCVD";
> + case EFC_EVT_FDISC_RCVD:
> + return "EFC_EVT_FDISC_RCVD";
> + case EFC_EVT_ADISC_RCVD:
> + return "EFC_EVT_ADISC_RCVD";
> + case EFC_EVT_RSCN_RCVD:
> + return "EFC_EVT_RSCN_RCVD";
> + case EFC_EVT_SCR_RCVD:
> + return "EFC_EVT_SCR_RCVD";
> + case EFC_EVT_ELS_RCVD:
> + return "EFC_EVT_ELS_RCVD";
> + case EFC_EVT_LAST:
> + return "EFC_EVT_LAST";
> + case EFC_EVT_FCP_CMD_RCVD:
> + return "EFC_EVT_FCP_CMD_RCVD";
> +
> + case EFC_EVT_GIDPT_DELAY_EXPIRED:
> + return "EFC_EVT_GIDPT_DELAY_EXPIRED";
> +
> + case EFC_EVT_NODE_ACTIVE_IO_LIST_EMPTY:
> + return "EFC_EVT_NODE_ACTIVE_IO_LIST_EMPTY";
> + case EFC_EVT_NODE_DEL_INI_COMPLETE:
> + return "EFC_EVT_NODE_DEL_INI_COMPLETE";
> + case EFC_EVT_NODE_DEL_TGT_COMPLETE:
> + return "EFC_EVT_NODE_DEL_TGT_COMPLETE";
> +
> + default:
> + break;
> + }
> + return "unknown";
> +}
Please convert into a lookup array.
> diff --git a/drivers/scsi/elx/libefc/efc_sm.h b/drivers/scsi/elx/libefc/efc_sm.h
> new file mode 100644
> index 000000000000..c76352d1d527
> --- /dev/null
> +++ b/drivers/scsi/elx/libefc/efc_sm.h
> @@ -0,0 +1,140 @@
> +/* SPDX-License-Identifier: GPL-2.0 */
> +/*
> + * Copyright (C) 2019 Broadcom. All Rights Reserved. The term
> + * “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.
> + *
> + */
> +
> +/**
> + * Generic state machine framework declarations.
> + */
> +
> +#ifndef _EFC_SM_H
> +#define _EFC_SM_H
> +
> +/**
> + * State Machine (SM) IDs.
> + */
> +enum {
> + EFC_SM_COMMON = 0,
> + EFC_SM_DOMAIN,
> + EFC_SM_PORT,
> + EFC_SM_LOGIN,
> + EFC_SM_LAST
> +};
> +
> +#define EFC_SM_EVENT_SHIFT 24
> +#define EFC_SM_EVENT_START(id) ((id) << EFC_SM_EVENT_SHIFT)
> +
> +extern const char *efc_sm_id[];
> +
Curious.
You define 4 state machine IDs, yet declare names for only 3 of them.
Omission?
And I would probably use a lookup function for the state machines; this
'const char *efc_sm_id[]' looks a bit lonely. Plus I'm always wary of
variable sized global const ...
Cheers,
Hannes
--
Dr. Hannes Reinecke Teamlead Storage & Networking
hare@xxxxxxx +49 911 74053 688
SUSE Software Solutions Germany GmbH, Maxfeldstr. 5, 90409 Nürnberg
HRB 36809 (AG Nürnberg), GF: Felix Imendörffer
