ocs_gendump.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2015, Emulex
 * All rights reserved.
 *
 * 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.
 *
 */

#if !defined(__OCS_GENDUMP_H__)
#define __OCS_GENDUMP_H__

extern int ocs_gen_dump(ocs_t *ocs);
extern void ocs_fw_dump_init(ocs_t *ocs, int32_t fw_dump_type);
extern void ocs_fw_dump_state_set(ocs_t *ocs, uint32_t state);
extern int32_t ocs_fw_dump_state_check(ocs_t *ocs, uint32_t state);
extern int32_t ocs_adapter_reset(ocs_t *ocs);
extern int32_t ocs_port_reset(ocs_t *ocs);
extern int32_t ocs_fw_reset(ocs_t *ocs);
extern int32_t ocs_trigger_dump(ocs_t *ocs, uint8_t dump_level);

#define OCS_MAX_HBA_PORTS           4

/* FW dump status */
#define OCS_FW_DUMP_STATUS_SUCCESS      0
#define OCS_FW_DUMP_STATUS_IN_PROGRESS      1
#define OCS_FW_DUMP_STATUS_SKIP         2
#define OCS_FW_DUMP_STATUS_FAILED       -1

/* FW dump level flags */
#define FW_DUMP_LEVEL_NONE          0
#define FW_CHIP_LEVEL_DUMP          1
#define FW_FUNC_DESC_DUMP           2

/* FW dump state flags; should maintain 1:1 mapping with FW dump level flags */
#define FW_DUMP_STATE_NONE          0
#define FW_CHIP_DUMP_STATE_VALID        1
#define FW_FUNC_DUMP_STATE_VALID        2

/* FW dump type flags */
#define FW_DUMP_TYPE_DUMPTOHOST         1
#define FW_DUMP_TYPE_FLASH          2

/* FW dump ready status flags */
#define FW_DUMP_READY_STATUS_NOT_READY      0
#define FW_DUMP_READY_STATUS_DD_PRESENT     1
#define FW_DUMP_READY_STATUS_FDB_PRESENT    2
#define FW_DUMP_READY_STATUS_SKIP_DUMP      3
#define FW_DUMP_READY_STATUS_FAILED     -1

struct ocs_fw_dump {
    uint8_t *saved_buff;
    uint32_t size;
    int32_t type;

    uint32_t num_chip_dump_buffers;
    uint32_t num_func_dump_buffers;
    ocs_dma_t *chip_dump_buffers;
    ocs_dma_t *func_dump_buffers;

    /* lock is used around state */
    ocs_lock_t lock;
    uint32_t state;
};

#endif // __OCS_GENDUMP_H__