treewide: Add API function iio_channel_get_label()

This function can be used to retrieve the label for this IIO Channel, if it was specified in linux driver. Signed-off-by: Dan Nechita <[email protected]>
analogdevicesinc · Jan 27, 2025 · fc7ab0e · fc7ab0e
1 parent f7af85f
commit fc7ab0e
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/channel.c b/channel.c
@@ -326,6 +326,11 @@ const char * iio_channel_get_name(const struct iio_channel *chn)
 	return chn->name;
 }
 
+const char * iio_channel_get_label(const struct iio_channel *chn)
+{
+	return chn->label;
+}
+
 bool iio_channel_is_output(const struct iio_channel *chn)
 {
 	return chn->is_output;

diff --git a/context.c b/context.c
@@ -30,7 +30,7 @@ static const char xml_header[] = "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
 "version-minor CDATA #REQUIRED version-git CDATA #REQUIRED description CDATA #IMPLIED>"
 "<!ATTLIST context-attribute name CDATA #REQUIRED value CDATA #REQUIRED>"
 "<!ATTLIST device id CDATA #REQUIRED name CDATA #IMPLIED label CDATA #IMPLIED>"
-"<!ATTLIST channel id CDATA #REQUIRED type (input|output) #REQUIRED name CDATA #IMPLIED>"
+"<!ATTLIST channel id CDATA #REQUIRED type (input|output) #REQUIRED name CDATA #IMPLIED label CDATA #IMPLIED>"
 "<!ATTLIST scan-element index CDATA #REQUIRED format CDATA #REQUIRED scale CDATA #IMPLIED>"
 "<!ATTLIST attribute name CDATA #REQUIRED filename CDATA #IMPLIED>"
 "<!ATTLIST debug-attribute name CDATA #REQUIRED>"

diff --git a/include/iio/iio.h b/include/iio/iio.h
@@ -876,6 +876,12 @@ __api __check_ret __pure const char * iio_channel_get_id(const struct iio_channe
  * <b>NOTE:</b> if the channel has no name, NULL is returned. */
 __api __check_ret __pure const char * iio_channel_get_name(const struct iio_channel *chn);
 
+/** @brief Retrieve the channel label (e.g. <b><i>anglY</i></b>)
+ * @param chn A pointer to an iio_channel structure
+ * @return A pointer to a static NULL-terminated string
+ *
+ * <b>NOTE:</b> if the channel has no label, NULL is returned. */
+__api __check_ret __pure const char * iio_channel_get_label(const struct iio_channel *chn);
 
 /** @brief Return True if the given channel is an output channel
  * @param chn A pointer to an iio_channel structure