/* Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
 * Use of this source code is governed by a BSD-style license that can be
 * found in the LICENSE file.
 */

/* LPC module for Chrome EC */

#ifndef __CROS_EC_LPC_H
#define __CROS_EC_LPC_H

#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. */
uint8_t *lpc_get_memmap_range(void);

/* Return true if the TOH is still set */
int lpc_keyboard_has_char(void);

/* Send a byte to host via port 0x60 and asserts IRQ if specified. */
void lpc_keyboard_put_char(uint8_t chr, int send_irq);

/* Clear the keyboard buffer. */
void lpc_keyboard_clear_buffer(void);

/* 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. */
int lpc_comx_has_char(void);

/* Return the next character pending on the COMx interface. */
int lpc_comx_get_char(void);

/* Put a character to the COMx LPC interface. */
void lpc_comx_put_char(int c);

/* Types of host events */
enum lpc_host_event_type {
	LPC_HOST_EVENT_SMI = 0,
	LPC_HOST_EVENT_SCI,
	LPC_HOST_EVENT_WAKE,
};

/* Set one or more SCI/SMI event bits. */
void lpc_set_host_events(uint32_t mask);

/* Clear one or more SCI/SMI event bits.  Write 1 to a bit to clear it. */
void lpc_clear_host_events(uint32_t mask);

/* Return the raw SCI/SMI event state. */
uint32_t lpc_get_host_events(void);

/* Set the event mask for the specified event type. */
void lpc_set_host_event_mask(enum lpc_host_event_type type, uint32_t mask);

/* 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 */