Imported Upstream version 17.05
[deb_dpdk.git] / drivers / net / sfc / base / siena_flash.h
diff --git a/drivers/net/sfc/base/siena_flash.h b/drivers/net/sfc/base/siena_flash.h
new file mode 100644 (file)
index 0000000..e270055
--- /dev/null
@@ -0,0 +1,215 @@
+/*
+ * Copyright (c) 2007-2016 Solarflare Communications Inc.
+ * 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.
+ *
+ * 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 OWNER 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.
+ *
+ * The views and conclusions contained in the software and documentation are
+ * those of the authors and should not be interpreted as representing official
+ * policies, either expressed or implied, of the FreeBSD Project.
+ */
+
+#ifndef        _SYS_SIENA_FLASH_H
+#define        _SYS_SIENA_FLASH_H
+
+#pragma pack(1)
+
+/* Fixed locations near the start of flash (which may be in the internal PHY
+ * firmware header) point to the boot header.
+ *
+ * - parsed by MC boot ROM and firmware
+ * - reserved (but not parsed) by PHY firmware
+ * - opaque to driver
+ */
+
+#define        SIENA_MC_BOOT_PHY_FW_HDR_LEN (0x20)
+
+#define        SIENA_MC_BOOT_PTR_LOCATION (0x18)      /* First thing we try to boot */
+#define        SIENA_MC_BOOT_ALT_PTR_LOCATION (0x1c)  /* Alternative if that fails */
+
+#define        SIENA_MC_BOOT_HDR_LEN (0x200)
+
+#define        SIENA_MC_BOOT_MAGIC (0x51E4A001)
+#define        SIENA_MC_BOOT_VERSION (1)
+
+
+/*Structures supporting an arbitrary number of binary blobs in the flash image
+  intended to house code and tables for the satellite cpus*/
+/*thanks to random.org for:*/
+#define        BLOBS_HEADER_MAGIC (0xBDA3BBD4)
+#define        BLOB_HEADER_MAGIC  (0xA1478A91)
+
+typedef struct blobs_hdr_s {                   /* GENERATED BY scripts/genfwdef */
+       efx_dword_t     magic;
+       efx_dword_t     no_of_blobs;
+} blobs_hdr_t;
+
+typedef struct blob_hdr_s {                    /* GENERATED BY scripts/genfwdef */
+       efx_dword_t     magic;
+       efx_dword_t     cpu_type;
+       efx_dword_t     build_variant;
+       efx_dword_t     offset;
+       efx_dword_t     length;
+       efx_dword_t     checksum;
+} blob_hdr_t;
+
+#define        BLOB_CPU_TYPE_TXDI_TEXT (0)
+#define        BLOB_CPU_TYPE_RXDI_TEXT (1)
+#define        BLOB_CPU_TYPE_TXDP_TEXT (2)
+#define        BLOB_CPU_TYPE_RXDP_TEXT (3)
+#define        BLOB_CPU_TYPE_RXHRSL_HR_LUT (4)
+#define        BLOB_CPU_TYPE_RXHRSL_HR_LUT_CFG (5)
+#define        BLOB_CPU_TYPE_TXHRSL_HR_LUT (6)
+#define        BLOB_CPU_TYPE_TXHRSL_HR_LUT_CFG (7)
+#define        BLOB_CPU_TYPE_RXHRSL_HR_PGM  (8)
+#define        BLOB_CPU_TYPE_RXHRSL_SL_PGM  (9)
+#define        BLOB_CPU_TYPE_TXHRSL_HR_PGM  (10)
+#define        BLOB_CPU_TYPE_TXHRSL_SL_PGM  (11)
+#define        BLOB_CPU_TYPE_RXDI_VTBL0 (12)
+#define        BLOB_CPU_TYPE_TXDI_VTBL0 (13)
+#define        BLOB_CPU_TYPE_RXDI_VTBL1 (14)
+#define        BLOB_CPU_TYPE_TXDI_VTBL1 (15)
+#define        BLOB_CPU_TYPE_DUMPSPEC (32)
+#define        BLOB_CPU_TYPE_MC_XIP   (33)
+
+#define        BLOB_CPU_TYPE_INVALID (31)
+
+/*
+ * The upper four bits of the CPU type field specify the compression
+ * algorithm used for this blob.
+ */
+#define        BLOB_COMPRESSION_MASK (0xf0000000)
+#define        BLOB_CPU_TYPE_MASK    (0x0fffffff)
+
+#define        BLOB_COMPRESSION_NONE (0x00000000) /* Stored as is */
+#define        BLOB_COMPRESSION_LZ   (0x10000000) /* see lib/lzdecoder.c */
+
+typedef struct siena_mc_boot_hdr_s {           /* GENERATED BY scripts/genfwdef */
+       efx_dword_t     magic;                  /* = SIENA_MC_BOOT_MAGIC */
+       efx_word_t      hdr_version;            /* this structure definition is version 1 */
+       efx_byte_t      board_type;
+       efx_byte_t      firmware_version_a;
+       efx_byte_t      firmware_version_b;
+       efx_byte_t      firmware_version_c;
+       efx_word_t      checksum;               /* of whole header area + firmware image */
+       efx_word_t      firmware_version_d;
+       efx_byte_t      mcfw_subtype;
+       efx_byte_t      generation;             /* Valid for medford, SBZ for earlier chips */
+       efx_dword_t     firmware_text_offset;   /* offset to firmware .text */
+       efx_dword_t     firmware_text_size;     /* length of firmware .text, in bytes */
+       efx_dword_t     firmware_data_offset;   /* offset to firmware .data */
+       efx_dword_t     firmware_data_size;     /* length of firmware .data, in bytes */
+       efx_byte_t      spi_rate;               /* SPI rate for reading image, 0 is BootROM default */
+       efx_byte_t      spi_phase_adj;          /* SPI SDO/SCL phase adjustment, 0 is default (no adj) */
+       efx_word_t      xpm_sector;             /* The sector that contains the key, or 0xffff if unsigned (medford) SBZ (earlier) */
+       efx_dword_t     reserved_c[7];          /* (set to 0) */
+} siena_mc_boot_hdr_t;
+
+#define        SIENA_MC_BOOT_HDR_PADDING \
+       (SIENA_MC_BOOT_HDR_LEN - sizeof(siena_mc_boot_hdr_t))
+
+#define        SIENA_MC_STATIC_CONFIG_MAGIC (0xBDCF5555)
+#define        SIENA_MC_STATIC_CONFIG_VERSION (0)
+
+typedef struct siena_mc_static_config_hdr_s {  /* GENERATED BY scripts/genfwdef */
+       efx_dword_t     magic;                  /* = SIENA_MC_STATIC_CONFIG_MAGIC */
+       efx_word_t      length;                 /* of header area (i.e. not including VPD) */
+       efx_byte_t      version;
+       efx_byte_t      csum;                   /* over header area (i.e. not including VPD) */
+       efx_dword_t     static_vpd_offset;
+       efx_dword_t     static_vpd_length;
+       efx_dword_t     capabilities;
+       efx_byte_t      mac_addr_base[6];
+       efx_byte_t      green_mode_cal;         /* Green mode calibration result */
+       efx_byte_t      green_mode_valid;       /* Whether cal holds a valid value */
+       efx_word_t      mac_addr_count;
+       efx_word_t      mac_addr_stride;
+       efx_word_t      calibrated_vref;        /* Vref as measured during production */
+       efx_word_t      adc_vref;               /* Vref as read by ADC */
+       efx_dword_t     reserved2[1];           /* (write as zero) */
+       efx_dword_t     num_dbi_items;
+       struct {
+               efx_word_t      addr;
+               efx_word_t      byte_enables;
+               efx_dword_t     value;
+       } dbi[];
+} siena_mc_static_config_hdr_t;
+
+/* This prefixes a valid XIP partition */
+#define XIP_PARTITION_MAGIC (0x51DEC0DE)
+
+#define        SIENA_MC_DYNAMIC_CONFIG_MAGIC (0xBDCFDDDD)
+#define        SIENA_MC_DYNAMIC_CONFIG_VERSION (0)
+
+typedef struct siena_mc_fw_version_s {         /* GENERATED BY scripts/genfwdef */
+       efx_dword_t     fw_subtype;
+       efx_word_t      version_w;
+       efx_word_t      version_x;
+       efx_word_t      version_y;
+       efx_word_t      version_z;
+} siena_mc_fw_version_t;
+
+typedef struct siena_mc_dynamic_config_hdr_s { /* GENERATED BY scripts/genfwdef */
+       efx_dword_t     magic;                  /* = SIENA_MC_DYNAMIC_CONFIG_MAGIC */
+       efx_word_t      length;                 /* of header area (i.e. not including VPD) */
+       efx_byte_t      version;
+       efx_byte_t      csum;                   /* over header area (i.e. not including VPD) */
+       efx_dword_t     dynamic_vpd_offset;
+       efx_dword_t     dynamic_vpd_length;
+       efx_dword_t     num_fw_version_items;
+       siena_mc_fw_version_t   fw_version[];
+} siena_mc_dynamic_config_hdr_t;
+
+#define        SIENA_MC_EXPROM_SINGLE_MAGIC (0xAA55)  /* little-endian uint16_t */
+
+#define        SIENA_MC_EXPROM_COMBO_MAGIC (0xB0070102)  /* little-endian uint32_t */
+#define        SIENA_MC_EXPROM_COMBO_V2_MAGIC (0xB0070103)  /* little-endian uint32_t */
+
+typedef struct siena_mc_combo_rom_hdr_s {      /* GENERATED BY scripts/genfwdef */
+       efx_dword_t     magic;                  /* = SIENA_MC_EXPROM_COMBO_MAGIC or SIENA_MC_EXPROM_COMBO_V2_MAGIC */
+       union           {
+               struct {
+                       efx_dword_t     len1;   /* length of first image */
+                       efx_dword_t     len2;   /* length of second image */
+                       efx_dword_t     off1;   /* offset of first byte to edit to combine images */
+                       efx_dword_t     off2;   /* offset of second byte to edit to combine images */
+                       efx_word_t      infoblk0_off;/* infoblk offset */
+                       efx_word_t      infoblk1_off;/* infoblk offset */
+                       efx_byte_t      infoblk_len;/* length of space reserved for one infoblk structure */
+                       efx_byte_t      reserved[7];/* (set to 0) */
+               } v1;
+               struct {
+                       efx_dword_t     len1;   /* length of first image */
+                       efx_dword_t     len2;   /* length of second image */
+                       efx_dword_t     off1;   /* offset of first byte to edit to combine images */
+                       efx_dword_t     off2;   /* offset of second byte to edit to combine images */
+                       efx_word_t      infoblk_off;/* infoblk start offset */
+                       efx_word_t      infoblk_count;/* infoblk count  */
+                       efx_byte_t      infoblk_len;/* length of space reserved for one infoblk structure */
+                       efx_byte_t      reserved[7];/* (set to 0) */
+               } v2;
+       } data;
+} siena_mc_combo_rom_hdr_t;
+
+#pragma pack()
+
+#endif /* _SYS_SIENA_FLASH_H */