aboutsummaryrefslogtreecommitdiff
path: root/lib/pbdrv/drv/index.dox
diff options
context:
space:
mode:
Diffstat (limited to 'lib/pbdrv/drv/index.dox')
-rw-r--r--lib/pbdrv/drv/index.dox19
1 files changed, 19 insertions, 0 deletions
diff --git a/lib/pbdrv/drv/index.dox b/lib/pbdrv/drv/index.dox
new file mode 100644
index 0000000..89b9247
--- /dev/null
+++ b/lib/pbdrv/drv/index.dox
@@ -0,0 +1,19 @@
+// vim:ft=doxygen
+/**
+\ingroup pbdrv-mod
+\defgroup pb_drv Drivers
+\brief Platform-specific \ref pbdrv-mod implementations
+
+Like \ref pb_ext "extensions", drivers provide platform-specific
+implementations for various functions used in \ref pbdrv-mod.
+
+If there is no existing driver for your target, you may implement the following
+in order to use \ref pbdrv-mod:
+
+- The \c pb_i2c_recv() function must be **called** for every received I2C
+ message
+- The \c pb_i2c_send() function must be **implemented** using the
+ platform/device-specific I2C write function
+
+*/
+