From d64fe223e3fc414c9fe3ecb38a2e136dd5397144 Mon Sep 17 00:00:00 2001 From: Tomasz Wasilczyk Date: Mon, 13 Nov 2017 14:11:55 -0800 Subject: [PATCH] Update comments for vendor-specific parameters API. Bug: 65862441 Test: none Change-Id: Iffdc48ec86159ca3d7c0dddd586b9865ace4f492 --- broadcastradio/1.2/ITuner.hal | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/broadcastradio/1.2/ITuner.hal b/broadcastradio/1.2/ITuner.hal index cc966fcb8f..ba97ea0c0a 100644 --- a/broadcastradio/1.2/ITuner.hal +++ b/broadcastradio/1.2/ITuner.hal @@ -28,8 +28,11 @@ interface ITuner extends @1.1::ITuner { * ones stated in VendorKeyValue documentation (a requirement of key * prefixes). * - * Results vector may not contain a result for each parameter being set, - * it can even be empty. + * For each pair in the result vector, the key must be one of the keys + * contained in the input (possibly with wildcards expanded), and the value + * must be a vendor-specific result status (i.e. the string "OK" or an error + * code). The implementation may choose to return an empty vector, or only + * return a status for a subset of the provided inputs, at its discretion. * * Application and HAL must not use keys with unknown prefix. In particular, * it must not place a key-value pair in results vector for unknown key from @@ -40,7 +43,6 @@ interface ITuner extends @1.1::ITuner { * * @param parameters Vendor-specific key-value pairs. * @return results Operation completion status for parameters being set. - * Value format for result status is vendor-specific. */ setParameters(vec parameters) generates (vec results);