Re: [PATCH 03/20] drm/nouveau/nvkm/subdev/bios/init: Demote a bunch of kernel-doc abuses

From: Karol Herbst
Date: Thu Aug 24 2023 - 04:43:03 EST


On Thu, Aug 24, 2023 at 9:37 AM Lee Jones <lee@xxxxxxxxxx> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
> drivers/gpu/drm/nouveau/nvkm/subdev/bios/init.c:584: warning: Function parameter or member 'init' not described in 'init_reserved'
> drivers/gpu/drm/nouveau/nvkm/subdev/bios/init.c:611: warning: expecting prototype for INIT_DONE(). Prototype was for init_done() instead
> [Snipped ~140 lines for brevity]
>
> Signed-off-by: Lee Jones <lee@xxxxxxxxxx>
> ---
> Cc: Ben Skeggs <bskeggs@xxxxxxxxxx>
> Cc: Karol Herbst <kherbst@xxxxxxxxxx>
> Cc: Lyude Paul <lyude@xxxxxxxxxx>
> Cc: David Airlie <airlied@xxxxxxxxx>
> Cc: Daniel Vetter <daniel@xxxxxxxx>
> Cc: dri-devel@xxxxxxxxxxxxxxxxxxxxx
> Cc: nouveau@xxxxxxxxxxxxxxxxxxxxx
> ---
> .../gpu/drm/nouveau/nvkm/subdev/bios/init.c | 136 +++++++++---------
> 1 file changed, 68 insertions(+), 68 deletions(-)
>
> diff --git a/drivers/gpu/drm/nouveau/nvkm/subdev/bios/init.c b/drivers/gpu/drm/nouveau/nvkm/subdev/bios/init.c
> index 1420794038642..b54f044c4483b 100644
> --- a/drivers/gpu/drm/nouveau/nvkm/subdev/bios/init.c
> +++ b/drivers/gpu/drm/nouveau/nvkm/subdev/bios/init.c
> @@ -575,7 +575,7 @@ init_tmds_reg(struct nvbios_init *init, u8 tmds)
> * init opcode handlers
> *****************************************************************************/
>
> -/**
> +/*
> * init_reserved - stub for various unknown/unused single-byte opcodes
> *
> */
> @@ -602,7 +602,7 @@ init_reserved(struct nvbios_init *init)
> init->offset += length;
> }
>
> -/**
> +/*
> * INIT_DONE - opcode 0x71
> *
> */
> @@ -613,7 +613,7 @@ init_done(struct nvbios_init *init)
> init->offset = 0x0000;
> }
>
> -/**
> +/*
> * INIT_IO_RESTRICT_PROG - opcode 0x32
> *
> */
> @@ -650,7 +650,7 @@ init_io_restrict_prog(struct nvbios_init *init)
> trace("}]\n");
> }
>
> -/**
> +/*
> * INIT_REPEAT - opcode 0x33
> *
> */
> @@ -676,7 +676,7 @@ init_repeat(struct nvbios_init *init)
> init->repeat = repeat;
> }
>
> -/**
> +/*
> * INIT_IO_RESTRICT_PLL - opcode 0x34
> *
> */
> @@ -716,7 +716,7 @@ init_io_restrict_pll(struct nvbios_init *init)
> trace("}]\n");
> }
>
> -/**
> +/*
> * INIT_END_REPEAT - opcode 0x36
> *
> */
> @@ -732,7 +732,7 @@ init_end_repeat(struct nvbios_init *init)
> }
> }
>
> -/**
> +/*
> * INIT_COPY - opcode 0x37
> *
> */
> @@ -759,7 +759,7 @@ init_copy(struct nvbios_init *init)
> init_wrvgai(init, port, index, data);
> }
>
> -/**
> +/*
> * INIT_NOT - opcode 0x38
> *
> */
> @@ -771,7 +771,7 @@ init_not(struct nvbios_init *init)
> init_exec_inv(init);
> }
>
> -/**
> +/*
> * INIT_IO_FLAG_CONDITION - opcode 0x39
> *
> */
> @@ -788,7 +788,7 @@ init_io_flag_condition(struct nvbios_init *init)
> init_exec_set(init, false);
> }
>
> -/**
> +/*
> * INIT_GENERIC_CONDITION - opcode 0x3a
> *
> */
> @@ -840,7 +840,7 @@ init_generic_condition(struct nvbios_init *init)
> }
> }
>
> -/**
> +/*
> * INIT_IO_MASK_OR - opcode 0x3b
> *
> */
> @@ -859,7 +859,7 @@ init_io_mask_or(struct nvbios_init *init)
> init_wrvgai(init, 0x03d4, index, data &= ~(1 << or));
> }
>
> -/**
> +/*
> * INIT_IO_OR - opcode 0x3c
> *
> */
> @@ -878,7 +878,7 @@ init_io_or(struct nvbios_init *init)
> init_wrvgai(init, 0x03d4, index, data | (1 << or));
> }
>
> -/**
> +/*
> * INIT_ANDN_REG - opcode 0x47
> *
> */
> @@ -895,7 +895,7 @@ init_andn_reg(struct nvbios_init *init)
> init_mask(init, reg, mask, 0);
> }
>
> -/**
> +/*
> * INIT_OR_REG - opcode 0x48
> *
> */
> @@ -912,7 +912,7 @@ init_or_reg(struct nvbios_init *init)
> init_mask(init, reg, 0, mask);
> }
>
> -/**
> +/*
> * INIT_INDEX_ADDRESS_LATCHED - opcode 0x49
> *
> */
> @@ -942,7 +942,7 @@ init_idx_addr_latched(struct nvbios_init *init)
> }
> }
>
> -/**
> +/*
> * INIT_IO_RESTRICT_PLL2 - opcode 0x4a
> *
> */
> @@ -977,7 +977,7 @@ init_io_restrict_pll2(struct nvbios_init *init)
> trace("}]\n");
> }
>
> -/**
> +/*
> * INIT_PLL2 - opcode 0x4b
> *
> */
> @@ -994,7 +994,7 @@ init_pll2(struct nvbios_init *init)
> init_prog_pll(init, reg, freq);
> }
>
> -/**
> +/*
> * INIT_I2C_BYTE - opcode 0x4c
> *
> */
> @@ -1025,7 +1025,7 @@ init_i2c_byte(struct nvbios_init *init)
> }
> }
>
> -/**
> +/*
> * INIT_ZM_I2C_BYTE - opcode 0x4d
> *
> */
> @@ -1051,7 +1051,7 @@ init_zm_i2c_byte(struct nvbios_init *init)
> }
> }
>
> -/**
> +/*
> * INIT_ZM_I2C - opcode 0x4e
> *
> */
> @@ -1085,7 +1085,7 @@ init_zm_i2c(struct nvbios_init *init)
> }
> }
>
> -/**
> +/*
> * INIT_TMDS - opcode 0x4f
> *
> */
> @@ -1111,7 +1111,7 @@ init_tmds(struct nvbios_init *init)
> init_wr32(init, reg + 0, addr);
> }
>
> -/**
> +/*
> * INIT_ZM_TMDS_GROUP - opcode 0x50
> *
> */
> @@ -1138,7 +1138,7 @@ init_zm_tmds_group(struct nvbios_init *init)
> }
> }
>
> -/**
> +/*
> * INIT_CR_INDEX_ADDRESS_LATCHED - opcode 0x51
> *
> */
> @@ -1168,7 +1168,7 @@ init_cr_idx_adr_latch(struct nvbios_init *init)
> init_wrvgai(init, 0x03d4, addr0, save0);
> }
>
> -/**
> +/*
> * INIT_CR - opcode 0x52
> *
> */
> @@ -1188,7 +1188,7 @@ init_cr(struct nvbios_init *init)
> init_wrvgai(init, 0x03d4, addr, val | data);
> }
>
> -/**
> +/*
> * INIT_ZM_CR - opcode 0x53
> *
> */
> @@ -1205,7 +1205,7 @@ init_zm_cr(struct nvbios_init *init)
> init_wrvgai(init, 0x03d4, addr, data);
> }
>
> -/**
> +/*
> * INIT_ZM_CR_GROUP - opcode 0x54
> *
> */
> @@ -1229,7 +1229,7 @@ init_zm_cr_group(struct nvbios_init *init)
> }
> }
>
> -/**
> +/*
> * INIT_CONDITION_TIME - opcode 0x56
> *
> */
> @@ -1256,7 +1256,7 @@ init_condition_time(struct nvbios_init *init)
> init_exec_set(init, false);
> }
>
> -/**
> +/*
> * INIT_LTIME - opcode 0x57
> *
> */
> @@ -1273,7 +1273,7 @@ init_ltime(struct nvbios_init *init)
> mdelay(msec);
> }
>
> -/**
> +/*
> * INIT_ZM_REG_SEQUENCE - opcode 0x58
> *
> */
> @@ -1298,7 +1298,7 @@ init_zm_reg_sequence(struct nvbios_init *init)
> }
> }
>
> -/**
> +/*
> * INIT_PLL_INDIRECT - opcode 0x59
> *
> */
> @@ -1317,7 +1317,7 @@ init_pll_indirect(struct nvbios_init *init)
> init_prog_pll(init, reg, freq);
> }
>
> -/**
> +/*
> * INIT_ZM_REG_INDIRECT - opcode 0x5a
> *
> */
> @@ -1336,7 +1336,7 @@ init_zm_reg_indirect(struct nvbios_init *init)
> init_wr32(init, addr, data);
> }
>
> -/**
> +/*
> * INIT_SUB_DIRECT - opcode 0x5b
> *
> */
> @@ -1362,7 +1362,7 @@ init_sub_direct(struct nvbios_init *init)
> init->offset += 3;
> }
>
> -/**
> +/*
> * INIT_JUMP - opcode 0x5c
> *
> */
> @@ -1380,7 +1380,7 @@ init_jump(struct nvbios_init *init)
> init->offset += 3;
> }
>
> -/**
> +/*
> * INIT_I2C_IF - opcode 0x5e
> *
> */
> @@ -1407,7 +1407,7 @@ init_i2c_if(struct nvbios_init *init)
> init_exec_force(init, false);
> }
>
> -/**
> +/*
> * INIT_COPY_NV_REG - opcode 0x5f
> *
> */
> @@ -1433,7 +1433,7 @@ init_copy_nv_reg(struct nvbios_init *init)
> init_mask(init, dreg, ~dmask, (data & smask) ^ sxor);
> }
>
> -/**
> +/*
> * INIT_ZM_INDEX_IO - opcode 0x62
> *
> */
> @@ -1451,7 +1451,7 @@ init_zm_index_io(struct nvbios_init *init)
> init_wrvgai(init, port, index, data);
> }
>
> -/**
> +/*
> * INIT_COMPUTE_MEM - opcode 0x63
> *
> */
> @@ -1469,7 +1469,7 @@ init_compute_mem(struct nvbios_init *init)
> init_exec_force(init, false);
> }
>
> -/**
> +/*
> * INIT_RESET - opcode 0x65
> *
> */
> @@ -1496,7 +1496,7 @@ init_reset(struct nvbios_init *init)
> init_exec_force(init, false);
> }
>
> -/**
> +/*
> * INIT_CONFIGURE_MEM - opcode 0x66
> *
> */
> @@ -1555,7 +1555,7 @@ init_configure_mem(struct nvbios_init *init)
> init_exec_force(init, false);
> }
>
> -/**
> +/*
> * INIT_CONFIGURE_CLK - opcode 0x67
> *
> */
> @@ -1589,7 +1589,7 @@ init_configure_clk(struct nvbios_init *init)
> init_exec_force(init, false);
> }
>
> -/**
> +/*
> * INIT_CONFIGURE_PREINIT - opcode 0x68
> *
> */
> @@ -1615,7 +1615,7 @@ init_configure_preinit(struct nvbios_init *init)
> init_exec_force(init, false);
> }
>
> -/**
> +/*
> * INIT_IO - opcode 0x69
> *
> */
> @@ -1655,7 +1655,7 @@ init_io(struct nvbios_init *init)
> init_wrport(init, port, data | value);
> }
>
> -/**
> +/*
> * INIT_SUB - opcode 0x6b
> *
> */
> @@ -1682,7 +1682,7 @@ init_sub(struct nvbios_init *init)
> init->offset += 2;
> }
>
> -/**
> +/*
> * INIT_RAM_CONDITION - opcode 0x6d
> *
> */
> @@ -1701,7 +1701,7 @@ init_ram_condition(struct nvbios_init *init)
> init_exec_set(init, false);
> }
>
> -/**
> +/*
> * INIT_NV_REG - opcode 0x6e
> *
> */
> @@ -1719,7 +1719,7 @@ init_nv_reg(struct nvbios_init *init)
> init_mask(init, reg, ~mask, data);
> }
>
> -/**
> +/*
> * INIT_MACRO - opcode 0x6f
> *
> */
> @@ -1743,7 +1743,7 @@ init_macro(struct nvbios_init *init)
> init->offset += 2;
> }
>
> -/**
> +/*
> * INIT_RESUME - opcode 0x72
> *
> */
> @@ -1755,7 +1755,7 @@ init_resume(struct nvbios_init *init)
> init_exec_set(init, true);
> }
>
> -/**
> +/*
> * INIT_STRAP_CONDITION - opcode 0x73
> *
> */
> @@ -1773,7 +1773,7 @@ init_strap_condition(struct nvbios_init *init)
> init_exec_set(init, false);
> }
>
> -/**
> +/*
> * INIT_TIME - opcode 0x74
> *
> */
> @@ -1794,7 +1794,7 @@ init_time(struct nvbios_init *init)
> }
> }
>
> -/**
> +/*
> * INIT_CONDITION - opcode 0x75
> *
> */
> @@ -1811,7 +1811,7 @@ init_condition(struct nvbios_init *init)
> init_exec_set(init, false);
> }
>
> -/**
> +/*
> * INIT_IO_CONDITION - opcode 0x76
> *
> */
> @@ -1828,7 +1828,7 @@ init_io_condition(struct nvbios_init *init)
> init_exec_set(init, false);
> }
>
> -/**
> +/*
> * INIT_ZM_REG16 - opcode 0x77
> *
> */
> @@ -1845,7 +1845,7 @@ init_zm_reg16(struct nvbios_init *init)
> init_wr32(init, addr, data);
> }
>
> -/**
> +/*
> * INIT_INDEX_IO - opcode 0x78
> *
> */
> @@ -1867,7 +1867,7 @@ init_index_io(struct nvbios_init *init)
> init_wrvgai(init, port, index, data | value);
> }
>
> -/**
> +/*
> * INIT_PLL - opcode 0x79
> *
> */
> @@ -1884,7 +1884,7 @@ init_pll(struct nvbios_init *init)
> init_prog_pll(init, reg, freq);
> }
>
> -/**
> +/*
> * INIT_ZM_REG - opcode 0x7a
> *
> */
> @@ -1904,7 +1904,7 @@ init_zm_reg(struct nvbios_init *init)
> init_wr32(init, addr, data);
> }
>
> -/**
> +/*
> * INIT_RAM_RESTRICT_PLL - opcde 0x87
> *
> */
> @@ -1934,7 +1934,7 @@ init_ram_restrict_pll(struct nvbios_init *init)
> }
> }
>
> -/**
> +/*
> * INIT_RESET_BEGUN - opcode 0x8c
> *
> */
> @@ -1945,7 +1945,7 @@ init_reset_begun(struct nvbios_init *init)
> init->offset += 1;
> }
>
> -/**
> +/*
> * INIT_RESET_END - opcode 0x8d
> *
> */
> @@ -1956,7 +1956,7 @@ init_reset_end(struct nvbios_init *init)
> init->offset += 1;
> }
>
> -/**
> +/*
> * INIT_GPIO - opcode 0x8e
> *
> */
> @@ -1972,7 +1972,7 @@ init_gpio(struct nvbios_init *init)
> nvkm_gpio_reset(gpio, DCB_GPIO_UNUSED);
> }
>
> -/**
> +/*
> * INIT_RAM_RESTRICT_ZM_GROUP - opcode 0x8f
> *
> */
> @@ -2010,7 +2010,7 @@ init_ram_restrict_zm_reg_group(struct nvbios_init *init)
> }
> }
>
> -/**
> +/*
> * INIT_COPY_ZM_REG - opcode 0x90
> *
> */
> @@ -2027,7 +2027,7 @@ init_copy_zm_reg(struct nvbios_init *init)
> init_wr32(init, dreg, init_rd32(init, sreg));
> }
>
> -/**
> +/*
> * INIT_ZM_REG_GROUP - opcode 0x91
> *
> */
> @@ -2049,7 +2049,7 @@ init_zm_reg_group(struct nvbios_init *init)
> }
> }
>
> -/**
> +/*
> * INIT_XLAT - opcode 0x96
> *
> */
> @@ -2077,7 +2077,7 @@ init_xlat(struct nvbios_init *init)
> init_mask(init, daddr, ~dmask, data);
> }
>
> -/**
> +/*
> * INIT_ZM_MASK_ADD - opcode 0x97
> *
> */
> @@ -2098,7 +2098,7 @@ init_zm_mask_add(struct nvbios_init *init)
> init_wr32(init, addr, data);
> }
>
> -/**
> +/*
> * INIT_AUXCH - opcode 0x98
> *
> */
> @@ -2122,7 +2122,7 @@ init_auxch(struct nvbios_init *init)
> }
> }
>
> -/**
> +/*
> * INIT_AUXCH - opcode 0x99
> *
> */
> @@ -2144,7 +2144,7 @@ init_zm_auxch(struct nvbios_init *init)
> }
> }
>
> -/**
> +/*
> * INIT_I2C_LONG_IF - opcode 0x9a
> *
> */
> @@ -2183,7 +2183,7 @@ init_i2c_long_if(struct nvbios_init *init)
> init_exec_set(init, false);
> }
>
> -/**
> +/*
> * INIT_GPIO_NE - opcode 0xa9
> *
> */
> --
> 2.42.0.rc1.204.g551eb34607-goog
>

Reviewed-by: Karol Herbst <kherbst@xxxxxxxxxx>