Re: [PATCH v6 2/3] greybus: Add BeaglePlay Linux Driver

[kernel test robot <lkp@intel.com>]

Hi Ayush,

kernel test robot noticed the following build warnings:

[auto build test WARNING on 6269320850097903b30be8f07a5c61d9f7592393]

url:    https://github.com/intel-lab-lkp/linux/commits/Ayush-Singh/dt-bindings-Add-beaglecc1352/20231003-031225
base:   6269320850097903b30be8f07a5c61d9f7592393
patch link:    https://lore.kernel.org/r/20231002182454.211165-3-ayushdevel1325%40gmail.com
patch subject: [PATCH v6 2/3] greybus: Add BeaglePlay Linux Driver
config: sh-allmodconfig (https://download.01.org/0day-ci/archive/20231003/202310031521.Iq3S1RE9-lkp@intel.com/config)
compiler: sh4-linux-gcc (GCC) 13.2.0
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20231003/202310031521.Iq3S1RE9-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202310031521.Iq3S1RE9-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> drivers/greybus/gb-beagleplay.c:45: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * BeaglePlay Greybus driver
   drivers/greybus/gb-beagleplay.c:78: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Structure to represent part of HDCL frame payload data.
   drivers/greybus/gb-beagleplay.c:107: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Consume HDLC Buffer. This function assumes that consumer lock has been acquired.
   drivers/greybus/gb-beagleplay.c:127: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Queue HDLC data for sending. This function assumes that producer lock as been acquired.


vim +45 drivers/greybus/gb-beagleplay.c

    43	
    44	/**
  > 45	 * BeaglePlay Greybus driver
    46	 *
    47	 * @sd: underlying serdev device
    48	 *
    49	 * @gb_hd: greybus host device of this driver
    50	 *
    51	 * @tx_work: hdlc transmit work
    52	 * @tx_producer_lock: hdlc transmit data producer lock. acquired when appending data to buffer.
    53	 * @tx_consumer_lock: hdlc transmit data consumer lock. acquired when sending data over uart.
    54	 * @tx_circ_buf: hdlc transmit circular buffer.
    55	 * @tx_crc: hdlc transmit crc-ccitt fcs
    56	 *
    57	 * @rx_buffer_len: length of receive buffer filled.
    58	 * @rx_buffer: hdlc frame receive buffer
    59	 * @rx_in_esc: hdlc rx flag to indicate ESC frame
    60	 */
    61	struct gb_beagleplay {
    62		struct serdev_device *sd;
    63	
    64		struct gb_host_device *gb_hd;
    65	
    66		struct work_struct tx_work;
    67		spinlock_t tx_producer_lock;
    68		spinlock_t tx_consumer_lock;
    69		struct circ_buf tx_circ_buf;
    70		u16 tx_crc;
    71	
    72		u16 rx_buffer_len;
    73		bool rx_in_esc;
    74		u8 rx_buffer[MAX_RX_HDLC];
    75	};
    76	

-- 
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki