/* SPDX-License-Identifier: GPL-2.0 or BSD-3-Clause */
/*
 * Copyright(c) 2015, 2016 Intel Corporation.
 */

#ifndef __PLATFORM_H
#define __PLATFORM_H

#define METADATA_TABLE_FIELD_START_SHIFT                0
#define METADATA_TABLE_FIELD_START_LEN_BITS             15
#define METADATA_TABLE_FIELD_LEN_SHIFT                  16
#define METADATA_TABLE_FIELD_LEN_LEN_BITS               16

/* Header structure */
#define PLATFORM_CONFIG_HEADER_RECORD_IDX_SHIFT                 0
#define PLATFORM_CONFIG_HEADER_RECORD_IDX_LEN_BITS              6
#define PLATFORM_CONFIG_HEADER_TABLE_LENGTH_SHIFT               16
#define PLATFORM_CONFIG_HEADER_TABLE_LENGTH_LEN_BITS            12
#define PLATFORM_CONFIG_HEADER_TABLE_TYPE_SHIFT                 28
#define PLATFORM_CONFIG_HEADER_TABLE_TYPE_LEN_BITS              4

enum platform_config_table_type_encoding {
        PLATFORM_CONFIG_TABLE_RESERVED,
        PLATFORM_CONFIG_SYSTEM_TABLE,
        PLATFORM_CONFIG_PORT_TABLE,
        PLATFORM_CONFIG_RX_PRESET_TABLE,
        PLATFORM_CONFIG_TX_PRESET_TABLE,
        PLATFORM_CONFIG_QSFP_ATTEN_TABLE,
        PLATFORM_CONFIG_VARIABLE_SETTINGS_TABLE,
        PLATFORM_CONFIG_TABLE_MAX
};

enum platform_config_system_table_fields {
        SYSTEM_TABLE_RESERVED,
        SYSTEM_TABLE_NODE_STRING,
        SYSTEM_TABLE_SYSTEM_IMAGE_GUID,
        SYSTEM_TABLE_NODE_GUID,
        SYSTEM_TABLE_REVISION,
        SYSTEM_TABLE_VENDOR_OUI,
        SYSTEM_TABLE_META_VERSION,
        SYSTEM_TABLE_DEVICE_ID,
        SYSTEM_TABLE_PARTITION_ENFORCEMENT_CAP,
        SYSTEM_TABLE_QSFP_POWER_CLASS_MAX,
        SYSTEM_TABLE_QSFP_ATTENUATION_DEFAULT_12G,
        SYSTEM_TABLE_QSFP_ATTENUATION_DEFAULT_25G,
        SYSTEM_TABLE_VARIABLE_TABLE_ENTRIES_PER_PORT,
        SYSTEM_TABLE_MAX
};

enum platform_config_port_table_fields {
        PORT_TABLE_RESERVED,
        PORT_TABLE_PORT_TYPE,
        PORT_TABLE_LOCAL_ATTEN_12G,
        PORT_TABLE_LOCAL_ATTEN_25G,
        PORT_TABLE_LINK_SPEED_SUPPORTED,
        PORT_TABLE_LINK_WIDTH_SUPPORTED,
        PORT_TABLE_AUTO_LANE_SHEDDING_ENABLED,
        PORT_TABLE_EXTERNAL_LOOPBACK_ALLOWED,
        PORT_TABLE_VL_CAP,
        PORT_TABLE_MTU_CAP,
        PORT_TABLE_TX_LANE_ENABLE_MASK,
        PORT_TABLE_LOCAL_MAX_TIMEOUT,
        PORT_TABLE_REMOTE_ATTEN_12G,
        PORT_TABLE_REMOTE_ATTEN_25G,
        PORT_TABLE_TX_PRESET_IDX_ACTIVE_NO_EQ,
        PORT_TABLE_TX_PRESET_IDX_ACTIVE_EQ,
        PORT_TABLE_RX_PRESET_IDX,
        PORT_TABLE_CABLE_REACH_CLASS,
        PORT_TABLE_MAX
};

enum platform_config_rx_preset_table_fields {
        RX_PRESET_TABLE_RESERVED,
        RX_PRESET_TABLE_QSFP_RX_CDR_APPLY,
        RX_PRESET_TABLE_QSFP_RX_EMP_APPLY,
        RX_PRESET_TABLE_QSFP_RX_AMP_APPLY,
        RX_PRESET_TABLE_QSFP_RX_CDR,
        RX_PRESET_TABLE_QSFP_RX_EMP,
        RX_PRESET_TABLE_QSFP_RX_AMP,
        RX_PRESET_TABLE_MAX
};

enum platform_config_tx_preset_table_fields {
        TX_PRESET_TABLE_RESERVED,
        TX_PRESET_TABLE_PRECUR,
        TX_PRESET_TABLE_ATTN,
        TX_PRESET_TABLE_POSTCUR,
        TX_PRESET_TABLE_QSFP_TX_CDR_APPLY,
        TX_PRESET_TABLE_QSFP_TX_EQ_APPLY,
        TX_PRESET_TABLE_QSFP_TX_CDR,
        TX_PRESET_TABLE_QSFP_TX_EQ,
        TX_PRESET_TABLE_MAX
};

enum platform_config_qsfp_attn_table_fields {
        QSFP_ATTEN_TABLE_RESERVED,
        QSFP_ATTEN_TABLE_TX_PRESET_IDX,
        QSFP_ATTEN_TABLE_RX_PRESET_IDX,
        QSFP_ATTEN_TABLE_MAX
};

enum platform_config_variable_settings_table_fields {
        VARIABLE_SETTINGS_TABLE_RESERVED,
        VARIABLE_SETTINGS_TABLE_TX_PRESET_IDX,
        VARIABLE_SETTINGS_TABLE_RX_PRESET_IDX,
        VARIABLE_SETTINGS_TABLE_MAX
};

struct platform_config {
        size_t size;
        const u8 *data;
};

struct platform_config_data {
        u32 *table;
        u32 *table_metadata;
        u32 num_table;
};

/*
 * This struct acts as a quick reference into the platform_data binary image
 * and is populated by parse_platform_config(...) depending on the specific
 * META_VERSION
 */
struct platform_config_cache {
        u8  cache_valid;
        struct platform_config_data config_tables[PLATFORM_CONFIG_TABLE_MAX];
};

/* This section defines default values and encodings for the
 * fields defined for each table above
 */

/*
 * =====================================================
 *  System table encodings
 * =====================================================
 */
#define PLATFORM_CONFIG_MAGIC_NUM               0x3d4f5041
#define PLATFORM_CONFIG_MAGIC_NUMBER_LEN        4

/*
 * These power classes are the same as defined in SFF 8636 spec rev 2.4
 * describing byte 129 in table 6-16, except enumerated in a different order
 */
enum platform_config_qsfp_power_class_encoding {
        QSFP_POWER_CLASS_1 = 1,
        QSFP_POWER_CLASS_2,
        QSFP_POWER_CLASS_3,
        QSFP_POWER_CLASS_4,
        QSFP_POWER_CLASS_5,
        QSFP_POWER_CLASS_6,
        QSFP_POWER_CLASS_7
};

/*
 * ====================================================
 *  Port table encodings
 * ====================================================
 */
enum platform_config_port_type_encoding {
        PORT_TYPE_UNKNOWN,
        PORT_TYPE_DISCONNECTED,
        PORT_TYPE_FIXED,
        PORT_TYPE_VARIABLE,
        PORT_TYPE_QSFP,
        PORT_TYPE_MAX
};

enum platform_config_link_speed_supported_encoding {
        LINK_SPEED_SUPP_12G = 1,
        LINK_SPEED_SUPP_25G,
        LINK_SPEED_SUPP_12G_25G,
        LINK_SPEED_SUPP_MAX
};

/*
 * This is a subset (not strict) of the link downgrades
 * supported. The link downgrades supported are expected
 * to be supplied to the driver by another entity such as
 * the fabric manager
 */
enum platform_config_link_width_supported_encoding {
        LINK_WIDTH_SUPP_1X = 1,
        LINK_WIDTH_SUPP_2X,
        LINK_WIDTH_SUPP_2X_1X,
        LINK_WIDTH_SUPP_3X,
        LINK_WIDTH_SUPP_3X_1X,
        LINK_WIDTH_SUPP_3X_2X,
        LINK_WIDTH_SUPP_3X_2X_1X,
        LINK_WIDTH_SUPP_4X,
        LINK_WIDTH_SUPP_4X_1X,
        LINK_WIDTH_SUPP_4X_2X,
        LINK_WIDTH_SUPP_4X_2X_1X,
        LINK_WIDTH_SUPP_4X_3X,
        LINK_WIDTH_SUPP_4X_3X_1X,
        LINK_WIDTH_SUPP_4X_3X_2X,
        LINK_WIDTH_SUPP_4X_3X_2X_1X,
        LINK_WIDTH_SUPP_MAX
};

enum platform_config_virtual_lane_capability_encoding {
        VL_CAP_VL0 = 1,
        VL_CAP_VL0_1,
        VL_CAP_VL0_2,
        VL_CAP_VL0_3,
        VL_CAP_VL0_4,
        VL_CAP_VL0_5,
        VL_CAP_VL0_6,
        VL_CAP_VL0_7,
        VL_CAP_VL0_8,
        VL_CAP_VL0_9,
        VL_CAP_VL0_10,
        VL_CAP_VL0_11,
        VL_CAP_VL0_12,
        VL_CAP_VL0_13,
        VL_CAP_VL0_14,
        VL_CAP_MAX
};

/* Max MTU */
enum platform_config_mtu_capability_encoding {
        MTU_CAP_256   = 1,
        MTU_CAP_512   = 2,
        MTU_CAP_1024  = 3,
        MTU_CAP_2048  = 4,
        MTU_CAP_4096  = 5,
        MTU_CAP_8192  = 6,
        MTU_CAP_10240 = 7
};

enum platform_config_local_max_timeout_encoding {
        LOCAL_MAX_TIMEOUT_10_MS = 1,
        LOCAL_MAX_TIMEOUT_100_MS,
        LOCAL_MAX_TIMEOUT_1_S,
        LOCAL_MAX_TIMEOUT_10_S,
        LOCAL_MAX_TIMEOUT_100_S,
        LOCAL_MAX_TIMEOUT_1000_S
};

enum link_tuning_encoding {
        OPA_PASSIVE_TUNING,
        OPA_ACTIVE_TUNING,
        OPA_UNKNOWN_TUNING
};

/*
 * Shifts and masks for the link SI tuning values stuffed into the ASIC scratch
 * registers for integrated platforms
 */
#define PORT0_PORT_TYPE_SHIFT           0
#define PORT0_LOCAL_ATTEN_SHIFT         4
#define PORT0_REMOTE_ATTEN_SHIFT        10
#define PORT0_DEFAULT_ATTEN_SHIFT       32

#define PORT1_PORT_TYPE_SHIFT           16
#define PORT1_LOCAL_ATTEN_SHIFT         20
#define PORT1_REMOTE_ATTEN_SHIFT        26
#define PORT1_DEFAULT_ATTEN_SHIFT       40

#define PORT0_PORT_TYPE_MASK            0xFUL
#define PORT0_LOCAL_ATTEN_MASK          0x3FUL
#define PORT0_REMOTE_ATTEN_MASK         0x3FUL
#define PORT0_DEFAULT_ATTEN_MASK        0xFFUL

#define PORT1_PORT_TYPE_MASK            0xFUL
#define PORT1_LOCAL_ATTEN_MASK          0x3FUL
#define PORT1_REMOTE_ATTEN_MASK         0x3FUL
#define PORT1_DEFAULT_ATTEN_MASK        0xFFUL

#define PORT0_PORT_TYPE_SMASK           (PORT0_PORT_TYPE_MASK << \
                                         PORT0_PORT_TYPE_SHIFT)
#define PORT0_LOCAL_ATTEN_SMASK         (PORT0_LOCAL_ATTEN_MASK << \
                                         PORT0_LOCAL_ATTEN_SHIFT)
#define PORT0_REMOTE_ATTEN_SMASK        (PORT0_REMOTE_ATTEN_MASK << \
                                         PORT0_REMOTE_ATTEN_SHIFT)
#define PORT0_DEFAULT_ATTEN_SMASK       (PORT0_DEFAULT_ATTEN_MASK << \
                                         PORT0_DEFAULT_ATTEN_SHIFT)

#define PORT1_PORT_TYPE_SMASK           (PORT1_PORT_TYPE_MASK << \
                                         PORT1_PORT_TYPE_SHIFT)
#define PORT1_LOCAL_ATTEN_SMASK         (PORT1_LOCAL_ATTEN_MASK << \
                                         PORT1_LOCAL_ATTEN_SHIFT)
#define PORT1_REMOTE_ATTEN_SMASK        (PORT1_REMOTE_ATTEN_MASK << \
                                         PORT1_REMOTE_ATTEN_SHIFT)
#define PORT1_DEFAULT_ATTEN_SMASK       (PORT1_DEFAULT_ATTEN_MASK << \
                                         PORT1_DEFAULT_ATTEN_SHIFT)

#define QSFP_MAX_POWER_SHIFT            0
#define TX_NO_EQ_SHIFT                  4
#define TX_EQ_SHIFT                     25
#define RX_SHIFT                        46

#define QSFP_MAX_POWER_MASK             0xFUL
#define TX_NO_EQ_MASK                   0x1FFFFFUL
#define TX_EQ_MASK                      0x1FFFFFUL
#define RX_MASK                         0xFFFFUL

#define QSFP_MAX_POWER_SMASK            (QSFP_MAX_POWER_MASK << \
                                         QSFP_MAX_POWER_SHIFT)
#define TX_NO_EQ_SMASK                  (TX_NO_EQ_MASK << TX_NO_EQ_SHIFT)
#define TX_EQ_SMASK                     (TX_EQ_MASK << TX_EQ_SHIFT)
#define RX_SMASK                        (RX_MASK << RX_SHIFT)

#define TX_PRECUR_SHIFT                 0
#define TX_ATTN_SHIFT                   4
#define QSFP_TX_CDR_APPLY_SHIFT         9
#define QSFP_TX_EQ_APPLY_SHIFT          10
#define QSFP_TX_CDR_SHIFT               11
#define QSFP_TX_EQ_SHIFT                12
#define TX_POSTCUR_SHIFT                16

#define TX_PRECUR_MASK                  0xFUL
#define TX_ATTN_MASK                    0x1FUL
#define QSFP_TX_CDR_APPLY_MASK          0x1UL
#define QSFP_TX_EQ_APPLY_MASK           0x1UL
#define QSFP_TX_CDR_MASK                0x1UL
#define QSFP_TX_EQ_MASK                 0xFUL
#define TX_POSTCUR_MASK                 0x1FUL

#define TX_PRECUR_SMASK                 (TX_PRECUR_MASK << TX_PRECUR_SHIFT)
#define TX_ATTN_SMASK                   (TX_ATTN_MASK << TX_ATTN_SHIFT)
#define QSFP_TX_CDR_APPLY_SMASK         (QSFP_TX_CDR_APPLY_MASK << \
                                         QSFP_TX_CDR_APPLY_SHIFT)
#define QSFP_TX_EQ_APPLY_SMASK          (QSFP_TX_EQ_APPLY_MASK << \
                                         QSFP_TX_EQ_APPLY_SHIFT)
#define QSFP_TX_CDR_SMASK               (QSFP_TX_CDR_MASK << QSFP_TX_CDR_SHIFT)
#define QSFP_TX_EQ_SMASK                (QSFP_TX_EQ_MASK << QSFP_TX_EQ_SHIFT)
#define TX_POSTCUR_SMASK                (TX_POSTCUR_MASK << TX_POSTCUR_SHIFT)

#define QSFP_RX_CDR_APPLY_SHIFT         0
#define QSFP_RX_EMP_APPLY_SHIFT         1
#define QSFP_RX_AMP_APPLY_SHIFT         2
#define QSFP_RX_CDR_SHIFT               3
#define QSFP_RX_EMP_SHIFT               4
#define QSFP_RX_AMP_SHIFT               8

#define QSFP_RX_CDR_APPLY_MASK          0x1UL
#define QSFP_RX_EMP_APPLY_MASK          0x1UL
#define QSFP_RX_AMP_APPLY_MASK          0x1UL
#define QSFP_RX_CDR_MASK                0x1UL
#define QSFP_RX_EMP_MASK                0xFUL
#define QSFP_RX_AMP_MASK                0x3UL

#define QSFP_RX_CDR_APPLY_SMASK         (QSFP_RX_CDR_APPLY_MASK << \
                                         QSFP_RX_CDR_APPLY_SHIFT)
#define QSFP_RX_EMP_APPLY_SMASK         (QSFP_RX_EMP_APPLY_MASK << \
                                         QSFP_RX_EMP_APPLY_SHIFT)
#define QSFP_RX_AMP_APPLY_SMASK         (QSFP_RX_AMP_APPLY_MASK << \
                                         QSFP_RX_AMP_APPLY_SHIFT)
#define QSFP_RX_CDR_SMASK               (QSFP_RX_CDR_MASK << QSFP_RX_CDR_SHIFT)
#define QSFP_RX_EMP_SMASK               (QSFP_RX_EMP_MASK << QSFP_RX_EMP_SHIFT)
#define QSFP_RX_AMP_SMASK               (QSFP_RX_AMP_MASK << QSFP_RX_AMP_SHIFT)

#define BITMAP_VERSION                  1
#define BITMAP_VERSION_SHIFT            44
#define BITMAP_VERSION_MASK             0xFUL
#define BITMAP_VERSION_SMASK            (BITMAP_VERSION_MASK << \
                                         BITMAP_VERSION_SHIFT)
#define CHECKSUM_SHIFT                  48
#define CHECKSUM_MASK                   0xFFFFUL
#define CHECKSUM_SMASK                  (CHECKSUM_MASK << CHECKSUM_SHIFT)

/* platform.c */
void get_platform_config(struct hfi1_devdata *dd);
void free_platform_config(struct hfi1_devdata *dd);
void get_port_type(struct hfi1_pportdata *ppd);
int set_qsfp_tx(struct hfi1_pportdata *ppd, int on);
void tune_serdes(struct hfi1_pportdata *ppd);

#endif                  /*__PLATFORM_H*/