Skip to content

Commit 5f20bc2

Browse files
rddunlapij-intel
authored andcommitted
platform/x86: ISST: isst_if.h: fix all kernel-doc warnings
Fix all kernel-doc warnings in <uapi/linux/isst_if.h>: - don't use "[]" in the variable name in kernel-doc - add a few missing entries - change "power_domain" to "power_domain_id" in kernel-doc to match the struct member name - add a leading '@' on a few existing kernel-doc lines - use '_' instead of '-' in struct member names Examples (but not all 27 warnings): Warning: include/uapi/linux/isst_if.h:63 struct member 'cpu_map' not described in 'isst_if_cpu_maps' Warning: ../include/uapi/linux/isst_if.h:95 struct member 'req_count' not described in 'isst_if_io_regs' Warning: include/uapi/linux/isst_if.h:132 struct member 'mbox_cmd' not described in 'isst_if_mbox_cmds' Warning: ../include/uapi/linux/isst_if.h:183 struct member 'supported' not described in 'isst_core_power' Warning: ../include/uapi/linux/isst_if.h:206 struct member 'power_domain_id' not described in 'isst_clos_param' Warning: ../include/uapi/linux/isst_if.h:239 struct member 'assoc_info' not described in 'isst_if_clos_assoc_cmds' Warning: ../include/uapi/linux/isst_if.h:286 struct member 'sst_tf_support' not described in 'isst_perf_level_info' Warning: ../include/uapi/linux/isst_if.h:375 struct member 'trl_freq_mhz' not described in 'isst_perf_level_data_info' Warning: ../include/uapi/linux/isst_if.h:475 struct member 'max_buckets' not described in 'isst_turbo_freq_info' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Link: https://patch.msgid.link/20251023194615.180824-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 a229809 commit 5f20bc2

1 file changed

Lines changed: 27 additions & 23 deletions

File tree

include/uapi/linux/isst_if.h

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ struct isst_if_cpu_map {
5252
/**
5353
* struct isst_if_cpu_maps - structure for CPU map IOCTL
5454
* @cmd_count: Number of CPU mapping command in cpu_map[]
55-
* @cpu_map[]: Holds one or more CPU map data structure
55+
* @cpu_map: Holds one or more CPU map data structure
5656
*
5757
* This structure used with ioctl ISST_IF_GET_PHY_ID to send
5858
* one or more CPU mapping commands. Here IOCTL return value indicates
@@ -82,8 +82,8 @@ struct isst_if_io_reg {
8282

8383
/**
8484
* struct isst_if_io_regs - structure for IO register commands
85-
* @cmd_count: Number of io reg commands in io_reg[]
86-
* @io_reg[]: Holds one or more io_reg command structure
85+
* @req_count: Number of io reg commands in io_reg[]
86+
* @io_reg: Holds one or more io_reg command structure
8787
*
8888
* This structure used with ioctl ISST_IF_IO_CMD to send
8989
* one or more read/write commands to PUNIT. Here IOCTL return value
@@ -120,7 +120,7 @@ struct isst_if_mbox_cmd {
120120
/**
121121
* struct isst_if_mbox_cmds - structure for mailbox commands
122122
* @cmd_count: Number of mailbox commands in mbox_cmd[]
123-
* @mbox_cmd[]: Holds one or more mbox commands
123+
* @mbox_cmd: Holds one or more mbox commands
124124
*
125125
* This structure used with ioctl ISST_IF_MBOX_COMMAND to send
126126
* one or more mailbox commands to PUNIT. Here IOCTL return value
@@ -152,7 +152,7 @@ struct isst_if_msr_cmd {
152152
/**
153153
* struct isst_if_msr_cmds - structure for msr commands
154154
* @cmd_count: Number of mailbox commands in msr_cmd[]
155-
* @msr_cmd[]: Holds one or more msr commands
155+
* @msr_cmd: Holds one or more msr commands
156156
*
157157
* This structure used with ioctl ISST_IF_MSR_COMMAND to send
158158
* one or more MSR commands. IOCTL return value indicates number of
@@ -167,8 +167,9 @@ struct isst_if_msr_cmds {
167167
* struct isst_core_power - Structure to get/set core_power feature
168168
* @get_set: 0: Get, 1: Set
169169
* @socket_id: Socket/package id
170-
* @power_domain: Power Domain id
170+
* @power_domain_id: Power Domain id
171171
* @enable: Feature enable status
172+
* @supported: Power domain supports SST_CP interface
172173
* @priority_type: Priority type for the feature (ordered/proportional)
173174
*
174175
* Structure to get/set core_power feature state using IOCTL
@@ -187,11 +188,11 @@ struct isst_core_power {
187188
* struct isst_clos_param - Structure to get/set clos praram
188189
* @get_set: 0: Get, 1: Set
189190
* @socket_id: Socket/package id
190-
* @power_domain: Power Domain id
191-
* clos: Clos ID for the parameters
192-
* min_freq_mhz: Minimum frequency in MHz
193-
* max_freq_mhz: Maximum frequency in MHz
194-
* prop_prio: Proportional priority from 0-15
191+
* @power_domain_id: Power Domain id
192+
* @clos: Clos ID for the parameters
193+
* @min_freq_mhz: Minimum frequency in MHz
194+
* @max_freq_mhz: Maximum frequency in MHz
195+
* @prop_prio: Proportional priority from 0-15
195196
*
196197
* Structure to get/set per clos property using IOCTL
197198
* ISST_IF_CLOS_PARAM.
@@ -209,7 +210,7 @@ struct isst_clos_param {
209210
/**
210211
* struct isst_if_clos_assoc - Structure to assign clos to a CPU
211212
* @socket_id: Socket/package id
212-
* @power_domain: Power Domain id
213+
* @power_domain_id: Power Domain id
213214
* @logical_cpu: CPU number
214215
* @clos: Clos ID to assign to the logical CPU
215216
*
@@ -228,6 +229,7 @@ struct isst_if_clos_assoc {
228229
* @get_set: Request is for get or set
229230
* @punit_cpu_map: Set to 1 if the CPU number is punit numbering not
230231
* Linux CPU number
232+
* @assoc_info: CLOS data for this CPU
231233
*
232234
* Structure used to get/set associate CPUs to clos using IOCTL
233235
* ISST_IF_CLOS_ASSOC.
@@ -257,7 +259,7 @@ struct isst_tpmi_instance_count {
257259
/**
258260
* struct isst_perf_level_info - Structure to get information on SST-PP levels
259261
* @socket_id: Socket/package id
260-
* @power_domain: Power Domain id
262+
* @power_domain_id: Power Domain id
261263
* @logical_cpu: CPU number
262264
* @clos: Clos ID to assign to the logical CPU
263265
* @max_level: Maximum performance level supported by the platform
@@ -267,8 +269,8 @@ struct isst_tpmi_instance_count {
267269
* @feature_state: SST-BF and SST-TF (enabled/disabled) status at current level
268270
* @locked: SST-PP performance level change is locked/unlocked
269271
* @enabled: SST-PP feature is enabled or not
270-
* @sst-tf_support: SST-TF support status at this level
271-
* @sst-bf_support: SST-BF support status at this level
272+
* @sst_tf_support: SST-TF support status at this level
273+
* @sst_bf_support: SST-BF support status at this level
272274
*
273275
* Structure to get SST-PP details using IOCTL ISST_IF_PERF_LEVELS.
274276
*/
@@ -289,7 +291,7 @@ struct isst_perf_level_info {
289291
/**
290292
* struct isst_perf_level_control - Structure to set SST-PP level
291293
* @socket_id: Socket/package id
292-
* @power_domain: Power Domain id
294+
* @power_domain_id: Power Domain id
293295
* @level: level to set
294296
*
295297
* Structure used change SST-PP level using IOCTL ISST_IF_PERF_SET_LEVEL.
@@ -303,7 +305,7 @@ struct isst_perf_level_control {
303305
/**
304306
* struct isst_perf_feature_control - Structure to activate SST-BF/SST-TF
305307
* @socket_id: Socket/package id
306-
* @power_domain: Power Domain id
308+
* @power_domain_id: Power Domain id
307309
* @feature: bit 0 = SST-BF state, bit 1 = SST-TF state
308310
*
309311
* Structure used to enable SST-BF/SST-TF using IOCTL ISST_IF_PERF_SET_FEATURE.
@@ -320,7 +322,7 @@ struct isst_perf_feature_control {
320322
/**
321323
* struct isst_perf_level_data_info - Structure to get SST-PP level details
322324
* @socket_id: Socket/package id
323-
* @power_domain: Power Domain id
325+
* @power_domain_id: Power Domain id
324326
* @level: SST-PP level for which caller wants to get information
325327
* @tdp_ratio: TDP Ratio
326328
* @base_freq_mhz: Base frequency in MHz
@@ -341,8 +343,8 @@ struct isst_perf_feature_control {
341343
* @pm_fabric_freq_mhz: Fabric (Uncore) minimum frequency
342344
* @max_buckets: Maximum trl buckets
343345
* @max_trl_levels: Maximum trl levels
344-
* @bucket_core_counts[TRL_MAX_BUCKETS]: Number of cores per bucket
345-
* @trl_freq_mhz[TRL_MAX_LEVELS][TRL_MAX_BUCKETS]: maximum frequency
346+
* @bucket_core_counts: Number of cores per bucket
347+
* @trl_freq_mhz: maximum frequency
346348
* for a bucket and trl level
347349
*
348350
* Structure used to get information on frequencies and TDP for a SST-PP
@@ -402,7 +404,7 @@ struct isst_perf_level_fabric_info {
402404
/**
403405
* struct isst_perf_level_cpu_mask - Structure to get SST-PP level CPU mask
404406
* @socket_id: Socket/package id
405-
* @power_domain: Power Domain id
407+
* @power_domain_id: Power Domain id
406408
* @level: SST-PP level for which caller wants to get information
407409
* @punit_cpu_map: Set to 1 if the CPU number is punit numbering not
408410
* Linux CPU number. If 0 CPU buffer is copied to user space
@@ -430,7 +432,7 @@ struct isst_perf_level_cpu_mask {
430432
/**
431433
* struct isst_base_freq_info - Structure to get SST-BF frequencies
432434
* @socket_id: Socket/package id
433-
* @power_domain: Power Domain id
435+
* @power_domain_id: Power Domain id
434436
* @level: SST-PP level for which caller wants to get information
435437
* @high_base_freq_mhz: High priority CPU base frequency
436438
* @low_base_freq_mhz: Low priority CPU base frequency
@@ -453,9 +455,11 @@ struct isst_base_freq_info {
453455
/**
454456
* struct isst_turbo_freq_info - Structure to get SST-TF frequencies
455457
* @socket_id: Socket/package id
456-
* @power_domain: Power Domain id
458+
* @power_domain_id: Power Domain id
457459
* @level: SST-PP level for which caller wants to get information
458460
* @max_clip_freqs: Maximum number of low priority core clipping frequencies
461+
* @max_buckets: Maximum trl buckets
462+
* @max_trl_levels: Maximum trl levels
459463
* @lp_clip_freq_mhz: Clip frequencies per trl level
460464
* @bucket_core_counts: Maximum number of cores for a bucket
461465
* @trl_freq_mhz: Frequencies per trl level for each bucket

0 commit comments

Comments
 (0)