diff options
| author | Aseda Aboagye <aaboagye@google.com> | 2020-09-29 11:09:17 -0700 |
|---|---|---|
| committer | Commit Bot <commit-bot@chromium.org> | 2020-09-29 22:58:57 +0000 |
| commit | 86f58bd95f42f1afad046ce65e5c68b7d813c8f5 (patch) | |
| tree | 476ada212b08ceb6d412c2869c333ac08bfb640f /include/button.h | |
| parent | 133c6096ffd81cf5e7d62334ccc12d67e14e7830 (diff) | |
| download | chrome-ec-86f58bd95f42f1afad046ce65e5c68b7d813c8f5.tar.gz | |
cleanup: button: Reword comments
This commit is just a clean up CL to clean up some of the comments
introduced with the new ADC detected buttons feature.
BUG=b:167319238
BRANCH=None
TEST=None
Signed-off-by: Aseda Aboagye <aaboagye@google.com>
Change-Id: Ie08a8ca26ceaec26dae2d55f3493f28f1e4a414c
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2438676
Reviewed-by: Diana Z <dzigterman@chromium.org>
Commit-Queue: Aseda Aboagye <aaboagye@chromium.org>
Tested-by: Aseda Aboagye <aaboagye@chromium.org>
Diffstat (limited to 'include/button.h')
| -rw-r--r-- | include/button.h | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/include/button.h b/include/button.h index ec0a7afdc2..3ab5892083 100644 --- a/include/button.h +++ b/include/button.h @@ -88,16 +88,18 @@ int button_disable_gpio(enum button button_type); void button_interrupt(enum gpio_signal signal); /* - * determined which buttons connected ADC + * Is this button using ADC voltages to detect state? * - * @param signal Signal which triggered the interrupt. + * @param gpio The GPIO of interest. + * Returns 1 if button state is detected by ADC, 0 if not. */ int button_is_adc_detected(enum gpio_signal gpio); /* - * distinct which buttons determined by ADC voltage + * Sample the ADC voltage and convert to a physical pressed/not pressed state. * - * @param signal Signal which triggered the interrupt. + * @param gpio ADC detected GPIO. + * Returns the physical state of the button. */ int adc_to_physical_value(enum gpio_signal gpio); |