History

block: fix uapi blkzoned.h comments

Update the kdoc comments for struct blk_zone (capacity field description missing) and for struct blk_zone_report (flags field description missing).

Damien Le Moal committed 6 years ago

Commit 8858e8d1 parent 47ce0301 file · +9 −6Browse files

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

Unified · Split

include/uapi/linux/blkzoned.h+9−6
@@ -93,12 +93,15 @@ enum blk_zone_report_flags { · 92 unmodified lines
93 * @non_seq: Flag indicating that the zone is using non-sequential resources93 * @non_seq: Flag indicating that the zone is using non-sequential resources
94 * (for host-aware zoned block devices only).94 * (for host-aware zoned block devices only).
95 * @reset: Flag indicating that a zone reset is recommended.95 * @reset: Flag indicating that a zone reset is recommended.
96 * @reserved: Padding to 64 B to match the ZBC/ZAC defined zone descriptor size.96 * @resv: Padding for 8B alignment.
97 * @capacity: Zone usable capacity in 512 B sector units
98 * @reserved: Padding to 64 B to match the ZBC, ZAC and ZNS defined zone
99 * descriptor size.
97 *100 *
98 * start, len and wp use the regular 512 B sector unit, regardless of the101 * start, len, capacity and wp use the regular 512 B sector unit, regardless
99 * device logical block size. The overall structure size is 64 B to match the102 * of the device logical block size. The overall structure size is 64 B to
100 * ZBC/ZAC defined zone descriptor and allow support for future additional103 * match the ZBC, ZAC and ZNS defined zone descriptor and allow support for
101 * zone information.104 * future additional zone information.
102 */105 */
103struct blk_zone {106struct blk_zone {
104 __u64 start; /* Zone start sector */107 __u64 start; /* Zone start sector */
@@ -118,7 +121,7 @@ struct blk_zone { · 13 unmodified lines
118 *121 *
119 * @sector: starting sector of report122 * @sector: starting sector of report
120 * @nr_zones: IN maximum / OUT actual123 * @nr_zones: IN maximum / OUT actual
121 * @reserved: padding to 16 byte alignment124 * @flags: one or more flags as defined by enum blk_zone_report_flags.
122 * @zones: Space to hold @nr_zones @zones entries on reply.125 * @zones: Space to hold @nr_zones @zones entries on reply.
123 *126 *
124 * The array of at most @nr_zones must follow this structure in memory.127 * The array of at most @nr_zones must follow this structure in memory.