tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

spi: spi-mem: clean up kernel-doc in spi-mem.h

Eliminate all kernel-doc warnings in spi-mem.h:
- add missing struct member descriptions
- don't use "struct" for function descrptions

Warning: include/linux/spi/spi-mem.h:202 struct member 'cmd' not described
in 'spi_mem_op'
Warning: include/linux/spi/spi-mem.h:202 struct member 'addr' not described
in 'spi_mem_op'
Warning: include/linux/spi/spi-mem.h:202 struct member 'dummy' not
described in 'spi_mem_op'
Warning: include/linux/spi/spi-mem.h:202 struct member 'data' not described
in 'spi_mem_op'

Warning: include/linux/spi/spi-mem.h:286 Incorrect use of kernel-doc
format: * struct spi_mem_get_drvdata() - get driver private data
attached to a SPI mem
Warning: include/linux/spi/spi-mem.h:298 Incorrect use of kernel-doc
format: * struct spi_controller_mem_ops - SPI memory operations
Warning: include/linux/spi/spi-mem.h:362 expecting prototype for struct
spi_mem_set_drvdata. Prototype was for struct spi_controller_mem_ops instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://patch.msgid.link/20260301014743.3133167-1-rdunlap@infradead.org
Signed-off-by: Mark Brown <broonie@kernel.org>

authored by

Randy Dunlap and committed by
Mark Brown d3b693a1 463279e5

+6 -2
+6 -2
include/linux/spi/spi-mem.h
··· 130 130 131 131 /** 132 132 * struct spi_mem_op - describes a SPI memory operation 133 + * @cmd: the complete command 133 134 * @cmd.nbytes: number of opcode bytes (only 1 or 2 are valid). The opcode is 134 135 * sent MSB-first. 135 136 * @cmd.buswidth: number of IO lines used to transmit the command 136 137 * @cmd.opcode: operation opcode 137 138 * @cmd.dtr: whether the command opcode should be sent in DTR mode or not 139 + * @addr: the address attributes 138 140 * @addr.nbytes: number of address bytes to send. Can be zero if the operation 139 141 * does not need to send an address 140 142 * @addr.buswidth: number of IO lines used to transmit the address cycles ··· 145 143 * Note that only @addr.nbytes are taken into account in this 146 144 * address value, so users should make sure the value fits in the 147 145 * assigned number of bytes. 146 + * @dummy: data for dummy operation 148 147 * @dummy.nbytes: number of dummy bytes to send after an opcode or address. Can 149 148 * be zero if the operation does not require dummy bytes 150 149 * @dummy.buswidth: number of IO lanes used to transmit the dummy bytes 151 150 * @dummy.dtr: whether the dummy bytes should be sent in DTR mode or not 151 + * @data: the data attributes 152 152 * @data.buswidth: number of IO lanes used to send/receive the data 153 153 * @data.dtr: whether the data should be sent in DTR mode or not 154 154 * @data.ecc: whether error correction is required or not ··· 277 273 }; 278 274 279 275 /** 280 - * struct spi_mem_set_drvdata() - attach driver private data to a SPI mem 276 + * spi_mem_set_drvdata() - attach driver private data to a SPI mem 281 277 * device 282 278 * @mem: memory device 283 279 * @data: data to attach to the memory device ··· 288 284 } 289 285 290 286 /** 291 - * struct spi_mem_get_drvdata() - get driver private data attached to a SPI mem 287 + * spi_mem_get_drvdata() - get driver private data attached to a SPI mem 292 288 * device 293 289 * @mem: memory device 294 290 *