1 /* SPDX-License-Identifier: BSD-3-Clause */ 2 /* Copyright (c) 2023, Intel Corporation 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, 9 * this list of conditions and the following disclaimer. 10 * 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * 3. Neither the name of the Intel Corporation nor the names of its 16 * contributors may be used to endorse or promote products derived from 17 * this software without specific prior written permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 20 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 23 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29 * POSSIBILITY OF SUCH DAMAGE. 30 */ 31 /*$FreeBSD$*/ 32 33 #ifndef _ICE_NVM_H_ 34 #define _ICE_NVM_H_ 35 36 #define ICE_NVM_CMD_READ 0x0000000B 37 #define ICE_NVM_CMD_WRITE 0x0000000C 38 39 /* NVM Access config bits */ 40 #define ICE_NVM_CFG_MODULE_M MAKEMASK(0xFF, 0) 41 #define ICE_NVM_CFG_MODULE_S 0 42 #define ICE_NVM_CFG_FLAGS_M MAKEMASK(0xF, 8) 43 #define ICE_NVM_CFG_FLAGS_S 8 44 #define ICE_NVM_CFG_EXT_FLAGS_M MAKEMASK(0xF, 12) 45 #define ICE_NVM_CFG_EXT_FLAGS_S 12 46 #define ICE_NVM_CFG_ADAPTER_INFO_M MAKEMASK(0xFFFF, 16) 47 #define ICE_NVM_CFG_ADAPTER_INFO_S 16 48 49 /* NVM Read Get Driver Features */ 50 #define ICE_NVM_GET_FEATURES_MODULE 0xE 51 #define ICE_NVM_GET_FEATURES_FLAGS 0xF 52 53 /* NVM Read/Write Mapped Space */ 54 #define ICE_NVM_REG_RW_MODULE 0x0 55 #define ICE_NVM_REG_RW_FLAGS 0x1 56 57 #pragma pack(1) 58 struct ice_orom_civd_info { 59 u8 signature[4]; /* Must match ASCII '$CIV' characters */ 60 u8 checksum; /* Simple modulo 256 sum of all structure bytes must equal 0 */ 61 __le32 combo_ver; /* Combo Image Version number */ 62 u8 combo_name_len; /* Length of the unicode combo image version string, max of 32 */ 63 __le16 combo_name[32]; /* Unicode string representing the Combo Image version */ 64 }; 65 #pragma pack() 66 67 #define ICE_NVM_ACCESS_MAJOR_VER 0 68 #define ICE_NVM_ACCESS_MINOR_VER 5 69 70 /* NVM Access feature flags. Other bits in the features field are reserved and 71 * should be set to zero when reporting the ice_nvm_features structure. 72 */ 73 #define ICE_NVM_FEATURES_0_REG_ACCESS BIT(1) 74 75 /* NVM Access Features */ 76 struct ice_nvm_features { 77 u8 major; /* Major version (informational only) */ 78 u8 minor; /* Minor version (informational only) */ 79 u16 size; /* size of ice_nvm_features structure */ 80 u8 features[12]; /* Array of feature bits */ 81 }; 82 83 /* NVM Access command */ 84 struct ice_nvm_access_cmd { 85 u32 command; /* NVM command: READ or WRITE */ 86 u32 config; /* NVM command configuration */ 87 u32 offset; /* offset to read/write, in bytes */ 88 u32 data_size; /* size of data field, in bytes */ 89 }; 90 91 /* NVM Access data */ 92 union ice_nvm_access_data { 93 u32 regval; /* Storage for register value */ 94 struct ice_nvm_features drv_features; /* NVM features */ 95 }; 96 97 u32 ice_nvm_access_get_module(struct ice_nvm_access_cmd *cmd); 98 u32 ice_nvm_access_get_flags(struct ice_nvm_access_cmd *cmd); 99 u32 ice_nvm_access_get_adapter(struct ice_nvm_access_cmd *cmd); 100 enum ice_status 101 ice_nvm_access_read(struct ice_hw *hw, struct ice_nvm_access_cmd *cmd, 102 union ice_nvm_access_data *data); 103 enum ice_status 104 ice_nvm_access_write(struct ice_hw *hw, struct ice_nvm_access_cmd *cmd, 105 union ice_nvm_access_data *data); 106 enum ice_status 107 ice_nvm_access_get_features(struct ice_nvm_access_cmd *cmd, 108 union ice_nvm_access_data *data); 109 enum ice_status 110 ice_handle_nvm_access(struct ice_hw *hw, struct ice_nvm_access_cmd *cmd, 111 union ice_nvm_access_data *data); 112 enum ice_status 113 ice_acquire_nvm(struct ice_hw *hw, enum ice_aq_res_access_type access); 114 void ice_release_nvm(struct ice_hw *hw); 115 enum ice_status 116 ice_aq_read_nvm(struct ice_hw *hw, u16 module_typeid, u32 offset, u16 length, 117 void *data, bool last_command, bool read_shadow_ram, 118 struct ice_sq_cd *cd); 119 enum ice_status 120 ice_read_flat_nvm(struct ice_hw *hw, u32 offset, u32 *length, u8 *data, 121 bool read_shadow_ram); 122 enum ice_status 123 ice_get_pfa_module_tlv(struct ice_hw *hw, u16 *module_tlv, u16 *module_tlv_len, 124 u16 module_type); 125 enum ice_status 126 ice_get_nvm_minsrevs(struct ice_hw *hw, struct ice_minsrev_info *minsrevs); 127 enum ice_status 128 ice_update_nvm_minsrevs(struct ice_hw *hw, struct ice_minsrev_info *minsrevs); 129 enum ice_status 130 ice_get_inactive_orom_ver(struct ice_hw *hw, struct ice_orom_info *orom); 131 enum ice_status 132 ice_get_inactive_nvm_ver(struct ice_hw *hw, struct ice_nvm_info *nvm); 133 enum ice_status 134 ice_get_inactive_netlist_ver(struct ice_hw *hw, struct ice_netlist_info *netlist); 135 enum ice_status 136 ice_read_pba_string(struct ice_hw *hw, u8 *pba_num, u32 pba_num_size); 137 enum ice_status ice_init_nvm(struct ice_hw *hw); 138 enum ice_status ice_read_sr_word(struct ice_hw *hw, u16 offset, u16 *data); 139 enum ice_status ice_read_sr_word_aq(struct ice_hw *hw, u16 offset, u16 *data); 140 enum ice_status 141 ice_read_sr_buf(struct ice_hw *hw, u16 offset, u16 *words, u16 *data); 142 enum ice_status 143 ice_aq_erase_nvm(struct ice_hw *hw, u16 module_typeid, struct ice_sq_cd *cd); 144 enum ice_status 145 ice_aq_update_nvm(struct ice_hw *hw, u16 module_typeid, u32 offset, 146 u16 length, void *data, bool last_command, u8 command_flags, 147 struct ice_sq_cd *cd); 148 enum ice_status 149 ice_aq_read_nvm_cfg(struct ice_hw *hw, u8 cmd_flags, u16 field_id, void *data, 150 u16 buf_size, u16 *elem_count, struct ice_sq_cd *cd); 151 enum ice_status 152 ice_aq_write_nvm_cfg(struct ice_hw *hw, u8 cmd_flags, void *data, u16 buf_size, 153 u16 elem_count, struct ice_sq_cd *cd); 154 enum ice_status ice_update_sr_checksum(struct ice_hw *hw); 155 enum ice_status ice_validate_sr_checksum(struct ice_hw *hw, u16 *checksum); 156 enum ice_status ice_nvm_validate_checksum(struct ice_hw *hw); 157 enum ice_status ice_nvm_recalculate_checksum(struct ice_hw *hw); 158 enum ice_status 159 ice_nvm_write_activate(struct ice_hw *hw, u16 cmd_flags, u8 *response_flags); 160 #endif /* _ICE_NVM_H_ */ 161