Skip to content

Commit 20e20b1

Browse files
rddunlapij-intel
authored andcommitted
platform/x86/intel/vsec: correct kernel-doc comments
Fix kernel-doc warnings in intel_vsec.h to eliminate all kernel-doc warnings: Warning: include/linux/intel_vsec.h:92 struct member 'read_telem' not described in 'pmt_callbacks' Warning: include/linux/intel_vsec.h:146 expecting prototype for struct intel_sec_device. Prototype was for struct intel_vsec_device instead Warning: include/linux/intel_vsec.h:146 struct member 'priv_data_size' not described in 'intel_vsec_device' In struct pmt_callbacks, correct the kernel-doc for @read_telem. kernel-doc doesn't support documenting callback function parameters, so drop the '@' signs on those and use "* *" to make them somewhat readable in the produced documentation output. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Link: https://patch.msgid.link/20251216063801.2896495-1-rdunlap@infradead.org Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com> Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
1 parent 15dd100 commit 20e20b1

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

include/linux/intel_vsec.h

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,13 @@ enum intel_vsec_quirks {
8080

8181
/**
8282
* struct pmt_callbacks - Callback infrastructure for PMT devices
83-
* ->read_telem() when specified, called by client driver to access PMT data (instead
84-
* of direct copy).
85-
* @pdev: PCI device reference for the callback's use
86-
* @guid: ID of data to acccss
87-
* @data: buffer for the data to be copied
88-
* @off: offset into the requested buffer
89-
* @count: size of buffer
83+
* @read_telem: when specified, called by client driver to access PMT
84+
* data (instead of direct copy).
85+
* * pdev: PCI device reference for the callback's use
86+
* * guid: ID of data to acccss
87+
* * data: buffer for the data to be copied
88+
* * off: offset into the requested buffer
89+
* * count: size of buffer
9090
*/
9191
struct pmt_callbacks {
9292
int (*read_telem)(struct pci_dev *pdev, u32 guid, u64 *data, loff_t off, u32 count);
@@ -120,14 +120,15 @@ struct intel_vsec_platform_info {
120120
};
121121

122122
/**
123-
* struct intel_sec_device - Auxbus specific device information
123+
* struct intel_vsec_device - Auxbus specific device information
124124
* @auxdev: auxbus device struct for auxbus access
125125
* @pcidev: pci device associated with the device
126126
* @resource: any resources shared by the parent
127127
* @ida: id reference
128128
* @num_resources: number of resources
129129
* @id: xarray id
130130
* @priv_data: any private data needed
131+
* @priv_data_size: size of private data area
131132
* @quirks: specified quirks
132133
* @base_addr: base address of entries (if specified)
133134
* @cap_id: the enumerated id of the vsec feature

0 commit comments

Comments
 (0)