Merge series from Luca Ceresoli <luca.ceresoli@bootlin.com>: This series applies various improvements to the DAPM documentation: a rewrite of a few sections for clarity, style improvements and typo fixes. Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com> --- Changes in v2: - avoid wrapping in patch 3 as suggested by Alex - Link to v1: https://lore.kernel.org/r/20240416-dapm-docs-v1-0-a818d2819bf6@bootlin.com --- Luca Ceresoli (12): ASoC: doc: dapm: fix typos ASoC: doc: dapm: fix struct name ASoC: doc: dapm: minor rewording ASoC: doc: dapm: remove dash after colon ASoC: doc: dapm: clarify it's an internal API ASoC: doc: dapm: replace "map" with "graph" ASoC: doc: dapm: extend initial descrption ASoC: doc: dapm: describe how widgets and routes are registered ASoC: doc: dapm: fix and improve section "Registering DAPM controls" ASoC: doc: dapm: improve section "Codec/DSP Widget Interconnections" ASoC: doc: dapm: update section "DAPM Widget Events" ASoC: doc: dapm: update event types Documentation/sound/soc/dapm-graph.svg | 375 +++++++++++++++++++++++++++++++++ Documentation/sound/soc/dapm.rst | 174 ++++++++++----- 2 files changed, 492 insertions(+), 57 deletions(-) --- base-commit: c942a0cd3603e34dd2d7237e064d9318cb7f9654 change-id: 20240315-dapm-docs-79bd51f267db Best regards, -- Luca Ceresoli <luca.ceresoli@bootlin.com>
Showing the changes to include/uapi (2 of 737 files). Show all
Unified · Split
| @@ -57,7 +57,7 @@ enum vdpa_attr { · 56 unmodified lines | |||
| 57 | VDPA_ATTR_DEV_FEATURES, /* u64 */ | 57 | VDPA_ATTR_DEV_FEATURES, /* u64 */ |
| 58 | 58 | ||
| 59 | VDPA_ATTR_DEV_BLK_CFG_CAPACITY, /* u64 */ | 59 | VDPA_ATTR_DEV_BLK_CFG_CAPACITY, /* u64 */ |
| 60 | VDPA_ATTR_DEV_BLK_CFG_SEG_SIZE, /* u32 */ | 60 | VDPA_ATTR_DEV_BLK_CFG_SIZE_MAX, /* u32 */ |
| 61 | VDPA_ATTR_DEV_BLK_CFG_BLK_SIZE, /* u32 */ | 61 | VDPA_ATTR_DEV_BLK_CFG_BLK_SIZE, /* u32 */ |
| 62 | VDPA_ATTR_DEV_BLK_CFG_SEG_MAX, /* u32 */ | 62 | VDPA_ATTR_DEV_BLK_CFG_SEG_MAX, /* u32 */ |
| 63 | VDPA_ATTR_DEV_BLK_CFG_NUM_QUEUES, /* u16 */ | 63 | VDPA_ATTR_DEV_BLK_CFG_NUM_QUEUES, /* u16 */ |
| @@ -70,8 +70,8 @@ enum vdpa_attr { · 6 unmodified lines | |||
| 70 | VDPA_ATTR_DEV_BLK_CFG_DISCARD_SEC_ALIGN,/* u32 */ | 70 | VDPA_ATTR_DEV_BLK_CFG_DISCARD_SEC_ALIGN,/* u32 */ |
| 71 | VDPA_ATTR_DEV_BLK_CFG_MAX_WRITE_ZEROES_SEC, /* u32 */ | 71 | VDPA_ATTR_DEV_BLK_CFG_MAX_WRITE_ZEROES_SEC, /* u32 */ |
| 72 | VDPA_ATTR_DEV_BLK_CFG_MAX_WRITE_ZEROES_SEG, /* u32 */ | 72 | VDPA_ATTR_DEV_BLK_CFG_MAX_WRITE_ZEROES_SEG, /* u32 */ |
| 73 | VDPA_ATTR_DEV_BLK_CFG_READ_ONLY, /* u8 */ | 73 | VDPA_ATTR_DEV_BLK_READ_ONLY, /* u8 */ |
| 74 | VDPA_ATTR_DEV_BLK_CFG_FLUSH, /* u8 */ | 74 | VDPA_ATTR_DEV_BLK_FLUSH, /* u8 */ |
| 75 | 75 | ||
| 76 | /* new attributes must be added above here */ | 76 | /* new attributes must be added above here */ |
| 77 | VDPA_ATTR_MAX, | 77 | VDPA_ATTR_MAX, |
| @@ -179,12 +179,6 @@ · 178 unmodified lines | |||
| 179 | /* Get the config size */ | 179 | /* Get the config size */ |
| 180 | #define VHOST_VDPA_GET_CONFIG_SIZE _IOR(VHOST_VIRTIO, 0x79, __u32) | 180 | #define VHOST_VDPA_GET_CONFIG_SIZE _IOR(VHOST_VIRTIO, 0x79, __u32) |
| 181 | 181 | ||
| 182 | /* Get the count of all virtqueues */ | ||
| 183 | #define VHOST_VDPA_GET_VQS_COUNT _IOR(VHOST_VIRTIO, 0x80, __u32) | ||
| 184 | |||
| 185 | /* Get the number of virtqueue groups. */ | ||
| 186 | #define VHOST_VDPA_GET_GROUP_NUM _IOR(VHOST_VIRTIO, 0x81, __u32) | ||
| 187 | |||
| 188 | /* Get the number of address spaces. */ | 182 | /* Get the number of address spaces. */ |
| 189 | #define VHOST_VDPA_GET_AS_NUM _IOR(VHOST_VIRTIO, 0x7A, unsigned int) | 183 | #define VHOST_VDPA_GET_AS_NUM _IOR(VHOST_VIRTIO, 0x7A, unsigned int) |
| 190 | 184 | ||
| @@ -228,10 +222,17 @@ · 37 unmodified lines | |||
| 228 | #define VHOST_VDPA_GET_VRING_DESC_GROUP _IOWR(VHOST_VIRTIO, 0x7F, \ | 222 | #define VHOST_VDPA_GET_VRING_DESC_GROUP _IOWR(VHOST_VIRTIO, 0x7F, \ |
| 229 | struct vhost_vring_state) | 223 | struct vhost_vring_state) |
| 230 | 224 | ||
| 225 | |||
| 226 | /* Get the count of all virtqueues */ | ||
| 227 | #define VHOST_VDPA_GET_VQS_COUNT _IOR(VHOST_VIRTIO, 0x80, __u32) | ||
| 228 | |||
| 229 | /* Get the number of virtqueue groups. */ | ||
| 230 | #define VHOST_VDPA_GET_GROUP_NUM _IOR(VHOST_VIRTIO, 0x81, __u32) | ||
| 231 | |||
| 231 | /* Get the queue size of a specific virtqueue. | 232 | /* Get the queue size of a specific virtqueue. |
| 232 | * userspace set the vring index in vhost_vring_state.index | 233 | * userspace set the vring index in vhost_vring_state.index |
| 233 | * kernel set the queue size in vhost_vring_state.num | 234 | * kernel set the queue size in vhost_vring_state.num |
| 234 | */ | 235 | */ |
| 235 | #define VHOST_VDPA_GET_VRING_SIZE _IOWR(VHOST_VIRTIO, 0x80, \ | 236 | #define VHOST_VDPA_GET_VRING_SIZE _IOWR(VHOST_VIRTIO, 0x82, \ |
| 236 | struct vhost_vring_state) | 237 | struct vhost_vring_state) |
| 237 | #endif | 238 | #endif |