Merge pull request #21 from lonkaars/master

Updating branch

1 files changed, 32 insertions, 0 deletions

diff --git a/lib/pbdrv/drv/index.dox b/lib/pbdrv/drv/index.dox
new file mode 100644
index 0000000..1fe09e2
--- /dev/null
+++ b/lib/pbdrv/drv/index.dox
@@ -0,0 +1,32 @@
+// 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.
+
+Drivers are automatically included based on your build configuration, and you
+only need to ensure \c pbdrv-mod is linked with your final executable in order
+to use one of the available drivers:
+
+```cmake
+# include pbdrv
+add_subdirectory(lib/pbdrv)
+
+# link pbdrv-mod
+target_link_libraries(main 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
+
+*/
+