Message ID | 20210129004332.3004826-3-anthony.l.nguyen@intel.com (mailing list archive) |
---|---|
State | Changes Requested |
Delegated to: | Netdev Maintainers |
Headers | show |
Series | 100GbE Intel Wired LAN Driver Updates 2021-01-28 | expand |
On Thu, Jan 28, 2021 at 7:46 PM Tony Nguyen <anthony.l.nguyen@intel.com> wrote: > > From: Jacob Keller <jacob.e.keller@intel.com> > > The ice flash contains two copies of each of the NVM, Option ROM, and > Netlist modules. Each bank has a pointer word and a size word. In order > to correctly read from the active flash bank, the driver must calculate > the offset manually. > > During NVM initialization, read the Shadow RAM control word and > determine which bank is active for each NVM module. Additionally, cache > the size and pointer values for use in calculating the correct offset. > > Signed-off-by: Jacob Keller <jacob.e.keller@intel.com> > Tested-by: Tony Brelinski <tonyx.brelinski@intel.com> > Signed-off-by: Tony Nguyen <anthony.l.nguyen@intel.com> > --- > drivers/net/ethernet/intel/ice/ice_nvm.c | 151 ++++++++++++++++++++++ > drivers/net/ethernet/intel/ice/ice_type.h | 37 ++++++ > 2 files changed, 188 insertions(+) > > diff --git a/drivers/net/ethernet/intel/ice/ice_nvm.c b/drivers/net/ethernet/intel/ice/ice_nvm.c > index b0f0b4fc266b..308344045397 100644 > --- a/drivers/net/ethernet/intel/ice/ice_nvm.c > +++ b/drivers/net/ethernet/intel/ice/ice_nvm.c > @@ -603,6 +603,151 @@ static enum ice_status ice_discover_flash_size(struct ice_hw *hw) > return status; > } > > +/** > + * ice_read_sr_pointer - Read the value of a Shadow RAM pointer word > + * @hw: pointer to the HW structure > + * @offset: the word offset of the Shadow RAM word to read > + * @pointer: pointer value read from Shadow RAM > + * > + * Read the given Shadow RAM word, and convert it to a pointer value specified > + * in bytes. This function assumes the specified offset is a valid pointer > + * word. > + * > + * Each pointer word specifies whether it is stored in word size or 4KB > + * sector size by using the highest bit. The reported pointer value will be in > + * bytes, intended for flat NVM reads. > + */ > +static enum ice_status > +ice_read_sr_pointer(struct ice_hw *hw, u16 offset, u32 *pointer) > +{ > + enum ice_status status; > + u16 value; > + > + status = ice_read_sr_word(hw, offset, &value); > + if (status) > + return status; > + > + /* Determine if the pointer is in 4KB or word units */ > + if (value & ICE_SR_NVM_PTR_4KB_UNITS) > + *pointer = (value & ~ICE_SR_NVM_PTR_4KB_UNITS) * 4 * 1024; > + else > + *pointer = value * 2; Should this be << 2, for 4B words?
On Fri, Jan 29, 2021 at 4:01 PM Willem de Bruijn <willemdebruijn.kernel@gmail.com> wrote: > > On Thu, Jan 28, 2021 at 7:46 PM Tony Nguyen <anthony.l.nguyen@intel.com> wrote: > > > > From: Jacob Keller <jacob.e.keller@intel.com> > > > > The ice flash contains two copies of each of the NVM, Option ROM, and > > Netlist modules. Each bank has a pointer word and a size word. In order > > to correctly read from the active flash bank, the driver must calculate > > the offset manually. > > > > During NVM initialization, read the Shadow RAM control word and > > determine which bank is active for each NVM module. Additionally, cache > > the size and pointer values for use in calculating the correct offset. > > > > Signed-off-by: Jacob Keller <jacob.e.keller@intel.com> > > Tested-by: Tony Brelinski <tonyx.brelinski@intel.com> > > Signed-off-by: Tony Nguyen <anthony.l.nguyen@intel.com> > > --- > > drivers/net/ethernet/intel/ice/ice_nvm.c | 151 ++++++++++++++++++++++ > > drivers/net/ethernet/intel/ice/ice_type.h | 37 ++++++ > > 2 files changed, 188 insertions(+) > > > > diff --git a/drivers/net/ethernet/intel/ice/ice_nvm.c b/drivers/net/ethernet/intel/ice/ice_nvm.c > > index b0f0b4fc266b..308344045397 100644 > > --- a/drivers/net/ethernet/intel/ice/ice_nvm.c > > +++ b/drivers/net/ethernet/intel/ice/ice_nvm.c > > @@ -603,6 +603,151 @@ static enum ice_status ice_discover_flash_size(struct ice_hw *hw) > > return status; > > } > > > > +/** > > + * ice_read_sr_pointer - Read the value of a Shadow RAM pointer word > > + * @hw: pointer to the HW structure > > + * @offset: the word offset of the Shadow RAM word to read > > + * @pointer: pointer value read from Shadow RAM > > + * > > + * Read the given Shadow RAM word, and convert it to a pointer value specified > > + * in bytes. This function assumes the specified offset is a valid pointer > > + * word. > > + * > > + * Each pointer word specifies whether it is stored in word size or 4KB > > + * sector size by using the highest bit. The reported pointer value will be in > > + * bytes, intended for flat NVM reads. > > + */ > > +static enum ice_status > > +ice_read_sr_pointer(struct ice_hw *hw, u16 offset, u32 *pointer) > > +{ > > + enum ice_status status; > > + u16 value; > > + > > + status = ice_read_sr_word(hw, offset, &value); > > + if (status) > > + return status; > > + > > + /* Determine if the pointer is in 4KB or word units */ > > + if (value & ICE_SR_NVM_PTR_4KB_UNITS) > > + *pointer = (value & ~ICE_SR_NVM_PTR_4KB_UNITS) * 4 * 1024; > > + else > > + *pointer = value * 2; > > Should this be << 2, for 4B words? Never mind, sorry. I gather from patch 3 that wordsize is 16b.
On 1/29/2021 1:04 PM, Willem de Bruijn wrote: > On Fri, Jan 29, 2021 at 4:01 PM Willem de Bruijn > <willemdebruijn.kernel@gmail.com> wrote: >> >> On Thu, Jan 28, 2021 at 7:46 PM Tony Nguyen <anthony.l.nguyen@intel.com> wrote: >>> >>> From: Jacob Keller <jacob.e.keller@intel.com> >>> >>> The ice flash contains two copies of each of the NVM, Option ROM, and >>> Netlist modules. Each bank has a pointer word and a size word. In order >>> to correctly read from the active flash bank, the driver must calculate >>> the offset manually. >>> >>> During NVM initialization, read the Shadow RAM control word and >>> determine which bank is active for each NVM module. Additionally, cache >>> the size and pointer values for use in calculating the correct offset. >>> >>> Signed-off-by: Jacob Keller <jacob.e.keller@intel.com> >>> Tested-by: Tony Brelinski <tonyx.brelinski@intel.com> >>> Signed-off-by: Tony Nguyen <anthony.l.nguyen@intel.com> >>> --- >>> drivers/net/ethernet/intel/ice/ice_nvm.c | 151 ++++++++++++++++++++++ >>> drivers/net/ethernet/intel/ice/ice_type.h | 37 ++++++ >>> 2 files changed, 188 insertions(+) >>> >>> diff --git a/drivers/net/ethernet/intel/ice/ice_nvm.c b/drivers/net/ethernet/intel/ice/ice_nvm.c >>> index b0f0b4fc266b..308344045397 100644 >>> --- a/drivers/net/ethernet/intel/ice/ice_nvm.c >>> +++ b/drivers/net/ethernet/intel/ice/ice_nvm.c >>> @@ -603,6 +603,151 @@ static enum ice_status ice_discover_flash_size(struct ice_hw *hw) >>> return status; >>> } >>> >>> +/** >>> + * ice_read_sr_pointer - Read the value of a Shadow RAM pointer word >>> + * @hw: pointer to the HW structure >>> + * @offset: the word offset of the Shadow RAM word to read >>> + * @pointer: pointer value read from Shadow RAM >>> + * >>> + * Read the given Shadow RAM word, and convert it to a pointer value specified >>> + * in bytes. This function assumes the specified offset is a valid pointer >>> + * word. >>> + * >>> + * Each pointer word specifies whether it is stored in word size or 4KB >>> + * sector size by using the highest bit. The reported pointer value will be in >>> + * bytes, intended for flat NVM reads. >>> + */ >>> +static enum ice_status >>> +ice_read_sr_pointer(struct ice_hw *hw, u16 offset, u32 *pointer) >>> +{ >>> + enum ice_status status; >>> + u16 value; >>> + >>> + status = ice_read_sr_word(hw, offset, &value); >>> + if (status) >>> + return status; >>> + >>> + /* Determine if the pointer is in 4KB or word units */ >>> + if (value & ICE_SR_NVM_PTR_4KB_UNITS) >>> + *pointer = (value & ~ICE_SR_NVM_PTR_4KB_UNITS) * 4 * 1024; >>> + else >>> + *pointer = value * 2; >> >> Should this be << 2, for 4B words? > > Never mind, sorry. I gather from patch 3 that wordsize is 16b. > Ah, yes that could have been explained a bit better. In this context, a word is indeed 2 bytes. Perhaps we could have used "<< 1" and "<< 12" or similar instead of the multiplication, but I felt this was a bit more clear. Thanks, Jake
On Fri, Jan 29, 2021 at 4:32 PM Jacob Keller <jacob.e.keller@intel.com> wrote: > > > > On 1/29/2021 1:04 PM, Willem de Bruijn wrote: > > On Fri, Jan 29, 2021 at 4:01 PM Willem de Bruijn > > <willemdebruijn.kernel@gmail.com> wrote: > >> > >> On Thu, Jan 28, 2021 at 7:46 PM Tony Nguyen <anthony.l.nguyen@intel.com> wrote: > >>> > >>> From: Jacob Keller <jacob.e.keller@intel.com> > >>> > >>> The ice flash contains two copies of each of the NVM, Option ROM, and > >>> Netlist modules. Each bank has a pointer word and a size word. In order > >>> to correctly read from the active flash bank, the driver must calculate > >>> the offset manually. > >>> > >>> During NVM initialization, read the Shadow RAM control word and > >>> determine which bank is active for each NVM module. Additionally, cache > >>> the size and pointer values for use in calculating the correct offset. > >>> > >>> Signed-off-by: Jacob Keller <jacob.e.keller@intel.com> > >>> Tested-by: Tony Brelinski <tonyx.brelinski@intel.com> > >>> Signed-off-by: Tony Nguyen <anthony.l.nguyen@intel.com> > >>> --- > >>> drivers/net/ethernet/intel/ice/ice_nvm.c | 151 ++++++++++++++++++++++ > >>> drivers/net/ethernet/intel/ice/ice_type.h | 37 ++++++ > >>> 2 files changed, 188 insertions(+) > >>> > >>> diff --git a/drivers/net/ethernet/intel/ice/ice_nvm.c b/drivers/net/ethernet/intel/ice/ice_nvm.c > >>> index b0f0b4fc266b..308344045397 100644 > >>> --- a/drivers/net/ethernet/intel/ice/ice_nvm.c > >>> +++ b/drivers/net/ethernet/intel/ice/ice_nvm.c > >>> @@ -603,6 +603,151 @@ static enum ice_status ice_discover_flash_size(struct ice_hw *hw) > >>> return status; > >>> } > >>> > >>> +/** > >>> + * ice_read_sr_pointer - Read the value of a Shadow RAM pointer word > >>> + * @hw: pointer to the HW structure > >>> + * @offset: the word offset of the Shadow RAM word to read > >>> + * @pointer: pointer value read from Shadow RAM > >>> + * > >>> + * Read the given Shadow RAM word, and convert it to a pointer value specified > >>> + * in bytes. This function assumes the specified offset is a valid pointer > >>> + * word. > >>> + * > >>> + * Each pointer word specifies whether it is stored in word size or 4KB > >>> + * sector size by using the highest bit. The reported pointer value will be in > >>> + * bytes, intended for flat NVM reads. > >>> + */ > >>> +static enum ice_status > >>> +ice_read_sr_pointer(struct ice_hw *hw, u16 offset, u32 *pointer) > >>> +{ > >>> + enum ice_status status; > >>> + u16 value; > >>> + > >>> + status = ice_read_sr_word(hw, offset, &value); > >>> + if (status) > >>> + return status; > >>> + > >>> + /* Determine if the pointer is in 4KB or word units */ > >>> + if (value & ICE_SR_NVM_PTR_4KB_UNITS) > >>> + *pointer = (value & ~ICE_SR_NVM_PTR_4KB_UNITS) * 4 * 1024; > >>> + else > >>> + *pointer = value * 2; > >> > >> Should this be << 2, for 4B words? > > > > Never mind, sorry. I gather from patch 3 that wordsize is 16b. > > > > > Ah, yes that could have been explained a bit better. In this context, a > word is indeed 2 bytes. > > Perhaps we could have used "<< 1" and "<< 12" or similar instead of the > multiplication, but I felt this was a bit more clear. Thanks. That doesn't matter (for me). I just wrongly assumed wordsize to be 4B.
diff --git a/drivers/net/ethernet/intel/ice/ice_nvm.c b/drivers/net/ethernet/intel/ice/ice_nvm.c index b0f0b4fc266b..308344045397 100644 --- a/drivers/net/ethernet/intel/ice/ice_nvm.c +++ b/drivers/net/ethernet/intel/ice/ice_nvm.c @@ -603,6 +603,151 @@ static enum ice_status ice_discover_flash_size(struct ice_hw *hw) return status; } +/** + * ice_read_sr_pointer - Read the value of a Shadow RAM pointer word + * @hw: pointer to the HW structure + * @offset: the word offset of the Shadow RAM word to read + * @pointer: pointer value read from Shadow RAM + * + * Read the given Shadow RAM word, and convert it to a pointer value specified + * in bytes. This function assumes the specified offset is a valid pointer + * word. + * + * Each pointer word specifies whether it is stored in word size or 4KB + * sector size by using the highest bit. The reported pointer value will be in + * bytes, intended for flat NVM reads. + */ +static enum ice_status +ice_read_sr_pointer(struct ice_hw *hw, u16 offset, u32 *pointer) +{ + enum ice_status status; + u16 value; + + status = ice_read_sr_word(hw, offset, &value); + if (status) + return status; + + /* Determine if the pointer is in 4KB or word units */ + if (value & ICE_SR_NVM_PTR_4KB_UNITS) + *pointer = (value & ~ICE_SR_NVM_PTR_4KB_UNITS) * 4 * 1024; + else + *pointer = value * 2; + + return 0; +} + +/** + * ice_read_sr_area_size - Read an area size from a Shadow RAM word + * @hw: pointer to the HW structure + * @offset: the word offset of the Shadow RAM to read + * @size: size value read from the Shadow RAM + * + * Read the given Shadow RAM word, and convert it to an area size value + * specified in bytes. This function assumes the specified offset is a valid + * area size word. + * + * Each area size word is specified in 4KB sector units. This function reports + * the size in bytes, intended for flat NVM reads. + */ +static enum ice_status +ice_read_sr_area_size(struct ice_hw *hw, u16 offset, u32 *size) +{ + enum ice_status status; + u16 value; + + status = ice_read_sr_word(hw, offset, &value); + if (status) + return status; + + /* Area sizes are always specified in 4KB units */ + *size = value * 4 * 1024; + + return 0; +} + +/** + * ice_determine_active_flash_banks - Discover active bank for each module + * @hw: pointer to the HW struct + * + * Read the Shadow RAM control word and determine which banks are active for + * the NVM, OROM, and Netlist modules. Also read and calculate the associated + * pointer and size. These values are then cached into the ice_flash_info + * structure for later use in order to calculate the correct offset to read + * from the active module. + */ +static enum ice_status +ice_determine_active_flash_banks(struct ice_hw *hw) +{ + struct ice_bank_info *banks = &hw->flash.banks; + enum ice_status status; + u16 ctrl_word; + + status = ice_read_sr_word(hw, ICE_SR_NVM_CTRL_WORD, &ctrl_word); + if (status) { + ice_debug(hw, ICE_DBG_NVM, "Failed to read the Shadow RAM control word\n"); + return status; + } + + /* Check that the control word indicates validity */ + if ((ctrl_word & ICE_SR_CTRL_WORD_1_M) >> ICE_SR_CTRL_WORD_1_S != ICE_SR_CTRL_WORD_VALID) { + ice_debug(hw, ICE_DBG_NVM, "Shadow RAM control word is invalid\n"); + return ICE_ERR_CFG; + } + + if (!(ctrl_word & ICE_SR_CTRL_WORD_NVM_BANK)) + banks->nvm_bank = ICE_1ST_FLASH_BANK; + else + banks->nvm_bank = ICE_2ND_FLASH_BANK; + + if (!(ctrl_word & ICE_SR_CTRL_WORD_OROM_BANK)) + banks->orom_bank = ICE_1ST_FLASH_BANK; + else + banks->orom_bank = ICE_2ND_FLASH_BANK; + + if (!(ctrl_word & ICE_SR_CTRL_WORD_NETLIST_BANK)) + banks->netlist_bank = ICE_1ST_FLASH_BANK; + else + banks->netlist_bank = ICE_2ND_FLASH_BANK; + + status = ice_read_sr_pointer(hw, ICE_SR_1ST_NVM_BANK_PTR, &banks->nvm_ptr); + if (status) { + ice_debug(hw, ICE_DBG_NVM, "Failed to read NVM bank pointer\n"); + return status; + } + + status = ice_read_sr_area_size(hw, ICE_SR_NVM_BANK_SIZE, &banks->nvm_size); + if (status) { + ice_debug(hw, ICE_DBG_NVM, "Failed to read NVM bank area size\n"); + return status; + } + + status = ice_read_sr_pointer(hw, ICE_SR_1ST_OROM_BANK_PTR, &banks->orom_ptr); + if (status) { + ice_debug(hw, ICE_DBG_NVM, "Failed to read OROM bank pointer\n"); + return status; + } + + status = ice_read_sr_area_size(hw, ICE_SR_OROM_BANK_SIZE, &banks->orom_size); + if (status) { + ice_debug(hw, ICE_DBG_NVM, "Failed to read OROM bank area size\n"); + return status; + } + + status = ice_read_sr_pointer(hw, ICE_SR_NETLIST_BANK_PTR, &banks->netlist_ptr); + if (status) { + ice_debug(hw, ICE_DBG_NVM, "Failed to read Netlist bank pointer\n"); + return status; + } + + status = ice_read_sr_area_size(hw, ICE_SR_NETLIST_BANK_SIZE, &banks->netlist_size); + if (status) { + ice_debug(hw, ICE_DBG_NVM, "Failed to read Netlist bank area size\n"); + return status; + } + + return 0; +} + /** * ice_init_nvm - initializes NVM setting * @hw: pointer to the HW struct @@ -643,6 +788,12 @@ enum ice_status ice_init_nvm(struct ice_hw *hw) return status; } + status = ice_determine_active_flash_banks(hw); + if (status) { + ice_debug(hw, ICE_DBG_NVM, "Failed to determine active flash banks.\n"); + return status; + } + status = ice_get_nvm_ver_info(hw, &flash->nvm); if (status) { ice_debug(hw, ICE_DBG_INIT, "Failed to read NVM info.\n"); diff --git a/drivers/net/ethernet/intel/ice/ice_type.h b/drivers/net/ethernet/intel/ice/ice_type.h index 7af7758374d4..bc3be64cf3d9 100644 --- a/drivers/net/ethernet/intel/ice/ice_type.h +++ b/drivers/net/ethernet/intel/ice/ice_type.h @@ -330,11 +330,34 @@ struct ice_netlist_info { u16 cust_ver; /* customer version */ }; +/* Enumeration of possible flash banks for the NVM, OROM, and Netlist modules + * of the flash image. + */ +enum ice_flash_bank { + ICE_INVALID_FLASH_BANK, + ICE_1ST_FLASH_BANK, + ICE_2ND_FLASH_BANK, +}; + +/* information for accessing NVM, OROM, and Netlist flash banks */ +struct ice_bank_info { + u32 nvm_ptr; /* Pointer to 1st NVM bank */ + u32 nvm_size; /* Size of NVM bank */ + u32 orom_ptr; /* Pointer to 1st OROM bank */ + u32 orom_size; /* Size of OROM bank */ + u32 netlist_ptr; /* Pointer to 1st Netlist bank */ + u32 netlist_size; /* Size of Netlist bank */ + enum ice_flash_bank nvm_bank; /* Active NVM bank */ + enum ice_flash_bank orom_bank; /* Active OROM bank */ + enum ice_flash_bank netlist_bank; /* Active Netlist bank */ +}; + /* Flash Chip Information */ struct ice_flash_info { struct ice_orom_info orom; /* Option ROM version info */ struct ice_nvm_info nvm; /* NVM version information */ struct ice_netlist_info netlist;/* Netlist version info */ + struct ice_bank_info banks; /* Flash Bank information */ u16 sr_words; /* Shadow RAM size in words */ u32 flash_size; /* Size of available flash in bytes */ u8 blank_nvm_mode; /* is NVM empty (no FW present) */ @@ -770,6 +793,7 @@ struct ice_hw_port_stats { }; /* Checksum and Shadow RAM pointers */ +#define ICE_SR_NVM_CTRL_WORD 0x00 #define ICE_SR_BOOT_CFG_PTR 0x132 #define ICE_SR_NVM_WOL_CFG 0x19 #define ICE_NVM_OROM_VER_OFF 0x02 @@ -789,10 +813,23 @@ struct ice_hw_port_stats { #define ICE_OROM_VER_MASK (0xff << ICE_OROM_VER_SHIFT) #define ICE_SR_PFA_PTR 0x40 #define ICE_SR_1ST_NVM_BANK_PTR 0x42 +#define ICE_SR_NVM_BANK_SIZE 0x43 #define ICE_SR_1ST_OROM_BANK_PTR 0x44 +#define ICE_SR_OROM_BANK_SIZE 0x45 #define ICE_SR_NETLIST_BANK_PTR 0x46 +#define ICE_SR_NETLIST_BANK_SIZE 0x47 #define ICE_SR_SECTOR_SIZE_IN_WORDS 0x800 +/* Auxiliary field, mask, and shift definition for Shadow RAM and NVM Flash */ +#define ICE_SR_CTRL_WORD_1_S 0x06 +#define ICE_SR_CTRL_WORD_1_M (0x03 << ICE_SR_CTRL_WORD_1_S) +#define ICE_SR_CTRL_WORD_VALID 0x1 +#define ICE_SR_CTRL_WORD_OROM_BANK BIT(3) +#define ICE_SR_CTRL_WORD_NETLIST_BANK BIT(4) +#define ICE_SR_CTRL_WORD_NVM_BANK BIT(5) + +#define ICE_SR_NVM_PTR_4KB_UNITS BIT(15) + /* Link override related */ #define ICE_SR_PFA_LINK_OVERRIDE_WORDS 10 #define ICE_SR_PFA_LINK_OVERRIDE_PHY_WORDS 4