History

gpio: uapi: kernel-doc formatting improvements

Add kernel-doc formatting to all references to structs, enums, fields and constants, and move deprecation warnings into the Note section of the deprecated struct. Replace 'OR:ed' with 'added', as the former looks odd.

Kent Gibson committed 6 years ago

Commit 2cc522d1 parent f2016021 file · +47 −46Browse files

Showing the changes to include/uapi/linux (1 of 1 file). Show all

Unified · Split

include/uapi/linux/gpio.h+47−46
@@ -110,17 +110,17 @@ enum gpio_v2_line_attr_id { · 109 unmodified lines
110110 * struct gpio_v2_line_attribute - a configurable attribute of a line
111111 * @id: attribute identifier with value from &enum gpio_v2_line_attr_id
112112 * @padding: reserved for future use and must be zero filled
113− * @flags: if id is GPIO_V2_LINE_ATTR_ID_FLAGS, the flags for the GPIO
114− * line, with values from enum gpio_v2_line_flag, such as
115− * GPIO_V2_LINE_FLAG_ACTIVE_LOW, GPIO_V2_LINE_FLAG_OUTPUT etc, OR:ed
113+ * @flags: if id is %GPIO_V2_LINE_ATTR_ID_FLAGS, the flags for the GPIO
114+ * line, with values from &enum gpio_v2_line_flag, such as
115+ * %GPIO_V2_LINE_FLAG_ACTIVE_LOW, %GPIO_V2_LINE_FLAG_OUTPUT etc, added
116116 * together. This overrides the default flags contained in the &struct
117117 * gpio_v2_line_config for the associated line.
118− * @values: if id is GPIO_V2_LINE_ATTR_ID_OUTPUT_VALUES, a bitmap
118+ * @values: if id is %GPIO_V2_LINE_ATTR_ID_OUTPUT_VALUES, a bitmap
119119 * containing the values to which the lines will be set, with each bit
120120 * number corresponding to the index into &struct
121121 * gpio_v2_line_request.offsets.
122− * @debounce_period_us: if id is GPIO_V2_LINE_ATTR_ID_DEBOUNCE, the desired
123− * debounce period, in microseconds
122+ * @debounce_period_us: if id is %GPIO_V2_LINE_ATTR_ID_DEBOUNCE, the
123+ * desired debounce period, in microseconds
124124 */
125125 struct gpio_v2_line_attribute {
126126 __u32 id;
@@ -147,12 +147,12 @@ struct gpio_v2_line_config_attribute { · 20 unmodified lines
147147
148148 /**
149149 * struct gpio_v2_line_config - Configuration for GPIO lines
150− * @flags: flags for the GPIO lines, with values from enum
151− * gpio_v2_line_flag, such as GPIO_V2_LINE_FLAG_ACTIVE_LOW,
152− * GPIO_V2_LINE_FLAG_OUTPUT etc, OR:ed together. This is the default for
150+ * @flags: flags for the GPIO lines, with values from &enum
151+ * gpio_v2_line_flag, such as %GPIO_V2_LINE_FLAG_ACTIVE_LOW,
152+ * %GPIO_V2_LINE_FLAG_OUTPUT etc, added together. This is the default for
153153 * all requested lines but may be overridden for particular lines using
154− * attrs.
155− * @num_attrs: the number of attributes in attrs
154+ * @attrs.
155+ * @num_attrs: the number of attributes in @attrs
156156 * @padding: reserved for future use and must be zero filled
157157 * @attrs: the configuration attributes associated with the requested
158158 * lines. Any attribute should only be associated with a particular line
@@ -175,17 +175,17 @@ struct gpio_v2_line_config { · 16 unmodified lines
175175 * "my-bitbanged-relay"
176176 * @config: requested configuration for the lines.
177177 * @num_lines: number of lines requested in this request, i.e. the number
178− * of valid fields in the GPIO_V2_LINES_MAX sized arrays, set to 1 to
178+ * of valid fields in the %GPIO_V2_LINES_MAX sized arrays, set to 1 to
179179 * request a single line
180180 * @event_buffer_size: a suggested minimum number of line events that the
181181 * kernel should buffer. This is only relevant if edge detection is
182182 * enabled in the configuration. Note that this is only a suggested value
183183 * and the kernel may allocate a larger buffer or cap the size of the
184184 * buffer. If this field is zero then the buffer size defaults to a minimum
185− * of num_lines*16.
185+ * of @num_lines * 16.
186186 * @padding: reserved for future use and must be zero filled
187187 * @fd: if successful this field will contain a valid anonymous file handle
188− * after a GPIO_GET_LINE_IOCTL operation, zero or negative value means
188+ * after a %GPIO_GET_LINE_IOCTL operation, zero or negative value means
189189 * error
190190 */
191191 struct gpio_v2_line_request {
@@ -207,11 +207,12 @@ struct gpio_v2_line_request { · 15 unmodified lines
207207 * @consumer: a functional name for the consumer of this GPIO line as set
208208 * by whatever is using it, will be empty if there is no current user but
209209 * may also be empty if the consumer doesn't set this up
210− * @flags: flags for the GPIO line, such as GPIO_V2_LINE_FLAG_ACTIVE_LOW,
211− * GPIO_V2_LINE_FLAG_OUTPUT etc, OR:ed together
212210 * @offset: the local offset on this GPIO chip, fill this in when
213211 * requesting the line information from the kernel
214− * @num_attrs: the number of attributes in attrs
212+ * @num_attrs: the number of attributes in @attrs
213+ * @flags: flags for the GPIO lines, with values from &enum
214+ * gpio_v2_line_flag, such as %GPIO_V2_LINE_FLAG_ACTIVE_LOW,
215+ * %GPIO_V2_LINE_FLAG_OUTPUT etc, added together.
215216 * @attrs: the configuration attributes associated with the line
216217 * @padding: reserved for future use
217218 */
@@ -244,7 +245,7 @@ enum gpio_v2_line_changed_type { · 26 unmodified lines
244245 * of a GPIO line
245246 * @info: updated line information
246247 * @timestamp_ns: estimate of time of status change occurrence, in nanoseconds
247− * @event_type: the type of change with a value from enum
248+ * @event_type: the type of change with a value from &enum
248249 * gpio_v2_line_changed_type
249250 * @padding: reserved for future use
250251 */
@@ -269,10 +270,10 @@ enum gpio_v2_line_event_id { · 18 unmodified lines
269270 /**
270271 * struct gpio_v2_line_event - The actual event being pushed to userspace
271272 * @timestamp_ns: best estimate of time of event occurrence, in nanoseconds.
272− * The timestamp_ns is read from CLOCK_MONOTONIC and is intended to allow the
273− * accurate measurement of the time between events. It does not provide
273+ * The @timestamp_ns is read from %CLOCK_MONOTONIC and is intended to allow
274+ * the accurate measurement of the time between events. It does not provide
274275 * the wall-clock time.
275− * @id: event identifier with value from enum gpio_v2_line_event_id
276+ * @id: event identifier with value from &enum gpio_v2_line_event_id
276277 * @offset: the offset of the line that triggered the event
277278 * @seqno: the sequence number for this event in the sequence of events for
278279 * all the lines in this line request
@@ -319,8 +320,8 @@ struct gpio_v2_line_event { · 40 unmodified lines
319320 * whatever is using it, will be empty if there is no current user but may
320321 * also be empty if the consumer doesn't set this up
321322 *
322− * This struct is part of ABI v1 and is deprecated.
323− * Use struct gpio_v2_line_info instead.
323+ * Note: This struct is part of ABI v1 and is deprecated.
324+ * Use &struct gpio_v2_line_info instead.
324325 */
325326 struct gpioline_info {
326327 __u32 line_offset;
@@ -344,18 +345,18 @@ enum { · 17 unmodified lines
344345 * of a GPIO line
345346 * @info: updated line information
346347 * @timestamp: estimate of time of status change occurrence, in nanoseconds
347− * @event_type: one of GPIOLINE_CHANGED_REQUESTED, GPIOLINE_CHANGED_RELEASED
348− * and GPIOLINE_CHANGED_CONFIG
348+ * @event_type: one of %GPIOLINE_CHANGED_REQUESTED,
349+ * %GPIOLINE_CHANGED_RELEASED and %GPIOLINE_CHANGED_CONFIG
349350 * @padding: reserved for future use
350351 *
351− * Note: struct gpioline_info embedded here has 32-bit alignment on its own,
352+ * The &struct gpioline_info embedded here has 32-bit alignment on its own,
352353 * but it works fine with 64-bit alignment too. With its 72 byte size, we can
353354 * guarantee there are no implicit holes between it and subsequent members.
354355 * The 20-byte padding at the end makes sure we don't add any implicit padding
355356 * at the end of the structure on 64-bit architectures.
356357 *
357− * This struct is part of ABI v1 and is deprecated.
358− * Use struct gpio_v2_line_info_changed instead.
358+ * Note: This struct is part of ABI v1 and is deprecated.
359+ * Use &struct gpio_v2_line_info_changed instead.
359360 */
360361 struct gpioline_info_changed {
361362 struct gpioline_info info;
@@ -379,13 +380,13 @@ struct gpioline_info_changed { · 17 unmodified lines
379380 * @lineoffsets: an array of desired lines, specified by offset index for the
380381 * associated GPIO device
381382 * @flags: desired flags for the desired GPIO lines, such as
382− * GPIOHANDLE_REQUEST_OUTPUT, GPIOHANDLE_REQUEST_ACTIVE_LOW etc, OR:ed
383+ * %GPIOHANDLE_REQUEST_OUTPUT, %GPIOHANDLE_REQUEST_ACTIVE_LOW etc, added
383384 * together. Note that even if multiple lines are requested, the same flags
384385 * must be applicable to all of them, if you want lines with individual
385386 * flags set, request them one by one. It is possible to select
386387 * a batch of input or output lines, but they must all have the same
387388 * characteristics, i.e. all inputs or all outputs, all active low etc
388− * @default_values: if the GPIOHANDLE_REQUEST_OUTPUT is set for a requested
389+ * @default_values: if the %GPIOHANDLE_REQUEST_OUTPUT is set for a requested
389390 * line, this specifies the default output value, should be 0 (low) or
390391 * 1 (high), anything else than 0 or 1 will be interpreted as 1 (high)
391392 * @consumer_label: a desired consumer label for the selected GPIO line(s)
@@ -393,11 +394,11 @@ struct gpioline_info_changed { · 1 unmodified line
393394 * @lines: number of lines requested in this request, i.e. the number of
394395 * valid fields in the above arrays, set to 1 to request a single line
395396 * @fd: if successful this field will contain a valid anonymous file handle
396− * after a GPIO_GET_LINEHANDLE_IOCTL operation, zero or negative value
397+ * after a %GPIO_GET_LINEHANDLE_IOCTL operation, zero or negative value
397398 * means error
398399 *
399− * This struct is part of ABI v1 and is deprecated.
400− * Use struct gpio_v2_line_request instead.
400+ * Note: This struct is part of ABI v1 and is deprecated.
401+ * Use &struct gpio_v2_line_request instead.
401402 */
402403 struct gpiohandle_request {
403404 __u32 lineoffsets[GPIOHANDLES_MAX];
@@ -411,15 +412,15 @@ struct gpiohandle_request { · 7 unmodified lines
411412 /**
412413 * struct gpiohandle_config - Configuration for a GPIO handle request
413414 * @flags: updated flags for the requested GPIO lines, such as
414− * GPIOHANDLE_REQUEST_OUTPUT, GPIOHANDLE_REQUEST_ACTIVE_LOW etc, OR:ed
415+ * %GPIOHANDLE_REQUEST_OUTPUT, %GPIOHANDLE_REQUEST_ACTIVE_LOW etc, added
415416 * together
416− * @default_values: if the GPIOHANDLE_REQUEST_OUTPUT is set in flags,
417+ * @default_values: if the %GPIOHANDLE_REQUEST_OUTPUT is set in flags,
417418 * this specifies the default output value, should be 0 (low) or
418419 * 1 (high), anything else than 0 or 1 will be interpreted as 1 (high)
419420 * @padding: reserved for future use and should be zero filled
420421 *
421− * This struct is part of ABI v1 and is deprecated.
422− * Use struct gpio_v2_line_config instead.
422+ * Note: This struct is part of ABI v1 and is deprecated.
423+ * Use &struct gpio_v2_line_config instead.
423424 */
424425 struct gpiohandle_config {
425426 __u32 flags;
@@ -433,8 +434,8 @@ struct gpiohandle_config { · 7 unmodified lines
433434 * state of a line, when setting the state of lines these should contain
434435 * the desired target state
435436 *
436− * This struct is part of ABI v1 and is deprecated.
437− * Use struct gpio_v2_line_values instead.
437+ * Note: This struct is part of ABI v1 and is deprecated.
438+ * Use &struct gpio_v2_line_values instead.
438439 */
439440 struct gpiohandle_data {
440441 __u8 values[GPIOHANDLES_MAX];
@@ -450,17 +451,17 @@ struct gpiohandle_data { · 9 unmodified lines
450451 * @lineoffset: the desired line to subscribe to events from, specified by
451452 * offset index for the associated GPIO device
452453 * @handleflags: desired handle flags for the desired GPIO line, such as
453− * GPIOHANDLE_REQUEST_ACTIVE_LOW or GPIOHANDLE_REQUEST_OPEN_DRAIN
454+ * %GPIOHANDLE_REQUEST_ACTIVE_LOW or %GPIOHANDLE_REQUEST_OPEN_DRAIN
454455 * @eventflags: desired flags for the desired GPIO event line, such as
455− * GPIOEVENT_REQUEST_RISING_EDGE or GPIOEVENT_REQUEST_FALLING_EDGE
456+ * %GPIOEVENT_REQUEST_RISING_EDGE or %GPIOEVENT_REQUEST_FALLING_EDGE
456457 * @consumer_label: a desired consumer label for the selected GPIO line(s)
457458 * such as "my-listener"
458459 * @fd: if successful this field will contain a valid anonymous file handle
459− * after a GPIO_GET_LINEEVENT_IOCTL operation, zero or negative value
460+ * after a %GPIO_GET_LINEEVENT_IOCTL operation, zero or negative value
460461 * means error
461462 *
462− * This struct is part of ABI v1 and is deprecated.
463− * Use struct gpio_v2_line_request instead.
463+ * Note: This struct is part of ABI v1 and is deprecated.
464+ * Use &struct gpio_v2_line_request instead.
464465 */
465466 struct gpioevent_request {
466467 __u32 lineoffset;
@@ -481,8 +482,8 @@ struct gpioevent_request { · 14 unmodified lines
481482 * @timestamp: best estimate of time of event occurrence, in nanoseconds
482483 * @id: event identifier
483484 *
484− * This struct is part of ABI v1 and is deprecated.
485− * Use struct gpio_v2_line_event instead.
485+ * Note: This struct is part of ABI v1 and is deprecated.
486+ * Use &struct gpio_v2_line_event instead.
486487 */
487488 struct gpioevent_data {
488489 __u64 timestamp;