net/ice/base: cleanup misleading comment
authorQi Zhang <qi.z.zhang@intel.com>
Wed, 26 Aug 2020 06:42:19 +0000 (14:42 +0800)
committerFerruh Yigit <ferruh.yigit@intel.com>
Fri, 18 Sep 2020 16:55:09 +0000 (18:55 +0200)
The maximum Admin Queue buffer size and NVM shadow RAM sector size are
both 4 Kilobytes. Some comments refer to those as 4Kb which can be
confused with 4 Kilobits.
Update the comments to use the commonly used KB symbol instead.

Signed-off-by: Bruce Allan <bruce.w.allan@intel.com>
Signed-off-by: Qi Zhang <qi.z.zhang@intel.com>
Acked-by: Qiming Yang <qiming.yang@intel.com>
drivers/net/ice/base/ice_nvm.c

index bfeade6..2befe68 100644 (file)
@@ -58,7 +58,7 @@ ice_aq_read_nvm(struct ice_hw *hw, u16 module_typeid, u32 offset, u16 length,
  *
  * Reads a portion of the NVM, as a flat memory space. This function correctly
  * breaks read requests across Shadow RAM sectors and ensures that no single
- * read request exceeds the maximum 4Kb read for a single AdminQ command.
+ * read request exceeds the maximum 4KB read for a single AdminQ command.
  *
  * Returns a status code on failure. Note that the data pointer may be
  * partially updated if some reads succeed before a failure.
@@ -86,10 +86,10 @@ ice_read_flat_nvm(struct ice_hw *hw, u32 offset, u32 *length, u8 *data,
        do {
                u32 read_size, sector_offset;
 
-               /* ice_aq_read_nvm cannot read more than 4Kb at a time.
+               /* ice_aq_read_nvm cannot read more than 4KB at a time.
                 * Additionally, a read from the Shadow RAM may not cross over
                 * a sector boundary. Conveniently, the sector size is also
-                * 4Kb.
+                * 4KB.
                 */
                sector_offset = offset % ICE_AQ_MAX_BUF_LEN;
                read_size = MIN_T(u32, ICE_AQ_MAX_BUF_LEN - sector_offset,
@@ -164,7 +164,7 @@ ice_read_sr_buf_aq(struct ice_hw *hw, u16 offset, u16 *words, u16 *data)
 
        ice_debug(hw, ICE_DBG_TRACE, "%s\n", __func__);
 
-       /* ice_read_flat_nvm takes into account the 4Kb AdminQ and Shadow RAM
+       /* ice_read_flat_nvm takes into account the 4KB AdminQ and Shadow RAM
         * sector restrictions necessary when reading from the NVM.
         */
        status = ice_read_flat_nvm(hw, offset * 2, &bytes, (u8 *)data, true);