| Message ID | 20200915014455.1232507-10-jesse.brandeburg@intel.com |
|---|---|
| State | New |
| Headers | show |
| Series | make drivers/net/ethernet W=1 clean | expand |
On 15/09/2020 02:44, Jesse Brandeburg wrote: > kernel-doc script as used by W=1, is confused by the macro > usage inside the header describing the efx_ptp_data struct. > > drivers/net/ethernet/sfc/ptp.c:345: warning: Function parameter or member 'MC_CMD_PTP_IN_TRANSMIT_LENMAX' not described in 'efx_ptp_data' > > After some discussion on the list, break this patch out to > a separate one, and fix the issue through a creative > macro declaration. > > Signed-off-by: Jesse Brandeburg <jesse.brandeburg@intel.com> > Cc: Edward Cree <ecree@solarflare.com> I still don't love it, but it'll do, so have an Acked-by: Edward Cree <ecree@solarflare.com> (But please make sure whoever maintains scripts/kernel-doc knows that it's breaking on a reasonable construct and forcing the code to be _less_ self-documenting than it otherwise could be.)
diff --git a/drivers/net/ethernet/sfc/mcdi.h b/drivers/net/ethernet/sfc/mcdi.h index ef6d21e4bd0b..69c2924a147c 100644 --- a/drivers/net/ethernet/sfc/mcdi.h +++ b/drivers/net/ethernet/sfc/mcdi.h @@ -190,6 +190,7 @@ void efx_mcdi_sensor_event(struct efx_nic *efx, efx_qword_t *ev); * 32-bit-aligned. Also, on Siena we must copy to the MC shared * memory strictly 32 bits at a time, so add any necessary padding. */ +#define MCDI_TX_BUF_LEN(_len) DIV_ROUND_UP((_len), 4) #define _MCDI_DECLARE_BUF(_name, _len) \ efx_dword_t _name[DIV_ROUND_UP(_len, 4)] #define MCDI_DECLARE_BUF(_name, _len) \ diff --git a/drivers/net/ethernet/sfc/ptp.c b/drivers/net/ethernet/sfc/ptp.c index bea4725a4499..a5f0c943a9bf 100644 --- a/drivers/net/ethernet/sfc/ptp.c +++ b/drivers/net/ethernet/sfc/ptp.c @@ -325,7 +325,7 @@ struct efx_ptp_data { struct work_struct pps_work; struct workqueue_struct *pps_workwq; bool nic_ts_enabled; - _MCDI_DECLARE_BUF(txbuf, MC_CMD_PTP_IN_TRANSMIT_LENMAX); + efx_dword_t txbuf[MCDI_TX_BUF_LEN(MC_CMD_PTP_IN_TRANSMIT_LENMAX)]; unsigned int good_syncs; unsigned int fast_syncs;
kernel-doc script as used by W=1, is confused by the macro usage inside the header describing the efx_ptp_data struct. drivers/net/ethernet/sfc/ptp.c:345: warning: Function parameter or member 'MC_CMD_PTP_IN_TRANSMIT_LENMAX' not described in 'efx_ptp_data' After some discussion on the list, break this patch out to a separate one, and fix the issue through a creative macro declaration. Signed-off-by: Jesse Brandeburg <jesse.brandeburg@intel.com> Cc: Edward Cree <ecree@solarflare.com> --- drivers/net/ethernet/sfc/mcdi.h | 1 + drivers/net/ethernet/sfc/ptp.c | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-)