ARM: 6246/1: mmci: support larger MMCIDATALENGTH register

[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / scsi / bfa / bfa_ioc.c

/*
 * Copyright (c) 2005-2009 Brocade Communications Systems, Inc.
 * All rights reserved
 * www.brocade.com
 *
 * Linux driver for Brocade Fibre Channel Host Bus Adapter.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License (GPL) Version 2 as
 * published by the Free Software Foundation
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 */

#include <bfa.h>
#include <bfa_ioc.h>
#include <bfa_fwimg_priv.h>
#include <cna/bfa_cna_trcmod.h>
#include <cs/bfa_debug.h>
#include <bfi/bfi_ioc.h>
#include <bfi/bfi_ctreg.h>
#include <aen/bfa_aen_ioc.h>
#include <aen/bfa_aen.h>
#include <log/bfa_log_hal.h>
#include <defs/bfa_defs_pci.h>

BFA_TRC_FILE(CNA, IOC);

/**
 * IOC local definitions
 */
#define BFA_IOC_TOV             2000    /* msecs */
#define BFA_IOC_HWSEM_TOV       500     /* msecs */
#define BFA_IOC_HB_TOV          500     /* msecs */
#define BFA_IOC_HWINIT_MAX      2
#define BFA_IOC_FWIMG_MINSZ     (16 * 1024)
#define BFA_IOC_TOV_RECOVER      BFA_IOC_HB_TOV

#define bfa_ioc_timer_start(__ioc)                                      \
        bfa_timer_begin((__ioc)->timer_mod, &(__ioc)->ioc_timer,        \
                        bfa_ioc_timeout, (__ioc), BFA_IOC_TOV)
#define bfa_ioc_timer_stop(__ioc)   bfa_timer_stop(&(__ioc)->ioc_timer)

#define BFA_DBG_FWTRC_ENTS      (BFI_IOC_TRC_ENTS)
#define BFA_DBG_FWTRC_LEN                                       \
        (BFA_DBG_FWTRC_ENTS * sizeof(struct bfa_trc_s) +        \
         (sizeof(struct bfa_trc_mod_s) -                        \
          BFA_TRC_MAX * sizeof(struct bfa_trc_s)))
#define BFA_DBG_FWTRC_OFF(_fn)  (BFI_IOC_TRC_OFF + BFA_DBG_FWTRC_LEN * (_fn))

/**
 * Asic specific macros : see bfa_hw_cb.c and bfa_hw_ct.c for details.
 */

#define bfa_ioc_firmware_lock(__ioc)                    \
                        ((__ioc)->ioc_hwif->ioc_firmware_lock(__ioc))
#define bfa_ioc_firmware_unlock(__ioc)                  \
                        ((__ioc)->ioc_hwif->ioc_firmware_unlock(__ioc))
#define bfa_ioc_fwimg_get_chunk(__ioc, __off)           \
                        ((__ioc)->ioc_hwif->ioc_fwimg_get_chunk(__ioc, __off))
#define bfa_ioc_fwimg_get_size(__ioc)                   \
                        ((__ioc)->ioc_hwif->ioc_fwimg_get_size(__ioc))
#define bfa_ioc_reg_init(__ioc) ((__ioc)->ioc_hwif->ioc_reg_init(__ioc))
#define bfa_ioc_map_port(__ioc) ((__ioc)->ioc_hwif->ioc_map_port(__ioc))
#define bfa_ioc_notify_hbfail(__ioc)                    \
                        ((__ioc)->ioc_hwif->ioc_notify_hbfail(__ioc))

bfa_boolean_t   bfa_auto_recover = BFA_TRUE;

/*
 * forward declarations
 */
static void     bfa_ioc_aen_post(struct bfa_ioc_s *bfa,
                                 enum bfa_ioc_aen_event event);
static void     bfa_ioc_hw_sem_get(struct bfa_ioc_s *ioc);
static void     bfa_ioc_hw_sem_get_cancel(struct bfa_ioc_s *ioc);
static void     bfa_ioc_hwinit(struct bfa_ioc_s *ioc, bfa_boolean_t force);
static void     bfa_ioc_timeout(void *ioc);
static void     bfa_ioc_send_enable(struct bfa_ioc_s *ioc);
static void     bfa_ioc_send_disable(struct bfa_ioc_s *ioc);
static void     bfa_ioc_send_getattr(struct bfa_ioc_s *ioc);
static void     bfa_ioc_hb_monitor(struct bfa_ioc_s *ioc);
static void     bfa_ioc_hb_stop(struct bfa_ioc_s *ioc);
static void     bfa_ioc_reset(struct bfa_ioc_s *ioc, bfa_boolean_t force);
static void     bfa_ioc_mbox_poll(struct bfa_ioc_s *ioc);
static void     bfa_ioc_mbox_hbfail(struct bfa_ioc_s *ioc);
static void     bfa_ioc_recover(struct bfa_ioc_s *ioc);
static void     bfa_ioc_disable_comp(struct bfa_ioc_s *ioc);
static void     bfa_ioc_lpu_stop(struct bfa_ioc_s *ioc);

/**
 *  bfa_ioc_sm
 */

/**
 * IOC state machine events
 */
enum ioc_event {
        IOC_E_ENABLE = 1,       /*  IOC enable request */
        IOC_E_DISABLE = 2,      /*  IOC disable request */
        IOC_E_TIMEOUT = 3,      /*  f/w response timeout */
        IOC_E_FWREADY = 4,      /*  f/w initialization done */
        IOC_E_FWRSP_GETATTR = 5,        /*  IOC get attribute response */
        IOC_E_FWRSP_ENABLE = 6, /*  enable f/w response */
        IOC_E_FWRSP_DISABLE = 7,        /*  disable f/w response */
        IOC_E_HBFAIL = 8,       /*  heartbeat failure */
        IOC_E_HWERROR = 9,      /*  hardware error interrupt */
        IOC_E_SEMLOCKED = 10,   /*  h/w semaphore is locked */
        IOC_E_DETACH = 11,      /*  driver detach cleanup */
};

bfa_fsm_state_decl(bfa_ioc, reset, struct bfa_ioc_s, enum ioc_event);
bfa_fsm_state_decl(bfa_ioc, fwcheck, struct bfa_ioc_s, enum ioc_event);
bfa_fsm_state_decl(bfa_ioc, mismatch, struct bfa_ioc_s, enum ioc_event);
bfa_fsm_state_decl(bfa_ioc, semwait, struct bfa_ioc_s, enum ioc_event);
bfa_fsm_state_decl(bfa_ioc, hwinit, struct bfa_ioc_s, enum ioc_event);
bfa_fsm_state_decl(bfa_ioc, enabling, struct bfa_ioc_s, enum ioc_event);
bfa_fsm_state_decl(bfa_ioc, getattr, struct bfa_ioc_s, enum ioc_event);
bfa_fsm_state_decl(bfa_ioc, op, struct bfa_ioc_s, enum ioc_event);
bfa_fsm_state_decl(bfa_ioc, initfail, struct bfa_ioc_s, enum ioc_event);
bfa_fsm_state_decl(bfa_ioc, hbfail, struct bfa_ioc_s, enum ioc_event);
bfa_fsm_state_decl(bfa_ioc, disabling, struct bfa_ioc_s, enum ioc_event);
bfa_fsm_state_decl(bfa_ioc, disabled, struct bfa_ioc_s, enum ioc_event);

static struct bfa_sm_table_s ioc_sm_table[] = {
        {BFA_SM(bfa_ioc_sm_reset), BFA_IOC_RESET},
        {BFA_SM(bfa_ioc_sm_fwcheck), BFA_IOC_FWMISMATCH},
        {BFA_SM(bfa_ioc_sm_mismatch), BFA_IOC_FWMISMATCH},
        {BFA_SM(bfa_ioc_sm_semwait), BFA_IOC_SEMWAIT},
        {BFA_SM(bfa_ioc_sm_hwinit), BFA_IOC_HWINIT},
        {BFA_SM(bfa_ioc_sm_enabling), BFA_IOC_HWINIT},
        {BFA_SM(bfa_ioc_sm_getattr), BFA_IOC_GETATTR},
        {BFA_SM(bfa_ioc_sm_op), BFA_IOC_OPERATIONAL},
        {BFA_SM(bfa_ioc_sm_initfail), BFA_IOC_INITFAIL},
        {BFA_SM(bfa_ioc_sm_hbfail), BFA_IOC_HBFAIL},
        {BFA_SM(bfa_ioc_sm_disabling), BFA_IOC_DISABLING},
        {BFA_SM(bfa_ioc_sm_disabled), BFA_IOC_DISABLED},
};

/**
 * Reset entry actions -- initialize state machine
 */
static void
bfa_ioc_sm_reset_entry(struct bfa_ioc_s *ioc)
{
        ioc->retry_count = 0;
        ioc->auto_recover = bfa_auto_recover;
}

/**
 * Beginning state. IOC is in reset state.
 */
static void
bfa_ioc_sm_reset(struct bfa_ioc_s *ioc, enum ioc_event event)
{
        bfa_trc(ioc, event);

        switch (event) {
        case IOC_E_ENABLE:
                bfa_fsm_set_state(ioc, bfa_ioc_sm_fwcheck);
                break;

        case IOC_E_DISABLE:
                bfa_ioc_disable_comp(ioc);
                break;

        case IOC_E_DETACH:
                break;

        default:
                bfa_sm_fault(ioc, event);
        }
}

/**
 * Semaphore should be acquired for version check.
 */
static void
bfa_ioc_sm_fwcheck_entry(struct bfa_ioc_s *ioc)
{
        bfa_ioc_hw_sem_get(ioc);
}

/**
 * Awaiting h/w semaphore to continue with version check.
 */
static void
bfa_ioc_sm_fwcheck(struct bfa_ioc_s *ioc, enum ioc_event event)
{
        bfa_trc(ioc, event);

        switch (event) {
        case IOC_E_SEMLOCKED:
                if (bfa_ioc_firmware_lock(ioc)) {
                        ioc->retry_count = 0;
                        bfa_fsm_set_state(ioc, bfa_ioc_sm_hwinit);
                } else {
                        bfa_ioc_hw_sem_release(ioc);
                        bfa_fsm_set_state(ioc, bfa_ioc_sm_mismatch);
                }
                break;

        case IOC_E_DISABLE:
                bfa_ioc_disable_comp(ioc);
                /*
                 * fall through
                 */

        case IOC_E_DETACH:
                bfa_ioc_hw_sem_get_cancel(ioc);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_reset);
                break;

        case IOC_E_FWREADY:
                break;

        default:
                bfa_sm_fault(ioc, event);
        }
}

/**
 * Notify enable completion callback and generate mismatch AEN.
 */
static void
bfa_ioc_sm_mismatch_entry(struct bfa_ioc_s *ioc)
{
        /**
         * Provide enable completion callback and AEN notification only once.
         */
        if (ioc->retry_count == 0) {
                ioc->cbfn->enable_cbfn(ioc->bfa, BFA_STATUS_IOC_FAILURE);
                bfa_ioc_aen_post(ioc, BFA_IOC_AEN_FWMISMATCH);
        }
        ioc->retry_count++;
        bfa_ioc_timer_start(ioc);
}

/**
 * Awaiting firmware version match.
 */
static void
bfa_ioc_sm_mismatch(struct bfa_ioc_s *ioc, enum ioc_event event)
{
        bfa_trc(ioc, event);

        switch (event) {
        case IOC_E_TIMEOUT:
                bfa_fsm_set_state(ioc, bfa_ioc_sm_fwcheck);
                break;

        case IOC_E_DISABLE:
                bfa_ioc_disable_comp(ioc);
                /*
                 * fall through
                 */

        case IOC_E_DETACH:
                bfa_ioc_timer_stop(ioc);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_reset);
                break;

        case IOC_E_FWREADY:
                break;

        default:
                bfa_sm_fault(ioc, event);
        }
}

/**
 * Request for semaphore.
 */
static void
bfa_ioc_sm_semwait_entry(struct bfa_ioc_s *ioc)
{
        bfa_ioc_hw_sem_get(ioc);
}

/**
 * Awaiting semaphore for h/w initialzation.
 */
static void
bfa_ioc_sm_semwait(struct bfa_ioc_s *ioc, enum ioc_event event)
{
        bfa_trc(ioc, event);

        switch (event) {
        case IOC_E_SEMLOCKED:
                ioc->retry_count = 0;
                bfa_fsm_set_state(ioc, bfa_ioc_sm_hwinit);
                break;

        case IOC_E_DISABLE:
                bfa_ioc_hw_sem_get_cancel(ioc);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_disabled);
                break;

        default:
                bfa_sm_fault(ioc, event);
        }
}


static void
bfa_ioc_sm_hwinit_entry(struct bfa_ioc_s *ioc)
{
        bfa_ioc_timer_start(ioc);
        bfa_ioc_reset(ioc, BFA_FALSE);
}

/**
 * Hardware is being initialized. Interrupts are enabled.
 * Holding hardware semaphore lock.
 */
static void
bfa_ioc_sm_hwinit(struct bfa_ioc_s *ioc, enum ioc_event event)
{
        bfa_trc(ioc, event);

        switch (event) {
        case IOC_E_FWREADY:
                bfa_ioc_timer_stop(ioc);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_enabling);
                break;

        case IOC_E_HWERROR:
                bfa_ioc_timer_stop(ioc);
                /*
                 * fall through
                 */

        case IOC_E_TIMEOUT:
                ioc->retry_count++;
                if (ioc->retry_count < BFA_IOC_HWINIT_MAX) {
                        bfa_ioc_timer_start(ioc);
                        bfa_ioc_reset(ioc, BFA_TRUE);
                        break;
                }

                bfa_ioc_hw_sem_release(ioc);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_initfail);
                break;

        case IOC_E_DISABLE:
                bfa_ioc_hw_sem_release(ioc);
                bfa_ioc_timer_stop(ioc);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_disabled);
                break;

        default:
                bfa_sm_fault(ioc, event);
        }
}


static void
bfa_ioc_sm_enabling_entry(struct bfa_ioc_s *ioc)
{
        bfa_ioc_timer_start(ioc);
        bfa_ioc_send_enable(ioc);
}

/**
 * Host IOC function is being enabled, awaiting response from firmware.
 * Semaphore is acquired.
 */
static void
bfa_ioc_sm_enabling(struct bfa_ioc_s *ioc, enum ioc_event event)
{
        bfa_trc(ioc, event);

        switch (event) {
        case IOC_E_FWRSP_ENABLE:
                bfa_ioc_timer_stop(ioc);
                bfa_ioc_hw_sem_release(ioc);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_getattr);
                break;

        case IOC_E_HWERROR:
                bfa_ioc_timer_stop(ioc);
                /*
                 * fall through
                 */

        case IOC_E_TIMEOUT:
                ioc->retry_count++;
                if (ioc->retry_count < BFA_IOC_HWINIT_MAX) {
                        bfa_reg_write(ioc->ioc_regs.ioc_fwstate,
                                      BFI_IOC_UNINIT);
                        bfa_fsm_set_state(ioc, bfa_ioc_sm_hwinit);
                        break;
                }

                bfa_ioc_hw_sem_release(ioc);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_initfail);
                break;

        case IOC_E_DISABLE:
                bfa_ioc_timer_stop(ioc);
                bfa_ioc_hw_sem_release(ioc);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_disabled);
                break;

        case IOC_E_FWREADY:
                bfa_ioc_send_enable(ioc);
                break;

        default:
                bfa_sm_fault(ioc, event);
        }
}


static void
bfa_ioc_sm_getattr_entry(struct bfa_ioc_s *ioc)
{
        bfa_ioc_timer_start(ioc);
        bfa_ioc_send_getattr(ioc);
}

/**
 * IOC configuration in progress. Timer is active.
 */
static void
bfa_ioc_sm_getattr(struct bfa_ioc_s *ioc, enum ioc_event event)
{
        bfa_trc(ioc, event);

        switch (event) {
        case IOC_E_FWRSP_GETATTR:
                bfa_ioc_timer_stop(ioc);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_op);
                break;

        case IOC_E_HWERROR:
                bfa_ioc_timer_stop(ioc);
                /*
                 * fall through
                 */

        case IOC_E_TIMEOUT:
                bfa_fsm_set_state(ioc, bfa_ioc_sm_initfail);
                break;

        case IOC_E_DISABLE:
                bfa_ioc_timer_stop(ioc);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_disabled);
                break;

        default:
                bfa_sm_fault(ioc, event);
        }
}


static void
bfa_ioc_sm_op_entry(struct bfa_ioc_s *ioc)
{
        ioc->cbfn->enable_cbfn(ioc->bfa, BFA_STATUS_OK);
        bfa_ioc_hb_monitor(ioc);
        bfa_ioc_aen_post(ioc, BFA_IOC_AEN_ENABLE);
}

static void
bfa_ioc_sm_op(struct bfa_ioc_s *ioc, enum ioc_event event)
{
        bfa_trc(ioc, event);

        switch (event) {
        case IOC_E_ENABLE:
                break;

        case IOC_E_DISABLE:
                bfa_ioc_hb_stop(ioc);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_disabling);
                break;

        case IOC_E_HWERROR:
        case IOC_E_FWREADY:
                /**
                 * Hard error or IOC recovery by other function.
                 * Treat it same as heartbeat failure.
                 */
                bfa_ioc_hb_stop(ioc);
                /*
                 * !!! fall through !!!
                 */

        case IOC_E_HBFAIL:
                bfa_fsm_set_state(ioc, bfa_ioc_sm_hbfail);
                break;

        default:
                bfa_sm_fault(ioc, event);
        }
}


static void
bfa_ioc_sm_disabling_entry(struct bfa_ioc_s *ioc)
{
        bfa_ioc_aen_post(ioc, BFA_IOC_AEN_DISABLE);
        bfa_ioc_timer_start(ioc);
        bfa_ioc_send_disable(ioc);
}

/**
 * IOC is being disabled
 */
static void
bfa_ioc_sm_disabling(struct bfa_ioc_s *ioc, enum ioc_event event)
{
        bfa_trc(ioc, event);

        switch (event) {
        case IOC_E_FWRSP_DISABLE:
                bfa_ioc_timer_stop(ioc);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_disabled);
                break;

        case IOC_E_HWERROR:
                bfa_ioc_timer_stop(ioc);
                /*
                 * !!! fall through !!!
                 */

        case IOC_E_TIMEOUT:
                bfa_reg_write(ioc->ioc_regs.ioc_fwstate, BFI_IOC_FAIL);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_disabled);
                break;

        default:
                bfa_sm_fault(ioc, event);
        }
}

/**
 * IOC disable completion entry.
 */
static void
bfa_ioc_sm_disabled_entry(struct bfa_ioc_s *ioc)
{
        bfa_ioc_disable_comp(ioc);
}

static void
bfa_ioc_sm_disabled(struct bfa_ioc_s *ioc, enum ioc_event event)
{
        bfa_trc(ioc, event);

        switch (event) {
        case IOC_E_ENABLE:
                bfa_fsm_set_state(ioc, bfa_ioc_sm_semwait);
                break;

        case IOC_E_DISABLE:
                ioc->cbfn->disable_cbfn(ioc->bfa);
                break;

        case IOC_E_FWREADY:
                break;

        case IOC_E_DETACH:
                bfa_ioc_firmware_unlock(ioc);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_reset);
                break;

        default:
                bfa_sm_fault(ioc, event);
        }
}


static void
bfa_ioc_sm_initfail_entry(struct bfa_ioc_s *ioc)
{
        ioc->cbfn->enable_cbfn(ioc->bfa, BFA_STATUS_IOC_FAILURE);
        bfa_ioc_timer_start(ioc);
}

/**
 * Hardware initialization failed.
 */
static void
bfa_ioc_sm_initfail(struct bfa_ioc_s *ioc, enum ioc_event event)
{
        bfa_trc(ioc, event);

        switch (event) {
        case IOC_E_DISABLE:
                bfa_ioc_timer_stop(ioc);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_disabled);
                break;

        case IOC_E_DETACH:
                bfa_ioc_timer_stop(ioc);
                bfa_ioc_firmware_unlock(ioc);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_reset);
                break;

        case IOC_E_TIMEOUT:
                bfa_fsm_set_state(ioc, bfa_ioc_sm_semwait);
                break;

        default:
                bfa_sm_fault(ioc, event);
        }
}


static void
bfa_ioc_sm_hbfail_entry(struct bfa_ioc_s *ioc)
{
        struct list_head *qe;
        struct bfa_ioc_hbfail_notify_s *notify;

        /**
         * Mark IOC as failed in hardware and stop firmware.
         */
        bfa_ioc_lpu_stop(ioc);
        bfa_reg_write(ioc->ioc_regs.ioc_fwstate, BFI_IOC_FAIL);

        /**
         * Notify other functions on HB failure.
         */
        bfa_ioc_notify_hbfail(ioc);

        /**
         * Notify driver and common modules registered for notification.
         */
        ioc->cbfn->hbfail_cbfn(ioc->bfa);
        list_for_each(qe, &ioc->hb_notify_q) {
                notify = (struct bfa_ioc_hbfail_notify_s *)qe;
                notify->cbfn(notify->cbarg);
        }

        /**
         * Flush any queued up mailbox requests.
         */
        bfa_ioc_mbox_hbfail(ioc);
        bfa_ioc_aen_post(ioc, BFA_IOC_AEN_HBFAIL);

        /**
         * Trigger auto-recovery after a delay.
         */
        if (ioc->auto_recover) {
                bfa_timer_begin(ioc->timer_mod, &ioc->ioc_timer,
                                bfa_ioc_timeout, ioc, BFA_IOC_TOV_RECOVER);
        }
}

/**
 * IOC heartbeat failure.
 */
static void
bfa_ioc_sm_hbfail(struct bfa_ioc_s *ioc, enum ioc_event event)
{
        bfa_trc(ioc, event);

        switch (event) {

        case IOC_E_ENABLE:
                ioc->cbfn->enable_cbfn(ioc->bfa, BFA_STATUS_IOC_FAILURE);
                break;

        case IOC_E_DISABLE:
                if (ioc->auto_recover)
                        bfa_ioc_timer_stop(ioc);
                bfa_fsm_set_state(ioc, bfa_ioc_sm_disabled);
                break;

        case IOC_E_TIMEOUT:
                bfa_fsm_set_state(ioc, bfa_ioc_sm_semwait);
                break;

        case IOC_E_FWREADY:
                /**
                 * Recovery is already initiated by other function.
                 */
                break;

        case IOC_E_HWERROR:
                /*
                 * HB failure notification, ignore.
                 */
                break;

        default:
                bfa_sm_fault(ioc, event);
        }
}



/**
 *  bfa_ioc_pvt BFA IOC private functions
 */

static void
bfa_ioc_disable_comp(struct bfa_ioc_s *ioc)
{
        struct list_head *qe;
        struct bfa_ioc_hbfail_notify_s *notify;

        ioc->cbfn->disable_cbfn(ioc->bfa);

        /**
         * Notify common modules registered for notification.
         */
        list_for_each(qe, &ioc->hb_notify_q) {
                notify = (struct bfa_ioc_hbfail_notify_s *)qe;
                notify->cbfn(notify->cbarg);
        }
}

void
bfa_ioc_sem_timeout(void *ioc_arg)
{
        struct bfa_ioc_s *ioc = (struct bfa_ioc_s *)ioc_arg;

        bfa_ioc_hw_sem_get(ioc);
}

bfa_boolean_t
bfa_ioc_sem_get(bfa_os_addr_t sem_reg)
{
        u32 r32;
        int cnt = 0;
#define BFA_SEM_SPINCNT 3000

        r32 = bfa_reg_read(sem_reg);

        while (r32 && (cnt < BFA_SEM_SPINCNT)) {
                cnt++;
                bfa_os_udelay(2);
                r32 = bfa_reg_read(sem_reg);
        }

        if (r32 == 0)
                return BFA_TRUE;

        bfa_assert(cnt < BFA_SEM_SPINCNT);
        return BFA_FALSE;
}

void
bfa_ioc_sem_release(bfa_os_addr_t sem_reg)
{
        bfa_reg_write(sem_reg, 1);
}

static void
bfa_ioc_hw_sem_get(struct bfa_ioc_s *ioc)
{
        u32        r32;

        /**
         * First read to the semaphore register will return 0, subsequent reads
         * will return 1. Semaphore is released by writing 1 to the register
         */
        r32 = bfa_reg_read(ioc->ioc_regs.ioc_sem_reg);
        if (r32 == 0) {
                bfa_fsm_send_event(ioc, IOC_E_SEMLOCKED);
                return;
        }

        bfa_timer_begin(ioc->timer_mod, &ioc->sem_timer, bfa_ioc_sem_timeout,
                        ioc, BFA_IOC_HWSEM_TOV);
}

void
bfa_ioc_hw_sem_release(struct bfa_ioc_s *ioc)
{
        bfa_reg_write(ioc->ioc_regs.ioc_sem_reg, 1);
}

static void
bfa_ioc_hw_sem_get_cancel(struct bfa_ioc_s *ioc)
{
        bfa_timer_stop(&ioc->sem_timer);
}

/**
 * Initialize LPU local memory (aka secondary memory / SRAM)
 */
static void
bfa_ioc_lmem_init(struct bfa_ioc_s *ioc)
{
        u32        pss_ctl;
        int             i;
#define PSS_LMEM_INIT_TIME  10000

        pss_ctl = bfa_reg_read(ioc->ioc_regs.pss_ctl_reg);
        pss_ctl &= ~__PSS_LMEM_RESET;
        pss_ctl |= __PSS_LMEM_INIT_EN;
        pss_ctl |= __PSS_I2C_CLK_DIV(3UL); /* i2c workaround 12.5khz clock */
        bfa_reg_write(ioc->ioc_regs.pss_ctl_reg, pss_ctl);

        /**
         * wait for memory initialization to be complete
         */
        i = 0;
        do {
                pss_ctl = bfa_reg_read(ioc->ioc_regs.pss_ctl_reg);
                i++;
        } while (!(pss_ctl & __PSS_LMEM_INIT_DONE) && (i < PSS_LMEM_INIT_TIME));

        /**
         * If memory initialization is not successful, IOC timeout will catch
         * such failures.
         */
        bfa_assert(pss_ctl & __PSS_LMEM_INIT_DONE);
        bfa_trc(ioc, pss_ctl);

        pss_ctl &= ~(__PSS_LMEM_INIT_DONE | __PSS_LMEM_INIT_EN);
        bfa_reg_write(ioc->ioc_regs.pss_ctl_reg, pss_ctl);
}

static void
bfa_ioc_lpu_start(struct bfa_ioc_s *ioc)
{
        u32        pss_ctl;

        /**
         * Take processor out of reset.
         */
        pss_ctl = bfa_reg_read(ioc->ioc_regs.pss_ctl_reg);
        pss_ctl &= ~__PSS_LPU0_RESET;

        bfa_reg_write(ioc->ioc_regs.pss_ctl_reg, pss_ctl);
}

static void
bfa_ioc_lpu_stop(struct bfa_ioc_s *ioc)
{
        u32        pss_ctl;

        /**
         * Put processors in reset.
         */
        pss_ctl = bfa_reg_read(ioc->ioc_regs.pss_ctl_reg);
        pss_ctl |= (__PSS_LPU0_RESET | __PSS_LPU1_RESET);

        bfa_reg_write(ioc->ioc_regs.pss_ctl_reg, pss_ctl);
}

/**
 * Get driver and firmware versions.
 */
void
bfa_ioc_fwver_get(struct bfa_ioc_s *ioc, struct bfi_ioc_image_hdr_s *fwhdr)
{
        u32        pgnum, pgoff;
        u32        loff = 0;
        int             i;
        u32       *fwsig = (u32 *) fwhdr;

        pgnum = bfa_ioc_smem_pgnum(ioc, loff);
        pgoff = bfa_ioc_smem_pgoff(ioc, loff);
        bfa_reg_write(ioc->ioc_regs.host_page_num_fn, pgnum);

        for (i = 0; i < (sizeof(struct bfi_ioc_image_hdr_s) / sizeof(u32));
             i++) {
                fwsig[i] = bfa_mem_read(ioc->ioc_regs.smem_page_start, loff);
                loff += sizeof(u32);
        }
}

/**
 * Returns TRUE if same.
 */
bfa_boolean_t
bfa_ioc_fwver_cmp(struct bfa_ioc_s *ioc, struct bfi_ioc_image_hdr_s *fwhdr)
{
        struct bfi_ioc_image_hdr_s *drv_fwhdr;
        int             i;

        drv_fwhdr =
                (struct bfi_ioc_image_hdr_s *)bfa_ioc_fwimg_get_chunk(ioc, 0);

        for (i = 0; i < BFI_IOC_MD5SUM_SZ; i++) {
                if (fwhdr->md5sum[i] != drv_fwhdr->md5sum[i]) {
                        bfa_trc(ioc, i);
                        bfa_trc(ioc, fwhdr->md5sum[i]);
                        bfa_trc(ioc, drv_fwhdr->md5sum[i]);
                        return BFA_FALSE;
                }
        }

        bfa_trc(ioc, fwhdr->md5sum[0]);
        return BFA_TRUE;
}

/**
 * Return true if current running version is valid. Firmware signature and
 * execution context (driver/bios) must match.
 */
static          bfa_boolean_t
bfa_ioc_fwver_valid(struct bfa_ioc_s *ioc)
{
        struct bfi_ioc_image_hdr_s fwhdr, *drv_fwhdr;

        /**
         * If bios/efi boot (flash based) -- return true
         */
        if (bfa_ioc_fwimg_get_size(ioc) < BFA_IOC_FWIMG_MINSZ)
                return BFA_TRUE;

        bfa_ioc_fwver_get(ioc, &fwhdr);
        drv_fwhdr =
                (struct bfi_ioc_image_hdr_s *)bfa_ioc_fwimg_get_chunk(ioc, 0);

        if (fwhdr.signature != drv_fwhdr->signature) {
                bfa_trc(ioc, fwhdr.signature);
                bfa_trc(ioc, drv_fwhdr->signature);
                return BFA_FALSE;
        }

        if (fwhdr.exec != drv_fwhdr->exec) {
                bfa_trc(ioc, fwhdr.exec);
                bfa_trc(ioc, drv_fwhdr->exec);
                return BFA_FALSE;
        }

        return bfa_ioc_fwver_cmp(ioc, &fwhdr);
}

/**
 * Conditionally flush any pending message from firmware at start.
 */
static void
bfa_ioc_msgflush(struct bfa_ioc_s *ioc)
{
        u32        r32;

        r32 = bfa_reg_read(ioc->ioc_regs.lpu_mbox_cmd);
        if (r32)
                bfa_reg_write(ioc->ioc_regs.lpu_mbox_cmd, 1);
}


static void
bfa_ioc_hwinit(struct bfa_ioc_s *ioc, bfa_boolean_t force)
{
        enum bfi_ioc_state ioc_fwstate;
        bfa_boolean_t   fwvalid;

        ioc_fwstate = bfa_reg_read(ioc->ioc_regs.ioc_fwstate);

        if (force)
                ioc_fwstate = BFI_IOC_UNINIT;

        bfa_trc(ioc, ioc_fwstate);

        /**
         * check if firmware is valid
         */
        fwvalid = (ioc_fwstate == BFI_IOC_UNINIT) ?
                        BFA_FALSE : bfa_ioc_fwver_valid(ioc);

        if (!fwvalid) {
                bfa_ioc_boot(ioc, BFI_BOOT_TYPE_NORMAL, ioc->pcidev.device_id);
                return;
        }

        /**
         * If hardware initialization is in progress (initialized by other IOC),
         * just wait for an initialization completion interrupt.
         */
        if (ioc_fwstate == BFI_IOC_INITING) {
                bfa_trc(ioc, ioc_fwstate);
                ioc->cbfn->reset_cbfn(ioc->bfa);
                return;
        }

        /**
         * If IOC function is disabled and firmware version is same,
         * just re-enable IOC.
         */
        if (ioc_fwstate == BFI_IOC_DISABLED || ioc_fwstate == BFI_IOC_OP) {
                bfa_trc(ioc, ioc_fwstate);

                /**
                 * When using MSI-X any pending firmware ready event should
                 * be flushed. Otherwise MSI-X interrupts are not delivered.
                 */
                bfa_ioc_msgflush(ioc);
                ioc->cbfn->reset_cbfn(ioc->bfa);
                bfa_fsm_send_event(ioc, IOC_E_FWREADY);
                return;
        }

        /**
         * Initialize the h/w for any other states.
         */
        bfa_ioc_boot(ioc, BFI_BOOT_TYPE_NORMAL, ioc->pcidev.device_id);
}

static void
bfa_ioc_timeout(void *ioc_arg)
{
        struct bfa_ioc_s *ioc = (struct bfa_ioc_s *)ioc_arg;

        bfa_trc(ioc, 0);
        bfa_fsm_send_event(ioc, IOC_E_TIMEOUT);
}

void
bfa_ioc_mbox_send(struct bfa_ioc_s *ioc, void *ioc_msg, int len)
{
        u32       *msgp = (u32 *) ioc_msg;
        u32        i;

        bfa_trc(ioc, msgp[0]);
        bfa_trc(ioc, len);

        bfa_assert(len <= BFI_IOC_MSGLEN_MAX);

        /*
         * first write msg to mailbox registers
         */
        for (i = 0; i < len / sizeof(u32); i++)
                bfa_reg_write(ioc->ioc_regs.hfn_mbox + i * sizeof(u32),
                              bfa_os_wtole(msgp[i]));

        for (; i < BFI_IOC_MSGLEN_MAX / sizeof(u32); i++)
                bfa_reg_write(ioc->ioc_regs.hfn_mbox + i * sizeof(u32), 0);

        /*
         * write 1 to mailbox CMD to trigger LPU event
         */
        bfa_reg_write(ioc->ioc_regs.hfn_mbox_cmd, 1);
        (void)bfa_reg_read(ioc->ioc_regs.hfn_mbox_cmd);
}

static void
bfa_ioc_send_enable(struct bfa_ioc_s *ioc)
{
        struct bfi_ioc_ctrl_req_s enable_req;

        bfi_h2i_set(enable_req.mh, BFI_MC_IOC, BFI_IOC_H2I_ENABLE_REQ,
                    bfa_ioc_portid(ioc));
        enable_req.ioc_class = ioc->ioc_mc;
        bfa_ioc_mbox_send(ioc, &enable_req, sizeof(struct bfi_ioc_ctrl_req_s));
}

static void
bfa_ioc_send_disable(struct bfa_ioc_s *ioc)
{
        struct bfi_ioc_ctrl_req_s disable_req;

        bfi_h2i_set(disable_req.mh, BFI_MC_IOC, BFI_IOC_H2I_DISABLE_REQ,
                    bfa_ioc_portid(ioc));
        bfa_ioc_mbox_send(ioc, &disable_req, sizeof(struct bfi_ioc_ctrl_req_s));
}

static void
bfa_ioc_send_getattr(struct bfa_ioc_s *ioc)
{
        struct bfi_ioc_getattr_req_s attr_req;

        bfi_h2i_set(attr_req.mh, BFI_MC_IOC, BFI_IOC_H2I_GETATTR_REQ,
                    bfa_ioc_portid(ioc));
        bfa_dma_be_addr_set(attr_req.attr_addr, ioc->attr_dma.pa);
        bfa_ioc_mbox_send(ioc, &attr_req, sizeof(attr_req));
}

static void
bfa_ioc_hb_check(void *cbarg)
{
        struct bfa_ioc_s  *ioc = cbarg;
        u32     hb_count;

        hb_count = bfa_reg_read(ioc->ioc_regs.heartbeat);
        if (ioc->hb_count == hb_count) {
                bfa_log(ioc->logm, BFA_LOG_HAL_HEARTBEAT_FAILURE,
                        hb_count);
                bfa_ioc_recover(ioc);
                return;
        } else {
                ioc->hb_count = hb_count;
        }

        bfa_ioc_mbox_poll(ioc);
        bfa_timer_begin(ioc->timer_mod, &ioc->ioc_timer, bfa_ioc_hb_check,
                        ioc, BFA_IOC_HB_TOV);
}

static void
bfa_ioc_hb_monitor(struct bfa_ioc_s *ioc)
{
        ioc->hb_count = bfa_reg_read(ioc->ioc_regs.heartbeat);
        bfa_timer_begin(ioc->timer_mod, &ioc->ioc_timer, bfa_ioc_hb_check, ioc,
                        BFA_IOC_HB_TOV);
}

static void
bfa_ioc_hb_stop(struct bfa_ioc_s *ioc)
{
        bfa_timer_stop(&ioc->ioc_timer);
}

/**
 *      Initiate a full firmware download.
 */
static void
bfa_ioc_download_fw(struct bfa_ioc_s *ioc, u32 boot_type,
                    u32 boot_param)
{
        u32       *fwimg;
        u32        pgnum, pgoff;
        u32        loff = 0;
        u32        chunkno = 0;
        u32        i;

        /**
         * Initialize LMEM first before code download
         */
        bfa_ioc_lmem_init(ioc);

        /**
         * Flash based firmware boot
         */
        bfa_trc(ioc, bfa_ioc_fwimg_get_size(ioc));
        if (bfa_ioc_fwimg_get_size(ioc) < BFA_IOC_FWIMG_MINSZ)
                boot_type = BFI_BOOT_TYPE_FLASH;
        fwimg = bfa_ioc_fwimg_get_chunk(ioc, chunkno);

        pgnum = bfa_ioc_smem_pgnum(ioc, loff);
        pgoff = bfa_ioc_smem_pgoff(ioc, loff);

        bfa_reg_write(ioc->ioc_regs.host_page_num_fn, pgnum);

        for (i = 0; i < bfa_ioc_fwimg_get_size(ioc); i++) {

                if (BFA_IOC_FLASH_CHUNK_NO(i) != chunkno) {
                        chunkno = BFA_IOC_FLASH_CHUNK_NO(i);
                        fwimg = bfa_ioc_fwimg_get_chunk(ioc,
                                        BFA_IOC_FLASH_CHUNK_ADDR(chunkno));
                }

                /**
                 * write smem
                 */
                bfa_mem_write(ioc->ioc_regs.smem_page_start, loff,
                              fwimg[BFA_IOC_FLASH_OFFSET_IN_CHUNK(i)]);

                loff += sizeof(u32);

                /**
                 * handle page offset wrap around
                 */
                loff = PSS_SMEM_PGOFF(loff);
                if (loff == 0) {
                        pgnum++;
                        bfa_reg_write(ioc->ioc_regs.host_page_num_fn, pgnum);
                }
        }

        bfa_reg_write(ioc->ioc_regs.host_page_num_fn,
                      bfa_ioc_smem_pgnum(ioc, 0));

        /*
         * Set boot type and boot param at the end.
         */
        bfa_mem_write(ioc->ioc_regs.smem_page_start, BFI_BOOT_TYPE_OFF,
                        bfa_os_swap32(boot_type));
        bfa_mem_write(ioc->ioc_regs.smem_page_start, BFI_BOOT_PARAM_OFF,
                        bfa_os_swap32(boot_param));
}

static void
bfa_ioc_reset(struct bfa_ioc_s *ioc, bfa_boolean_t force)
{
        bfa_ioc_hwinit(ioc, force);
}

/**
 * Update BFA configuration from firmware configuration.
 */
static void
bfa_ioc_getattr_reply(struct bfa_ioc_s *ioc)
{
        struct bfi_ioc_attr_s *attr = ioc->attr;

        attr->adapter_prop = bfa_os_ntohl(attr->adapter_prop);
        attr->maxfrsize = bfa_os_ntohs(attr->maxfrsize);

        bfa_fsm_send_event(ioc, IOC_E_FWRSP_GETATTR);
}

/**
 * Attach time initialization of mbox logic.
 */
static void
bfa_ioc_mbox_attach(struct bfa_ioc_s *ioc)
{
        struct bfa_ioc_mbox_mod_s *mod = &ioc->mbox_mod;
        int             mc;

        INIT_LIST_HEAD(&mod->cmd_q);
        for (mc = 0; mc < BFI_MC_MAX; mc++) {
                mod->mbhdlr[mc].cbfn = NULL;
                mod->mbhdlr[mc].cbarg = ioc->bfa;
        }
}

/**
 * Mbox poll timer -- restarts any pending mailbox requests.
 */
static void
bfa_ioc_mbox_poll(struct bfa_ioc_s *ioc)
{
        struct bfa_ioc_mbox_mod_s *mod = &ioc->mbox_mod;
        struct bfa_mbox_cmd_s *cmd;
        u32        stat;

        /**
         * If no command pending, do nothing
         */
        if (list_empty(&mod->cmd_q))
                return;

        /**
         * If previous command is not yet fetched by firmware, do nothing
         */
        stat = bfa_reg_read(ioc->ioc_regs.hfn_mbox_cmd);
        if (stat)
                return;

        /**
         * Enqueue command to firmware.
         */
        bfa_q_deq(&mod->cmd_q, &cmd);
        bfa_ioc_mbox_send(ioc, cmd->msg, sizeof(cmd->msg));
}

/**
 * Cleanup any pending requests.
 */
static void
bfa_ioc_mbox_hbfail(struct bfa_ioc_s *ioc)
{
        struct bfa_ioc_mbox_mod_s *mod = &ioc->mbox_mod;
        struct bfa_mbox_cmd_s *cmd;

        while (!list_empty(&mod->cmd_q))
                bfa_q_deq(&mod->cmd_q, &cmd);
}

/**
 *  bfa_ioc_public
 */

/**
 * Interface used by diag module to do firmware boot with memory test
 * as the entry vector.
 */
void
bfa_ioc_boot(struct bfa_ioc_s *ioc, u32 boot_type, u32 boot_param)
{
        bfa_os_addr_t   rb;

        bfa_ioc_stats(ioc, ioc_boots);

        if (bfa_ioc_pll_init(ioc) != BFA_STATUS_OK)
                return;

        /**
         * Initialize IOC state of all functions on a chip reset.
         */
        rb = ioc->pcidev.pci_bar_kva;
        if (boot_param == BFI_BOOT_TYPE_MEMTEST) {
                bfa_reg_write((rb + BFA_IOC0_STATE_REG), BFI_IOC_MEMTEST);
                bfa_reg_write((rb + BFA_IOC1_STATE_REG), BFI_IOC_MEMTEST);
        } else {
                bfa_reg_write((rb + BFA_IOC0_STATE_REG), BFI_IOC_INITING);
                bfa_reg_write((rb + BFA_IOC1_STATE_REG), BFI_IOC_INITING);
        }

        bfa_ioc_download_fw(ioc, boot_type, boot_param);

        /**
         * Enable interrupts just before starting LPU
         */
        ioc->cbfn->reset_cbfn(ioc->bfa);
        bfa_ioc_lpu_start(ioc);
}

/**
 * Enable/disable IOC failure auto recovery.
 */
void
bfa_ioc_auto_recover(bfa_boolean_t auto_recover)
{
        bfa_auto_recover = auto_recover;
}


bfa_boolean_t
bfa_ioc_is_operational(struct bfa_ioc_s *ioc)
{
        return bfa_fsm_cmp_state(ioc, bfa_ioc_sm_op);
}

void
bfa_ioc_msgget(struct bfa_ioc_s *ioc, void *mbmsg)
{
        u32       *msgp = mbmsg;
        u32        r32;
        int             i;

        /**
         * read the MBOX msg
         */
        for (i = 0; i < (sizeof(union bfi_ioc_i2h_msg_u) / sizeof(u32));
             i++) {
                r32 = bfa_reg_read(ioc->ioc_regs.lpu_mbox +
                                   i * sizeof(u32));
                msgp[i] = bfa_os_htonl(r32);
        }

        /**
         * turn off mailbox interrupt by clearing mailbox status
         */
        bfa_reg_write(ioc->ioc_regs.lpu_mbox_cmd, 1);
        bfa_reg_read(ioc->ioc_regs.lpu_mbox_cmd);
}

void
bfa_ioc_isr(struct bfa_ioc_s *ioc, struct bfi_mbmsg_s *m)
{
        union bfi_ioc_i2h_msg_u *msg;

        msg = (union bfi_ioc_i2h_msg_u *)m;

        bfa_ioc_stats(ioc, ioc_isrs);

        switch (msg->mh.msg_id) {
        case BFI_IOC_I2H_HBEAT:
                break;

        case BFI_IOC_I2H_READY_EVENT:
                bfa_fsm_send_event(ioc, IOC_E_FWREADY);
                break;

        case BFI_IOC_I2H_ENABLE_REPLY:
                bfa_fsm_send_event(ioc, IOC_E_FWRSP_ENABLE);
                break;

        case BFI_IOC_I2H_DISABLE_REPLY:
                bfa_fsm_send_event(ioc, IOC_E_FWRSP_DISABLE);
                break;

        case BFI_IOC_I2H_GETATTR_REPLY:
                bfa_ioc_getattr_reply(ioc);
                break;

        default:
                bfa_trc(ioc, msg->mh.msg_id);
                bfa_assert(0);
        }
}

/**
 * IOC attach time initialization and setup.
 *
 * @param[in]   ioc     memory for IOC
 * @param[in]   bfa     driver instance structure
 * @param[in]   trcmod  kernel trace module
 * @param[in]   aen     kernel aen event module
 * @param[in]   logm    kernel logging module
 */
void
bfa_ioc_attach(struct bfa_ioc_s *ioc, void *bfa, struct bfa_ioc_cbfn_s *cbfn,
               struct bfa_timer_mod_s *timer_mod, struct bfa_trc_mod_s *trcmod,
               struct bfa_aen_s *aen, struct bfa_log_mod_s *logm)
{
        ioc->bfa = bfa;
        ioc->cbfn = cbfn;
        ioc->timer_mod = timer_mod;
        ioc->trcmod = trcmod;
        ioc->aen = aen;
        ioc->logm = logm;
        ioc->fcmode = BFA_FALSE;
        ioc->pllinit = BFA_FALSE;
        ioc->dbg_fwsave_once = BFA_TRUE;

        bfa_ioc_mbox_attach(ioc);
        INIT_LIST_HEAD(&ioc->hb_notify_q);

        bfa_fsm_set_state(ioc, bfa_ioc_sm_reset);
}

/**
 * Driver detach time IOC cleanup.
 */
void
bfa_ioc_detach(struct bfa_ioc_s *ioc)
{
        bfa_fsm_send_event(ioc, IOC_E_DETACH);
}

/**
 * Setup IOC PCI properties.
 *
 * @param[in]   pcidev  PCI device information for this IOC
 */
void
bfa_ioc_pci_init(struct bfa_ioc_s *ioc, struct bfa_pcidev_s *pcidev,
                 enum bfi_mclass mc)
{
        ioc->ioc_mc = mc;
        ioc->pcidev = *pcidev;
        ioc->ctdev = (ioc->pcidev.device_id == BFA_PCI_DEVICE_ID_CT);
        ioc->cna = ioc->ctdev && !ioc->fcmode;

        /**
         * Set asic specific interfaces. See bfa_ioc_cb.c and bfa_ioc_ct.c
         */
        if (ioc->ctdev)
                bfa_ioc_set_ct_hwif(ioc);
        else
                bfa_ioc_set_cb_hwif(ioc);

        bfa_ioc_map_port(ioc);
        bfa_ioc_reg_init(ioc);
}

/**
 * Initialize IOC dma memory
 *
 * @param[in]   dm_kva  kernel virtual address of IOC dma memory
 * @param[in]   dm_pa   physical address of IOC dma memory
 */
void
bfa_ioc_mem_claim(struct bfa_ioc_s *ioc, u8 *dm_kva, u64 dm_pa)
{
        /**
         * dma memory for firmware attribute
         */
        ioc->attr_dma.kva = dm_kva;
        ioc->attr_dma.pa = dm_pa;
        ioc->attr = (struct bfi_ioc_attr_s *)dm_kva;
}

/**
 * Return size of dma memory required.
 */
u32
bfa_ioc_meminfo(void)
{
        return BFA_ROUNDUP(sizeof(struct bfi_ioc_attr_s), BFA_DMA_ALIGN_SZ);
}

void
bfa_ioc_enable(struct bfa_ioc_s *ioc)
{
        bfa_ioc_stats(ioc, ioc_enables);
        ioc->dbg_fwsave_once = BFA_TRUE;

        bfa_fsm_send_event(ioc, IOC_E_ENABLE);
}

void
bfa_ioc_disable(struct bfa_ioc_s *ioc)
{
        bfa_ioc_stats(ioc, ioc_disables);
        bfa_fsm_send_event(ioc, IOC_E_DISABLE);
}

/**
 * Returns memory required for saving firmware trace in case of crash.
 * Driver must call this interface to allocate memory required for
 * automatic saving of firmware trace. Driver should call
 * bfa_ioc_debug_memclaim() right after bfa_ioc_attach() to setup this
 * trace memory.
 */
int
bfa_ioc_debug_trcsz(bfa_boolean_t auto_recover)
{
return (auto_recover) ? BFA_DBG_FWTRC_LEN : 0;
}

/**
 * Initialize memory for saving firmware trace. Driver must initialize
 * trace memory before call bfa_ioc_enable().
 */
void
bfa_ioc_debug_memclaim(struct bfa_ioc_s *ioc, void *dbg_fwsave)
{
        ioc->dbg_fwsave = dbg_fwsave;
        ioc->dbg_fwsave_len = bfa_ioc_debug_trcsz(ioc->auto_recover);
}

u32
bfa_ioc_smem_pgnum(struct bfa_ioc_s *ioc, u32 fmaddr)
{
        return PSS_SMEM_PGNUM(ioc->ioc_regs.smem_pg0, fmaddr);
}

u32
bfa_ioc_smem_pgoff(struct bfa_ioc_s *ioc, u32 fmaddr)
{
        return PSS_SMEM_PGOFF(fmaddr);
}

/**
 * Register mailbox message handler functions
 *
 * @param[in]   ioc             IOC instance
 * @param[in]   mcfuncs         message class handler functions
 */
void
bfa_ioc_mbox_register(struct bfa_ioc_s *ioc, bfa_ioc_mbox_mcfunc_t *mcfuncs)
{
        struct bfa_ioc_mbox_mod_s *mod = &ioc->mbox_mod;
        int             mc;

        for (mc = 0; mc < BFI_MC_MAX; mc++)
                mod->mbhdlr[mc].cbfn = mcfuncs[mc];
}

/**
 * Register mailbox message handler function, to be called by common modules
 */
void
bfa_ioc_mbox_regisr(struct bfa_ioc_s *ioc, enum bfi_mclass mc,
                    bfa_ioc_mbox_mcfunc_t cbfn, void *cbarg)
{
        struct bfa_ioc_mbox_mod_s *mod = &ioc->mbox_mod;

        mod->mbhdlr[mc].cbfn = cbfn;
        mod->mbhdlr[mc].cbarg = cbarg;
}

/**
 * Queue a mailbox command request to firmware. Waits if mailbox is busy.
 * Responsibility of caller to serialize
 *
 * @param[in]   ioc     IOC instance
 * @param[i]    cmd     Mailbox command
 */
void
bfa_ioc_mbox_queue(struct bfa_ioc_s *ioc, struct bfa_mbox_cmd_s *cmd)
{
        struct bfa_ioc_mbox_mod_s *mod = &ioc->mbox_mod;
        u32        stat;

        /**
         * If a previous command is pending, queue new command
         */
        if (!list_empty(&mod->cmd_q)) {
                list_add_tail(&cmd->qe, &mod->cmd_q);
                return;
        }

        /**
         * If mailbox is busy, queue command for poll timer
         */
        stat = bfa_reg_read(ioc->ioc_regs.hfn_mbox_cmd);
        if (stat) {
                list_add_tail(&cmd->qe, &mod->cmd_q);
                return;
        }

        /**
         * mailbox is free -- queue command to firmware
         */
        bfa_ioc_mbox_send(ioc, cmd->msg, sizeof(cmd->msg));
}

/**
 * Handle mailbox interrupts
 */
void
bfa_ioc_mbox_isr(struct bfa_ioc_s *ioc)
{
        struct bfa_ioc_mbox_mod_s *mod = &ioc->mbox_mod;
        struct bfi_mbmsg_s m;
        int             mc;

        bfa_ioc_msgget(ioc, &m);

        /**
         * Treat IOC message class as special.
         */
        mc = m.mh.msg_class;
        if (mc == BFI_MC_IOC) {
                bfa_ioc_isr(ioc, &m);
                return;
        }

        if ((mc > BFI_MC_MAX) || (mod->mbhdlr[mc].cbfn == NULL))
                return;

        mod->mbhdlr[mc].cbfn(mod->mbhdlr[mc].cbarg, &m);
}

void
bfa_ioc_error_isr(struct bfa_ioc_s *ioc)
{
        bfa_fsm_send_event(ioc, IOC_E_HWERROR);
}

#ifndef BFA_BIOS_BUILD

/**
 * return true if IOC is disabled
 */
bfa_boolean_t
bfa_ioc_is_disabled(struct bfa_ioc_s *ioc)
{
        return bfa_fsm_cmp_state(ioc, bfa_ioc_sm_disabling)
                || bfa_fsm_cmp_state(ioc, bfa_ioc_sm_disabled);
}

/**
 * return true if IOC firmware is different.
 */
bfa_boolean_t
bfa_ioc_fw_mismatch(struct bfa_ioc_s *ioc)
{
        return bfa_fsm_cmp_state(ioc, bfa_ioc_sm_reset)
                || bfa_fsm_cmp_state(ioc, bfa_ioc_sm_fwcheck)
                || bfa_fsm_cmp_state(ioc, bfa_ioc_sm_mismatch);
}

#define bfa_ioc_state_disabled(__sm)            \
        (((__sm) == BFI_IOC_UNINIT) ||          \
         ((__sm) == BFI_IOC_INITING) ||         \
         ((__sm) == BFI_IOC_HWINIT) ||          \
         ((__sm) == BFI_IOC_DISABLED) ||        \
         ((__sm) == BFI_IOC_FAIL) ||            \
         ((__sm) == BFI_IOC_CFG_DISABLED))

/**
 * Check if adapter is disabled -- both IOCs should be in a disabled
 * state.
 */
bfa_boolean_t
bfa_ioc_adapter_is_disabled(struct bfa_ioc_s *ioc)
{
        u32        ioc_state;
        bfa_os_addr_t   rb = ioc->pcidev.pci_bar_kva;

        if (!bfa_fsm_cmp_state(ioc, bfa_ioc_sm_disabled))
                return BFA_FALSE;

        ioc_state = bfa_reg_read(rb + BFA_IOC0_STATE_REG);
        if (!bfa_ioc_state_disabled(ioc_state))
                return BFA_FALSE;

        ioc_state = bfa_reg_read(rb + BFA_IOC1_STATE_REG);
        if (!bfa_ioc_state_disabled(ioc_state))
                return BFA_FALSE;

        return BFA_TRUE;
}

/**
 * Add to IOC heartbeat failure notification queue. To be used by common
 * modules such as
 */
void
bfa_ioc_hbfail_register(struct bfa_ioc_s *ioc,
                        struct bfa_ioc_hbfail_notify_s *notify)
{
        list_add_tail(&notify->qe, &ioc->hb_notify_q);
}

#define BFA_MFG_NAME "Brocade"
void
bfa_ioc_get_adapter_attr(struct bfa_ioc_s *ioc,
                         struct bfa_adapter_attr_s *ad_attr)
{
        struct bfi_ioc_attr_s *ioc_attr;

        ioc_attr = ioc->attr;

        bfa_ioc_get_adapter_serial_num(ioc, ad_attr->serial_num);
        bfa_ioc_get_adapter_fw_ver(ioc, ad_attr->fw_ver);
        bfa_ioc_get_adapter_optrom_ver(ioc, ad_attr->optrom_ver);
        bfa_ioc_get_adapter_manufacturer(ioc, ad_attr->manufacturer);
        bfa_os_memcpy(&ad_attr->vpd, &ioc_attr->vpd,
                      sizeof(struct bfa_mfg_vpd_s));

        ad_attr->nports = bfa_ioc_get_nports(ioc);
        ad_attr->max_speed = bfa_ioc_speed_sup(ioc);

        bfa_ioc_get_adapter_model(ioc, ad_attr->model);
        /* For now, model descr uses same model string */
        bfa_ioc_get_adapter_model(ioc, ad_attr->model_descr);

        if (BFI_ADAPTER_IS_SPECIAL(ioc_attr->adapter_prop))
                ad_attr->prototype = 1;
        else
                ad_attr->prototype = 0;

        ad_attr->pwwn = bfa_ioc_get_pwwn(ioc);
        ad_attr->mac = bfa_ioc_get_mac(ioc);

        ad_attr->pcie_gen = ioc_attr->pcie_gen;
        ad_attr->pcie_lanes = ioc_attr->pcie_lanes;
        ad_attr->pcie_lanes_orig = ioc_attr->pcie_lanes_orig;
        ad_attr->asic_rev = ioc_attr->asic_rev;

        bfa_ioc_get_pci_chip_rev(ioc, ad_attr->hw_ver);

        ad_attr->cna_capable = ioc->cna;
}

enum bfa_ioc_type_e
bfa_ioc_get_type(struct bfa_ioc_s *ioc)
{
        if (!ioc->ctdev || ioc->fcmode)
                return BFA_IOC_TYPE_FC;
        else if (ioc->ioc_mc == BFI_MC_IOCFC)
                return BFA_IOC_TYPE_FCoE;
        else if (ioc->ioc_mc == BFI_MC_LL)
                return BFA_IOC_TYPE_LL;
        else {
                bfa_assert(ioc->ioc_mc == BFI_MC_LL);
                return BFA_IOC_TYPE_LL;
        }
}

void
bfa_ioc_get_adapter_serial_num(struct bfa_ioc_s *ioc, char *serial_num)
{
        bfa_os_memset((void *)serial_num, 0, BFA_ADAPTER_SERIAL_NUM_LEN);
        bfa_os_memcpy((void *)serial_num,
                        (void *)ioc->attr->brcd_serialnum,
                        BFA_ADAPTER_SERIAL_NUM_LEN);
}

void
bfa_ioc_get_adapter_fw_ver(struct bfa_ioc_s *ioc, char *fw_ver)
{
        bfa_os_memset((void *)fw_ver, 0, BFA_VERSION_LEN);
        bfa_os_memcpy(fw_ver, ioc->attr->fw_version, BFA_VERSION_LEN);
}

void
bfa_ioc_get_pci_chip_rev(struct bfa_ioc_s *ioc, char *chip_rev)
{
        bfa_assert(chip_rev);

        bfa_os_memset((void *)chip_rev, 0, BFA_IOC_CHIP_REV_LEN);

        chip_rev[0] = 'R';
        chip_rev[1] = 'e';
        chip_rev[2] = 'v';
        chip_rev[3] = '-';
        chip_rev[4] = ioc->attr->asic_rev;
        chip_rev[5] = '\0';
}

void
bfa_ioc_get_adapter_optrom_ver(struct bfa_ioc_s *ioc, char *optrom_ver)
{
        bfa_os_memset((void *)optrom_ver, 0, BFA_VERSION_LEN);
        bfa_os_memcpy(optrom_ver, ioc->attr->optrom_version,
                BFA_VERSION_LEN);
}

void
bfa_ioc_get_adapter_manufacturer(struct bfa_ioc_s *ioc, char *manufacturer)
{
        bfa_os_memset((void *)manufacturer, 0, BFA_ADAPTER_MFG_NAME_LEN);
        bfa_os_memcpy(manufacturer, BFA_MFG_NAME, BFA_ADAPTER_MFG_NAME_LEN);
}

void
bfa_ioc_get_adapter_model(struct bfa_ioc_s *ioc, char *model)
{
        struct bfi_ioc_attr_s   *ioc_attr;
        u8              nports;
        u8              max_speed;

        bfa_assert(model);
        bfa_os_memset((void *)model, 0, BFA_ADAPTER_MODEL_NAME_LEN);

        ioc_attr = ioc->attr;

        nports = bfa_ioc_get_nports(ioc);
        max_speed = bfa_ioc_speed_sup(ioc);

        /**
         * model name
         */
        if (max_speed == 10) {
                strcpy(model, "BR-10?0");
                model[5] = '0' + nports;
        } else {
                strcpy(model, "Brocade-??5");
                model[8] = '0' + max_speed;
                model[9] = '0' + nports;
        }
}

enum bfa_ioc_state
bfa_ioc_get_state(struct bfa_ioc_s *ioc)
{
        return bfa_sm_to_state(ioc_sm_table, ioc->fsm);
}

void
bfa_ioc_get_attr(struct bfa_ioc_s *ioc, struct bfa_ioc_attr_s *ioc_attr)
{
        bfa_os_memset((void *)ioc_attr, 0, sizeof(struct bfa_ioc_attr_s));

        ioc_attr->state = bfa_ioc_get_state(ioc);
        ioc_attr->port_id = ioc->port_id;

        ioc_attr->ioc_type = bfa_ioc_get_type(ioc);

        bfa_ioc_get_adapter_attr(ioc, &ioc_attr->adapter_attr);

        ioc_attr->pci_attr.device_id = ioc->pcidev.device_id;
        ioc_attr->pci_attr.pcifn = ioc->pcidev.pci_func;
        bfa_ioc_get_pci_chip_rev(ioc, ioc_attr->pci_attr.chip_rev);
}

/**
 *  hal_wwn_public
 */
wwn_t
bfa_ioc_get_pwwn(struct bfa_ioc_s *ioc)
{
        union {
                wwn_t           wwn;
                u8         byte[sizeof(wwn_t)];
        }
        w;

        w.wwn = ioc->attr->mfg_wwn;

        if (bfa_ioc_portid(ioc) == 1)
                w.byte[7]++;

        return w.wwn;
}

wwn_t
bfa_ioc_get_nwwn(struct bfa_ioc_s *ioc)
{
        union {
                wwn_t           wwn;
                u8         byte[sizeof(wwn_t)];
        }
        w;

        w.wwn = ioc->attr->mfg_wwn;

        if (bfa_ioc_portid(ioc) == 1)
                w.byte[7]++;

        w.byte[0] = 0x20;

        return w.wwn;
}

wwn_t
bfa_ioc_get_wwn_naa5(struct bfa_ioc_s *ioc, u16 inst)
{
        union {
                wwn_t           wwn;
                u8         byte[sizeof(wwn_t)];
        }
        w              , w5;

        bfa_trc(ioc, inst);

        w.wwn = ioc->attr->mfg_wwn;
        w5.byte[0] = 0x50 | w.byte[2] >> 4;
        w5.byte[1] = w.byte[2] << 4 | w.byte[3] >> 4;
        w5.byte[2] = w.byte[3] << 4 | w.byte[4] >> 4;
        w5.byte[3] = w.byte[4] << 4 | w.byte[5] >> 4;
        w5.byte[4] = w.byte[5] << 4 | w.byte[6] >> 4;
        w5.byte[5] = w.byte[6] << 4 | w.byte[7] >> 4;
        w5.byte[6] = w.byte[7] << 4 | (inst & 0x0f00) >> 8;
        w5.byte[7] = (inst & 0xff);

        return w5.wwn;
}

u64
bfa_ioc_get_adid(struct bfa_ioc_s *ioc)
{
        return ioc->attr->mfg_wwn;
}

mac_t
bfa_ioc_get_mac(struct bfa_ioc_s *ioc)
{
        mac_t           mac;

        mac = ioc->attr->mfg_mac;
        mac.mac[MAC_ADDRLEN - 1] += bfa_ioc_pcifn(ioc);

        return mac;
}

void
bfa_ioc_set_fcmode(struct bfa_ioc_s *ioc)
{
        ioc->fcmode = BFA_TRUE;
        ioc->port_id = bfa_ioc_pcifn(ioc);
}

bfa_boolean_t
bfa_ioc_get_fcmode(struct bfa_ioc_s *ioc)
{
        return ioc->fcmode || (ioc->pcidev.device_id != BFA_PCI_DEVICE_ID_CT);
}

/**
 * Send AEN notification
 */
static void
bfa_ioc_aen_post(struct bfa_ioc_s *ioc, enum bfa_ioc_aen_event event)
{
        union bfa_aen_data_u aen_data;
        struct bfa_log_mod_s *logmod = ioc->logm;
        s32         inst_num = 0;
        enum bfa_ioc_type_e ioc_type;

        bfa_log(logmod, BFA_LOG_CREATE_ID(BFA_AEN_CAT_IOC, event), inst_num);

        memset(&aen_data.ioc.pwwn, 0, sizeof(aen_data.ioc.pwwn));
        memset(&aen_data.ioc.mac, 0, sizeof(aen_data.ioc.mac));
        ioc_type = bfa_ioc_get_type(ioc);
        switch (ioc_type) {
        case BFA_IOC_TYPE_FC:
                aen_data.ioc.pwwn = bfa_ioc_get_pwwn(ioc);
                break;
        case BFA_IOC_TYPE_FCoE:
                aen_data.ioc.pwwn = bfa_ioc_get_pwwn(ioc);
                aen_data.ioc.mac = bfa_ioc_get_mac(ioc);
                break;
        case BFA_IOC_TYPE_LL:
                aen_data.ioc.mac = bfa_ioc_get_mac(ioc);
                break;
        default:
                bfa_assert(ioc_type == BFA_IOC_TYPE_FC);
                break;
        }
        aen_data.ioc.ioc_type = ioc_type;
}

/**
 * Retrieve saved firmware trace from a prior IOC failure.
 */
bfa_status_t
bfa_ioc_debug_fwsave(struct bfa_ioc_s *ioc, void *trcdata, int *trclen)
{
        int             tlen;

        if (ioc->dbg_fwsave_len == 0)
                return BFA_STATUS_ENOFSAVE;

        tlen = *trclen;
        if (tlen > ioc->dbg_fwsave_len)
                tlen = ioc->dbg_fwsave_len;

        bfa_os_memcpy(trcdata, ioc->dbg_fwsave, tlen);
        *trclen = tlen;
        return BFA_STATUS_OK;
}

/**
 * Clear saved firmware trace
 */
void
bfa_ioc_debug_fwsave_clear(struct bfa_ioc_s *ioc)
{
        ioc->dbg_fwsave_once = BFA_TRUE;
}

/**
 * Retrieve saved firmware trace from a prior IOC failure.
 */
bfa_status_t
bfa_ioc_debug_fwtrc(struct bfa_ioc_s *ioc, void *trcdata, int *trclen)
{
        u32        pgnum;
        u32        loff = BFA_DBG_FWTRC_OFF(bfa_ioc_portid(ioc));
        int             i, tlen;
        u32       *tbuf = trcdata, r32;

        bfa_trc(ioc, *trclen);

        pgnum = bfa_ioc_smem_pgnum(ioc, loff);
        loff = bfa_ioc_smem_pgoff(ioc, loff);

        /*
         *  Hold semaphore to serialize pll init and fwtrc.
         */
        if (BFA_FALSE == bfa_ioc_sem_get(ioc->ioc_regs.ioc_init_sem_reg))
                return BFA_STATUS_FAILED;

        bfa_reg_write(ioc->ioc_regs.host_page_num_fn, pgnum);

        tlen = *trclen;
        if (tlen > BFA_DBG_FWTRC_LEN)
                tlen = BFA_DBG_FWTRC_LEN;
        tlen /= sizeof(u32);

        bfa_trc(ioc, tlen);

        for (i = 0; i < tlen; i++) {
                r32 = bfa_mem_read(ioc->ioc_regs.smem_page_start, loff);
                tbuf[i] = bfa_os_ntohl(r32);
                loff += sizeof(u32);

                /**
                 * handle page offset wrap around
                 */
                loff = PSS_SMEM_PGOFF(loff);
                if (loff == 0) {
                        pgnum++;
                        bfa_reg_write(ioc->ioc_regs.host_page_num_fn, pgnum);
                }
        }
        bfa_reg_write(ioc->ioc_regs.host_page_num_fn,
                      bfa_ioc_smem_pgnum(ioc, 0));

        /*
         *  release semaphore.
         */
        bfa_ioc_sem_release(ioc->ioc_regs.ioc_init_sem_reg);

        bfa_trc(ioc, pgnum);

        *trclen = tlen * sizeof(u32);
        return BFA_STATUS_OK;
}

/**
 * Save firmware trace if configured.
 */
static void
bfa_ioc_debug_save(struct bfa_ioc_s *ioc)
{
        int             tlen;

        if (ioc->dbg_fwsave_len) {
                tlen = ioc->dbg_fwsave_len;
                bfa_ioc_debug_fwtrc(ioc, ioc->dbg_fwsave, &tlen);
        }
}

/**
 * Firmware failure detected. Start recovery actions.
 */
static void
bfa_ioc_recover(struct bfa_ioc_s *ioc)
{
        if (ioc->dbg_fwsave_once) {
                ioc->dbg_fwsave_once = BFA_FALSE;
                bfa_ioc_debug_save(ioc);
        }

        bfa_ioc_stats(ioc, ioc_hbfails);
        bfa_fsm_send_event(ioc, IOC_E_HBFAIL);
}

#else

static void
bfa_ioc_aen_post(struct bfa_ioc_s *ioc, enum bfa_ioc_aen_event event)
{
}

static void
bfa_ioc_recover(struct bfa_ioc_s *ioc)
{
        bfa_assert(0);
}

#endif