Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

topology2: pipeline: document pipeline.priority attribute #8509

Merged
merged 1 commit into from
Apr 5, 2024

Conversation

kv2019i
Copy link
Collaborator

@kv2019i kv2019i commented Nov 21, 2023

Add a note that priority 0 is the highest priority and indicates pipeline that should be run first. This matches with the SOF scheduler implementation.

@@ -57,7 +57,7 @@ Class.Widget."pipeline" {
}
}

# pipeline priority
# pipeline priority (0 = highest priority)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we add more? like priority range: 0 ~ ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, yeah, also useful to add "lowest = 7" iirc.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@btian1 @lgirdwood I agree but this is complex. 0 = highest applies to all implementations, but fine details of other semantics are still a bit unclear to me, including what is the lowest. in IPC4 this is 7, but we don't have such for IPC3. but fair enough, let me investigate more to come up with the documentation.

Copy link
Member

@lgirdwood lgirdwood left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needed addition.

@@ -57,7 +57,7 @@ Class.Widget."pipeline" {
}
}

# pipeline priority
# pipeline priority (0 = highest priority)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, yeah, also useful to add "lowest = 7" iirc.

Add constraints on valid pipeline priority values and document
the semantics so that 0 is considered the highest priority and such
pipeline should be run first.

The range matches definitions in include/ipc4/pipeline.h and
SOF_IPC4_MAX_PIPELINE_PRIORITY.

Signed-off-by: Kai Vehmanen <[email protected]>
@kv2019i kv2019i force-pushed the 202311-tplg-pipe-priority-doc branch from 22f7dbe to 179bbd5 Compare April 4, 2024 10:33
@kv2019i
Copy link
Collaborator Author

kv2019i commented Apr 4, 2024

V2:

  • document the 0..7 range used by IPC4 (and covers all IPC3 usage as well)
  • add explicit constraints (as we now can do this)

@kv2019i
Copy link
Collaborator Author

kv2019i commented Apr 5, 2024

SOFCI TEST

@kv2019i kv2019i merged commit 07b762e into thesofproject:main Apr 5, 2024
43 of 45 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants