doc: add ADC information for each platform

Signed-off-by: Thomas Ingleby <thomas.c.ingleby@intel.com>

diff --git a/docs/edison.md b/docs/edison.md
index 3cbe22b..6263b1f 100644 (file)
--- a/docs/edison.md
+++ b/docs/edison.md
@@ -11,3 +11,5 @@ in libmraa:
 
 - PWM avaible on default swizzler postions. (3,5,6,9)
 - SPI exposed is also used for the ADC. Try not to use your own CS.
+- ADC kernel module will return 12bit number but the ADC itself only has an
+  accuracy of 10bits. This ADC is only included on the arduino board.

diff --git a/docs/galileorevd.md b/docs/galileorevd.md
index 65c1fd1..859e476 100644 (file)
--- a/docs/galileorevd.md
+++ b/docs/galileorevd.md
@@ -8,3 +8,4 @@ The rev D board has the following limitations in libmraa:
 
 - gpio register access via /dev/uio is limited to pin2 and 3
 - gpio interupts will only work on GPIO_EDGE_BOTH
+- adc kernel module will return 12bit number. MRAA defaults shift this to 10bits

diff --git a/docs/galileorevh.md b/docs/galileorevh.md
index 92a71d1..a9b3272 100644 (file)
--- a/docs/galileorevh.md
+++ b/docs/galileorevh.md
@@ -10,3 +10,5 @@ The Gen 2 board has the following limitations in libmraa:
 - i2c bus is shared with multiple devices, scanning it usually fails
 - pwm period is set globally for all pwm channels, when changed this will halt
   all pwm channels
+- adc kernel module will return 12bit number but the ADC itself only has an
+  accuracy of 10bits.