Henry-Hiles/qmk_userspace
1
0
Fork 0
forked from mirrors/qmk_userspace
Code Pull requests Activity

Dedupe I2C, SPI, UART driver inclusions (#22253)

Browse source
This commit is contained in:
Ryan 2023-10-13 17:25:32 +11:00 • committed by GitHub
parent f150258e5a
commit c157c19b81
Failed to generate hash of commit
130 changed files with 284 additions and 249 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/i2c_driver.md
View file

@ -2,6 +2,18 @@
The I2C Master drivers used in QMK have a set of common functions to allow portability between MCUs.
## Usage :id=usage
In most cases, the I2C Master driver code is automatically included if you are using a feature or driver which requires it, such as [OLED](feature_oled_driver.md).
However, if you need to use the driver standalone, add the following to your `rules.mk`:
```make
I2C_DRIVER_REQUIRED = yes
```
You can then call the I2C API by including `i2c_master.h` in your code.
## I2C Addressing :id=note-on-i2c-addresses
All of the addresses expected by this driver should be pushed to the upper 7 bits of the address byte. Setting