diff --git a/include/topology.h b/include/topology.h index 011f6ae7..51d282f6 100644 --- a/include/topology.h +++ b/include/topology.h @@ -203,12 +203,77 @@ extern "C" { * bytes "0x12,0x34,0x56,0x78" * shorts "0x1122,0x3344,0x5566,0x7788" * words "0xaabbccdd,0x11223344,0x66aa77bb,0xefef1234" + * tuples "section id of the vendor tuples" * }; * - * The file, bytes, shorts and words keywords are all mutually exclusive as - * the private data should only be taken from one source. The private data can - * either be read from a separate file or defined in the topology file using - * the bytes, shorts or words keywords. + * The file, bytes, shorts, words and tuples keywords are all mutually + * exclusive as the private data should only be taken from one source. + * The private data can either be read from a separate file or defined in + * the topology file using the bytes, shorts, words or tuples keywords. + * The keyword tuples is to define vendor specific tuples. Please refer to + * section Vendor Tokens and Vendor tuples. + * + *
+ * SectionVendorTokens."id of the vendor tokens" {
+ * comment "optional comments"
+ * VENDOR_TOKEN_ID1 "1"
+ * VENDOR_TOKEN_ID2 "2"
+ * VENDOR_TOKEN_ID3 "3"
+ * ...
+ * }
+ *
+ *
+ *
+ * SectionVendorTuples."id of the vendor tuples" {
+ * tokens "id of the vendor tokens"
+ *
+ * tuples."string" {
+ * VENDOR_TOKEN_ID1 "character string"
+ * ...
+ * }
+ *
+ * tuples."uuid" {
+ * VENDOR_TOKEN_ID2 "16 character uuid"
+ * ...
+ * }
+ *
+ * tuples."bool" {
+ * VENDOR_TOKEN_ID3 "true/false"
+ * ...
+ * }
+ *
+ * tuples."byte" {
+ * VENDOR_TOKEN_ID4 "0x11"
+ * VENDOR_TOKEN_ID5 "0x22"
+ * ...
+ * }
+ *
+ * tuples."short" {
+ * VENDOR_TOKEN_ID6 "0x1122"
+ * VENDOR_TOKEN_ID7 "0x3344"
+ * ...
+ * }
+ *
+ * tuples."word" {
+ * VENDOR_TOKEN_ID8 "0x11223344"
+ * VENDOR_TOKEN_ID9 "0x55667788"
+ * ...
+ * }
+ * }
+ *
*
*