aboutsummaryrefslogtreecommitdiff
path: root/lib/pbdrv/drv/index.dox
blob: c0c1b767a76d5d3cc7e98a3f91d1ec541e1d5f79 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// 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
	\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;
	```

*/