stm32: add some documentation to keyboard_scan.c

This adds some documentation explaining the method to the madness
involving the board's gpio_list array.

BUG=none
BRANCH=none
TEST=it's just comments.

Change-Id: I30731555bbc358b0bebd75f906cbbb3116206146
Signed-off-by: David Hendricks <dhendrix@chromium.org>
Reviewed-on: https://gerrit.chromium.org/gerrit/44994
Reviewed-by: Vincent Palatin <vpalatin@chromium.org>
This commit is contained in:
David Hendricks
2013-03-08 16:27:32 -08:00
committed by ChromeBot
parent cdfbe88e92
commit 7c9f26b582

View File

@@ -5,6 +5,12 @@
/*
* Keyboard scanner module for Chrome EC
*
* To make this code portable, we rely heavily on looping over the keyboard
* input and output entries in the board's gpio_list[]. Each set of inputs or
* outputs must be listed in consecutive, increasing order so that scan loops
* can iterate beginning at KB_IN00 or KB_OUT00 for however many GPIOs are
* utilized (KB_INPUTS or KB_OUTPUTS).
*/
#include "atomic.h"