diff options
author | Randall Spangler <rspangler@chromium.org> | 2012-10-29 13:44:29 -0700 |
---|---|---|
committer | Gerrit <chrome-bot@google.com> | 2012-10-30 12:42:45 -0700 |
commit | f76cb374f856b71e7db4fd6a123a0add49e7d512 (patch) | |
tree | 9f024d636c481f5ad975a04f3754a71dac5b2b22 /include | |
parent | d5ade1b2ed426ae2a7bd0d69ab462f76faa25c66 (diff) | |
download | chrome-ec-f76cb374f856b71e7db4fd6a123a0add49e7d512.tar.gz |
Clean up LPC module
Tidied comments, and removed handling of ACPI events on host command
port (not needed since EVT hardware is now EOL'd).
BUG=chrome-os-partner:15579
BRANCH=none
TEST='ectool hello' succeeds
Change-Id: I063382b9981f713ba23f7714b4ccb7faa957b411
Signed-off-by: Randall Spangler <rspangler@chromium.org>
Reviewed-on: https://gerrit.chromium.org/gerrit/36804
Diffstat (limited to 'include')
-rw-r--r-- | include/lpc.h | 60 |
1 files changed, 41 insertions, 19 deletions
diff --git a/include/lpc.h b/include/lpc.h index 8c33b401b2..3dd39a105e 100644 --- a/include/lpc.h +++ b/include/lpc.h @@ -10,37 +10,50 @@ #include "common.h" -/* - * Manually generate an IRQ to host. - * Note that the irq_num == 0 would set the AH bit (Active High). - */ -void lpc_manual_irq(int irq_num); - -/* - * Return a pointer to the memory-mapped buffer. This buffer is writable at - * any time, and the host can read it at any time. +/** + * Return a pointer to the memory-mapped buffer. + * + * This buffer is writable at any time, and the host can read it at any time. */ uint8_t *lpc_get_memmap_range(void); -/* Return true if the TOH is still set */ +/** + * Return true if keyboard data is waiting for the host to read (TOH is still + * set). + */ int lpc_keyboard_has_char(void); -/* Send a byte to host via port 0x60 and asserts IRQ if specified. */ +/** + * Send a byte to host via keyboard port 0x60. + * + * @param chr Byte to send + * @param send_irq If non-zero, asserts IRQ + */ void lpc_keyboard_put_char(uint8_t chr, int send_irq); -/* Clear the keyboard buffer. */ +/** + * Clear the keyboard buffer. + */ void lpc_keyboard_clear_buffer(void); -/* Send an IRQ to host if there is a byte in buffer already. */ +/** + * Send an IRQ to host if there is a byte in buffer already. + */ void lpc_keyboard_resume_irq(void); -/* Return non-zero if the COMx interface has received a character. */ +/** + * Return non-zero if the COMx interface has received a character. + */ int lpc_comx_has_char(void); -/* Return the next character pending on the COMx interface. */ +/** + * Return the next character pending on the COMx interface. + */ int lpc_comx_get_char(void); -/* Put a character to the COMx LPC interface. */ +/** + * Put a character to the COMx LPC interface. + */ void lpc_comx_put_char(int c); /* @@ -57,13 +70,22 @@ enum lpc_host_event_type { LPC_HOST_EVENT_WAKE, }; -/* Set the event state */ +/** + * Set the event state. + */ void lpc_set_host_event_state(uint32_t mask); -/* Set the event mask for the specified event type. */ +/** + * Set the event mask for the specified event type. + * + * @param type Event type + * @param mask New event mask + */ void lpc_set_host_event_mask(enum lpc_host_event_type type, uint32_t mask); -/* Return the event mask for the specified event type. */ +/** + * Return the event mask for the specified event type. + */ uint32_t lpc_get_host_event_mask(enum lpc_host_event_type type); #endif /* __CROS_EC_LPC_H */ |