/*
 * Copyright (c) 2013 Mellanox Technologies Ltd.  All rights reserved.
 * Copyright (c) 2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * OpenIB.org BSD license below:
 *
 *     Redistribution and use in source and binary forms, with or
 *     without modification, are permitted provided that the following
 *     conditions are met:
 *
 *      - Redistributions of source code must retain the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer.
 *
 *      - 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.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 */

#ifndef RESOURCE_DUMP_SEGMENT_BE_H
#define RESOURCE_DUMP_SEGMENT_BE_H

#include <stdint.h>

#ifdef __cplusplus
namespace mft
{
namespace resource_dump
{
#endif

#ifdef __cplusplus
enum struct SegmentType : uint16_t
#else
enum SegmentType
#endif
{
    notice = 0xfff9,
    command,
    terminate,
    error,
    reference,
    info,
    menu
};

typedef struct resource_dump_segment_header
{
    uint16_t length_dw;
    uint16_t segment_type;
} resource_dump_segment_header_t;

typedef struct segment_params_data
{
    uint32_t index1;
    uint32_t index2;
    uint16_t num_of_obj1;
    uint16_t num_of_obj2;
} segment_params_data_t;

typedef struct resource_segment_sub_header
{
    uint32_t reserved;
    uint32_t index1;
    uint32_t index2;
} resource_segment_sub_header_t;

typedef struct notice_segment_data
{
    uint16_t reserved0;
    uint16_t syndrome_id;
    uint32_t reserved1;
    uint32_t reserved2;
    char notice[32];
} notice_segment_data_t;

typedef struct command_segment_data
{
    uint16_t segment_called;
    uint16_t vhca_id;
    segment_params_data_t segment_params;
} command_segment_data_t;

typedef notice_segment_data_t error_segment_data;

struct reference_segment_data
{
    uint16_t reserved;
    uint16_t reference_segment_type;
    segment_params_data_t segment_params;
};

typedef struct info_segment_data
{
    uint8_t reserved[3];
    uint8_t dump_version;
    uint32_t hw_version;
    uint32_t fw_version;
} info_segment_data_t;

typedef struct menu_segment_sub_header
{
    uint16_t reserved;
    uint16_t num_of_records;
} menu_segment_sub_header_t;

typedef struct menu_record_data
{
    uint16_t reserved : 3;
    uint16_t event_supported : 1;
    uint16_t num_of_obj2_supports_active : 1;
    uint16_t num_of_obj2_supports_all : 1;
    uint16_t must_have_num_of_obj2 : 1;
    uint16_t support_num_of_obj2 : 1;
    uint16_t num_of_obj1_supports_active : 1;
    uint16_t num_of_obj1_supports_all : 1;
    uint16_t must_have_num_of_obj1 : 1;
    uint16_t support_num_of_obj1 : 1;
    uint16_t must_have_index2 : 1;
    uint16_t support_index2 : 1;
    uint16_t must_have_index1 : 1;
    uint16_t support_index1 : 1;

    uint16_t segment_type;

    char segment_name[16];
    char index1_name[16];
    char index2_name[16];
} menu_record_data_t;

#ifdef __cplusplus
} // namespace resource_dump
} // namespace mft
#endif

#endif // RESOURCE_DUMP_SEGMENT_BE_H
