cleanup: More detail in todo comments for mccroskey

This dev board hasn't seen much love.  Add bug links for the unloved
bits and remove an empty interrupt handler.

BUG=chrome-os-partner:23494
BRANCH=none
TEST=build mccroskey

Change-Id: Ic521c6cba4ca438bf54f9ce77eb0cba99be57602
Signed-off-by: Randall Spangler <rspangler@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/174082
Reviewed-by: Bill Richardson <wfrichar@chromium.org>

2 files changed, 23 insertions, 20 deletions

diff --git a/board/mccroskey/board.c b/board/mccroskey/board.c
index 4665565033..d0d839c57d 100644
--- a/board/mccroskey/board.c
+++ b/board/mccroskey/board.c
@@ -22,8 +22,6 @@
 
 #define HARD_RESET_TIMEOUT_MS 5
 
-static void kbd_power_on(enum gpio_signal signal);
-
 /* GPIO signal list.  Must match order from enum gpio_signal. */
 const struct gpio_info gpio_list[] = {
 	/* Inputs with interrupt handlers are first for efficiency */
@@ -43,7 +41,8 @@ const struct gpio_info gpio_list[] = {
 	 keyboard_raw_gpio_interrupt},
 	{"KB_IN07",        GPIO_B, (1<<15), GPIO_KB_INPUT,
 	 keyboard_raw_gpio_interrupt},
-	{"KBD_PWR_BUTTON", GPIO_B, (1<<2),  GPIO_INPUT, kbd_power_on},
+	/* TODO(crosbug.com/p/23494): interrupt handler for power button */
+	{"KBD_PWR_BUTTON", GPIO_B, (1<<2),  GPIO_INPUT, NULL},
 
 	{"OMZO_RDY_L",     GPIO_A, (1<<0),  GPIO_INPUT, NULL},	/* PA0_WKUP */
 	{"OZMO_RST_L",     GPIO_A, (1<<2),  GPIO_ODR_HIGH, NULL},
@@ -77,7 +76,7 @@ const struct gpio_info gpio_list[] = {
 	{"HUB_RESET",      GPIO_C, (1<<14), GPIO_ODR_HIGH, NULL},
 	{"WP_L",           GPIO_D, (1<<2),  GPIO_INPUT, NULL},
 
-	/* FIXME: make this alt. function */
+	/* TODO(crosbug.com/p/23494): make this an alternate function */
 	{"BL_PWM",         GPIO_A, (1<<1),  GPIO_OUTPUT, NULL},
 
 	/* Unimplemented signals which we need to emulate for now */
@@ -101,8 +100,8 @@ BUILD_ASSERT(ARRAY_SIZE(gpio_list) == GPIO_COUNT);
 /* Pins with alternate functions */
 const struct gpio_alt_func gpio_alt_funcs[] = {
 	/*
-	 * TODO(rspangler): use this instead of hard-coded register writes in
-	 * board_config_pre_init().
+	 * TODO(crosbug.com/p/23494): Use this instead of hard-coded register
+	 * writes in board_config_pre_init().
 	 */
 };
 const int gpio_alt_funcs_count = ARRAY_SIZE(gpio_alt_funcs);
@@ -111,15 +110,20 @@ void board_config_pre_init(void)
 {
 	uint32_t val;
 
-	/* Enable all GPIOs clocks
-	 * TODO: more fine-grained enabling for power saving
+	/* Enable all GPIOs clocks.
+	 *
+	 * TODO(crosbug.com/p/23494): more fine-grained enabling for power
+	 * saving.
 	 */
 	STM32_RCC_APB2ENR |= 0x1fd;
 
 #ifdef CONFIG_SPI
-	/* SPI1 on pins PA4-7 (alt. function push-pull, 10MHz) */
-	/* FIXME: Connected device SPI freq is fxo/2 in master mode, fxo/4
-	 * in slave mode. fxo ranges from 12-40MHz */
+	/*
+	 * SPI1 on pins PA4-7 (alt. function push-pull, 10MHz).
+	 *
+	 * TODO(crosbug.com/p/23494): Connected device SPI freq is fxo/2 in
+	 * master mode, fxo/4 in slave mode. fxo ranges from 12-40MHz.
+	 */
 	val = STM32_GPIO_CRL(GPIO_A) & ~0xffff0000;
 	val |= 0x99990000;
 	STM32_GPIO_CRL(GPIO_A) = val;
@@ -163,8 +167,3 @@ void board_i2c_post_init(int port)
 		STM32_GPIO_CRL(GPIO_B) = val;
 	}
 }
-
-void kbd_power_on(enum gpio_signal signal)
-{
-	/* FIXME: this is just a stub for now... */
-}
diff --git a/board/mccroskey/board.h b/board/mccroskey/board.h
index 8d2ac274ab..ceee19ce45 100644
--- a/board/mccroskey/board.h
+++ b/board/mccroskey/board.h
@@ -12,7 +12,8 @@
 #define CPU_CLOCK 48000000
 
 /* Debug features */
-#define CONFIG_I2C_DEBUG	/* FIXME(dhendrix): remove this eventually */
+/* TODO(crosbug.com/p/23494): turn off extra I2C debugging when it works */
+#define CONFIG_I2C_DEBUG
 #undef  CONFIG_TASK_PROFILING
 
 /* Features not present on this reference board */
@@ -23,8 +24,8 @@
 #define CONFIG_KEYBOARD_PROTOCOL_MKBP
 
 /*
- * TODO(dhendrix): Stop mode causes the UART to drop characters and likely
- * other bad side-effects. Disable for now.
+ * TODO(crosbug.com/p/23494): Stop mode causes the UART to drop characters and
+ * likely other bad side-effects. Disable for now.
  */
 #undef   CONFIG_LOW_POWER_IDLE
 
@@ -91,7 +92,10 @@ enum gpio_signal {
 	GPIO_HUB_RESET,
 	GPIO_WP_L,
 
-	/* FIXME: this will be an alt. function GPIO, so remove it from here */
+	/*
+	 * TODO(crosbug.com/p/23494): This will be an alternate function GPIO,
+	 * so remove it from here.
+	 */
 	GPIO_BL_PWM,
 
 	/* Unimplemented GPIOs */