Re: [PATCH] drivers: usb: storage: prefer pr_*() macros over bare printk()

From: Joe Perches
Date: Thu Dec 03 2020 - 12:28:08 EST


On Thu, 2020-12-03 at 15:11 +0100, Enrico Weigelt, metux IT consult
wrote:
> pr_*() printing helpers are preferred over using bare printk().

Please run your proposed patches through checkpatch --strict
and see if any of its bleats are things that should be fixed
at the same time. For this patch:

$ ./scripts/checkpatch.pl --terse --emacs --strict --showfile -
drivers/usb/storage/alauda.c:625: WARNING: Prefer using '"%s...", __func__' to using 'alauda_read_map', this function's name, in a string
drivers/usb/storage/alauda.c:626: WARNING: quoted string split across lines
drivers/usb/storage/alauda.c:645: WARNING: Prefer using '"%s...", __func__' to using 'alauda_read_map', this function's name, in a string
drivers/usb/storage/alauda.c:651: WARNING: Prefer using '"%s...", __func__' to using 'alauda_read_map', this function's name, in a string
drivers/usb/storage/alauda.c:652: WARNING: quoted string split across lines
drivers/usb/storage/alauda.c:820: WARNING: Prefer using '"%s...", __func__' to using 'alauda_write_lba', this function's name, in a string
drivers/usb/storage/alauda.c:826: WARNING: Prefer using '"%s...", __func__' to using 'alauda_write_lba', this function's name, in a string
drivers/usb/storage/ene_ub6250.c:2105: CHECK: Avoid CamelCase: <Insert>
drivers/usb/storage/ene_ub6250.c:2106: CHECK: Avoid CamelCase: <Ready>
drivers/usb/storage/ene_ub6250.c:2107: CHECK: Avoid CamelCase: <IsMSPro>
drivers/usb/storage/ene_ub6250.c:2108: CHECK: Avoid CamelCase: <IsMSPHG>
drivers/usb/storage/ene_ub6250.c:2109: CHECK: Avoid CamelCase: <WtP>
drivers/usb/storage/sddr09.c:871: WARNING: Prefer using '"%s...", __func__' to using 'sddr09_write_lba', this function's name, in a string
drivers/usb/storage/sddr09.c:1238: WARNING: Prefer using '"%s...", __func__' to using 'sddr09_read_map', this function's name, in a string
drivers/usb/storage/sddr09.c:1279: CHECK: Alignment should match open parenthesis
drivers/usb/storage/sddr09.c:1293: WARNING: quoted string split across lines
drivers/usb/storage/sddr09.c:1294: WARNING: quoted string split across lines
drivers/usb/storage/sddr09.c:1303: WARNING: quoted string split across lines
drivers/usb/storage/sddr09.c:1312: WARNING: quoted string split across lines
drivers/usb/storage/sddr55.c:491: CHECK: Alignment should match open parenthesis

> Signed-off-by: Enrico Weigelt, metux IT consult <info@xxxxxxxxx>
> ---
>  drivers/usb/storage/alauda.c | 23 ++++++++------------
>  drivers/usb/storage/ene_ub6250.c | 20 ++++++++---------
>  drivers/usb/storage/freecom.c | 2 +-
>  drivers/usb/storage/sddr09.c | 46 +++++++++++++++++-----------------------
>  drivers/usb/storage/sddr55.c | 7 +++---
>  5 files changed, 43 insertions(+), 55 deletions(-)
>
> diff --git a/drivers/usb/storage/alauda.c b/drivers/usb/storage/alauda.c
> index 20b857e97e60..4453238da87e 100644
> --- a/drivers/usb/storage/alauda.c
> +++ b/drivers/usb/storage/alauda.c
> @@ -622,9 +622,8 @@ static int alauda_read_map(struct us_data *us, unsigned int zone)
>  
>
>   /* check even parity */
>   if (parity[data[6] ^ data[7]]) {
> - printk(KERN_WARNING
> - "alauda_read_map: Bad parity in LBA for block %d"
> - " (%02X %02X)\n", i, data[6], data[7]);
> + pr_warn("alauda_read_map: Bad parity in LBA for block %d"
> + " (%02X %02X)\n", i, data[6], data[7]);
>   pba_to_lba[i] = UNUSABLE;
>   continue;
>   }
> @@ -643,17 +642,15 @@ static int alauda_read_map(struct us_data *us, unsigned int zone)
>   */
>  
>
>   if (lba_offset >= uzonesize) {
> - printk(KERN_WARNING
> - "alauda_read_map: Bad low LBA %d for block %d\n",
> - lba_real, blocknum);
> + pr_warn("alauda_read_map: Bad low LBA %d for block %d\n",
> + lba_real, blocknum);
>   continue;
>   }
>  
>
>   if (lba_to_pba[lba_offset] != UNDEF) {
> - printk(KERN_WARNING
> - "alauda_read_map: "
> - "LBA %d seen for PBA %d and %d\n",
> - lba_real, lba_to_pba[lba_offset], blocknum);
> + pr_warn("alauda_read_map: "
> + "LBA %d seen for PBA %d and %d\n",
> + lba_real, lba_to_pba[lba_offset], blocknum);
>   continue;
>   }
>  
>
> @@ -820,15 +817,13 @@ static int alauda_write_lba(struct us_data *us, u16 lba,
>   * Maybe it is impossible to write to PBA 1.
>   * Fake success, but don't do anything.
>   */
> - printk(KERN_WARNING
> - "alauda_write_lba: avoid writing to pba 1\n");
> + pr_warn("alauda_write_lba: avoid writing to pba 1\n");
>   return USB_STOR_TRANSPORT_GOOD;
>   }
>  
>
>   new_pba = alauda_find_unused_pba(&MEDIA_INFO(us), zone);
>   if (!new_pba) {
> - printk(KERN_WARNING
> - "alauda_write_lba: Out of unused blocks\n");
> + pr_arn("alauda_write_lba: Out of unused blocks\n");
>   return USB_STOR_TRANSPORT_ERROR;
>   }
>  
>
> diff --git a/drivers/usb/storage/ene_ub6250.c b/drivers/usb/storage/ene_ub6250.c
> index 98c1aa594e6c..3d3d42c44570 100644
> --- a/drivers/usb/storage/ene_ub6250.c
> +++ b/drivers/usb/storage/ene_ub6250.c
> @@ -1957,7 +1957,7 @@ static int ms_card_init(struct us_data *us)
>   u32 btBlk1stErred;
>   struct ene_ub6250_info *info = (struct ene_ub6250_info *) us->extra;
>  
>
> - printk(KERN_INFO "MS_CardInit start\n");
> + pr_info("MS_CardInit start\n");
>  
>
>   ms_lib_free_allocatedarea(us); /* Clean buffer and set struct us_data flag to 0 */
>  
>
> @@ -2064,7 +2064,7 @@ static int ms_card_init(struct us_data *us)
>   kfree(PageBuffer1);
>   kfree(PageBuffer0);
>  
>
> - printk(KERN_INFO "MS_CardInit end\n");
> + pr_info("MS_CardInit end\n");
>   return result;
>  }
>  
>
> @@ -2076,13 +2076,13 @@ static int ene_ms_init(struct us_data *us)
>   struct ene_ub6250_info *info = (struct ene_ub6250_info *) us->extra;
>   u8 *bbuf = info->bbuf;
>  
>
> - printk(KERN_INFO "transport --- ENE_MSInit\n");
> + pr_info("transport --- ENE_MSInit\n");
>  
>
>   /* the same part to test ENE */
>  
>
>   result = ene_load_bincode(us, MS_INIT_PATTERN);
>   if (result != USB_STOR_XFER_GOOD) {
> - printk(KERN_ERR "Load MS Init Code Fail !!\n");
> + pr_err("Load MS Init Code Fail !!\n");
>   return USB_STOR_TRANSPORT_ERROR;
>   }
>  
>
> @@ -2095,18 +2095,18 @@ static int ene_ms_init(struct us_data *us)
>  
>
>   result = ene_send_scsi_cmd(us, FDIR_READ, bbuf, 0);
>   if (result != USB_STOR_XFER_GOOD) {
> - printk(KERN_ERR "Execution MS Init Code Fail !!\n");
> + pr_err("Execution MS Init Code Fail !!\n");
>   return USB_STOR_TRANSPORT_ERROR;
>   }
>   /* the same part to test ENE */
>   info->MS_Status = *(struct MS_STATUS *) bbuf;
>  
>
>   if (info->MS_Status.Insert && info->MS_Status.Ready) {
> - printk(KERN_INFO "Insert = %x\n", info->MS_Status.Insert);
> - printk(KERN_INFO "Ready = %x\n", info->MS_Status.Ready);
> - printk(KERN_INFO "IsMSPro = %x\n", info->MS_Status.IsMSPro);
> - printk(KERN_INFO "IsMSPHG = %x\n", info->MS_Status.IsMSPHG);
> - printk(KERN_INFO "WtP= %x\n", info->MS_Status.WtP);
> + pr_info("Insert = %x\n", info->MS_Status.Insert);
> + pr_info("Ready = %x\n", info->MS_Status.Ready);
> + pr_info("IsMSPro = %x\n", info->MS_Status.IsMSPro);
> + pr_info("IsMSPHG = %x\n", info->MS_Status.IsMSPHG);
> + pr_info("WtP= %x\n", info->MS_Status.WtP);
>   if (info->MS_Status.IsMSPro) {
>   MSP_BlockSize = (bbuf[6] << 8) | bbuf[7];
>   MSP_UserAreaBlocks = (bbuf[10] << 8) | bbuf[11];
> diff --git a/drivers/usb/storage/freecom.c b/drivers/usb/storage/freecom.c
> index 3d5f7d0ff0f1..43183a815a66 100644
> --- a/drivers/usb/storage/freecom.c
> +++ b/drivers/usb/storage/freecom.c
> @@ -480,7 +480,7 @@ static int init_freecom(struct us_data *us)
>  
>
>  static int usb_stor_freecom_reset(struct us_data *us)
>  {
> - printk (KERN_CRIT "freecom reset called\n");
> + pr_crit("freecom reset called\n");
>  
>
>   /* We don't really have this feature. */
>   return FAILED;
> diff --git a/drivers/usb/storage/sddr09.c b/drivers/usb/storage/sddr09.c
> index 51bcd4a43690..da1114ee865f 100644
> --- a/drivers/usb/storage/sddr09.c
> +++ b/drivers/usb/storage/sddr09.c
> @@ -868,8 +868,7 @@ sddr09_write_lba(struct us_data *us, unsigned int lba,
>   if (pba == UNDEF) {
>   pba = sddr09_find_unused_pba(info, lba);
>   if (!pba) {
> - printk(KERN_WARNING
> - "sddr09_write_lba: Out of unused blocks\n");
> + pr_warn("sddr09_write_lba: Out of unused blocks\n");
>   return -ENOSPC;
>   }
>   info->pba_to_lba[pba] = lba;
> @@ -881,7 +880,7 @@ sddr09_write_lba(struct us_data *us, unsigned int lba,
>   * Maybe it is impossible to write to PBA 1.
>   * Fake success, but don't do anything.
>   */
> - printk(KERN_WARNING "sddr09: avoid writing to pba 1\n");
> + pr_warn("sddr09: avoid writing to pba 1\n");
>   return 0;
>   }
>  
>
> @@ -1146,7 +1145,7 @@ sddr09_get_cardinfo(struct us_data *us, unsigned char flags) {
>  
>
>   if (result) {
>   usb_stor_dbg(us, "Result of read_deviceID is %d\n", result);
> - printk(KERN_WARNING "sddr09: could not read card info\n");
> + pr_warn("sddr09: could not read card info\n");
>   return NULL;
>   }
>  
>
> @@ -1188,7 +1187,7 @@ sddr09_get_cardinfo(struct us_data *us, unsigned char flags) {
>   sprintf(blurbtxt + strlen(blurbtxt),
>   ", WP");
>  
>
> - printk(KERN_WARNING "%s\n", blurbtxt);
> + pr_warn("%s\n", blurbtxt);
>  
>
>   return cardinfo;
>  }
> @@ -1236,7 +1235,7 @@ sddr09_read_map(struct us_data *us) {
>   info->pba_to_lba = kmalloc_array(numblocks, sizeof(int), GFP_NOIO);
>  
>
>   if (info->lba_to_pba == NULL || info->pba_to_lba == NULL) {
> - printk(KERN_WARNING "sddr09_read_map: out of memory\n");
> + pr_warn("sddr09_read_map: out of memory\n");
>   result = -1;
>   goto done;
>   }
> @@ -1276,7 +1275,7 @@ sddr09_read_map(struct us_data *us) {
>   if (ptr[j] != 0)
>   goto nonz;
>   info->pba_to_lba[i] = UNUSABLE;
> - printk(KERN_WARNING "sddr09: PBA %d has no logical mapping\n",
> + pr_warn("sddr09: PBA %d has no logical mapping\n",
>   i);
>   continue;
>  
>
> @@ -1290,30 +1289,27 @@ sddr09_read_map(struct us_data *us) {
>   nonff:
>   /* normal PBAs start with six FFs */
>   if (j < 6) {
> - printk(KERN_WARNING
> - "sddr09: PBA %d has no logical mapping: "
> - "reserved area = %02X%02X%02X%02X "
> - "data status %02X block status %02X\n",
> - i, ptr[0], ptr[1], ptr[2], ptr[3],
> - ptr[4], ptr[5]);
> + pr_warn("sddr09: PBA %d has no logical mapping: "
> + "reserved area = %02X%02X%02X%02X "
> + "data status %02X block status %02X\n",
> + i, ptr[0], ptr[1], ptr[2], ptr[3],
> + ptr[4], ptr[5]);
>   info->pba_to_lba[i] = UNUSABLE;
>   continue;
>   }
>  
>
>   if ((ptr[6] >> 4) != 0x01) {
> - printk(KERN_WARNING
> - "sddr09: PBA %d has invalid address field "
> - "%02X%02X/%02X%02X\n",
> - i, ptr[6], ptr[7], ptr[11], ptr[12]);
> + pr_warn("sddr09: PBA %d has invalid address field "
> + "%02X%02X/%02X%02X\n",
> + i, ptr[6], ptr[7], ptr[11], ptr[12]);
>   info->pba_to_lba[i] = UNUSABLE;
>   continue;
>   }
>  
>
>   /* check even parity */
>   if (parity[ptr[6] ^ ptr[7]]) {
> - printk(KERN_WARNING
> - "sddr09: Bad parity in LBA for block %d"
> - " (%02X %02X)\n", i, ptr[6], ptr[7]);
> + pr_warn("sddr09: Bad parity in LBA for block %d"
> + " (%02X %02X)\n", i, ptr[6], ptr[7]);
>   info->pba_to_lba[i] = UNUSABLE;
>   continue;
>   }
> @@ -1331,18 +1327,16 @@ sddr09_read_map(struct us_data *us) {
>   */
>  
>
>   if (lba >= 1000) {
> - printk(KERN_WARNING
> - "sddr09: Bad low LBA %d for block %d\n",
> - lba, i);
> + pr_warn("sddr09: Bad low LBA %d for block %d\n",
> + lba, i);
>   goto possibly_erase;
>   }
>  
>
>   lba += 1000*(i/0x400);
>  
>
>   if (info->lba_to_pba[lba] != UNDEF) {
> - printk(KERN_WARNING
> - "sddr09: LBA %d seen for PBA %d and %d\n",
> - lba, info->lba_to_pba[lba], i);
> + pr_warn("sddr09: LBA %d seen for PBA %d and %d\n",
> + lba, info->lba_to_pba[lba], i);
>   goto possibly_erase;
>   }
>  
>
> diff --git a/drivers/usb/storage/sddr55.c b/drivers/usb/storage/sddr55.c
> index 15dc25801cdc..9b5102a1cd9b 100644
> --- a/drivers/usb/storage/sddr55.c
> +++ b/drivers/usb/storage/sddr55.c
> @@ -487,7 +487,7 @@ static int sddr55_write_data(struct us_data *us,
>  
>
>   /* check that new_pba wasn't already being used */
>   if (info->pba_to_lba[new_pba] != UNUSED_BLOCK) {
> - printk(KERN_ERR "sddr55 error: new PBA %04X already in use for LBA %04X\n",
> + pr_err("sddr55 error: new PBA %04X already in use for LBA %04X\n",
>   new_pba, info->pba_to_lba[new_pba]);
>   info->fatal_error = 1;
>   set_sense_info (3, 0x31, 0);
> @@ -741,9 +741,8 @@ static int sddr55_read_map(struct us_data *us) {
>  
>   if (info->lba_to_pba[lba + zone * 1000] != NOT_ALLOCATED &&
>   !info->force_read_only) {
> - printk(KERN_WARNING
> - "sddr55: map inconsistency at LBA %04X\n",
> - lba + zone * 1000);
> + pr_warn("sddr55: map inconsistency at LBA %04X\n",
> + lba + zone * 1000);
>   info->force_read_only = 1;
>   }
>  
>