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.dox7
1 files changed, 6 insertions, 1 deletions
diff --git a/lib/pbdrv/drv/index.dox b/lib/pbdrv/drv/index.dox
index 89b9247..c0c1b76 100644
--- a/lib/pbdrv/drv/index.dox
+++ b/lib/pbdrv/drv/index.dox
@@ -8,12 +8,17 @@ 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:
+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
+ \note The \c pb_i2c_send() function should immediately call \c
+ pb_hook_i2c_send() before doing any further processing:
+ ```c
+ if (pb_hook_i2c_send(i2c_addr, buf, sz)) return;
+ ```
*/