aboutsummaryrefslogtreecommitdiff
path: root/include/topology.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/topology.h')
-rw-r--r--include/topology.h14
1 files changed, 14 insertions, 0 deletions
diff --git a/include/topology.h b/include/topology.h
index 1bebe1ed..ccb3a004 100644
--- a/include/topology.h
+++ b/include/topology.h
@@ -214,6 +214,20 @@ extern "C" {
* The keyword tuples is to define vendor specific tuples. Please refer to
* section Vendor Tokens and Vendor tuples.
*
+ * It's easy to use a vendor tuples object to define a C structure instance.
+ * And a data section can include multiple vendor tuples objects:
+ *
+ * <pre>
+ * SectionData."data element name" {
+ * index "1" #Index number
+ * tuples [
+ * "id of the 1st vendor tuples section"
+ * "id of the 2nd vendor tuples section"
+ * ...
+ * ]
+ * };
+ * </pre>
+ *
* <h5>How to define an element with private data</h5>
* An element can refer to a single data section or multiple data
* sections.