drivers: i2c: i2c-priv: document i2c_map_dt_bitrate
Document the helper function.
Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
diff --git a/drivers/i2c/i2c-priv.h b/drivers/i2c/i2c-priv.h
index 0ac92bd..83bbb42 100644
--- a/drivers/i2c/i2c-priv.h
+++ b/drivers/i2c/i2c-priv.h
@@ -14,6 +14,14 @@
extern "C" {
#endif
+/**
+ * @brief Map I2C bitrate from DT (in bps) to I2C interface encoding.
+ *
+ * @param bitrate I2C bitrate from DT (in bps)
+ *
+ * @retval bitrate I2C interface encoded bitrate.
+ * @retval 0 If given @p bitrate is not valid.
+ */
static inline uint32_t i2c_map_dt_bitrate(uint32_t bitrate)
{
switch (bitrate) {
